junk/mutt/files/mutt.1

   1 .\" -*-nroff-*-
   2 .\"
   3 .\"
   4 .\"     Copyright (C) 1996-2021 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 "July 24, 2020" Unix "User Manuals"
  21 .SH NAME
  22 mutt \- The Mutt Mail User Agent
  23 .SH SYNOPSIS
  24 .TP 6
  25 .B mutt
  26 [\fB\-nRyzZ\fR]
  27 [\fB\-e \fIcommand\fR]
  28 [\fB\-F \fIrcfile\fR]
  29 [\fB\-m \fItype\fR]
  30 [\fB\-f \fImailbox\fR]
  31 .TP 6
  32 .B mutt
  33 [\fB\-Enx\fR]
  34 [\fB\-e \fIcommand\fR]
  35 [\fB\-F \fIrcfile\fR]
  36 [\fB\-H \fIdraft\fR]
  37 [\fB\-i \fIinclude\fR]
  38 .br
  39 [\fB\-b \fIbcc-addr\fR]
  40 [\fB\-c \fIcc-addr\fR]
  41 [\fB\-s \fIsubject\fR]
  42 .br
  43 [\fB\-a \fIfile ... \fB\-\-\fR]
  44 \fIto-addr ...
  45 .TP 6
  46 .B mutt
  47 [\fB\-nx\fR]
  48 [\fB\-e \fIcommand\fR]
  49 [\fB\-F \fIrcfile\fR]
  50 [\fB\-b \fIbcc-addr\fR]
  51 [\fB\-c \fIcc-addr\fR]
  52 .br
  53 [\fB\-s \fIsubject\fR]
  54 [\fB\-a \fIfile ... \fB\-\-\fR]
  55 \fIto-addr ... \fR< message
  56 .TP 6
  57 .B mutt
  58 [\fB\-n\fR]
  59 [\fB\-e \fIcommand\fR]
  60 [\fB\-F \fIrcfile\fR]
  61 \fB\-p
  62 .TP 6
  63 .B mutt
  64 [\fB\-n\fR]
  65 [\fB\-e \fIcommand\fR]
  66 [\fB\-F \fIrcfile\fR]
  67 \fB\-A \fIalias
  68 .TP 6
  69 .B mutt
  70 [\fB\-n\fR]
  71 [\fB\-e \fIcommand\fR]
  72 [\fB\-F \fIrcfile\fR]
  73 \fB\-Q \fIvariable
  74 .TP 6
  75 .B mutt
  76 \fB\-v\fR[\fBv\fR]
  77 .TP 6
  78 .B mutt
  79 \fB\-D
  80 .SH DESCRIPTION
  81 .PP
  82 Mutt is a small but very powerful text based program for reading and sending electronic
  83 mail under unix operating systems, including support for color terminals, MIME,
  84 OpenPGP, and a threaded sorting mode.
  85 .PP
  86 .BR Note :
  87 This manual page gives a brief overview of the \fBmutt\fP executable command
  88 line options.
  89 A copy of the full manual is located in \fI/usr/share/doc/mutt\fP, in text, HTML, and/or
  90 PDF format.
  91 Please refer to the manual to learn how to use and configure Mutt.
  92 .SH OPTIONS
  93 .TP
  94 .BI \-A " alias"
  95 Print an expanded version of the given \fIalias\fP and exit.
  96 .TP
  97 .BI \-a " file ... "
  98 Attach a \fIfile\fP using MIME.
  99 Separating \fIfile\fP and \fIto-addr\fP arguments with \*(lq\fB\-\-\fP\*(rq is
 100 mandatory.
 101 For example:
 102 .sp
 103 .nf
 104 .ft C
 105 \&    mutt \-a image.jpg \-\- to-addr
 106 \&    mutt \-a img.jpg *.png \-\- to-addr-1 to-addr-2
 107 .ft R
 108 .fi
 109 .sp
 110 The \fB\-a\fP option must be placed at the end of command line options.
 111 .TP
 112 .BI \-b " bcc-addr"
 113 Specify a blind carbon copy (BCC) address.
 114 .TP
 115 .BI \-c " cc-addr"
 116 Specify a carbon copy (CC) address.
 117 .TP
 118 .BI \-d " level"
 119 If Mutt was compiled with \fB+DEBUG\fP log debugging output to
 120 \fI~/.muttdebug0\fP.
 121 \fILevel\fP can range from 1-5 and effects verbosity.
 122 A value of 2 is recommended.
 123 .TP
 124 .B \-D
 125 Print the value of all configuration options to stdout.
 126 .TP
 127 .B \-E
 128 Edit the \fIdraft\fP file specified by \fB\-H\fP or \fIinclude\fP file
 129 specified by \fB-i\fP during message composition.
 130 .TP
 131 .BI \-e " command"
 132 Specify a configuration \fIcommand\fP to be run after processing of
 133 initialization files.
 134 .TP
 135 .BI \-f " mailbox"
 136 Specify a \fImailbox\fP to load.
 137 .TP
 138 .BI \-F " rcfile"
 139 Use \fIrcfile\fP instead of the user configuration file.
 140 .TP
 141 .B \-h
 142 Display a short option summary and exit.
 143 .TP
 144 .BI \-H " draft"
 145 Specify a \fIdraft\fP file which contains header and body to use to send a
 146 message.
 147 If \fIdraft\fP is \*(lq\fB\-\fP\*(rq, then data is read from stdin.
 148 .TP
 149 .BI \-i " include"
 150 Specify an \fIinclude\fP file to be inserted into the body of a message.
 151 Ignored if \fB\-H\fP is set.
 152 If \fIinclude\fP is \*(lq\fB\-\fP\*(rq, then data is read from stdin.
 153 .TP
 154 .BI \-m " type"
 155 Specify a default mailbox \fItype\fP for newly created folders.
 156 Can be one of the following: mbox, MMDF, MH or Maildir.
 157 See also \fB$mbox_type\fP in the manual.
 158 .TP
 159 .B \-n
 160 Do not read the system-wide Muttrc configuration file.
 161 .TP
 162 .B \-p
 163 Resume a postponed message.
 164 Exit immediately if there are no postponed messages.
 165 .TP
 166 .BI \-Q " variable"
 167 Query a configuration \fIvariable\fP.
 168 The query is performed after all configuration files have been parsed, and any
 169 \fIcommands\fP given on the command line have been executed.
 170 .TP
 171 .B \-R
 172 Open a mailbox in read-only mode.
 173 .TP
 174 .BI \-s " subject"
 175 Specify the \fIsubject\fP of the message.
 176 Must be enclosed in quotes if it contains spaces.
 177 .TP
 178 .B \-v
 179 Display the Mutt version number and compile-time definitions.
 180 .TP
 181 .B \-vv
 182 Display license and copyright information.
 183 .TP
 184 .B \-x
 185 Emulate the
 186 .BR mailx (1)
 187 compose mode.
 188 .TP
 189 .B \-y
 190 Start Mutt with a listing of all mailboxes specified by the \fImailboxes\fP
 191 configuration command.
 192 .TP
 193 .B \-z
 194 Exit immediately with code 1 if \fImailbox\fP specified by \fB\-f\fP does not
 195 contain any messages.
 196 .TP
 197 .B \-Z
 198 Open the first mailbox specified by the \fImailboxes\fP configuration command
 199 which contains new mail.
 200 Exit immediately with code 1 if there is no new mail in any of them.
 201 .TP
 202 .B \-\-
 203 Treat remaining arguments as \fIto-addr\fP even if they start with a dash.
 204 See also \fB\-a\fP above.
 205 \fITo-addr\fP can be a local or network mail address as well as mailto: URL.
 206 .SH ENVIRONMENT
 207 .IP "EDITOR, VISUAL"
 208 Specifies the editor to use when composing messages.
 209 If both EDITOR and VISUAL are set, VISUAL takes precedence.
 210 If neither EDITOR nor VISUAL are set, the default is
 211 .BR vi (1).
 212 .IP "EGDSOCKET, RANDFILE"
 213 Paths used to initialize the random engine for SSL library.
 214 .IP "EMAIL"
 215 The user's e-mail address.
 216 .IP "HOME"
 217 Full path of the user's home directory.
 218 .IP "MAIL"
 219 Full path of the user's spool mailbox.
 220 .IP "MAILDIR"
 221 Full path of the user's spool mailbox if MAIL is unset.
 222 Commonly used when the spool mailbox is a
 223 .BR maildir (5)
 224 folder.
 225 .IP "MAILCAPS"
 226 Path to search for mailcap files.
 227 .IP "MM_NOASK"
 228 If this variable is set, mailcap are always used without prompting first.
 229 .IP "PGPPATH"
 230 Directory in which the user's PGP public keyring can be found.
 231 When used with the original PGP program, mutt and
 232 .BR mutt_pgpring (1)
 233 rely on this being set.
 234 .IP "REPLYTO"
 235 Default Reply-To address.
 236 .IP "TMPDIR"
 237 Directory in which temporary files are created.
 238 If unset, \fI/tmp\fP is used.
 239 See also $tmpdir configuration variable.
 240 .IP "LC_ALL, LC_CTYPE, LANG"
 241 Used to determine charset and locale to use.
 242 .IP TEXTDOMAINDIR
 243 Directory containing translation files.
 244 If set, this path overwrite the Mutt installation directory.
 245 Used for testing translation changes.
 246 .SH FILES
 247 .TP
 248 .I ~/.muttrc
 249 .TQ
 250 .I ~/.mutt/muttrc
 251 .TQ
 252 .I $XDG_CONFIG_HOME/mutt/muttrc
 253 User configuration files.
 254 .TP
 255 .I /etc/Muttrc
 256 System-wide configuration file.
 257 .TP
 258 .I /tmp/muttXXXXXX
 259 Temporary files created by Mutt.
 260 .TP
 261 .I ~/.muttdebug0
 262 File containing debugging output.
 263 Log files are automatically rotated by \fBmutt\fP changing the number at the end.
 264 See \fB\-d\fP option above.
 265 .TP
 266 .I ~/.mailcap
 267 User definition for handling non-text MIME types.
 268 .TP
 269 .I /etc/mailcap
 270 System definition for handling non-text MIME types.
 271 .TP
 272 .I ~/.mime.types
 273 User's personal mapping between MIME types and file extensions.
 274 .TP
 275 .I /etc/mime.types
 276 System mapping between MIME types and file extensions.
 277 .TP
 278 .I /usr/bin/mutt_dotlock
 279 The privileged dotlocking program.
 280 .TP
 281 .I "/usr/share/doc/mutt/manual.txt.gz"
 282 The Mutt manual.
 283 .SH BUGS
 284 .PP
 285 None.  Mutts have fleas, not bugs.
 286 .SH FLEAS
 287 .PP
 288 Suspend/resume while editing a file with an external editor does not work
 289 under SunOS 4.x if you use the curses lib in /usr/5lib.  It \fIdoes\fP work
 290 with the S-Lang library, however.
 291 .PP
 292 Resizing the screen while using an external pager causes Mutt to go haywire
 293 on some systems.
 294 .PP
 295 Suspend/resume does not work under Ultrix.
 296 .PP
 297 The help line for the index menu is not updated if you change the bindings
 298 for one of the functions listed while Mutt is running.
 299 .PP
 300 For a more up-to-date list of bugs, errm, fleas, please visit the
 301 mutt project's bug tracking system under https://gitlab.com/muttmua/mutt/issues.
 302 .SH NO WARRANTIES
 303 This program is distributed in the hope that it will be useful,
 304 but WITHOUT ANY WARRANTY; without even the implied warranty of
 305 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 306 GNU General Public License for more details.
 307 .SH SEE ALSO
 308 .PP
 309 .BR mutt_dotlock (1),
 310 .BR mutt_pgpring (1),
 311 .BR pgpewrap (1),
 312 .BR sendmail (1),
 313 .BR smail (1),
 314 .BR smime_keys (1),
 315 .BR curses (3),
 316 .BR ncurses (3),
 317 .BR mailcap (5),
 318 .BR maildir (5),
 319 .BR mbox (5),
 320 .BR mmdf (5),
 321 .BR muttrc (5)
 322 .PP
 323 Mutt Home Page: http://www.mutt.org/
 324 .PP
 325 The Mutt manual
 326 .SH AUTHOR
 327 .PP
 328 Michael Elkins, and others.
 329 Use <mutt-dev@mutt.org> to contact the developers.