Merge branch 'sp/maint-no-thin' into maint
[gitweb.git] / Documentation / git-send-email.txt
index 367646efab2462f99f04c9a9a9e875a89e884406..16bfd7be2271d21d8d380e9f4e20307569f3a538 100644 (file)
@@ -34,17 +34,24 @@ The --bcc option must be repeated for each user you want on the bcc list.
 +
 The --cc option must be repeated for each user you want on the cc list.
 
+--cc-cmd::
+       Specify a command to execute once per patch file which
+       should generate patch file specific "Cc:" entries.
+       Output of this command must be single email address per line.
+       Default is the value of 'sendemail.cccmd' configuration value.
+
 --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
+       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.
+       Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
+       introductory message for the patch series.
 
 --from::
        Specify the sender of the emails.  This will default to
@@ -53,21 +60,25 @@ The --cc option must be repeated for each user you want on the cc list.
 
 --in-reply-to::
        Specify the contents of the first In-Reply-To header.
-       Subsequent emails will refer to the previous email 
+       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.
 
---no-signed-off-by-cc::
-       Do not add emails found in Signed-off-by: lines to the cc list.
+--signed-off-by-cc, --no-signed-off-by-cc::
+        If this is set, add emails found in Signed-off-by: or Cc: lines to the
+        cc list.
+        Default is the value of 'sendemail.signedoffcc' configuration value;
+        if that is unspecified, default to --signed-off-by-cc.
 
 --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.  A full
-       pathname of a sendmail-like program can be specified instead;
+       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
@@ -75,13 +86,31 @@ The --cc option must be repeated for each user you want on the cc list.
        `localhost` otherwise.
 
 --subject::
-       Specify the initial subject of the email thread.
+       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.
 
---suppress-from::
-       Do not add the From: address to the cc: list, if it shows up in a From:
-       line.
+--suppress-from, --no-suppress-from::
+        If this is set, do not add the From: address to the cc: list, if it
+        shows up in a From: line.
+        Default is the value of 'sendemail.suppressfrom' configuration value;
+        if that is unspecified, default to --no-suppress-from.
+
+--thread, --no-thread::
+       If this is set, the In-Reply-To header will be set on each email sent.
+       If disabled with "--no-thread", no emails will have the In-Reply-To
+       header set.
+       Default is the value of the 'sendemail.thread' configuration value;
+       if that is unspecified, default to --thread.
+
+--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.
@@ -101,6 +130,16 @@ sendemail.aliasfiletype::
        Format of the file(s) specified in sendemail.aliasesfile. Must be
        one of 'mutt', 'mailrc', 'pine', or 'gnus'.
 
+sendemail.cccmd::
+       Command to execute to generate per patch file specific "Cc:"s.
+
+sendemail.bcc::
+       Email address (or alias) to always bcc.
+
+sendemail.chainreplyto::
+       Boolean value specifying the default to the '--chain_reply_to'
+       parameter.
+
 sendemail.smtpserver::
        Default smtp server to use.
 
@@ -118,4 +157,3 @@ Documentation by Ryan Anderson
 GIT
 ---
 Part of the gitlink:git[7] suite
-