Documentation/git-send-email.txt

   1 git-send-email(1)
   2 =================
   3
   4 NAME
   5 ----
   6 git-send-email - Send a collection of patches as emails
   7
   8
   9 SYNOPSIS
  10 --------
  11 'git send-email' [options] <file|directory|rev-list options>...
  12
  13
  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.
  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
  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
  39
  40 OPTIONS
  41 -------
  42
  43 Composing
  44 ~~~~~~~~~
  45
  46 --annotate::
  47         Review and edit each patch you're about to send. See the
  48         CONFIGURATION section for 'sendemail.multiedit'.
  49
  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.
  55
  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.
  61
  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'.
  75
  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".
  83
  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.
  90
  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.
  95
  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.
 101 +
 102 The --to option must be repeated for each user you want on the to list.
 103
 104
 105 Sending
 106 ~~~~~~~
 107
 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.
 116
 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'.
 121
 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.
 127
 128 --smtp-pass[=<password>]::
 129         Password for SMTP-AUTH. The argument is optional: If no
 130         argument is specified, then the empty string is used as
 131         the password. Default is the value of 'sendemail.smtppass',
 132         however '--smtp-pass' always overrides this value.
 133 +
 134 Furthermore, passwords need not be specified in configuration files
 135 or on the command line. If a username has been specified (with
 136 '--smtp-user' or a 'sendemail.smtpuser'), but no password has been
 137 specified (with '--smtp-pass' or 'sendemail.smtppass'), then the
 138 user is prompted for a password while the input is masked for privacy.
 139
 140 --smtp-server=<host>::
 141         If set, specifies the outgoing SMTP server to use (e.g.
 142         `smtp.example.com` or a raw IP address).  Alternatively it can
 143         specify a full pathname of a sendmail-like program instead;
 144         the program must support the `-i` option.  Default value can
 145         be specified by the 'sendemail.smtpserver' configuration
 146         option; the built-in default is `/usr/sbin/sendmail` or
 147         `/usr/lib/sendmail` if such program is available, or
 148         `localhost` otherwise.
 149
 150 --smtp-server-port=<port>::
 151         Specifies a port different from the default port (SMTP
 152         servers typically listen to smtp port 25, but may also listen to
 153         submission port 587, or the common SSL smtp port 465);
 154         symbolic port names (e.g. "submission" instead of 587)
 155         are also accepted. The port can also be set with the
 156         'sendemail.smtpserverport' configuration variable.
 157
 158 --smtp-ssl::
 159         Legacy alias for '--smtp-encryption ssl'.
 160
 161 --smtp-user=<user>::
 162         Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser';
 163         if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),
 164         then authentication is not attempted.
 165
 166
 167 Automating
 168 ~~~~~~~~~~
 169
 170 --cc-cmd=<command>::
 171         Specify a command to execute once per patch file which
 172         should generate patch file specific "Cc:" entries.
 173         Output of this command must be single email address per line.
 174         Default is the value of 'sendemail.cccmd' configuration value.
 175
 176 --[no-]chain-reply-to::
 177         If this is set, each email will be sent as a reply to the previous
 178         email sent.  If disabled with "--no-chain-reply-to", all emails after
 179         the first will be sent as replies to the first email sent.  When using
 180         this, it is recommended that the first file given be an overview of the
 181         entire patch series. Disabled by default, but the 'sendemail.chainreplyto'
 182         configuration variable can be used to enable it.
 183
 184 --identity=<identity>::
 185         A configuration identity. When given, causes values in the
 186         'sendemail.<identity>' subsection to take precedence over
 187         values in the 'sendemail' section. The default identity is
 188         the value of 'sendemail.identity'.
 189
 190 --[no-]signed-off-by-cc::
 191         If this is set, add emails found in Signed-off-by: or Cc: lines to the
 192         cc list. Default is the value of 'sendemail.signedoffbycc' configuration
 193         value; if that is unspecified, default to --signed-off-by-cc.
 194
 195 --suppress-cc=<category>::
 196         Specify an additional category of recipients to suppress the
 197         auto-cc of:
 198 +
 199 --
 200 - 'author' will avoid including the patch author
 201 - 'self' will avoid including the sender
 202 - 'cc' will avoid including anyone mentioned in Cc lines in the patch header
 203   except for self (use 'self' for that).
 204 - 'bodycc' will avoid including anyone mentioned in Cc lines in the
 205   patch body (commit message) except for self (use 'self' for that).
 206 - 'sob' will avoid including anyone mentioned in Signed-off-by lines except
 207    for self (use 'self' for that).
 208 - 'cccmd' will avoid running the --cc-cmd.
 209 - 'body' is equivalent to 'sob' + 'bodycc'
 210 - 'all' will suppress all auto cc values.
 211 --
 212 +
 213 Default is the value of 'sendemail.suppresscc' configuration value; if
 214 that is unspecified, default to 'self' if --suppress-from is
 215 specified, as well as 'body' if --no-signed-off-cc is specified.
 216
 217 --[no-]suppress-from::
 218         If this is set, do not add the From: address to the cc: list.
 219         Default is the value of 'sendemail.suppressfrom' configuration
 220         value; if that is unspecified, default to --no-suppress-from.
 221
 222 --[no-]thread::
 223         If this is set, the In-Reply-To and References headers will be
 224         added to each email sent.  Whether each mail refers to the
 225         previous email (`deep` threading per 'git format-patch'
 226         wording) or to the first email (`shallow` threading) is
 227         governed by "--[no-]chain-reply-to".
 228 +
 229 If disabled with "--no-thread", those headers will not be added
 230 (unless specified with --in-reply-to).  Default is the value of the
 231 'sendemail.thread' configuration value; if that is unspecified,
 232 default to --thread.
 233 +
 234 It is up to the user to ensure that no In-Reply-To header already
 235 exists when 'git send-email' is asked to add it (especially note that
 236 'git format-patch' can be configured to do the threading itself).
 237 Failure to do so may not produce the expected result in the
 238 recipient's MUA.
 239
 240
 241 Administering
 242 ~~~~~~~~~~~~~
 243
 244 --confirm=<mode>::
 245         Confirm just before sending:
 246 +
 247 --
 248 - 'always' will always confirm before sending
 249 - 'never' will never confirm before sending
 250 - 'cc' will confirm before sending when send-email has automatically
 251   added addresses from the patch to the Cc list
 252 - 'compose' will confirm before sending the first message when using --compose.
 253 - 'auto' is equivalent to 'cc' + 'compose'
 254 --
 255 +
 256 Default is the value of 'sendemail.confirm' configuration value; if that
 257 is unspecified, default to 'auto' unless any of the suppress options
 258 have been specified, in which case default to 'compose'.
 259
 260 --dry-run::
 261         Do everything except actually send the emails.
 262
 263 --[no-]format-patch::
 264         When an argument may be understood either as a reference or as a file name,
 265         choose to understand it as a format-patch argument ('--format-patch')
 266         or as a file name ('--no-format-patch'). By default, when such a conflict
 267         occurs, git send-email will fail.
 268
 269 --quiet::
 270         Make git-send-email less verbose.  One line per email should be
 271         all that is output.
 272
 273 --[no-]validate::
 274         Perform sanity checks on patches.
 275         Currently, validation means the following:
 276 +
 277 --
 278                 *       Warn of patches that contain lines longer than 998 characters; this
 279                         is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
 280 --
 281 +
 282 Default is the value of 'sendemail.validate'; if this is not set,
 283 default to '--validate'.
 284
 285
 286 CONFIGURATION
 287 -------------
 288
 289 sendemail.aliasesfile::
 290         To avoid typing long email addresses, point this to one or more
 291         email aliases files.  You must also supply 'sendemail.aliasfiletype'.
 292
 293 sendemail.aliasfiletype::
 294         Format of the file(s) specified in sendemail.aliasesfile. Must be
 295         one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus'.
 296
 297 sendemail.multiedit::
 298         If true (default), a single editor instance will be spawned to edit
 299         files you have to edit (patches when '--annotate' is used, and the
 300         summary when '--compose' is used). If false, files will be edited one
 301         after the other, spawning a new editor each time.
 302
 303 sendemail.confirm::
 304         Sets the default for whether to confirm before sending. Must be
 305         one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm'
 306         in the previous section for the meaning of these values.
 307
 308
 309 Author
 310 ------
 311 Written by Ryan Anderson <ryan@michonline.com>
 312
 313 git-send-email is originally based upon
 314 send_lots_of_email.pl by Greg Kroah-Hartman.
 315
 316
 317 Documentation
 318 --------------
 319 Documentation by Ryan Anderson
 320
 321
 322 GIT
 323 ---
 324 Part of the linkgit:git[1] suite