jcs.org
mutt stable branch with some hacks
1.\" -*-nroff-*-
2.\"
3.\"
4.\" Copyright (C) 1996-2016 Michael R. Elkins <me@cs.hmc.edu>
5.\"
6.\" This program is free software; you can redistribute it and/or modify
7.\" it under the terms of the GNU General Public License as published by
8.\" the Free Software Foundation; either version 2 of the License, or
9.\" (at your option) any later version.
10.\"
11.\" This program is distributed in the hope that it will be useful,
12.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
13.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14.\" GNU General Public License for more details.
15.\"
16.\" You should have received a copy of the GNU General Public License
17.\" along with this program; if not, write to the Free Software
18.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19.\"
20.TH mutt 1 "January 2009" Unix "User Manuals"
21.SH NAME
22mutt \- The Mutt Mail User Agent
23.SH SYNOPSIS
24.PP
25.B mutt
26[\-nRyzZ]
27[\-e \fIcmd\fP] [\-F \fIfile\fP] [\-m \fItype\fP] [\-f \fIfile\fP]
28.PP
29.B mutt
30[\-Enx]
31[\-e \fIcmd\fP]
32[\-F \fIfile\fP]
33[\-H \fIfile\fP]
34[\-i \fIfile\fP]
35[\-s \fIsubj\fP]
36[\-b \fIaddr\fP]
37[\-c \fIaddr\fP]
38[\-a \fIfile\fP [...] \-\-]
39\fIaddr|mailto_url\fP [...]
40.PP
41.B mutt
42[\-nx]
43[\-e \fIcmd\fP]
44[\-F \fIfile\fP]
45[\-s \fIsubj\fP]
46[\-b \fIaddr\fP]
47[\-c \fIaddr\fP]
48[\-a \fIfile\fP [...] \-\-]
49\fIaddr|mailto_url\fP [...]
50< message
51.PP
52.B mutt
53[\-n] [\-e \fIcmd\fP] [\-F \fIfile\fP] \-p
54.PP
55.B mutt
56[\-n] [\-e \fIcmd\fP] [\-F \fIfile\fP] \-A \fIalias\fP
57.PP
58.B mutt
59[\-n] [\-e \fIcmd\fP] [\-F \fIfile\fP] \-Q \fIquery\fP
60.PP
61.B mutt
62\-v[v]
63.PP
64.B mutt
65\-D
66.SH DESCRIPTION
67.PP
68Mutt is a small but very powerful text based program for reading and sending electronic
69mail under unix operating systems, including support for color terminals, MIME,
70OpenPGP, and a threaded sorting mode.
71.PP
72.I Note:
73.IR
74This manual page gives a brief overview of mutt's command line
75options. You should find a copy of the full manual in @docdir@, in
76text, HTML, and/or PDF format.
77.SH OPTIONS
78.PP
79.IP "-A \fIalias\fP"
80An expanded version of the given alias is passed to stdout.
81.IP "-a \fIfile\fP [...]"
82Attach a file to your message using MIME.
83When attaching single or multiple files, separating filenames and recipient addresses with
84"\-\-" is mandatory, e.g. \fBmutt \-a image.jpg \-\- addr1\fP or
85\fBmutt \-a img.jpg *.png \-\- addr1 addr2\fP.
86The \-a option must be placed at the end of command line options.
87.IP "-b \fIaddress\fP"
88Specify a blind-carbon-copy (BCC) recipient
89.IP "-c \fIaddress\fP"
90Specify a carbon-copy (CC) recipient
91.IP "-d \fIlevel\fP"
92If mutt was compiled with +DEBUG log debugging output to ~/.muttdebug0.
93\fILevel\fP can range from 1-5 and effects verbosity. A value of 2 is
94recommended.
95.IP "-D"
96Print the value of all configuration options to stdout.
97.IP "-E"
98Causes the draft file specified by -H or include file specified by -i
99to be edited during message composition.
100.IP "-e \fIcommand\fP"
101Specify a configuration command to be run after processing of initialization
102files.
103.IP "-f \fImailbox\fP"
104Specify which mailbox to load.
105.IP "-F \fImuttrc\fP"
106Specify an initialization file to read instead of ~/.muttrc
107.IP "-h"
108Display help.
109.IP "-H \fIdraft\fP"
110Specify a draft file which contains header and body to use to send a
111message.
112.IP "-i \fIinclude\fP"
113Specify a file to include into the body of a message.
114.IP "-m \fItype\fP "
115specify a default mailbox type for newly created folders.
116.IP "-n"
117Causes Mutt to bypass the system configuration file.
118.IP "-p"
119Resume a postponed message.
120.IP "-Q \fIquery\fP"
121Query a configuration variables value. The query is executed after
122all configuration files have been parsed, and any commands given on
123the command line have been executed.
124.IP "-R"
125Open a mailbox in \fIread-only\fP mode.
126.IP "-s \fIsubject\fP"
127Specify the subject of the message.
128.IP "-v"
129Display the Mutt version number and compile-time definitions.
130.IP "-vv"
131Display license and copyright information.
132.IP "-x"
133Emulate the mailx compose mode.
134.IP "-y"
135Start Mutt with a listing of all mailboxes specified by the \fImailboxes\fP
136command.
137.IP "-z"
138When used with \-f, causes Mutt not to start if there are no messages in the
139mailbox.
140.IP "-Z"
141Causes Mutt to open the first mailbox specified by the \fImailboxes\fP
142command which contains new mail.
143.IP "--"
144Treat remaining arguments as \fIaddr\fP even if they start with a dash.
145See also "\-a" above.
146.SH ENVIRONMENT
147.PP
148.IP "EDITOR"
149Specifies the editor to use if VISUAL is unset.
150.IP "EMAIL"
151The user's e-mail address.
152.IP "HOME"
153Full path of the user's home directory.
154.IP "MAIL"
155Full path of the user's spool mailbox.
156.IP "MAILDIR"
157Full path of the user's spool mailbox if MAIL is unset. Commonly used when the spool
158mailbox is a
159.B maildir (5)
160folder.
161.IP "MAILCAPS"
162Path to search for mailcap files.
163.IP "MM_NOASK"
164If this variable is set, mailcap are always used without prompting first.
165.IP "PGPPATH"
166Directory in which the user's PGP public keyring can be found. When used with
167the original PGP program, mutt and
168.B pgpring (1)
169rely on this being set.
170.IP "TMPDIR"
171Directory in which temporary files are created.
172.IP "REPLYTO"
173Default Reply-To address.
174.IP "VISUAL"
175Specifies the editor to use when composing messages.
176.SH FILES
177.PP
178.IP "~/.muttrc or ~/.mutt/muttrc"
179User configuration file.
180.IP "@sysconfdir@/Muttrc"
181System-wide configuration file.
182.IP "/tmp/muttXXXXXX"
183Temporary files created by Mutt.
184.IP "~/.mailcap"
185User definition for handling non-text MIME types.
186.IP "@sysconfdir@/mailcap"
187System definition for handling non-text MIME types.
188.IP "~/.mime.types"
189User's personal mapping between MIME types and file extensions.
190.IP "@sysconfdir@/mime.types"
191System mapping between MIME types and file extensions.
192.IP "@bindir@/mutt_dotlock"
193The privileged dotlocking program.
194.IP "@docdir@/manual.txt"
195The Mutt manual.
196.SH BUGS
197.PP
198None. Mutts have fleas, not bugs.
199.SH FLEAS
200.PP
201Suspend/resume while editing a file with an external editor does not work
202under SunOS 4.x if you use the curses lib in /usr/5lib. It \fIdoes\fP work
203with the S-Lang library, however.
204.PP
205Resizing the screen while using an external pager causes Mutt to go haywire
206on some systems.
207.PP
208Suspend/resume does not work under Ultrix.
209.PP
210The help line for the index menu is not updated if you change the bindings
211for one of the functions listed while Mutt is running.
212.PP
213For a more up-to-date list of bugs, errm, fleas, please visit the
214mutt project's bug tracking system under http://bugs.mutt.org/.
215.SH NO WARRANTIES
216This program is distributed in the hope that it will be useful,
217but WITHOUT ANY WARRANTY; without even the implied warranty of
218MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
219GNU General Public License for more details.
220.SH SEE ALSO
221.PP
222.BR curses (3),
223.BR mailcap (5),
224.BR maildir (5),
225.BR mbox (5),
226.BR mutt_dotlock (1),
227.BR muttrc (5),
228.BR ncurses (3),
229.BR sendmail (1),
230.BR smail (1).
231.PP
232Mutt Home Page: http://www.mutt.org/
233.PP
234The Mutt manual
235.SH AUTHOR
236.PP
237Michael Elkins, and others. Use <mutt-dev@mutt.org> to contact
238the developers.