584138-mx_update_context-segfault.patch: fix a segfault due to holes in IMAP headers...

[software/mutt-debian.git] / doc / mutt.man

diff --git a/doc/mutt.man b/doc/mutt.man
index 26214f6c6af48ce6221fefffa855d42024f54eaa..8a5113c6d9ef63c4d03c7868bad388c685ffa6eb 100644 (file)
--- a/doc/mutt.man
+++ b/doc/mutt.man
@@ -17,55 +17,73 @@
 .\"     along with this program; if not, write to the Free Software
 .\"     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 .\"
 .\"     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 "March 2007" Unix "User Manuals"
+.TH mutt 1 "January 2009" Unix "User Manuals"

 .SH NAME
 mutt \- The Mutt Mail User Agent
 .SH SYNOPSIS
 .PP
 .B mutt
 .SH NAME
 mutt \- The Mutt Mail User Agent
 .SH SYNOPSIS
 .PP
 .B mutt

-[-nRyzZ] 
-[-e \fIcmd\fP] [-F \fIfile\fP] [-m \fItype\fP] [-f \fIfile\fP]
+[\-nRyzZ]
+[\-e \fIcmd\fP] [\-F \fIfile\fP] [\-m \fItype\fP] [\-f \fIfile\fP]

 .PP
 .B mutt 
 .PP
 .B mutt 

-[-nx] 
-[-e \fIcmd\fP] 
-[-F \fIfile\fP]
-[-H \fIfile\fP]
-[-i \fIfile\fP]
-[-s \fIsubj\fP]
-[-b \fIaddr\fP]
-[-c \fIaddr\fP]
-[\-a \fIfile\fP [...]]
-[\-\-]
-\fIaddr\fP [...]
+[\-nx] 
+[\-e \fIcmd\fP] 
+[\-F \fIfile\fP]
+[\-H \fIfile\fP]
+[\-i \fIfile\fP]
+[\-s \fIsubj\fP]
+[\-b \fIaddr\fP]
+[\-c \fIaddr\fP]
+[\-a \fIfile\fP [...] \-\-]
+\fIaddr|mailto_url\fP [...]
+.PP
+.B mutt 
+[\-nx] 
+[\-e \fIcmd\fP] 
+[\-F \fIfile\fP]
+[\-s \fIsubj\fP]
+[\-b \fIaddr\fP]
+[\-c \fIaddr\fP]
+[\-a \fIfile\fP [...] \-\-]
+\fIaddr|mailto_url\fP [...]
+< message

 .PP
 .B mutt
 .PP
 .B mutt

-[-n] [-e \fIcmd\fP] [-F \fIfile\fP] -p
+[\-n] [\-e \fIcmd\fP] [\-F \fIfile\fP] \-p

 .PP
 .B mutt
 .PP
 .B mutt

-[-n] [-e \fIcmd\fP] [-F \fIfile\fP] -A \fIalias\fP
+[\-n] [\-e \fIcmd\fP] [\-F \fIfile\fP] \-A \fIalias\fP

 .PP
 .B mutt
 .PP
 .B mutt

-[-n] [-e \fIcmd\fP] [-F \fIfile\fP] -Q \fIquery\fP
+[\-n] [\-e \fIcmd\fP] [\-F \fIfile\fP] \-Q \fIquery\fP

 .PP
 .B mutt 
 .PP
 .B mutt 

--v[v]
+\-v[v]

 .PP
 .B mutt 
 .PP
 .B mutt 

--D
+\-D

 .SH DESCRIPTION
 .PP
 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 DESCRIPTION
 .PP
 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.

+.PP
+.I Note:
+.IR
+This manual page gives a brief overview of mutt's command line
+options. You should find a copy of the full manual in @docdir@, in
+text, HTML, and/or PDF format.

 .SH OPTIONS
 .PP
 .IP "-A \fIalias\fP"
 An expanded version of the given alias is passed to stdout.
 .IP "-a \fIfile\fP [...]"
 Attach a file to your message using MIME.
 .SH OPTIONS
 .PP
 .IP "-A \fIalias\fP"
 An expanded version of the given alias is passed to stdout.
 .IP "-a \fIfile\fP [...]"
 Attach a file to your message using MIME.

-To attach multiple files, separating filenames and recipient addresses with
-"\-\-" is mandatory, e.g. \fBmutt \-a img.jpg *.png \-\- addr1 addr2\fP.
+When attaching single or multiple files, separating filenames and recipient addresses with
+"\-\-" is mandatory, e.g. \fBmutt \-a image.jpg \-\- addr1\fP or
+\fBmutt \-a img.jpg *.png \-\- addr1 addr2\fP.
+The \-a option must be placed at the end of command line options.

 .IP "-b \fIaddress\fP"
 Specify a blind-carbon-copy (BCC) recipient
 .IP "-c \fIaddress\fP"
 .IP "-b \fIaddress\fP"
 Specify a blind-carbon-copy (BCC) recipient
 .IP "-c \fIaddress\fP"


@@ -91,7 +109,7 @@ message.
 .IP "-i \fIinclude\fP"
 Specify a file to include into the body of a message.
 .IP "-m \fItype\fP       "
 .IP "-i \fIinclude\fP"
 Specify a file to include into the body of a message.
 .IP "-m \fItype\fP       "

-specify a default mailbox type
+specify a default mailbox type for newly created folders.

 .IP "-n"
 Causes Mutt to bypass the system configuration file.
 .IP "-p"
 .IP "-n"
 Causes Mutt to bypass the system configuration file.
 .IP "-p"


@@ -114,12 +132,12 @@ Emulate the mailx compose mode.
 Start Mutt with a listing of all mailboxes specified by the \fImailboxes\fP
 command.
 .IP "-z"
 Start Mutt with a listing of all mailboxes specified by the \fImailboxes\fP
 command.
 .IP "-z"

-When used with -f, causes Mutt not to start if there are no messages in the
+When used with \-f, causes Mutt not to start if there are no messages in the

 mailbox.
 .IP "-Z"
 Causes Mutt to open the first mailbox specified by the \fImailboxes\fP
 command which contains new mail.
 mailbox.
 .IP "-Z"
 Causes Mutt to open the first mailbox specified by the \fImailboxes\fP
 command which contains new mail.

-.IP "\-\-"
+.IP "--"

 Treat remaining arguments as \fIaddr\fP even if they start with a dash.
 See also "\-a" above.
 .SH ENVIRONMENT
 Treat remaining arguments as \fIaddr\fP even if they start with a dash.
 See also "\-a" above.
 .SH ENVIRONMENT


@@ -133,8 +151,8 @@ Full path of the user's home directory.
 .IP "MAIL"
 Full path of the user's spool mailbox.
 .IP "MAILDIR"
 .IP "MAIL"
 Full path of the user's spool mailbox.
 .IP "MAILDIR"

-Full path of the user's spool mailbox.  Commonly used when the spool
-mailbox is a 
+Full path of the user's spool mailbox if MAIL is unset.  Commonly used when the spool
+mailbox is a

 .B maildir (5)
 folder.
 .IP "MAILCAPS"
 .B maildir (5)
 folder.
 .IP "MAILCAPS"