Docs: send-email: Create logical groupings for man text
The options are partitioned into more digestible groups. Within these groups, the options are sorted alphabetically. Signed-off-by: Michael Witten <mfwitten@mit.edu> Acked-by: Jeff King <peff@peff.net> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
Michael Witten committed
Sep 30, 2008 at 07:58 UTC
917f3e73ec60820608d32016293aa496bdcbdf0e
1 file changed
+69
-50
Documentation/git-send-email.txt
+69
-50
@@ -19,9 +19,12 @@ The header of the email is configurable by command line options. If not
19
specified on the command line, the user will be prompted with a ReadLine
20
enabled interface to provide the necessary information.
21
22
+
23
OPTIONS
24
-------
24
-The options available are:
25
+
26
+Composing
27
+~~~~~~~~~
28
29
--bcc::
30
Specify a "Bcc:" value for each email. Default is the value of
@@ -34,46 +37,15 @@ The --bcc option must be repeated for each user you want on the bcc list.
37
+
38
The --cc option must be repeated for each user you want on the cc list.
39
37
---cc-cmd::
38
- Specify a command to execute once per patch file which
39
- should generate patch file specific "Cc:" entries.
40
- Output of this command must be single email address per line.
41
- Default is the value of 'sendemail.cccmd' configuration value.
42
-
43
---[no-]chain-reply-to::
44
- If this is set, each email will be sent as a reply to the previous
45
- email sent. If disabled with "--no-chain-reply-to", all emails after
46
- the first will be sent as replies to the first email sent. When using
47
- this, it is recommended that the first file given be an overview of the
48
- entire patch series. Default is the value of the 'sendemail.chainreplyto'
49
- configuration value; if that is unspecified, default to --chain-reply-to.
50
-
40
--compose::
41
Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
42
introductory message for the patch series.
43
55
---dry-run::
56
- Do everything except actually send the emails.
57
-
58
---envelope-sender::
59
- Specify the envelope sender used to send the emails.
60
- This is useful if your default address is not the address that is
61
- subscribed to a list. If you use the sendmail binary, you must have
62
- suitable privileges for the -f parameter. Default is the value of
63
- the 'sendemail.envelopesender' configuration variable; if that is
64
- unspecified, choosing the envelope sender is left to your MTA.
65
-
44
--from::
45
Specify the sender of the emails. This will default to
46
the value GIT_COMMITTER_IDENT, as returned by "git var -l".
47
The user will still be prompted to confirm this entry.
48
71
---identity::
72
- A configuration identity. When given, causes values in the
73
- 'sendemail.<identity>' subsection to take precedence over
74
- values in the 'sendemail' section. The default identity is
75
- the value of 'sendemail.identity'.
76
-
49
--in-reply-to::
50
Specify the contents of the first In-Reply-To header.
51
Subsequent emails will refer to the previous email
@@ -81,14 +53,30 @@ The --cc option must be repeated for each user you want on the cc list.
53
Only necessary if --compose is also set. If --compose
54
is not set, this will be prompted for.
55
84
---quiet::
85
- Make git-send-email less verbose. One line per email should be
86
- all that is output.
56
+--subject::
57
+ Specify the initial subject of the email thread.
58
+ Only necessary if --compose is also set. If --compose
59
+ is not set, this will be prompted for.
60
88
---[no-]signed-off-by-cc::
89
- If this is set, add emails found in Signed-off-by: or Cc: lines to the
90
- cc list. Default is the value of 'sendemail.signedoffcc' configuration
91
- value; if that is unspecified, default to --signed-off-by-cc.
61
+--to::
62
+ Specify the primary recipient of the emails generated. Generally, this
63
+ will be the upstream maintainer of the project involved. Default is the
64
+ value of the 'sendemail.to' configuration value; if that is unspecified,
65
+ this will be prompted for.
66
++
67
+The --to option must be repeated for each user you want on the to list.
68
+
69
+
70
+Sending
71
+~~~~~~~
72
+
73
+--envelope-sender::
74
+ Specify the envelope sender used to send the emails.
75
+ This is useful if your default address is not the address that is
76
+ subscribed to a list. If you use the sendmail binary, you must have
77
+ suitable privileges for the -f parameter. Default is the value of
78
+ the 'sendemail.envelopesender' configuration variable; if that is
79
+ unspecified, choosing the envelope sender is left to your MTA.
80
81
--smtp-encryption::
82
Specify the encryption to use, either 'ssl' or 'tls'. Any other
@@ -130,10 +118,34 @@ user is prompted for a password while the input is masked for privacy.
118
if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),
119
then authentication is not attempted.
120
133
---subject::
134
- Specify the initial subject of the email thread.
135
- Only necessary if --compose is also set. If --compose
136
- is not set, this will be prompted for.
121
+
122
+Automating
123
+~~~~~~~~~~
124
+
125
+--cc-cmd::
126
+ Specify a command to execute once per patch file which
127
+ should generate patch file specific "Cc:" entries.
128
+ Output of this command must be single email address per line.
129
+ Default is the value of 'sendemail.cccmd' configuration value.
130
+
131
+--[no-]chain-reply-to::
132
+ If this is set, each email will be sent as a reply to the previous
133
+ email sent. If disabled with "--no-chain-reply-to", all emails after
134
+ the first will be sent as replies to the first email sent. When using
135
+ this, it is recommended that the first file given be an overview of the
136
+ entire patch series. Default is the value of the 'sendemail.chainreplyto'
137
+ configuration value; if that is unspecified, default to --chain-reply-to.
138
+
139
+--identity::
140
+ A configuration identity. When given, causes values in the
141
+ 'sendemail.<identity>' subsection to take precedence over
142
+ values in the 'sendemail' section. The default identity is
143
+ the value of 'sendemail.identity'.
144
+
145
+--[no-]signed-off-by-cc::
146
+ If this is set, add emails found in Signed-off-by: or Cc: lines to the
147
+ cc list. Default is the value of 'sendemail.signedoffcc' configuration
148
+ value; if that is unspecified, default to --signed-off-by-cc.
149
150
--suppress-cc::
151
Specify an additional category of recipients to suppress the
@@ -157,13 +169,16 @@ user is prompted for a password while the input is masked for privacy.
169
header set. Default is the value of the 'sendemail.thread' configuration
170
value; if that is unspecified, default to --thread.
171
160
---to::
161
- Specify the primary recipient of the emails generated. Generally, this
162
- will be the upstream maintainer of the project involved. Default is the
163
- value of the 'sendemail.to' configuration value; if that is unspecified,
164
- this will be prompted for.
165
-+
166
-The --to option must be repeated for each user you want on the to list.
172
+
173
+Administering
174
+~~~~~~~~~~~~~
175
+
176
+--dry-run::
177
+ Do everything except actually send the emails.
178
+
179
+--quiet::
180
+ Make git-send-email less verbose. One line per email should be
181
+ all that is output.
182
183
--[no-]validate::
184
Perform sanity checks on patches.
@@ -180,6 +195,7 @@ default to '--validate'.
195
196
CONFIGURATION
197
-------------
198
+
199
sendemail.aliasesfile::
200
To avoid typing long email addresses, point this to one or more
201
email aliases files. You must also supply 'sendemail.aliasfiletype'.
@@ -188,6 +204,7 @@ sendemail.aliasfiletype::
204
Format of the file(s) specified in sendemail.aliasesfile. Must be
205
one of 'mutt', 'mailrc', 'pine', or 'gnus'.
206
207
+
208
Author
209
------
210
Written by Ryan Anderson <ryan@michonline.com>
@@ -195,10 +212,12 @@ Written by Ryan Anderson <ryan@michonline.com>
212
git-send-email is originally based upon
213
send_lots_of_email.pl by Greg Kroah-Hartman.
214
215
+
216
Documentation
217
--------------
218
Documentation by Ryan Anderson
219
220
+
221
GIT
222
---
223
Part of the linkgit:git[1] suite