Docs: send-email: Remove unnecessary config variable description
The config variables are mentioned within the descriptions of the command line options with which they are associated. 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
3971a9733e3b17f46ab31c5fa28100533f398a3a
1 file changed
+16
-75
Documentation/git-send-email.txt
+16
-75
@@ -24,7 +24,8 @@ OPTIONS
24
The options available are:
25
26
--bcc::
27
- Specify a "Bcc:" value for each email.
27
+ Specify a "Bcc:" value for each email. Default is the value of
28
+ 'sendemail.bcc'.
29
+
30
The --bcc option must be repeated for each user you want on the bcc list.
31
@@ -85,9 +86,9 @@ The --cc option must be repeated for each user you want on the cc list.
86
all that is output.
87
88
--[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.
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.
92
93
--smtp-encryption::
94
Specify the encryption to use, either 'ssl' or 'tls'. Any other
@@ -97,22 +98,13 @@ The --cc option must be repeated for each user you want on the cc list.
98
--smtp-pass::
99
Password for SMTP-AUTH. The argument is optional: If no
100
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.
101
+ the password. Default is the value of 'sendemail.smtppass',
102
+ however '--smtp-pass' always overrides this value.
103
+
104
Furthermore, passwords need not be specified in configuration files
105
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
106
+'--smtp-user' or a 'sendemail.smtpuser'), but no password has been
107
+specified (with '--smtp-pass' or 'sendemail.smtppass'), then the
108
user is prompted for a password while the input is masked for privacy.
109
110
--smtp-server::
@@ -128,24 +120,15 @@ user is prompted for a password while the input is masked for privacy.
120
--smtp-server-port::
121
Specifies a port different from the default port (SMTP
122
servers typically listen to smtp port 25 and ssmtp port
131
- 465).
123
+ 465). This can be set with 'sendemail.smtpserverport'.
124
125
--smtp-ssl::
134
- Legacy alias for '--smtp-encryption=ssl'.
126
+ Legacy alias for '--smtp-encryption ssl'.
127
128
--smtp-user::
137
- Username for SMTP-AUTH. In place of this option, the following
138
- configuration variables can be specified:
139
-+
140
---
141
- * sendemail.smtpuser
142
- * sendemail.<identity>.smtpuser (see sendemail.identity).
143
---
144
-+
145
-However, --smtp-user always overrides these variables.
146
-+
147
-If a username is not specified (with --smtp-user or a
148
-configuration variable), then authentication is not attempted.
129
+ Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser';
130
+ if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),
131
+ then authentication is not attempted.
132
133
--subject::
134
Specify the initial subject of the email thread.
@@ -191,18 +174,12 @@ The --to option must be repeated for each user you want on the to list.
174
is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
175
--
176
+
194
-This option can be set with sendemail[.<identity>].validate; default to --validate
177
+Default is the value of 'sendemail.validate'; if this is not set,
178
+default to '--validate'.
179
180
181
CONFIGURATION
182
-------------
199
-sendemail.identity::
200
- The default configuration identity. When specified,
201
- 'sendemail.<identity>.<item>' will have higher precedence than
202
- 'sendemail.<item>'. This is useful to declare multiple SMTP
203
- identities and to hoist sensitive authentication information
204
- out of the repository and into the global configuration file.
205
-
183
sendemail.aliasesfile::
184
To avoid typing long email addresses, point this to one or more
185
email aliases files. You must also supply 'sendemail.aliasfiletype'.
@@ -211,42 +188,6 @@ sendemail.aliasfiletype::
188
Format of the file(s) specified in sendemail.aliasesfile. Must be
189
one of 'mutt', 'mailrc', 'pine', or 'gnus'.
190
214
-sendemail.to::
215
- Email address (or alias) to always send to.
216
-
217
-sendemail.cccmd::
218
- Command to execute to generate per patch file specific "Cc:"s.
219
-
220
-sendemail.bcc::
221
- Email address (or alias) to always bcc.
222
-
223
-sendemail.chainreplyto::
224
- Boolean value specifying the default to the '--[no-]chain-reply-to'
225
- parameter.
226
-
227
-sendemail.smtpserver::
228
- Default SMTP server to use.
229
-
230
-sendemail.smtpserverport::
231
- Default SMTP server port to use.
232
-
233
-sendemail.smtpuser::
234
- Default SMTP-AUTH username.
235
-
236
-sendemail.smtppass::
237
- Default SMTP-AUTH password.
238
-
239
-sendemail.smtpencryption::
240
- Default encryption method. Use 'ssl' for SSL (and specify an
241
- appropriate port), or 'tls' for TLS. Takes precedence over
242
- 'smtpssl' if both are specified.
243
-
244
-sendemail.smtpssl::
245
- Legacy boolean that sets 'smtpencryption=ssl' if enabled.
246
-
247
-sendemail.validate::
248
- Boolean override for --[no-]validate.
249
-
191
Author
192
------
193
Written by Ryan Anderson <ryan@michonline.com>