undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: send-email: Remove unnecessary config variable description

Browse Source 
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>
This commit is contained in:
Michael Witten 2008-09-30 07:58:29 -05:00 committed by Shawn O. Pearce
parent c306e071b3
commit 3971a9733e
1 changed files with 16 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
Documentation/git-send-email.txt
View File

@ -24,7 +24,8 @@ OPTIONS
The options available are:
--bcc::
Specify a "Bcc:" value for each email.
Specify a "Bcc:" value for each email. Default is the value of
'sendemail.bcc'.
+
The --bcc option must be repeated for each user you want on the bcc list.
@ -85,9 +86,9 @@ The --cc option must be repeated for each user you want on the cc list.
all that is output.
--[no-]signed-off-by-cc::
If this is set, add emails found in Signed-off-by: or Cc: lines to the
cc list. Default is the value of 'sendemail.signedoffcc' configuration
value; if that is unspecified, default to --signed-off-by-cc.
If this is set, add emails found in Signed-off-by: or Cc: lines to the
cc list. Default is the value of 'sendemail.signedoffcc' configuration
value; if that is unspecified, default to --signed-off-by-cc.
--smtp-encryption::
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.
--smtp-pass::
Password for SMTP-AUTH. The argument is optional: If no
argument is specified, then the empty string is used as
the password.
+
In place of this option, the following configuration variables
can be specified:
+
--
* sendemail.smtppass
* sendemail.<identity>.smtppass (see sendemail.identity).
--
+
However, --smtp-pass always overrides these variables.
the password. Default is the value of 'sendemail.smtppass',
however '--smtp-pass' always overrides this value.
+
Furthermore, passwords need not be specified in configuration files
or on the command line. If a username has been specified (with
--smtp-user or a configuration variable), but no password has been
specified (with --smtp-pass or a configuration variable), then the
'--smtp-user' or a 'sendemail.smtpuser'), but no password has been
specified (with '--smtp-pass' or 'sendemail.smtppass'), then the
user is prompted for a password while the input is masked for privacy.
--smtp-server::
@ -128,24 +120,15 @@ user is prompted for a password while the input is masked for privacy.
--smtp-server-port::
Specifies a port different from the default port (SMTP
servers typically listen to smtp port 25 and ssmtp port
465).
465). This can be set with 'sendemail.smtpserverport'.
--smtp-ssl::
Legacy alias for '--smtp-encryption=ssl'.
Legacy alias for '--smtp-encryption ssl'.
--smtp-user::
Username for SMTP-AUTH. In place of this option, the following
configuration variables can be specified:
+
--
* sendemail.smtpuser
* sendemail.<identity>.smtpuser (see sendemail.identity).
--
+
However, --smtp-user always overrides these variables.
+
If a username is not specified (with --smtp-user or a
configuration variable), then authentication is not attempted.
Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser';
if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),
then authentication is not attempted.
--subject::
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.
is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
--
+
This option can be set with sendemail[.<identity>].validate; default to --validate
Default is the value of 'sendemail.validate'; if this is not set,
default to '--validate'.
CONFIGURATION
-------------
sendemail.identity::
The default configuration identity. When specified,
'sendemail.<identity>.<item>' will have higher precedence than
'sendemail.<item>'. This is useful to declare multiple SMTP
identities and to hoist sensitive authentication information
out of the repository and into the global configuration file.
sendemail.aliasesfile::
To avoid typing long email addresses, point this to one or more
email aliases files. You must also supply 'sendemail.aliasfiletype'.
@ -211,42 +188,6 @@ sendemail.aliasfiletype::
Format of the file(s) specified in sendemail.aliasesfile. Must be
one of 'mutt', 'mailrc', 'pine', or 'gnus'.
sendemail.to::
Email address (or alias) to always send to.
sendemail.cccmd::
Command to execute to generate per patch file specific "Cc:"s.
sendemail.bcc::
Email address (or alias) to always bcc.
sendemail.chainreplyto::
Boolean value specifying the default to the '--[no-]chain-reply-to'
parameter.
sendemail.smtpserver::
Default SMTP server to use.
sendemail.smtpserverport::
Default SMTP server port to use.
sendemail.smtpuser::
Default SMTP-AUTH username.
sendemail.smtppass::
Default SMTP-AUTH password.
sendemail.smtpencryption::
Default encryption method. Use 'ssl' for SSL (and specify an
appropriate port), or 'tls' for TLS. Takes precedence over
'smtpssl' if both are specified.
sendemail.smtpssl::
Legacy boolean that sets 'smtpencryption=ssl' if enabled.
sendemail.validate::
Boolean override for --[no-]validate.
Author
------
Written by Ryan Anderson <ryan@michonline.com>