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> [... file|directory]
  12
  13
  14
  15 DESCRIPTION
  16 -----------
  17 Takes the patches given on the command line and emails them out.
  18
  19 The header of the email is configurable by command line options.  If not
  20 specified on the command line, the user will be prompted with a ReadLine
  21 enabled interface to provide the necessary information.
  22
  23 OPTIONS
  24 -------
  25 The options available are:
  26
  27 --bcc::
  28         Specify a "Bcc:" value for each email.
  29 +
  30 The --bcc option must be repeated for each user you want on the bcc list.
  31
  32 --cc::
  33         Specify a starting "Cc:" value for each email.
  34 +
  35 The --cc option must be repeated for each user you want on the cc list.
  36
  37 --cc-cmd::
  38         Specify a command to execute once per patch file which
  39         should generate patch file specific "Cc:" entries.
  40         Output of this command must be single email address per line.
  41         Default is the value of 'sendemail.cccmd' configuration value.
  42
  43 --[no-]chain-reply-to::
  44         If this is set, each email will be sent as a reply to the previous
  45         email sent.  If disabled with "--no-chain-reply-to", all emails after
  46         the first will be sent as replies to the first email sent.  When using
  47         this, it is recommended that the first file given be an overview of the
  48         entire patch series.
  49         Default is the value of the 'sendemail.chainreplyto' configuration
  50         value; if that is unspecified, default to --chain-reply-to.
  51
  52 --compose::
  53         Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
  54         introductory message for the patch series.
  55
  56 --from::
  57         Specify the sender of the emails.  This will default to
  58         the value GIT_COMMITTER_IDENT, as returned by "git var -l".
  59         The user will still be prompted to confirm this entry.
  60
  61 --in-reply-to::
  62         Specify the contents of the first In-Reply-To header.
  63         Subsequent emails will refer to the previous email
  64         instead of this if --chain-reply-to is set (the default)
  65         Only necessary if --compose is also set.  If --compose
  66         is not set, this will be prompted for.
  67
  68 --[no-]signed-off-by-cc::
  69         If this is set, add emails found in Signed-off-by: or Cc: lines to the
  70         cc list.
  71         Default is the value of 'sendemail.signedoffcc' configuration value;
  72         if that is unspecified, default to --signed-off-by-cc.
  73
  74 --quiet::
  75         Make git-send-email less verbose.  One line per email should be
  76         all that is output.
  77
  78 --identity::
  79         A configuration identity. When given, causes values in the
  80         'sendemail.<identity>' subsection to take precedence over
  81         values in the 'sendemail' section. The default identity is
  82         the value of 'sendemail.identity'.
  83
  84 --smtp-server::
  85         If set, specifies the outgoing SMTP server to use (e.g.
  86         `smtp.example.com` or a raw IP address).  Alternatively it can
  87         specify a full pathname of a sendmail-like program instead;
  88         the program must support the `-i` option.  Default value can
  89         be specified by the 'sendemail.smtpserver' configuration
  90         option; the built-in default is `/usr/sbin/sendmail` or
  91         `/usr/lib/sendmail` if such program is available, or
  92         `localhost` otherwise.
  93
  94 --smtp-server-port::
  95         Specifies a port different from the default port (SMTP
  96         servers typically listen to smtp port 25 and ssmtp port
  97         465).
  98
  99 --smtp-user::
 100         Username for SMTP-AUTH. In place of this option, the following
 101         configuration variables can be specified:
 102 +
 103 --
 104                 * sendemail.smtpuser
 105                 * sendemail.<identity>.smtpuser (see sendemail.identity).
 106 --
 107 +
 108 However, --smtp-user always overrides these variables.
 109 +
 110 If a username is not specified (with --smtp-user or a
 111 configuration variable), then authentication is not attempted.
 112
 113 --smtp-pass::
 114         Password for SMTP-AUTH. The argument is optional: If no
 115         argument is specified, then the empty string is used as
 116         the password.
 117 +
 118 In place of this option, the following configuration variables
 119 can be specified:
 120 +
 121 --
 122                 * sendemail.smtppass
 123                 * sendemail.<identity>.smtppass (see sendemail.identity).
 124 --
 125 +
 126 However, --smtp-pass always overrides these variables.
 127 +
 128 Furthermore, passwords need not be specified in configuration files
 129 or on the command line. If a username has been specified (with
 130 --smtp-user or a configuration variable), but no password has been
 131 specified (with --smtp-pass or a configuration variable), then the
 132 user is prompted for a password while the input is masked for privacy.
 133
 134 --smtp-encryption::
 135         Specify the encryption to use, either 'ssl' or 'tls'.  Any other
 136         value reverts to plain SMTP.  Default is the value of
 137         'sendemail.smtpencryption'.
 138
 139 --smtp-ssl::
 140         Legacy alias for '--smtp-encryption=ssl'.
 141
 142 --subject::
 143         Specify the initial subject of the email thread.
 144         Only necessary if --compose is also set.  If --compose
 145         is not set, this will be prompted for.
 146
 147 --[no-]suppress-from::
 148         If this is set, do not add the From: address to the cc: list.
 149         Default is the value of 'sendemail.suppressfrom' configuration value;
 150         if that is unspecified, default to --no-suppress-from.
 151
 152 --suppress-cc::
 153         Specify an additional category of recipients to suppress the
 154         auto-cc of.  'self' will avoid including the sender, 'author' will
 155         avoid including the patch author, 'cc' will avoid including anyone
 156         mentioned in Cc lines in the patch, 'sob' will avoid including
 157         anyone mentioned in Signed-off-by lines, and 'cccmd' will avoid
 158         running the --cc-cmd.  'all' will suppress all auto cc values.
 159         Default is the value of 'sendemail.suppresscc' configuration value;
 160         if that is unspecified, default to 'self' if --suppress-from is
 161         specified, as well as 'sob' if --no-signed-off-cc is specified.
 162
 163 --[no-]thread::
 164         If this is set, the In-Reply-To header will be set on each email sent.
 165         If disabled with "--no-thread", no emails will have the In-Reply-To
 166         header set.
 167         Default is the value of the 'sendemail.thread' configuration value;
 168         if that is unspecified, default to --thread.
 169
 170 --dry-run::
 171         Do everything except actually send the emails.
 172
 173 --envelope-sender::
 174         Specify the envelope sender used to send the emails.
 175         This is useful if your default address is not the address that is
 176         subscribed to a list. If you use the sendmail binary, you must have
 177         suitable privileges for the -f parameter.
 178         Default is the value of the 'sendemail.envelopesender' configuration
 179         variable; if that is unspecified, choosing the envelope sender is left
 180         to your MTA.
 181
 182 --no-validate::
 183         Don't perform any sanity checks on patches.
 184         Currently, validation means the following:
 185 +
 186 --
 187                 *       Warn of patches that contain lines longer than 998 characters; this
 188                         is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
 189 --
 190
 191 --to::
 192         Specify the primary recipient of the emails generated.
 193         Generally, this will be the upstream maintainer of the
 194         project involved.
 195         Default is the value of the 'sendemail.to' configuration value;
 196         if that is unspecified, this will be prompted for.
 197 +
 198 The --to option must be repeated for each user you want on the to list.
 199
 200
 201 CONFIGURATION
 202 -------------
 203 sendemail.identity::
 204         The default configuration identity. When specified,
 205         'sendemail.<identity>.<item>' will have higher precedence than
 206         'sendemail.<item>'. This is useful to declare multiple SMTP
 207         identities and to hoist sensitive authentication information
 208         out of the repository and into the global configuration file.
 209
 210 sendemail.aliasesfile::
 211         To avoid typing long email addresses, point this to one or more
 212         email aliases files.  You must also supply 'sendemail.aliasfiletype'.
 213
 214 sendemail.aliasfiletype::
 215         Format of the file(s) specified in sendemail.aliasesfile. Must be
 216         one of 'mutt', 'mailrc', 'pine', or 'gnus'.
 217
 218 sendemail.to::
 219         Email address (or alias) to always send to.
 220
 221 sendemail.cccmd::
 222         Command to execute to generate per patch file specific "Cc:"s.
 223
 224 sendemail.bcc::
 225         Email address (or alias) to always bcc.
 226
 227 sendemail.chainreplyto::
 228         Boolean value specifying the default to the '--chain_reply_to'
 229         parameter.
 230
 231 sendemail.smtpserver::
 232         Default SMTP server to use.
 233
 234 sendemail.smtpserverport::
 235         Default SMTP server port to use.
 236
 237 sendemail.smtpuser::
 238         Default SMTP-AUTH username.
 239
 240 sendemail.smtppass::
 241         Default SMTP-AUTH password.
 242
 243 sendemail.smtpencryption::
 244         Default encryption method.  Use 'ssl' for SSL (and specify an
 245         appropriate port), or 'tls' for TLS.  Takes precedence over
 246         'smtpssl' if both are specified.
 247
 248 sendemail.smtpssl::
 249         Legacy boolean that sets 'smtpencryption=ssl' if enabled.
 250
 251 Author
 252 ------
 253 Written by Ryan Anderson <ryan@michonline.com>
 254
 255 git-send-email is originally based upon
 256 send_lots_of_email.pl by Greg Kroah-Hartman.
 257
 258 Documentation
 259 --------------
 260 Documentation by Ryan Anderson
 261
 262 GIT
 263 ---
 264 Part of the linkgit:git[1] suite