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