user-manual: use pithier example commit
[gitweb.git] / Documentation / git-send-email.txt
index a2763bd74fbad3a79b09588312127a1b98911a56..7ae39fd5a20a869db8c2be101d7001c1c48ff198 100644 (file)
@@ -1,6 +1,5 @@
 git-send-email(1)
 =================
-v0.1, July 2005
 
 NAME
 ----
@@ -21,46 +20,108 @@ The header of the email is configurable by command line options.  If not
 specified on the command line, the user will be prompted with a ReadLine
 enabled interface to provide the necessary information.
 
+OPTIONS
+-------
 The options available are:
 
-  --to
-       Specify the primary recipient of the emails generated.
-       Generally, this will be the upstream maintainer of the
-       project involved.
+--bcc::
+       Specify a "Bcc:" value for each email.
++
+The --bcc option must be repeated for each user you want on the bcc list.
+
+--cc::
+       Specify a starting "Cc:" value for each email.
++
+The --cc option must be repeated for each user you want on the cc list.
+
+--chain-reply-to, --no-chain-reply-to::
+       If this is set, each email will be sent as a reply to the previous
+       email sent.  If disabled with "--no-chain-reply-to", all emails after
+       the first will be sent as replies to the first email sent.  When using
+       this, it is recommended that the first file given be an overview of the
+       entire patch series.
+       Default is the value of the 'sendemail.chainreplyto' configuration
+       value; if that is unspecified, default to --chain-reply-to.
+
+--compose::
+       Use $EDITOR to edit an introductory message for the
+       patch series.
 
-   --from
+--from::
        Specify the sender of the emails.  This will default to
        the value GIT_COMMITTER_IDENT, as returned by "git-var -l".
        The user will still be prompted to confirm this entry.
 
-   --compose
-       Use \$EDITOR to edit an introductory message for the
-       patch series.
-
-   --subject
-       Specify the initial subject of the email thread.
+--in-reply-to::
+       Specify the contents of the first In-Reply-To header.
+       Subsequent emails will refer to the previous email
+       instead of this if --chain-reply-to is set (the default)
        Only necessary if --compose is also set.  If --compose
        is not set, this will be prompted for.
 
-   --in-reply-to
-       Specify the contents of the first In-Reply-To header.
-       Subsequent emails will refer to the previous email 
-       instead of this if --chain-reply-to is set (the default)
+--no-signed-off-by-cc::
+       Do not add emails found in Signed-off-by: or Cc: lines to the
+       cc list.
+
+--quiet::
+       Make git-send-email less verbose.  One line per email should be
+       all that is output.
+
+--smtp-server::
+       If set, specifies the outgoing SMTP server to use (e.g.
+       `smtp.example.com` or a raw IP address).  Alternatively it can
+       specify a full pathname of a sendmail-like program instead;
+       the program must support the `-i` option.  Default value can
+       be specified by the 'sendemail.smtpserver' configuration
+       option; the built-in default is `/usr/sbin/sendmail` or
+       `/usr/lib/sendmail` if such program is available, or
+       `localhost` otherwise.
+
+--subject::
+       Specify the initial subject of the email thread.
        Only necessary if --compose is also set.  If --compose
        is not set, this will be prompted for.
 
-   --chain-reply-to, --no-chain-reply-to
-       If this is set, each email will be sent as a reply to the previous
-       email sent.  If disabled with "--no-chain-reply-to", all emails after
-       the first will be sent as replies to the first email sent.  When using
-       this, it is recommended that the first file given be an overview of the
-       entire patch series.
-       Default is --chain-reply-to
+--suppress-from::
+       Do not add the From: address to the cc: list, if it shows up in a From:
+       line.
+
+--dry-run::
+       Do everything except actually send the emails.
+
+--envelope-sender::
+       Specify the envelope sender used to send the emails.
+       This is useful if your default address is not the address that is
+       subscribed to a list. If you use the sendmail binary, you must have
+       suitable privileges for the -f parameter.
+
+--to::
+       Specify the primary recipient of the emails generated.
+       Generally, this will be the upstream maintainer of the
+       project involved.
++
+The --to option must be repeated for each user you want on the to list.
+
+
+CONFIGURATION
+-------------
+sendemail.aliasesfile::
+       To avoid typing long email addresses, point this to one or more
+       email aliases files.  You must also supply 'sendemail.aliasfiletype'.
+
+sendemail.aliasfiletype::
+       Format of the file(s) specified in sendemail.aliasesfile. Must be
+       one of 'mutt', 'mailrc', 'pine', or 'gnus'.
+
+sendemail.bcc::
+       Email address (or alias) to always bcc.
 
-   --smtp-server
-       If set, specifies the outgoing SMTP server to use.  Defaults to
-       localhost.
+sendemail.chainreplyto::
+       Boolean value specifying the default to the '--chain_reply_to'
+       parameter.
 
+sendemail.smtpserver::
+       Default smtp server to use.
 
 Author
 ------