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
  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.
  21
  22 There are two formats accepted for patch files:
  23
  24 1. mbox format files
  25 +
  26 This is what linkgit:git-format-patch[1] generates.  Most headers and MIME
  27 formatting are ignored.
  28
  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.
  34
  35
  36 OPTIONS
  37 -------
  38
  39 Composing
  40 ~~~~~~~~~
  41
  42 --annotate::
  43         Review and edit each patch you're about to send. See the
  44         CONFIGURATION section for 'sendemail.multiedit'.
  45
  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.
  51
  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.
  57
  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'.
  71
  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.
  76
  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.
  83
  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.
  88
  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.
  96
  97
  98 Sending
  99 ~~~~~~~
 100
 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.
 108
 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'.
 113
 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.
 125
 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.
 135
 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); symbolic port names (e.g. "submission" instead of 465)
 140         are also accepted. The port can also be set with the
 141         'sendemail.smtpserverport' configuration variable.
 142
 143 --smtp-ssl::
 144         Legacy alias for '--smtp-encryption ssl'.
 145
 146 --smtp-user=<user>::
 147         Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser';
 148         if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),
 149         then authentication is not attempted.
 150
 151
 152 Automating
 153 ~~~~~~~~~~
 154
 155 --cc-cmd=<command>::
 156         Specify a command to execute once per patch file which
 157         should generate patch file specific "Cc:" entries.
 158         Output of this command must be single email address per line.
 159         Default is the value of 'sendemail.cccmd' configuration value.
 160
 161 --[no-]chain-reply-to=<identifier>::
 162         If this is set, each email will be sent as a reply to the previous
 163         email sent.  If disabled with "--no-chain-reply-to", all emails after
 164         the first will be sent as replies to the first email sent.  When using
 165         this, it is recommended that the first file given be an overview of the
 166         entire patch series. Default is the value of the 'sendemail.chainreplyto'
 167         configuration value; if that is unspecified, default to --chain-reply-to.
 168
 169 --identity=<identity>::
 170         A configuration identity. When given, causes values in the
 171         'sendemail.<identity>' subsection to take precedence over
 172         values in the 'sendemail' section. The default identity is
 173         the value of 'sendemail.identity'.
 174
 175 --[no-]signed-off-by-cc::
 176         If this is set, add emails found in Signed-off-by: or Cc: lines to the
 177         cc list. Default is the value of 'sendemail.signedoffbycc' configuration
 178         value; if that is unspecified, default to --signed-off-by-cc.
 179
 180 --suppress-cc=<category>::
 181         Specify an additional category of recipients to suppress the
 182         auto-cc of:
 183 +
 184 --
 185 - 'author' will avoid including the patch author
 186 - 'self' will avoid including the sender
 187 - 'cc' will avoid including anyone mentioned in Cc lines in the patch header
 188   except for self (use 'self' for that).
 189 - 'ccbody' will avoid including anyone mentioned in Cc lines in the
 190   patch body (commit message) except for self (use 'self' for that).
 191 - 'sob' will avoid including anyone mentioned in Signed-off-by lines except
 192    for self (use 'self' for that).
 193 - 'cccmd' will avoid running the --cc-cmd.
 194 - 'body' is equivalent to 'sob' + 'ccbody'
 195 - 'all' will suppress all auto cc values.
 196 --
 197 +
 198 Default is the value of 'sendemail.suppresscc' configuration value; if
 199 that is unspecified, default to 'self' if --suppress-from is
 200 specified, as well as 'body' if --no-signed-off-cc is specified.
 201
 202 --[no-]suppress-from::
 203         If this is set, do not add the From: address to the cc: list.
 204         Default is the value of 'sendemail.suppressfrom' configuration
 205         value; if that is unspecified, default to --no-suppress-from.
 206
 207 --[no-]thread::
 208         If this is set, the In-Reply-To header will be set on each email sent.
 209         If disabled with "--no-thread", no emails will have the In-Reply-To
 210         header set. Default is the value of the 'sendemail.thread' configuration
 211         value; if that is unspecified, default to --thread.
 212
 213
 214 Administering
 215 ~~~~~~~~~~~~~
 216
 217 --confirm=<mode>::
 218         Confirm just before sending:
 219 +
 220 --
 221 - 'always' will always confirm before sending
 222 - 'never' will never confirm before sending
 223 - 'cc' will confirm before sending when send-email has automatically
 224   added addresses from the patch to the Cc list
 225 - 'compose' will confirm before sending the first message when using --compose.
 226 - 'auto' is equivalent to 'cc' + 'compose'
 227 --
 228 +
 229 Default is the value of 'sendemail.confirm' configuration value; if that
 230 is unspecified, default to 'auto' unless any of the suppress options
 231 have been specified, in which case default to 'compose'.
 232
 233 --dry-run::
 234         Do everything except actually send the emails.
 235
 236 --[no-]format-patch::
 237         When an argument may be understood either as a reference or as a file name,
 238         choose to understand it as a format-patch argument ('--format-patch')
 239         or as a file name ('--no-format-patch'). By default, when such a conflict
 240         occurs, git send-email will fail.
 241
 242 --quiet::
 243         Make git-send-email less verbose.  One line per email should be
 244         all that is output.
 245
 246 --[no-]validate::
 247         Perform sanity checks on patches.
 248         Currently, validation means the following:
 249 +
 250 --
 251                 *       Warn of patches that contain lines longer than 998 characters; this
 252                         is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
 253 --
 254 +
 255 Default is the value of 'sendemail.validate'; if this is not set,
 256 default to '--validate'.
 257
 258
 259 CONFIGURATION
 260 -------------
 261
 262 sendemail.aliasesfile::
 263         To avoid typing long email addresses, point this to one or more
 264         email aliases files.  You must also supply 'sendemail.aliasfiletype'.
 265
 266 sendemail.aliasfiletype::
 267         Format of the file(s) specified in sendemail.aliasesfile. Must be
 268         one of 'mutt', 'mailrc', 'pine', or 'gnus'.
 269
 270 sendemail.multiedit::
 271         If true (default), a single editor instance will be spawned to edit
 272         files you have to edit (patches when '--annotate' is used, and the
 273         summary when '--compose' is used). If false, files will be edited one
 274         after the other, spawning a new editor each time.
 275
 276 sendemail.confirm::
 277         Sets the default for whether to confirm before sending. Must be
 278         one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm'
 279         in the previous section for the meaning of these values.
 280
 281
 282 Author
 283 ------
 284 Written by Ryan Anderson <ryan@michonline.com>
 285
 286 git-send-email is originally based upon
 287 send_lots_of_email.pl by Greg Kroah-Hartman.
 288
 289
 290 Documentation
 291 --------------
 292 Documentation by Ryan Anderson
 293
 294
 295 GIT
 296 ---
 297 Part of the linkgit:git[1] suite