Docs: send-email: Man page option ordering
Now the man page lists the options in alphabetical order (in terms of the 'main' part of an option's name). 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
73811e662849c17cf9e53e63a35b676d624e032c
1 file changed
+66
-72
Documentation/git-send-email.txt
+66
-72
@@ -11,7 +11,6 @@ SYNOPSIS
11
'git send-email' [options] <file|directory> [... file|directory]
12
13
14
-
14
DESCRIPTION
15
-----------
16
Takes the patches given on the command line and emails them out.
@@ -45,19 +44,35 @@ The --cc option must be repeated for each user you want on the cc list.
44
email sent. If disabled with "--no-chain-reply-to", all emails after
45
the first will be sent as replies to the first email sent. When using
46
this, it is recommended that the first file given be an overview of the
48
- entire patch series.
49
- Default is the value of the 'sendemail.chainreplyto' configuration
50
- value; if that is unspecified, default to --chain-reply-to.
47
+ entire patch series. Default is the value of the 'sendemail.chainreplyto'
48
+ configuration value; if that is unspecified, default to --chain-reply-to.
49
50
--compose::
51
Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
52
introductory message for the patch series.
53
54
+--dry-run::
55
+ Do everything except actually send the emails.
56
+
57
+--envelope-sender::
58
+ Specify the envelope sender used to send the emails.
59
+ This is useful if your default address is not the address that is
60
+ subscribed to a list. If you use the sendmail binary, you must have
61
+ suitable privileges for the -f parameter. Default is the value of
62
+ the 'sendemail.envelopesender' configuration variable; if that is
63
+ unspecified, choosing the envelope sender is left to your MTA.
64
+
65
--from::
66
Specify the sender of the emails. This will default to
67
the value GIT_COMMITTER_IDENT, as returned by "git var -l".
68
The user will still be prompted to confirm this entry.
69
70
+--identity::
71
+ A configuration identity. When given, causes values in the
72
+ 'sendemail.<identity>' subsection to take precedence over
73
+ values in the 'sendemail' section. The default identity is
74
+ the value of 'sendemail.identity'.
75
+
76
--in-reply-to::
77
Specify the contents of the first In-Reply-To header.
78
Subsequent emails will refer to the previous email
@@ -65,21 +80,40 @@ The --cc option must be repeated for each user you want on the cc list.
80
Only necessary if --compose is also set. If --compose
81
is not set, this will be prompted for.
82
68
---[no-]signed-off-by-cc::
69
- If this is set, add emails found in Signed-off-by: or Cc: lines to the
70
- cc list.
71
- Default is the value of 'sendemail.signedoffcc' configuration value;
72
- if that is unspecified, default to --signed-off-by-cc.
73
-
83
--quiet::
84
Make git-send-email less verbose. One line per email should be
85
all that is output.
86
78
---identity::
79
- A configuration identity. When given, causes values in the
80
- 'sendemail.<identity>' subsection to take precedence over
81
- values in the 'sendemail' section. The default identity is
82
- the value of 'sendemail.identity'.
87
+--[no-]signed-off-by-cc::
88
+ If this is set, add emails found in Signed-off-by: or Cc: lines to the
89
+ cc list. Default is the value of 'sendemail.signedoffcc' configuration
90
+ value; if that is unspecified, default to --signed-off-by-cc.
91
+
92
+--smtp-encryption::
93
+ Specify the encryption to use, either 'ssl' or 'tls'. Any other
94
+ value reverts to plain SMTP. Default is the value of
95
+ 'sendemail.smtpencryption'.
96
+
97
+--smtp-pass::
98
+ Password for SMTP-AUTH. The argument is optional: If no
99
+ argument is specified, then the empty string is used as
100
+ the password.
101
++
102
+In place of this option, the following configuration variables
103
+can be specified:
104
++
105
+--
106
+ * sendemail.smtppass
107
+ * sendemail.<identity>.smtppass (see sendemail.identity).
108
+--
109
++
110
+However, --smtp-pass always overrides these variables.
111
++
112
+Furthermore, passwords need not be specified in configuration files
113
+or on the command line. If a username has been specified (with
114
+--smtp-user or a configuration variable), but no password has been
115
+specified (with --smtp-pass or a configuration variable), then the
116
+user is prompted for a password while the input is masked for privacy.
117
118
--smtp-server::
119
If set, specifies the outgoing SMTP server to use (e.g.
@@ -96,6 +130,9 @@ The --cc option must be repeated for each user you want on the cc list.
130
servers typically listen to smtp port 25 and ssmtp port
131
465).
132
133
+--smtp-ssl::
134
+ Legacy alias for '--smtp-encryption=ssl'.
135
+
136
--smtp-user::
137
Username for SMTP-AUTH. In place of this option, the following
138
configuration variables can be specified:
@@ -110,45 +147,11 @@ However, --smtp-user always overrides these variables.
147
If a username is not specified (with --smtp-user or a
148
configuration variable), then authentication is not attempted.
149
113
---smtp-pass::
114
- Password for SMTP-AUTH. The argument is optional: If no
115
- argument is specified, then the empty string is used as
116
- the password.
117
-+
118
-In place of this option, the following configuration variables
119
-can be specified:
120
-+
121
---
122
- * sendemail.smtppass
123
- * sendemail.<identity>.smtppass (see sendemail.identity).
124
---
125
-+
126
-However, --smtp-pass always overrides these variables.
127
-+
128
-Furthermore, passwords need not be specified in configuration files
129
-or on the command line. If a username has been specified (with
130
---smtp-user or a configuration variable), but no password has been
131
-specified (with --smtp-pass or a configuration variable), then the
132
-user is prompted for a password while the input is masked for privacy.
133
-
134
---smtp-encryption::
135
- Specify the encryption to use, either 'ssl' or 'tls'. Any other
136
- value reverts to plain SMTP. Default is the value of
137
- 'sendemail.smtpencryption'.
138
-
139
---smtp-ssl::
140
- Legacy alias for '--smtp-encryption=ssl'.
141
-
150
--subject::
151
Specify the initial subject of the email thread.
152
Only necessary if --compose is also set. If --compose
153
is not set, this will be prompted for.
154
147
---[no-]suppress-from::
148
- If this is set, do not add the From: address to the cc: list.
149
- Default is the value of 'sendemail.suppressfrom' configuration value;
150
- if that is unspecified, default to --no-suppress-from.
151
-
155
--suppress-cc::
156
Specify an additional category of recipients to suppress the
157
auto-cc of. 'self' will avoid including the sender, 'author' will
@@ -160,24 +163,24 @@ user is prompted for a password while the input is masked for privacy.
163
if that is unspecified, default to 'self' if --suppress-from is
164
specified, as well as 'sob' if --no-signed-off-cc is specified.
165
166
+--[no-]suppress-from::
167
+ If this is set, do not add the From: address to the cc: list.
168
+ Default is the value of 'sendemail.suppressfrom' configuration
169
+ value; if that is unspecified, default to --no-suppress-from.
170
+
171
--[no-]thread::
172
If this is set, the In-Reply-To header will be set on each email sent.
173
If disabled with "--no-thread", no emails will have the In-Reply-To
166
- header set.
167
- Default is the value of the 'sendemail.thread' configuration value;
168
- if that is unspecified, default to --thread.
174
+ header set. Default is the value of the 'sendemail.thread' configuration
175
+ value; if that is unspecified, default to --thread.
176
170
---dry-run::
171
- Do everything except actually send the emails.
172
-
173
---envelope-sender::
174
- Specify the envelope sender used to send the emails.
175
- This is useful if your default address is not the address that is
176
- subscribed to a list. If you use the sendmail binary, you must have
177
- suitable privileges for the -f parameter.
178
- Default is the value of the 'sendemail.envelopesender' configuration
179
- variable; if that is unspecified, choosing the envelope sender is left
180
- to your MTA.
177
+--to::
178
+ Specify the primary recipient of the emails generated. Generally, this
179
+ will be the upstream maintainer of the project involved. Default is the
180
+ value of the 'sendemail.to' configuration value; if that is unspecified,
181
+ this will be prompted for.
182
++
183
+The --to option must be repeated for each user you want on the to list.
184
185
--no-validate::
186
Don't perform any sanity checks on patches.
@@ -188,15 +191,6 @@ user is prompted for a password while the input is masked for privacy.
191
is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
192
--
193
191
---to::
192
- Specify the primary recipient of the emails generated.
193
- Generally, this will be the upstream maintainer of the
194
- project involved.
195
- Default is the value of the 'sendemail.to' configuration value;
196
- if that is unspecified, this will be prompted for.
197
-+
198
-The --to option must be repeated for each user you want on the to list.
199
-
194
195
CONFIGURATION
196
-------------