gitweb: Add git_merge sub
[git/gsoc2010-gitweb.git] / Documentation / git-send-email.txt
blob12622fc49a0825fa8423c46ddddc06ff89f292d4
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
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
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'.
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'.
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.
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.
72 Missing From or In-Reply-To headers will be prompted for.
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.
105 Sending
106 ~~~~~~~
108 --envelope-sender=<address>::
109         Specify the envelope sender used to send the emails.
110         This is useful if your default address is not the address that is
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
115         unspecified, choosing the envelope sender is left to your MTA.
117 --smtp-encryption=<encryption>::
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'.
122 --smtp-domain=<FQDN>::
123         Specifies the Fully Qualified Domain Name (FQDN) used in the
124         HELO/EHLO command to the SMTP server.  Some servers require the
125         FQDN to match your IP address.  If not set, git send-email attempts
126         to determine your FQDN automatically.  Default is the value of
127         'sendemail.smtpdomain'.
129 --smtp-pass[=<password>]::
130         Password for SMTP-AUTH. The argument is optional: If no
131         argument is specified, then the empty string is used as
132         the password. Default is the value of 'sendemail.smtppass',
133         however '--smtp-pass' always overrides this value.
135 Furthermore, passwords need not be specified in configuration files
136 or on the command line. If a username has been specified (with
137 '--smtp-user' or a 'sendemail.smtpuser'), but no password has been
138 specified (with '--smtp-pass' or 'sendemail.smtppass'), then the
139 user is prompted for a password while the input is masked for privacy.
141 --smtp-server=<host>::
142         If set, specifies the outgoing SMTP server to use (e.g.
143         `smtp.example.com` or a raw IP address).  Alternatively it can
144         specify a full pathname of a sendmail-like program instead;
145         the program must support the `-i` option.  Default value can
146         be specified by the 'sendemail.smtpserver' configuration
147         option; the built-in default is `/usr/sbin/sendmail` or
148         `/usr/lib/sendmail` if such program is available, or
149         `localhost` otherwise.
151 --smtp-server-port=<port>::
152         Specifies a port different from the default port (SMTP
153         servers typically listen to smtp port 25, but may also listen to
154         submission port 587, or the common SSL smtp port 465);
155         symbolic port names (e.g. "submission" instead of 587)
156         are also accepted. The port can also be set with the
157         'sendemail.smtpserverport' configuration variable.
159 --smtp-ssl::
160         Legacy alias for '--smtp-encryption ssl'.
162 --smtp-user=<user>::
163         Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser';
164         if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),
165         then authentication is not attempted.
168 Automating
169 ~~~~~~~~~~
171 --cc-cmd=<command>::
172         Specify a command to execute once per patch file which
173         should generate patch file specific "Cc:" entries.
174         Output of this command must be single email address per line.
175         Default is the value of 'sendemail.cccmd' configuration value.
177 --[no-]chain-reply-to::
178         If this is set, each email will be sent as a reply to the previous
179         email sent.  If disabled with "--no-chain-reply-to", all emails after
180         the first will be sent as replies to the first email sent.  When using
181         this, it is recommended that the first file given be an overview of the
182         entire patch series. Disabled by default, but the 'sendemail.chainreplyto'
183         configuration variable can be used to enable it.
185 --identity=<identity>::
186         A configuration identity. When given, causes values in the
187         'sendemail.<identity>' subsection to take precedence over
188         values in the 'sendemail' section. The default identity is
189         the value of 'sendemail.identity'.
191 --[no-]signed-off-by-cc::
192         If this is set, add emails found in Signed-off-by: or Cc: lines to the
193         cc list. Default is the value of 'sendemail.signedoffbycc' configuration
194         value; if that is unspecified, default to --signed-off-by-cc.
196 --suppress-cc=<category>::
197         Specify an additional category of recipients to suppress the
198         auto-cc of:
201 - 'author' will avoid including the patch author
202 - 'self' will avoid including the sender
203 - 'cc' will avoid including anyone mentioned in Cc lines in the patch header
204   except for self (use 'self' for that).
205 - 'bodycc' will avoid including anyone mentioned in Cc lines in the
206   patch body (commit message) except for self (use 'self' for that).
207 - 'sob' will avoid including anyone mentioned in Signed-off-by lines except
208    for self (use 'self' for that).
209 - 'cccmd' will avoid running the --cc-cmd.
210 - 'body' is equivalent to 'sob' + 'bodycc'
211 - 'all' will suppress all auto cc values.
214 Default is the value of 'sendemail.suppresscc' configuration value; if
215 that is unspecified, default to 'self' if --suppress-from is
216 specified, as well as 'body' if --no-signed-off-cc is specified.
218 --[no-]suppress-from::
219         If this is set, do not add the From: address to the cc: list.
220         Default is the value of 'sendemail.suppressfrom' configuration
221         value; if that is unspecified, default to --no-suppress-from.
223 --[no-]thread::
224         If this is set, the In-Reply-To and References headers will be
225         added to each email sent.  Whether each mail refers to the
226         previous email (`deep` threading per 'git format-patch'
227         wording) or to the first email (`shallow` threading) is
228         governed by "--[no-]chain-reply-to".
230 If disabled with "--no-thread", those headers will not be added
231 (unless specified with --in-reply-to).  Default is the value of the
232 'sendemail.thread' configuration value; if that is unspecified,
233 default to --thread.
235 It is up to the user to ensure that no In-Reply-To header already
236 exists when 'git send-email' is asked to add it (especially note that
237 'git format-patch' can be configured to do the threading itself).
238 Failure to do so may not produce the expected result in the
239 recipient's MUA.
242 Administering
243 ~~~~~~~~~~~~~
245 --confirm=<mode>::
246         Confirm just before sending:
249 - 'always' will always confirm before sending
250 - 'never' will never confirm before sending
251 - 'cc' will confirm before sending when send-email has automatically
252   added addresses from the patch to the Cc list
253 - 'compose' will confirm before sending the first message when using --compose.
254 - 'auto' is equivalent to 'cc' + 'compose'
257 Default is the value of 'sendemail.confirm' configuration value; if that
258 is unspecified, default to 'auto' unless any of the suppress options
259 have been specified, in which case default to 'compose'.
261 --dry-run::
262         Do everything except actually send the emails.
264 --[no-]format-patch::
265         When an argument may be understood either as a reference or as a file name,
266         choose to understand it as a format-patch argument ('--format-patch')
267         or as a file name ('--no-format-patch'). By default, when such a conflict
268         occurs, git send-email will fail.
270 --quiet::
271         Make git-send-email less verbose.  One line per email should be
272         all that is output.
274 --[no-]validate::
275         Perform sanity checks on patches.
276         Currently, validation means the following:
279                 *       Warn of patches that contain lines longer than 998 characters; this
280                         is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
283 Default is the value of 'sendemail.validate'; if this is not set,
284 default to '--validate'.
287 CONFIGURATION
288 -------------
290 sendemail.aliasesfile::
291         To avoid typing long email addresses, point this to one or more
292         email aliases files.  You must also supply 'sendemail.aliasfiletype'.
294 sendemail.aliasfiletype::
295         Format of the file(s) specified in sendemail.aliasesfile. Must be
296         one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus'.
298 sendemail.multiedit::
299         If true (default), a single editor instance will be spawned to edit
300         files you have to edit (patches when '--annotate' is used, and the
301         summary when '--compose' is used). If false, files will be edited one
302         after the other, spawning a new editor each time.
304 sendemail.confirm::
305         Sets the default for whether to confirm before sending. Must be
306         one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm'
307         in the previous section for the meaning of these values.
310 Use gmail as the smtp server
311 ----------------------------
313 Add the following section to the config file:
315         [sendemail]
316                 smtpencryption = tls
317                 smtpserver = smtp.gmail.com
318                 smtpuser = yourname@gmail.com
319                 smtpserverport = 587
321 Note: the following perl modules are required
322       Net::SMTP::SSL, MIME::Base64 and Authen::SASL
325 Author
326 ------
327 Written by Ryan Anderson <ryan@michonline.com>
329 git-send-email is originally based upon
330 send_lots_of_email.pl by Greg Kroah-Hartman.
333 Documentation
334 --------------
335 Documentation by Ryan Anderson
340 Part of the linkgit:git[1] suite