Docs: send-email: Create logical groupings for --help text
The options are partitioned into more digestible groups. 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
4ed62b0316619b70e9dc9868e93c33815ff678d5
1 file changed
+34
-27
git-send-email.perl
+34
-27
@@ -39,33 +39,40 @@ package main;
39
sub usage {
40
print <<EOT;
41
git send-email [options] <file | directory>...
42
-Options:
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 * Perform patch sanity checks. Default on.
42
+
43
+ Composing:
44
+ --from <str> * Email From:
45
+ --to <str> * Email To:
46
+ --cc <str> * Email Cc:
47
+ --bcc <str> * Email Bcc:
48
+ --subject <str> * Email "Subject:"
49
+ --in-reply-to <str> * Email "In-Reply-To:"
50
+ --compose * Open an editor for introduction.
51
+
52
+ Sending:
53
+ --envelope-sender <str> * Email envelope sender.
54
+ --smtp-server <str:int> * Outgoing SMTP server to use. The port
55
+ is optional. Default 'localhost'.
56
+ --smtp-server-port <int> * Outgoing SMTP server port.
57
+ --smtp-user <str> * Username for SMTP-AUTH.
58
+ --smtp-pass <str> * Password for SMTP-AUTH; not necessary.
59
+ --smtp-encryption <str> * tls or ssl; anything else disables.
60
+ --smtp-ssl * Deprecated. Use '--smtp-encryption ssl'.
61
+
62
+ Automating:
63
+ --identity <str> * Use the sendemail.<id> options.
64
+ --cc-cmd <str> * Email Cc: via `<str> \$patch_path`
65
+ --suppress-cc <str> * author, self, sob, cccmd, all.
66
+ --[no-]signed-off-by-cc * Send to Cc: and Signed-off-by:
67
+ addresses. Default on.
68
+ --[no-]suppress-from * Send to self. Default off.
69
+ --[no-]chain-reply-to * Chain In-Reply-To: fields. Default on.
70
+ --[no-]thread * Use In-Reply-To: field. Default on.
71
+
72
+ Administering:
73
+ --quiet * Output one line of info per email.
74
+ --dry-run * Don't actually send the emails.
75
+ --[no-]validate * Perform patch sanity checks. Default on.
76
77
EOT
78
exit(1);