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