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

Docs: send-email usage text much sexier

Browse Source 
All of the descriptions are aligned, shorter,
better arranged, and no line is greater than
78 columns.

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:25 -05:00 committed by Shawn O. Pearce
parent 7ecbad91e9
commit 180c9f5c29
1 changed files with 26 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
git-send-email.perl
View File

@ -40,74 +40,32 @@ sub usage {
print <<EOT; print <<EOT;
git send-email [options] <file | directory>... git send-email [options] <file | directory>...
Options: Options:
--from Specify the "From:" line of the email to be sent. --identity <str> * Use the sendemail.<id> options.
--from <str> * Email From:
--to Specify the primary "To:" line of the email. --envelope-sender <str> * Email envelope sender.
--to <str> * Email To:
--cc Specify an initial "Cc:" list for the entire series --cc <str> * Email Cc:
of emails. --cc-cmd <str> * Email Cc: via `<str> \$patch_path`
--bcc <str> * Email Bcc:
--cc-cmd Specify a command to execute per file which adds --subject <str> * Email "Subject:" (only if --compose).
per file specific cc address entries --compose * Open an editor for introduction.
--in-reply-to <str> * First "In-Reply-To:" (only if --compose).
--bcc Specify a list of email addresses that should be Bcc: --[no-]chain-reply-to * Chain In-Reply-To: fields. Default on.
on all the emails. --[no-]thread * Use In-Reply-To: field. Default on.
--[no-]signed-off-by-cc * Actually send to Cc: and Signed-off-by:
--compose Use \$GIT_EDITOR, core.editor, \$EDITOR, or \$VISUAL to edit addresses. Default on.
an introductory message for the patch series. --suppress-cc <str> * author, self, sob, cccmd, all.
--[no-]suppress-from * Don't send email to self. Default off.
--subject Specify the initial "Subject:" line. --smtp-server <str:int> * Outgoing SMTP server to use. The port
Only necessary if --compose is also set. If --compose is optional. Default 'localhost'.
is not set, this will be prompted for. --smtp-server-port <int> * Outgoing SMTP server port.
--smtp-user <str> * The username for SMTP-AUTH.
--in-reply-to Specify the first "In-Reply-To:" header line. --smtp-pass <str> * The password for SMTP-AUTH; not necessary.
Only used if --compose is also set. If --compose is not --smtp-encryption <str> * tls or ssl; anything else disables.
set, this will be prompted for. --smtp-ssl * Deprecated. Use '--smtp-encryption ssl'.
--quiet * Output one line of info per email.
--[no-]chain-reply-to If set, the replies will all be to the previous --dry-run * Don't actually send the emails.
email sent, rather than to the first email sent. --no-validate * Don't perform sanity checks on patches.
Defaults to on.
--[no-]signed-off-by-cc Automatically add email addresses that appear in
Signed-off-by: or Cc: lines to the cc: list. Defaults to on.
--identity The configuration identity, a subsection to prioritise over
the default section.
--smtp-server If set, specifies the outgoing SMTP server to use.
Defaults to localhost. Port number can be specified here with
hostname:port format or by using --smtp-server-port option.
--smtp-server-port Specify a port on the outgoing SMTP server to connect to.
--smtp-user The username for SMTP-AUTH.
--smtp-pass The password for SMTP-AUTH.
--smtp-encryption Specify 'tls' for STARTTLS encryption, or 'ssl' for SSL.
Any other value disables the feature.
--smtp-ssl Synonym for '--smtp-encryption=ssl'. Deprecated.
--suppress-cc Suppress the specified category of auto-CC. The category
can be one of 'author' for the patch author, 'self' to
avoid copying yourself, 'sob' for Signed-off-by lines,
'cccmd' for the output of the cccmd, or 'all' to suppress
all of these.
--[no-]suppress-from Suppress sending emails to yourself. Defaults to off.
--[no-]thread Specify that the "In-Reply-To:" header should be set on all
emails. Defaults to on.
--quiet Make git-send-email less verbose. One line per email
should be all that is output.
--dry-run Do everything except actually send the emails.
--envelope-sender Specify the envelope sender used to send the emails.
--no-validate Don't perform any sanity checks on patches.
EOT EOT
exit(1); exit(1);