Docs: send-email usage text much sexier
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>
Michael Witten committed
Sep 30, 2008 at 07:58 UTC
180c9f5c299b6ec9fcd77e3346fbdd6874e028a4
1 file changed
+26
-68
git-send-email.perl
+26
-68
@@ -40,74 +40,32 @@ sub usage {
40
print <<EOT;
41
git send-email [options] <file | directory>...
42
Options:
43
- --from Specify the "From:" line of the email to be sent.
44
-
45
- --to Specify the primary "To:" line of the email.
46
-
47
- --cc Specify an initial "Cc:" list for the entire series
48
- of emails.
49
-
50
- --cc-cmd Specify a command to execute per file which adds
51
- per file specific cc address entries
52
-
53
- --bcc Specify a list of email addresses that should be Bcc:
54
- on all the emails.
55
-
56
- --compose Use \$GIT_EDITOR, core.editor, \$EDITOR, or \$VISUAL to edit
57
- an introductory message for the patch series.
58
-
59
- --subject Specify the initial "Subject:" line.
60
- Only necessary if --compose is also set. If --compose
61
- is not set, this will be prompted for.
62
-
63
- --in-reply-to Specify the first "In-Reply-To:" header line.
64
- Only used if --compose is also set. If --compose is not
65
- set, this will be prompted for.
66
-
67
- --[no-]chain-reply-to If set, the replies will all be to the previous
68
- email sent, rather than to the first email sent.
69
- Defaults to on.
70
-
71
- --[no-]signed-off-by-cc Automatically add email addresses that appear in
72
- Signed-off-by: or Cc: lines to the cc: list. Defaults to on.
73
-
74
- --identity The configuration identity, a subsection to prioritise over
75
- the default section.
76
-
77
- --smtp-server If set, specifies the outgoing SMTP server to use.
78
- Defaults to localhost. Port number can be specified here with
79
- hostname:port format or by using --smtp-server-port option.
80
-
81
- --smtp-server-port Specify a port on the outgoing SMTP server to connect to.
82
-
83
- --smtp-user The username for SMTP-AUTH.
84
-
85
- --smtp-pass The password for SMTP-AUTH.
86
-
87
- --smtp-encryption Specify 'tls' for STARTTLS encryption, or 'ssl' for SSL.
88
- Any other value disables the feature.
89
-
90
- --smtp-ssl Synonym for '--smtp-encryption=ssl'. Deprecated.
91
-
92
- --suppress-cc Suppress the specified category of auto-CC. The category
93
- can be one of 'author' for the patch author, 'self' to
94
- avoid copying yourself, 'sob' for Signed-off-by lines,
95
- 'cccmd' for the output of the cccmd, or 'all' to suppress
96
- all of these.
97
-
98
- --[no-]suppress-from Suppress sending emails to yourself. Defaults to off.
99
-
100
- --[no-]thread Specify that the "In-Reply-To:" header should be set on all
101
- emails. Defaults to on.
102
-
103
- --quiet Make git-send-email less verbose. One line per email
104
- should be all that is output.
105
-
106
- --dry-run Do everything except actually send the emails.
107
-
108
- --envelope-sender Specify the envelope sender used to send the emails.
109
-
110
- --no-validate Don't perform any sanity checks on patches.
43
+ --identity <str> * Use the sendemail.<id> options.
44
+ --from <str> * Email From:
45
+ --envelope-sender <str> * Email envelope sender.
46
+ --to <str> * Email To:
47
+ --cc <str> * Email Cc:
48
+ --cc-cmd <str> * Email Cc: via `<str> \$patch_path`
49
+ --bcc <str> * Email Bcc:
50
+ --subject <str> * Email "Subject:" (only if --compose).
51
+ --compose * Open an editor for introduction.
52
+ --in-reply-to <str> * First "In-Reply-To:" (only if --compose).
53
+ --[no-]chain-reply-to * Chain In-Reply-To: fields. Default on.
54
+ --[no-]thread * Use In-Reply-To: field. Default on.
55
+ --[no-]signed-off-by-cc * Actually send to Cc: and Signed-off-by:
56
+ addresses. Default on.
57
+ --suppress-cc <str> * author, self, sob, cccmd, all.
58
+ --[no-]suppress-from * Don't send email to self. Default off.
59
+ --smtp-server <str:int> * Outgoing SMTP server to use. The port
60
+ is optional. Default 'localhost'.
61
+ --smtp-server-port <int> * Outgoing SMTP server port.
62
+ --smtp-user <str> * The username for SMTP-AUTH.
63
+ --smtp-pass <str> * The password for SMTP-AUTH; not necessary.
64
+ --smtp-encryption <str> * tls or ssl; anything else disables.
65
+ --smtp-ssl * Deprecated. Use '--smtp-encryption ssl'.
66
+ --quiet * Output one line of info per email.
67
+ --dry-run * Don't actually send the emails.
68
+ --no-validate * Don't perform sanity checks on patches.
69
70
EOT
71
exit(1);