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