mutt.man 5.83 KB
Newer Older
Thomas Roessler's avatar
Thomas Roessler committed
1 2 3
.\" -*-nroff-*-
.\"
.\"
4
.\"     Copyright (C) 1996-2004 Michael R. Elkins <me@cs.hmc.edu>
Thomas Roessler's avatar
Thomas Roessler committed
5 6 7 8 9 10 11 12 13 14 15 16 17
.\" 
.\"     This program is free software; you can redistribute it and/or modify
.\"     it under the terms of the GNU General Public License as published by
.\"     the Free Software Foundation; either version 2 of the License, or
.\"     (at your option) any later version.
.\" 
.\"     This program is distributed in the hope that it will be useful,
.\"     but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"     GNU General Public License for more details.
.\" 
.\"     You should have received a copy of the GNU General Public License
.\"     along with this program; if not, write to the Free Software
18
.\"     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Thomas Roessler's avatar
Thomas Roessler committed
19
.\"
Thomas Roessler's avatar
Thomas Roessler committed
20
.TH mutt 1 "January 2002" Unix "User Manuals"
Thomas Roessler's avatar
Thomas Roessler committed
21
.SH NAME
Thomas Roessler's avatar
Thomas Roessler committed
22
mutt \- The Mutt Mail User Agent
Thomas Roessler's avatar
Thomas Roessler committed
23
.SH SYNOPSIS
Thomas Roessler's avatar
Thomas Roessler committed
24
.PP
25
.B mutt
26 27
[-nRyzZ] 
[-e \fIcmd\fP] [-F \fIfile\fP] [-m \fItype\fP] [-f \fIfile\fP]
28 29
.PP
.B mutt 
30 31 32 33 34 35 36 37 38
[-nx] 
[-e \fIcmd\fP] 
[-a \fIfile\fP]
[-F \fIfile\fP]
[-H \fIfile\fP]
[-i \fIfile\fP]
[-s \fIsubj\fP]
[-b \fIaddr\fP]
[-c \fIaddr\fP] \fIaddr\fP [...]
39 40
.PP
.B mutt
41
[-n] [-e \fIcmd\fP] [-F \fIfile\fP] -p
42
.PP
Thomas Roessler's avatar
Thomas Roessler committed
43 44 45
.B mutt
[-n] [-e \fIcmd\fP] [-F \fIfile\fP] -Q \fIquery\fP
.PP
46 47 48
.B mutt
[-n] [-e \fIcmd\fP] [-F \fIfile\fP] -A \fIalias\fP
.PP
Thomas Roessler's avatar
Thomas Roessler committed
49
.B mutt 
50
-v[v]
51 52 53
.PP
.B mutt 
-D
Thomas Roessler's avatar
Thomas Roessler committed
54
.SH DESCRIPTION
Thomas Roessler's avatar
Thomas Roessler committed
55
.PP
Thomas Roessler's avatar
Thomas Roessler committed
56 57 58 59
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.
.SH OPTIONS
Thomas Roessler's avatar
Thomas Roessler committed
60
.PP
61 62
.IP "-A \fIalias\fP"
An expanded version of the given alias is passed to stdout.
Thomas Roessler's avatar
Thomas Roessler committed
63 64 65 66 67 68
.IP "-a \fIfile\fP"
Attach a file to your message using MIME.
.IP "-b \fIaddress\fP"
Specify a blind-carbon-copy (BCC) recipient
.IP "-c \fIaddress\fP"
Specify a carbon-copy (CC) recipient
69 70
.IP "-D"
Print the value of all configuration options to stdout.
Thomas Roessler's avatar
Thomas Roessler committed
71 72 73 74 75 76 77 78 79 80 81 82 83 84
.IP "-e \fIcommand\fP"
Specify a configuration command to be run after processing of initialization
files.
.IP "-f \fImailbox\fP"
Specify which mailbox to load.
.IP "-F \fImuttrc\fP"
Specify an initialization file to read instead of ~/.muttrc
.IP "-h"
Display help.
.IP "-H \fIdraft\fP"
Specify a draft file which contains header and body to use to send a
message.
.IP "-i \fIinclude\fP"
Specify a file to include into the body of a message.
Thomas Roessler's avatar
Thomas Roessler committed
85
.IP "-m \fItype\fP       "
Thomas Roessler's avatar
Thomas Roessler committed
86 87 88 89 90
specify a default mailbox type
.IP "-n"
Causes Mutt to bypass the system configuration file.
.IP "-p"
Resume a postponed message.
Thomas Roessler's avatar
Thomas Roessler committed
91
.IP "-Q \fIquery\fP"
92
Query a configuration variables value.  The query is executed after
Thomas Roessler's avatar
Thomas Roessler committed
93 94
all configuration files have been parsed, and any commands given on
the command line have been executed.
Thomas Roessler's avatar
Thomas Roessler committed
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
.IP "-R"
Open a mailbox in \fIread-only\fP mode.
.IP "-s \fIsubject\fP"
Specify the subject of the message.
.IP "-v"
Display the Mutt version number and compile-time definitions.
.IP "-x"
Emulate the mailx compose mode.
.IP "-y"
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
mailbox.
.IP "-Z"
Causes Mutt to open the first mailbox specified by the \fImailboxes\fP
command which contains new mail.
.SH ENVIRONMENT
Thomas Roessler's avatar
Thomas Roessler committed
113
.PP
Thomas Roessler's avatar
Thomas Roessler committed
114
.IP "EDITOR"
115
Specifies the editor to use if VISUAL is unset.
116 117
.IP "EMAIL"
The user's e-mail address.
Thomas Roessler's avatar
Thomas Roessler committed
118 119 120 121
.IP "HOME"
Full path of the user's home directory.
.IP "MAIL"
Full path of the user's spool mailbox.
Thomas Roessler's avatar
Thomas Roessler committed
122 123 124 125 126
.IP "MAILDIR"
Full path of the user's spool mailbox.  Commonly used when the spool
mailbox is a 
.B maildir (5)
folder.
Thomas Roessler's avatar
Thomas Roessler committed
127 128 129 130 131 132 133 134 135 136 137
.IP "MAILCAPS"
Path to search for mailcap files.
.IP "MM_NOASK"
If this variable is set, mailcap are always used without prompting first.
.IP "PGPPATH"
Directory in which the user's PGP public keyring can be found.
.IP "TMPDIR"
Directory in which temporary files are created.
.IP "REPLYTO"
Default Reply-To address.
.IP "VISUAL"
138
Specifies the editor to use when composing messages.
Thomas Roessler's avatar
Thomas Roessler committed
139
.SH FILES
Thomas Roessler's avatar
Thomas Roessler committed
140
.PP
Thomas Roessler's avatar
Thomas Roessler committed
141
.IP "~/.muttrc or ~/.mutt/muttrc"
Thomas Roessler's avatar
Thomas Roessler committed
142
User configuration file.
143
.IP "@sysconfdir@/Muttrc"
Thomas Roessler's avatar
Thomas Roessler committed
144 145 146 147 148
System-wide configuration file.
.IP "/tmp/muttXXXXXX"
Temporary files created by Mutt.
.IP "~/.mailcap"
User definition for handling non-text MIME types.
149
.IP "@sysconfdir@/mailcap"
Cedric Duval's avatar
Cedric Duval committed
150
System definition for handling non-text MIME types.
Thomas Roessler's avatar
Thomas Roessler committed
151 152
.IP "~/.mime.types"
User's personal mapping between MIME types and file extensions.
153
.IP "@sysconfdir@/mime.types"
Thomas Roessler's avatar
Thomas Roessler committed
154
System mapping between MIME types and file extensions.
155
.IP "@bindir@/mutt_dotlock"
Thomas Roessler's avatar
Thomas Roessler committed
156
The privileged dotlocking program.
157
.IP "@docdir@/manual.txt"
Thomas Roessler's avatar
Thomas Roessler committed
158
The Mutt manual.
Thomas Roessler's avatar
Thomas Roessler committed
159
.SH BUGS
Thomas Roessler's avatar
Thomas Roessler committed
160
.PP
161 162 163
None.  Mutts have fleas, not bugs.
.SH FLEAS
.PP
Thomas Roessler's avatar
Thomas Roessler committed
164
Suspend/resume while editing a file with an external editor does not work
Thomas Roessler's avatar
Thomas Roessler committed
165 166
under SunOS 4.x if you use the curses lib in /usr/5lib.  It \fIdoes\fP work
with the S-Lang library, however.
Thomas Roessler's avatar
Thomas Roessler committed
167
.PP
Thomas Roessler's avatar
Thomas Roessler committed
168 169
Resizing the screen while using an external pager causes Mutt to go haywire
on some systems.
Thomas Roessler's avatar
Thomas Roessler committed
170
.PP
Thomas Roessler's avatar
Thomas Roessler committed
171
suspend/resume does not work under Ultrix.
Thomas Roessler's avatar
Thomas Roessler committed
172
.PP
Thomas Roessler's avatar
Thomas Roessler committed
173 174
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.
175
.PP
176 177 178 179
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)
Thomas Roessler's avatar
Thomas Roessler committed
180
program.
181 182 183 184 185
.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
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
Thomas Roessler's avatar
Thomas Roessler committed
186
.SH SEE ALSO
Thomas Roessler's avatar
Thomas Roessler committed
187 188
.PP
.BR curses (3),
Thomas Roessler's avatar
Thomas Roessler committed
189 190 191 192
.BR flea (1),
.BR mailcap (5),
.BR maildir (5),
.BR mbox (5),
193
.BR mutt_dotlock (1),
Thomas Roessler's avatar
Thomas Roessler committed
194
.BR muttrc (5),
Thomas Roessler's avatar
Thomas Roessler committed
195 196
.BR ncurses (3),
.BR sendmail (1),
Thomas Roessler's avatar
Thomas Roessler committed
197
.BR smail (1)
Thomas Roessler's avatar
Thomas Roessler committed
198
.PP
Thomas Roessler's avatar
Thomas Roessler committed
199
Mutt Home Page: http://www.mutt.org/
200
.PP
Thomas Roessler's avatar
Thomas Roessler committed
201 202
The Mutt manual
.PP
203
The GNU General Public License.
Thomas Roessler's avatar
Thomas Roessler committed
204
.SH AUTHOR
205 206
.PP
Michael Elkins, and others.  Use <mutt-dev@mutt.org> to contact
207
the developers.