e38b7021b4d38c07bd794e59be0a5e0747a8b775
[git/git.git] / Documentation / git-send-email.txt
1 git-send-email(1)
2 =================
3
4 NAME
5 ----
6 git-send-email - Send a collection of patches as emails
7
8
9 SYNOPSIS
10 --------
11 'git-send-email' [options] <file|directory> [... file|directory]
12
13
14
15 DESCRIPTION
16 -----------
17 Takes the patches given on the command line and emails them out.
18
19 The header of the email is configurable by command line options. If not
20 specified on the command line, the user will be prompted with a ReadLine
21 enabled interface to provide the necessary information.
22
23 OPTIONS
24 -------
25 The options available are:
26
27 --bcc::
28 Specify a "Bcc:" value for each email.
29 +
30 The --bcc option must be repeated for each user you want on the bcc list.
31
32 --cc::
33 Specify a starting "Cc:" value for each email.
34 +
35 The --cc option must be repeated for each user you want on the cc list.
36
37 --cc-cmd::
38 Specify a command to execute once per patch file which
39 should generate patch file specific "Cc:" entries.
40 Output of this command must be single email address per line.
41 Default is the value of 'sendemail.cccmd' configuration value.
42
43 --chain-reply-to, --no-chain-reply-to::
44 If this is set, each email will be sent as a reply to the previous
45 email sent. If disabled with "--no-chain-reply-to", all emails after
46 the first will be sent as replies to the first email sent. When using
47 this, it is recommended that the first file given be an overview of the
48 entire patch series.
49 Default is the value of the 'sendemail.chainreplyto' configuration
50 value; if that is unspecified, default to --chain-reply-to.
51
52 --compose::
53 Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
54 introductory message for the patch series.
55
56 --from::
57 Specify the sender of the emails. This will default to
58 the value GIT_COMMITTER_IDENT, as returned by "git-var -l".
59 The user will still be prompted to confirm this entry.
60
61 --in-reply-to::
62 Specify the contents of the first In-Reply-To header.
63 Subsequent emails will refer to the previous email
64 instead of this if --chain-reply-to is set (the default)
65 Only necessary if --compose is also set. If --compose
66 is not set, this will be prompted for.
67
68 --signed-off-by-cc, --no-signed-off-by-cc::
69 If this is set, add emails found in Signed-off-by: or Cc: lines to the
70 cc list.
71 Default is the value of 'sendemail.signedoffcc' configuration value;
72 if that is unspecified, default to --signed-off-by-cc.
73
74 --quiet::
75 Make git-send-email less verbose. One line per email should be
76 all that is output.
77
78 --identity::
79 A configuration identity. When given, causes values in the
80 'sendemail.<identity>' subsection to take precedence over
81 values in the 'sendemail' section. The default identity is
82 the value of 'sendemail.identity'.
83
84 --smtp-server::
85 If set, specifies the outgoing SMTP server to use (e.g.
86 `smtp.example.com` or a raw IP address). Alternatively it can
87 specify a full pathname of a sendmail-like program instead;
88 the program must support the `-i` option. Default value can
89 be specified by the 'sendemail.smtpserver' configuration
90 option; the built-in default is `/usr/sbin/sendmail` or
91 `/usr/lib/sendmail` if such program is available, or
92 `localhost` otherwise.
93
94 --smtp-server-port::
95 Specifies a port different from the default port (SMTP
96 servers typically listen to smtp port 25 and ssmtp port
97 465).
98
99 --smtp-user, --smtp-pass::
100 Username and password for SMTP-AUTH. Defaults are the values of
101 the configuration values 'sendemail.smtpuser' and
102 'sendemail.smtppass', but see also 'sendemail.identity'.
103 If not set, authentication is not attempted.
104
105 --smtp-ssl::
106 If set, connects to the SMTP server using SSL.
107 Default is the value of the 'sendemail.smtpssl' configuration value;
108 if that is unspecified, does not use SSL.
109
110 --subject::
111 Specify the initial subject of the email thread.
112 Only necessary if --compose is also set. If --compose
113 is not set, this will be prompted for.
114
115 --suppress-from, --no-suppress-from::
116 If this is set, do not add the From: address to the cc: list, if it
117 shows up in a From: line.
118 Default is the value of 'sendemail.suppressfrom' configuration value;
119 if that is unspecified, default to --no-suppress-from.
120
121 --thread, --no-thread::
122 If this is set, the In-Reply-To header will be set on each email sent.
123 If disabled with "--no-thread", no emails will have the In-Reply-To
124 header set.
125 Default is the value of the 'sendemail.thread' configuration value;
126 if that is unspecified, default to --thread.
127
128 --dry-run::
129 Do everything except actually send the emails.
130
131 --envelope-sender::
132 Specify the envelope sender used to send the emails.
133 This is useful if your default address is not the address that is
134 subscribed to a list. If you use the sendmail binary, you must have
135 suitable privileges for the -f parameter.
136
137 --to::
138 Specify the primary recipient of the emails generated.
139 Generally, this will be the upstream maintainer of the
140 project involved.
141 +
142 The --to option must be repeated for each user you want on the to list.
143
144
145 CONFIGURATION
146 -------------
147 sendemail.identity::
148 The default configuration identity. When specified,
149 'sendemail.<identity>.<item>' will have higher precedence than
150 'sendemail.<item>'. This is useful to declare multiple SMTP
151 identities and to hoist sensitive authentication information
152 out of the repository and into the global configuation file.
153
154 sendemail.aliasesfile::
155 To avoid typing long email addresses, point this to one or more
156 email aliases files. You must also supply 'sendemail.aliasfiletype'.
157
158 sendemail.aliasfiletype::
159 Format of the file(s) specified in sendemail.aliasesfile. Must be
160 one of 'mutt', 'mailrc', 'pine', or 'gnus'.
161
162 sendemail.to::
163 Email address (or alias) to always send to.
164
165 sendemail.cccmd::
166 Command to execute to generate per patch file specific "Cc:"s.
167
168 sendemail.bcc::
169 Email address (or alias) to always bcc.
170
171 sendemail.chainreplyto::
172 Boolean value specifying the default to the '--chain_reply_to'
173 parameter.
174
175 sendemail.smtpserver::
176 Default SMTP server to use.
177
178 sendemail.smtpuser::
179 Default SMTP-AUTH username.
180
181 sendemail.smtppass::
182 Default SMTP-AUTH password.
183
184 sendemail.smtpssl::
185 Boolean value specifying the default to the '--smtp-ssl' parameter.
186
187 Author
188 ------
189 Written by Ryan Anderson <ryan@michonline.com>
190
191 git-send-email is originally based upon
192 send_lots_of_email.pl by Greg Kroah-Hartman.
193
194 Documentation
195 --------------
196 Documentation by Ryan Anderson
197
198 GIT
199 ---
200 Part of the gitlink:git[7] suite