2 * Copyright (C) 1996-2002,2007 Michael R. Elkins <me@mutt.org>
3 * Copyright (C) 2004 g10 Code GmbH
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 # include "doc/makedoc-defs.h"
31 #define DT_BOOL 1 /* boolean option */
32 #define DT_NUM 2 /* a number */
33 #define DT_STR 3 /* a string */
34 #define DT_PATH 4 /* a pathname */
35 #define DT_QUAD 5 /* quad-option (yes/no/ask-yes/ask-no) */
36 #define DT_SORT 6 /* sorting methods */
37 #define DT_RX 7 /* regular expressions */
38 #define DT_MAGIC 8 /* mailbox type */
39 #define DT_SYN 9 /* synonym for another variable */
40 #define DT_ADDR 10 /* e-mail address */
42 #define DTYPE(x) ((x) & DT_MASK)
45 #define DT_SUBTYPE_MASK 0xf0
46 #define DT_SORT_ALIAS 0x10
47 #define DT_SORT_BROWSER 0x20
48 #define DT_SORT_KEYS 0x40
49 #define DT_SORT_AUX 0x80
51 /* flags to parse_set() */
52 #define M_SET_INV (1<<0) /* default is to invert all vars */
53 #define M_SET_UNSET (1<<1) /* default is to unset all vars */
54 #define M_SET_RESET (1<<2) /* default is to reset all vars to default */
56 /* forced redraw/resort types */
58 #define R_INDEX (1<<0)
59 #define R_PAGER (1<<1)
60 #define R_RESORT (1<<2) /* resort the mailbox */
61 #define R_RESORT_SUB (1<<3) /* resort subthreads */
62 #define R_RESORT_INIT (1<<4) /* resort from scratch */
63 #define R_TREE (1<<5) /* redraw the thread tree */
64 #define R_BOTH (R_INDEX | R_PAGER)
65 #define R_RESORT_BOTH (R_RESORT | R_RESORT_SUB)
73 unsigned long init; /* initial value */
76 #define UL (unsigned long)
81 #define ISPELL "ispell"
84 struct option_t MuttVars[] = {
86 { "abort_nosubject", DT_QUAD, R_NONE, OPT_SUBJECT, M_ASKYES },
89 ** If set to \fIyes\fP, when composing messages and no subject is given
90 ** at the subject prompt, composition will be aborted. If set to
91 ** \fIno\fP, composing messages with no subject given at the subject
92 ** prompt will never be aborted.
94 { "abort_unmodified", DT_QUAD, R_NONE, OPT_ABORT, M_YES },
97 ** If set to \fIyes\fP, composition will automatically abort after
98 ** editing the message body if no changes are made to the file (this
99 ** check only happens after the \fIfirst\fP edit of the file). When set
100 ** to \fIno\fP, composition will never be aborted.
102 { "alias_file", DT_PATH, R_NONE, UL &AliasFile, UL "~/.muttrc" },
105 ** The default file in which to save aliases created by the
106 ** \fC$<create-alias>\fP function. Entries added to this file are
107 ** encoded in the character set specified by $$config_charset if it
108 ** is \fIset\fP or the current character set otherwise.
110 ** \fBNote:\fP Mutt will not automatically source this file; you must
111 ** explicitly use the ``$source'' command for it to be executed in case
112 ** this option points to a dedicated alias file.
114 ** The default for this option is the currently used muttrc file, or
115 ** ``~/.muttrc'' if no user muttrc was found.
117 { "alias_format", DT_STR, R_NONE, UL &AliasFmt, UL "%4n %2f %t %-10a %r" },
120 ** Specifies the format of the data displayed for the ``$alias'' menu. The
121 ** following \fCprintf(3)\fP-style sequences are available:
123 ** .dt %a .dd alias name
124 ** .dt %f .dd flags - currently, a ``d'' for an alias marked for deletion
125 ** .dt %n .dd index number
126 ** .dt %r .dd address which alias expands to
127 ** .dt %t .dd character which indicates if the alias is tagged for inclusion
130 { "allow_8bit", DT_BOOL, R_NONE, OPTALLOW8BIT, 1 },
133 ** Controls whether 8-bit data is converted to 7-bit using either Quoted-
134 ** Printable or Base64 encoding when sending mail.
136 { "allow_ansi", DT_BOOL, R_NONE, OPTALLOWANSI, 0 },
139 ** Controls whether ANSI color codes in messages (and color tags in
140 ** rich text messages) are to be interpreted.
141 ** Messages containing these codes are rare, but if this option is \fIset\fP,
142 ** their text will be colored accordingly. Note that this may override
143 ** your color choices, and even present a security problem, since a
144 ** message could include a line like
146 ** [-- PGP output follows ...
149 ** and give it the same color as your attachment color (see also
150 ** $$crypt_timestamp).
152 { "arrow_cursor", DT_BOOL, R_BOTH, OPTARROWCURSOR, 0 },
155 ** When \fIset\fP, an arrow (``->'') will be used to indicate the current entry
156 ** in menus instead of highlighting the whole line. On slow network or modem
157 ** links this will make response faster because there is less that has to
158 ** be redrawn on the screen when moving to the next or previous entries
161 { "ascii_chars", DT_BOOL, R_BOTH, OPTASCIICHARS, 0 },
164 ** If \fIset\fP, Mutt will use plain ASCII characters when displaying thread
165 ** and attachment trees, instead of the default \fIACS\fP characters.
167 { "askbcc", DT_BOOL, R_NONE, OPTASKBCC, 0 },
170 ** If \fIset\fP, Mutt will prompt you for blind-carbon-copy (Bcc) recipients
171 ** before editing an outgoing message.
173 { "askcc", DT_BOOL, R_NONE, OPTASKCC, 0 },
176 ** If \fIset\fP, Mutt will prompt you for carbon-copy (Cc) recipients before
177 ** editing the body of an outgoing message.
179 { "assumed_charset", DT_STR, R_NONE, UL &AssumedCharset, UL 0},
182 ** This variable is a colon-separated list of character encoding
183 ** schemes for messages without character encoding indication.
184 ** Header field values and message body content without character encoding
185 ** indication would be assumed that they are written in one of this list.
186 ** By default, all the header fields and message body without any charset
187 ** indication are assumed to be in ``us-ascii''.
189 ** For example, Japanese users might prefer this:
191 ** set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
194 ** However, only the first content is valid for the message body.
196 { "attach_charset", DT_STR, R_NONE, UL &AttachCharset, UL 0 },
199 ** This variable is a colon-separated list of character encoding
200 ** schemes for text file attachments. Mutt uses this setting to guess
201 ** which encoding files being attached are encoded in to convert them to
202 ** a proper character set given in $$send_charset.
204 ** If \fIunset\fP, the value of $$charset will be used instead.
205 ** For example, the following configuration would work for Japanese
208 ** set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
211 ** Note: for Japanese users, ``iso-2022-*'' must be put at the head
212 ** of the value as shown above if included.
214 { "attach_format", DT_STR, R_NONE, UL &AttachFormat, UL "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] " },
217 ** This variable describes the format of the ``attachment'' menu. The
218 ** following \fCprintf(3)\fP-style sequences are understood:
220 ** .dt %C .dd charset
221 ** .dt %c .dd requires charset conversion (``n'' or ``c'')
222 ** .dt %D .dd deleted flag
223 ** .dt %d .dd description
224 ** .dt %e .dd MIME content-transfer-encoding
225 ** .dt %f .dd filename
226 ** .dt %I .dd disposition (``I'' for inline, ``A'' for attachment)
227 ** .dt %m .dd major MIME type
228 ** .dt %M .dd MIME subtype
229 ** .dt %n .dd attachment number
230 ** .dt %Q .dd ``Q'', if MIME part qualifies for attachment counting
232 ** .dt %t .dd tagged flag
233 ** .dt %T .dd graphic tree characters
234 ** .dt %u .dd unlink (=to delete) flag
235 ** .dt %X .dd number of qualifying MIME parts in this part and its children
236 ** (please see the ``$attachments'' section for possible speed effects)
237 ** .dt %>X .dd right justify the rest of the string and pad with character ``X''
238 ** .dt %|X .dd pad to the end of the line with character ``X''
239 ** .dt %*X .dd soft-fill with character ``X'' as pad
242 ** For an explanation of ``soft-fill'', see the $$index_format documentation.
244 { "attach_sep", DT_STR, R_NONE, UL &AttachSep, UL "\n" },
247 ** The separator to add between attachments when operating (saving,
248 ** printing, piping, etc) on a list of tagged attachments.
250 { "attach_split", DT_BOOL, R_NONE, OPTATTACHSPLIT, 1 },
253 ** If this variable is \fIunset\fP, when operating (saving, printing, piping,
254 ** etc) on a list of tagged attachments, Mutt will concatenate the
255 ** attachments and will operate on them as a single attachment. The
256 ** $$attach_sep separator is added after each attachment. When \fIset\fP,
257 ** Mutt will operate on the attachments one by one.
259 { "attribution", DT_STR, R_NONE, UL &Attribution, UL "On %d, %n wrote:" },
262 ** This is the string that will precede a message which has been included
263 ** in a reply. For a full listing of defined \fCprintf(3)\fP-like sequences see
264 ** the section on $$index_format.
266 { "auto_tag", DT_BOOL, R_NONE, OPTAUTOTAG, 0 },
269 ** When \fIset\fP, functions in the \fIindex\fP menu which affect a message
270 ** will be applied to all tagged messages (if there are any). When
271 ** unset, you must first use the \fC<tag-prefix>\fP function (bound to ``;''
272 ** by default) to make the next function apply to all tagged messages.
274 { "autoedit", DT_BOOL, R_NONE, OPTAUTOEDIT, 0 },
277 ** When \fIset\fP along with $$edit_headers, Mutt will skip the initial
278 ** send-menu (prompting for subject and recipients) and allow you to
279 ** immediately begin editing the body of your
280 ** message. The send-menu may still be accessed once you have finished
281 ** editing the body of your message.
284 ** \fBNote:\fP when this option is \fIset\fP, you cannot use send-hooks that depend
285 ** on the recipients when composing a new (non-reply) message, as the initial
286 ** list of recipients is empty.
288 ** Also see $$fast_reply.
290 { "beep", DT_BOOL, R_NONE, OPTBEEP, 1 },
293 ** When this variable is \fIset\fP, mutt will beep when an error occurs.
295 { "beep_new", DT_BOOL, R_NONE, OPTBEEPNEW, 0 },
298 ** When this variable is \fIset\fP, mutt will beep whenever it prints a message
299 ** notifying you of new mail. This is independent of the setting of the
302 { "bounce", DT_QUAD, R_NONE, OPT_BOUNCE, M_ASKYES },
305 ** Controls whether you will be asked to confirm bouncing messages.
306 ** If set to \fIyes\fP you don't get asked if you want to bounce a
307 ** message. Setting this variable to \fIno\fP is not generally useful,
308 ** and thus not recommended, because you are unable to bounce messages.
310 { "bounce_delivered", DT_BOOL, R_NONE, OPTBOUNCEDELIVERED, 1 },
313 ** When this variable is \fIset\fP, mutt will include Delivered-To headers when
314 ** bouncing messages. Postfix users may wish to \fIunset\fP this variable.
316 { "braille_friendly", DT_BOOL, R_NONE, OPTBRAILLEFRIENDLY, 0 },
319 ** When this variable is \fIset\fP, mutt will place the cursor at the beginning
320 ** of the current line in menus, even when the $$arrow_cursor variable
321 ** is \fIunset\fP, making it easier for blind persons using Braille displays to
322 ** follow these menus. The option is \fIunset\fP by default because many
323 ** visual terminals don't permit making the cursor invisible.
326 { "certificate_file", DT_PATH, R_NONE, UL &SslCertFile, UL "~/.mutt_certificates" },
329 ** This variable specifies the file where the certificates you trust
330 ** are saved. When an unknown certificate is encountered, you are asked
331 ** if you accept it or not. If you accept it, the certificate can also
332 ** be saved in this file and further connections are automatically
335 ** You can also manually add CA certificates in this file. Any server
336 ** certificate that is signed with one of these CA certificates is
337 ** also automatically accepted.
341 ** set certificate_file=~/.mutt/certificates
346 { "charset", DT_STR, R_NONE, UL &Charset, UL 0 },
349 ** Character set your terminal uses to display and enter textual data.
350 ** It is also the fallback for $$send_charset.
352 ** Upon startup Mutt tries to derive this value from environment variables
353 ** such as \fC$$$LC_CTYPE\fP or \fC$$$LANG\fP.
355 ** \fBNote:\fP It should only be set in case Mutt isn't abled to determine the
356 ** character set used correctly.
358 { "check_mbox_size", DT_BOOL, R_NONE, OPTCHECKMBOXSIZE, 0 },
361 ** When this variable is \fIset\fP, mutt will use file size attribute instead of
362 ** access time when checking for new mail in mbox and mmdf folders.
364 ** This variable is \fIunset\fP by default and should only be enabled when
365 ** new mail detection for these folder types is unreliable or doesn't work.
367 ** Note that enabling this variable should happen before any ``$mailboxes''
368 ** directives occur in configuration files regarding mbox or mmdf folders
369 ** because mutt needs to determine the initial new mail status of such a
370 ** mailbox by performing a fast mailbox scan when it is defined.
371 ** Afterwards the new mail status is tracked by file size changes.
373 { "check_new", DT_BOOL, R_NONE, OPTCHECKNEW, 1 },
376 ** \fBNote:\fP this option only affects \fImaildir\fP and \fIMH\fP style
379 ** When \fIset\fP, Mutt will check for new mail delivered while the
380 ** mailbox is open. Especially with MH mailboxes, this operation can
381 ** take quite some time since it involves scanning the directory and
382 ** checking each file to see if it has already been looked at. If
383 ** this variable is \fIunset\fP, no check for new mail is performed
384 ** while the mailbox is open.
386 { "collapse_unread", DT_BOOL, R_NONE, OPTCOLLAPSEUNREAD, 1 },
389 ** When \fIunset\fP, Mutt will not collapse a thread if it contains any
392 { "compose_format", DT_STR, R_BOTH, UL &ComposeFormat, UL "-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-" },
395 ** Controls the format of the status line displayed in the ``compose''
396 ** menu. This string is similar to $$status_format, but has its own
397 ** set of \fCprintf(3)\fP-like sequences:
399 ** .dt %a .dd total number of attachments
400 ** .dt %h .dd local hostname
401 ** .dt %l .dd approximate size (in bytes) of the current message
402 ** .dt %v .dd Mutt version string
405 ** See the text describing the $$status_format option for more
406 ** information on how to set $$compose_format.
408 { "config_charset", DT_STR, R_NONE, UL &ConfigCharset, UL 0 },
411 ** When defined, Mutt will recode commands in rc files from this
412 ** encoding to the current character set as specified by $$charset
413 ** and aliases written to $$alias_file from the current character set.
415 ** Please note that if setting $$charset it must be done before
416 ** setting $$config_charset.
418 ** Recoding should be avoided as it may render unconvertable
419 ** characters as question marks which can lead to undesired
420 ** side effects (for example in regular expressions).
422 { "confirmappend", DT_BOOL, R_NONE, OPTCONFIRMAPPEND, 1 },
425 ** When \fIset\fP, Mutt will prompt for confirmation when appending messages to
426 ** an existing mailbox.
428 { "confirmcreate", DT_BOOL, R_NONE, OPTCONFIRMCREATE, 1 },
431 ** When \fIset\fP, Mutt will prompt for confirmation when saving messages to a
432 ** mailbox which does not yet exist before creating it.
434 { "connect_timeout", DT_NUM, R_NONE, UL &ConnectTimeout, 30 },
437 ** Causes Mutt to timeout a network connection (for IMAP, POP or SMTP) after this
438 ** many seconds if the connection is not able to be established. A negative
439 ** value causes Mutt to wait indefinitely for the connection attempt to succeed.
441 { "content_type", DT_STR, R_NONE, UL &ContentType, UL "text/plain" },
444 ** Sets the default Content-Type for the body of newly composed messages.
446 { "copy", DT_QUAD, R_NONE, OPT_COPY, M_YES },
449 ** This variable controls whether or not copies of your outgoing messages
450 ** will be saved for later references. Also see $$record,
451 ** $$save_name, $$force_name and ``$fcc-hook''.
453 { "pgp_autoencrypt", DT_SYN, R_NONE, UL "crypt_autoencrypt", 0 },
454 { "crypt_autoencrypt", DT_BOOL, R_NONE, OPTCRYPTAUTOENCRYPT, 0 },
457 ** Setting this variable will cause Mutt to always attempt to PGP
458 ** encrypt outgoing messages. This is probably only useful in
459 ** connection to the ``$send-hook'' command. It can be overridden
460 ** by use of the pgp menu, when encryption is not required or
461 ** signing is requested as well. If $$smime_is_default is \fIset\fP,
462 ** then OpenSSL is used instead to create S/MIME messages and
463 ** settings can be overridden by use of the smime menu instead.
466 { "crypt_autopgp", DT_BOOL, R_NONE, OPTCRYPTAUTOPGP, 1 },
469 ** This variable controls whether or not mutt may automatically enable
470 ** PGP encryption/signing for messages. See also $$crypt_autoencrypt,
471 ** $$crypt_replyencrypt,
472 ** $$crypt_autosign, $$crypt_replysign and $$smime_is_default.
474 { "pgp_autosign", DT_SYN, R_NONE, UL "crypt_autosign", 0 },
475 { "crypt_autosign", DT_BOOL, R_NONE, OPTCRYPTAUTOSIGN, 0 },
478 ** Setting this variable will cause Mutt to always attempt to
479 ** cryptographically sign outgoing messages. This can be overridden
480 ** by use of the pgp menu, when signing is not required or
481 ** encryption is requested as well. If $$smime_is_default is \fIset\fP,
482 ** then OpenSSL is used instead to create S/MIME messages and settings can
483 ** be overridden by use of the smime menu instead of the pgp menu.
486 { "crypt_autosmime", DT_BOOL, R_NONE, OPTCRYPTAUTOSMIME, 1 },
489 ** This variable controls whether or not mutt may automatically enable
490 ** S/MIME encryption/signing for messages. See also $$crypt_autoencrypt,
491 ** $$crypt_replyencrypt,
492 ** $$crypt_autosign, $$crypt_replysign and $$smime_is_default.
494 { "pgp_replyencrypt", DT_SYN, R_NONE, UL "crypt_replyencrypt", 1 },
495 { "crypt_replyencrypt", DT_BOOL, R_NONE, OPTCRYPTREPLYENCRYPT, 1 },
498 ** If \fIset\fP, automatically PGP or OpenSSL encrypt replies to messages which are
502 { "pgp_replysign", DT_SYN, R_NONE, UL "crypt_replysign", 0 },
503 { "crypt_replysign", DT_BOOL, R_NONE, OPTCRYPTREPLYSIGN, 0 },
506 ** If \fIset\fP, automatically PGP or OpenSSL sign replies to messages which are
509 ** \fBNote:\fP this does not work on messages that are encrypted
513 { "pgp_replysignencrypted", DT_SYN, R_NONE, UL "crypt_replysignencrypted", 0},
514 { "crypt_replysignencrypted", DT_BOOL, R_NONE, OPTCRYPTREPLYSIGNENCRYPTED, 0 },
517 ** If \fIset\fP, automatically PGP or OpenSSL sign replies to messages
518 ** which are encrypted. This makes sense in combination with
519 ** $$crypt_replyencrypt, because it allows you to sign all
520 ** messages which are automatically encrypted. This works around
521 ** the problem noted in $$crypt_replysign, that mutt is not able
522 ** to find out whether an encrypted message is also signed.
525 { "crypt_timestamp", DT_BOOL, R_NONE, OPTCRYPTTIMESTAMP, 1 },
528 ** If \fIset\fP, mutt will include a time stamp in the lines surrounding
529 ** PGP or S/MIME output, so spoofing such lines is more difficult.
530 ** If you are using colors to mark these lines, and rely on these,
531 ** you may \fIunset\fP this setting.
534 { "crypt_use_gpgme", DT_BOOL, R_NONE, OPTCRYPTUSEGPGME, 0 },
537 ** This variable controls the use of the GPGME-enabled crypto backends.
538 ** If it is \fIset\fP and Mutt was built with gpgme support, the gpgme code for
539 ** S/MIME and PGP will be used instead of the classic code. Note that
540 ** you need to set this option in .muttrc; it won't have any effect when
541 ** used interactively.
543 { "crypt_use_pka", DT_BOOL, R_NONE, OPTCRYPTUSEPKA, 0 },
546 ** Controls whether mutt uses PKA
547 ** (see http://www.g10code.de/docs/pka-intro.de.pdf) during signature
548 ** verification (only supported by the GPGME backend).
550 { "pgp_verify_sig", DT_SYN, R_NONE, UL "crypt_verify_sig", 0},
551 { "crypt_verify_sig", DT_QUAD, R_NONE, OPT_VERIFYSIG, M_YES },
554 ** If \fI``yes''\fP, always attempt to verify PGP or S/MIME signatures.
555 ** If \fI``ask-*''\fP, ask whether or not to verify the signature.
556 ** If \Fi``no''\fP, never attempt to verify cryptographic signatures.
559 { "date_format", DT_STR, R_BOTH, UL &DateFmt, UL "!%a, %b %d, %Y at %I:%M:%S%p %Z" },
562 ** This variable controls the format of the date printed by the ``%d''
563 ** sequence in $$index_format. This is passed to the \fCstrftime(3)\fP
564 ** function to process the date, see the man page for the proper syntax.
566 ** Unless the first character in the string is a bang (``!''), the month
567 ** and week day names are expanded according to the locale specified in
568 ** the variable $$locale. If the first character in the string is a
569 ** bang, the bang is discarded, and the month and week day names in the
570 ** rest of the string are expanded in the \fIC\fP locale (that is in US
573 { "default_hook", DT_STR, R_NONE, UL &DefaultHook, UL "~f %s !~P | (~P ~C %s)" },
576 ** This variable controls how ``$message-hook'', ``$reply-hook'', ``$send-hook'',
577 ** ``$send2-hook'', ``$save-hook'', and ``$fcc-hook'' will
578 ** be interpreted if they are specified with only a simple regexp,
579 ** instead of a matching pattern. The hooks are expanded when they are
580 ** declared, so a hook will be interpreted according to the value of this
581 ** variable at the time the hook is declared.
583 ** The default value matches
584 ** if the message is either from a user matching the regular expression
585 ** given, or if it is from you (if the from address matches
586 ** ``$alternates'') and is to or cc'ed to a user matching the given
587 ** regular expression.
589 { "delete", DT_QUAD, R_NONE, OPT_DELETE, M_ASKYES },
592 ** Controls whether or not messages are really deleted when closing or
593 ** synchronizing a mailbox. If set to \fIyes\fP, messages marked for
594 ** deleting will automatically be purged without prompting. If set to
595 ** \fIno\fP, messages marked for deletion will be kept in the mailbox.
597 { "delete_untag", DT_BOOL, R_NONE, OPTDELETEUNTAG, 1 },
600 ** If this option is \fIset\fP, mutt will untag messages when marking them
601 ** for deletion. This applies when you either explicitly delete a message,
602 ** or when you save it to another folder.
604 { "digest_collapse", DT_BOOL, R_NONE, OPTDIGESTCOLLAPSE, 1},
607 ** If this option is \fIset\fP, mutt's received-attachments menu will not show the subparts of
608 ** individual messages in a multipart/digest. To see these subparts, press ``v'' on that menu.
610 { "display_filter", DT_PATH, R_PAGER, UL &DisplayFilter, UL "" },
613 ** When set, specifies a command used to filter messages. When a message
614 ** is viewed it is passed as standard input to $$display_filter, and the
615 ** filtered message is read from the standard output.
617 #if defined(DL_STANDALONE) && defined(USE_DOTLOCK)
618 { "dotlock_program", DT_PATH, R_NONE, UL &MuttDotlock, UL BINDIR "/mutt_dotlock" },
621 ** Contains the path of the \fCmutt_dotlock(8)\fP binary to be used by
625 { "dsn_notify", DT_STR, R_NONE, UL &DsnNotify, UL "" },
628 ** This variable sets the request for when notification is returned. The
629 ** string consists of a comma separated list (no spaces!) of one or more
630 ** of the following: \fInever\fP, to never request notification,
631 ** \fIfailure\fP, to request notification on transmission failure,
632 ** \fIdelay\fP, to be notified of message delays, \fIsuccess\fP, to be
633 ** notified of successful transmission.
637 ** set dsn_notify="failure,delay"
640 ** \fBNote:\fP when using $$sendmail for delivery, you should not enable
641 ** this unless you are either using Sendmail 8.8.x or greater or a MTA
642 ** providing a \fCsendmail(1)\fP-compatible interface supporting the \fC-N\fP option
643 ** for DSN. For SMTP delivery, DSN support is autodetected so that it
644 ** depends on the server whether DSN will be used or not.
646 { "dsn_return", DT_STR, R_NONE, UL &DsnReturn, UL "" },
649 ** This variable controls how much of your message is returned in DSN
650 ** messages. It may be set to either \fIhdrs\fP to return just the
651 ** message header, or \fIfull\fP to return the full message.
655 ** set dsn_return=hdrs
658 ** \fBNote:\fP when using $$sendmail for delivery, you should not enable
659 ** this unless you are either using Sendmail 8.8.x or greater or a MTA
660 ** providing a \fCsendmail(1)\fP-compatible interface supporting the \fC-R\fP option
661 ** for DSN. For SMTP delivery, DSN support is autodetected so that it
662 ** depends on the server whether DSN will be used or not.
664 { "duplicate_threads", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTDUPTHREADS, 1 },
667 ** This variable controls whether mutt, when $$sort is set to \fIthreads\fP, threads
668 ** messages with the same Message-Id together. If it is \fIset\fP, it will indicate
669 ** that it thinks they are duplicates of each other with an equals sign
670 ** in the thread tree.
672 { "edit_headers", DT_BOOL, R_NONE, OPTEDITHDRS, 0 },
675 ** This option allows you to edit the header of your outgoing messages
676 ** along with the body of your message.
678 ** \fBNote\fP that changes made to the References: and Date: headers are
679 ** ignored for interoperability reasons.
681 { "edit_hdrs", DT_SYN, R_NONE, UL "edit_headers", 0 },
684 { "editor", DT_PATH, R_NONE, UL &Editor, 0 },
687 ** This variable specifies which editor is used by mutt.
688 ** It defaults to the value of the \fC$$$VISUAL\fP, or \fC$$$EDITOR\fP, environment
689 ** variable, or to the string ``vi'' if neither of those are set.
691 { "encode_from", DT_BOOL, R_NONE, OPTENCODEFROM, 0 },
694 ** When \fIset\fP, mutt will quoted-printable encode messages when
695 ** they contain the string ``From '' (note the trailing space) in the beginning of a line.
696 ** This is useful to avoid the tampering certain mail delivery and transport
697 ** agents tend to do with messages (in order to prevent tools from
698 ** misinterpreting the line as a mbox message separator).
700 #if defined(USE_SSL_OPENSSL)
701 { "entropy_file", DT_PATH, R_NONE, UL &SslEntropyFile, 0 },
704 ** The file which includes random data that is used to initialize SSL
705 ** library functions.
708 { "envelope_from_address", DT_ADDR, R_NONE, UL &EnvFrom, 0 },
711 ** Manually sets the \fIenvelope\fP sender for outgoing messages.
712 ** This value is ignored if $$use_envelope_from is \fIunset\fP.
714 { "escape", DT_STR, R_NONE, UL &EscChar, UL "~" },
717 ** Escape character to use for functions in the builtin editor.
719 { "fast_reply", DT_BOOL, R_NONE, OPTFASTREPLY, 0 },
722 ** When \fIset\fP, the initial prompt for recipients and subject are skipped
723 ** when replying to messages, and the initial prompt for subject is
724 ** skipped when forwarding messages.
726 ** \fBNote:\fP this variable has no effect when the $$autoedit
727 ** variable is \fIset\fP.
729 { "fcc_attach", DT_QUAD, R_NONE, OPT_FCCATTACH, M_YES },
732 ** This variable controls whether or not attachments on outgoing messages
733 ** are saved along with the main body of your message.
735 { "fcc_clear", DT_BOOL, R_NONE, OPTFCCCLEAR, 0 },
738 ** When this variable is \fIset\fP, FCCs will be stored unencrypted and
739 ** unsigned, even when the actual message is encrypted and/or
743 { "folder", DT_PATH, R_NONE, UL &Maildir, UL "~/Mail" },
746 ** Specifies the default location of your mailboxes. A ``+'' or ``='' at the
747 ** beginning of a pathname will be expanded to the value of this
748 ** variable. Note that if you change this variable (from the default)
749 ** value you need to make sure that the assignment occurs \fIbefore\fP
750 ** you use ``+'' or ``='' for any other variables since expansion takes place
751 ** when handling the ``$mailboxes'' command.
753 { "folder_format", DT_STR, R_INDEX, UL &FolderFormat, UL "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f" },
756 ** This variable allows you to customize the file browser display to your
757 ** personal taste. This string is similar to $$index_format, but has
758 ** its own set of \fCprintf(3)\fP-like sequences:
760 ** .dt %C .dd current file number
761 ** .dt %d .dd date/time folder was last modified
762 ** .dt %f .dd filename (``/'' is appended to directory names,
763 ** ``@'' to symbolic links and ``*'' to executable
765 ** .dt %F .dd file permissions
766 ** .dt %g .dd group name (or numeric gid, if missing)
767 ** .dt %l .dd number of hard links
768 ** .dt %N .dd N if folder has new mail, blank otherwise
769 ** .dt %s .dd size in bytes
770 ** .dt %t .dd ``*'' if the file is tagged, blank otherwise
771 ** .dt %u .dd owner name (or numeric uid, if missing)
772 ** .dt %>X .dd right justify the rest of the string and pad with character ``X''
773 ** .dt %|X .dd pad to the end of the line with character ``X''
774 ** .dt %*X .dd soft-fill with character ``X'' as pad
777 ** For an explanation of ``soft-fill'', see the $$index_format documentation.
779 { "followup_to", DT_BOOL, R_NONE, OPTFOLLOWUPTO, 1 },
782 ** Controls whether or not the ``Mail-Followup-To:'' header field is
783 ** generated when sending mail. When \fIset\fP, Mutt will generate this
784 ** field when you are replying to a known mailing list, specified with
785 ** the ``$subscribe'' or ``$lists'' commands.
787 ** This field has two purposes. First, preventing you from
788 ** receiving duplicate copies of replies to messages which you send
789 ** to mailing lists, and second, ensuring that you do get a reply
790 ** separately for any messages sent to known lists to which you are
793 ** The header will contain only the list's address
794 ** for subscribed lists, and both the list address and your own
795 ** email address for unsubscribed lists. Without this header, a
796 ** group reply to your message sent to a subscribed list will be
797 ** sent to both the list and your address, resulting in two copies
798 ** of the same email for you.
800 { "force_name", DT_BOOL, R_NONE, OPTFORCENAME, 0 },
803 ** This variable is similar to $$save_name, except that Mutt will
804 ** store a copy of your outgoing message by the username of the address
805 ** you are sending to even if that mailbox does not exist.
807 ** Also see the $$record variable.
809 { "forward_decode", DT_BOOL, R_NONE, OPTFORWDECODE, 1 },
812 ** Controls the decoding of complex MIME messages into \fCtext/plain\fP when
813 ** forwarding a message. The message header is also RFC2047 decoded.
814 ** This variable is only used, if $$mime_forward is \fIunset\fP,
815 ** otherwise $$mime_forward_decode is used instead.
817 { "forw_decode", DT_SYN, R_NONE, UL "forward_decode", 0 },
820 { "forward_decrypt", DT_BOOL, R_NONE, OPTFORWDECRYPT, 1 },
823 ** Controls the handling of encrypted messages when forwarding a message.
824 ** When \fIset\fP, the outer layer of encryption is stripped off. This
825 ** variable is only used if $$mime_forward is \fIset\fP and
826 ** $$mime_forward_decode is \fIunset\fP.
829 { "forw_decrypt", DT_SYN, R_NONE, UL "forward_decrypt", 0 },
832 { "forward_edit", DT_QUAD, R_NONE, OPT_FORWEDIT, M_YES },
835 ** This quadoption controls whether or not the user is automatically
836 ** placed in the editor when forwarding messages. For those who always want
837 ** to forward with no modification, use a setting of ``no''.
839 { "forward_format", DT_STR, R_NONE, UL &ForwFmt, UL "[%a: %s]" },
842 ** This variable controls the default subject when forwarding a message.
843 ** It uses the same format sequences as the $$index_format variable.
845 { "forw_format", DT_SYN, R_NONE, UL "forward_format", 0 },
848 { "forward_quote", DT_BOOL, R_NONE, OPTFORWQUOTE, 0 },
851 ** When \fIset\fP, forwarded messages included in the main body of the
852 ** message (when $$mime_forward is \fIunset\fP) will be quoted using
855 { "forw_quote", DT_SYN, R_NONE, UL "forward_quote", 0 },
858 { "from", DT_ADDR, R_NONE, UL &From, UL 0 },
861 ** When \fIset\fP, this variable contains a default from address. It
862 ** can be overridden using ``$my_hdr'' (including from a ``$send-hook'') and
863 ** $$reverse_name. This variable is ignored if $$use_from is \fIunset\fP.
865 ** This setting defaults to the contents of the environment variable \fC$$$EMAIL\fP.
867 { "gecos_mask", DT_RX, R_NONE, UL &GecosMask, UL "^[^,]*" },
870 ** A regular expression used by mutt to parse the GECOS field of a password
871 ** entry when expanding the alias. The default value
872 ** will return the string up to the first ``,'' encountered.
873 ** If the GECOS field contains a string like ``lastname, firstname'' then you
874 ** should set it to ``\fC.*\fP''.
876 ** This can be useful if you see the following behavior: you address an e-mail
877 ** to user ID ``stevef'' whose full name is ``Steve Franklin''. If mutt expands
878 ** ``stevef'' to ``"Franklin" stevef@foo.bar'' then you should set the $$gecos_mask to
879 ** a regular expression that will match the whole name so mutt will expand
880 ** ``Franklin'' to ``Franklin, Steve''.
882 { "hdr_format", DT_SYN, R_NONE, UL "index_format", 0 },
885 { "hdrs", DT_BOOL, R_NONE, OPTHDRS, 1 },
888 ** When \fIunset\fP, the header fields normally added by the ``$my_hdr''
889 ** command are not created. This variable \fImust\fP be unset before
890 ** composing a new message or replying in order to take effect. If \fIset\fP,
891 ** the user defined header fields are added to every new message.
893 { "header", DT_BOOL, R_NONE, OPTHEADER, 0 },
896 ** When \fIset\fP, this variable causes Mutt to include the header
897 ** of the message you are replying to into the edit buffer.
898 ** The $$weed setting applies.
901 { "header_cache", DT_PATH, R_NONE, UL &HeaderCache, 0 },
904 ** This variable points to the header cache database.
905 ** If pointing to a directory Mutt will contain a header cache
906 ** database file per folder, if pointing to a file that file will
907 ** be a single global header cache. By default it is \fIunset\fP so no header
908 ** caching will be used.
910 ** Header caching can greatly improve speed when opening POP, IMAP
911 ** MH or Maildir folders, see ``$caching'' for details.
913 #if defined(HAVE_QDBM) || defined(HAVE_TC)
914 { "header_cache_compress", DT_BOOL, R_NONE, OPTHCACHECOMPRESS, 1 },
917 ** When mutt is compiled with qdbm or tokyocabinet as header cache backend,
918 ** this option determines whether the database will be compressed.
919 ** Compression results in database files roughly being one fifth
920 ** of the usual diskspace, but the uncompression can result in a
921 ** slower opening of cached folder(s) which in general is still
922 ** much faster than opening non header cached folders.
924 #endif /* HAVE_QDBM */
925 #if defined(HAVE_GDBM) || defined(HAVE_DB4)
926 { "header_cache_pagesize", DT_STR, R_NONE, UL &HeaderCachePageSize, UL "16384" },
929 ** When mutt is compiled with either gdbm or bdb4 as the header cache backend,
930 ** this option changes the database page size. Too large or too small
931 ** values can waste space, memory, or CPU time. The default should be more
932 ** or less optimal for most use cases.
934 #endif /* HAVE_GDBM || HAVE_DB4 */
935 #endif /* USE_HCACHE */
936 { "help", DT_BOOL, R_BOTH, OPTHELP, 1 },
939 ** When \fIset\fP, help lines describing the bindings for the major functions
940 ** provided by each menu are displayed on the first line of the screen.
942 ** \fBNote:\fP The binding will not be displayed correctly if the
943 ** function is bound to a sequence rather than a single keystroke. Also,
944 ** the help line may not be updated if a binding is changed while Mutt is
945 ** running. Since this variable is primarily aimed at new users, neither
946 ** of these should present a major problem.
948 { "hidden_host", DT_BOOL, R_NONE, OPTHIDDENHOST, 0 },
951 ** When \fIset\fP, mutt will skip the host name part of $$hostname variable
952 ** when adding the domain part to addresses. This variable does not
953 ** affect the generation of Message-IDs, and it will not lead to the
954 ** cut-off of first-level domains.
956 { "hide_limited", DT_BOOL, R_TREE|R_INDEX, OPTHIDELIMITED, 0 },
959 ** When \fIset\fP, mutt will not show the presence of messages that are hidden
960 ** by limiting, in the thread tree.
962 { "hide_missing", DT_BOOL, R_TREE|R_INDEX, OPTHIDEMISSING, 1 },
965 ** When \fIset\fP, mutt will not show the presence of missing messages in the
968 { "hide_thread_subject", DT_BOOL, R_TREE|R_INDEX, OPTHIDETHREADSUBJECT, 1 },
971 ** When \fIset\fP, mutt will not show the subject of messages in the thread
972 ** tree that have the same subject as their parent or closest previously
973 ** displayed sibling.
975 { "hide_top_limited", DT_BOOL, R_TREE|R_INDEX, OPTHIDETOPLIMITED, 0 },
978 ** When \fIset\fP, mutt will not show the presence of messages that are hidden
979 ** by limiting, at the top of threads in the thread tree. Note that when
980 ** $$hide_limited is \fIset\fP, this option will have no effect.
982 { "hide_top_missing", DT_BOOL, R_TREE|R_INDEX, OPTHIDETOPMISSING, 1 },
985 ** When \fIset\fP, mutt will not show the presence of missing messages at the
986 ** top of threads in the thread tree. Note that when $$hide_missing is
987 ** \fIset\fP, this option will have no effect.
989 { "history", DT_NUM, R_NONE, UL &HistSize, 10 },
992 ** This variable controls the size (in number of strings remembered) of
993 ** the string history buffer per category. The buffer is cleared each time the
996 { "history_file", DT_PATH, R_NONE, UL &HistFile, UL "~/.mutthistory" },
999 ** The file in which Mutt will save its history.
1001 { "honor_disposition", DT_BOOL, R_NONE, OPTHONORDISP, 0 },
1004 ** When \fIset\fP, Mutt will not display attachments with a
1005 ** disposition of ``attachment'' inline even if it could
1006 ** render the part to plain text. These MIME parts can only
1007 ** be viewed from the attachment menu.
1009 ** If \fIunset\fP, Mutt will render all MIME parts it can
1010 ** properly transform to plain text.
1012 { "honor_followup_to", DT_QUAD, R_NONE, OPT_MFUPTO, M_YES },
1015 ** This variable controls whether or not a Mail-Followup-To header is
1016 ** honored when group-replying to a message.
1018 { "hostname", DT_STR, R_NONE, UL &Fqdn, 0 },
1021 ** Specifies the fully-qualified hostname of the system mutt is running on
1022 ** containing the host's name and the DNS domain it belongs to. It is used
1023 ** as the domain part (after ``@'') for local email addresses as well as
1024 ** Message-Id headers.
1026 ** Its value is determined at startup as follows: If the node's name
1027 ** as returned by the \fCuname(3)\fP function contains the hostname and the
1028 ** domain, these are used to construct $$hostname. If there is no
1029 ** domain part returned, Mutt will look for a ``domain'' or ``search''
1030 ** line in \fC/etc/resolv.conf\fP to determine the domain. Optionally, Mutt
1031 ** can be compiled with a fixed domain name in which case a detected
1034 ** Also see $$use_domain and $$hidden_host.
1036 { "ignore_linear_white_space", DT_BOOL, R_NONE, OPTIGNORELWS, 0 },
1039 ** This option replaces linear-white-space between encoded-word
1040 ** and text to a single space to prevent the display of MIME-encoded
1041 ** ``Subject:'' field from being divided into multiple lines.
1043 { "ignore_list_reply_to", DT_BOOL, R_NONE, OPTIGNORELISTREPLYTO, 0 },
1046 ** Affects the behaviour of the \fC<reply>\fP function when replying to
1047 ** messages from mailing lists (as defined by the ``$subscribe'' or
1048 ** ``$lists'' commands). When \fIset\fP, if the ``Reply-To:'' field is
1049 ** set to the same value as the ``To:'' field, Mutt assumes that the
1050 ** ``Reply-To:'' field was set by the mailing list to automate responses
1051 ** to the list, and will ignore this field. To direct a response to the
1052 ** mailing list when this option is \fIset\fP, use the \fC$<list-reply>\fP
1053 ** function; \fC<group-reply>\fP will reply to both the sender and the
1057 { "imap_authenticators", DT_STR, R_NONE, UL &ImapAuthenticators, UL 0 },
1060 ** This is a colon-delimited list of authentication methods mutt may
1061 ** attempt to use to log in to an IMAP server, in the order mutt should
1062 ** try them. Authentication methods are either ``login'' or the right
1063 ** side of an IMAP ``AUTH=xxx'' capability string, eg ``digest-md5'', ``gssapi''
1064 ** or ``cram-md5''. This option is case-insensitive. If it's
1065 ** \fIunset\fP (the default) mutt will try all available methods,
1066 ** in order from most-secure to least-secure.
1070 ** set imap_authenticators="gssapi:cram-md5:login"
1073 ** \fBNote:\fP Mutt will only fall back to other authentication methods if
1074 ** the previous methods are unavailable. If a method is available but
1075 ** authentication fails, mutt will not connect to the IMAP server.
1077 { "imap_check_subscribed", DT_BOOL, R_NONE, OPTIMAPCHECKSUBSCRIBED, 0 },
1080 ** When \fIset\fP, mutt will fetch the set of subscribed folders from
1081 ** your server on connection, and add them to the set of mailboxes
1082 ** it polls for new mail just as if you had issued individual ``$mailboxes''
1085 { "imap_delim_chars", DT_STR, R_NONE, UL &ImapDelimChars, UL "/." },
1088 ** This contains the list of characters which you would like to treat
1089 ** as folder separators for displaying IMAP paths. In particular it
1090 ** helps in using the ``='' shortcut for your \fIfolder\fP variable.
1092 { "imap_headers", DT_STR, R_INDEX, UL &ImapHeaders, UL 0},
1095 ** Mutt requests these header fields in addition to the default headers
1096 ** (``Date:'', ``From:'', ``Subject:'', ``To:'', ``Cc:'', ``Message-Id:'',
1097 ** ``References:'', ``Content-Type:'', ``Content-Description:'', ``In-Reply-To:'',
1098 ** ``Reply-To:'', ``Lines:'', ``List-Post:'', ``X-Label:'') from IMAP
1099 ** servers before displaying the index menu. You may want to add more
1100 ** headers for spam detection.
1102 ** \fBNote:\fP This is a space separated list, items should be uppercase
1103 ** and not contain the colon, e.g. ``X-BOGOSITY X-SPAM-STATUS'' for the
1104 ** ``X-Bogosity:'' and ``X-Spam-Status:'' header fields.
1106 { "imap_idle", DT_BOOL, R_NONE, OPTIMAPIDLE, 0 },
1109 ** When \fIset\fP, mutt will attempt to use the IMAP IDLE extension
1110 ** to check for new mail in the current mailbox. Some servers
1111 ** (dovecot was the inspiration for this option) react badly
1112 ** to mutt's implementation. If your connection seems to freeze
1113 ** up periodically, try unsetting this.
1115 { "imap_keepalive", DT_NUM, R_NONE, UL &ImapKeepalive, 900 },
1118 ** This variable specifies the maximum amount of time in seconds that mutt
1119 ** will wait before polling open IMAP connections, to prevent the server
1120 ** from closing them before mutt has finished with them. The default is
1121 ** well within the RFC-specified minimum amount of time (30 minutes) before
1122 ** a server is allowed to do this, but in practice the RFC does get
1123 ** violated every now and then. Reduce this number if you find yourself
1124 ** getting disconnected from your IMAP server due to inactivity.
1126 { "imap_list_subscribed", DT_BOOL, R_NONE, OPTIMAPLSUB, 0 },
1129 ** This variable configures whether IMAP folder browsing will look for
1130 ** only subscribed folders or all folders. This can be toggled in the
1131 ** IMAP browser with the \fC<toggle-subscribed>\fP function.
1133 { "imap_login", DT_STR, R_NONE, UL &ImapLogin, UL 0 },
1136 ** Your login name on the IMAP server.
1138 ** This variable defaults to the value of $$imap_user.
1140 { "imap_pass", DT_STR, R_NONE, UL &ImapPass, UL 0 },
1143 ** Specifies the password for your IMAP account. If \fIunset\fP, Mutt will
1144 ** prompt you for your password when you invoke the \fC<imap-fetch-mail>\fP function
1145 ** or try to open an IMAP folder.
1147 ** \fBWarning\fP: you should only use this option when you are on a
1148 ** fairly secure machine, because the superuser can read your muttrc even
1149 ** if you are the only one who can read the file.
1151 { "imap_passive", DT_BOOL, R_NONE, OPTIMAPPASSIVE, 1 },
1154 ** When \fIset\fP, mutt will not open new IMAP connections to check for new
1155 ** mail. Mutt will only check for new mail over existing IMAP
1156 ** connections. This is useful if you don't want to be prompted to
1157 ** user/password pairs on mutt invocation, or if opening the connection
1160 { "imap_peek", DT_BOOL, R_NONE, OPTIMAPPEEK, 1 },
1163 ** When \fIset\fP, mutt will avoid implicitly marking your mail as read whenever
1164 ** you fetch a message from the server. This is generally a good thing,
1165 ** but can make closing an IMAP folder somewhat slower. This option
1166 ** exists to appease speed freaks.
1168 { "imap_pipeline_depth", DT_NUM, R_NONE, UL &ImapPipelineDepth, 15 },
1171 ** Controls the number of IMAP commands that may be queued up before they
1172 ** are sent to the server. A deeper pipeline reduces the amount of time
1173 ** mutt must wait for the server, and can make IMAP servers feel much
1174 ** more responsive. But not all servers correctly handle pipelined commands,
1175 ** so if you have problems you might want to try setting this variable to 0.
1177 ** \fBNote:\fP Changes to this variable have no effect on open connections.
1179 { "imap_servernoise", DT_BOOL, R_NONE, OPTIMAPSERVERNOISE, 1 },
1182 ** When \fIset\fP, mutt will display warning messages from the IMAP
1183 ** server as error messages. Since these messages are often
1184 ** harmless, or generated due to configuration problems on the
1185 ** server which are out of the users' hands, you may wish to suppress
1186 ** them at some point.
1188 { "imap_user", DT_STR, R_NONE, UL &ImapUser, UL 0 },
1191 ** The name of the user whose mail you intend to access on the IMAP
1194 ** This variable defaults to your user name on the local machine.
1197 { "implicit_autoview", DT_BOOL,R_NONE, OPTIMPLICITAUTOVIEW, 0},
1200 ** If set to ``yes'', mutt will look for a mailcap entry with the
1201 ** ``\fCcopiousoutput\fP'' flag set for \fIevery\fP MIME attachment it doesn't have
1202 ** an internal viewer defined for. If such an entry is found, mutt will
1203 ** use the viewer defined in that entry to convert the body part to text
1206 { "include", DT_QUAD, R_NONE, OPT_INCLUDE, M_ASKYES },
1209 ** Controls whether or not a copy of the message(s) you are replying to
1210 ** is included in your reply.
1212 { "include_onlyfirst", DT_BOOL, R_NONE, OPTINCLUDEONLYFIRST, 0},
1215 ** Controls whether or not Mutt includes only the first attachment
1216 ** of the message you are replying.
1218 { "indent_string", DT_STR, R_NONE, UL &Prefix, UL "> " },
1221 ** Specifies the string to prepend to each line of text quoted in a
1222 ** message to which you are replying. You are strongly encouraged not to
1223 ** change this value, as it tends to agitate the more fanatical netizens.
1225 ** The value of this option is ignored if $$text_flowed is set, too because
1226 ** the quoting mechanism is strictly defined for format=flowed.
1228 ** This option is a format string, please see the description of
1229 ** $$index_format for supported \fCprintf(3)\fP-style sequences.
1231 { "indent_str", DT_SYN, R_NONE, UL "indent_string", 0 },
1234 { "index_format", DT_STR, R_BOTH, UL &HdrFmt, UL "%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s" },
1237 ** This variable allows you to customize the message index display to
1238 ** your personal taste.
1240 ** ``Format strings'' are similar to the strings used in the C
1241 ** function \fCprintf(3)\fP to format output (see the man page for more details).
1242 ** The following sequences are defined in Mutt:
1244 ** .dt %a .dd address of the author
1245 ** .dt %A .dd reply-to address (if present; otherwise: address of author)
1246 ** .dt %b .dd filename of the original message folder (think mailbox)
1247 ** .dt %B .dd the list to which the letter was sent, or else the folder name (%b).
1248 ** .dt %c .dd number of characters (bytes) in the message
1249 ** .dt %C .dd current message number
1250 ** .dt %d .dd date and time of the message in the format specified by
1251 ** $$date_format converted to sender's time zone
1252 ** .dt %D .dd date and time of the message in the format specified by
1253 ** $$date_format converted to the local time zone
1254 ** .dt %e .dd current message number in thread
1255 ** .dt %E .dd number of messages in current thread
1256 ** .dt %f .dd sender (address + real name), either From: or Return-Path:
1257 ** .dt %F .dd author name, or recipient name if the message is from you
1258 ** .dt %H .dd spam attribute(s) of this message
1259 ** .dt %i .dd message-id of the current message
1260 ** .dt %l .dd number of lines in the message (does not work with maildir,
1261 ** mh, and possibly IMAP folders)
1262 ** .dt %L .dd If an address in the ``To:'' or ``Cc:'' header field matches an address
1263 ** defined by the users ``$subscribe'' command, this displays
1264 ** "To <list-name>", otherwise the same as %F.
1265 ** .dt %m .dd total number of message in the mailbox
1266 ** .dt %M .dd number of hidden messages if the thread is collapsed.
1267 ** .dt %N .dd message score
1268 ** .dt %n .dd author's real name (or address if missing)
1269 ** .dt %O .dd original save folder where mutt would formerly have
1270 ** stashed the message: list name or recipient name
1271 ** if not sent to a list
1272 ** .dt %P .dd progress indicator for the builtin pager (how much of the file has been displayed)
1273 ** .dt %s .dd subject of the message
1274 ** .dt %S .dd status of the message (``N''/``D''/``d''/``!''/``r''/\(as)
1275 ** .dt %t .dd ``To:'' field (recipients)
1276 ** .dt %T .dd the appropriate character from the $$to_chars string
1277 ** .dt %u .dd user (login) name of the author
1278 ** .dt %v .dd first name of the author, or the recipient if the message is from you
1279 ** .dt %X .dd number of attachments
1280 ** (please see the ``$attachments'' section for possible speed effects)
1281 ** .dt %y .dd ``X-Label:'' field, if present
1282 ** .dt %Y .dd ``X-Label:'' field, if present, and \fI(1)\fP not at part of a thread tree,
1283 ** \fI(2)\fP at the top of a thread, or \fI(3)\fP ``X-Label:'' is different from
1284 ** preceding message's ``X-Label:''.
1285 ** .dt %Z .dd message status flags
1286 ** .dt %{fmt} .dd the date and time of the message is converted to sender's
1287 ** time zone, and ``fmt'' is expanded by the library function
1288 ** \fCstrftime(3)\fP; a leading bang disables locales
1289 ** .dt %[fmt] .dd the date and time of the message is converted to the local
1290 ** time zone, and ``fmt'' is expanded by the library function
1291 ** \fCstrftime(3)\fP; a leading bang disables locales
1292 ** .dt %(fmt) .dd the local date and time when the message was received.
1293 ** ``fmt'' is expanded by the library function \fCstrftime(3)\fP;
1294 ** a leading bang disables locales
1295 ** .dt %<fmt> .dd the current local time. ``fmt'' is expanded by the library
1296 ** function \fCstrftime(3)\fP; a leading bang disables locales.
1297 ** .dt %>X .dd right justify the rest of the string and pad with character ``X''
1298 ** .dt %|X .dd pad to the end of the line with character ``X''
1299 ** .dt %*X .dd soft-fill with character ``X'' as pad
1302 ** ``Soft-fill'' deserves some explanation: Normal right-justification
1303 ** will print everything to the left of the ``%>'', displaying padding and
1304 ** whatever lies to the right only if there's room. By contrast,
1305 ** soft-fill gives priority to the right-hand side, guaranteeing space
1306 ** to display it and showing padding only if there's still room. If
1307 ** necessary, soft-fill will eat text leftwards to make room for
1310 ** Note that these expandos are supported in
1311 ** ``$save-hook'', ``$fcc-hook'' and ``$fcc-save-hook'', too.
1313 { "ispell", DT_PATH, R_NONE, UL &Ispell, UL ISPELL },
1316 ** How to invoke ispell (GNU's spell-checking software).
1318 { "keep_flagged", DT_BOOL, R_NONE, OPTKEEPFLAGGED, 0 },
1321 ** If \fIset\fP, read messages marked as flagged will not be moved
1322 ** from your spool mailbox to your $$mbox mailbox, or as a result of
1323 ** a ``$mbox-hook'' command.
1325 { "locale", DT_STR, R_BOTH, UL &Locale, UL "C" },
1328 ** The locale used by \fCstrftime(3)\fP to format dates. Legal values are
1329 ** the strings your system accepts for the locale environment variable \fC$$$LC_TIME\fP.
1331 { "mail_check", DT_NUM, R_NONE, UL &BuffyTimeout, 5 },
1334 ** This variable configures how often (in seconds) mutt should look for
1335 ** new mail. Also see the $$timeout variable.
1337 { "mailcap_path", DT_STR, R_NONE, UL &MailcapPath, 0 },
1340 ** This variable specifies which files to consult when attempting to
1341 ** display MIME bodies not directly supported by Mutt.
1343 { "mailcap_sanitize", DT_BOOL, R_NONE, OPTMAILCAPSANITIZE, 1 },
1346 ** If \fIset\fP, mutt will restrict possible characters in mailcap % expandos
1347 ** to a well-defined set of safe characters. This is the safe setting,
1348 ** but we are not sure it doesn't break some more advanced MIME stuff.
1350 ** \fBDON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE
1354 { "maildir_header_cache_verify", DT_BOOL, R_NONE, OPTHCACHEVERIFY, 1 },
1357 ** Check for Maildir unaware programs other than mutt having modified maildir
1358 ** files when the header cache is in use. This incurs one \fCstat(2)\fP per
1359 ** message every time the folder is opened (which can be very slow for NFS
1363 { "maildir_trash", DT_BOOL, R_NONE, OPTMAILDIRTRASH, 0 },
1366 ** If \fIset\fP, messages marked as deleted will be saved with the maildir
1367 ** trashed flag instead of unlinked. \fBNote:\fP this only applies
1368 ** to maildir-style mailboxes. Setting it will have no effect on other
1371 { "mark_old", DT_BOOL, R_BOTH, OPTMARKOLD, 1 },
1374 ** Controls whether or not mutt marks \fInew\fP \fBunread\fP
1375 ** messages as \fIold\fP if you exit a mailbox without reading them.
1376 ** With this option \fIset\fP, the next time you start mutt, the messages
1377 ** will show up with an ``O'' next to them in the index menu,
1378 ** indicating that they are old.
1380 { "markers", DT_BOOL, R_PAGER, OPTMARKERS, 1 },
1383 ** Controls the display of wrapped lines in the internal pager. If set, a
1384 ** ``+'' marker is displayed at the beginning of wrapped lines.
1386 ** Also see the $$smart_wrap variable.
1388 { "mask", DT_RX, R_NONE, UL &Mask, UL "!^\\.[^.]" },
1391 ** A regular expression used in the file browser, optionally preceded by
1392 ** the \fInot\fP operator ``!''. Only files whose names match this mask
1393 ** will be shown. The match is always case-sensitive.
1395 { "mbox", DT_PATH, R_BOTH, UL &Inbox, UL "~/mbox" },
1398 ** This specifies the folder into which read mail in your $$spoolfile
1399 ** folder will be appended.
1401 ** Also see the $$move variable.
1403 { "mbox_type", DT_MAGIC,R_NONE, UL &DefaultMagic, M_MBOX },
1406 ** The default mailbox type used when creating new folders. May be any of
1407 ** ``mbox'', ``MMDF'', ``MH'' and ``Maildir''. This is overriden by the
1408 ** \fC-m\fP command-line option.
1410 { "menu_context", DT_NUM, R_NONE, UL &MenuContext, 0 },
1413 ** This variable controls the number of lines of context that are given
1414 ** when scrolling through menus. (Similar to $$pager_context.)
1416 { "menu_move_off", DT_BOOL, R_NONE, OPTMENUMOVEOFF, 1 },
1419 ** When \fIunset\fP, the bottom entry of menus will never scroll up past
1420 ** the bottom of the screen, unless there are less entries than lines.
1421 ** When \fIset\fP, the bottom entry may move off the bottom.
1423 { "menu_scroll", DT_BOOL, R_NONE, OPTMENUSCROLL, 0 },
1426 ** When \fIset\fP, menus will be scrolled up or down one line when you
1427 ** attempt to move across a screen boundary. If \fIunset\fP, the screen
1428 ** is cleared and the next or previous page of the menu is displayed
1429 ** (useful for slow links to avoid many redraws).
1431 #if defined(USE_IMAP) || defined(USE_POP)
1432 { "message_cache_clean", DT_BOOL, R_NONE, OPTMESSAGECACHECLEAN, 0 },
1435 ** If \fIset\fP, mutt will clean out obsolete entries from the message cache when
1436 ** the mailbox is synchronized. You probably only want to set it
1437 ** every once in a while, since it can be a little slow
1438 ** (especially for large folders).
1440 { "message_cachedir", DT_PATH, R_NONE, UL &MessageCachedir, 0 },
1443 ** Set this to a directory and mutt will cache copies of messages from
1444 ** your IMAP and POP servers here. You are free to remove entries at any
1447 ** When setting this variable to a directory, mutt needs to fetch every
1448 ** remote message only once and can perform regular expression searches
1449 ** as fast as for local folders.
1451 ** Also see the $$message_cache_clean variable.
1454 { "message_format", DT_STR, R_NONE, UL &MsgFmt, UL "%s" },
1457 ** This is the string displayed in the ``attachment'' menu for
1458 ** attachments of type \fCmessage/rfc822\fP. For a full listing of defined
1459 ** \fCprintf(3)\fP-like sequences see the section on $$index_format.
1461 { "msg_format", DT_SYN, R_NONE, UL "message_format", 0 },
1464 { "meta_key", DT_BOOL, R_NONE, OPTMETAKEY, 0 },
1467 ** If \fIset\fP, forces Mutt to interpret keystrokes with the high bit (bit 8)
1468 ** set as if the user had pressed the Esc key and whatever key remains
1469 ** after having the high bit removed. For example, if the key pressed
1470 ** has an ASCII value of \fC0xf8\fP, then this is treated as if the user had
1471 ** pressed Esc then ``x''. This is because the result of removing the
1472 ** high bit from \fC0xf8\fP is \fC0x78\fP, which is the ASCII character
1475 { "metoo", DT_BOOL, R_NONE, OPTMETOO, 0 },
1478 ** If \fIunset\fP, Mutt will remove your address (see the ``$alternates''
1479 ** command) from the list of recipients when replying to a message.
1481 { "mh_purge", DT_BOOL, R_NONE, OPTMHPURGE, 0 },
1484 ** When \fIunset\fP, mutt will mimic mh's behaviour and rename deleted messages
1485 ** to \fI,<old file name>\fP in mh folders instead of really deleting
1486 ** them. This leaves the message on disk but makes programs reading the folder
1487 ** ignore it. If the variable is \fIset\fP, the message files will simply be
1490 ** This option is similar to $$maildir_trash for Maildir folders.
1492 { "mh_seq_flagged", DT_STR, R_NONE, UL &MhFlagged, UL "flagged" },
1495 ** The name of the MH sequence used for flagged messages.
1497 { "mh_seq_replied", DT_STR, R_NONE, UL &MhReplied, UL "replied" },
1500 ** The name of the MH sequence used to tag replied messages.
1502 { "mh_seq_unseen", DT_STR, R_NONE, UL &MhUnseen, UL "unseen" },
1505 ** The name of the MH sequence used for unseen messages.
1507 { "mime_forward", DT_QUAD, R_NONE, OPT_MIMEFWD, M_NO },
1510 ** When \fIset\fP, the message you are forwarding will be attached as a
1511 ** separate \fCmessage/rfc822\fP MIME part instead of included in the main body of the
1512 ** message. This is useful for forwarding MIME messages so the receiver
1513 ** can properly view the message as it was delivered to you. If you like
1514 ** to switch between MIME and not MIME from mail to mail, set this
1515 ** variable to ``ask-no'' or ``ask-yes''.
1517 ** Also see $$forward_decode and $$mime_forward_decode.
1519 { "mime_forward_decode", DT_BOOL, R_NONE, OPTMIMEFORWDECODE, 0 },
1522 ** Controls the decoding of complex MIME messages into \fCtext/plain\fP when
1523 ** forwarding a message while $$mime_forward is \fIset\fP. Otherwise
1524 ** $$forward_decode is used instead.
1526 { "mime_fwd", DT_SYN, R_NONE, UL "mime_forward", 0 },
1529 { "mime_forward_rest", DT_QUAD, R_NONE, OPT_MIMEFWDREST, M_YES },
1532 ** When forwarding multiple attachments of a MIME message from the attachment
1533 ** menu, attachments which cannot be decoded in a reasonable manner will
1534 ** be attached to the newly composed message if this option is \fIset\fP.
1537 { "mix_entry_format", DT_STR, R_NONE, UL &MixEntryFormat, UL "%4n %c %-16s %a" },
1540 ** This variable describes the format of a remailer line on the mixmaster
1541 ** chain selection screen. The following \fCprintf(3)\fP-like sequences are
1544 ** .dt %n .dd The running number on the menu.
1545 ** .dt %c .dd Remailer capabilities.
1546 ** .dt %s .dd The remailer's short name.
1547 ** .dt %a .dd The remailer's e-mail address.
1550 { "mixmaster", DT_PATH, R_NONE, UL &Mixmaster, UL MIXMASTER },
1553 ** This variable contains the path to the Mixmaster binary on your
1554 ** system. It is used with various sets of parameters to gather the
1555 ** list of known remailers, and to finally send a message through the
1559 { "move", DT_QUAD, R_NONE, OPT_MOVE, M_NO },
1562 ** Controls whether or not Mutt will move read messages
1563 ** from your spool mailbox to your $$mbox mailbox, or as a result of
1564 ** a ``$mbox-hook'' command.
1566 { "narrow_tree", DT_BOOL, R_TREE|R_INDEX, OPTNARROWTREE, 0 },
1569 ** This variable, when \fIset\fP, makes the thread tree narrower, allowing
1570 ** deeper threads to fit on the screen.
1573 { "net_inc", DT_NUM, R_NONE, UL &NetInc, 10 },
1576 ** Operations that expect to transfer a large amount of data over the
1577 ** network will update their progress every $$net_inc kilobytes.
1578 ** If set to 0, no progress messages will be displayed.
1580 ** See also $$read_inc, $$write_inc and $$net_inc.
1583 { "pager", DT_PATH, R_NONE, UL &Pager, UL "builtin" },
1586 ** This variable specifies which pager you would like to use to view
1587 ** messages. The value ``builtin'' means to use the builtin pager, otherwise this
1588 ** variable should specify the pathname of the external pager you would
1591 ** Using an external pager may have some disadvantages: Additional
1592 ** keystrokes are necessary because you can't call mutt functions
1593 ** directly from the pager, and screen resizes cause lines longer than
1594 ** the screen width to be badly formatted in the help menu.
1596 { "pager_context", DT_NUM, R_NONE, UL &PagerContext, 0 },
1599 ** This variable controls the number of lines of context that are given
1600 ** when displaying the next or previous page in the internal pager. By
1601 ** default, Mutt will display the line after the last one on the screen
1602 ** at the top of the next page (0 lines of context).
1604 ** This variable also specifies the amount of context given for search
1605 ** results. If positive, this many lines will be given before a match,
1606 ** if 0, the match will be top-aligned.
1608 { "pager_format", DT_STR, R_PAGER, UL &PagerFmt, UL "-%Z- %C/%m: %-20.20n %s%* -- (%P)" },
1611 ** This variable controls the format of the one-line message ``status''
1612 ** displayed before each message in either the internal or an external
1613 ** pager. The valid sequences are listed in the $$index_format
1616 { "pager_index_lines",DT_NUM, R_PAGER, UL &PagerIndexLines, 0 },
1619 ** Determines the number of lines of a mini-index which is shown when in
1620 ** the pager. The current message, unless near the top or bottom of the
1621 ** folder, will be roughly one third of the way down this mini-index,
1622 ** giving the reader the context of a few messages before and after the
1623 ** message. This is useful, for example, to determine how many messages
1624 ** remain to be read in the current thread. One of the lines is reserved
1625 ** for the status bar from the index, so a setting of 6
1626 ** will only show 5 lines of the actual index. A value of 0 results in
1627 ** no index being shown. If the number of messages in the current folder
1628 ** is less than $$pager_index_lines, then the index will only use as
1629 ** many lines as it needs.
1631 { "pager_stop", DT_BOOL, R_NONE, OPTPAGERSTOP, 0 },
1634 ** When \fIset\fP, the internal-pager will \fBnot\fP move to the next message
1635 ** when you are at the end of a message and invoke the \fC<next-page>\fP
1638 { "pgp_auto_decode", DT_BOOL, R_NONE, OPTPGPAUTODEC, 0 },
1641 ** If \fIset\fP, mutt will automatically attempt to decrypt traditional PGP
1642 ** messages whenever the user performs an operation which ordinarily would
1643 ** result in the contents of the message being operated on. For example,
1644 ** if the user displays a pgp-traditional message which has not been manually
1645 ** checked with the \fC$<check-traditional-pgp>\fP function, mutt will automatically
1646 ** check the message for traditional pgp.
1648 { "pgp_create_traditional", DT_SYN, R_NONE, UL "pgp_autoinline", 0 },
1649 { "pgp_autoinline", DT_BOOL, R_NONE, OPTPGPAUTOINLINE, 0 },
1652 ** This option controls whether Mutt generates old-style inline
1653 ** (traditional) PGP encrypted or signed messages under certain
1654 ** circumstances. This can be overridden by use of the pgp menu,
1655 ** when inline is not required.
1657 ** Note that Mutt might automatically use PGP/MIME for messages
1658 ** which consist of more than a single MIME part. Mutt can be
1659 ** configured to ask before sending PGP/MIME messages when inline
1660 ** (traditional) would not work.
1662 ** Also see the $$pgp_mime_auto variable.
1664 ** Also note that using the old-style PGP message format is \fBstrongly\fP
1665 ** \fBdeprecated\fP.
1668 { "pgp_check_exit", DT_BOOL, R_NONE, OPTPGPCHECKEXIT, 1 },
1671 ** If \fIset\fP, mutt will check the exit code of the PGP subprocess when
1672 ** signing or encrypting. A non-zero exit code means that the
1673 ** subprocess failed.
1676 { "pgp_clearsign_command", DT_STR, R_NONE, UL &PgpClearSignCommand, 0 },
1679 ** This format is used to create an old-style ``clearsigned'' PGP
1680 ** message. Note that the use of this format is \fBstrongly\fP
1681 ** \fBdeprecated\fP.
1683 ** This is a format string, see the $$pgp_decode_command command for
1684 ** possible \fCprintf(3)\fP-like sequences.
1687 { "pgp_decode_command", DT_STR, R_NONE, UL &PgpDecodeCommand, 0},
1690 ** This format strings specifies a command which is used to decode
1691 ** application/pgp attachments.
1693 ** The PGP command formats have their own set of \fCprintf(3)\fP-like sequences:
1695 ** .dt %p .dd Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty
1696 ** string otherwise. Note: This may be used with a %? construct.
1697 ** .dt %f .dd Expands to the name of a file containing a message.
1698 ** .dt %s .dd Expands to the name of a file containing the signature part
1699 ** . of a \fCmultipart/signed\fP attachment when verifying it.
1700 ** .dt %a .dd The value of $$pgp_sign_as.
1701 ** .dt %r .dd One or more key IDs.
1704 ** For examples on how to configure these formats for the various versions
1705 ** of PGP which are floating around, see the pgp and gpg sample configuration files in
1706 ** the \fCsamples/\fP subdirectory which has been installed on your system
1707 ** alongside the documentation.
1710 { "pgp_decrypt_command", DT_STR, R_NONE, UL &PgpDecryptCommand, 0},
1713 ** This command is used to decrypt a PGP encrypted message.
1715 ** This is a format string, see the $$pgp_decode_command command for
1716 ** possible \fCprintf(3)\fP-like sequences.
1719 { "pgp_encrypt_only_command", DT_STR, R_NONE, UL &PgpEncryptOnlyCommand, 0},
1722 ** This command is used to encrypt a body part without signing it.
1724 ** This is a format string, see the $$pgp_decode_command command for
1725 ** possible \fCprintf(3)\fP-like sequences.
1728 { "pgp_encrypt_sign_command", DT_STR, R_NONE, UL &PgpEncryptSignCommand, 0},
1731 ** This command is used to both sign and encrypt a body part.
1733 ** This is a format string, see the $$pgp_decode_command command for
1734 ** possible \fCprintf(3)\fP-like sequences.
1737 { "pgp_entry_format", DT_STR, R_NONE, UL &PgpEntryFormat, UL "%4n %t%f %4l/0x%k %-4a %2c %u" },
1740 ** This variable allows you to customize the PGP key selection menu to
1741 ** your personal taste. This string is similar to $$index_format, but
1742 ** has its own set of \fCprintf(3)\fP-like sequences:
1744 ** .dt %n .dd number
1745 ** .dt %k .dd key id
1746 ** .dt %u .dd user id
1747 ** .dt %a .dd algorithm
1748 ** .dt %l .dd key length
1750 ** .dt %c .dd capabilities
1751 ** .dt %t .dd trust/validity of the key-uid association
1752 ** .dt %[<s>] .dd date of the key where <s> is an \fCstrftime(3)\fP expression
1757 { "pgp_export_command", DT_STR, R_NONE, UL &PgpExportCommand, 0},
1760 ** This command is used to export a public key from the user's
1763 ** This is a format string, see the $$pgp_decode_command command for
1764 ** possible \fCprintf(3)\fP-like sequences.
1767 { "pgp_getkeys_command", DT_STR, R_NONE, UL &PgpGetkeysCommand, 0},
1770 ** This command is invoked whenever mutt will need public key information.
1771 ** Of the sequences supported by $$pgp_decode_command, %r is the only
1772 ** \fCprintf(3)\fP-like sequence used with this format.
1775 { "pgp_good_sign", DT_RX, R_NONE, UL &PgpGoodSign, 0 },
1778 ** If you assign a text to this variable, then a PGP signature is only
1779 ** considered verified if the output from $$pgp_verify_command contains
1780 ** the text. Use this variable if the exit code from the command is 0
1781 ** even for bad signatures.
1784 { "pgp_ignore_subkeys", DT_BOOL, R_NONE, OPTPGPIGNORESUB, 1},
1787 ** Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead,
1788 ** the principal key will inherit the subkeys' capabilities. \fIUnset\fP this
1789 ** if you want to play interesting key selection games.
1792 { "pgp_import_command", DT_STR, R_NONE, UL &PgpImportCommand, 0},
1795 ** This command is used to import a key from a message into
1796 ** the user's public key ring.
1798 ** This is a format string, see the $$pgp_decode_command command for
1799 ** possible \fCprintf(3)\fP-like sequences.
1802 { "pgp_list_pubring_command", DT_STR, R_NONE, UL &PgpListPubringCommand, 0},
1805 ** This command is used to list the public key ring's contents. The
1806 ** output format must be analogous to the one used by
1808 ** gpg --list-keys --with-colons.
1811 ** This format is also generated by the \fCpgpring\fP utility which comes
1814 ** This is a format string, see the $$pgp_decode_command command for
1815 ** possible \fCprintf(3)\fP-like sequences.
1818 { "pgp_list_secring_command", DT_STR, R_NONE, UL &PgpListSecringCommand, 0},
1821 ** This command is used to list the secret key ring's contents. The
1822 ** output format must be analogous to the one used by:
1824 ** gpg --list-keys --with-colons.
1827 ** This format is also generated by the \fCpgpring\fP utility which comes
1830 ** This is a format string, see the $$pgp_decode_command command for
1831 ** possible \fCprintf(3)\fP-like sequences.
1834 { "pgp_long_ids", DT_BOOL, R_NONE, OPTPGPLONGIDS, 0 },
1837 ** If \fIset\fP, use 64 bit PGP key IDs, if \fIunset\fP use the normal 32 bit key IDs.
1840 { "pgp_mime_auto", DT_QUAD, R_NONE, OPT_PGPMIMEAUTO, M_ASKYES },
1843 ** This option controls whether Mutt will prompt you for
1844 ** automatically sending a (signed/encrypted) message using
1845 ** PGP/MIME when inline (traditional) fails (for any reason).
1847 ** Also note that using the old-style PGP message format is \fBstrongly\fP
1848 ** \fBdeprecated\fP.
1851 { "pgp_auto_traditional", DT_SYN, R_NONE, UL "pgp_replyinline", 0 },
1852 { "pgp_replyinline", DT_BOOL, R_NONE, OPTPGPREPLYINLINE, 0 },
1855 ** Setting this variable will cause Mutt to always attempt to
1856 ** create an inline (traditional) message when replying to a
1857 ** message which is PGP encrypted/signed inline. This can be
1858 ** overridden by use of the pgp menu, when inline is not
1859 ** required. This option does not automatically detect if the
1860 ** (replied-to) message is inline; instead it relies on Mutt
1861 ** internals for previously checked/flagged messages.
1863 ** Note that Mutt might automatically use PGP/MIME for messages
1864 ** which consist of more than a single MIME part. Mutt can be
1865 ** configured to ask before sending PGP/MIME messages when inline
1866 ** (traditional) would not work.
1868 ** Also see the $$pgp_mime_auto variable.
1870 ** Also note that using the old-style PGP message format is \fBstrongly\fP
1871 ** \fBdeprecated\fP.
1875 { "pgp_retainable_sigs", DT_BOOL, R_NONE, OPTPGPRETAINABLESIG, 0 },
1878 ** If \fIset\fP, signed and encrypted messages will consist of nested
1879 ** \fCmultipart/signed\fP and \fCmultipart/encrypted\fP body parts.
1881 ** This is useful for applications like encrypted and signed mailing
1882 ** lists, where the outer layer (\fCmultipart/encrypted\fP) can be easily
1883 ** removed, while the inner \fCmultipart/signed\fP part is retained.
1886 { "pgp_show_unusable", DT_BOOL, R_NONE, OPTPGPSHOWUNUSABLE, 1 },
1889 ** If \fIset\fP, mutt will display non-usable keys on the PGP key selection
1890 ** menu. This includes keys which have been revoked, have expired, or
1891 ** have been marked as ``disabled'' by the user.
1894 { "pgp_sign_as", DT_STR, R_NONE, UL &PgpSignAs, 0 },
1897 ** If you have more than one key pair, this option allows you to specify
1898 ** which of your private keys to use. It is recommended that you use the
1899 ** keyid form to specify your key (e.g. \fC0x00112233\fP).
1902 { "pgp_sign_command", DT_STR, R_NONE, UL &PgpSignCommand, 0},
1905 ** This command is used to create the detached PGP signature for a
1906 ** \fCmultipart/signed\fP PGP/MIME body part.
1908 ** This is a format string, see the $$pgp_decode_command command for
1909 ** possible \fCprintf(3)\fP-like sequences.
1912 { "pgp_sort_keys", DT_SORT|DT_SORT_KEYS, R_NONE, UL &PgpSortKeys, SORT_ADDRESS },
1915 ** Specifies how the entries in the pgp menu are sorted. The
1916 ** following are legal values:
1918 ** .dt address .dd sort alphabetically by user id
1919 ** .dt keyid .dd sort alphabetically by key id
1920 ** .dt date .dd sort by key creation date
1921 ** .dt trust .dd sort by the trust of the key
1924 ** If you prefer reverse order of the above values, prefix it with
1928 { "pgp_strict_enc", DT_BOOL, R_NONE, OPTPGPSTRICTENC, 1 },
1931 ** If \fIset\fP, Mutt will automatically encode PGP/MIME signed messages as
1932 ** quoted-printable. Please note that unsetting this variable may
1933 ** lead to problems with non-verifyable PGP signatures, so only change
1934 ** this if you know what you are doing.
1937 { "pgp_timeout", DT_NUM, R_NONE, UL &PgpTimeout, 300 },
1940 ** The number of seconds after which a cached passphrase will expire if
1944 { "pgp_use_gpg_agent", DT_BOOL, R_NONE, OPTUSEGPGAGENT, 0},
1947 ** If \fIset\fP, mutt will use a possibly-running \fCgpg-agent(1)\fP process.
1950 { "pgp_verify_command", DT_STR, R_NONE, UL &PgpVerifyCommand, 0},
1953 ** This command is used to verify PGP signatures.
1955 ** This is a format string, see the $$pgp_decode_command command for
1956 ** possible \fCprintf(3)\fP-like sequences.
1959 { "pgp_verify_key_command", DT_STR, R_NONE, UL &PgpVerifyKeyCommand, 0},
1962 ** This command is used to verify key information from the key selection
1965 ** This is a format string, see the $$pgp_decode_command command for
1966 ** possible \fCprintf(3)\fP-like sequences.
1969 { "pipe_decode", DT_BOOL, R_NONE, OPTPIPEDECODE, 0 },
1972 ** Used in connection with the \fC<pipe-message>\fP command. When \fIunset\fP,
1973 ** Mutt will pipe the messages without any preprocessing. When \fIset\fP, Mutt
1974 ** will weed headers and will attempt to decode the messages
1977 { "pipe_sep", DT_STR, R_NONE, UL &PipeSep, UL "\n" },
1980 ** The separator to add between messages when piping a list of tagged
1981 ** messages to an external Unix command.
1983 { "pipe_split", DT_BOOL, R_NONE, OPTPIPESPLIT, 0 },
1986 ** Used in connection with the \fC<pipe-message>\fP function following
1987 ** \fC<tag-prefix>\fP. If this variable is \fIunset\fP, when piping a list of
1988 ** tagged messages Mutt will concatenate the messages and will pipe them
1989 ** all concatenated. When \fIset\fP, Mutt will pipe the messages one by one.
1990 ** In both cases the messages are piped in the current sorted order,
1991 ** and the $$pipe_sep separator is added after each message.
1994 { "pop_auth_try_all", DT_BOOL, R_NONE, OPTPOPAUTHTRYALL, 1 },
1997 ** If \fIset\fP, Mutt will try all available authentication methods.
1998 ** When \fIunset\fP, Mutt will only fall back to other authentication
1999 ** methods if the previous methods are unavailable. If a method is
2000 ** available but authentication fails, Mutt will not connect to the POP server.
2002 { "pop_authenticators", DT_STR, R_NONE, UL &PopAuthenticators, UL 0 },
2005 ** This is a colon-delimited list of authentication methods mutt may
2006 ** attempt to use to log in to an POP server, in the order mutt should
2007 ** try them. Authentication methods are either ``user'', ``apop'' or any
2008 ** SASL mechanism, eg ``digest-md5'', ``gssapi'' or ``cram-md5''.
2009 ** This option is case-insensitive. If this option is \fIunset\fP
2010 ** (the default) mutt will try all available methods, in order from
2011 ** most-secure to least-secure.
2015 ** set pop_authenticators="digest-md5:apop:user"
2018 { "pop_checkinterval", DT_NUM, R_NONE, UL &PopCheckTimeout, 60 },
2021 ** This variable configures how often (in seconds) mutt should look for
2022 ** new mail in the currently selected mailbox if it is a POP mailbox.
2024 { "pop_delete", DT_QUAD, R_NONE, OPT_POPDELETE, M_ASKNO },
2027 ** If \fIset\fP, Mutt will delete successfully downloaded messages from the POP
2028 ** server when using the \fC$<fetch-mail>\fP function. When \fIunset\fP, Mutt will
2029 ** download messages but also leave them on the POP server.
2031 { "pop_host", DT_STR, R_NONE, UL &PopHost, UL "" },
2034 ** The name of your POP server for the \fC$<fetch-mail>\fP function. You
2035 ** can also specify an alternative port, username and password, ie:
2037 ** [pop[s]://][username[:password]@]popserver[:port]
2040 ** where ``[...]'' denotes an optional part.
2042 { "pop_last", DT_BOOL, R_NONE, OPTPOPLAST, 0 },
2045 ** If this variable is \fIset\fP, mutt will try to use the ``\fCLAST\fP'' POP command
2046 ** for retrieving only unread messages from the POP server when using
2047 ** the \fC$<fetch-mail>\fP function.
2049 { "pop_pass", DT_STR, R_NONE, UL &PopPass, UL "" },
2052 ** Specifies the password for your POP account. If \fIunset\fP, Mutt will
2053 ** prompt you for your password when you open a POP mailbox.
2055 ** \fBWarning\fP: you should only use this option when you are on a
2056 ** fairly secure machine, because the superuser can read your muttrc
2057 ** even if you are the only one who can read the file.
2059 { "pop_reconnect", DT_QUAD, R_NONE, OPT_POPRECONNECT, M_ASKYES },
2062 ** Controls whether or not Mutt will try to reconnect to the POP server if
2063 ** the connection is lost.
2065 { "pop_user", DT_STR, R_NONE, UL &PopUser, 0 },
2068 ** Your login name on the POP server.
2070 ** This variable defaults to your user name on the local machine.
2072 #endif /* USE_POP */
2073 { "post_indent_string",DT_STR, R_NONE, UL &PostIndentString, UL "" },
2076 ** Similar to the $$attribution variable, Mutt will append this
2077 ** string after the inclusion of a message which is being replied to.
2079 { "post_indent_str", DT_SYN, R_NONE, UL "post_indent_string", 0 },
2082 { "postpone", DT_QUAD, R_NONE, OPT_POSTPONE, M_ASKYES },
2085 ** Controls whether or not messages are saved in the $$postponed
2086 ** mailbox when you elect not to send immediately.
2088 ** Also see the $$recall variable.
2090 { "postponed", DT_PATH, R_INDEX, UL &Postponed, UL "~/postponed" },
2093 ** Mutt allows you to indefinitely ``$postpone sending a message'' which
2094 ** you are editing. When you choose to postpone a message, Mutt saves it
2095 ** in the mailbox specified by this variable.
2097 ** Also see the $$postpone variable.
2100 { "preconnect", DT_STR, R_NONE, UL &Preconnect, UL 0},
2103 ** If \fIset\fP, a shell command to be executed if mutt fails to establish
2104 ** a connection to the server. This is useful for setting up secure
2105 ** connections, e.g. with \fCssh(1)\fP. If the command returns a nonzero
2106 ** status, mutt gives up opening the server. Example:
2108 ** set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net \(rs
2109 ** sleep 20 < /dev/null > /dev/null"
2112 ** Mailbox ``foo'' on ``mailhost.net'' can now be reached
2113 ** as ``{localhost:1234}foo''.
2115 ** Note: For this example to work, you must be able to log in to the
2116 ** remote machine without having to enter a password.
2118 #endif /* USE_SOCKET */
2119 { "print", DT_QUAD, R_NONE, OPT_PRINT, M_ASKNO },
2122 ** Controls whether or not Mutt really prints messages.
2123 ** This is set to ``ask-no'' by default, because some people
2124 ** accidentally hit ``p'' often.
2126 { "print_command", DT_PATH, R_NONE, UL &PrintCmd, UL "lpr" },
2129 ** This specifies the command pipe that should be used to print messages.
2131 { "print_cmd", DT_SYN, R_NONE, UL "print_command", 0 },
2134 { "print_decode", DT_BOOL, R_NONE, OPTPRINTDECODE, 1 },
2137 ** Used in connection with the \fC<print-message>\fP command. If this
2138 ** option is \fIset\fP, the message is decoded before it is passed to the
2139 ** external command specified by $$print_command. If this option
2140 ** is \fIunset\fP, no processing will be applied to the message when
2141 ** printing it. The latter setting may be useful if you are using
2142 ** some advanced printer filter which is able to properly format
2143 ** e-mail messages for printing.
2145 { "print_split", DT_BOOL, R_NONE, OPTPRINTSPLIT, 0 },
2148 ** Used in connection with the \fC<print-message>\fP command. If this option
2149 ** is \fIset\fP, the command specified by $$print_command is executed once for
2150 ** each message which is to be printed. If this option is \fIunset\fP,
2151 ** the command specified by $$print_command is executed only once, and
2152 ** all the messages are concatenated, with a form feed as the message
2155 ** Those who use the \fCenscript\fP(1) program's mail-printing mode will
2156 ** most likely want to \fIset\fP this option.
2158 { "prompt_after", DT_BOOL, R_NONE, OPTPROMPTAFTER, 1 },
2161 ** If you use an \fIexternal\fP $$pager, setting this variable will
2162 ** cause Mutt to prompt you for a command when the pager exits rather
2163 ** than returning to the index menu. If \fIunset\fP, Mutt will return to the
2164 ** index menu when the external pager exits.
2166 { "query_command", DT_PATH, R_NONE, UL &QueryCmd, UL "" },
2169 ** This specifies the command that mutt will use to make external address
2170 ** queries. The string should contain a ``%s'', which will be substituted
2171 ** with the query string the user types. See ``$query'' for more
2174 { "query_format", DT_STR, R_NONE, UL &QueryFormat, UL "%4c %t %-25.25a %-25.25n %?e?(%e)?" },
2177 ** This variable describes the format of the ``query'' menu. The
2178 ** following \fCprintf(3)\fP-style sequences are understood:
2180 ** .dt %a .dd destination address
2181 ** .dt %c .dd current entry number
2182 ** .dt %e .dd extra information *
2183 ** .dt %n .dd destination name
2184 ** .dt %t .dd ``*'' if current entry is tagged, a space otherwise
2185 ** .dt %>X .dd right justify the rest of the string and pad with ``X''
2186 ** .dt %|X .dd pad to the end of the line with ``X''
2187 ** .dt %*X .dd soft-fill with character ``X'' as pad
2190 ** For an explanation of ``soft-fill'', see the $$index_format documentation.
2192 ** * = can be optionally printed if nonzero, see the $$status_format documentation.
2194 { "quit", DT_QUAD, R_NONE, OPT_QUIT, M_YES },
2197 ** This variable controls whether ``quit'' and ``exit'' actually quit
2198 ** from mutt. If this option is \fIset\fP, they do quit, if it is \fIunset\fP, they
2199 ** have no effect, and if it is set to \fIask-yes\fP or \fIask-no\fP, you are
2200 ** prompted for confirmation when you try to quit.
2202 { "quote_regexp", DT_RX, R_PAGER, UL &QuoteRegexp, UL "^([ \t]*[|>:}#])+" },
2205 ** A regular expression used in the internal pager to determine quoted
2206 ** sections of text in the body of a message. Quoted text may be filtered
2207 ** out using the \fC<toggle-quoted>\fP command, or colored according to the
2208 ** ``color quoted'' family of directives.
2210 ** Higher levels of quoting may be colored differently (``color quoted1'',
2211 ** ``color quoted2'', etc.). The quoting level is determined by removing
2212 ** the last character from the matched text and recursively reapplying
2213 ** the regular expression until it fails to produce a match.
2215 ** Match detection may be overridden by the $$smileys regular expression.
2217 { "read_inc", DT_NUM, R_NONE, UL &ReadInc, 10 },
2220 ** If set to a value greater than 0, Mutt will display which message it
2221 ** is currently on when reading a mailbox or when performing search actions
2222 ** such as search and limit. The message is printed after
2223 ** this many messages have been read or searched (e.g., if set to 25, Mutt will
2224 ** print a message when it is at message 25, and then again when it gets
2225 ** to message 50). This variable is meant to indicate progress when
2226 ** reading or searching large mailboxes which may take some time.
2227 ** When set to 0, only a single message will appear before the reading
2230 ** Also see the $$write_inc, $$net_inc and $$time_inc variables and the
2231 ** ``$tuning'' section of the manual for performance considerations.
2233 { "read_only", DT_BOOL, R_NONE, OPTREADONLY, 0 },
2236 ** If \fIset\fP, all folders are opened in read-only mode.
2238 { "realname", DT_STR, R_BOTH, UL &Realname, 0 },
2241 ** This variable specifies what ``real'' or ``personal'' name should be used
2242 ** when sending messages.
2244 ** By default, this is the GECOS field from \fC/etc/passwd\fP. Note that this
2245 ** variable will \fInot\fP be used when the user has set a real name
2246 ** in the $$from variable.
2248 { "recall", DT_QUAD, R_NONE, OPT_RECALL, M_ASKYES },
2251 ** Controls whether or not Mutt recalls postponed messages
2252 ** when composing a new message.
2254 ** \fISetting\fP this variable to is not generally useful, and thus not
2257 ** Also see $$postponed variable.
2259 { "record", DT_PATH, R_NONE, UL &Outbox, UL "~/sent" },
2262 ** This specifies the file into which your outgoing messages should be
2263 ** appended. (This is meant as the primary method for saving a copy of
2264 ** your messages, but another way to do this is using the ``$my_hdr''
2265 ** command to create a ``Bcc:'' field with your email address in it.)
2267 ** The value of \fI$$record\fP is overridden by the $$force_name and
2268 ** $$save_name variables, and the ``$fcc-hook'' command.
2270 { "reply_regexp", DT_RX, R_INDEX|R_RESORT, UL &ReplyRegexp, UL "^(re([\\[0-9\\]+])*|aw):[ \t]*" },
2273 ** A regular expression used to recognize reply messages when threading
2274 ** and replying. The default value corresponds to the English "Re:" and
2275 ** the German "Aw:".
2277 { "reply_self", DT_BOOL, R_NONE, OPTREPLYSELF, 0 },
2280 ** If \fIunset\fP and you are replying to a message sent by you, Mutt will
2281 ** assume that you want to reply to the recipients of that message rather
2282 ** than to yourself.
2284 ** Also see the ``$alternates'' command.
2286 { "reply_to", DT_QUAD, R_NONE, OPT_REPLYTO, M_ASKYES },
2289 ** If \fIset\fP, when replying to a message, Mutt will use the address listed
2290 ** in the Reply-to: header as the recipient of the reply. If \fIunset\fP,
2291 ** it will use the address in the From: header field instead. This
2292 ** option is useful for reading a mailing list that sets the Reply-To:
2293 ** header field to the list address and you want to send a private
2294 ** message to the author of a message.
2296 { "resolve", DT_BOOL, R_NONE, OPTRESOLVE, 1 },
2299 ** When \fIset\fP, the cursor will be automatically advanced to the next
2300 ** (possibly undeleted) message whenever a command that modifies the
2301 ** current message is executed.
2303 { "reverse_alias", DT_BOOL, R_BOTH, OPTREVALIAS, 0 },
2306 ** This variable controls whether or not Mutt will display the ``personal''
2307 ** name from your aliases in the index menu if it finds an alias that
2308 ** matches the message's sender. For example, if you have the following
2311 ** alias juser abd30425@somewhere.net (Joe User)
2314 ** and then you receive mail which contains the following header:
2316 ** From: abd30425@somewhere.net
2319 ** It would be displayed in the index menu as ``Joe User'' instead of
2320 ** ``abd30425@somewhere.net.'' This is useful when the person's e-mail
2321 ** address is not human friendly.
2323 { "reverse_name", DT_BOOL, R_BOTH, OPTREVNAME, 0 },
2326 ** It may sometimes arrive that you receive mail to a certain machine,
2327 ** move the messages to another machine, and reply to some the messages
2328 ** from there. If this variable is \fIset\fP, the default \fIFrom:\fP line of
2329 ** the reply messages is built using the address where you received the
2330 ** messages you are replying to \fBif\fP that address matches your
2331 ** ``$alternates''. If the variable is \fIunset\fP, or the address that would be
2332 ** used doesn't match your ``$alternates'', the \fIFrom:\fP line will use
2333 ** your address on the current machine.
2335 ** Also see the ``$alternates'' command.
2337 { "reverse_realname", DT_BOOL, R_BOTH, OPTREVREAL, 1 },
2340 ** This variable fine-tunes the behaviour of the $$reverse_name feature.
2341 ** When it is \fIset\fP, mutt will use the address from incoming messages as-is,
2342 ** possibly including eventual real names. When it is \fIunset\fP, mutt will
2343 ** override any such real names with the setting of the $$realname variable.
2345 { "rfc2047_parameters", DT_BOOL, R_NONE, OPTRFC2047PARAMS, 0 },
2348 ** When this variable is \fIset\fP, Mutt will decode RFC2047-encoded MIME
2349 ** parameters. You want to set this variable when mutt suggests you
2350 ** to save attachments to files named like:
2352 ** =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
2355 ** When this variable is \fIset\fP interactively, the change won't be
2356 ** active until you change folders.
2358 ** Note that this use of RFC2047's encoding is explicitly
2359 ** prohibited by the standard, but nevertheless encountered in the
2362 ** Also note that setting this parameter will \fInot\fP have the effect
2363 ** that mutt \fIgenerates\fP this kind of encoding. Instead, mutt will
2364 ** unconditionally use the encoding specified in RFC2231.
2366 { "save_address", DT_BOOL, R_NONE, OPTSAVEADDRESS, 0 },
2369 ** If \fIset\fP, mutt will take the sender's full address when choosing a
2370 ** default folder for saving a mail. If $$save_name or $$force_name
2371 ** is \fIset\fP too, the selection of the Fcc folder will be changed as well.
2373 { "save_empty", DT_BOOL, R_NONE, OPTSAVEEMPTY, 1 },
2376 ** When \fIunset\fP, mailboxes which contain no saved messages will be removed
2377 ** when closed (the exception is $$spoolfile which is never removed).
2378 ** If \fIset\fP, mailboxes are never removed.
2380 ** \fBNote:\fP This only applies to mbox and MMDF folders, Mutt does not
2381 ** delete MH and Maildir directories.
2383 { "save_history", DT_NUM, R_NONE, UL &SaveHist, 0 },
2386 ** This variable controls the size of the history (per category) saved in the
2387 ** $$history_file file.
2389 { "save_name", DT_BOOL, R_NONE, OPTSAVENAME, 0 },
2392 ** This variable controls how copies of outgoing messages are saved.
2393 ** When \fIset\fP, a check is made to see if a mailbox specified by the
2394 ** recipient address exists (this is done by searching for a mailbox in
2395 ** the $$folder directory with the \fIusername\fP part of the
2396 ** recipient address). If the mailbox exists, the outgoing message will
2397 ** be saved to that mailbox, otherwise the message is saved to the
2398 ** $$record mailbox.
2400 ** Also see the $$force_name variable.
2402 { "score", DT_BOOL, R_NONE, OPTSCORE, 1 },
2405 ** When this variable is \fIunset\fP, scoring is turned off. This can
2406 ** be useful to selectively disable scoring for certain folders when the
2407 ** $$score_threshold_delete variable and related are used.
2410 { "score_threshold_delete", DT_NUM, R_NONE, UL &ScoreThresholdDelete, UL -1 },
2413 ** Messages which have been assigned a score equal to or lower than the value
2414 ** of this variable are automatically marked for deletion by mutt. Since
2415 ** mutt scores are always greater than or equal to zero, the default setting
2416 ** of this variable will never mark a message for deletion.
2418 { "score_threshold_flag", DT_NUM, R_NONE, UL &ScoreThresholdFlag, 9999 },
2421 ** Messages which have been assigned a score greater than or equal to this
2422 ** variable's value are automatically marked "flagged".
2424 { "score_threshold_read", DT_NUM, R_NONE, UL &ScoreThresholdRead, UL -1 },
2427 ** Messages which have been assigned a score equal to or lower than the value
2428 ** of this variable are automatically marked as read by mutt. Since
2429 ** mutt scores are always greater than or equal to zero, the default setting
2430 ** of this variable will never mark a message read.
2432 { "search_context", DT_NUM, R_NONE, UL &SearchContext, UL 0 },
2435 ** For the pager, this variable specifies the number of lines shown
2436 ** before search results. By default, search results will be top-aligned.
2438 { "send_charset", DT_STR, R_NONE, UL &SendCharset, UL "us-ascii:iso-8859-1:utf-8" },
2441 ** A colon-delimited list of character sets for outgoing messages. Mutt will use the
2442 ** first character set into which the text can be converted exactly.
2443 ** If your $$charset is not ``iso-8859-1'' and recipients may not
2444 ** understand ``UTF-8'', it is advisable to include in the list an
2445 ** appropriate widely used standard character set (such as
2446 ** ``iso-8859-2'', ``koi8-r'' or ``iso-2022-jp'') either instead of or after
2449 ** In case the text cannot be converted into one of these exactly,
2450 ** mutt uses $$charset as a fallback.
2452 { "sendmail", DT_PATH, R_NONE, UL &Sendmail, UL SENDMAIL " -oem -oi" },
2455 ** Specifies the program and arguments used to deliver mail sent by Mutt.
2456 ** Mutt expects that the specified program interprets additional
2457 ** arguments as recipient addresses.
2459 { "sendmail_wait", DT_NUM, R_NONE, UL &SendmailWait, 0 },
2462 ** Specifies the number of seconds to wait for the $$sendmail process
2463 ** to finish before giving up and putting delivery in the background.
2465 ** Mutt interprets the value of this variable as follows:
2467 ** .dt >0 .dd number of seconds to wait for sendmail to finish before continuing
2468 ** .dt 0 .dd wait forever for sendmail to finish
2469 ** .dt <0 .dd always put sendmail in the background without waiting
2472 ** Note that if you specify a value other than 0, the output of the child
2473 ** process will be put in a temporary file. If there is some error, you
2474 ** will be informed as to where to find the output.
2476 { "shell", DT_PATH, R_NONE, UL &Shell, 0 },
2479 ** Command to use when spawning a subshell. By default, the user's login
2480 ** shell from \fC/etc/passwd\fP is used.
2482 { "sig_dashes", DT_BOOL, R_NONE, OPTSIGDASHES, 1 },
2485 ** If \fIset\fP, a line containing ``-- '' (note the trailing space) will be inserted before your
2486 ** $$signature. It is \fBstrongly\fP recommended that you not \fIunset\fP
2487 ** this variable unless your signature contains just your name. The
2488 ** reason for this is because many software packages use ``-- \n'' to
2489 ** detect your signature. For example, Mutt has the ability to highlight
2490 ** the signature in a different color in the builtin pager.
2492 { "sig_on_top", DT_BOOL, R_NONE, OPTSIGONTOP, 0},
2495 ** If \fIset\fP, the signature will be included before any quoted or forwarded
2496 ** text. It is \fBstrongly\fP recommended that you do not set this variable
2497 ** unless you really know what you are doing, and are prepared to take
2498 ** some heat from netiquette guardians.
2500 { "signature", DT_PATH, R_NONE, UL &Signature, UL "~/.signature" },
2503 ** Specifies the filename of your signature, which is appended to all
2504 ** outgoing messages. If the filename ends with a pipe (``|''), it is
2505 ** assumed that filename is a shell command and input should be read from
2506 ** its standard output.
2508 { "simple_search", DT_STR, R_NONE, UL &SimpleSearch, UL "~f %s | ~s %s" },
2511 ** Specifies how Mutt should expand a simple search into a real search
2512 ** pattern. A simple search is one that does not contain any of the ``~'' pattern
2513 ** operators. See ``$patterns'' for more information on search patterns.
2515 ** For example, if you simply type ``joe'' at a search or limit prompt, Mutt
2516 ** will automatically expand it to the value specified by this variable by
2517 ** replacing ``%s'' with the supplied string.
2518 ** For the default value, ``joe'' would be expanded to: ``~f joe | ~s joe''.
2520 { "sleep_time", DT_NUM, R_NONE, UL &SleepTime, 1 },
2523 ** Specifies time, in seconds, to pause while displaying certain informational
2524 ** messages, while moving from folder to folder and after expunging
2525 ** messages from the current folder. The default is to pause one second, so
2526 ** a value of zero for this option suppresses the pause.
2528 { "smart_wrap", DT_BOOL, R_PAGER, OPTWRAP, 1 },
2531 ** Controls the display of lines longer than the screen width in the
2532 ** internal pager. If \fIset\fP, long lines are wrapped at a word boundary. If
2533 ** \fIunset\fP, lines are simply wrapped at the screen edge. Also see the
2534 ** $$markers variable.
2536 { "smileys", DT_RX, R_PAGER, UL &Smileys, UL "(>From )|(:[-^]?[][)(><}{|/DP])" },
2539 ** The \fIpager\fP uses this variable to catch some common false
2540 ** positives of $$quote_regexp, most notably smileys and not consider
2541 ** a line quoted text if it also matches $$smileys. This mostly
2542 ** happens at the beginning of a line.
2547 { "smime_ask_cert_label", DT_BOOL, R_NONE, OPTASKCERTLABEL, 1 },
2550 ** This flag controls whether you want to be asked to enter a label
2551 ** for a certificate about to be added to the database or not. It is
2552 ** \fIset\fP by default.
2555 { "smime_ca_location", DT_PATH, R_NONE, UL &SmimeCALocation, 0 },
2558 ** This variable contains the name of either a directory, or a file which
2559 ** contains trusted certificates for use with OpenSSL.
2562 { "smime_certificates", DT_PATH, R_NONE, UL &SmimeCertificates, 0 },
2565 ** Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
2566 ** storage and retrieval of keys by itself. This is very basic right
2567 ** now, and keys and certificates are stored in two different
2568 ** directories, both named as the hash-value retrieved from
2569 ** OpenSSL. There is an index file which contains mailbox-address
2570 ** keyid pairs, and which can be manually edited. This option points to
2571 ** the location of the certificates.
2574 { "smime_decrypt_command", DT_STR, R_NONE, UL &SmimeDecryptCommand, 0},
2577 ** This format string specifies a command which is used to decrypt
2578 ** \fCapplication/x-pkcs7-mime\fP attachments.
2580 ** The OpenSSL command formats have their own set of \fCprintf(3)\fP-like sequences
2581 ** similar to PGP's:
2583 ** .dt %f .dd Expands to the name of a file containing a message.
2584 ** .dt %s .dd Expands to the name of a file containing the signature part
2585 ** . of a \fCmultipart/signed\fP attachment when verifying it.
2586 ** .dt %k .dd The key-pair specified with $$smime_default_key
2587 ** .dt %c .dd One or more certificate IDs.
2588 ** .dt %a .dd The algorithm used for encryption.
2589 ** .dt %C .dd CA location: Depending on whether $$smime_ca_location
2590 ** . points to a directory or file, this expands to
2591 ** . ``-CApath $$smime_ca_location'' or ``-CAfile $$smime_ca_location''.
2594 ** For examples on how to configure these formats, see the \fCsmime.rc\fP in
2595 ** the \fCsamples/\fP subdirectory which has been installed on your system
2596 ** alongside the documentation.
2599 { "smime_decrypt_use_default_key", DT_BOOL, R_NONE, OPTSDEFAULTDECRYPTKEY, 1 },
2602 ** If \fIset\fP (default) this tells mutt to use the default key for decryption. Otherwise,
2603 ** if managing multiple certificate-key-pairs, mutt will try to use the mailbox-address
2604 ** to determine the key to use. It will ask you to supply a key, if it can't find one.
2607 { "smime_sign_as", DT_SYN, R_NONE, UL "smime_default_key", 0 },
2608 { "smime_default_key", DT_STR, R_NONE, UL &SmimeDefaultKey, 0 },
2611 ** This is the default key-pair to use for signing. This must be set to the
2612 ** keyid (the hash-value that OpenSSL generates) to work properly
2615 { "smime_encrypt_command", DT_STR, R_NONE, UL &SmimeEncryptCommand, 0},
2618 ** This command is used to create encrypted S/MIME messages.
2620 ** This is a format string, see the $$smime_decrypt_command command for
2621 ** possible \fCprintf(3)\fP-like sequences.
2624 { "smime_encrypt_with", DT_STR, R_NONE, UL &SmimeCryptAlg, 0 },
2627 ** This sets the algorithm that should be used for encryption.
2628 ** Valid choices are ``des'', ``des3'', ``rc2-40'', ``rc2-64'', ``rc2-128''.
2629 ** If \fIunset\fP, ``3des'' (TripleDES) is used.
2632 { "smime_get_cert_command", DT_STR, R_NONE, UL &SmimeGetCertCommand, 0},
2635 ** This command is used to extract X509 certificates from a PKCS7 structure.
2637 ** This is a format string, see the $$smime_decrypt_command command for
2638 ** possible \fCprintf(3)\fP-like sequences.
2641 { "smime_get_cert_email_command", DT_STR, R_NONE, UL &SmimeGetCertEmailCommand, 0},
2644 ** This command is used to extract the mail address(es) used for storing
2645 ** X509 certificates, and for verification purposes (to check whether the
2646 ** certificate was issued for the sender's mailbox).
2648 ** This is a format string, see the $$smime_decrypt_command command for
2649 ** possible \fCprintf(3)\fP-like sequences.
2652 { "smime_get_signer_cert_command", DT_STR, R_NONE, UL &SmimeGetSignerCertCommand, 0},
2655 ** This command is used to extract only the signers X509 certificate from a S/MIME
2656 ** signature, so that the certificate's owner may get compared to the
2657 ** email's ``From:'' field.
2659 ** This is a format string, see the $$smime_decrypt_command command for
2660 ** possible \fCprintf(3)\fP-like sequences.
2663 { "smime_import_cert_command", DT_STR, R_NONE, UL &SmimeImportCertCommand, 0},
2666 ** This command is used to import a certificate via smime_keys.
2668 ** This is a format string, see the $$smime_decrypt_command command for
2669 ** possible \fCprintf(3)\fP-like sequences.
2672 { "smime_is_default", DT_BOOL, R_NONE, OPTSMIMEISDEFAULT, 0},
2675 ** The default behaviour of mutt is to use PGP on all auto-sign/encryption
2676 ** operations. To override and to use OpenSSL instead this must be \fIset\fP.
2677 ** However, this has no effect while replying, since mutt will automatically
2678 ** select the same application that was used to sign/encrypt the original
2679 ** message. (Note that this variable can be overridden by unsetting $$crypt_autosmime.)
2682 { "smime_keys", DT_PATH, R_NONE, UL &SmimeKeys, 0 },
2685 ** Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
2686 ** storage and retrieval of keys/certs by itself. This is very basic right now,
2687 ** and stores keys and certificates in two different directories, both
2688 ** named as the hash-value retrieved from OpenSSL. There is an index file
2689 ** which contains mailbox-address keyid pair, and which can be manually
2690 ** edited. This option points to the location of the private keys.
2693 { "smime_pk7out_command", DT_STR, R_NONE, UL &SmimePk7outCommand, 0},
2696 ** This command is used to extract PKCS7 structures of S/MIME signatures,
2697 ** in order to extract the public X509 certificate(s).
2699 ** This is a format string, see the $$smime_decrypt_command command for
2700 ** possible \fCprintf(3)\fP-like sequences.
2703 { "smime_sign_command", DT_STR, R_NONE, UL &SmimeSignCommand, 0},
2706 ** This command is used to created S/MIME signatures of type
2707 ** \fCmultipart/signed\fP, which can be read by all mail clients.
2709 ** This is a format string, see the $$smime_decrypt_command command for
2710 ** possible \fCprintf(3)\fP-like sequences.
2713 { "smime_sign_opaque_command", DT_STR, R_NONE, UL &SmimeSignOpaqueCommand, 0},
2716 ** This command is used to created S/MIME signatures of type
2717 ** \fCapplication/x-pkcs7-signature\fP, which can only be handled by mail
2718 ** clients supporting the S/MIME extension.
2720 ** This is a format string, see the $$smime_decrypt_command command for
2721 ** possible \fCprintf(3)\fP-like sequences.
2724 { "smime_timeout", DT_NUM, R_NONE, UL &SmimeTimeout, 300 },
2727 ** The number of seconds after which a cached passphrase will expire if
2731 { "smime_verify_command", DT_STR, R_NONE, UL &SmimeVerifyCommand, 0},
2734 ** This command is used to verify S/MIME signatures of type \fCmultipart/signed\fP.
2736 ** This is a format string, see the $$smime_decrypt_command command for
2737 ** possible \fCprintf(3)\fP-like sequences.
2740 { "smime_verify_opaque_command", DT_STR, R_NONE, UL &SmimeVerifyOpaqueCommand, 0},
2743 ** This command is used to verify S/MIME signatures of type
2744 ** \fCapplication/x-pkcs7-mime\fP.
2746 ** This is a format string, see the $$smime_decrypt_command command for
2747 ** possible \fCprintf(3)\fP-like sequences.
2752 { "smtp_authenticators", DT_STR, R_NONE, UL &SmtpAuthenticators, UL 0 },
2755 ** This is a colon-delimited list of authentication methods mutt may
2756 ** attempt to use to log in to an SMTP server, in the order mutt should
2757 ** try them. Authentication methods are any SASL mechanism, eg
2758 ** ``digest-md5'', ``gssapi'' or ``cram-md5''.
2759 ** This option is case-insensitive. If it is ``unset''
2760 ** (the default) mutt will try all available methods, in order from
2761 ** most-secure to least-secure.
2765 ** set smtp_authenticators="digest-md5:cram-md5"
2768 # endif /* USE_SASL */
2769 { "smtp_pass", DT_STR, R_NONE, UL &SmtpPass, UL 0 },
2772 ** Specifies the password for your SMTP account. If \fIunset\fP, Mutt will
2773 ** prompt you for your password when you first send mail via SMTP.
2774 ** See $$smtp_url to configure mutt to send mail via SMTP.
2776 ** \fBWarning\fP: you should only use this option when you are on a
2777 ** fairly secure machine, because the superuser can read your muttrc even
2778 ** if you are the only one who can read the file.
2780 { "smtp_url", DT_STR, R_NONE, UL &SmtpUrl, UL 0 },
2783 ** Defines the SMTP smarthost where sent messages should relayed for
2784 ** delivery. This should take the form of an SMTP URL, eg:
2786 ** smtp[s]://[user[:pass]@]host[:port]/
2789 ** where ``[...]'' denotes an optional part.
2790 ** Setting this variable overrides the value of the $$sendmail
2793 #endif /* USE_SMTP */
2794 { "sort", DT_SORT, R_INDEX|R_RESORT, UL &Sort, SORT_DATE },
2797 ** Specifies how to sort messages in the ``index'' menu. Valid values
2800 ** .dd date or date-sent
2801 ** .dd date-received
2803 ** .dd mailbox-order (unsorted)
2812 ** You may optionally use the ``reverse-'' prefix to specify reverse sorting
2813 ** order (example: ``\fCset sort=reverse-date-sent\fP'').
2815 { "sort_alias", DT_SORT|DT_SORT_ALIAS, R_NONE, UL &SortAlias, SORT_ALIAS },
2818 ** Specifies how the entries in the ``alias'' menu are sorted. The
2819 ** following are legal values:
2821 ** .dd address (sort alphabetically by email address)
2822 ** .dd alias (sort alphabetically by alias name)
2823 ** .dd unsorted (leave in order specified in .muttrc)
2826 { "sort_aux", DT_SORT|DT_SORT_AUX, R_INDEX|R_RESORT_BOTH, UL &SortAux, SORT_DATE },
2829 ** When sorting by threads, this variable controls how threads are sorted
2830 ** in relation to other threads, and how the branches of the thread trees
2831 ** are sorted. This can be set to any value that $$sort can, except
2832 ** ``threads'' (in that case, mutt will just use ``date-sent''). You can also
2833 ** specify the ``last-'' prefix in addition to the ``reverse-'' prefix, but ``last-''
2834 ** must come after ``reverse-''. The ``last-'' prefix causes messages to be
2835 ** sorted against its siblings by which has the last descendant, using
2836 ** the rest of $$sort_aux as an ordering. For instance,
2838 ** set sort_aux=last-date-received
2841 ** would mean that if a new message is received in a
2842 ** thread, that thread becomes the last one displayed (or the first, if
2843 ** you have ``\fCset sort=reverse-threads\fP''.)
2845 ** Note: For reversed $$sort
2846 ** order $$sort_aux is reversed again (which is not the right thing to do,
2847 ** but kept to not break any existing configuration setting).
2849 { "sort_browser", DT_SORT|DT_SORT_BROWSER, R_NONE, UL &BrowserSort, SORT_ALPHA },
2852 ** Specifies how to sort entries in the file browser. By default, the
2853 ** entries are sorted alphabetically. Valid values:
2855 ** .dd alpha (alphabetically)
2861 ** You may optionally use the ``reverse-'' prefix to specify reverse sorting
2862 ** order (example: ``\fCset sort_browser=reverse-date\fP'').
2864 { "sort_re", DT_BOOL, R_INDEX|R_RESORT|R_RESORT_INIT, OPTSORTRE, 1 },
2867 ** This variable is only useful when sorting by threads with
2868 ** $$strict_threads \fIunset\fP. In that case, it changes the heuristic
2869 ** mutt uses to thread messages by subject. With $$sort_re \fIset\fP, mutt will
2870 ** only attach a message as the child of another message by subject if
2871 ** the subject of the child message starts with a substring matching the
2872 ** setting of $$reply_regexp. With $$sort_re \fIunset\fP, mutt will attach
2873 ** the message whether or not this is the case, as long as the
2874 ** non-$$reply_regexp parts of both messages are identical.
2876 { "spam_separator", DT_STR, R_NONE, UL &SpamSep, UL "," },
2879 ** This variable controls what happens when multiple spam headers
2880 ** are matched: if \fIunset\fP, each successive header will overwrite any
2881 ** previous matches value for the spam label. If \fIset\fP, each successive
2882 ** match will append to the previous, using this variable's value as a
2885 { "spoolfile", DT_PATH, R_NONE, UL &Spoolfile, 0 },
2888 ** If your spool mailbox is in a non-default place where Mutt cannot find
2889 ** it, you can specify its location with this variable. Mutt will
2890 ** initially set this variable to the value of the environment
2891 ** variable \fC$$$MAIL\fP or \fC$$$MAILDIR\fP if either is defined.
2893 #if defined(USE_SSL)
2894 #ifdef USE_SSL_GNUTLS
2895 { "ssl_ca_certificates_file", DT_PATH, R_NONE, UL &SslCACertFile, 0 },
2898 ** This variable specifies a file containing trusted CA certificates.
2899 ** Any server certificate that is signed with one of these CA
2900 ** certificates is also automatically accepted.
2904 ** set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
2907 #endif /* USE_SSL_GNUTLS */
2908 { "ssl_client_cert", DT_PATH, R_NONE, UL &SslClientCert, 0 },
2911 ** The file containing a client certificate and its associated private
2914 { "ssl_force_tls", DT_BOOL, R_NONE, OPTSSLFORCETLS, 0 },
2917 ** If this variable is \fIset\fP, Mutt will require that all connections
2918 ** to remote servers be encrypted. Furthermore it will attempt to
2919 ** negotiate TLS even if the server does not advertise the capability,
2920 ** since it would otherwise have to abort the connection anyway. This
2921 ** option supersedes $$ssl_starttls.
2923 # ifdef USE_SSL_GNUTLS
2924 { "ssl_min_dh_prime_bits", DT_NUM, R_NONE, UL &SslDHPrimeBits, 0 },
2927 ** This variable specifies the minimum acceptable prime size (in bits)
2928 ** for use in any Diffie-Hellman key exchange. A value of 0 will use
2929 ** the default from the GNUTLS library.
2931 # endif /* USE_SSL_GNUTLS */
2932 { "ssl_starttls", DT_QUAD, R_NONE, OPT_SSLSTARTTLS, M_YES },
2935 ** If \fIset\fP (the default), mutt will attempt to use \fCSTARTTLS\fP on servers
2936 ** advertising the capability. When \fIunset\fP, mutt will not attempt to
2937 ** use \fCSTARTTLS\fP regardless of the server's capabilities.
2939 # ifdef USE_SSL_OPENSSL
2940 { "ssl_use_sslv2", DT_BOOL, R_NONE, OPTSSLV2, 0 },
2943 ** This variable specifies whether to attempt to use SSLv2 in the
2944 ** SSL authentication process.
2946 # endif /* defined USE_SSL_OPENSSL */
2947 { "ssl_use_sslv3", DT_BOOL, R_NONE, OPTSSLV3, 1 },
2950 ** This variable specifies whether to attempt to use SSLv3 in the
2951 ** SSL authentication process.
2953 { "ssl_use_tlsv1", DT_BOOL, R_NONE, OPTTLSV1, 1 },
2956 ** This variable specifies whether to attempt to use TLSv1 in the
2957 ** SSL authentication process.
2959 #ifdef USE_SSL_OPENSSL
2960 { "ssl_usesystemcerts", DT_BOOL, R_NONE, OPTSSLSYSTEMCERTS, 1 },
2963 ** If set to \fIyes\fP, mutt will use CA certificates in the
2964 ** system-wide certificate store when checking if a server certificate
2965 ** is signed by a trusted CA.
2968 { "ssl_verify_dates", DT_BOOL, R_NONE, OPTSSLVERIFYDATES, 1 },
2971 ** If \fIset\fP (the default), mutt will not automatically accept a server
2972 ** certificate that is either not yet valid or already expired. You should
2973 ** only unset this for particular known hosts, using the
2974 ** \fC$<account-hook>\fP function.
2976 { "ssl_verify_host", DT_BOOL, R_NONE, OPTSSLVERIFYHOST, 1 },
2979 ** If \fIset\fP (the default), mutt will not automatically accept a server
2980 ** certificate whose host name does not match the host used in your folder
2981 ** URL. You should only unset this for particular known hosts, using
2982 ** the \fC$<account-hook>\fP function.
2984 #endif /* defined(USE_SSL) */
2985 { "status_chars", DT_STR, R_BOTH, UL &StChars, UL "-*%A" },
2988 ** Controls the characters used by the ``%r'' indicator in
2989 ** $$status_format. The first character is used when the mailbox is
2990 ** unchanged. The second is used when the mailbox has been changed, and
2991 ** it needs to be resynchronized. The third is used if the mailbox is in
2992 ** read-only mode, or if the mailbox will not be written when exiting
2993 ** that mailbox (You can toggle whether to write changes to a mailbox
2994 ** with the \fC<toggle-write>\fP operation, bound by default to ``%''). The fourth
2995 ** is used to indicate that the current folder has been opened in attach-
2996 ** message mode (Certain operations like composing a new mail, replying,
2997 ** forwarding, etc. are not permitted in this mode).
2999 { "status_format", DT_STR, R_BOTH, UL &Status, UL "-%r-Mutt: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F? Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%s/%S)-%>-(%P)---" },
3002 ** Controls the format of the status line displayed in the ``index''
3003 ** menu. This string is similar to $$index_format, but has its own
3004 ** set of \fCprintf(3)\fP-like sequences:
3006 ** .dt %b .dd number of mailboxes with new mail *
3007 ** .dt %d .dd number of deleted messages *
3008 ** .dt %f .dd the full pathname of the current mailbox
3009 ** .dt %F .dd number of flagged messages *
3010 ** .dt %h .dd local hostname
3011 ** .dt %l .dd size (in bytes) of the current mailbox *
3012 ** .dt %L .dd size (in bytes) of the messages shown
3013 ** (i.e., which match the current limit) *
3014 ** .dt %m .dd the number of messages in the mailbox *
3015 ** .dt %M .dd the number of messages shown (i.e., which match the current limit) *
3016 ** .dt %n .dd number of new messages in the mailbox *
3017 ** .dt %o .dd number of old unread messages *
3018 ** .dt %p .dd number of postponed messages *
3019 ** .dt %P .dd percentage of the way through the index
3020 ** .dt %r .dd modified/read-only/won't-write/attach-message indicator,
3021 ** according to $$status_chars
3022 ** .dt %s .dd current sorting mode ($$sort)
3023 ** .dt %S .dd current aux sorting method ($$sort_aux)
3024 ** .dt %t .dd number of tagged messages *
3025 ** .dt %u .dd number of unread messages *
3026 ** .dt %v .dd Mutt version string
3027 ** .dt %V .dd currently active limit pattern, if any *
3028 ** .dt %>X .dd right justify the rest of the string and pad with ``X''
3029 ** .dt %|X .dd pad to the end of the line with ``X''
3030 ** .dt %*X .dd soft-fill with character ``X'' as pad
3033 ** For an explanation of ``soft-fill'', see the $$index_format documentation.
3035 ** * = can be optionally printed if nonzero
3037 ** Some of the above sequences can be used to optionally print a string
3038 ** if their value is nonzero. For example, you may only want to see the
3039 ** number of flagged messages if such messages exist, since zero is not
3040 ** particularly meaningful. To optionally print a string based upon one
3041 ** of the above sequences, the following construct is used:
3043 ** \fC%?<sequence_char>?<optional_string>?\fP
3045 ** where \fIsequence_char\fP is a character from the table above, and
3046 ** \fIoptional_string\fP is the string you would like printed if
3047 ** \fIsequence_char\fP is nonzero. \fIoptional_string\fP \fBmay\fP contain
3048 ** other sequences as well as normal text, but you may \fBnot\fP nest
3049 ** optional strings.
3051 ** Here is an example illustrating how to optionally print the number of
3052 ** new messages in a mailbox:
3054 ** \fC%?n?%n new messages.?\fP
3056 ** You can also switch between two strings using the following construct:
3058 ** \fC%?<sequence_char>?<if_string>&<else_string>?\fP
3060 ** If the value of \fIsequence_char\fP is non-zero, \fIif_string\fP will
3061 ** be expanded, otherwise \fIelse_string\fP will be expanded.
3063 ** You can force the result of any \fCprintf(3)\fP-like sequence to be lowercase
3064 ** by prefixing the sequence character with an underscore (``_'') sign.
3065 ** For example, if you want to display the local hostname in lowercase,
3066 ** you would use: ``\fC%_h\fP''.
3068 ** If you prefix the sequence character with a colon (``:'') character, mutt
3069 ** will replace any dots in the expansion by underscores. This might be helpful
3070 ** with IMAP folders that don't like dots in folder names.
3072 { "status_on_top", DT_BOOL, R_BOTH, OPTSTATUSONTOP, 0 },
3075 ** Setting this variable causes the ``status bar'' to be displayed on
3076 ** the first line of the screen rather than near the bottom. If $$help
3077 ** is \fIset\fP, too it'll be placed at the bottom.
3079 { "strict_threads", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTSTRICTTHREADS, 0 },
3082 ** If \fIset\fP, threading will only make use of the ``In-Reply-To'' and
3083 ** ``References:'' fields when you $$sort by message threads. By
3084 ** default, messages with the same subject are grouped together in
3085 ** ``pseudo threads.''. This may not always be desirable, such as in a
3086 ** personal mailbox where you might have several unrelated messages with
3087 ** the subjects like ``hi'' which will get grouped together. See also
3088 ** $$sort_re for a less drastic way of controlling this
3091 { "suspend", DT_BOOL, R_NONE, OPTSUSPEND, 1 },
3094 ** When \fIunset\fP, mutt won't stop when the user presses the terminal's
3095 ** \fIsusp\fP key, usually ``^Z''. This is useful if you run mutt
3096 ** inside an xterm using a command like ``\fCxterm -e mutt\fP''.
3098 { "text_flowed", DT_BOOL, R_NONE, OPTTEXTFLOWED, 0 },
3101 ** When \fIset\fP, mutt will generate ``format=flowed'' bodies with a content type
3102 ** of ``\fCtext/plain; format=flowed\fP''.
3103 ** This format is easier to handle for some mailing software, and generally
3104 ** just looks like ordinary text. To actually make use of this format's
3105 ** features, you'll need support in your editor.
3107 ** Note that $$indent_string is ignored when this option is \fIset\fP.
3109 { "thorough_search", DT_BOOL, R_NONE, OPTTHOROUGHSRC, 0 },
3112 ** Affects the \fC~b\fP and \fC~h\fP search operations described in
3113 ** section ``$patterns''. If \fIset\fP, the headers and body/attachments of
3114 ** messages to be searched are decoded before searching. If \fIunset\fP,
3115 ** messages are searched as they appear in the folder.
3117 ** Users searching attachments or for non-ASCII characters should \fIset\fP
3118 ** this value because decoding also includes MIME parsing/decoding and possible
3119 ** character set conversions. Otherwise mutt will attempt to match against the
3120 ** raw message received (for example quoted-printable encoded or with encoded
3121 ** headers) which may lead to incorrect search results.
3123 { "thread_received", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTTHREADRECEIVED, 0 },
3126 ** When \fIset\fP, mutt uses the date received rather than the date sent
3127 ** to thread messages by subject.
3129 { "tilde", DT_BOOL, R_PAGER, OPTTILDE, 0 },
3132 ** When \fIset\fP, the internal-pager will pad blank lines to the bottom of the
3133 ** screen with a tilde (``~'').
3135 { "time_inc", DT_NUM, R_NONE, UL &TimeInc, 0 },
3138 ** Along with $$read_inc, $$write_inc, and $$net_inc, this
3139 ** variable controls the frequency with which progress updates are
3140 ** displayed. It suppresses updates less than $$time_inc milliseconds
3141 ** apart. This can improve throughput on systems with slow terminals,
3142 ** or when running mutt on a remote system.
3144 ** Also see the ``$tuning'' section of the manual for performance considerations.
3146 { "timeout", DT_NUM, R_NONE, UL &Timeout, 600 },
3149 ** When Mutt is waiting for user input either idleing in menus or
3150 ** in an interactive prompt, Mutt would block until input is
3151 ** present. Depending on the context, this would prevent certain
3152 ** operations from working, like checking for new mail or keeping
3153 ** an IMAP connection alive.
3155 ** This variable controls how many seconds Mutt will at most wait
3156 ** until it aborts waiting for input, performs these operations and
3157 ** continues to wait for input.
3159 ** A value of zero or less will cause Mutt to never time out.
3161 { "tmpdir", DT_PATH, R_NONE, UL &Tempdir, 0 },
3164 ** This variable allows you to specify where Mutt will place its
3165 ** temporary files needed for displaying and composing messages. If
3166 ** this variable is not set, the environment variable \fC$$$TMPDIR\fP is
3167 ** used. If \fC$$$TMPDIR\fP is not set then ``\fC/tmp\fP'' is used.
3169 { "to_chars", DT_STR, R_BOTH, UL &Tochars, UL " +TCFL" },
3172 ** Controls the character used to indicate mail addressed to you. The
3173 ** first character is the one used when the mail is \fInot\fP addressed to your
3174 ** address. The second is used when you are the only
3175 ** recipient of the message. The third is when your address
3176 ** appears in the ``To:'' header field, but you are not the only recipient of
3177 ** the message. The fourth character is used when your
3178 ** address is specified in the ``Cc:'' header field, but you are not the only
3179 ** recipient. The fifth character is used to indicate mail that was sent
3180 ** by \fIyou\fP. The sixth character is used to indicate when a mail
3181 ** was sent to a mailing-list you subscribe to.
3184 { "tunnel", DT_STR, R_NONE, UL &Tunnel, UL 0 },
3187 ** Setting this variable will cause mutt to open a pipe to a command
3188 ** instead of a raw socket. You may be able to use this to set up
3189 ** preauthenticated connections to your IMAP/POP3/SMTP server. Example:
3191 ** set tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
3194 ** Note: For this example to work you must be able to log in to the remote
3195 ** machine without having to enter a password.
3197 ** When set, Mutt uses the tunnel for all remote connections.
3198 ** Please see ``$account-hook'' in the manual for how to use different
3199 ** tunnel commands per connection.
3202 { "uncollapse_jump", DT_BOOL, R_NONE, OPTUNCOLLAPSEJUMP, 0 },
3205 ** When \fIset\fP, Mutt will jump to the next unread message, if any,
3206 ** when the current thread is \fIun\fPcollapsed.
3208 { "use_8bitmime", DT_BOOL, R_NONE, OPTUSE8BITMIME, 0 },
3211 ** \fBWarning:\fP do not set this variable unless you are using a version
3212 ** of sendmail which supports the \fC-B8BITMIME\fP flag (such as sendmail
3213 ** 8.8.x) or you may not be able to send mail.
3215 ** When \fIset\fP, Mutt will invoke $$sendmail with the \fC-B8BITMIME\fP
3216 ** flag when sending 8-bit messages to enable ESMTP negotiation.
3218 { "use_domain", DT_BOOL, R_NONE, OPTUSEDOMAIN, 1 },
3221 ** When \fIset\fP, Mutt will qualify all local addresses (ones without the
3222 ** ``@host'' portion) with the value of $$hostname. If \fIunset\fP, no
3223 ** addresses will be qualified.
3225 { "use_envelope_from", DT_BOOL, R_NONE, OPTENVFROM, 0 },
3228 ** When \fIset\fP, mutt will set the \fIenvelope\fP sender of the message.
3229 ** If $$envelope_from_address is \fIset\fP, it will be used as the sender
3230 ** address. If \fIunset\fP, mutt will attempt to derive the sender from the
3231 ** ``From:'' header.
3233 ** Note that this information is passed to sendmail command using the
3234 ** \fC-f\fP command line switch. Therefore setting this option is not useful
3235 ** if the $$sendmail variable already contains \fC-f\fP or if the
3236 ** executable pointed to by $$sendmail doesn't support the \fC-f\fP switch.
3238 { "envelope_from", DT_SYN, R_NONE, UL "use_envelope_from", 0 },
3241 { "use_from", DT_BOOL, R_NONE, OPTUSEFROM, 1 },
3244 ** When \fIset\fP, Mutt will generate the ``From:'' header field when
3245 ** sending messages. If \fIunset\fP, no ``From:'' header field will be
3246 ** generated unless the user explicitly sets one using the ``$my_hdr''
3250 { "use_idn", DT_BOOL, R_BOTH, OPTUSEIDN, 1},
3253 ** When \fIset\fP, Mutt will show you international domain names decoded.
3254 ** Note: You can use IDNs for addresses even if this is \fIunset\fP.
3255 ** This variable only affects decoding.
3257 #endif /* HAVE_LIBIDN */
3258 #ifdef HAVE_GETADDRINFO
3259 { "use_ipv6", DT_BOOL, R_NONE, OPTUSEIPV6, 1},
3262 ** When \fIset\fP, Mutt will look for IPv6 addresses of hosts it tries to
3263 ** contact. If this option is \fIunset\fP, Mutt will restrict itself to IPv4 addresses.
3264 ** Normally, the default should work.
3266 #endif /* HAVE_GETADDRINFO */
3267 { "user_agent", DT_BOOL, R_NONE, OPTXMAILER, 1},
3270 ** When \fIset\fP, mutt will add a ``User-Agent:'' header to outgoing
3271 ** messages, indicating which version of mutt was used for composing
3274 { "visual", DT_PATH, R_NONE, UL &Visual, 0 },
3277 ** Specifies the visual editor to invoke when the ``\fC~v\fP'' command is
3278 ** given in the builtin editor.
3280 { "wait_key", DT_BOOL, R_NONE, OPTWAITKEY, 1 },
3283 ** Controls whether Mutt will ask you to press a key after an external command
3284 ** has been invoked by these functions: \fC<shell-escape>\fP,
3285 ** \fC<pipe-message>\fP, \fC<pipe-entry>\fP, \fC<print-message>\fP,
3286 ** and \fC<print-entry>\fP commands.
3288 ** It is also used when viewing attachments with ``$auto_view'', provided
3289 ** that the corresponding mailcap entry has a \fIneedsterminal\fP flag,
3290 ** and the external program is interactive.
3292 ** When \fIset\fP, Mutt will always ask for a key. When \fIunset\fP, Mutt will wait
3293 ** for a key only if the external command returned a non-zero status.
3295 { "weed", DT_BOOL, R_NONE, OPTWEED, 1 },
3298 ** When \fIset\fP, mutt will weed headers when displaying, forwarding,
3299 ** printing, or replying to messages.
3301 { "wrap", DT_NUM, R_PAGER, UL &Wrap, 0 },
3304 ** When set to a positive value, mutt will wrap text at $$wrap characters.
3305 ** When set to a negative value, mutt will wrap text so that there are $$wrap
3306 ** characters of empty space on the right side of the terminal.
3308 { "wrap_search", DT_BOOL, R_NONE, OPTWRAPSEARCH, 1 },
3311 ** Controls whether searches wrap around the end.
3313 ** When \fIset\fP, searches will wrap around the first (or last) item. When
3314 ** \fIunset\fP, incremental searches will not wrap.
3316 { "wrapmargin", DT_NUM, R_PAGER, UL &Wrap, 0 },
3319 ** (DEPRECATED) Equivalent to setting $$wrap with a negative value.
3321 { "write_bcc", DT_BOOL, R_NONE, OPTWRITEBCC, 1},
3324 ** Controls whether mutt writes out the ``Bcc:'' header when preparing
3325 ** messages to be sent. Exim users may wish to unset this. If mutt
3326 ** is set to deliver directly via SMTP (see $$smtp_url), this
3327 ** option does nothing: mutt will never write out the ``Bcc:'' header
3330 { "write_inc", DT_NUM, R_NONE, UL &WriteInc, 10 },
3333 ** When writing a mailbox, a message will be printed every
3334 ** $$write_inc messages to indicate progress. If set to 0, only a
3335 ** single message will be displayed before writing a mailbox.
3337 ** Also see the $$read_inc, $$net_inc and $$time_inc variables and the
3338 ** ``$tuning'' section of the manual for performance considerations.
3341 { NULL, 0, 0, 0, 0 }
3344 const struct mapping_t SortMethods[] = {
3345 { "date", SORT_DATE },
3346 { "date-sent", SORT_DATE },
3347 { "date-received", SORT_RECEIVED },
3348 { "mailbox-order", SORT_ORDER },
3349 { "subject", SORT_SUBJECT },
3350 { "from", SORT_FROM },
3351 { "size", SORT_SIZE },
3352 { "threads", SORT_THREADS },
3354 { "score", SORT_SCORE },
3355 { "spam", SORT_SPAM },
3359 /* same as SortMethods, but with "threads" replaced by "date" */
3361 const struct mapping_t SortAuxMethods[] = {
3362 { "date", SORT_DATE },
3363 { "date-sent", SORT_DATE },
3364 { "date-received", SORT_RECEIVED },
3365 { "mailbox-order", SORT_ORDER },
3366 { "subject", SORT_SUBJECT },
3367 { "from", SORT_FROM },
3368 { "size", SORT_SIZE },
3369 { "threads", SORT_DATE }, /* note: sort_aux == threads
3373 { "score", SORT_SCORE },
3374 { "spam", SORT_SPAM },
3379 const struct mapping_t SortBrowserMethods[] = {
3380 { "alpha", SORT_SUBJECT },
3381 { "date", SORT_DATE },
3382 { "size", SORT_SIZE },
3383 { "unsorted", SORT_ORDER },
3387 const struct mapping_t SortAliasMethods[] = {
3388 { "alias", SORT_ALIAS },
3389 { "address", SORT_ADDRESS },
3390 { "unsorted", SORT_ORDER },
3394 const struct mapping_t SortKeyMethods[] = {
3395 { "address", SORT_ADDRESS },
3396 { "date", SORT_DATE },
3397 { "keyid", SORT_KEYID },
3398 { "trust", SORT_TRUST },
3403 /* functions used to parse commands in a rc file */
3405 static int parse_list (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3406 static int parse_spam_list (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3407 static int parse_unlist (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3409 static int parse_group (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3410 static int parse_ungroup (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3412 static int parse_lists (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3413 static int parse_unlists (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3414 static int parse_alias (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3415 static int parse_unalias (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3416 static int parse_ignore (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3417 static int parse_unignore (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3418 static int parse_source (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3419 static int parse_set (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3420 static int parse_my_hdr (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3421 static int parse_unmy_hdr (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3422 static int parse_subscribe (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3423 static int parse_unsubscribe (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3424 static int parse_attachments (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3425 static int parse_unattachments (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3428 static int parse_alternates (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3429 static int parse_unalternates (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3431 /* Parse -group arguments */
3432 static int parse_group_context (group_context_t **ctx, BUFFER *buf, BUFFER *s, unsigned long data, BUFFER *err);
3438 int (*func) (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3442 struct command_t Commands[] = {
3443 { "alternates", parse_alternates, 0 },
3444 { "unalternates", parse_unalternates, 0 },
3446 { "account-hook", mutt_parse_hook, M_ACCOUNTHOOK },
3448 { "alias", parse_alias, 0 },
3449 { "attachments", parse_attachments, 0 },
3450 { "unattachments",parse_unattachments,0 },
3451 { "auto_view", parse_list, UL &AutoViewList },
3452 { "alternative_order", parse_list, UL &AlternativeOrderList},
3453 { "bind", mutt_parse_bind, 0 },
3454 { "charset-hook", mutt_parse_hook, M_CHARSETHOOK },
3456 { "color", mutt_parse_color, 0 },
3457 { "uncolor", mutt_parse_uncolor, 0 },
3459 { "exec", mutt_parse_exec, 0 },
3460 { "fcc-hook", mutt_parse_hook, M_FCCHOOK },
3461 { "fcc-save-hook", mutt_parse_hook, M_FCCHOOK | M_SAVEHOOK },
3462 { "folder-hook", mutt_parse_hook, M_FOLDERHOOK },
3463 { "group", parse_group, 0 },
3464 { "ungroup", parse_ungroup, 0 },
3465 { "hdr_order", parse_list, UL &HeaderOrderList },
3467 { "iconv-hook", mutt_parse_hook, M_ICONVHOOK },
3469 { "ignore", parse_ignore, 0 },
3470 { "lists", parse_lists, 0 },
3471 { "macro", mutt_parse_macro, 0 },
3472 { "mailboxes", mutt_parse_mailboxes, M_MAILBOXES },
3473 { "unmailboxes", mutt_parse_mailboxes, M_UNMAILBOXES },
3474 { "message-hook", mutt_parse_hook, M_MESSAGEHOOK },
3475 { "mbox-hook", mutt_parse_hook, M_MBOXHOOK },
3476 { "mime_lookup", parse_list, UL &MimeLookupList },
3477 { "unmime_lookup", parse_unlist, UL &MimeLookupList },
3478 { "mono", mutt_parse_mono, 0 },
3479 { "my_hdr", parse_my_hdr, 0 },
3480 { "pgp-hook", mutt_parse_hook, M_CRYPTHOOK },
3481 { "crypt-hook", mutt_parse_hook, M_CRYPTHOOK },
3482 { "push", mutt_parse_push, 0 },
3483 { "reply-hook", mutt_parse_hook, M_REPLYHOOK },
3484 { "reset", parse_set, M_SET_RESET },
3485 { "save-hook", mutt_parse_hook, M_SAVEHOOK },
3486 { "score", mutt_parse_score, 0 },
3487 { "send-hook", mutt_parse_hook, M_SENDHOOK },
3488 { "send2-hook", mutt_parse_hook, M_SEND2HOOK },
3489 { "set", parse_set, 0 },
3490 { "source", parse_source, 0 },
3491 { "spam", parse_spam_list, M_SPAM },
3492 { "nospam", parse_spam_list, M_NOSPAM },
3493 { "subscribe", parse_subscribe, 0 },
3494 { "toggle", parse_set, M_SET_INV },
3495 { "unalias", parse_unalias, 0 },
3496 { "unalternative_order",parse_unlist, UL &AlternativeOrderList },
3497 { "unauto_view", parse_unlist, UL &AutoViewList },
3498 { "unhdr_order", parse_unlist, UL &HeaderOrderList },
3499 { "unhook", mutt_parse_unhook, 0 },
3500 { "unignore", parse_unignore, 0 },
3501 { "unlists", parse_unlists, 0 },
3502 { "unmono", mutt_parse_unmono, 0 },
3503 { "unmy_hdr", parse_unmy_hdr, 0 },
3504 { "unscore", mutt_parse_unscore, 0 },
3505 { "unset", parse_set, M_SET_UNSET },
3506 { "unsubscribe", parse_unsubscribe, 0 },