Debian Codegraph @

upstream/debian-unstable/man1/mutt.1

raw
1 .\" -*-nroff-*-
2 .\"
3 .\"
4 .\" Copyright (C) 1996-2023 Michael R. Elkins <[email protected]>
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 .in +4m
104 .nf
105 mutt \-a image.jpg \-\- to-addr
106 mutt \-a img.jpg *.png \-\- to-addr-1 to-addr-2
107 .fi
108 .in
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 -5 to 5 and affects verbosity. A value of
122 zero disables debugging. A value less than zero disables automatic log
123 file rotation; the log level is then its absolute value. A value of 2
124 (-2) is recommended for most diagnosis.
125 .TP
126 .B \-D
127 Print the value of all configuration options to stdout.
128 .TP
129 .B \-E
130 Edit the \fIdraft\fP file specified by \fB\-H\fP or \fIinclude\fP file
131 specified by \fB-i\fP during message composition.
132 .TP
133 .BI \-e " command"
134 Specify a configuration \fIcommand\fP to be run after processing of
135 initialization files.
136 .TP
137 .BI \-f " mailbox"
138 Specify a \fImailbox\fP to load.
139 .TP
140 .BI \-F " rcfile"
141 Use \fIrcfile\fP instead of the user configuration file.
142 .TP
143 .B \-h
144 Display a short option summary and exit.
145 .TP
146 .BI \-H " draft"
147 Specify a \fIdraft\fP file which contains header and body to use to
148 send a message. If \fIdraft\fP is \*(lq\fB\-\fP\*(rq, then data is
149 read from stdin. The draft file is expected to contain just an RFC822
150 email \(em headers and a body. Although it is not an mbox file, if an
151 mbox "\fBFrom\~\fP" line is present, it will be silently discarded.
152 Draft files are processed the same in interactive and batch mode; they
153 are not passed through untouched. For example, encrypted draft files
154 will be decrypted.
155 .TP
156 .BI \-i " include"
157 Specify an \fIinclude\fP file to be inserted into the body of a message.
158 Ignored if \fB\-H\fP is set.
159 If \fIinclude\fP is \*(lq\fB\-\fP\*(rq, then data is read from stdin.
160 .TP
161 .BI \-m " type"
162 Specify a default mailbox \fItype\fP for newly created folders.
163 Can be one of the following: mbox, MMDF, MH or Maildir.
164 See also \fB$mbox_type\fP in the manual.
165 .TP
166 .B \-n
167 Do not read the system-wide Muttrc configuration file.
168 .TP
169 .B \-p
170 Resume a postponed message.
171 Exit immediately if there are no postponed messages.
172 .TP
173 .BI \-Q " variable"
174 Query a configuration \fIvariable\fP.
175 The query is performed after all configuration files have been parsed, and any
176 \fIcommands\fP given on the command line have been executed.
177 .TP
178 .B \-R
179 Open a mailbox in read-only mode.
180 .TP
181 .BI \-s " subject"
182 Specify the \fIsubject\fP of the message.
183 Must be enclosed in quotes if it contains spaces.
184 .TP
185 .B \-v
186 Display the Mutt version number and compile-time definitions.
187 .TP
188 .B \-vv
189 Display license and copyright information.
190 .TP
191 .B \-x
192 Emulate the
193 .BR mailx (1)
194 compose mode.
195 .TP
196 .B \-y
197 Start Mutt with a listing of all mailboxes specified by the \fImailboxes\fP
198 configuration command.
199 .TP
200 .B \-z
201 Exit immediately with code 1 if \fImailbox\fP specified by \fB\-f\fP does not
202 contain any messages.
203 .TP
204 .B \-Z
205 Open the first mailbox specified by the \fImailboxes\fP configuration command
206 which contains new mail.
207 Exit immediately with code 1 if there is no new mail in any of them.
208 .TP
209 .B \-\-
210 Treat remaining arguments as \fIto-addr\fP even if they start with a dash.
211 See also \fB\-a\fP above.
212 \fITo-addr\fP can be a local or network mail address as well as mailto: URL.
213 .SH ENVIRONMENT
214 .IP "EDITOR, VISUAL"
215 Specifies the editor to use when composing messages.
216 If both EDITOR and VISUAL are set, VISUAL takes precedence.
217 If neither EDITOR nor VISUAL are set, the default is
218 .BR vi (1).
219 .IP "EGDSOCKET, RANDFILE"
220 Paths used to initialize the random engine for SSL library.
221 .IP "EMAIL"
222 The user's e-mail address.
223 .IP "HOME"
224 Full path of the user's home directory.
225 .IP "MAIL"
226 Full path of the user's spool mailbox.
227 .IP "MAILDIR"
228 Full path of the user's spool mailbox if MAIL is unset.
229 Commonly used when the spool mailbox is a
230 .BR maildir (5)
231 folder.
232 .IP "MAILCAPS"
233 Path to search for mailcap files.
234 .IP "MM_NOASK"
235 If this variable is set, mailcap are always used without prompting first.
236 .IP "PGPPATH"
237 Directory in which the user's PGP public keyring can be found.
238 When used with the original PGP program, mutt and
239 .BR mutt_pgpring (1)
240 rely on this being set.
241 .IP "REPLYTO"
242 Default Reply-To address.
243 .IP "TMPDIR"
244 Directory in which temporary files are created.
245 If unset, \fI/tmp\fP is used.
246 See also $tmpdir configuration variable.
247 .IP "LC_ALL, LC_CTYPE, LANG"
248 Used to determine charset and locale to use.
249 .IP TEXTDOMAINDIR
250 Directory containing translation files.
251 If set, this path overwrite the Mutt installation directory.
252 Used for testing translation changes.
253 .SH FILES
254 .TP
255 .I ~/.muttrc
256 .TQ
257 .I ~/.mutt/muttrc
258 .TQ
259 .I $XDG_CONFIG_HOME/mutt/muttrc
260 User configuration files.
261 .TP
262 .I /etc/Muttrc or /usr/share/mutt/Muttrc
263 System-wide configuration file.
264 .TP
265 .I /tmp/muttXXXXXX
266 Temporary files created by Mutt.
267 .TP
268 .I ~/.muttdebug0
269 File containing debugging output.
270 Log files are automatically rotated by \fBmutt\fP changing the number at the end.
271 See \fB\-d\fP option above.
272 .TP
273 .I ~/.mailcap
274 User definition for handling non-text MIME types.
275 .TP
276 .I /etc/mailcap
277 System definition for handling non-text MIME types.
278 .TP
279 .I ~/.mime.types
280 User's personal mapping between MIME types and file extensions.
281 .TP
282 .I /etc/mime.types
283 System mapping between MIME types and file extensions.
284 .TP
285 .I /usr/bin/mutt_dotlock
286 The privileged dotlocking program.
287 .TP
288 .I "/usr/share/doc/mutt/manual.txt.gz"
289 The Mutt manual.
290 .SH BUGS
291 .PP
292 None. Mutts have fleas, not bugs.
293 .SH FLEAS
294 .PP
295 Suspend/resume while editing a file with an external editor does not work
296 under SunOS 4.x if you use the curses lib in /usr/5lib. It \fIdoes\fP work
297 with the S-Lang library, however.
298 .PP
299 Resizing the screen while using an external pager causes Mutt to go haywire
300 on some systems.
301 .PP
302 Suspend/resume does not work under Ultrix.
303 .PP
304 The help line for the index menu is not updated if you change the bindings
305 for one of the functions listed while Mutt is running.
306 .PP
307 For a more up-to-date list of bugs, errm, fleas, please visit the
308 mutt project's bug tracking system under https://gitlab.com/muttmua/mutt/issues.
309 .SH NO WARRANTIES
310 This program is distributed in the hope that it will be useful,
311 but WITHOUT ANY WARRANTY; without even the implied warranty of
312 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
313 GNU General Public License for more details.
314 .SH SEE ALSO
315 .PP
316 .BR mutt_dotlock (1),
317 .BR mutt_pgpring (1),
318 .BR pgpewrap (1),
319 .BR sendmail (1),
320 .BR smail (1),
321 .BR smime_keys (1),
322 .BR curses (3),
323 .BR ncurses (3),
324 .BR mailcap (5),
325 .BR maildir (5),
326 .BR mbox (5),
327 .BR mmdf (5),
328 .BR muttrc (5)
329 .PP
330 Mutt Home Page: http://www.mutt.org/
331 .PP
332 The Mutt manual
333 .PP
334 RFC5322 \(em Internet Message Format: https://tools.ietf.org/rfcmarkup/5322
335 (obsoletes RFC2822 and RFC822)
336 .SH AUTHOR
337 .PP
338 Michael Elkins, and others.
339 Use <[email protected]> to contact the developers.