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