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 --chain-reply-to, --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 --signed-off-by-cc, --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-user, --smtp-pass::
  95         Username and password for SMTP-AUTH. Defaults are the values of
  96         the configuration values 'sendemail.smtpuser' and
  97         'sendemail.smtppass', but see also 'sendemail.identity'.
  98         If not set, authentication is not attempted.
  99
 100 --smtp-ssl::
 101         If set, connects to the SMTP server using SSL.
 102         Default is the value of the 'sendemail.smtpssl' configuration value;
 103         if that is unspecified, does not use SSL.
 104
 105 --subject::
 106         Specify the initial subject of the email thread.
 107         Only necessary if --compose is also set.  If --compose
 108         is not set, this will be prompted for.
 109
 110 --suppress-from, --no-suppress-from::
 111         If this is set, do not add the From: address to the cc: list, if it
 112         shows up in a From: line.
 113         Default is the value of 'sendemail.suppressfrom' configuration value;
 114         if that is unspecified, default to --no-suppress-from.
 115
 116 --thread, --no-thread::
 117         If this is set, the In-Reply-To header will be set on each email sent.
 118         If disabled with "--no-thread", no emails will have the In-Reply-To
 119         header set.
 120         Default is the value of the 'sendemail.thread' configuration value;
 121         if that is unspecified, default to --thread.
 122
 123 --dry-run::
 124         Do everything except actually send the emails.
 125
 126 --envelope-sender::
 127         Specify the envelope sender used to send the emails.
 128         This is useful if your default address is not the address that is
 129         subscribed to a list. If you use the sendmail binary, you must have
 130         suitable privileges for the -f parameter.
 131
 132 --to::
 133         Specify the primary recipient of the emails generated.
 134         Generally, this will be the upstream maintainer of the
 135         project involved.
 136 +
 137 The --to option must be repeated for each user you want on the to list.
 138
 139
 140 CONFIGURATION
 141 -------------
 142 sendemail.identity::
 143         The default configuration identity. When specified,
 144         'sendemail.<identity>.<item>' will have higher precedence than
 145         'sendemail.<item>'. This is useful to declare multiple SMTP
 146         identities and to hoist sensitive authentication information
 147         out of the repository and into the global configuation file.
 148
 149 sendemail.aliasesfile::
 150         To avoid typing long email addresses, point this to one or more
 151         email aliases files.  You must also supply 'sendemail.aliasfiletype'.
 152
 153 sendemail.aliasfiletype::
 154         Format of the file(s) specified in sendemail.aliasesfile. Must be
 155         one of 'mutt', 'mailrc', 'pine', or 'gnus'.
 156
 157 sendemail.cccmd::
 158         Command to execute to generate per patch file specific "Cc:"s.
 159
 160 sendemail.bcc::
 161         Email address (or alias) to always bcc.
 162
 163 sendemail.chainreplyto::
 164         Boolean value specifying the default to the '--chain_reply_to'
 165         parameter.
 166
 167 sendemail.smtpserver::
 168         Default SMTP server to use.
 169
 170 sendemail.smtpuser::
 171         Default SMTP-AUTH username.
 172
 173 sendemail.smtppass::
 174         Default SMTP-AUTH password.
 175
 176 sendemail.smtpssl::
 177         Boolean value specifying the default to the '--smtp-ssl' parameter.
 178
 179 Author
 180 ------
 181 Written by Ryan Anderson <ryan@michonline.com>
 182
 183 git-send-email is originally based upon
 184 send_lots_of_email.pl by Greg Kroah-Hartman.
 185
 186 Documentation
 187 --------------
 188 Documentation by Ryan Anderson
 189
 190 GIT
 191 ---
 192 Part of the gitlink:git[7] suite