[PATCH] Update documentation for git-get-tar-commit-id
[git/trast.git] / Documentation / git-send-email-script.txt
blobf79ad19945bd5f1cf81ca28dc785c0b68e20bc9b
1 git-send-email-script(1)
2 ========================
3 v0.1, July 2005
5 NAME
6 ----
7 git-send-email-script - Send a collection of patches as emails
10 SYNOPSIS
11 --------
12 'git-send-email-script' [options] <file|directory> [... file|directory]
16 DESCRIPTION
17 -----------
18 Takes the patches given on the command line and emails them out.
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.
24 The options available are:
26   --to
27         Specify the primary recipient of the emails generated.
28         Generally, this will be the upstream maintainer of the
29         project involved.
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.
36    --compose
37         Use \$EDITOR to edit an introductory message for the
38         patch series.
40    --subject
41         Specify the initial subject of the email thread.
42         Only necessary if --compose is also set.  If --compose
43         is not set, this will be prompted for.
45    --in-reply-to
46         Specify the contents of the first In-Reply-To header.
47         Subsequent emails will refer to the previous email 
48         instead of this if --chain-reply-to is set (the default)
49         Only necessary if --compose is also set.  If --compose
50         is not set, this will be prompted for.
52    --chain-reply-to, --no-chain-reply-to
53         If this is set, each email will be sent as a reply to the previous
54         email sent.  If disabled with "--no-chain-reply-to", all emails after
55         the first will be sent as replies to the first email sent.  When using
56         this, it is recommended that the first file given be an overview of the
57         entire patch series.
58         Default is --chain-reply-to
60    --smtp-server
61         If set, specifies the outgoing SMTP server to use.  Defaults to
62         localhost.
65 Author
66 ------
67 Written by Ryan Anderson <ryan@michonline.com>
69 git-send-email-script is originally based upon
70 send_lots_of_email.pl by Greg Kroah-Hartman.
72 Documentation
73 --------------
74 Documentation by Ryan Anderson
76 GIT
77 ---
78 Part of the link:git.html[git] suite