Code

Merge branch 'maint'
[git.git] / Documentation / git-send-email.txt
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.
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.
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.
26 There are two formats accepted for patch files:
28 1. mbox format files
29 +
30 This is what linkgit:git-format-patch[1] generates.  Most headers and MIME
31 formatting are ignored.
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.
40 OPTIONS
41 -------
43 Composing
44 ~~~~~~~~~
46 --annotate::
47         Review and edit each patch you're about to send. See the
48         CONFIGURATION section for 'sendemail.multiedit'.
50 --bcc=<address>::
51         Specify a "Bcc:" value for each email. Default is the value of
52         'sendemail.bcc'.
53 +
54 The --bcc option must be repeated for each user you want on the bcc list.
56 --cc=<address>::
57         Specify a starting "Cc:" value for each email.
58         Default is the value of 'sendemail.cc'.
59 +
60 The --cc option must be repeated for each user you want on the cc list.
62 --compose::
63         Invoke a text editor (see GIT_EDITOR in linkgit:git-var[1])
64         to edit an introductory message for the patch series.
65 +
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.
71 +
72 Missing From or In-Reply-To headers will be prompted for.
73 +
74 See the CONFIGURATION section for 'sendemail.multiedit'.
76 --from=<address>::
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".
84 --in-reply-to=<identifier>::
85         Specify the contents of the first In-Reply-To header.
86         Subsequent emails will refer to the previous email
87         instead of this if --chain-reply-to is set.
88         Only necessary if --compose is also set.  If --compose
89         is not set, this will be prompted for.
91 --subject=<string>::
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.
96 --to=<address>::
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.
102 The --to option must be repeated for each user you want on the to list.
104 --8bit-encoding=<encoding>::
105         When encountering a non-ASCII message or subject that does not
106         declare its encoding, add headers/quoting to indicate it is
107         encoded in <encoding>.  Default is the value of the
108         'sendemail.assume8bitEncoding'; if that is unspecified, this
109         will be prompted for if any non-ASCII files are encountered.
111 Note that no attempts whatsoever are made to validate the encoding.
114 Sending
115 ~~~~~~~
117 --envelope-sender=<address>::
118         Specify the envelope sender used to send the emails.
119         This is useful if your default address is not the address that is
120         subscribed to a list. In order to use the 'From' address, set the
121         value to "auto". If you use the sendmail binary, you must have
122         suitable privileges for the -f parameter.  Default is the value of the
123         'sendemail.envelopesender' configuration variable; if that is
124         unspecified, choosing the envelope sender is left to your MTA.
126 --smtp-encryption=<encryption>::
127         Specify the encryption to use, either 'ssl' or 'tls'.  Any other
128         value reverts to plain SMTP.  Default is the value of
129         'sendemail.smtpencryption'.
131 --smtp-domain=<FQDN>::
132         Specifies the Fully Qualified Domain Name (FQDN) used in the
133         HELO/EHLO command to the SMTP server.  Some servers require the
134         FQDN to match your IP address.  If not set, git send-email attempts
135         to determine your FQDN automatically.  Default is the value of
136         'sendemail.smtpdomain'.
138 --smtp-pass[=<password>]::
139         Password for SMTP-AUTH. The argument is optional: If no
140         argument is specified, then the empty string is used as
141         the password. Default is the value of 'sendemail.smtppass',
142         however '--smtp-pass' always overrides this value.
144 Furthermore, passwords need not be specified in configuration files
145 or on the command line. If a username has been specified (with
146 '--smtp-user' or a 'sendemail.smtpuser'), but no password has been
147 specified (with '--smtp-pass' or 'sendemail.smtppass'), then the
148 user is prompted for a password while the input is masked for privacy.
150 --smtp-server=<host>::
151         If set, specifies the outgoing SMTP server to use (e.g.
152         `smtp.example.com` or a raw IP address).  Alternatively it can
153         specify a full pathname of a sendmail-like program instead;
154         the program must support the `-i` option.  Default value can
155         be specified by the 'sendemail.smtpserver' configuration
156         option; the built-in default is `/usr/sbin/sendmail` or
157         `/usr/lib/sendmail` if such program is available, or
158         `localhost` otherwise.
160 --smtp-server-port=<port>::
161         Specifies a port different from the default port (SMTP
162         servers typically listen to smtp port 25, but may also listen to
163         submission port 587, or the common SSL smtp port 465);
164         symbolic port names (e.g. "submission" instead of 587)
165         are also accepted. The port can also be set with the
166         'sendemail.smtpserverport' configuration variable.
168 --smtp-ssl::
169         Legacy alias for '--smtp-encryption ssl'.
171 --smtp-user=<user>::
172         Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser';
173         if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),
174         then authentication is not attempted.
177 Automating
178 ~~~~~~~~~~
180 --cc-cmd=<command>::
181         Specify a command to execute once per patch file which
182         should generate patch file specific "Cc:" entries.
183         Output of this command must be single email address per line.
184         Default is the value of 'sendemail.cccmd' configuration value.
186 --[no-]chain-reply-to::
187         If this is set, each email will be sent as a reply to the previous
188         email sent.  If disabled with "--no-chain-reply-to", all emails after
189         the first will be sent as replies to the first email sent.  When using
190         this, it is recommended that the first file given be an overview of the
191         entire patch series. Disabled by default, but the 'sendemail.chainreplyto'
192         configuration variable can be used to enable it.
194 --identity=<identity>::
195         A configuration identity. When given, causes values in the
196         'sendemail.<identity>' subsection to take precedence over
197         values in the 'sendemail' section. The default identity is
198         the value of 'sendemail.identity'.
200 --[no-]signed-off-by-cc::
201         If this is set, add emails found in Signed-off-by: or Cc: lines to the
202         cc list. Default is the value of 'sendemail.signedoffbycc' configuration
203         value; if that is unspecified, default to --signed-off-by-cc.
205 --suppress-cc=<category>::
206         Specify an additional category of recipients to suppress the
207         auto-cc of:
209 --
210 - 'author' will avoid including the patch author
211 - 'self' will avoid including the sender
212 - 'cc' will avoid including anyone mentioned in Cc lines in the patch header
213   except for self (use 'self' for that).
214 - 'bodycc' will avoid including anyone mentioned in Cc lines in the
215   patch body (commit message) except for self (use 'self' for that).
216 - 'sob' will avoid including anyone mentioned in Signed-off-by lines except
217    for self (use 'self' for that).
218 - 'cccmd' will avoid running the --cc-cmd.
219 - 'body' is equivalent to 'sob' + 'bodycc'
220 - 'all' will suppress all auto cc values.
221 --
223 Default is the value of 'sendemail.suppresscc' configuration value; if
224 that is unspecified, default to 'self' if --suppress-from is
225 specified, as well as 'body' if --no-signed-off-cc is specified.
227 --[no-]suppress-from::
228         If this is set, do not add the From: address to the cc: list.
229         Default is the value of 'sendemail.suppressfrom' configuration
230         value; if that is unspecified, default to --no-suppress-from.
232 --[no-]thread::
233         If this is set, the In-Reply-To and References headers will be
234         added to each email sent.  Whether each mail refers to the
235         previous email (`deep` threading per 'git format-patch'
236         wording) or to the first email (`shallow` threading) is
237         governed by "--[no-]chain-reply-to".
239 If disabled with "--no-thread", those headers will not be added
240 (unless specified with --in-reply-to).  Default is the value of the
241 'sendemail.thread' configuration value; if that is unspecified,
242 default to --thread.
244 It is up to the user to ensure that no In-Reply-To header already
245 exists when 'git send-email' is asked to add it (especially note that
246 'git format-patch' can be configured to do the threading itself).
247 Failure to do so may not produce the expected result in the
248 recipient's MUA.
251 Administering
252 ~~~~~~~~~~~~~
254 --confirm=<mode>::
255         Confirm just before sending:
257 --
258 - 'always' will always confirm before sending
259 - 'never' will never confirm before sending
260 - 'cc' will confirm before sending when send-email has automatically
261   added addresses from the patch to the Cc list
262 - 'compose' will confirm before sending the first message when using --compose.
263 - 'auto' is equivalent to 'cc' + 'compose'
264 --
266 Default is the value of 'sendemail.confirm' configuration value; if that
267 is unspecified, default to 'auto' unless any of the suppress options
268 have been specified, in which case default to 'compose'.
270 --dry-run::
271         Do everything except actually send the emails.
273 --[no-]format-patch::
274         When an argument may be understood either as a reference or as a file name,
275         choose to understand it as a format-patch argument ('--format-patch')
276         or as a file name ('--no-format-patch'). By default, when such a conflict
277         occurs, git send-email will fail.
279 --quiet::
280         Make git-send-email less verbose.  One line per email should be
281         all that is output.
283 --[no-]validate::
284         Perform sanity checks on patches.
285         Currently, validation means the following:
287 --
288                 *       Warn of patches that contain lines longer than 998 characters; this
289                         is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
290 --
292 Default is the value of 'sendemail.validate'; if this is not set,
293 default to '--validate'.
296 CONFIGURATION
297 -------------
299 sendemail.aliasesfile::
300         To avoid typing long email addresses, point this to one or more
301         email aliases files.  You must also supply 'sendemail.aliasfiletype'.
303 sendemail.aliasfiletype::
304         Format of the file(s) specified in sendemail.aliasesfile. Must be
305         one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus'.
307 sendemail.multiedit::
308         If true (default), a single editor instance will be spawned to edit
309         files you have to edit (patches when '--annotate' is used, and the
310         summary when '--compose' is used). If false, files will be edited one
311         after the other, spawning a new editor each time.
313 sendemail.confirm::
314         Sets the default for whether to confirm before sending. Must be
315         one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm'
316         in the previous section for the meaning of these values.
319 Use gmail as the smtp server
320 ----------------------------
322 Add the following section to the config file:
324         [sendemail]
325                 smtpencryption = tls
326                 smtpserver = smtp.gmail.com
327                 smtpuser = yourname@gmail.com
328                 smtpserverport = 587
330 Note: the following perl modules are required
331       Net::SMTP::SSL, MIME::Base64 and Authen::SASL
334 Author
335 ------
336 Written by Ryan Anderson <ryan@michonline.com>
338 git-send-email is originally based upon
339 send_lots_of_email.pl by Greg Kroah-Hartman.
342 Documentation
343 --------------
344 Documentation by Ryan Anderson
347 GIT
348 ---
349 Part of the linkgit:git[1] suite