Add missing reference to GIT_COMMITTER_DATE in git-commit-tree documentation
[git/dscho.git] / Documentation / git-send-email.txt
blob795db873fcda3b9248e56b3662a95f726b7a20cd
1 git-send-email(1)
2 =================
4 NAME
5 ----
6 git-send-email - Send a collection of patches as emails
9 SYNOPSIS
10 --------
11 'git-send-email' [options] <file|directory> [... file|directory]
15 DESCRIPTION
16 -----------
17 Takes the patches given on the command line and emails them out.
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.
23 OPTIONS
24 -------
25 The options available are:
27 --bcc::
28         Specify a "Bcc:" value for each email.
30 The --bcc option must be repeated for each user you want on the bcc list.
32 --cc::
33         Specify a starting "Cc:" value for each email.
35 The --cc option must be repeated for each user you want on the cc list.
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.
46 --compose::
47         Use $EDITOR to edit an introductory message for the
48         patch series.
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.
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.
62 --no-signed-off-by-cc::
63         Do not add emails found in Signed-off-by: or Cc: lines to the
64         cc list.
66 --quiet::
67         Make git-send-email less verbose.  One line per email should be
68         all that is output.
70 --smtp-server::
71         If set, specifies the outgoing SMTP server to use.  A full
72         pathname of a sendmail-like program can be specified instead;
73         the program must support the `-i` option.  Default value can
74         be specified by the 'sendemail.smtpserver' configuration
75         option; the built-in default is `/usr/sbin/sendmail` or
76         `/usr/lib/sendmail` if such program is available, or
77         `localhost` otherwise.
79 --subject::
80         Specify the initial subject of the email thread.
81         Only necessary if --compose is also set.  If --compose
82         is not set, this will be prompted for.
84 --suppress-from::
85         Do not add the From: address to the cc: list, if it shows up in a From:
86         line.
88 --dry-run::
89         Do everything except actually send the emails.
91 --envelope-sender::
92         Specify the envelope sender used to send the emails.
93         This is useful if your default address is not the address that is
94         subscribed to a list. If you use the sendmail binary, you must have
95         suitable privileges for the -f parameter.
97 --to::
98         Specify the primary recipient of the emails generated.
99         Generally, this will be the upstream maintainer of the
100         project involved.
102 The --to option must be repeated for each user you want on the to list.
105 CONFIGURATION
106 -------------
107 sendemail.aliasesfile::
108         To avoid typing long email addresses, point this to one or more
109         email aliases files.  You must also supply 'sendemail.aliasfiletype'.
111 sendemail.aliasfiletype::
112         Format of the file(s) specified in sendemail.aliasesfile. Must be
113         one of 'mutt', 'mailrc', 'pine', or 'gnus'.
115 sendemail.bcc::
116         Email address (or alias) to always bcc.
118 sendemail.chainreplyto::
119         Boolean value specifying the default to the '--chain_reply_to'
120         parameter.
122 sendemail.smtpserver::
123         Default smtp server to use.
125 Author
126 ------
127 Written by Ryan Anderson <ryan@michonline.com>
129 git-send-email is originally based upon
130 send_lots_of_email.pl by Greg Kroah-Hartman.
132 Documentation
133 --------------
134 Documentation by Ryan Anderson
138 Part of the gitlink:git[7] suite