git-commit: show dirtiness including index.
[git/gitweb.git] / Documentation / git-send-email.txt
blob00537d8907872aa25c39f07513ef661b1bef1f17
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 --chain-reply-to, --no-chain-reply-to::
28         If this is set, each email will be sent as a reply to the previous
29         email sent.  If disabled with "--no-chain-reply-to", all emails after
30         the first will be sent as replies to the first email sent.  When using
31         this, it is recommended that the first file given be an overview of the
32         entire patch series.
33         Default is --chain-reply-to
35 --compose::
36         Use $EDITOR to edit an introductory message for the
37         patch series.
39 --from::
40         Specify the sender of the emails.  This will default to
41         the value GIT_COMMITTER_IDENT, as returned by "git-var -l".
42         The user will still be prompted to confirm this entry.
44 --in-reply-to::
45         Specify the contents of the first In-Reply-To header.
46         Subsequent emails will refer to the previous email 
47         instead of this if --chain-reply-to is set (the default)
48         Only necessary if --compose is also set.  If --compose
49         is not set, this will be prompted for.
51 --quiet::
52         Make git-send-email less verbose.  One line per email should be
53         all that is output.
55 --smtp-server::
56         If set, specifies the outgoing SMTP server to use.  Defaults to
57         localhost.
59 --subject::
60         Specify the initial subject of the email thread.
61         Only necessary if --compose is also set.  If --compose
62         is not set, this will be prompted for.
64 --to::
65         Specify the primary recipient of the emails generated.
66         Generally, this will be the upstream maintainer of the
67         project involved.
70 Author
71 ------
72 Written by Ryan Anderson <ryan@michonline.com>
74 git-send-email is originally based upon
75 send_lots_of_email.pl by Greg Kroah-Hartman.
77 Documentation
78 --------------
79 Documentation by Ryan Anderson
81 GIT
82 ---
83 Part of the gitlink:git[7] suite