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.signedoffbycc' 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 --smtp-server::
  79         If set, specifies the outgoing SMTP server to use (e.g.
  80         `smtp.example.com` or a raw IP address).  Alternatively it can
  81         specify a full pathname of a sendmail-like program instead;
  82         the program must support the `-i` option.  Default value can
  83         be specified by the 'sendemail.smtpserver' configuration
  84         option; the built-in default is `/usr/sbin/sendmail` or
  85         `/usr/lib/sendmail` if such program is available, or
  86         `localhost` otherwise.
  87
  88 --subject::
  89         Specify the initial subject of the email thread.
  90         Only necessary if --compose is also set.  If --compose
  91         is not set, this will be prompted for.
  92
  93 --suppress-from, --no-suppress-from::
  94         If this is set, do not add the From: address to the cc: list, if it
  95         shows up in a From: line.
  96         Default is the value of 'sendemail.suppressfrom' configuration value;
  97         if that is unspecified, default to --no-supress-from.
  98
  99 --thread, --no-thread::
 100         If this is set, the In-Reply-To header will be set on each email sent.
 101         If disabled with "--no-thread", no emails will have the In-Reply-To
 102         header set.
 103         Default is the value of the 'sendemail.thread' configuration value;
 104         if that is unspecified, default to --thread.
 105
 106 --dry-run::
 107         Do everything except actually send the emails.
 108
 109 --envelope-sender::
 110         Specify the envelope sender used to send the emails.
 111         This is useful if your default address is not the address that is
 112         subscribed to a list. If you use the sendmail binary, you must have
 113         suitable privileges for the -f parameter.
 114
 115 --to::
 116         Specify the primary recipient of the emails generated.
 117         Generally, this will be the upstream maintainer of the
 118         project involved.
 119 +
 120 The --to option must be repeated for each user you want on the to list.
 121
 122
 123 CONFIGURATION
 124 -------------
 125 sendemail.aliasesfile::
 126         To avoid typing long email addresses, point this to one or more
 127         email aliases files.  You must also supply 'sendemail.aliasfiletype'.
 128
 129 sendemail.aliasfiletype::
 130         Format of the file(s) specified in sendemail.aliasesfile. Must be
 131         one of 'mutt', 'mailrc', 'pine', or 'gnus'.
 132
 133 sendemail.cccmd::
 134         Command to execute to generate per patch file specific "Cc:"s.
 135
 136 sendemail.bcc::
 137         Email address (or alias) to always bcc.
 138
 139 sendemail.chainreplyto::
 140         Boolean value specifying the default to the '--chain_reply_to'
 141         parameter.
 142
 143 sendemail.smtpserver::
 144         Default smtp server to use.
 145
 146 Author
 147 ------
 148 Written by Ryan Anderson <ryan@michonline.com>
 149
 150 git-send-email is originally based upon
 151 send_lots_of_email.pl by Greg Kroah-Hartman.
 152
 153 Documentation
 154 --------------
 155 Documentation by Ryan Anderson
 156
 157 GIT
 158 ---
 159 Part of the gitlink:git[7] suite