]> granicus.if.org Git - neomutt/commitdiff
mutt.man and mutt -h updates
authorChristoph Berg <cb@df7cb.de>
Wed, 14 Mar 2007 20:09:20 +0000 (13:09 -0700)
committerChristoph Berg <cb@df7cb.de>
Wed, 14 Mar 2007 20:09:20 +0000 (13:09 -0700)
the following patch documents mutt --, removes the reference to flea,
and generally updates the mutt.1 manpage.

(I removed -d from the SYNOPSIS part since it wasn't entirely correct
syntactically there and putting it elsewhere seems like unnecessary
clutter.)

doc/mutt.man
main.c

index afc628d1fefbdcf26d10a618949147084b450113..52a4d2941735bf2bceacfeb5987fc4dc1e8a01f5 100644 (file)
@@ -17,7 +17,7 @@
 .\"     along with this program; if not, write to the Free Software
 .\"     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 .\"
-.TH mutt 1 "January 2002" Unix "User Manuals"
+.TH mutt 1 "March 2007" Unix "User Manuals"
 .SH NAME
 mutt \- The Mutt Mail User Agent
 .SH SYNOPSIS
@@ -35,19 +35,18 @@ mutt \- The Mutt Mail User Agent
 [-i \fIfile\fP]
 [-s \fIsubj\fP]
 [-b \fIaddr\fP]
-[-c \fIaddr\fP] \fIaddr\fP [...]
+[-c \fIaddr\fP]
+[--]
+\fIaddr\fP [...]
 .PP
 .B mutt
 [-n] [-e \fIcmd\fP] [-F \fIfile\fP] -p
 .PP
 .B mutt
-[-n] [-e \fIcmd\fP] [-F \fIfile\fP] -Q \fIquery\fP
-.PP
-.B mutt
 [-n] [-e \fIcmd\fP] [-F \fIfile\fP] -A \fIalias\fP
 .PP
 .B mutt
--d \fIlevel\fp
+[-n] [-e \fIcmd\fP] [-F \fIfile\fP] -Q \fIquery\fP
 .PP
 .B mutt 
 -v[v]
@@ -56,9 +55,9 @@ mutt \- The Mutt Mail User Agent
 -D
 .SH DESCRIPTION
 .PP
-Mutt is a small but very powerful text based program for reading electronic
-mail under unix operating systems, including support color terminals, MIME,
-and a threaded sorting mode.
+Mutt is a small but very powerful text based program for reading and sending electronic
+mail under unix operating systems, including support for color terminals, MIME,
+OpenPGP, and a threaded sorting mode.
 .SH OPTIONS
 .PP
 .IP "-A \fIalias\fP"
@@ -69,6 +68,10 @@ Attach a file to your message using MIME.
 Specify a blind-carbon-copy (BCC) recipient
 .IP "-c \fIaddress\fP"
 Specify a carbon-copy (CC) recipient
+.IP "-d \fIlevel\fp"
+If mutt was complied with +DEBUG log debugging output to ~/.muttdebug0.
+\fILevel\fP can range from 1-5 and effects verbosity. A value of 2 is
+recommended.
 .IP "-D"
 Print the value of all configuration options to stdout.
 .IP "-e \fIcommand\fP"
@@ -99,12 +102,10 @@ the command line have been executed.
 Open a mailbox in \fIread-only\fP mode.
 .IP "-s \fIsubject\fP"
 Specify the subject of the message.
-.IP "-d \fIlevel\fp"
-If mutt was complied with +DEBUG log debugging output to ~/.muttdebug0.
-\fILevel\fP can range from 1-5 and effects verbosity. A value of 2 is
-recommended.
 .IP "-v"
 Display the Mutt version number and compile-time definitions.
+.IP "-vv"
+Display license and copyright information.
 .IP "-x"
 Emulate the mailx compose mode.
 .IP "-y"
@@ -116,6 +117,8 @@ mailbox.
 .IP "-Z"
 Causes Mutt to open the first mailbox specified by the \fImailboxes\fP
 command which contains new mail.
+.IP "--"
+Treat remaining arguments as \fIaddr\fP even if they start with a dash.
 .SH ENVIRONMENT
 .PP
 .IP "EDITOR"
@@ -175,16 +178,13 @@ with the S-Lang library, however.
 Resizing the screen while using an external pager causes Mutt to go haywire
 on some systems.
 .PP
-suspend/resume does not work under Ultrix.
+Suspend/resume does not work under Ultrix.
 .PP
 The help line for the index menu is not updated if you change the bindings
 for one of the functions listed while Mutt is running.
 .PP
 For a more up-to-date list of bugs, errm, fleas, please visit the
-mutt project's bug tracking system under http://bugs.guug.de/.  To
-report a bug, please use the
-.BR flea (1)
-program.
+mutt project's bug tracking system under http://bugs.mutt.org/.
 .SH NO WARRANTIES
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -193,7 +193,6 @@ GNU General Public License for more details.
 .SH SEE ALSO
 .PP
 .BR curses (3),
-.BR flea (1),
 .BR mailcap (5),
 .BR maildir (5),
 .BR mbox (5),
@@ -201,13 +200,11 @@ GNU General Public License for more details.
 .BR muttrc (5),
 .BR ncurses (3),
 .BR sendmail (1),
-.BR smail (1)
+.BR smail (1).
 .PP
 Mutt Home Page: http://www.mutt.org/
 .PP
 The Mutt manual
-.PP
-The GNU General Public License.
 .SH AUTHOR
 .PP
 Michael Elkins, and others.  Use <mutt-dev@mutt.org> to contact
diff --git a/main.c b/main.c
index e8b7300e767ee4aaaf0e796272f29399e7114752..546748311ab558b8668daca99bf1e9498d1cc7fa 100644 (file)
--- a/main.c
+++ b/main.c
@@ -109,7 +109,7 @@ static void mutt_usage (void)
        mutt [ -nR ] [ -e <cmd> ] [ -F <file> ] -Q <query> [ -Q <query> ] [...]\n\
        mutt [ -nR ] [ -e <cmd> ] [ -F <file> ] -A <alias> [ -A <alias> ] [...]\n\
        mutt [ -nR ] [ -e <cmd> ] [ -F <file> ] -D\n\
-       mutt [ -nx ] [ -e <cmd> ] [ -a <file> ] [ -F <file> ] [ -H <file> ] [ -i <file> ] [ -s <subj> ] [ -b <addr> ] [ -c <addr> ] <addr> [ ... ]\n\
+       mutt [ -nx ] [ -e <cmd> ] [ -a <file> ] [ -F <file> ] [ -H <file> ] [ -i <file> ] [ -s <subj> ] [ -b <addr> ] [ -c <addr> ] [ -- ] <addr> [ ... ]\n\
        mutt [ -n ] [ -e <cmd> ] [ -F <file> ] -p\n\
        mutt -v[v]\n");
 
@@ -143,6 +143,7 @@ options:\n\
   -z\t\texit immediately if there are no messages in the mailbox\n\
   -Z\t\topen the first folder with new message, exit immediately if none\n\
   -h\t\tthis help message");
+  puts _("  --\t\ttreat remaining arguments as addr even if starting with a dash");
 
   exit (0);
 }