Documentation / git-send-email.txton commit Merge branch 'maint' to sync with 1.5.2.5 (c576304)
   1git-send-email(1)
   2=================
   3
   4NAME
   5----
   6git-send-email - Send a collection of patches as emails
   7
   8
   9SYNOPSIS
  10--------
  11'git-send-email' [options] <file|directory> [... file|directory]
  12
  13
  14
  15DESCRIPTION
  16-----------
  17Takes the patches given on the command line and emails them out.
  18
  19The header of the email is configurable by command line options.  If not
  20specified on the command line, the user will be prompted with a ReadLine
  21enabled interface to provide the necessary information.
  22
  23OPTIONS
  24-------
  25The options available are:
  26
  27--bcc::
  28        Specify a "Bcc:" value for each email.
  29+
  30The --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+
  35The --cc option must be repeated for each user you want on the cc list.
  36
  37--chain-reply-to, --no-chain-reply-to::
  38        If this is set, each email will be sent as a reply to the previous
  39        email sent.  If disabled with "--no-chain-reply-to", all emails after
  40        the first will be sent as replies to the first email sent.  When using
  41        this, it is recommended that the first file given be an overview of the
  42        entire patch series.
  43        Default is the value of the 'sendemail.chainreplyto' configuration
  44        value; if that is unspecified, default to --chain-reply-to.
  45
  46--compose::
  47        Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
  48        introductory message for the patch series.
  49
  50--from::
  51        Specify the sender of the emails.  This will default to
  52        the value GIT_COMMITTER_IDENT, as returned by "git-var -l".
  53        The user will still be prompted to confirm this entry.
  54
  55--in-reply-to::
  56        Specify the contents of the first In-Reply-To header.
  57        Subsequent emails will refer to the previous email
  58        instead of this if --chain-reply-to is set (the default)
  59        Only necessary if --compose is also set.  If --compose
  60        is not set, this will be prompted for.
  61
  62--signed-off-by-cc, --no-signed-off-by-cc::
  63        If this is set, add emails found in Signed-off-by: or Cc: lines to the
  64        cc list.
  65        Default is the value of 'sendemail.signedoffbycc' configuration value;
  66        if that is unspecified, default to --signed-off-by-cc.
  67
  68--quiet::
  69        Make git-send-email less verbose.  One line per email should be
  70        all that is output.
  71
  72--smtp-server::
  73        If set, specifies the outgoing SMTP server to use (e.g.
  74        `smtp.example.com` or a raw IP address).  Alternatively it can
  75        specify a full pathname of a sendmail-like program instead;
  76        the program must support the `-i` option.  Default value can
  77        be specified by the 'sendemail.smtpserver' configuration
  78        option; the built-in default is `/usr/sbin/sendmail` or
  79        `/usr/lib/sendmail` if such program is available, or
  80        `localhost` otherwise.
  81
  82--subject::
  83        Specify the initial subject of the email thread.
  84        Only necessary if --compose is also set.  If --compose
  85        is not set, this will be prompted for.
  86
  87--suppress-from, --no-suppress-from::
  88        If this is set, do not add the From: address to the cc: list, if it
  89        shows up in a From: line.
  90        Default is the value of 'sendemail.suppressfrom' configuration value;
  91        if that is unspecified, default to --no-supress-from.
  92
  93--thread, --no-thread::
  94        If this is set, the In-Reply-To header will be set on each email sent.
  95        If disabled with "--no-thread", no emails will have the In-Reply-To
  96        header set.
  97        Default is the value of the 'sendemail.thread' configuration value;
  98        if that is unspecified, default to --thread.
  99
 100--dry-run::
 101        Do everything except actually send the emails.
 102
 103--envelope-sender::
 104        Specify the envelope sender used to send the emails.
 105        This is useful if your default address is not the address that is
 106        subscribed to a list. If you use the sendmail binary, you must have
 107        suitable privileges for the -f parameter.
 108
 109--to::
 110        Specify the primary recipient of the emails generated.
 111        Generally, this will be the upstream maintainer of the
 112        project involved.
 113+
 114The --to option must be repeated for each user you want on the to list.
 115
 116
 117CONFIGURATION
 118-------------
 119sendemail.aliasesfile::
 120        To avoid typing long email addresses, point this to one or more
 121        email aliases files.  You must also supply 'sendemail.aliasfiletype'.
 122
 123sendemail.aliasfiletype::
 124        Format of the file(s) specified in sendemail.aliasesfile. Must be
 125        one of 'mutt', 'mailrc', 'pine', or 'gnus'.
 126
 127sendemail.bcc::
 128        Email address (or alias) to always bcc.
 129
 130sendemail.chainreplyto::
 131        Boolean value specifying the default to the '--chain_reply_to'
 132        parameter.
 133
 134sendemail.smtpserver::
 135        Default smtp server to use.
 136
 137Author
 138------
 139Written by Ryan Anderson <ryan@michonline.com>
 140
 141git-send-email is originally based upon
 142send_lots_of_email.pl by Greg Kroah-Hartman.
 143
 144Documentation
 145--------------
 146Documentation by Ryan Anderson
 147
 148GIT
 149---
 150Part of the gitlink:git[7] suite