]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-send-email(1) |
2 | ================= | |
479cec96 RA |
3 | |
4 | NAME | |
5 | ---- | |
215a7ad1 | 6 | git-send-email - Send a collection of patches as emails |
479cec96 RA |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
7791a1d9 | 11 | [verse] |
5df9fcf6 | 12 | 'git send-email' [options] <file|directory|rev-list options>... |
479cec96 RA |
13 | |
14 | ||
479cec96 RA |
15 | DESCRIPTION |
16 | ----------- | |
17 | Takes the patches given on the command line and emails them out. | |
94af7c31 PB |
18 | Patches can be specified as files, directories (which will send all |
19 | files in the directory), or directly as a revision list. In the | |
20 | last case, any format accepted by linkgit:git-format-patch[1] can | |
21 | be passed to git send-email. | |
479cec96 RA |
22 | |
23 | The header of the email is configurable by command line options. If not | |
24 | specified on the command line, the user will be prompted with a ReadLine | |
25 | enabled interface to provide the necessary information. | |
26 | ||
c4ba87a6 TZ |
27 | There are two formats accepted for patch files: |
28 | ||
29 | 1. mbox format files | |
30 | + | |
31 | This is what linkgit:git-format-patch[1] generates. Most headers and MIME | |
32 | formatting are ignored. | |
33 | ||
34 | 2. The original format used by Greg Kroah-Hartman's 'send_lots_of_email.pl' | |
35 | script | |
36 | + | |
37 | This format expects the first line of the file to contain the "Cc:" value | |
38 | and the "Subject:" of the message as the second line. | |
39 | ||
917f3e73 | 40 | |
df8baa42 JF |
41 | OPTIONS |
42 | ------- | |
917f3e73 MW |
43 | |
44 | Composing | |
45 | ~~~~~~~~~ | |
479cec96 | 46 | |
432b1282 | 47 | --annotate:: |
3a78d078 MW |
48 | Review and edit each patch you're about to send. See the |
49 | CONFIGURATION section for 'sendemail.multiedit'. | |
432b1282 | 50 | |
4c0fe0af | 51 | --bcc=<address>:: |
3971a973 MW |
52 | Specify a "Bcc:" value for each email. Default is the value of |
53 | 'sendemail.bcc'. | |
5ef1f8d4 SV |
54 | + |
55 | The --bcc option must be repeated for each user you want on the bcc list. | |
79ee555b | 56 | |
4c0fe0af | 57 | --cc=<address>:: |
da140f8b | 58 | Specify a starting "Cc:" value for each email. |
bd7c6e7f | 59 | Default is the value of 'sendemail.cc'. |
5ef1f8d4 SV |
60 | + |
61 | The --cc option must be repeated for each user you want on the cc list. | |
79ee555b | 62 | |
2718435b | 63 | --compose:: |
b4479f07 JN |
64 | Invoke a text editor (see GIT_EDITOR in linkgit:git-var[1]) |
65 | to edit an introductory message for the patch series. | |
beece9da | 66 | + |
01d38612 SB |
67 | When '--compose' is used, git send-email will use the From, Subject, and |
68 | In-Reply-To headers specified in the message. If the body of the message | |
69 | (what you type after the headers and a blank line) only contains blank | |
70 | (or GIT: prefixed) lines the summary won't be sent, but From, Subject, | |
71 | and In-Reply-To headers will be used unless they are removed. | |
beece9da | 72 | + |
01d38612 | 73 | Missing From or In-Reply-To headers will be prompted for. |
3a78d078 MW |
74 | + |
75 | See the CONFIGURATION section for 'sendemail.multiedit'. | |
479cec96 | 76 | |
4c0fe0af | 77 | --from=<address>:: |
09caa24f TP |
78 | Specify the sender of the emails. If not specified on the command line, |
79 | the value of the 'sendemail.from' configuration option is used. If | |
80 | neither the command line option nor 'sendemail.from' are set, then the | |
81 | user will be prompted for the value. The default for the prompt will be | |
82 | the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not | |
83 | set, as returned by "git var -l". | |
479cec96 | 84 | |
4c0fe0af | 85 | --in-reply-to=<identifier>:: |
db54c8e7 AO |
86 | Make the first mail (or all the mails with `--no-thread`) appear as a |
87 | reply to the given Message-Id, which avoids breaking threads to | |
88 | provide a new patch series. | |
89 | The second and subsequent emails will be sent as replies according to | |
90 | the `--[no]-chain-reply-to` setting. | |
91 | + | |
92 | So for example when `--thread` and `--no-chain-reply-to` are specified, the | |
93 | second and subsequent patches will be replies to the first one like in the | |
94 | illustration below where `[PATCH v2 0/3]` is in reply to `[PATCH 0/2]`: | |
95 | + | |
96 | [PATCH 0/2] Here is what I did... | |
97 | [PATCH 1/2] Clean up and tests | |
98 | [PATCH 2/2] Implementation | |
99 | [PATCH v2 0/3] Here is a reroll | |
100 | [PATCH v2 1/3] Clean up | |
101 | [PATCH v2 2/3] New tests | |
102 | [PATCH v2 3/3] Implementation | |
103 | + | |
104 | Only necessary if --compose is also set. If --compose | |
105 | is not set, this will be prompted for. | |
479cec96 | 106 | |
4c0fe0af | 107 | --subject=<string>:: |
917f3e73 MW |
108 | Specify the initial subject of the email thread. |
109 | Only necessary if --compose is also set. If --compose | |
110 | is not set, this will be prompted for. | |
a6d62cdd | 111 | |
4c0fe0af | 112 | --to=<address>:: |
917f3e73 MW |
113 | Specify the primary recipient of the emails generated. Generally, this |
114 | will be the upstream maintainer of the project involved. Default is the | |
115 | value of the 'sendemail.to' configuration value; if that is unspecified, | |
6e74e075 | 116 | and --to-cmd is not specified, this will be prompted for. |
917f3e73 MW |
117 | + |
118 | The --to option must be repeated for each user you want on the to list. | |
119 | ||
3cae7e5b TR |
120 | --8bit-encoding=<encoding>:: |
121 | When encountering a non-ASCII message or subject that does not | |
122 | declare its encoding, add headers/quoting to indicate it is | |
123 | encoded in <encoding>. Default is the value of the | |
124 | 'sendemail.assume8bitEncoding'; if that is unspecified, this | |
125 | will be prompted for if any non-ASCII files are encountered. | |
126 | + | |
127 | Note that no attempts whatsoever are made to validate the encoding. | |
128 | ||
917f3e73 MW |
129 | |
130 | Sending | |
131 | ~~~~~~~ | |
132 | ||
4c0fe0af | 133 | --envelope-sender=<address>:: |
917f3e73 MW |
134 | Specify the envelope sender used to send the emails. |
135 | This is useful if your default address is not the address that is | |
c89e3241 FC |
136 | subscribed to a list. In order to use the 'From' address, set the |
137 | value to "auto". If you use the sendmail binary, you must have | |
138 | suitable privileges for the -f parameter. Default is the value of the | |
139 | 'sendemail.envelopesender' configuration variable; if that is | |
917f3e73 | 140 | unspecified, choosing the envelope sender is left to your MTA. |
73811e66 | 141 | |
4c0fe0af | 142 | --smtp-encryption=<encryption>:: |
73811e66 MW |
143 | Specify the encryption to use, either 'ssl' or 'tls'. Any other |
144 | value reverts to plain SMTP. Default is the value of | |
145 | 'sendemail.smtpencryption'. | |
146 | ||
79ca070c BG |
147 | --smtp-domain=<FQDN>:: |
148 | Specifies the Fully Qualified Domain Name (FQDN) used in the | |
149 | HELO/EHLO command to the SMTP server. Some servers require the | |
150 | FQDN to match your IP address. If not set, git send-email attempts | |
69cf7bfd BG |
151 | to determine your FQDN automatically. Default is the value of |
152 | 'sendemail.smtpdomain'. | |
79ca070c | 153 | |
4c0fe0af | 154 | --smtp-pass[=<password>]:: |
73811e66 MW |
155 | Password for SMTP-AUTH. The argument is optional: If no |
156 | argument is specified, then the empty string is used as | |
3971a973 MW |
157 | the password. Default is the value of 'sendemail.smtppass', |
158 | however '--smtp-pass' always overrides this value. | |
73811e66 MW |
159 | + |
160 | Furthermore, passwords need not be specified in configuration files | |
161 | or on the command line. If a username has been specified (with | |
3971a973 MW |
162 | '--smtp-user' or a 'sendemail.smtpuser'), but no password has been |
163 | specified (with '--smtp-pass' or 'sendemail.smtppass'), then the | |
73811e66 | 164 | user is prompted for a password while the input is masked for privacy. |
34cc60ce | 165 | |
4c0fe0af | 166 | --smtp-server=<host>:: |
928a5590 JA |
167 | If set, specifies the outgoing SMTP server to use (e.g. |
168 | `smtp.example.com` or a raw IP address). Alternatively it can | |
169 | specify a full pathname of a sendmail-like program instead; | |
6dcfa306 SV |
170 | the program must support the `-i` option. Default value can |
171 | be specified by the 'sendemail.smtpserver' configuration | |
172 | option; the built-in default is `/usr/sbin/sendmail` or | |
173 | `/usr/lib/sendmail` if such program is available, or | |
174 | `localhost` otherwise. | |
a6d62cdd | 175 | |
4c0fe0af | 176 | --smtp-server-port=<port>:: |
44b2476a | 177 | Specifies a port different from the default port (SMTP |
2da846e7 WL |
178 | servers typically listen to smtp port 25, but may also listen to |
179 | submission port 587, or the common SSL smtp port 465); | |
180 | symbolic port names (e.g. "submission" instead of 587) | |
dd602bf8 MW |
181 | are also accepted. The port can also be set with the |
182 | 'sendemail.smtpserverport' configuration variable. | |
44b2476a | 183 | |
052fbea2 PO |
184 | --smtp-server-option=<option>:: |
185 | If set, specifies the outgoing SMTP server option to use. | |
186 | Default value can be specified by the 'sendemail.smtpserveroption' | |
187 | configuration option. | |
188 | + | |
189 | The --smtp-server-option option must be repeated for each option you want | |
190 | to pass to the server. Likewise, different lines in the configuration files | |
191 | must be used for each option. | |
192 | ||
73811e66 | 193 | --smtp-ssl:: |
3971a973 | 194 | Legacy alias for '--smtp-encryption ssl'. |
73811e66 | 195 | |
4c0fe0af | 196 | --smtp-user=<user>:: |
3971a973 MW |
197 | Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser'; |
198 | if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'), | |
199 | then authentication is not attempted. | |
2363d746 | 200 | |
3ddf9228 ZJS |
201 | --smtp-debug=0|1:: |
202 | Enable (1) or disable (0) debug output. If enabled, SMTP | |
203 | commands and replies will be printed. Useful to debug TLS | |
204 | connection and authentication problems. | |
917f3e73 MW |
205 | |
206 | Automating | |
207 | ~~~~~~~~~~ | |
208 | ||
6e74e075 JP |
209 | --to-cmd=<command>:: |
210 | Specify a command to execute once per patch file which | |
211 | should generate patch file specific "To:" entries. | |
212 | Output of this command must be single email address per line. | |
213 | Default is the value of 'sendemail.tocmd' configuration value. | |
214 | ||
4c0fe0af | 215 | --cc-cmd=<command>:: |
917f3e73 MW |
216 | Specify a command to execute once per patch file which |
217 | should generate patch file specific "Cc:" entries. | |
218 | Output of this command must be single email address per line. | |
219 | Default is the value of 'sendemail.cccmd' configuration value. | |
220 | ||
0fd41f2d | 221 | --[no-]chain-reply-to:: |
917f3e73 MW |
222 | If this is set, each email will be sent as a reply to the previous |
223 | email sent. If disabled with "--no-chain-reply-to", all emails after | |
224 | the first will be sent as replies to the first email sent. When using | |
225 | this, it is recommended that the first file given be an overview of the | |
41fe87fa JH |
226 | entire patch series. Disabled by default, but the 'sendemail.chainreplyto' |
227 | configuration variable can be used to enable it. | |
917f3e73 | 228 | |
4c0fe0af | 229 | --identity=<identity>:: |
917f3e73 MW |
230 | A configuration identity. When given, causes values in the |
231 | 'sendemail.<identity>' subsection to take precedence over | |
232 | values in the 'sendemail' section. The default identity is | |
233 | the value of 'sendemail.identity'. | |
234 | ||
235 | --[no-]signed-off-by-cc:: | |
236 | If this is set, add emails found in Signed-off-by: or Cc: lines to the | |
ddc3d4fe | 237 | cc list. Default is the value of 'sendemail.signedoffbycc' configuration |
917f3e73 | 238 | value; if that is unspecified, default to --signed-off-by-cc. |
2718435b | 239 | |
4c0fe0af | 240 | --suppress-cc=<category>:: |
65648283 | 241 | Specify an additional category of recipients to suppress the |
3531e270 JS |
242 | auto-cc of: |
243 | + | |
244 | -- | |
245 | - 'author' will avoid including the patch author | |
246 | - 'self' will avoid including the sender | |
247 | - 'cc' will avoid including anyone mentioned in Cc lines in the patch header | |
248 | except for self (use 'self' for that). | |
cb8a9bd5 | 249 | - 'bodycc' will avoid including anyone mentioned in Cc lines in the |
3531e270 JS |
250 | patch body (commit message) except for self (use 'self' for that). |
251 | - 'sob' will avoid including anyone mentioned in Signed-off-by lines except | |
252 | for self (use 'self' for that). | |
253 | - 'cccmd' will avoid running the --cc-cmd. | |
cb8a9bd5 | 254 | - 'body' is equivalent to 'sob' + 'bodycc' |
3531e270 JS |
255 | - 'all' will suppress all auto cc values. |
256 | -- | |
257 | + | |
258 | Default is the value of 'sendemail.suppresscc' configuration value; if | |
259 | that is unspecified, default to 'self' if --suppress-from is | |
260 | specified, as well as 'body' if --no-signed-off-cc is specified. | |
65648283 | 261 | |
73811e66 MW |
262 | --[no-]suppress-from:: |
263 | If this is set, do not add the From: address to the cc: list. | |
264 | Default is the value of 'sendemail.suppressfrom' configuration | |
265 | value; if that is unspecified, default to --no-suppress-from. | |
266 | ||
7ecbad91 | 267 | --[no-]thread:: |
f693b7e9 YD |
268 | If this is set, the In-Reply-To and References headers will be |
269 | added to each email sent. Whether each mail refers to the | |
270 | previous email (`deep` threading per 'git format-patch' | |
271 | wording) or to the first email (`shallow` threading) is | |
272 | governed by "--[no-]chain-reply-to". | |
273 | + | |
274 | If disabled with "--no-thread", those headers will not be added | |
275 | (unless specified with --in-reply-to). Default is the value of the | |
276 | 'sendemail.thread' configuration value; if that is unspecified, | |
277 | default to --thread. | |
278 | + | |
279 | It is up to the user to ensure that no In-Reply-To header already | |
280 | exists when 'git send-email' is asked to add it (especially note that | |
281 | 'git format-patch' can be configured to do the threading itself). | |
282 | Failure to do so may not produce the expected result in the | |
283 | recipient's MUA. | |
e46f7a0e | 284 | |
917f3e73 MW |
285 | |
286 | Administering | |
287 | ~~~~~~~~~~~~~ | |
288 | ||
4c0fe0af | 289 | --confirm=<mode>:: |
c1f2aa45 JS |
290 | Confirm just before sending: |
291 | + | |
292 | -- | |
293 | - 'always' will always confirm before sending | |
294 | - 'never' will never confirm before sending | |
295 | - 'cc' will confirm before sending when send-email has automatically | |
296 | added addresses from the patch to the Cc list | |
297 | - 'compose' will confirm before sending the first message when using --compose. | |
298 | - 'auto' is equivalent to 'cc' + 'compose' | |
299 | -- | |
300 | + | |
301 | Default is the value of 'sendemail.confirm' configuration value; if that | |
302 | is unspecified, default to 'auto' unless any of the suppress options | |
303 | have been specified, in which case default to 'compose'. | |
304 | ||
917f3e73 MW |
305 | --dry-run:: |
306 | Do everything except actually send the emails. | |
307 | ||
432b1282 MW |
308 | --[no-]format-patch:: |
309 | When an argument may be understood either as a reference or as a file name, | |
310 | choose to understand it as a format-patch argument ('--format-patch') | |
311 | or as a file name ('--no-format-patch'). By default, when such a conflict | |
312 | occurs, git send-email will fail. | |
313 | ||
917f3e73 MW |
314 | --quiet:: |
315 | Make git-send-email less verbose. One line per email should be | |
316 | all that is output. | |
03044a98 | 317 | |
dbf5e1e9 MW |
318 | --[no-]validate:: |
319 | Perform sanity checks on patches. | |
7ecbad91 MW |
320 | Currently, validation means the following: |
321 | + | |
322 | -- | |
323 | * Warn of patches that contain lines longer than 998 characters; this | |
324 | is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt. | |
325 | -- | |
dbf5e1e9 | 326 | + |
3971a973 MW |
327 | Default is the value of 'sendemail.validate'; if this is not set, |
328 | default to '--validate'. | |
7ecbad91 | 329 | |
1a3e302a AS |
330 | --force:: |
331 | Send emails even if safety checks would prevent it. | |
332 | ||
a6d62cdd | 333 | |
fc095242 AK |
334 | CONFIGURATION |
335 | ------------- | |
917f3e73 | 336 | |
fc095242 AK |
337 | sendemail.aliasesfile:: |
338 | To avoid typing long email addresses, point this to one or more | |
339 | email aliases files. You must also supply 'sendemail.aliasfiletype'. | |
340 | ||
341 | sendemail.aliasfiletype:: | |
342 | Format of the file(s) specified in sendemail.aliasesfile. Must be | |
7613ea35 | 343 | one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus'. |
fc095242 | 344 | |
8fd5bb7f PH |
345 | sendemail.multiedit:: |
346 | If true (default), a single editor instance will be spawned to edit | |
347 | files you have to edit (patches when '--annotate' is used, and the | |
348 | summary when '--compose' is used). If false, files will be edited one | |
349 | after the other, spawning a new editor each time. | |
350 | ||
c1f2aa45 JS |
351 | sendemail.confirm:: |
352 | Sets the default for whether to confirm before sending. Must be | |
353 | one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm' | |
354 | in the previous section for the meaning of these values. | |
355 | ||
36c10e6d JN |
356 | EXAMPLE |
357 | ------- | |
2b873e06 | 358 | Use gmail as the smtp server |
36c10e6d JN |
359 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
360 | To use 'git send-email' to send your patches through the GMail SMTP server, | |
361 | edit ~/.gitconfig to specify your account settings: | |
2b873e06 PY |
362 | |
363 | [sendemail] | |
364 | smtpencryption = tls | |
365 | smtpserver = smtp.gmail.com | |
366 | smtpuser = yourname@gmail.com | |
367 | smtpserverport = 587 | |
368 | ||
36c10e6d JN |
369 | Once your commits are ready to be sent to the mailing list, run the |
370 | following commands: | |
371 | ||
372 | $ git format-patch --cover-letter -M origin/master -o outgoing/ | |
373 | $ edit outgoing/0000-* | |
374 | $ git send-email outgoing/* | |
375 | ||
2b873e06 PY |
376 | Note: the following perl modules are required |
377 | Net::SMTP::SSL, MIME::Base64 and Authen::SASL | |
378 | ||
36c10e6d JN |
379 | SEE ALSO |
380 | -------- | |
381 | linkgit:git-format-patch[1], linkgit:git-imap-send[1], mbox(5) | |
382 | ||
479cec96 RA |
383 | GIT |
384 | --- | |
9e1f0a85 | 385 | Part of the linkgit:git[1] suite |