blob: 16bfd7be2271d21d8d380e9f4e20307569f3a538 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231git-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
Junio C Hamano97f518c2006-06-22 19:49:3527--bcc::
28Specify a "Bcc:" value for each email.
Junio C Hamanoa3fd83c2007-03-02 10:34:3629+
30The --bcc option must be repeated for each user you want on the bcc list.
Junio C Hamano97f518c2006-06-22 19:49:3531
Junio C Hamanoc9154122006-02-15 02:22:0632--cc::
33Specify a starting "Cc:" value for each email.
Junio C Hamanoa3fd83c2007-03-02 10:34:3634+
35The --cc option must be repeated for each user you want on the cc list.
Junio C Hamano97f518c2006-06-22 19:49:3536
Junio C Hamanoc5653d72007-09-02 06:25:1637--cc-cmd::
38Specify a command to execute once per patch file which
39should generate patch file specific "Cc:" entries.
40Output of this command must be single email address per line.
41Default is the value of 'sendemail.cccmd' configuration value.
42
Junio C Hamano1a4e8412005-12-27 08:17:2343--chain-reply-to, --no-chain-reply-to::
44If this is set, each email will be sent as a reply to the previous
45email sent. If disabled with "--no-chain-reply-to", all emails after
46the first will be sent as replies to the first email sent. When using
47this, it is recommended that the first file given be an overview of the
48entire patch series.
Junio C Hamanoc51fede2007-03-12 07:29:2049Default is the value of the 'sendemail.chainreplyto' configuration
50value; if that is unspecified, default to --chain-reply-to.
Junio C Hamano1a4e8412005-12-27 08:17:2351
Junio C Hamano86f75882006-02-06 02:27:2352--compose::
Junio C Hamanof6002a92007-07-20 10:28:2253Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
54introductory message for the patch series.
Junio C Hamano86f75882006-02-06 02:27:2355
56--from::
57Specify the sender of the emails. This will default to
58the value GIT_COMMITTER_IDENT, as returned by "git-var -l".
59The user will still be prompted to confirm this entry.
60
61--in-reply-to::
62Specify the contents of the first In-Reply-To header.
Junio C Hamanob63afff2007-05-01 03:05:5563Subsequent emails will refer to the previous email
Junio C Hamano86f75882006-02-06 02:27:2364instead of this if --chain-reply-to is set (the default)
65Only necessary if --compose is also set. If --compose
66is not set, this will be prompted for.
67
Junio C Hamano6865ebd2007-06-28 08:16:1468--signed-off-by-cc, --no-signed-off-by-cc::
69 If this is set, add emails found in Signed-off-by: or Cc: lines to the
70 cc list.
Junio C Hamano1b11dcb2007-08-18 07:20:5571 Default is the value of 'sendemail.signedoffcc' configuration value;
Junio C Hamano6865ebd2007-06-28 08:16:1472 if that is unspecified, default to --signed-off-by-cc.
Junio C Hamanoc9154122006-02-15 02:22:0673
Junio C Hamano86f75882006-02-06 02:27:2374--quiet::
75Make git-send-email less verbose. One line per email should be
76all that is output.
77
Junio C Hamano1a4e8412005-12-27 08:17:2378--smtp-server::
Junio C Hamanob63afff2007-05-01 03:05:5579If set, specifies the outgoing SMTP server to use (e.g.
80`smtp.example.com` or a raw IP address). Alternatively it can
81specify a full pathname of a sendmail-like program instead;
Junio C Hamanob19b4f02006-10-29 20:47:2282the program must support the `-i` option. Default value can
83be specified by the 'sendemail.smtpserver' configuration
84option; the built-in default is `/usr/sbin/sendmail` or
85`/usr/lib/sendmail` if such program is available, or
86`localhost` otherwise.
Junio C Hamano1a4e8412005-12-27 08:17:2387
Junio C Hamano86f75882006-02-06 02:27:2388--subject::
Junio C Hamanoa77a5132007-06-08 16:13:4489Specify the initial subject of the email thread.
Junio C Hamano86f75882006-02-06 02:27:2390Only necessary if --compose is also set. If --compose
91is not set, this will be prompted for.
92
Junio C Hamano6865ebd2007-06-28 08:16:1493--suppress-from, --no-suppress-from::
94 If this is set, do not add the From: address to the cc: list, if it
95 shows up in a From: line.
96 Default is the value of 'sendemail.suppressfrom' configuration value;
Junio C Hamanocae86272007-08-21 02:20:4997 if that is unspecified, default to --no-suppress-from.
Junio C Hamanoc9154122006-02-15 02:22:0698
Junio C Hamano6865ebd2007-06-28 08:16:1499--thread, --no-thread::
Junio C Hamanoddc5ad42007-06-27 07:14:52100If this is set, the In-Reply-To header will be set on each email sent.
Junio C Hamano6865ebd2007-06-28 08:16:14101If disabled with "--no-thread", no emails will have the In-Reply-To
Junio C Hamanoddc5ad42007-06-27 07:14:52102header set.
Junio C Hamano6865ebd2007-06-28 08:16:14103Default is the value of the 'sendemail.thread' configuration value;
104if that is unspecified, default to --thread.
Junio C Hamanoddc5ad42007-06-27 07:14:52105
Junio C Hamano45889b42007-04-26 07:20:04106--dry-run::
107Do everything except actually send the emails.
108
109--envelope-sender::
110Specify the envelope sender used to send the emails.
111This is useful if your default address is not the address that is
112subscribed to a list. If you use the sendmail binary, you must have
113suitable privileges for the -f parameter.
114
Junio C Hamano86f75882006-02-06 02:27:23115--to::
116Specify the primary recipient of the emails generated.
117Generally, this will be the upstream maintainer of the
118project involved.
Junio C Hamanoa3fd83c2007-03-02 10:34:36119+
120The --to option must be repeated for each user you want on the to list.
Junio C Hamano97f518c2006-06-22 19:49:35121
Junio C Hamano1a4e8412005-12-27 08:17:23122
Junio C Hamanoc51fede2007-03-12 07:29:20123CONFIGURATION
124-------------
125sendemail.aliasesfile::
126To avoid typing long email addresses, point this to one or more
127email aliases files. You must also supply 'sendemail.aliasfiletype'.
128
129sendemail.aliasfiletype::
130Format of the file(s) specified in sendemail.aliasesfile. Must be
131one of 'mutt', 'mailrc', 'pine', or 'gnus'.
132
Junio C Hamanoc5653d72007-09-02 06:25:16133sendemail.cccmd::
134Command to execute to generate per patch file specific "Cc:"s.
135
Junio C Hamanoc51fede2007-03-12 07:29:20136sendemail.bcc::
137Email address (or alias) to always bcc.
138
139sendemail.chainreplyto::
140Boolean value specifying the default to the '--chain_reply_to'
141parameter.
142
143sendemail.smtpserver::
144Default smtp server to use.
145
Junio C Hamano1a4e8412005-12-27 08:17:23146Author
147------
148Written by Ryan Anderson <ryan@michonline.com>
149
150git-send-email is originally based upon
151send_lots_of_email.pl by Greg Kroah-Hartman.
152
153Documentation
154--------------
155Documentation by Ryan Anderson
156
157GIT
158---
159Part of the gitlink:git[7] suite