Documentation / git-send-email.txton commit Merge branch 'maint' (c43f64a)
   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 $EDITOR to edit an introductory message for the
  48        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--no-signed-off-by-cc::
  63        Do not add emails found in Signed-off-by: or Cc: lines to the
  64        cc list.
  65
  66--quiet::
  67        Make git-send-email less verbose.  One line per email should be
  68        all that is output.
  69
  70--smtp-server::
  71        If set, specifies the outgoing SMTP server to use (e.g.
  72        `smtp.example.com` or a raw IP address).  Alternatively it can
  73        specify a full pathname of a sendmail-like program instead;
  74        the program must support the `-i` option.  Default value can
  75        be specified by the 'sendemail.smtpserver' configuration
  76        option; the built-in default is `/usr/sbin/sendmail` or
  77        `/usr/lib/sendmail` if such program is available, or
  78        `localhost` otherwise.
  79
  80--subject::
  81        Specify the initial subject of the email thread.
  82        Only necessary if --compose is also set.  If --compose
  83        is not set, this will be prompted for.
  84
  85--suppress-from::
  86        Do not add the From: address to the cc: list, if it shows up in a From:
  87        line.
  88
  89--dry-run::
  90        Do everything except actually send the emails.
  91
  92--envelope-sender::
  93        Specify the envelope sender used to send the emails.
  94        This is useful if your default address is not the address that is
  95        subscribed to a list. If you use the sendmail binary, you must have
  96        suitable privileges for the -f parameter.
  97
  98--to::
  99        Specify the primary recipient of the emails generated.
 100        Generally, this will be the upstream maintainer of the
 101        project involved.
 102+
 103The --to option must be repeated for each user you want on the to list.
 104
 105
 106CONFIGURATION
 107-------------
 108sendemail.aliasesfile::
 109        To avoid typing long email addresses, point this to one or more
 110        email aliases files.  You must also supply 'sendemail.aliasfiletype'.
 111
 112sendemail.aliasfiletype::
 113        Format of the file(s) specified in sendemail.aliasesfile. Must be
 114        one of 'mutt', 'mailrc', 'pine', or 'gnus'.
 115
 116sendemail.bcc::
 117        Email address (or alias) to always bcc.
 118
 119sendemail.chainreplyto::
 120        Boolean value specifying the default to the '--chain_reply_to'
 121        parameter.
 122
 123sendemail.smtpserver::
 124        Default smtp server to use.
 125
 126Author
 127------
 128Written by Ryan Anderson <ryan@michonline.com>
 129
 130git-send-email is originally based upon
 131send_lots_of_email.pl by Greg Kroah-Hartman.
 132
 133Documentation
 134--------------
 135Documentation by Ryan Anderson
 136
 137GIT
 138---
 139Part of the gitlink:git[7] suite