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