[PATCH] Add documentation for git-send-email-script
[git.git] / Documentation / git-send-email-script.txt
1 git-send-email-script(1)
2 =======================
3 v0.1, July 2005
4
5 NAME
6 ----
7 git-send-email-script - Send a collection of patches as emails
8
9
10 SYNOPSIS
11 --------
12 'git-send-email-script' [options] <file|directory> [... file|directory]
13
14
15
16 DESCRIPTION
17 -----------
18 Takes the patches given on the command line and emails them out.
19
20 The header of the email is configurable by command line options.  If not
21 specified on the command line, the user will be prompted with a ReadLine
22 enabled interface to provide the necessary information.
23
24 The options available are:
25
26   --to
27         Specify the primary recipient of the emails generated.
28         Generally, this will be the upstream maintainer of the
29         project involved.
30
31    --from
32         Specify the sender of the emails.  This will default to
33         the value GIT_COMMITTER_IDENT, as returned by "git-var -l".
34         The user will still be prompted to confirm this entry.
35
36    --subject
37         Specify the initial subject of the email thread.
38
39    --in-reply-to
40         Specify the contents of the first In-Reply-To header.
41         Subsequent emails will refer to the previous email 
42         instead of this.
43         When overriding on the command line, it may be necessary
44         to set this to a space.  For example
45                 --in-reply-to=" "
46
47 Author
48 ------
49 Written by Ryan Anderson <ryan@michonline.com>
50
51 git-send-email-script is originally based upon
52 send_lots_of_email.pl by Greg Kroah-Hartman.
53
54 Documentation
55 --------------
56 Documentation by Ryan Anderson
57
58 GIT
59 ---
60 Part of the link:git.html[git] suite
61