From 180c9f5c299b6ec9fcd77e3346fbdd6874e028a4 Mon Sep 17 00:00:00 2001 From: Michael Witten Date: Tue, 30 Sep 2008 07:58:25 -0500 Subject: [PATCH] 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 Acked-by: Jeff King Signed-off-by: Shawn O. Pearce --- git-send-email.perl | 94 +++++++++++++-------------------------------- 1 file changed, 26 insertions(+), 68 deletions(-) diff --git a/git-send-email.perl b/git-send-email.perl index 9f56162b1..2c31a257e 100755 --- a/git-send-email.perl +++ b/git-send-email.perl @@ -40,74 +40,32 @@ sub usage { print <... Options: - --from Specify the "From:" line of the email to be sent. - - --to Specify the primary "To:" line of the email. - - --cc Specify an initial "Cc:" list for the entire series - of emails. - - --cc-cmd Specify a command to execute per file which adds - per file specific cc address entries - - --bcc Specify a list of email addresses that should be Bcc: - on all the emails. - - --compose Use \$GIT_EDITOR, core.editor, \$EDITOR, or \$VISUAL to edit - an introductory message for the patch series. - - --subject Specify the initial "Subject:" line. - Only necessary if --compose is also set. If --compose - is not set, this will be prompted for. - - --in-reply-to Specify the first "In-Reply-To:" header line. - Only used if --compose is also set. If --compose is not - set, this will be prompted for. - - --[no-]chain-reply-to If set, the replies will all be to the previous - email sent, rather than to the first email sent. - 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. + --identity * Use the sendemail. options. + --from * Email From: + --envelope-sender * Email envelope sender. + --to * Email To: + --cc * Email Cc: + --cc-cmd * Email Cc: via ` \$patch_path` + --bcc * Email Bcc: + --subject * Email "Subject:" (only if --compose). + --compose * Open an editor for introduction. + --in-reply-to * First "In-Reply-To:" (only if --compose). + --[no-]chain-reply-to * Chain In-Reply-To: fields. Default on. + --[no-]thread * Use In-Reply-To: field. Default on. + --[no-]signed-off-by-cc * Actually send to Cc: and Signed-off-by: + addresses. Default on. + --suppress-cc * author, self, sob, cccmd, all. + --[no-]suppress-from * Don't send email to self. Default off. + --smtp-server * Outgoing SMTP server to use. The port + is optional. Default 'localhost'. + --smtp-server-port * Outgoing SMTP server port. + --smtp-user * The username for SMTP-AUTH. + --smtp-pass * The password for SMTP-AUTH; not necessary. + --smtp-encryption * tls or ssl; anything else disables. + --smtp-ssl * Deprecated. Use '--smtp-encryption ssl'. + --quiet * Output one line of info per email. + --dry-run * Don't actually send the emails. + --no-validate * Don't perform sanity checks on patches. EOT exit(1); -- 2.30.2