Merge branches 'jc/clone' and 'jc/name'
[git/jnareb-git.git] / Documentation / git-send-email.txt
blob8c58685e280614238143f50df5f97f0777c0470f
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 --cc::
28         Specify a starting "Cc:" value for each email.
30 --chain-reply-to, --no-chain-reply-to::
31         If this is set, each email will be sent as a reply to the previous
32         email sent.  If disabled with "--no-chain-reply-to", all emails after
33         the first will be sent as replies to the first email sent.  When using
34         this, it is recommended that the first file given be an overview of the
35         entire patch series.
36         Default is --chain-reply-to
38 --compose::
39         Use $EDITOR to edit an introductory message for the
40         patch series.
42 --from::
43         Specify the sender of the emails.  This will default to
44         the value GIT_COMMITTER_IDENT, as returned by "git-var -l".
45         The user will still be prompted to confirm this entry.
47 --in-reply-to::
48         Specify the contents of the first In-Reply-To header.
49         Subsequent emails will refer to the previous email 
50         instead of this if --chain-reply-to is set (the default)
51         Only necessary if --compose is also set.  If --compose
52         is not set, this will be prompted for.
54 --no-signed-off-by-cc::
55         Do not add emails foudn in Signed-off-by: lines to the cc list.
57 --quiet::
58         Make git-send-email less verbose.  One line per email should be
59         all that is output.
61 --smtp-server::
62         If set, specifies the outgoing SMTP server to use.  Defaults to
63         localhost.
65 --subject::
66         Specify the initial subject of the email thread.
67         Only necessary if --compose is also set.  If --compose
68         is not set, this will be prompted for.
70 --suppress-from::
71         Do not add the From: address to the cc: list, if it shows up in a From:
72         line.
74 --to::
75         Specify the primary recipient of the emails generated.
76         Generally, this will be the upstream maintainer of the
77         project involved.
80 Author
81 ------
82 Written by Ryan Anderson <ryan@michonline.com>
84 git-send-email is originally based upon
85 send_lots_of_email.pl by Greg Kroah-Hartman.
87 Documentation
88 --------------
89 Documentation by Ryan Anderson
91 GIT
92 ---
93 Part of the gitlink:git[7] suite