show-branch: optionally use unique prefix as name.
[git/dscho.git] / Documentation / git-send-email.txt
blobb9bec55e53ad191e4cb0b052551aa7e45049013e
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 --to::
28         Specify the primary recipient of the emails generated.
29         Generally, this will be the upstream maintainer of the
30         project involved.
32 --from::
33         Specify the sender of the emails.  This will default to
34         the value GIT_COMMITTER_IDENT, as returned by "git-var -l".
35         The user will still be prompted to confirm this entry.
37 --compose::
38         Use \$EDITOR to edit an introductory message for the
39         patch series.
41 --subject::
42         Specify the initial subject of the email thread.
43         Only necessary if --compose is also set.  If --compose
44         is not set, this will be prompted for.
46 --in-reply-to::
47         Specify the contents of the first In-Reply-To header.
48         Subsequent emails will refer to the previous email 
49         instead of this if --chain-reply-to is set (the default)
50         Only necessary if --compose is also set.  If --compose
51         is not set, this will be prompted for.
53 --chain-reply-to, --no-chain-reply-to::
54         If this is set, each email will be sent as a reply to the previous
55         email sent.  If disabled with "--no-chain-reply-to", all emails after
56         the first will be sent as replies to the first email sent.  When using
57         this, it is recommended that the first file given be an overview of the
58         entire patch series.
59         Default is --chain-reply-to
61 --smtp-server::
62         If set, specifies the outgoing SMTP server to use.  Defaults to
63         localhost.
66 Author
67 ------
68 Written by Ryan Anderson <ryan@michonline.com>
70 git-send-email is originally based upon
71 send_lots_of_email.pl by Greg Kroah-Hartman.
73 Documentation
74 --------------
75 Documentation by Ryan Anderson
77 GIT
78 ---
79 Part of the gitlink:git[7] suite