Documentation: begin discussion of git-remote in user manual
[git/jrn.git] / Documentation / git-send-email.txt
blob4c8d907bd595a4f31b3f53cfff25b84cea059ff7
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 --chain-reply-to
45 --compose::
46         Use $EDITOR to edit an introductory message for the
47         patch series.
49 --from::
50         Specify the sender of the emails.  This will default to
51         the value GIT_COMMITTER_IDENT, as returned by "git-var -l".
52         The user will still be prompted to confirm this entry.
54 --in-reply-to::
55         Specify the contents of the first In-Reply-To header.
56         Subsequent emails will refer to the previous email 
57         instead of this if --chain-reply-to is set (the default)
58         Only necessary if --compose is also set.  If --compose
59         is not set, this will be prompted for.
61 --no-signed-off-by-cc::
62         Do not add emails found in Signed-off-by: lines to the cc list.
64 --quiet::
65         Make git-send-email less verbose.  One line per email should be
66         all that is output.
68 --smtp-server::
69         If set, specifies the outgoing SMTP server to use.  A full
70         pathname of a sendmail-like program can be specified instead;
71         the program must support the `-i` option.  Default value can
72         be specified by the 'sendemail.smtpserver' configuration
73         option; the built-in default is `/usr/sbin/sendmail` or
74         `/usr/lib/sendmail` if such program is available, or
75         `localhost` otherwise.
77 --subject::
78         Specify the initial subject of the email thread.
79         Only necessary if --compose is also set.  If --compose
80         is not set, this will be prompted for.
82 --suppress-from::
83         Do not add the From: address to the cc: list, if it shows up in a From:
84         line.
86 --to::
87         Specify the primary recipient of the emails generated.
88         Generally, this will be the upstream maintainer of the
89         project involved.
91         The --to option must be repeated for each user you want on the to list.
94 Author
95 ------
96 Written by Ryan Anderson <ryan@michonline.com>
98 git-send-email is originally based upon
99 send_lots_of_email.pl by Greg Kroah-Hartman.
101 Documentation
102 --------------
103 Documentation by Ryan Anderson
107 Part of the gitlink:git[7] suite