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

Docs: send-email: Man page option ordering

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

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

@ -11,7 +11,6 @@ SYNOPSIS
'git send-email' [options] <file|directory> [... file|directory] 'git send-email' [options] <file|directory> [... file|directory]
DESCRIPTION DESCRIPTION
----------- -----------
Takes the patches given on the command line and emails them out. 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.
email sent. If disabled with "--no-chain-reply-to", all emails after email sent. If disabled with "--no-chain-reply-to", all emails after
the first will be sent as replies to the first email sent. When using the first will be sent as replies to the first email sent. When using
this, it is recommended that the first file given be an overview of the this, it is recommended that the first file given be an overview of the
entire patch series. entire patch series. Default is the value of the 'sendemail.chainreplyto'
Default is the value of the 'sendemail.chainreplyto' configuration configuration value; if that is unspecified, default to --chain-reply-to.
value; if that is unspecified, default to --chain-reply-to.
--compose:: --compose::
Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
introductory message for the patch series. introductory message for the patch series.
--dry-run::
Do everything except actually send the emails.
--envelope-sender::
Specify the envelope sender used to send the emails.
This is useful if your default address is not the address that is
subscribed to a list. If you use the sendmail binary, you must have
suitable privileges for the -f parameter. Default is the value of
the 'sendemail.envelopesender' configuration variable; if that is
unspecified, choosing the envelope sender is left to your MTA.
--from:: --from::
Specify the sender of the emails. This will default to Specify the sender of the emails. This will default to
the value GIT_COMMITTER_IDENT, as returned by "git var -l". the value GIT_COMMITTER_IDENT, as returned by "git var -l".
The user will still be prompted to confirm this entry. The user will still be prompted to confirm this entry.
--identity::
A configuration identity. When given, causes values in the
'sendemail.<identity>' subsection to take precedence over
values in the 'sendemail' section. The default identity is
the value of 'sendemail.identity'.
--in-reply-to:: --in-reply-to::
Specify the contents of the first In-Reply-To header. Specify the contents of the first In-Reply-To header.
Subsequent emails will refer to the previous email Subsequent emails will refer to the previous email
@ -65,50 +80,19 @@ The --cc option must be repeated for each user you want on the cc list.
Only necessary if --compose is also set. If --compose Only necessary if --compose is also set. If --compose
is not set, this will be prompted for. is not set, this will be prompted for.
--[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.
--quiet:: --quiet::
Make git-send-email less verbose. One line per email should be Make git-send-email less verbose. One line per email should be
all that is output. all that is output.
--identity:: --[no-]signed-off-by-cc::
A configuration identity. When given, causes values in the If this is set, add emails found in Signed-off-by: or Cc: lines to the
'sendemail.<identity>' subsection to take precedence over cc list. Default is the value of 'sendemail.signedoffcc' configuration
values in the 'sendemail' section. The default identity is value; if that is unspecified, default to --signed-off-by-cc.
the value of 'sendemail.identity'.
--smtp-server:: --smtp-encryption::
If set, specifies the outgoing SMTP server to use (e.g. Specify the encryption to use, either 'ssl' or 'tls'. Any other
`smtp.example.com` or a raw IP address). Alternatively it can value reverts to plain SMTP. Default is the value of
specify a full pathname of a sendmail-like program instead; 'sendemail.smtpencryption'.
the program must support the `-i` option. Default value can
be specified by the 'sendemail.smtpserver' configuration
option; the built-in default is `/usr/sbin/sendmail` or
`/usr/lib/sendmail` if such program is available, or
`localhost` otherwise.
--smtp-server-port::
Specifies a port different from the default port (SMTP
servers typically listen to smtp port 25 and ssmtp port
465).
--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.
--smtp-pass:: --smtp-pass::
Password for SMTP-AUTH. The argument is optional: If no Password for SMTP-AUTH. The argument is optional: If no
@ -131,24 +115,43 @@ or on the command line. If a username has been specified (with
specified (with --smtp-pass or a configuration variable), then the specified (with --smtp-pass or a configuration variable), then the
user is prompted for a password while the input is masked for privacy. user is prompted for a password while the input is masked for privacy.
--smtp-encryption:: --smtp-server::
Specify the encryption to use, either 'ssl' or 'tls'. Any other If set, specifies the outgoing SMTP server to use (e.g.
value reverts to plain SMTP. Default is the value of `smtp.example.com` or a raw IP address). Alternatively it can
'sendemail.smtpencryption'. specify a full pathname of a sendmail-like program instead;
the program must support the `-i` option. Default value can
be specified by the 'sendemail.smtpserver' configuration
option; the built-in default is `/usr/sbin/sendmail` or
`/usr/lib/sendmail` if such program is available, or
`localhost` otherwise.
--smtp-server-port::
Specifies a port different from the default port (SMTP
servers typically listen to smtp port 25 and ssmtp port
465).
--smtp-ssl:: --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.
--subject:: --subject::
Specify the initial subject of the email thread. Specify the initial subject of the email thread.
Only necessary if --compose is also set. If --compose Only necessary if --compose is also set. If --compose
is not set, this will be prompted for. is not set, this will be prompted for.
--[no-]suppress-from::
If this is set, do not add the From: address to the cc: list.
Default is the value of 'sendemail.suppressfrom' configuration value;
if that is unspecified, default to --no-suppress-from.
--suppress-cc:: --suppress-cc::
Specify an additional category of recipients to suppress the Specify an additional category of recipients to suppress the
auto-cc of. 'self' will avoid including the sender, 'author' will 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.
if that is unspecified, default to 'self' if --suppress-from is if that is unspecified, default to 'self' if --suppress-from is
specified, as well as 'sob' if --no-signed-off-cc is specified. specified, as well as 'sob' if --no-signed-off-cc is specified.
--[no-]suppress-from::
If this is set, do not add the From: address to the cc: list.
Default is the value of 'sendemail.suppressfrom' configuration
value; if that is unspecified, default to --no-suppress-from.
--[no-]thread:: --[no-]thread::
If this is set, the In-Reply-To header will be set on each email sent. If this is set, the In-Reply-To header will be set on each email sent.
If disabled with "--no-thread", no emails will have the In-Reply-To If disabled with "--no-thread", no emails will have the In-Reply-To
header set. header set. Default is the value of the 'sendemail.thread' configuration
Default is the value of the 'sendemail.thread' configuration value; value; if that is unspecified, default to --thread.
if that is unspecified, default to --thread.
--dry-run:: --to::
Do everything except actually send the emails. Specify the primary recipient of the emails generated. Generally, this
will be the upstream maintainer of the project involved. Default is the
--envelope-sender:: value of the 'sendemail.to' configuration value; if that is unspecified,
Specify the envelope sender used to send the emails. this will be prompted for.
This is useful if your default address is not the address that is +
subscribed to a list. If you use the sendmail binary, you must have The --to option must be repeated for each user you want on the to list.
suitable privileges for the -f parameter.
Default is the value of the 'sendemail.envelopesender' configuration
variable; if that is unspecified, choosing the envelope sender is left
to your MTA.
--no-validate:: --no-validate::
Don't perform any sanity checks on patches. 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.
is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt. is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
-- --
--to::
Specify the primary recipient of the emails generated.
Generally, this will be the upstream maintainer of the
project involved.
Default is the value of the 'sendemail.to' configuration value;
if that is unspecified, this will be prompted for.
+
The --to option must be repeated for each user you want on the to list.
CONFIGURATION CONFIGURATION
------------- -------------