doc/mutt.man

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