1 git-send-email(1)
2 =================
4 NAME
5 ----
6 git-send-email - Send a collection of patches as emails
9 SYNOPSIS
10 --------
11 'git send-email' [options] <file|directory|rev-list options>...
14 DESCRIPTION
15 -----------
16 Takes the patches given on the command line and emails them out.
18 The header of the email is configurable by command line options. If not
19 specified on the command line, the user will be prompted with a ReadLine
20 enabled interface to provide the necessary information.
22 There are two formats accepted for patch files:
24 1. mbox format files
25 +
26 This is what linkgit:git-format-patch[1] generates. Most headers and MIME
27 formatting are ignored.
29 2. The original format used by Greg Kroah-Hartman's 'send_lots_of_email.pl'
30 script
31 +
32 This format expects the first line of the file to contain the "Cc:" value
33 and the "Subject:" of the message as the second line.
36 OPTIONS
37 -------
39 Composing
40 ~~~~~~~~~
42 --annotate::
43 Review and edit each patch you're about to send. See the
44 CONFIGURATION section for 'sendemail.multiedit'.
46 --bcc=<address>::
47 Specify a "Bcc:" value for each email. Default is the value of
48 'sendemail.bcc'.
49 +
50 The --bcc option must be repeated for each user you want on the bcc list.
52 --cc=<address>::
53 Specify a starting "Cc:" value for each email.
54 Default is the value of 'sendemail.cc'.
55 +
56 The --cc option must be repeated for each user you want on the cc list.
58 --compose::
59 Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
60 introductory message for the patch series.
61 +
62 When '--compose' is used, git send-email will use the From, Subject, and
63 In-Reply-To headers specified in the message. If the body of the message
64 (what you type after the headers and a blank line) only contains blank
65 (or GIT: prefixed) lines the summary won't be sent, but From, Subject,
66 and In-Reply-To headers will be used unless they are removed.
67 +
68 Missing From or In-Reply-To headers will be prompted for.
69 +
70 See the CONFIGURATION section for 'sendemail.multiedit'.
72 --from=<address>::
73 Specify the sender of the emails. This will default to
74 the value GIT_COMMITTER_IDENT, as returned by "git var -l".
75 The user will still be prompted to confirm this entry.
77 --in-reply-to=<identifier>::
78 Specify the contents of the first In-Reply-To header.
79 Subsequent emails will refer to the previous email
80 instead of this if --chain-reply-to is set (the default)
81 Only necessary if --compose is also set. If --compose
82 is not set, this will be prompted for.
84 --subject=<string>::
85 Specify the initial subject of the email thread.
86 Only necessary if --compose is also set. If --compose
87 is not set, this will be prompted for.
89 --to=<address>::
90 Specify the primary recipient of the emails generated. Generally, this
91 will be the upstream maintainer of the project involved. Default is the
92 value of the 'sendemail.to' configuration value; if that is unspecified,
93 this will be prompted for.
94 +
95 The --to option must be repeated for each user you want on the to list.
98 Sending
99 ~~~~~~~
101 --envelope-sender=<address>::
102 Specify the envelope sender used to send the emails.
103 This is useful if your default address is not the address that is
104 subscribed to a list. If you use the sendmail binary, you must have
105 suitable privileges for the -f parameter. Default is the value of
106 the 'sendemail.envelopesender' configuration variable; if that is
107 unspecified, choosing the envelope sender is left to your MTA.
109 --smtp-encryption=<encryption>::
110 Specify the encryption to use, either 'ssl' or 'tls'. Any other
111 value reverts to plain SMTP. Default is the value of
112 'sendemail.smtpencryption'.
114 --smtp-pass[=<password>]::
115 Password for SMTP-AUTH. The argument is optional: If no
116 argument is specified, then the empty string is used as
117 the password. Default is the value of 'sendemail.smtppass',
118 however '--smtp-pass' always overrides this value.
119 +
120 Furthermore, passwords need not be specified in configuration files
121 or on the command line. If a username has been specified (with
122 '--smtp-user' or a 'sendemail.smtpuser'), but no password has been
123 specified (with '--smtp-pass' or 'sendemail.smtppass'), then the
124 user is prompted for a password while the input is masked for privacy.
126 --smtp-server=<host>::
127 If set, specifies the outgoing SMTP server to use (e.g.
128 `smtp.example.com` or a raw IP address). Alternatively it can
129 specify a full pathname of a sendmail-like program instead;
130 the program must support the `-i` option. Default value can
131 be specified by the 'sendemail.smtpserver' configuration
132 option; the built-in default is `/usr/sbin/sendmail` or
133 `/usr/lib/sendmail` if such program is available, or
134 `localhost` otherwise.
136 --smtp-server-port=<port>::
137 Specifies a port different from the default port (SMTP
138 servers typically listen to smtp port 25 and ssmtp port
139 465). This can be set with 'sendemail.smtpserverport'.
141 --smtp-ssl::
142 Legacy alias for '--smtp-encryption ssl'.
144 --smtp-user=<user>::
145 Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser';
146 if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),
147 then authentication is not attempted.
150 Automating
151 ~~~~~~~~~~
153 --cc-cmd=<command>::
154 Specify a command to execute once per patch file which
155 should generate patch file specific "Cc:" entries.
156 Output of this command must be single email address per line.
157 Default is the value of 'sendemail.cccmd' configuration value.
159 --[no-]chain-reply-to=<identifier>::
160 If this is set, each email will be sent as a reply to the previous
161 email sent. If disabled with "--no-chain-reply-to", all emails after
162 the first will be sent as replies to the first email sent. When using
163 this, it is recommended that the first file given be an overview of the
164 entire patch series. Default is the value of the 'sendemail.chainreplyto'
165 configuration value; if that is unspecified, default to --chain-reply-to.
167 --identity=<identity>::
168 A configuration identity. When given, causes values in the
169 'sendemail.<identity>' subsection to take precedence over
170 values in the 'sendemail' section. The default identity is
171 the value of 'sendemail.identity'.
173 --[no-]signed-off-by-cc::
174 If this is set, add emails found in Signed-off-by: or Cc: lines to the
175 cc list. Default is the value of 'sendemail.signedoffbycc' configuration
176 value; if that is unspecified, default to --signed-off-by-cc.
178 --suppress-cc=<category>::
179 Specify an additional category of recipients to suppress the
180 auto-cc of:
181 +
182 --
183 - 'author' will avoid including the patch author
184 - 'self' will avoid including the sender
185 - 'cc' will avoid including anyone mentioned in Cc lines in the patch header
186 except for self (use 'self' for that).
187 - 'ccbody' will avoid including anyone mentioned in Cc lines in the
188 patch body (commit message) except for self (use 'self' for that).
189 - 'sob' will avoid including anyone mentioned in Signed-off-by lines except
190 for self (use 'self' for that).
191 - 'cccmd' will avoid running the --cc-cmd.
192 - 'body' is equivalent to 'sob' + 'ccbody'
193 - 'all' will suppress all auto cc values.
194 --
195 +
196 Default is the value of 'sendemail.suppresscc' configuration value; if
197 that is unspecified, default to 'self' if --suppress-from is
198 specified, as well as 'body' if --no-signed-off-cc is specified.
200 --[no-]suppress-from::
201 If this is set, do not add the From: address to the cc: list.
202 Default is the value of 'sendemail.suppressfrom' configuration
203 value; if that is unspecified, default to --no-suppress-from.
205 --[no-]thread::
206 If this is set, the In-Reply-To header will be set on each email sent.
207 If disabled with "--no-thread", no emails will have the In-Reply-To
208 header set. Default is the value of the 'sendemail.thread' configuration
209 value; if that is unspecified, default to --thread.
212 Administering
213 ~~~~~~~~~~~~~
215 --confirm=<mode>::
216 Confirm just before sending:
217 +
218 --
219 - 'always' will always confirm before sending
220 - 'never' will never confirm before sending
221 - 'cc' will confirm before sending when send-email has automatically
222 added addresses from the patch to the Cc list
223 - 'compose' will confirm before sending the first message when using --compose.
224 - 'auto' is equivalent to 'cc' + 'compose'
225 --
226 +
227 Default is the value of 'sendemail.confirm' configuration value; if that
228 is unspecified, default to 'auto' unless any of the suppress options
229 have been specified, in which case default to 'compose'.
231 --dry-run::
232 Do everything except actually send the emails.
234 --[no-]format-patch::
235 When an argument may be understood either as a reference or as a file name,
236 choose to understand it as a format-patch argument ('--format-patch')
237 or as a file name ('--no-format-patch'). By default, when such a conflict
238 occurs, git send-email will fail.
240 --quiet::
241 Make git-send-email less verbose. One line per email should be
242 all that is output.
244 --[no-]validate::
245 Perform sanity checks on patches.
246 Currently, validation means the following:
247 +
248 --
249 * Warn of patches that contain lines longer than 998 characters; this
250 is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
251 --
252 +
253 Default is the value of 'sendemail.validate'; if this is not set,
254 default to '--validate'.
257 CONFIGURATION
258 -------------
260 sendemail.aliasesfile::
261 To avoid typing long email addresses, point this to one or more
262 email aliases files. You must also supply 'sendemail.aliasfiletype'.
264 sendemail.aliasfiletype::
265 Format of the file(s) specified in sendemail.aliasesfile. Must be
266 one of 'mutt', 'mailrc', 'pine', or 'gnus'.
268 sendemail.multiedit::
269 If true (default), a single editor instance will be spawned to edit
270 files you have to edit (patches when '--annotate' is used, and the
271 summary when '--compose' is used). If false, files will be edited one
272 after the other, spawning a new editor each time.
274 sendemail.confirm::
275 Sets the default for whether to confirm before sending. Must be
276 one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm'
277 in the previous section for the meaning of these values.
280 Author
281 ------
282 Written by Ryan Anderson <ryan@michonline.com>
284 git-send-email is originally based upon
285 send_lots_of_email.pl by Greg Kroah-Hartman.
288 Documentation
289 --------------
290 Documentation by Ryan Anderson
293 GIT
294 ---
295 Part of the linkgit:git[1] suite