]> granicus.if.org Git - neomutt/commitdiff
Adjust usage() string across docs for consistency 1170/head
authorFloyd Anderson <f.a@31c0.net>
Fri, 27 Apr 2018 19:07:14 +0000 (21:07 +0200)
committerRichard Russon <rich@flatcap.org>
Sat, 28 Apr 2018 10:25:38 +0000 (11:25 +0100)
doc/manual.xml.head
doc/neomutt.man
main.c

index 663f2df739f0186eb019c73ff0005f1d19b89736..a686da1d66ef60c1e19931caa0d19d682dd1b539 100644 (file)
@@ -16556,20 +16556,27 @@ folder-hook ^pop 'set read_inc=1'
             </row>
           </thead>
           <tbody>
+            <row>
+              <entry>--</entry>
+              <entry>
+                Special argument forces NeoMutt to stop option parsing and
+                treat remaining arguments as <literal>address</literal>es even
+                if they start with a dash
+              </entry>
+            </row>
             <row>
               <entry>-A <literal>alias</literal></entry>
               <entry>
                 Print an expanded version of the given <literal>alias</literal>
-                to stdout and exit.
+                to stdout and exit
               </entry>
             </row>
             <row>
-              <entry>-a <literal>file</literal> [<literal>...</literal>]</entry>
+              <entry>-a <literal>file</literal></entry>
               <entry>
-                Attach one or more <literal>file</literal>s to a message. Must
-                be given at last and separate attachment(s) from address(es)
-                using the &apos;<emphasis role="bold">--</emphasis>&apos;
-                argument, e.g.:
+                Attach one or more <literal>file</literal>s to a message (must
+                be the last option). Add any addresses after the
+                &apos;<emphasis role="bold">--</emphasis>&apos; argument, e.g.:
 
 <screen>
 neomutt -a image.jpg -- address1
@@ -16581,48 +16588,48 @@ neomutt -a image.jpg *.png -- address1 address2
             <row>
               <entry>-B</entry>
               <entry>
-                Run in batch mode (do not start the ncurses UI).
+                Run in batch mode (do not start the ncurses UI)
               </entry>
             </row>
             <row>
               <entry>-b <literal>address</literal></entry>
               <entry>
-                Specify a blind carbon copy (Bcc) recipient.
+                Specify a blind carbon copy (Bcc) recipient
               </entry>
             </row>
             <row>
               <entry>-c <literal>address</literal></entry>
               <entry>
-                Specify a carbon copy (Cc) recipient.
+                Specify a carbon copy (Cc) recipient
               </entry>
             </row>
             <row>
               <entry>-D</entry>
               <entry>
-                Dump all configuration variables as
-                &apos;<emphasis role="bold">name=value</emphasis>&apos; pair to
-                stdout.
+                Dump all config variables as
+                &apos;<emphasis role="bold">name=value</emphasis>&apos; pairs
+                to stdout
               </entry>
             </row>
             <row>
               <entry>-D -S</entry>
               <entry>
                 Like <emphasis role="bold">-D</emphasis>, but hide the value of
-                sensitive variables.
+                sensitive variables
               </entry>
             </row>
             <row>
               <entry>-d <literal>level</literal></entry>
               <entry>
-                Log debugging output to file (by default to
+                Log debugging output to a file (default is
                 &quot;<literal>~/.neomuttdebug0</literal>&quot;).
                 The <literal>level</literal> can range from 1&ndash;5 and
-                affects verbosity. A value of 2 is recommended. Using this
+                affects verbosity (a value of 2 is recommended). Using this
                 option along with <emphasis role="bold">-l</emphasis> is useful
                 to log the early startup process (before reading any
                 configuration and hence
                 <link linkend="debug-level">$debug_level</link> and
-                <link linkend="debug-file">$debug_file</link>).
+                <link linkend="debug-file">$debug_file</link>)
               </entry>
             </row>
             <row>
@@ -16631,74 +16638,76 @@ neomutt -a image.jpg *.png -- address1 address2
                 Edit
                 <literal>draft</literal> (<emphasis role="bold">-H</emphasis>) or
                 <literal>include</literal> (<emphasis role="bold">-i</emphasis>)
-                file during message composition.
+                file during message composition
               </entry>
             </row>
             <row>
               <entry>-e <literal>command</literal></entry>
               <entry>
-                Specify a <literal>command</literal> to be run after initial
-                program configuration.
+                Specify a <literal>command</literal> to be run after reading
+                the config files
               </entry>
             </row>
             <row>
               <entry>-F <literal>config</literal></entry>
               <entry>
-                Specify an alternative initialization file to read. See section
+                Specify an alternative initialization file to read, see section
                 <link linkend="configuration-files">Location of Initialization Files</link>
-                for a list of regular configuration files.
+                for a list of regular configuration files
               </entry>
             </row>
             <row>
               <entry>-f <literal>mailbox</literal></entry>
               <entry>
                 Specify a <literal>mailbox</literal> (as defined with
-                <command>mailboxes</command> command) to load.
+                <link linkend="mailboxes"><command>mailboxes</command> command</link>)
+                to load
               </entry>
             </row>
             <row>
               <entry>-G</entry>
               <entry>
-                Start NeoMutt with a listing of subscribed newsgroups.
+                Start NeoMutt with a listing of subscribed newsgroups
               </entry>
             </row>
             <row>
               <entry>-g <literal>server</literal></entry>
               <entry>
                 Like <emphasis role="bold">-G</emphasis>, but start at
-                specified news <literal>server</literal>.
+                specified news <literal>server</literal>
               </entry>
             </row>
             <row>
               <entry>-H <literal>draft</literal></entry>
               <entry>
                 Specify a <literal>draft</literal> file with header and body
-                for message composing.
+                for message composing
               </entry>
             </row>
             <row>
               <entry>-h</entry>
               <entry>
-                Print this help message and exit.
+                Print this help message and exit
               </entry>
             </row>
             <row>
               <entry>-i <literal>include</literal></entry>
               <entry>
                 Specify an <literal>include</literal> file to be embedded in
-                the body of a message.
+                the body of a message
               </entry>
             </row>
             <row>
               <entry>-l <literal>file</literal></entry>
               <entry>
-                Specify a <literal>file</literal> for debugging output. This
+                Specify a <literal>file</literal> for debugging output (default
+                &quot;<literal>~/.neomuttdebug0</literal>&quot;). This
                 overrules <link linkend="debug-file">$debug_file</link>
-                setting. NeoMutt keeps up to five debug logs ({
+                setting and NeoMutt keeps up to five debug logs ({
                 <literal>file</literal> |
                 <link linkend="debug-file">$debug_file</link> |
                 <literal>~/.neomuttdebug</literal> }[<literal>0-4</literal>])
-                before override the oldest file.
+                before override the oldest file
               </entry>
             </row>
             <row>
@@ -16706,73 +16715,72 @@ neomutt -a image.jpg *.png -- address1 address2
               <entry>
                 Specify a default mailbox format <literal>type</literal> for
                 newly created folders. The <literal>type</literal> is either
-                MH, MMDF, Maildir or mbox (case-insensitive).
+                MH, MMDF, Maildir or mbox (case-insensitive)
               </entry>
             </row>
             <row>
               <entry>-n</entry>
               <entry>
-                Bypass loading of system-wide configuration file.
+                Do not read the system-wide configuration file
               </entry>
             </row>
             <row>
               <entry>-p</entry>
               <entry>
-                Resume a prior postponed message, if any.
+                Resume a prior postponed message, if any
               </entry>
             </row>
             <row>
               <entry>-Q <literal>variable</literal></entry>
               <entry>
-                Query a configuration <literal>variable</literal> after all
-                configuration files and commands
-                (<emphasis role="bold">-e</emphasis>) have been processed and
-                print its value to stdout.
+                Query a configuration <literal>variable</literal> and print its
+                value to stdout (after the config has been read and any
+                commands executed)
               </entry>
             </row>
             <row>
               <entry>-R</entry>
               <entry>
-                Open mailbox in read-only mode.
+                Open mailbox in read-only mode
               </entry>
             </row>
             <row>
               <entry>-s <literal>subject</literal></entry>
               <entry>
                 Specify a <literal>subject</literal> (must be enclosed in
-                quotes if it has spaces).
+                quotes if it has spaces)
               </entry>
             </row>
             <row>
               <entry>-v</entry>
               <entry>
-                Print the NeoMutt version and compile-time definitions and exit.
+                Print the NeoMutt version and compile-time definitions and exit
               </entry>
             </row>
             <row>
               <entry>-vv</entry>
               <entry>
-                Print the NeoMutt license and copyright information and exit.
+                Print the NeoMutt license and copyright information and exit
               </entry>
             </row>
             <row>
               <entry>-x</entry>
               <entry>
                 Simulate the <emphasis role="bold">mailx</emphasis>(1) send
-                mode.
+                mode
               </entry>
             </row>
             <row>
               <entry>-y</entry>
               <entry>
-                Start NeoMutt with a listing of all defined mailboxes.
+                Start NeoMutt with a listing of all defined mailboxes
               </entry>
             </row>
             <row>
               <entry>-Z</entry>
               <entry>
-                Open the first mailbox with new message or exit immediately with
-                exit code 1 if none is found in all defined mailboxes.
+                Open the first mailbox with new message or exit immediately
+                with exit code 1 if none is found in all defined mailboxes
               </entry>
             </row>
             <row>
@@ -16780,15 +16788,7 @@ neomutt -a image.jpg *.png -- address1 address2
               <entry>
                 Open the first or specified
                 (<emphasis role="bold">-f</emphasis>) mailbox if it holds any
-                message or exit immediately with exit code 1 otherwise.
-              </entry>
-            </row>
-            <row>
-              <entry>--</entry>
-              <entry>
-                Special argument forces NeoMutt to stop option parsing and
-                treat remaining arguments as <literal>address</literal> even if
-                they start with a hyphen.
+                message or exit immediately with exit code 1 otherwise
               </entry>
             </row>
           </tbody>
index 26eedb4a96af4663ce4cc696eedbcaa730248dd3..beea680dafa0dab1b1a44d443372c370e6204feb 100644 (file)
@@ -159,13 +159,18 @@ HTML, and/or PDF format.
 .SH OPTIONS
 .\" --------------------------------------------------------------------
 .TP
+.BI \-\-
+Special argument forces NeoMutt to stop option parsing and treat remaining
+arguments as \fIaddress\fPes even if they start with a dash
+.
+.TP
 .BI \-A " alias"
-Print an expanded version of the given \fIalias\fP to stdout and exit.
+Print an expanded version of the given \fIalias\fP to stdout and exit
 .
 .TP
-.BI \-a " file \fR[\fP.\|.\|.\&\fR]\fP"
-Attach one or more \fIfile\fPs to a message. Must be given at last and separate
-attachment(s) from address(es) using the \(aq\fB\-\-\fP\(aq argument, e.g.:
+.BI \-a " file"
+Attach one or more \fIfile\fPs to a message (must be the last option). Add any
+addresses after the \(aq\fB\-\-\fP\(aq argument, e.g.:
 .RS
 .IP
 .EX
@@ -177,141 +182,137 @@ attachment(s) from address(es) using the \(aq\fB\-\-\fP\(aq argument, e.g.:
 .
 .TP
 .BI \-B
-Run in batch mode (do not start the ncurses UI).
+Run in batch mode (do not start the ncurses UI)
 .
 .TP
 .BI \-b " address"
-Specify a blind carbon copy (Bcc) recipient.
+Specify a blind carbon copy (Bcc) recipient
 .
 .TP
 .BI \-c " address"
-Specify a carbon copy (Cc) recipient.
+Specify a carbon copy (Cc) recipient
 .
 .TP
 .BI \-D
 Dump all configuration variables as
 .RB \(aq name = value \(aq
-pair to stdout.
+pairs to stdout
 .
 .TP
 .BI \-D\ \-S
-Like \fB\-D\fP, but hide the value of sensitive variables.
+Like \fB\-D\fP, but hide the value of sensitive variables
 .
 .TP
 .BI \-d " level"
-Log debugging output to file (by default to \(dq\fI~/.neomuttdebug0\fP\(dq).
-The \fIlevel\fP can range from 1\(en5 and affects verbosity. A value of 2 is
-recommended.
+Log debugging output to a file (default is \(dq\fI~/.neomuttdebug0\fP\(dq).
+The \fIlevel\fP can range from 1\(en5 and affects verbosity (a value of 2 is
+recommended)
 .IP
 Using this option along with \fB\-l\fP is useful to log the early startup
 process (before reading any configuration and hence $debug_level and
-$debug_file).
+$debug_file)
 .
 .TP
 .BI \-E
 Edit \fIdraft\fP (\fB\-H\fP) or \fIinclude\fP (\fB\-i\fP) file during message
-composition.
+composition
 .
 .TP
 .BI \-e " command"
-Specify a \fIcommand\fP to be run after initial program configuration.
+Specify a \fIcommand\fP to be run after reading the config files
 .
 .TP
 .BI \-F " config"
-Specify an alternative initialization file to read.
-.IP
-See \fIFILES\fP section below for a list of regular configuration files.
+Specify an alternative initialization file to read, see \fIFILES\fP section
+below for a list of regular configuration files
 .
 .TP
 .BI \-f " mailbox"
-Specify a \fImailbox\fP (as defined with \fBmailboxes\fP command) to load.
+Specify a \fImailbox\fP (as defined with \fBmailboxes\fP command) to load
 .
 .TP
 .BI \-G
-Start NeoMutt with a listing of subscribed newsgroups.
+Start NeoMutt with a listing of subscribed newsgroups
 .
 .TP
 .BI \-g " server"
-Like \fB\-G\fP, but start at specified news \fIserver\fP.
+Like \fB\-G\fP, but start at specified news \fIserver\fP
 .
 .TP
 .BI \-H " draft"
-Specify a \fIdraft\fP file with header and body for message composing.
+Specify a \fIdraft\fP file with header and body for message composing
 .
 .TP
 .BI \-h
-Print this help message and exit.
+Print this help message and exit
 .
 .TP
 .BI \-i " include"
-Specify an \fIinclude\fP file to be embedded in the body of a message.
+Specify an \fIinclude\fP file to be embedded in the body of a message
 .
 .TP
 .BI \-l " file"
-Specify a \fIfile\fP for debugging output.
+Specify a \fIfile\fP for debugging output (default
+\(dq\fI~/.neomuttdebug0\fP\(dq)
 .IP
-This overrules $debug_file setting. NeoMutt keeps up to five debug logs
+This overrules $debug_file setting and NeoMutt keeps up to five debug logs
 .RI "({ " file " | $debug_file | " ~/.neomuttdebug " }[" 0 - 4 ])
-before override the oldest file.
+before override the oldest file
 .
 .TP
 .BI \-m " type"
-Specify a default mailbox format \fItype\fP for newly created folders. The
-\fItype\fP is either MH, MMDF, Maildir or mbox (case-insensitive).
+Specify a default mailbox format \fItype\fP for newly created folders
+.IP
+The \fItype\fP is either MH, MMDF, Maildir or mbox (case-insensitive)
 .
 .TP
 .BI \-n
-Bypass loading of system-wide configuration file.
+Do not read the system-wide configuration file
 .
 .TP
 .BI \-p
-Resume a prior postponed message, if any.
+Resume a prior postponed message, if any
 .
 .TP
 .BI \-Q " variable"
-Query a configuration \fIvariable\fP after all configuration files and commands
-(\fB\-e\fP) have been processed and print its value to stdout.
+Query a configuration \fIvariable\fP and print its value to stdout (after the
+config has been read and any commands executed)
 .
 .TP
 .BI \-R
-Open mailbox in read-only mode.
+Open mailbox in read-only mode
 .
 .TP
 .BI \-s " subject"
-Specify a \fIsubject\fP (must be enclosed in quotes if it has spaces).
+Specify a \fIsubject\fP (must be enclosed in quotes if it has spaces)
 .
 .TP
 .BI \-v
-Print the NeoMutt version and compile-time definitions and exit.
+Print the NeoMutt version and compile-time definitions and exit
 .
 .TP
 .BI \-vv
-Print the NeoMutt license and copyright information and exit.
+Print the NeoMutt license and copyright information and exit
 .
 .TP
 .BI \-x
 Simulate the
 .BR mailx (1)
-send mode.
+send mode
 .
 .TP
 .BI \-y
-Start NeoMutt with a listing of all defined mailboxes.
+Start NeoMutt with a listing of all defined mailboxes
 .
 .TP
 .BI \-Z
 Open the first mailbox with new message or exit immediately with exit code 1 if
-none is found in all defined mailboxes.
+none is found in all defined mailboxes
 .
 .TP
 .BI \-z
 Open the first or specified (\fB\-f\fP) mailbox if it holds any message or exit
-immediately with exit code 1 otherwise.
-.
-.TP
-.BI \-\-
-Special argument forces NeoMutt to stop option parsing and treat remaining
-arguments as \fIaddress\fP even if they start with a hyphen.
+immediately with exit code 1 otherwise
 .
 .\" --------------------------------------------------------------------
 .SH ENVIRONMENT
diff --git a/main.c b/main.c
index c45891d6fe1391fb1ddc05094a5acc16a3ad1f47..35af68b0151857eaa9ac44a66c7d4232434f7e60 100644 (file)
--- a/main.c
+++ b/main.c
@@ -117,6 +117,8 @@ static void usage(void)
   /* L10N: Try to limit to 80 columns
            If more space is needed add an indented line */
   puts(_("options:\n"
+         "  --            Special argument forces NeoMutt to stop option parsing and treat\n"
+         "                remaining arguments as addresses even if they start with a dash\n"
          "  -A <alias>    Print an expanded version of the given alias to stdout and exit\n"
          "  -a <file>     Attach one or more files to a message (must be the last option)\n"
          "                Add any addresses after the '--' argument\n"
@@ -136,7 +138,7 @@ static void usage(void)
          "  -H <draft>    Specify a draft file with header and body for message composing\n"
          "  -h            Print this help message and exit\n"
          "  -i <include>  Specify an include file to be embedded in the body of a message\n"
-         "  -l <file>     Specify a file for debugging output (default ~/.neomuttdebug0)\n"
+         "  -l <file>     Specify a file for debugging output (default \"~/.neomuttdebug0\")\n"
          "  -m <type>     Specify a default mailbox format type for newly created folders\n"
          "                The type is either MH, MMDF, Maildir or mbox (case-insensitive)\n"
          "  -n            Do not read the system-wide configuration file\n"
@@ -152,9 +154,7 @@ static void usage(void)
          "  -Z            Open the first mailbox with new message or exit immediately with\n"
          "                exit code 1 if none is found in all defined mailboxes\n"
          "  -z            Open the first or specified (-f) mailbox if it holds any message\n"
-         "                or exit immediately with exit code 1 otherwise\n"
-         "  --            Special argument forces NeoMutt to stop option parsing and treat\n"
-         "                remaining arguments as addresses even if they start with a dash"));
+         "                or exit immediately with exit code 1 otherwise"));
 }
 // clang-format on