obj-i486-linux-gnu-patched/doc/mutt.1

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