2 * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
29 #define DT_BOOL 1 /* boolean option */
30 #define DT_NUM 2 /* a number */
31 #define DT_STR 3 /* a string */
32 #define DT_PATH 4 /* a pathname */
33 #define DT_QUAD 5 /* quad-option (yes/no/ask-yes/ask-no) */
34 #define DT_SORT 6 /* sorting methods */
35 #define DT_RX 7 /* regular expressions */
36 #define DT_MAGIC 8 /* mailbox type */
37 #define DT_SYN 9 /* synonym for another variable */
38 #define DT_ADDR 10 /* e-mail address */
40 #define DTYPE(x) ((x) & DT_MASK)
43 #define DT_SUBTYPE_MASK 0xf0
44 #define DT_SORT_ALIAS 0x10
45 #define DT_SORT_BROWSER 0x20
46 #define DT_SORT_KEYS 0x40
47 #define DT_SORT_AUX 0x80
49 /* flags to parse_set() */
50 #define M_SET_INV (1<<0) /* default is to invert all vars */
51 #define M_SET_UNSET (1<<1) /* default is to unset all vars */
52 #define M_SET_RESET (1<<2) /* default is to reset all vars to default */
54 /* forced redraw/resort types */
56 #define R_INDEX (1<<0)
57 #define R_PAGER (1<<1)
58 #define R_RESORT (1<<2) /* resort the mailbox */
59 #define R_RESORT_SUB (1<<3) /* resort subthreads */
60 #define R_RESORT_INIT (1<<4) /* resort from scratch */
61 #define R_TREE (1<<5) /* redraw the thread tree */
62 #define R_BOTH (R_INDEX | R_PAGER)
63 #define R_RESORT_BOTH (R_RESORT | R_RESORT_SUB)
71 unsigned long init; /* initial value */
74 #define UL (unsigned long)
79 #define ISPELL "ispell"
82 /* build complete documentation */
89 # define MIXMASTER "mixmaster"
100 # ifndef USE_LIBESMTP
101 # define USE_LIBESMTP
105 struct option_t MuttVars[] = {
107 { "abort_nosubject", DT_QUAD, R_NONE, OPT_SUBJECT, M_ASKYES },
110 ** If set to \fIyes\fP, when composing messages and no subject is given
111 ** at the subject prompt, composition will be aborted. If set to
112 ** \fIno\fP, composing messages with no subject given at the subject
113 ** prompt will never be aborted.
115 { "abort_unmodified", DT_QUAD, R_NONE, OPT_ABORT, M_YES },
118 ** If set to \fIyes\fP, composition will automatically abort after
119 ** editing the message body if no changes are made to the file (this
120 ** check only happens after the \fIfirst\fP edit of the file). When set
121 ** to \fIno\fP, composition will never be aborted.
123 { "alias_file", DT_PATH, R_NONE, UL &AliasFile, UL "~/.muttrc" },
126 ** The default file in which to save aliases created by the
127 ** ``$create-alias'' function.
129 ** \fBNote:\fP Mutt will not automatically source this file; you must
130 ** explicitly use the ``$source'' command for it to be executed.
132 { "alias_format", DT_STR, R_NONE, UL &AliasFmt, UL "%4n %2f %t %-10a %r" },
135 ** Specifies the format of the data displayed for the `alias' menu. The
136 ** following printf(3)-style sequences are available:
139 ** .dt %a .dd alias name
140 ** .dt %f .dd flags - currently, a "d" for an alias marked for deletion
141 ** .dt %n .dd index number
142 ** .dt %r .dd address which alias expands to
143 ** .dt %t .dd character which indicates if the alias is tagged for inclusion
146 { "allow_8bit", DT_BOOL, R_NONE, OPTALLOW8BIT, 1 },
149 ** Controls whether 8-bit data is converted to 7-bit using either Quoted-
150 ** Printable or Base64 encoding when sending mail.
152 { "allow_ansi", DT_BOOL, R_NONE, OPTALLOWANSI, 0 },
155 ** Controls whether ANSI color codes in messages (and color tags in
156 ** rich text messages) are to be interpreted.
157 ** Messages containing these codes are rare, but if this option is set,
158 ** their text will be colored accordingly. Note that this may override
159 ** your color choices, and even present a security problem, since a
160 ** message could include a line like "[-- PGP output follows ..." and
161 ** give it the same color as your attachment color.
163 { "arrow_cursor", DT_BOOL, R_BOTH, OPTARROWCURSOR, 0 },
166 ** When set, an arrow (``->'') will be used to indicate the current entry
167 ** in menus instead of highlighting the whole line. On slow network or modem
168 ** links this will make response faster because there is less that has to
169 ** be redrawn on the screen when moving to the next or previous entries
172 { "ascii_chars", DT_BOOL, R_BOTH, OPTASCIICHARS, 0 },
175 ** If set, Mutt will use plain ASCII characters when displaying thread
176 ** and attachment trees, instead of the default \fIACS\fP characters.
178 { "askbcc", DT_BOOL, R_NONE, OPTASKBCC, 0 },
181 ** If set, Mutt will prompt you for blind-carbon-copy (Bcc) recipients
182 ** before editing an outgoing message.
184 { "askcc", DT_BOOL, R_NONE, OPTASKCC, 0 },
187 ** If set, Mutt will prompt you for carbon-copy (Cc) recipients before
188 ** editing the body of an outgoing message.
191 { "ask_follow_up", DT_BOOL, R_NONE, OPTASKFOLLOWUP, 0 },
194 ** If set, Mutt will prompt you for follow-up groups before editing
195 ** the body of an outgoing message.
197 { "ask_x_comment_to", DT_BOOL, R_NONE, OPTASKXCOMMENTTO, 0 },
200 ** If set, Mutt will prompt you for x-comment-to field before editing
201 ** the body of an outgoing message.
204 { "attach_format", DT_STR, R_NONE, UL &AttachFormat, UL "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] " },
207 ** This variable describes the format of the `attachment' menu. The
208 ** following printf-style sequences are understood:
211 ** .dt %C .dd charset
212 ** .dt %c .dd reqiures charset conversion (n or c)
213 ** .dt %D .dd deleted flag
214 ** .dt %d .dd description
215 ** .dt %e .dd MIME content-transfer-encoding
216 ** .dt %f .dd filename
217 ** .dt %I .dd disposition (I=inline, A=attachment)
218 ** .dt %m .dd major MIME type
219 ** .dt %M .dd MIME subtype
220 ** .dt %n .dd attachment number
222 ** .dt %t .dd tagged flag
223 ** .dt %T .dd graphic tree characters
224 ** .dt %u .dd unlink (=to delete) flag
225 ** .dt %>X .dd right justify the rest of the string and pad with character "X"
226 ** .dt %|X .dd pad to the end of the line with character "X"
229 { "attach_sep", DT_STR, R_NONE, UL &AttachSep, UL "\n" },
232 ** The separator to add between attachments when operating (saving,
233 ** printing, piping, etc) on a list of tagged attachments.
235 { "attach_split", DT_BOOL, R_NONE, OPTATTACHSPLIT, 1 },
238 ** If this variable is unset, when operating (saving, printing, piping,
239 ** etc) on a list of tagged attachments, Mutt will concatenate the
240 ** attachments and will operate on them as a single attachment. The
241 ** ``$$attach_sep'' separator is added after each attachment. When set,
242 ** Mutt will operate on the attachments one by one.
244 { "attribution", DT_STR, R_NONE, UL &Attribution, UL "On %d, %n wrote:" },
247 ** This is the string that will precede a message which has been included
248 ** in a reply. For a full listing of defined printf()-like sequences see
249 ** the section on ``$$index_format''.
251 { "autoedit", DT_BOOL, R_NONE, OPTAUTOEDIT, 0 },
254 ** When set along with ``$$edit_headers'', Mutt will skip the initial
255 ** send-menu and allow you to immediately begin editing the body of your
256 ** message. The send-menu may still be accessed once you have finished
257 ** editing the body of your message.
259 ** Also see ``$$fast_reply''.
261 { "auto_tag", DT_BOOL, R_NONE, OPTAUTOTAG, 0 },
264 ** When set, functions in the \fIindex\fP menu which affect a message
265 ** will be applied to all tagged messages (if there are any). When
266 ** unset, you must first use the tag-prefix function (default: ";") to
267 ** make the next function apply to all tagged messages.
269 { "beep", DT_BOOL, R_NONE, OPTBEEP, 1 },
272 ** When this variable is set, mutt will beep when an error occurs.
274 { "beep_new", DT_BOOL, R_NONE, OPTBEEPNEW, 0 },
277 ** When this variable is set, mutt will beep whenever it prints a message
278 ** notifying you of new mail. This is independent of the setting of the
279 ** ``$$beep'' variable.
281 { "bounce", DT_QUAD, R_NONE, OPT_BOUNCE, M_ASKYES },
284 ** Controls whether you will be asked to confirm bouncing messages.
285 ** If set to \fIyes\fP you don't get asked if you want to bounce a
286 ** message. Setting this variable to \fIno\fP is not generally useful,
287 ** and thus not recommended, because you are unable to bounce messages.
289 { "bounce_delivered", DT_BOOL, R_NONE, OPTBOUNCEDELIVERED, 1 },
292 ** When this variable is set, mutt will include Delivered-To headers when
293 ** bouncing messages. Postfix users may wish to unset this variable.
296 { "catchup_newsgroup", DT_QUAD, R_NONE, OPT_CATCHUP, M_ASKYES },
299 ** If this variable is \fIset\fP, Mutt will mark all articles in newsgroup
300 ** as read when you quit the newsgroup (catchup newsgroup).
303 { "charset", DT_STR, R_NONE, UL &Charset, UL 0 },
306 ** Character set your terminal uses to display and enter textual data.
308 { "check_new", DT_BOOL, R_NONE, OPTCHECKNEW, 1 },
311 ** \fBNote:\fP this option only affects \fImaildir\fP and \fIMH\fP style
314 ** When \fIset\fP, Mutt will check for new mail delivered while the
315 ** mailbox is open. Especially with MH mailboxes, this operation can
316 ** take quite some time since it involves scanning the directory and
317 ** checking each file to see if it has already been looked at. If
318 ** \fIcheck_new\fP is \fIunset\fP, no check for new mail is performed
319 ** while the mailbox is open.
321 { "collapse_unread", DT_BOOL, R_NONE, OPTCOLLAPSEUNREAD, 1 },
324 ** When \fIunset\fP, Mutt will not collapse a thread if it contains any
327 { "uncollapse_jump", DT_BOOL, R_NONE, OPTUNCOLLAPSEJUMP, 0 },
330 ** When \fIset\fP, Mutt will jump to the next unread message, if any,
331 ** when the current thread is \fIun\fPcollapsed.
333 { "compose_format", DT_STR, R_BOTH, UL &ComposeFormat, UL "-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-" },
336 ** Controls the format of the status line displayed in the \fCompose\fP
337 ** menu. This string is similar to ``$$status_format'', but has its own
338 ** set of printf()-like sequences:
341 ** .dt %a .dd total number of attachments
342 ** .dt %h .dd local hostname
343 ** .dt %l .dd approximate size (in bytes) of the current message
344 ** .dt %v .dd Mutt version string
347 ** See the text describing the ``$$status_format'' option for more
348 ** information on how to set ``$$compose_format''.
350 { "confirmappend", DT_BOOL, R_NONE, OPTCONFIRMAPPEND, 1 },
353 ** When set, Mutt will prompt for confirmation when appending messages to
354 ** an existing mailbox.
356 { "confirmcreate", DT_BOOL, R_NONE, OPTCONFIRMCREATE, 1 },
359 ** When set, Mutt will prompt for confirmation when saving messages to a
360 ** mailbox which does not yet exist before creating it.
362 { "connect_timeout", DT_NUM, R_NONE, UL &ConnectTimeout, 30 },
365 ** Causes Mutt to timeout a network connection (for IMAP or POP) after this
366 ** many seconds if the connection is not able to be established. A negative
367 ** value causes Mutt to wait indefinitely for the connection to succeed.
369 { "content_type", DT_STR, R_NONE, UL &ContentType, UL "text/plain" },
372 ** Sets the default Content-Type for the body of newly composed messages.
374 { "copy", DT_QUAD, R_NONE, OPT_COPY, M_YES },
377 ** This variable controls whether or not copies of your outgoing messages
378 ** will be saved for later references. Also see ``$$record'',
379 ** ``$$save_name'', ``$$force_name'' and ``$fcc-hook''.
381 { "crypt_autopgp", DT_BOOL, R_NONE, OPTCRYPTAUTOPGP, 1 },
384 ** This variable controls whether or not mutt may automatically enable
385 ** PGP encryption/signing for messages. See also ``$$crypt_autoencrypt'',
386 ** ``$$crypt_replyencrypt'',
387 ** ``$$crypt_autosign'', ``$$crypt_replysign'' and ``$$smime_is_default''.
389 { "crypt_autosmime", DT_BOOL, R_NONE, OPTCRYPTAUTOSMIME, 1 },
392 ** This variable controls whether or not mutt may automatically enable
393 ** S/MIME encryption/signing for messages. See also ``$$crypt_autoencrypt'',
394 ** ``$$crypt_replyencrypt'',
395 ** ``$$crypt_autosign'', ``$$crypt_replysign'' and ``$$smime_is_default''.
397 { "date_format", DT_STR, R_BOTH, UL &DateFmt, UL "!%a, %b %d, %Y at %I:%M:%S%p %Z" },
400 ** This variable controls the format of the date printed by the ``%d''
401 ** sequence in ``$$index_format''. This is passed to the \fIstrftime\fP
402 ** call to process the date. See the man page for \fIstrftime(3)\fP for
403 ** the proper syntax.
405 ** Unless the first character in the string is a bang (``!''), the month
406 ** and week day names are expanded according to the locale specified in
407 ** the variable ``$$locale''. If the first character in the string is a
408 ** bang, the bang is discarded, and the month and week day names in the
409 ** rest of the string are expanded in the \fIC\fP locale (that is in US
412 { "default_hook", DT_STR, R_NONE, UL &DefaultHook, UL "~f %s !~P | (~P ~C %s)" },
415 ** This variable controls how send-hooks, message-hooks, save-hooks,
416 ** and fcc-hooks will
417 ** be interpreted if they are specified with only a simple regexp,
418 ** instead of a matching pattern. The hooks are expanded when they are
419 ** declared, so a hook will be interpreted according to the value of this
420 ** variable at the time the hook is declared. The default value matches
421 ** if the message is either from a user matching the regular expression
422 ** given, or if it is from you (if the from address matches
423 ** ``alternates'') and is to or cc'ed to a user matching the given
424 ** regular expression.
426 { "delete", DT_QUAD, R_NONE, OPT_DELETE, M_ASKYES },
429 ** Controls whether or not messages are really deleted when closing or
430 ** synchronizing a mailbox. If set to \fIyes\fP, messages marked for
431 ** deleting will automatically be purged without prompting. If set to
432 ** \fIno\fP, messages marked for deletion will be kept in the mailbox.
434 { "delete_untag", DT_BOOL, R_NONE, OPTDELETEUNTAG, 1 },
437 ** If this option is \fIset\fP, mutt will untag messages when marking them
438 ** for deletion. This applies when you either explicitly delete a message,
439 ** or when you save it to another folder.
441 { "digest_collapse", DT_BOOL, R_NONE, OPTDIGESTCOLLAPSE, 1},
444 ** If this option is \fIset\fP, mutt's revattach menu will not show the subparts of
445 ** individual messages in a digest. To see these subparts, press 'v' on that menu.
447 { "display_filter", DT_PATH, R_PAGER, UL &DisplayFilter, UL "" },
450 ** When set, specifies a command used to filter messages. When a message
451 ** is viewed it is passed as standard input to $$display_filter, and the
452 ** filtered message is read from the standard output.
454 #if defined(DL_STANDALONE) && defined(USE_DOTLOCK)
455 { "dotlock_program", DT_PATH, R_NONE, UL &MuttDotlock, UL BINDIR "/mutt_dotlock" },
458 ** Contains the path of the mutt_dotlock (8) binary to be used by
462 { "dsn_notify", DT_STR, R_NONE, UL &DsnNotify, UL "" },
465 ** \fBNote:\fP you should not enable this unless you are using Sendmail
468 ** This variable sets the request for when notification is returned. The
469 ** string consists of a comma separated list (no spaces!) of one or more
470 ** of the following: \fInever\fP, to never request notification,
471 ** \fIfailure\fP, to request notification on transmission failure,
472 ** \fIdelay\fP, to be notified of message delays, \fIsuccess\fP, to be
473 ** notified of successful transmission.
475 ** Example: set dsn_notify="failure,delay"
477 { "dsn_return", DT_STR, R_NONE, UL &DsnReturn, UL "" },
480 ** \fBNote:\fP you should not enable this unless you are using Sendmail
483 ** This variable controls how much of your message is returned in DSN
484 ** messages. It may be set to either \fIhdrs\fP to return just the
485 ** message header, or \fIfull\fP to return the full message.
487 ** Example: set dsn_return=hdrs
489 { "duplicate_threads", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTDUPTHREADS, 1 },
492 ** This variable controls whether mutt, when sorting by threads, threads
493 ** messages with the same message-id together. If it is set, it will indicate
494 ** that it thinks they are duplicates of each other with an equals sign
495 ** in the thread diagram.
497 { "edit_headers", DT_BOOL, R_NONE, OPTEDITHDRS, 0 },
500 ** This option allows you to edit the header of your outgoing messages
501 ** along with the body of your message.
503 { "edit_hdrs", DT_SYN, R_NONE, UL "edit_headers", 0 },
506 { "editor", DT_PATH, R_NONE, UL &Editor, 0 },
509 ** This variable specifies which editor is used by mutt.
510 ** It defaults to the value of the VISUAL, or EDITOR, environment
511 ** variable, or to the string "vi" if neither of those are set.
513 { "encode_from", DT_BOOL, R_NONE, OPTENCODEFROM, 0 },
516 ** When \fIset\fP, mutt will quoted-printable encode messages when
517 ** they contain the string "From " in the beginning of a line.
518 ** Useful to avoid the tampering certain mail delivery and transport
519 ** agents tend to do with messages.
521 { "envelope_from", DT_BOOL, R_NONE, OPTENVFROM, 0 },
524 ** When \fIset\fP, mutt will try to derive the message's \fIenvelope\fP
525 ** sender from the "From:" header. Note that this information is passed
526 ** to sendmail command using the "-f" command line switch, so don't set this
527 ** option if you are using that switch in $$sendmail yourself,
528 ** or if the sendmail on your machine doesn't support that command
531 { "escape", DT_STR, R_NONE, UL &EscChar, UL "~" },
534 ** Escape character to use for functions in the builtin editor.
536 { "fast_reply", DT_BOOL, R_NONE, OPTFASTREPLY, 0 },
539 ** When set, the initial prompt for recipients and subject are skipped
540 ** when replying to messages, and the initial prompt for subject is
541 ** skipped when forwarding messages.
543 ** \fBNote:\fP this variable has no effect when the ``$$autoedit''
546 { "fcc_attach", DT_BOOL, R_NONE, OPTFCCATTACH, 1 },
549 ** This variable controls whether or not attachments on outgoing messages
550 ** are saved along with the main body of your message.
552 { "fcc_clear", DT_BOOL, R_NONE, OPTFCCCLEAR, 0 },
555 ** When this variable is set, FCCs will be stored unencrypted and
556 ** unsigned, even when the actual message is encrypted and/or
560 { "folder", DT_PATH, R_NONE, UL &Maildir, UL "~/Mail" },
563 ** Specifies the default location of your mailboxes. A `+' or `=' at the
564 ** beginning of a pathname will be expanded to the value of this
565 ** variable. Note that if you change this variable from the default
566 ** value you need to make sure that the assignment occurs \fIbefore\fP
567 ** you use `+' or `=' for any other variables since expansion takes place
568 ** during the `set' command.
570 { "folder_format", DT_STR, R_INDEX, UL &FolderFormat, UL "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f" },
573 ** This variable allows you to customize the file browser display to your
574 ** personal taste. This string is similar to ``$$index_format'', but has
575 ** its own set of printf()-like sequences:
578 ** .dt %C .dd current file number
579 ** .dt %d .dd date/time folder was last modified
580 ** .dt %f .dd filename
581 ** .dt %F .dd file permissions
582 ** .dt %g .dd group name (or numeric gid, if missing)
583 ** .dt %l .dd number of hard links
584 ** .dt %N .dd N if folder has new mail, blank otherwise
585 ** .dt %s .dd size in bytes
586 ** .dt %t .dd * if the file is tagged, blank otherwise
587 ** .dt %u .dd owner name (or numeric uid, if missing)
588 ** .dt %>X .dd right justify the rest of the string and pad with character "X"
589 ** .dt %|X .dd pad to the end of the line with character "X"
592 { "followup_to", DT_BOOL, R_NONE, OPTFOLLOWUPTO, 1 },
595 ** Controls whether or not the \fIMail-Followup-To\fP header field is
596 ** generated when sending mail. When \fIset\fP, Mutt will generate this
597 ** field when you are replying to a known mailing list, specified with
598 ** the ``subscribe'' or ``$lists'' commands.
600 ** This field has two purposes. First, preventing you from
601 ** receiving duplicate copies of replies to messages which you send
602 ** to mailing lists, and second, ensuring that you do get a reply
603 ** separately for any messages sent to known lists to which you are
604 ** not subscribed. The header will contain only the list's address
605 ** for subscribed lists, and both the list address and your own
606 ** email address for unsubscribed lists. Without this header, a
607 ** group reply to your message sent to a subscribed list will be
608 ** sent to both the list and your address, resulting in two copies
609 ** of the same email for you.
612 { "followup_to_poster", DT_QUAD, R_NONE, OPT_FOLLOWUPTOPOSTER, M_ASKYES },
615 ** If this variable is \fIset\fP and the keyword "poster" is present in
616 ** \fIFollowup-To\fP header, follow-up to newsgroup function is not
617 ** permitted. The message will be mailed to the submitter of the
621 { "force_name", DT_BOOL, R_NONE, OPTFORCENAME, 0 },
624 ** This variable is similar to ``$$save_name'', except that Mutt will
625 ** store a copy of your outgoing message by the username of the address
626 ** you are sending to even if that mailbox does not exist.
628 ** Also see the ``$$record'' variable.
630 { "forward_decode", DT_BOOL, R_NONE, OPTFORWDECODE, 1 },
633 ** Controls the decoding of complex MIME messages into text/plain when
634 ** forwarding a message. The message header is also RFC2047 decoded.
635 ** This variable is only used, if ``$$mime_forward'' is \fIunset\fP,
636 ** otherwise ``$$mime_forward_decode'' is used instead.
638 { "forw_decode", DT_SYN, R_NONE, UL "forward_decode", 0 },
641 { "forward_edit", DT_QUAD, R_NONE, OPT_FORWEDIT, M_YES },
644 ** This quadoption controls whether or not the user is automatically
645 ** placed in the editor when forwarding messages. For those who always want
646 ** to forward with no modification, use a setting of ``no''.
648 { "forward_format", DT_STR, R_NONE, UL &ForwFmt, UL "[%a: %s]" },
651 ** This variable controls the default subject when forwarding a message.
652 ** It uses the same format sequences as the ``$$index_format'' variable.
654 { "forw_format", DT_SYN, R_NONE, UL "forward_format", 0 },
657 { "forward_quote", DT_BOOL, R_NONE, OPTFORWQUOTE, 0 },
660 ** When \fIset\fP forwarded messages included in the main body of the
661 ** message (when ``$$mime_forward'' is \fIunset\fP) will be quoted using
662 ** ``$$indent_string''.
664 { "forw_quote", DT_SYN, R_NONE, UL "forward_quote", 0 },
667 { "from", DT_ADDR, R_NONE, UL &From, UL 0 },
670 ** When set, this variable contains a default from address. It
671 ** can be overridden using my_hdr (including from send-hooks) and
672 ** ``$$reverse_name''. This variable is ignored if ``$$use_from''
675 ** Defaults to the contents of the environment variable EMAIL.
677 { "gecos_mask", DT_RX, R_NONE, UL &GecosMask, UL "^[^,]*" },
680 ** A regular expression used by mutt to parse the GECOS field of a password
681 ** entry when expanding the alias. By default the regular expression is set
682 ** to "^[^,]*" which will return the string up to the first "," encountered.
683 ** If the GECOS field contains a string like "lastname, firstname" then you
684 ** should set the gecos_mask=".*".
686 ** This can be useful if you see the following behavior: you address a e-mail
687 ** to user ID stevef whose full name is Steve Franklin. If mutt expands
688 ** stevef to "Franklin" stevef@foo.bar then you should set the gecos_mask to
689 ** a regular expression that will match the whole name so mutt will expand
690 ** "Franklin" to "Franklin, Steve".
693 { "group_index_format", DT_STR, R_BOTH, UL &GroupFormat, UL "%4C %M%N %5s %-45.45f %d" },
696 ** This variable allows you to customize the newsgroup browser display to
697 ** your personal taste. This string is similar to ``$index_format'', but
698 ** has its own set of printf()-like sequences:
701 ** %C current newsgroup number
702 ** %d description of newsgroup (becomes from server)
704 ** %M - if newsgroup not allowed for direct post (moderated for example)
705 ** %N N if newsgroup is new, u if unsubscribed, blank otherwise
706 ** %n number of new articles in newsgroup
707 ** %s number of unread articles in newsgroup
708 ** %>X right justify the rest of the string and pad with character "X"
709 ** %|X pad to the end of the line with character "X"
713 { "hdr_format", DT_SYN, R_NONE, UL "index_format", 0 },
716 { "hdrs", DT_BOOL, R_NONE, OPTHDRS, 1 },
719 ** When unset, the header fields normally added by the ``$my_hdr''
720 ** command are not created. This variable \fImust\fP be unset before
721 ** composing a new message or replying in order to take effect. If set,
722 ** the user defined header fields are added to every new message.
724 { "header", DT_BOOL, R_NONE, OPTHEADER, 0 },
727 ** When set, this variable causes Mutt to include the header
728 ** of the message you are replying to into the edit buffer.
729 ** The ``$$weed'' setting applies.
731 { "help", DT_BOOL, R_BOTH, OPTHELP, 1 },
734 ** When set, help lines describing the bindings for the major functions
735 ** provided by each menu are displayed on the first line of the screen.
737 ** \fBNote:\fP The binding will not be displayed correctly if the
738 ** function is bound to a sequence rather than a single keystroke. Also,
739 ** the help line may not be updated if a binding is changed while Mutt is
740 ** running. Since this variable is primarily aimed at new users, neither
741 ** of these should present a major problem.
743 { "hidden_host", DT_BOOL, R_NONE, OPTHIDDENHOST, 0 },
746 ** When set, mutt will skip the host name part of ``$$hostname'' variable
747 ** when adding the domain part to addresses. This variable does not
748 ** affect the generation of Message-IDs, and it will not lead to the
749 ** cut-off of first-level domains.
751 { "hide_limited", DT_BOOL, R_TREE|R_INDEX, OPTHIDELIMITED, 0 },
754 ** When set, mutt will not show the presence of messages that are hidden
755 ** by limiting, in the thread tree.
757 { "hide_missing", DT_BOOL, R_TREE|R_INDEX, OPTHIDEMISSING, 1 },
760 ** When set, mutt will not show the presence of missing messages in the
763 { "hide_top_limited", DT_BOOL, R_TREE|R_INDEX, OPTHIDETOPLIMITED, 0 },
766 ** When set, mutt will not show the presence of messages that are hidden
767 ** by limiting, at the top of threads in the thread tree. Note that when
768 ** $$hide_missing is set, this option will have no effect.
770 { "hide_top_missing", DT_BOOL, R_TREE|R_INDEX, OPTHIDETOPMISSING, 1 },
773 ** When set, mutt will not show the presence of missing messages at the
774 ** top of threads in the thread tree. Note that when $$hide_limited is
775 ** set, this option will have no effect.
777 { "history", DT_NUM, R_NONE, UL &HistSize, 10 },
780 ** This variable controls the size (in number of strings remembered) of
781 ** the string history buffer. The buffer is cleared each time the
784 { "honor_followup_to", DT_QUAD, R_NONE, OPT_MFUPTO, M_YES },
787 ** This variable controls whether or not a Mail-Followup-To header is
788 ** honored when group-replying to a message.
790 { "hostname", DT_STR, R_NONE, UL &Fqdn, 0 },
793 ** Specifies the hostname to use after the ``@'' in local e-mail
794 ** addresses. This overrides the compile time definition obtained from
797 { "ignore_list_reply_to", DT_BOOL, R_NONE, OPTIGNORELISTREPLYTO, 0 },
800 ** Affects the behaviour of the \fIreply\fP function when replying to
801 ** messages from mailing lists. When set, if the ``Reply-To:'' field is
802 ** set to the same value as the ``To:'' field, Mutt assumes that the
803 ** ``Reply-To:'' field was set by the mailing list to automate responses
804 ** to the list, and will ignore this field. To direct a response to the
805 ** mailing list when this option is set, use the \fIlist-reply\fP
806 ** function; \fIgroup-reply\fP will reply to both the sender and the
810 { "imap_authenticators", DT_STR, R_NONE, UL &ImapAuthenticators, UL 0 },
813 ** This is a colon-delimited list of authentication methods mutt may
814 ** attempt to use to log in to an IMAP server, in the order mutt should
815 ** try them. Authentication methods are either 'login' or the right
816 ** side of an IMAP 'AUTH=xxx' capability string, eg 'digest-md5',
817 ** 'gssapi' or 'cram-md5'. This parameter is case-insensitive. If this
818 ** parameter is unset (the default) mutt will try all available methods,
819 ** in order from most-secure to least-secure.
821 ** Example: set imap_authenticators="gssapi:cram-md5:login"
823 ** \fBNote:\fP Mutt will only fall back to other authentication methods if
824 ** the previous methods are unavailable. If a method is available but
825 ** authentication fails, mutt will not connect to the IMAP server.
827 { "imap_delim_chars", DT_STR, R_NONE, UL &ImapDelimChars, UL "/." },
830 ** This contains the list of characters which you would like to treat
831 ** as folder separators for displaying IMAP paths. In particular it
832 ** helps in using the '=' shortcut for your \fIfolder\fP variable.
835 { "imap_force_ssl", DT_BOOL, R_NONE, OPTIMAPFORCESSL, 0 },
838 ** If this variable is set, Mutt will always use SSL when
839 ** connecting to IMAP servers.
842 { "imap_home_namespace", DT_STR, R_NONE, UL &ImapHomeNamespace, UL 0},
845 ** You normally want to see your personal folders alongside
846 ** your INBOX in the IMAP browser. If you see something else, you may set
847 ** this variable to the IMAP path to your folders.
849 { "imap_keepalive", DT_NUM, R_NONE, UL &ImapKeepalive, 900 },
852 ** This variable specifies the maximum amount of time in seconds that mutt
853 ** will wait before polling open IMAP connections, to prevent the server
854 ** from closing them before mutt has finished with them. The default is
855 ** well within the RFC-specified minimum amount of time (30 minutes) before
856 ** a server is allowed to do this, but in practice the RFC does get
857 ** violated every now and then. Reduce this number if you find yourself
858 ** getting disconnected from your IMAP server due to inactivity.
860 { "imap_list_subscribed", DT_BOOL, R_NONE, OPTIMAPLSUB, 0 },
863 ** This variable configures whether IMAP folder browsing will look for
864 ** only subscribed folders or all folders. This can be toggled in the
865 ** IMAP browser with the \fItoggle-subscribed\fP function.
867 { "imap_pass", DT_STR, R_NONE, UL &ImapPass, UL 0 },
870 ** Specifies the password for your IMAP account. If unset, Mutt will
871 ** prompt you for your password when you invoke the fetch-mail function.
872 ** \fBWarning\fP: you should only use this option when you are on a
873 ** fairly secure machine, because the superuser can read your muttrc even
874 ** if you are the only one who can read the file.
876 { "imap_passive", DT_BOOL, R_NONE, OPTIMAPPASSIVE, 1 },
879 ** When set, mutt will not open new IMAP connections to check for new
880 ** mail. Mutt will only check for new mail over existing IMAP
881 ** connections. This is useful if you don't want to be prompted to
882 ** user/password pairs on mutt invocation, or if opening the connection
885 { "imap_peek", DT_BOOL, R_NONE, OPTIMAPPEEK, 1 },
888 ** If set, mutt will avoid implicitly marking your mail as read whenever
889 ** you fetch a message from the server. This is generally a good thing,
890 ** but can make closing an IMAP folder somewhat slower. This option
891 ** exists to appease speed freaks.
893 { "imap_servernoise", DT_BOOL, R_NONE, OPTIMAPSERVERNOISE, 1 },
896 ** When set, mutt will display warning messages from the IMAP
897 ** server as error messages. Since these messages are often
898 ** harmless, or generated due to configuration problems on the
899 ** server which are out of the users' hands, you may wish to suppress
900 ** them at some point.
902 { "imap_user", DT_STR, R_NONE, UL &ImapUser, UL 0 },
905 ** Your login name on the IMAP server.
907 ** This variable defaults to your user name on the local machine.
910 { "implicit_autoview", DT_BOOL,R_NONE, OPTIMPLICITAUTOVIEW, 0},
913 ** If set to ``yes'', mutt will look for a mailcap entry with the
914 ** copiousoutput flag set for \fIevery\fP MIME attachment it doesn't have
915 ** an internal viewer defined for. If such an entry is found, mutt will
916 ** use the viewer defined in that entry to convert the body part to text
919 { "include", DT_QUAD, R_NONE, OPT_INCLUDE, M_ASKYES },
922 ** Controls whether or not a copy of the message(s) you are replying to
923 ** is included in your reply.
925 { "indent_string", DT_STR, R_NONE, UL &Prefix, UL "> " },
928 ** Specifies the string to prepend to each line of text quoted in a
929 ** message to which you are replying. You are strongly encouraged not to
930 ** change this value, as it tends to agitate the more fanatical netizens.
932 { "indent_str", DT_SYN, R_NONE, UL "indent_string", 0 },
935 { "index_format", DT_STR, R_BOTH, UL &HdrFmt, UL "%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s" },
938 ** This variable allows you to customize the message index display to
939 ** your personal taste.
941 ** ``Format strings'' are similar to the strings used in the ``C''
942 ** function printf to format output (see the man page for more detail).
943 ** The following sequences are defined in Mutt:
946 ** .dt %a .dd address of the author
947 ** .dt %A .dd reply-to address (if present; otherwise: address of author)
948 ** .dt %b .dd filename of the original message folder (think mailBox)
949 ** .dt %B .dd the list to which the letter was sent, or else the folder name (%b).
950 ** .dt %c .dd number of characters (bytes) in the message
951 ** .dt %C .dd current message number
952 ** .dt %d .dd date and time of the message in the format specified by
953 ** ``date_format'' converted to sender's time zone
954 ** .dt %D .dd date and time of the message in the format specified by
955 ** ``date_format'' converted to the local time zone
956 ** .dt %e .dd current message number in thread
957 ** .dt %E .dd number of messages in current thread
958 ** .dt %f .dd entire From: line (address + real name)
959 ** .dt %F .dd author name, or recipient name if the message is from you
960 ** .dt %g .dd newsgroup name (if compiled with nntp support)
961 ** .dt %i .dd message-id of the current message
962 ** .dt %l .dd number of lines in the message (does not work with maildir,
963 ** mh, and possibly IMAP folders)
964 ** .dt %L .dd If an address in the To or CC header field matches an address
965 ** defined by the users ``subscribe'' command, this displays
966 ** "To <list-name>", otherwise the same as %F.
967 ** .dt %m .dd total number of message in the mailbox
968 ** .dt %M .dd number of hidden messages if the thread is collapsed.
969 ** .dt %N .dd message score
970 ** .dt %n .dd author's real name (or address if missing)
971 ** .dt %O .dd (_O_riginal save folder) Where mutt would formerly have
972 ** stashed the message: list name or recipient name if no list
973 ** .dt %s .dd subject of the message
974 ** .dt %S .dd status of the message (N/D/d/!/r/\(as)
975 ** .dt %t .dd `to:' field (recipients)
976 ** .dt %T .dd the appropriate character from the $$to_chars string
977 ** .dt %u .dd user (login) name of the author
978 ** .dt %v .dd first name of the author, or the recipient if the message is from you
979 ** .dt %W .dd name of organization of author (`organization:' field)
980 ** .dt %y .dd `x-label:' field, if present
981 ** .dt %Y .dd `x-label' field, if present, and (1) not at part of a thread tree,
982 ** (2) at the top of a thread, or (3) `x-label' is different from
983 ** preceding message's `x-label'.
984 ** .dt %Z .dd message status flags
985 ** .dt %{fmt} .dd the date and time of the message is converted to sender's
986 ** time zone, and ``fmt'' is expanded by the library function
987 ** ``strftime''; a leading bang disables locales
988 ** .dt %[fmt] .dd the date and time of the message is converted to the local
989 ** time zone, and ``fmt'' is expanded by the library function
990 ** ``strftime''; a leading bang disables locales
991 ** .dt %(fmt) .dd the local date and time when the message was received.
992 ** ``fmt'' is expanded by the library function ``strftime'';
993 ** a leading bang disables locales
994 ** .dt %<fmt> .dd the current local time. ``fmt'' is expanded by the library
995 ** function ``strftime''; a leading bang disables locales.
996 ** .dt %>X .dd right justify the rest of the string and pad with character "X"
997 ** .dt %|X .dd pad to the end of the line with character "X"
1000 ** See also: ``$$to_chars''.
1003 { "inews", DT_PATH, R_NONE, UL &Inews, UL "" },
1006 ** If set, specifies the program and arguments used to deliver news posted
1007 ** by Mutt. Otherwise, mutt posts article using current connection to
1008 ** news server. The following printf-style sequence is understood:
1011 ** %s newsserver name
1014 ** Example: set inews="/usr/local/bin/inews -hS"
1017 { "ispell", DT_PATH, R_NONE, UL &Ispell, UL ISPELL },
1020 ** How to invoke ispell (GNU's spell-checking software).
1022 { "keep_flagged", DT_BOOL, R_NONE, OPTKEEPFLAGGED, 0 },
1025 ** If set, read messages marked as flagged will not be moved
1026 ** from your spool mailbox to your ``$$mbox'' mailbox, or as a result of
1027 ** a ``$mbox-hook'' command.
1029 { "locale", DT_STR, R_BOTH, UL &Locale, UL "C" },
1032 ** The locale used by \fIstrftime(3)\fP to format dates. Legal values are
1033 ** the strings your system accepts for the locale variable \fILC_TIME\fP.
1035 { "list_reply", DT_QUAD, R_NONE, OPT_LISTREPLY, M_NO },
1038 ** When set, address replies to the mailing list the original message came
1039 ** from (instead to the author only). Setting this option to ``ask-yes'' or
1040 ** ``ask-no'' will ask if you really intended to reply to the author only.
1042 { "mail_check", DT_NUM, R_NONE, UL &BuffyTimeout, 5 },
1045 ** This variable configures how often (in seconds) mutt should look for
1048 { "mailcap_path", DT_STR, R_NONE, UL &MailcapPath, 0 },
1051 ** This variable specifies which files to consult when attempting to
1052 ** display MIME bodies not directly supported by Mutt.
1054 { "mailcap_sanitize", DT_BOOL, R_NONE, OPTMAILCAPSANITIZE, 1 },
1057 ** If set, mutt will restrict possible characters in mailcap % expandos
1058 ** to a well-defined set of safe characters. This is the safe setting,
1059 ** but we are not sure it doesn't break some more advanced MIME stuff.
1061 ** \fBDON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE
1064 { "maildir_trash", DT_BOOL, R_NONE, OPTMAILDIRTRASH, 0 },
1067 ** If set, messages marked as deleted will be saved with the maildir
1068 ** (T)rashed flag instead of unlinked. \fBNOTE:\fP this only applies
1069 ** to maildir-style mailboxes. Setting it will have no effect on other
1072 { "mark_old", DT_BOOL, R_BOTH, OPTMARKOLD, 1 },
1075 ** Controls whether or not mutt marks \fInew\fP \fBunread\fP
1076 ** messages as \fIold\fP if you exit a mailbox without reading them.
1077 ** With this option set, the next time you start mutt, the messages
1078 ** will show up with an "O" next to them in the index menu,
1079 ** indicating that they are old.
1081 { "markers", DT_BOOL, R_PAGER, OPTMARKERS, 1 },
1084 ** Controls the display of wrapped lines in the internal pager. If set, a
1085 ** ``+'' marker is displayed at the beginning of wrapped lines. Also see
1086 ** the ``$$smart_wrap'' variable.
1088 { "mask", DT_RX, R_NONE, UL &Mask, UL "!^\\.[^.]" },
1091 ** A regular expression used in the file browser, optionally preceded by
1092 ** the \fInot\fP operator ``!''. Only files whose names match this mask
1093 ** will be shown. The match is always case-sensitive.
1095 { "mbox", DT_PATH, R_BOTH, UL &Inbox, UL "~/mbox" },
1098 ** This specifies the folder into which read mail in your ``$$spoolfile''
1099 ** folder will be appended.
1101 { "sidebar_visible", DT_BOOL, R_BOTH, OPTMBOXPANE, 0 },
1104 ** This specifies whether or not to show the mailbox list pane.
1106 { "sidebar_width", DT_NUM, R_BOTH, UL &SidebarWidth, 0 },
1109 ** The width of the mailbox list pane (left sidebar like in GUIs).
1111 { "mbox_type", DT_MAGIC,R_NONE, UL &DefaultMagic, M_MBOX },
1114 ** The default mailbox type used when creating new folders. May be any of
1115 ** mbox, MMDF, MH and Maildir.
1117 { "metoo", DT_BOOL, R_NONE, OPTMETOO, 0 },
1120 ** If unset, Mutt will remove your address (see the ``alternates''
1121 ** command) from the list of recipients when replying to a message.
1123 { "menu_scroll", DT_BOOL, R_NONE, OPTMENUSCROLL, 0 },
1126 ** When \fIset\fP, menus will be scrolled up or down one line when you
1127 ** attempt to move across a screen boundary. If \fIunset\fP, the screen
1128 ** is cleared and the next or previous page of the menu is displayed
1129 ** (useful for slow links to avoid many redraws).
1131 { "meta_key", DT_BOOL, R_NONE, OPTMETAKEY, 0 },
1134 ** If set, forces Mutt to interpret keystrokes with the high bit (bit 8)
1135 ** set as if the user had pressed the ESC key and whatever key remains
1136 ** after having the high bit removed. For example, if the key pressed
1137 ** has an ASCII value of 0xf4, then this is treated as if the user had
1138 ** pressed ESC then ``x''. This is because the result of removing the
1139 ** high bit from ``0xf4'' is ``0x74'', which is the ASCII character
1142 { "mh_purge", DT_BOOL, R_NONE, OPTMHPURGE, 0 },
1145 ** When unset, mutt will mimic mh's behaviour and rename deleted messages
1146 ** to \fI,<old file name>\fP in mh folders instead of really deleting
1147 ** them. If the variable is set, the message files will simply be
1150 { "mh_seq_flagged", DT_STR, R_NONE, UL &MhFlagged, UL "flagged" },
1153 ** The name of the MH sequence used for flagged messages.
1155 { "mh_seq_replied", DT_STR, R_NONE, UL &MhReplied, UL "replied" },
1158 ** The name of the MH sequence used to tag replied messages.
1160 { "mh_seq_unseen", DT_STR, R_NONE, UL &MhUnseen, UL "unseen" },
1163 ** The name of the MH sequence used for unseen messages.
1165 { "mime_forward", DT_QUAD, R_NONE, OPT_MIMEFWD, M_NO },
1168 ** When set, the message you are forwarding will be attached as a
1169 ** separate MIME part instead of included in the main body of the
1170 ** message. This is useful for forwarding MIME messages so the receiver
1171 ** can properly view the message as it was delivered to you. If you like
1172 ** to switch between MIME and not MIME from mail to mail, set this
1173 ** variable to ask-no or ask-yes.
1175 ** Also see ``$$forward_decode'' and ``$$mime_forward_decode''.
1177 { "mime_forward_decode", DT_BOOL, R_NONE, OPTMIMEFORWDECODE, 0 },
1180 ** Controls the decoding of complex MIME messages into text/plain when
1181 ** forwarding a message while ``$$mime_forward'' is \fIset\fP. Otherwise
1182 ** ``$$forward_decode'' is used instead.
1184 { "mime_fwd", DT_SYN, R_NONE, UL "mime_forward", 0 },
1188 { "mime_forward_rest", DT_QUAD, R_NONE, OPT_MIMEFWDREST, M_YES },
1191 ** When forwarding multiple attachments of a MIME message from the recvattach
1192 ** menu, attachments which cannot be decoded in a reasonable manner will
1193 ** be attached to the newly composed message if this option is set.
1197 { "mime_subject", DT_BOOL, R_NONE, OPTMIMESUBJECT, 1 },
1200 ** If \fIunset\fP, 8-bit ``subject:'' line in article header will not be
1201 ** encoded according to RFC2047 to base64. This is useful when message
1202 ** is Usenet article, because MIME for news is nonstandard feature.
1207 { "mix_entry_format", DT_STR, R_NONE, UL &MixEntryFormat, UL "%4n %c %-16s %a" },
1210 ** This variable describes the format of a remailer line on the mixmaster
1211 ** chain selection screen. The following printf-like sequences are
1215 ** .dt %n .dd The running number on the menu.
1216 ** .dt %c .dd Remailer capabilities.
1217 ** .dt %s .dd The remailer's short name.
1218 ** .dt %a .dd The remailer's e-mail address.
1221 { "mixmaster", DT_PATH, R_NONE, UL &Mixmaster, UL MIXMASTER },
1224 ** This variable contains the path to the Mixmaster binary on your
1225 ** system. It is used with various sets of parameters to gather the
1226 ** list of known remailers, and to finally send a message through the
1232 { "move", DT_QUAD, R_NONE, OPT_MOVE, M_ASKNO },
1235 ** Controls whether you will be asked to confirm moving read messages
1236 ** from your spool mailbox to your ``$$mbox'' mailbox, or as a result of
1237 ** a ``$mbox-hook'' command.
1239 { "message_format", DT_STR, R_NONE, UL &MsgFmt, UL "%s" },
1242 ** This is the string displayed in the ``attachment'' menu for
1243 ** attachments of type message/rfc822. For a full listing of defined
1244 ** printf()-like sequences see the section on ``$$index_format''.
1246 { "msg_format", DT_SYN, R_NONE, UL "message_format", 0 },
1249 { "narrow_tree", DT_BOOL, R_TREE|R_INDEX, OPTNARROWTREE, 0 },
1252 ** This variable, when set, makes the thread tree narrower, allowing
1253 ** deeper threads to fit on the screen.
1256 { "news_cache_dir", DT_PATH, R_NONE, UL &NewsCacheDir, UL "~/.mutt" },
1259 ** This variable pointing to directory where Mutt will save cached news
1260 ** articles headers in. If \fIunset\fP, headers will not be saved at all
1261 ** and will be reloaded each time when you enter to newsgroup.
1263 { "news_server", DT_STR, R_NONE, UL &NewsServer, 0 },
1266 ** This variable specifies domain name or address of NNTP server. It
1267 ** defaults to the newsserver specified in the environment variable
1268 ** $$$NNTPSERVER or contained in the file /etc/nntpserver. You can also
1269 ** specify username and an alternative port for each newsserver, ie:
1271 ** [nntp[s]://][username[:password]@]newsserver[:port]
1273 { "newsrc", DT_PATH, R_NONE, UL &NewsRc, UL "~/.newsrc" },
1276 ** The file, containing info about subscribed newsgroups - names and
1277 ** indexes of read articles. The following printf-style sequence
1281 ** %s newsserver name
1284 { "nntp_context", DT_NUM, R_NONE, UL &NntpContext, 1000 },
1287 ** This variable defines number of articles which will be in index when
1288 ** newsgroup entered. If active newsgroup have more articles than this
1289 ** number, oldest articles will be ignored. Also controls how many
1290 ** articles headers will be saved in cache when you quit newsgroup.
1292 { "nntp_load_description", DT_BOOL, R_NONE, OPTLOADDESC, 1 },
1295 ** This variable controls whether or not descriptions for each newsgroup
1296 ** must be loaded when newsgroup is added to list (first time list
1297 ** loading or new newsgroup adding).
1299 { "nntp_user", DT_STR, R_NONE, UL &NntpUser, UL "" },
1302 ** Your login name on the NNTP server. If \fIunset\fP and NNTP server requires
1303 ** authentification, Mutt will prompt you for your account name when you
1304 ** connect to newsserver.
1306 { "nntp_pass", DT_STR, R_NONE, UL &NntpPass, UL "" },
1309 ** Your password for NNTP account.
1311 { "nntp_poll", DT_NUM, R_NONE, UL &NewsPollTimeout, 60 },
1314 ** The time in seconds until any operations on newsgroup except post new
1315 ** article will cause recheck for new news. If set to 0, Mutt will
1316 ** recheck newsgroup on each operation in index (stepping, read article,
1319 { "nntp_reconnect", DT_QUAD, R_NONE, OPT_NNTPRECONNECT, M_ASKYES },
1322 ** Controls whether or not Mutt will try to reconnect to newsserver when
1326 { "pager", DT_PATH, R_NONE, UL &Pager, UL "builtin" },
1329 ** This variable specifies which pager you would like to use to view
1330 ** messages. builtin means to use the builtin pager, otherwise this
1331 ** variable should specify the pathname of the external pager you would
1334 ** Using an external pager may have some disadvantages: Additional
1335 ** keystrokes are necessary because you can't call mutt functions
1336 ** directly from the pager, and screen resizes cause lines longer than
1337 ** the screen width to be badly formatted in the help menu.
1339 { "pager_context", DT_NUM, R_NONE, UL &PagerContext, 0 },
1342 ** This variable controls the number of lines of context that are given
1343 ** when displaying the next or previous page in the internal pager. By
1344 ** default, Mutt will display the line after the last one on the screen
1345 ** at the top of the next page (0 lines of context).
1347 { "pager_format", DT_STR, R_PAGER, UL &PagerFmt, UL "-%Z- %C/%m: %-20.20n %s" },
1350 ** This variable controls the format of the one-line message ``status''
1351 ** displayed before each message in either the internal or an external
1352 ** pager. The valid sequences are listed in the ``$$index_format''
1355 { "pager_index_lines",DT_NUM, R_PAGER, UL &PagerIndexLines, 0 },
1358 ** Determines the number of lines of a mini-index which is shown when in
1359 ** the pager. The current message, unless near the top or bottom of the
1360 ** folder, will be roughly one third of the way down this mini-index,
1361 ** giving the reader the context of a few messages before and after the
1362 ** message. This is useful, for example, to determine how many messages
1363 ** remain to be read in the current thread. One of the lines is reserved
1364 ** for the status bar from the index, so a \fIpager_index_lines\fP of 6
1365 ** will only show 5 lines of the actual index. A value of 0 results in
1366 ** no index being shown. If the number of messages in the current folder
1367 ** is less than \fIpager_index_lines\fP, then the index will only use as
1368 ** many lines as it needs.
1370 { "pager_stop", DT_BOOL, R_NONE, OPTPAGERSTOP, 0 },
1373 ** When set, the internal-pager will \fBnot\fP move to the next message
1374 ** when you are at the end of a message and invoke the \fInext-page\fP
1377 { "pgp_autosign", DT_SYN, R_NONE, UL "crypt_autosign", 0 },
1378 { "crypt_autosign", DT_BOOL, R_NONE, OPTCRYPTAUTOSIGN, 0 },
1381 ** Setting this variable will cause Mutt to always attempt to
1382 ** cryptographically sign outgoing messages. This can be overridden
1383 ** by use of the \fIpgp-menu\fP, when signing is not required or
1384 ** encryption is requested as well. If ``$$smime_is_default'' is set,
1385 ** then OpenSSL is used instead to create S/MIME messages and settings can
1386 ** be overridden by use of the \fIsmime-menu\fP.
1389 { "pgp_autoencrypt", DT_SYN, R_NONE, UL "crypt_autoencrypt", 0 },
1390 { "crypt_autoencrypt", DT_BOOL, R_NONE, OPTCRYPTAUTOENCRYPT, 0 },
1393 ** Setting this variable will cause Mutt to always attempt to PGP
1394 ** encrypt outgoing messages. This is probably only useful in
1395 ** connection to the \fIsend-hook\fP command. It can be overridden
1396 ** by use of the \fIpgp-menu\fP, when encryption is not required or
1397 ** signing is requested as well. IF ``$$smime_is_default'' is set,
1398 ** then OpenSSL is used instead to create S/MIME messages and
1399 ** settings can be overridden by use of the \fIsmime-menu\fP.
1402 { "pgp_ignore_subkeys", DT_BOOL, R_NONE, OPTPGPIGNORESUB, 1},
1405 ** Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead,
1406 ** the principal key will inherit the subkeys' capabilities. Unset this
1407 ** if you want to play interesting key selection games.
1410 { "pgp_replyencrypt", DT_SYN, R_NONE, UL "crypt_replyencrypt", 1 },
1411 { "crypt_replyencrypt", DT_BOOL, R_NONE, OPTCRYPTREPLYENCRYPT, 1 },
1414 ** If set, automatically PGP or OpenSSL encrypt replies to messages which are
1418 { "pgp_replysign", DT_SYN, R_NONE, UL "crypt_replysign", 0 },
1419 { "crypt_replysign", DT_BOOL, R_NONE, OPTCRYPTREPLYSIGN, 0 },
1422 ** If set, automatically PGP or OpenSSL sign replies to messages which are
1425 ** \fBNote:\fP this does not work on messages that are encrypted
1426 ** \fBand\fP signed!
1429 { "pgp_replysignencrypted", DT_SYN, R_NONE, UL "crypt_replysignencrypted", 0},
1430 { "crypt_replysignencrypted", DT_BOOL, R_NONE, OPTCRYPTREPLYSIGNENCRYPTED, 0 },
1433 ** If set, automatically PGP or OpenSSL sign replies to messages
1434 ** which are encrypted. This makes sense in combination with
1435 ** ``$$crypt_replyencrypt'', because it allows you to sign all
1436 ** messages which are automatically encrypted. This works around
1437 ** the problem noted in ``$$crypt_replysign'', that mutt is not able
1438 ** to find out whether an encrypted message is also signed.
1441 { "crypt_timestamp", DT_BOOL, R_NONE, OPTCRYPTTIMESTAMP, 1 },
1444 ** If set, mutt will include a time stamp in the lines surrounding
1445 ** PGP or S/MIME output, so spoofing such lines is more difficult.
1446 ** If you are using colors to mark these lines, and rely on these,
1447 ** you may unset this setting.
1450 { "pgp_use_gpg_agent", DT_BOOL, R_NONE, OPTUSEGPGAGENT, 0},
1453 ** If set, mutt will use a possibly-running gpg-agent process.
1456 { "pgp_verify_sig", DT_SYN, R_NONE, UL "crypt_verify_sig", 0},
1457 { "crypt_verify_sig", DT_QUAD, R_NONE, OPT_VERIFYSIG, M_YES },
1460 ** If ``yes'', always attempt to verify PGP or S/MIME signatures.
1461 ** If ``ask'', ask whether or not to verify the signature.
1462 ** If ``no'', never attempt to verify cryptographic signatures.
1465 { "smime_is_default", DT_BOOL, R_NONE, OPTSMIMEISDEFAULT, 0},
1468 ** The default behaviour of mutt is to use PGP on all auto-sign/encryption
1469 ** operations. To override and to use OpenSSL instead this must be set.
1470 ** However, this has no effect while replying, since mutt will automatically
1471 ** select the same application that was used to sign/encrypt the original
1472 ** message. (Note that this variable can be overridden by unsetting $$crypt_autosmime.)
1475 { "smime_ask_cert_label", DT_BOOL, R_NONE, OPTASKCERTLABEL, 1 },
1478 ** This flag controls whether you want to be asked to enter a label
1479 ** for a certificate about to be added to the database or not. It is
1483 { "smime_decrypt_use_default_key", DT_BOOL, R_NONE, OPTSDEFAULTDECRYPTKEY, 1 },
1486 ** If set (default) this tells mutt to use the default key for decryption. Otherwise,
1487 ** if manage multiple certificate-key-pairs, mutt will try to use the mailbox-address
1488 ** to determine the key to use. It will ask you to supply a key, if it can't find one.
1491 { "pgp_entry_format", DT_STR, R_NONE, UL &PgpEntryFormat, UL "%4n %t%f %4l/0x%k %-4a %2c %u" },
1494 ** This variable allows you to customize the PGP key selection menu to
1495 ** your personal taste. This string is similar to ``$$index_format'', but
1496 ** has its own set of printf()-like sequences:
1499 ** .dt %n .dd number
1500 ** .dt %k .dd key id
1501 ** .dt %u .dd user id
1502 ** .dt %a .dd algorithm
1503 ** .dt %l .dd key length
1505 ** .dt %c .dd capabilities
1506 ** .dt %t .dd trust/validity of the key-uid association
1507 ** .dt %[<s>] .dd date of the key where <s> is an strftime(3) expression
1512 { "pgp_good_sign", DT_RX, R_NONE, UL &PgpGoodSign, 0 },
1515 ** If you assign a text to this variable, then a PGP signature is only
1516 ** considered verified if the output from $$pgp_verify_command contains
1517 ** the text. Use this variable if the exit code from the command is 0
1518 ** even for bad signatures.
1521 { "pgp_check_exit", DT_BOOL, R_NONE, OPTPGPCHECKEXIT, 1 },
1524 ** If set, mutt will check the exit code of the PGP subprocess when
1525 ** signing or encrypting. A non-zero exit code means that the
1526 ** subprocess failed.
1529 { "pgp_long_ids", DT_BOOL, R_NONE, OPTPGPLONGIDS, 0 },
1532 ** If set, use 64 bit PGP key IDs. Unset uses the normal 32 bit Key IDs.
1535 { "pgp_retainable_sigs", DT_BOOL, R_NONE, OPTPGPRETAINABLESIG, 0 },
1538 ** If set, signed and encrypted messages will consist of nested
1539 ** multipart/signed and multipart/encrypted body parts.
1541 ** This is useful for applications like encrypted and signed mailing
1542 ** lists, where the outer layer (multipart/encrypted) can be easily
1543 ** removed, while the inner multipart/signed part is retained.
1546 { "pgp_show_unusable", DT_BOOL, R_NONE, OPTPGPSHOWUNUSABLE, 1 },
1549 ** If set, mutt will display non-usable keys on the PGP key selection
1550 ** menu. This includes keys which have been revoked, have expired, or
1551 ** have been marked as ``disabled'' by the user.
1554 { "pgp_sign_as", DT_STR, R_NONE, UL &PgpSignAs, 0 },
1557 ** If you have more than one key pair, this option allows you to specify
1558 ** which of your private keys to use. It is recommended that you use the
1559 ** keyid form to specify your key (e.g., ``0x00112233'').
1562 { "pgp_strict_enc", DT_BOOL, R_NONE, OPTPGPSTRICTENC, 1 },
1565 ** If set, Mutt will automatically encode PGP/MIME signed messages as
1566 ** \fIquoted-printable\fP. Please note that unsetting this variable may
1567 ** lead to problems with non-verifyable PGP signatures, so only change
1568 ** this if you know what you are doing.
1571 { "pgp_timeout", DT_NUM, R_NONE, UL &PgpTimeout, 300 },
1574 ** The number of seconds after which a cached passphrase will expire if
1578 { "pgp_sort_keys", DT_SORT|DT_SORT_KEYS, R_NONE, UL &PgpSortKeys, SORT_ADDRESS },
1581 ** Specifies how the entries in the `pgp keys' menu are sorted. The
1582 ** following are legal values:
1585 ** .dt address .dd sort alphabetically by user id
1586 ** .dt keyid .dd sort alphabetically by key id
1587 ** .dt date .dd sort by key creation date
1588 ** .dt trust .dd sort by the trust of the key
1591 ** If you prefer reverse order of the above values, prefix it with
1595 { "pgp_create_traditional", DT_QUAD, R_NONE, OPT_PGPTRADITIONAL, M_NO },
1598 ** This option controls whether Mutt generates old-style inline PGP
1599 ** encrypted or signed messages.
1601 ** Note that PGP/MIME will be used automatically for messages which have
1602 ** a character set different from us-ascii, or which consist of more than
1603 ** a single MIME part.
1605 ** Also note that using the old-style PGP message format is \fBstrongly\fP
1606 ** \fBdeprecated\fP.
1609 { "pgp_auto_traditional", DT_BOOL, R_NONE, OPTPGPAUTOTRAD, 0 },
1612 ** This option causes Mutt to generate an old-style inline PGP
1613 ** encrypted or signed message when replying to an old-style
1614 ** message, and a PGP/MIME message when replying to a PGP/MIME
1615 ** message. Note that this option is only meaningful when using
1616 ** ``$$crypt_replyencrypt'', ``$$crypt_replysign'', or
1617 ** ``$$crypt_replysignencrypted''.
1619 ** Also note that PGP/MIME will be used automatically for messages
1620 ** which have a character set different from us-ascii, or which
1621 ** consist of more than a single MIME part.
1623 ** This option overrides ``$$pgp_create_traditional''
1627 /* XXX Default values! */
1629 { "pgp_decode_command", DT_STR, R_NONE, UL &PgpDecodeCommand, 0},
1632 ** This format strings specifies a command which is used to decode
1633 ** application/pgp attachments.
1635 ** The PGP command formats have their own set of printf-like sequences:
1638 ** .dt %p .dd Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty
1639 ** string otherwise. Note: This may be used with a %? construct.
1640 ** .dt %f .dd Expands to the name of a file containing a message.
1641 ** .dt %s .dd Expands to the name of a file containing the signature part
1642 ** . of a multipart/signed attachment when verifying it.
1643 ** .dt %a .dd The value of $$pgp_sign_as.
1644 ** .dt %r .dd One or more key IDs.
1647 ** For examples on how to configure these formats for the various versions
1648 ** of PGP which are floating around, see the pgp*.rc and gpg.rc files in
1649 ** the samples/ subdirectory which has been installed on your system
1650 ** alongside the documentation.
1653 { "pgp_getkeys_command", DT_STR, R_NONE, UL &PgpGetkeysCommand, 0},
1656 ** This command is invoked whenever mutt will need public key information.
1657 ** %r is the only printf-like sequence used with this format.
1660 { "pgp_verify_command", DT_STR, R_NONE, UL &PgpVerifyCommand, 0},
1663 ** This command is used to verify PGP signatures.
1666 { "pgp_decrypt_command", DT_STR, R_NONE, UL &PgpDecryptCommand, 0},
1669 ** This command is used to decrypt a PGP encrypted message.
1672 { "pgp_clearsign_command", DT_STR, R_NONE, UL &PgpClearSignCommand, 0 },
1675 ** This format is used to create a old-style "clearsigned" PGP
1676 ** message. Note that the use of this format is \fBstrongly\fP
1677 ** \fBdeprecated\fP.
1680 { "pgp_sign_command", DT_STR, R_NONE, UL &PgpSignCommand, 0},
1683 ** This command is used to create the detached PGP signature for a
1684 ** multipart/signed PGP/MIME body part.
1687 { "pgp_encrypt_sign_command", DT_STR, R_NONE, UL &PgpEncryptSignCommand, 0},
1690 ** This command is used to both sign and encrypt a body part.
1693 { "pgp_encrypt_only_command", DT_STR, R_NONE, UL &PgpEncryptOnlyCommand, 0},
1696 ** This command is used to encrypt a body part without signing it.
1699 { "pgp_import_command", DT_STR, R_NONE, UL &PgpImportCommand, 0},
1702 ** This command is used to import a key from a message into
1703 ** the user's public key ring.
1706 { "pgp_export_command", DT_STR, R_NONE, UL &PgpExportCommand, 0},
1709 ** This command is used to export a public key from the user's
1713 { "pgp_verify_key_command", DT_STR, R_NONE, UL &PgpVerifyKeyCommand, 0},
1716 ** This command is used to verify key information from the key selection
1720 { "pgp_list_secring_command", DT_STR, R_NONE, UL &PgpListSecringCommand, 0},
1723 ** This command is used to list the secret key ring's contents. The
1724 ** output format must be analogous to the one used by
1725 ** gpg --list-keys --with-colons.
1727 ** This format is also generated by the pgpring utility which comes
1731 { "pgp_list_pubring_command", DT_STR, R_NONE, UL &PgpListPubringCommand, 0},
1734 ** This command is used to list the public key ring's contents. The
1735 ** output format must be analogous to the one used by
1736 ** gpg --list-keys --with-colons.
1738 ** This format is also generated by the pgpring utility which comes
1742 { "forward_decrypt", DT_BOOL, R_NONE, OPTFORWDECRYPT, 1 },
1745 ** Controls the handling of encrypted messages when forwarding a message.
1746 ** When set, the outer layer of encryption is stripped off. This
1747 ** variable is only used if ``$$mime_forward'' is \fIset\fP and
1748 ** ``$$mime_forward_decode'' is \fIunset\fP.
1751 { "forw_decrypt", DT_SYN, R_NONE, UL "forward_decrypt", 0 },
1755 { "smime_timeout", DT_NUM, R_NONE, UL &SmimeTimeout, 300 },
1758 ** The number of seconds after which a cached passphrase will expire if
1762 { "smime_encrypt_with", DT_STR, R_NONE, UL &SmimeCryptAlg, 0 },
1765 ** This sets the algorithm that should be used for encryption.
1766 ** Valid choices are "des", "des3", "rc2-40", "rc2-64", "rc2-128".
1767 ** If unset "3des" (TripleDES) is used.
1770 { "smime_keys", DT_PATH, R_NONE, UL &SmimeKeys, 0 },
1773 ** Since there is no pubring/secring as with PGP, mutt has to handle
1774 ** storage ad retrieval of keys/certs by itself. This is very basic right now,
1775 ** and stores keys and certificates in two different directories, both
1776 ** named as the hash-value retrieved from OpenSSL. There is an index file
1777 ** which contains mailbox-address keyid pair, and which can be manually
1778 ** edited. This one points to the location of the private keys.
1781 { "smime_ca_location", DT_PATH, R_NONE, UL &SmimeCALocation, 0 },
1784 ** This variable contains the name of either a directory, or a file which
1785 ** contains trusted certificates for use with OpenSSL.
1788 { "smime_certificates", DT_PATH, R_NONE, UL &SmimeCertificates, 0 },
1791 ** Since there is no pubring/secring as with PGP, mutt has to handle
1792 ** storage and retrieval of keys by itself. This is very basic right
1793 ** now, and keys and certificates are stored in two different
1794 ** directories, both named as the hash-value retrieved from
1795 ** OpenSSL. There is an index file which contains mailbox-address
1796 ** keyid pairs, and which can be manually edited. This one points to
1797 ** the location of the certificates.
1800 { "smime_decrypt_command", DT_STR, R_NONE, UL &SmimeDecryptCommand, 0},
1803 ** This format string specifies a command which is used to decrypt
1804 ** application/x-pkcs7-mime attachments.
1806 ** The OpenSSL command formats have their own set of printf-like sequences
1807 ** similar to PGP's:
1810 ** .dt %f .dd Expands to the name of a file containing a message.
1811 ** .dt %s .dd Expands to the name of a file containing the signature part
1812 ** . of a multipart/signed attachment when verifying it.
1813 ** .dt %k .dd The key-pair specified with $$smime_default_key
1814 ** .dt %c .dd One or more certificate IDs.
1815 ** .dt %a .dd The algorithm used for encryption.
1816 ** .dt %C .dd CA location: Depending on whether $$smime_ca_location
1817 ** . points to a directory or file, this expands to
1818 ** . "-CApath $$smime_ca_location" or "-CAfile $$smime_ca_location".
1821 ** For examples on how to configure these formats, see the smime.rc in
1822 ** the samples/ subdirectory which has been installed on your system
1823 ** alongside the documentation.
1826 { "smime_verify_command", DT_STR, R_NONE, UL &SmimeVerifyCommand, 0},
1829 ** This command is used to verify S/MIME signatures of type multipart/signed.
1832 { "smime_verify_opaque_command", DT_STR, R_NONE, UL &SmimeVerifyOpaqueCommand, 0},
1835 ** This command is used to verify S/MIME signatures of type
1836 ** application/x-pkcs7-mime.
1839 { "smime_sign_command", DT_STR, R_NONE, UL &SmimeSignCommand, 0},
1842 ** This command is used to created S/MIME signatures of type
1843 ** multipart/signed, which can be read by all mail clients.
1846 { "smime_sign_opaque_command", DT_STR, R_NONE, UL &SmimeSignOpaqueCommand, 0},
1849 ** This command is used to created S/MIME signatures of type
1850 ** application/x-pkcs7-signature, which can only be handled by mail
1851 ** clients supporting the S/MIME extension.
1854 { "smime_encrypt_command", DT_STR, R_NONE, UL &SmimeEncryptCommand, 0},
1857 ** This command is used to create encrypted S/MIME messages.
1860 { "smime_pk7out_command", DT_STR, R_NONE, UL &SmimePk7outCommand, 0},
1863 ** This command is used to extract PKCS7 structures of S/MIME signatures,
1864 ** in order to extract the public X509 certificate(s).
1867 { "smime_get_cert_command", DT_STR, R_NONE, UL &SmimeGetCertCommand, 0},
1870 ** This command is used to extract X509 certificates from a PKCS7 structure.
1873 { "smime_get_signer_cert_command", DT_STR, R_NONE, UL &SmimeGetSignerCertCommand, 0},
1876 ** This command is used to extract only the signers X509 certificate from a S/MIME
1877 ** signature, so that the certificate's owner may get compared to the email's
1881 { "smime_import_cert_command", DT_STR, R_NONE, UL &SmimeImportCertCommand, 0},
1884 ** This command is used to import a certificate via smime_keys.
1887 { "smime_get_cert_email_command", DT_STR, R_NONE, UL &SmimeGetCertEmailCommand, 0},
1890 ** This command is used to extract the mail address(es) used for storing
1891 ** X509 certificates, and for verification purposes (to check whether the
1892 ** certificate was issued for the sender's mailbox).
1895 { "smime_sign_as", DT_SYN, R_NONE, UL "smime_default_key", 0 },
1896 { "smime_default_key", DT_STR, R_NONE, UL &SmimeDefaultKey, 0 },
1899 ** This is the default key-pair to use for signing. This must be set to the
1900 ** keyid (the hash-value that OpenSSL generates) to work properly
1903 #if defined(USE_LIBESMTP)
1904 { "smtp_auth_username", DT_STR, R_NONE, UL &SmtpAuthUser, 0 },
1907 ** Defines the username to use with SMTP AUTH. Setting this variable will
1908 ** cause mutt to attempt to use SMTP AUTH when sending.
1910 { "smtp_auth_password", DT_STR, R_NONE, UL &SmtpAuthPass, 0 },
1913 ** Defines the password to use with SMTP AUTH. If ``$$smtp_auth_username''
1914 ** is set, but this variable is not, you will be prompted for a password
1917 { "smtp_host", DT_STR, R_NONE, UL &SmtpHost, 0 },
1920 ** Defines the SMTP host which will be used to deliver mail, as opposed
1921 ** to invoking the sendmail binary. Setting this variable overrides the
1922 ** value of ``$$sendmail'', and any associated variables.
1924 { "smtp_port", DT_NUM, R_NONE, UL &SmtpPort, 25 },
1927 ** Defines the port that the SMTP host is listening on for mail delivery.
1928 ** Must be specified as a number.
1930 ** Defaults to 25, the standard SMTP port, but RFC 2476-compliant SMTP
1931 ** servers will probably desire 587, the mail submission port.
1935 #if defined(USE_SSL)||defined(USE_NSS)
1937 { "ssl_starttls", DT_QUAD, R_NONE, OPT_SSLSTARTTLS, M_YES },
1940 ** If set (the default), mutt will attempt to use STARTTLS on servers
1941 ** advertising the capability. When unset, mutt will not attempt to
1942 ** use STARTTLS regardless of the server's capabilities.
1945 { "certificate_file", DT_PATH, R_NONE, UL &SslCertFile, 0 },
1948 ** This variable specifies the file where the certificates you trust
1949 ** are saved. When an unknown certificate is encountered, you are asked
1950 ** if you accept it or not. If you accept it, the certificate can also
1951 ** be saved in this file and further connections are automatically
1954 ** You can also manually add CA certificates in this file. Any server
1955 ** certificate that is signed with one of these CA certificates are
1956 ** also automatically accepted.
1958 ** Example: set certificate_file=~/.mutt/certificates
1960 { "ssl_usesystemcerts", DT_BOOL, R_NONE, OPTSSLSYSTEMCERTS, 1 },
1963 ** If set to \fIyes\fP, mutt will use CA certificates in the
1964 ** system-wide certificate store when checking if server certificate
1965 ** is signed by a trusted CA.
1967 { "entropy_file", DT_PATH, R_NONE, UL &SslEntropyFile, 0 },
1970 ** The file which includes random data that is used to initialize SSL
1971 ** library functions.
1973 { "ssl_use_sslv2", DT_BOOL, R_NONE, OPTSSLV2, 1 },
1976 ** This variables specifies whether to attempt to use SSLv2 in the
1977 ** SSL authentication process.
1979 { "ssl_use_sslv3", DT_BOOL, R_NONE, OPTSSLV3, 1 },
1982 ** This variables specifies whether to attempt to use SSLv3 in the
1983 ** SSL authentication process.
1985 { "ssl_use_tlsv1", DT_BOOL, R_NONE, OPTTLSV1, 1 },
1988 ** This variables specifies whether to attempt to use TLSv1 in the
1989 ** SSL authentication process.
1993 { "pipe_split", DT_BOOL, R_NONE, OPTPIPESPLIT, 0 },
1996 ** Used in connection with the \fIpipe-message\fP command and the ``tag-
1997 ** prefix'' operator. If this variable is unset, when piping a list of
1998 ** tagged messages Mutt will concatenate the messages and will pipe them
1999 ** as a single folder. When set, Mutt will pipe the messages one by one.
2000 ** In both cases the messages are piped in the current sorted order,
2001 ** and the ``$$pipe_sep'' separator is added after each message.
2003 { "pipe_decode", DT_BOOL, R_NONE, OPTPIPEDECODE, 0 },
2006 ** Used in connection with the \fIpipe-message\fP command. When unset,
2007 ** Mutt will pipe the messages without any preprocessing. When set, Mutt
2008 ** will weed headers and will attempt to PGP/MIME decode the messages
2011 { "pipe_sep", DT_STR, R_NONE, UL &PipeSep, UL "\n" },
2014 ** The separator to add between messages when piping a list of tagged
2015 ** messages to an external Unix command.
2018 { "pop_authenticators", DT_STR, R_NONE, UL &PopAuthenticators, UL 0 },
2021 ** This is a colon-delimited list of authentication methods mutt may
2022 ** attempt to use to log in to an POP server, in the order mutt should
2023 ** try them. Authentication methods are either 'user', 'apop' or any
2024 ** SASL mechanism, eg 'digest-md5', 'gssapi' or 'cram-md5'.
2025 ** This parameter is case-insensitive. If this parameter is unset
2026 ** (the default) mutt will try all available methods, in order from
2027 ** most-secure to least-secure.
2029 ** Example: set pop_authenticators="digest-md5:apop:user"
2031 { "pop_auth_try_all", DT_BOOL, R_NONE, OPTPOPAUTHTRYALL, 1 },
2034 ** If set, Mutt will try all available methods. When unset, Mutt will
2035 ** only fall back to other authentication methods if the previous
2036 ** methods are unavailable. If a method is available but authentication
2037 ** fails, Mutt will not connect to the POP server.
2039 { "pop_checkinterval", DT_NUM, R_NONE, UL &PopCheckTimeout, 60 },
2042 ** This variable configures how often (in seconds) POP should look for
2045 { "pop_delete", DT_QUAD, R_NONE, OPT_POPDELETE, M_ASKNO },
2048 ** If set, Mutt will delete successfully downloaded messages from the POP
2049 ** server when using the fetch-mail function. When unset, Mutt will
2050 ** download messages but also leave them on the POP server.
2052 { "pop_host", DT_STR, R_NONE, UL &PopHost, UL "" },
2055 ** The name of your POP server for the fetch-mail function. You
2056 ** can also specify an alternative port, username and password, ie:
2058 ** [pop[s]://][username[:password]@]popserver[:port]
2060 { "pop_last", DT_BOOL, R_NONE, OPTPOPLAST, 0 },
2063 ** If this variable is set, mutt will try to use the "LAST" POP command
2064 ** for retrieving only unread messages from the POP server when using
2065 ** the fetch-mail function.
2067 { "pop_reconnect", DT_QUAD, R_NONE, OPT_POPRECONNECT, M_ASKYES },
2070 ** Controls whether or not Mutt will try to reconnect to POP server when
2073 { "pop_user", DT_STR, R_NONE, UL &PopUser, 0 },
2076 ** Your login name on the POP server.
2078 ** This variable defaults to your user name on the local machine.
2080 { "pop_pass", DT_STR, R_NONE, UL &PopPass, UL "" },
2083 ** Specifies the password for your POP account. If unset, Mutt will
2084 ** prompt you for your password when you open POP mailbox.
2085 ** \fBWarning\fP: you should only use this option when you are on a
2086 ** fairly secure machine, because the superuser can read your muttrc
2087 ** even if you are the only one who can read the file.
2089 #endif /* USE_POP */
2090 { "post_indent_string",DT_STR, R_NONE, UL &PostIndentString, UL "" },
2093 ** Similar to the ``$$attribution'' variable, Mutt will append this
2094 ** string after the inclusion of a message which is being replied to.
2096 { "post_indent_str", DT_SYN, R_NONE, UL "post_indent_string", 0 },
2100 { "post_moderated", DT_QUAD, R_NONE, OPT_TOMODERATED, M_ASKYES },
2103 ** If set to \fIyes\fP, Mutt will post article to newsgroup that have
2104 ** not permissions to posting (e.g. moderated). \fBNote:\fP if newsserver
2105 ** does not support posting to that newsgroup or totally read-only, that
2106 ** posting will not have an effect.
2109 { "postpone", DT_QUAD, R_NONE, OPT_POSTPONE, M_ASKYES },
2112 ** Controls whether or not messages are saved in the ``$$postponed''
2113 ** mailbox when you elect not to send immediately.
2115 { "postponed", DT_PATH, R_NONE, UL &Postponed, UL "~/postponed" },
2118 ** Mutt allows you to indefinitely ``$postpone sending a message'' which
2119 ** you are editing. When you choose to postpone a message, Mutt saves it
2120 ** in the mailbox specified by this variable. Also see the ``$$postpone''
2124 { "preconnect", DT_STR, R_NONE, UL &Preconnect, UL 0},
2127 ** If set, a shell command to be executed if mutt fails to establish
2128 ** a connection to the server. This is useful for setting up secure
2129 ** connections, e.g. with ssh(1). If the command returns a nonzero
2130 ** status, mutt gives up opening the server. Example:
2132 ** preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net
2133 ** sleep 20 < /dev/null > /dev/null"
2135 ** Mailbox 'foo' on mailhost.net can now be reached
2136 ** as '{localhost:1234}foo'.
2138 ** NOTE: For this example to work, you must be able to log in to the
2139 ** remote machine without having to enter a password.
2141 #endif /* USE_SOCKET */
2142 { "print", DT_QUAD, R_NONE, OPT_PRINT, M_ASKNO },
2145 ** Controls whether or not Mutt asks for confirmation before printing.
2146 ** This is useful for people (like me) who accidentally hit ``p'' often.
2148 { "print_command", DT_PATH, R_NONE, UL &PrintCmd, UL "lpr" },
2151 ** This specifies the command pipe that should be used to print messages.
2153 { "print_cmd", DT_SYN, R_NONE, UL "print_command", 0 },
2156 { "print_decode", DT_BOOL, R_NONE, OPTPRINTDECODE, 1 },
2159 ** Used in connection with the print-message command. If this
2160 ** option is set, the message is decoded before it is passed to the
2161 ** external command specified by $$print_command. If this option
2162 ** is unset, no processing will be applied to the message when
2163 ** printing it. The latter setting may be useful if you are using
2164 ** some advanced printer filter which is able to properly format
2165 ** e-mail messages for printing.
2167 { "print_split", DT_BOOL, R_NONE, OPTPRINTSPLIT, 0 },
2170 ** Used in connection with the print-message command. If this option
2171 ** is set, the command specified by $$print_command is executed once for
2172 ** each message which is to be printed. If this option is unset,
2173 ** the command specified by $$print_command is executed only once, and
2174 ** all the messages are concatenated, with a form feed as the message
2177 ** Those who use the \fBenscript\fP(1) program's mail-printing mode will
2178 ** most likely want to set this option.
2180 { "prompt_after", DT_BOOL, R_NONE, OPTPROMPTAFTER, 1 },
2183 ** If you use an \fIexternal\fP ``$$pager'', setting this variable will
2184 ** cause Mutt to prompt you for a command when the pager exits rather
2185 ** than returning to the index menu. If unset, Mutt will return to the
2186 ** index menu when the external pager exits.
2188 { "query_command", DT_PATH, R_NONE, UL &QueryCmd, UL "" },
2191 ** This specifies the command that mutt will use to make external address
2192 ** queries. The string should contain a %s, which will be substituted
2193 ** with the query string the user types. See ``$query'' for more
2196 { "quit", DT_QUAD, R_NONE, OPT_QUIT, M_YES },
2199 ** This variable controls whether ``quit'' and ``exit'' actually quit
2200 ** from mutt. If it set to yes, they do quit, if it is set to no, they
2201 ** have no effect, and if it is set to ask-yes or ask-no, you are
2202 ** prompted for confirmation when you try to quit.
2204 { "quote_empty", DT_BOOL, R_NONE, OPTQUOTEEMPTY, 1 },
2207 ** Controls whether or not empty lines will be quoted using
2208 ** ``$indent_string''.
2210 { "quote_quoted", DT_BOOL, R_NONE, OPTQUOTEQUOTED, 0 },
2213 ** Controls how quoted lines will be quoted. If set, one quote
2214 ** character will be added to the end of existing prefix. Otherwise,
2215 ** quoted lines will be prepended by ``$indent_string''.
2217 { "quote_regexp", DT_RX, R_PAGER, UL &QuoteRegexp, UL "^([ \t]*[|>:}#])+" },
2220 ** A regular expression used in the internal-pager to determine quoted
2221 ** sections of text in the body of a message.
2223 ** \fBNote:\fP In order to use the \fIquoted\fP\fBx\fP patterns in the
2224 ** internal pager, you need to set this to a regular expression that
2225 ** matches \fIexactly\fP the quote characters at the beginning of quoted
2228 { "read_inc", DT_NUM, R_NONE, UL &ReadInc, 10 },
2231 ** If set to a value greater than 0, Mutt will display which message it
2232 ** is currently on when reading a mailbox. The message is printed after
2233 ** \fIread_inc\fP messages have been read (e.g., if set to 25, Mutt will
2234 ** print a message when it reads message 25, and then again when it gets
2235 ** to message 50). This variable is meant to indicate progress when
2236 ** reading large mailboxes which may take some time.
2237 ** When set to 0, only a single message will appear before the reading
2240 ** Also see the ``$$write_inc'' variable.
2242 { "read_only", DT_BOOL, R_NONE, OPTREADONLY, 0 },
2245 ** If set, all folders are opened in read-only mode.
2247 { "realname", DT_STR, R_BOTH, UL &Realname, 0 },
2250 ** This variable specifies what "real" or "personal" name should be used
2251 ** when sending messages.
2253 ** By default, this is the GECOS field from /etc/passwd. Note that this
2254 ** variable will \fInot\fP be used when the user has set a real name
2255 ** in the $$from variable.
2257 { "recall", DT_QUAD, R_NONE, OPT_RECALL, M_ASKYES },
2260 ** Controls whether or not you are prompted to recall postponed messages
2261 ** when composing a new message. Also see ``$$postponed''.
2263 ** Setting this variable to ``yes'' is not generally useful, and thus not
2266 { "record", DT_PATH, R_NONE, UL &Outbox, UL "" },
2269 ** This specifies the file into which your outgoing messages should be
2270 ** appended. (This is meant as the primary method for saving a copy of
2271 ** your messages, but another way to do this is using the ``$my_hdr''
2272 ** command to create a \fIBcc:\fP field with your email address in it.)
2274 ** The value of \fI$$record\fP is overridden by the ``$$force_name'' and
2275 ** ``$$save_name'' variables, and the ``$fcc-hook'' command.
2277 { "reply_regexp", DT_RX, R_INDEX|R_RESORT, UL &ReplyRegexp, UL "^(re([\\[0-9\\]+])*|aw):[ \t]*" },
2280 ** A regular expression used to recognize reply messages when threading
2281 ** and replying. The default value corresponds to the English "Re:" and
2282 ** the German "Aw:".
2284 { "reply_self", DT_BOOL, R_NONE, OPTREPLYSELF, 0 },
2287 ** If unset and you are replying to a message sent by you, Mutt will
2288 ** assume that you want to reply to the recipients of that message rather
2289 ** than to yourself.
2291 { "reply_to", DT_QUAD, R_NONE, OPT_REPLYTO, M_ASKYES },
2294 ** If set, Mutt will ask you if you want to use the address listed in the
2295 ** Reply-To: header field when replying to a message. If you answer no,
2296 ** it will use the address in the From: header field instead. This
2297 ** option is useful for reading a mailing list that sets the Reply-To:
2298 ** header field to the list address and you want to send a private
2299 ** message to the author of a message.
2301 { "resolve", DT_BOOL, R_NONE, OPTRESOLVE, 1 },
2304 ** When set, the cursor will be automatically advanced to the next
2305 ** (possibly undeleted) message whenever a command that modifies the
2306 ** current message is executed.
2308 { "reverse_alias", DT_BOOL, R_BOTH, OPTREVALIAS, 0 },
2311 ** This variable controls whether or not Mutt will display the "personal"
2312 ** name from your aliases in the index menu if it finds an alias that
2313 ** matches the message's sender. For example, if you have the following
2317 ** alias juser abd30425@somewhere.net (Joe User)
2320 ** and then you receive mail which contains the following header:
2323 ** From: abd30425@somewhere.net
2326 ** It would be displayed in the index menu as ``Joe User'' instead of
2327 ** ``abd30425@somewhere.net.'' This is useful when the person's e-mail
2328 ** address is not human friendly (like CompuServe addresses).
2330 { "reverse_name", DT_BOOL, R_BOTH, OPTREVNAME, 0 },
2333 ** It may sometimes arrive that you receive mail to a certain machine,
2334 ** move the messages to another machine, and reply to some the messages
2335 ** from there. If this variable is set, the default \fIFrom:\fP line of
2336 ** the reply messages is built using the address where you received the
2337 ** messages you are replying to. If the variable is unset, the
2338 ** \fIFrom:\fP line will use your address on the current machine.
2340 { "reverse_realname", DT_BOOL, R_BOTH, OPTREVREAL, 1 },
2343 ** This variable fine-tunes the behaviour of the $reverse_name feature.
2344 ** When it is set, mutt will use the address from incoming messages as-is,
2345 ** possibly including eventual real names. When it is unset, mutt will
2346 ** override any such real names with the setting of the $realname variable.
2348 { "rfc2047_parameters", DT_BOOL, R_NONE, OPTRFC2047PARAMS, 0 },
2351 ** When this variable is set, Mutt will decode RFC-2047-encoded MIME
2352 ** parameters. You want to set this variable when mutt suggests you
2353 ** to save attachments to files named like this:
2354 ** =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
2356 ** When this variable is set interactively, the change doesn't have
2357 ** the desired effect before you have changed folders.
2359 ** Note that this use of RFC 2047's encoding is explicitly,
2360 ** 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 RFC 2231.
2366 { "save_address", DT_BOOL, R_NONE, OPTSAVEADDRESS, 0 },
2369 ** If set, 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 set too, the selection of the fcc folder will be changed as well.
2373 { "save_empty", DT_BOOL, R_NONE, OPTSAVEEMPTY, 1 },
2376 ** When unset, mailboxes which contain no saved messages will be removed
2377 ** when closed (the exception is ``$$spoolfile'' which is never removed).
2378 ** If set, 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_name", DT_BOOL, R_NONE, OPTSAVENAME, 0 },
2386 ** This variable controls how copies of outgoing messages are saved.
2387 ** When set, a check is made to see if a mailbox specified by the
2388 ** recipient address exists (this is done by searching for a mailbox in
2389 ** the ``$$folder'' directory with the \fIusername\fP part of the
2390 ** recipient address). If the mailbox exists, the outgoing message will
2391 ** be saved to that mailbox, otherwise the message is saved to the
2392 ** ``$$record'' mailbox.
2394 ** Also see the ``$$force_name'' variable.
2396 { "score", DT_BOOL, R_NONE, OPTSCORE, 1 },
2399 ** When this variable is \fIunset\fP, scoring is turned off. This can
2400 ** be useful to selectively disable scoring for certain folders when the
2401 ** ``$$score_threshold_delete'' variable and friends are used.
2404 { "score_threshold_delete", DT_NUM, R_NONE, UL &ScoreThresholdDelete, UL -1 },
2407 ** Messages which have been assigned a score equal to or lower than the value
2408 ** of this variable are automatically marked for deletion by mutt. Since
2409 ** mutt scores are always greater than or equal to zero, the default setting
2410 ** of this variable will never mark a message for deletion.
2412 { "score_threshold_flag", DT_NUM, R_NONE, UL &ScoreThresholdFlag, 9999 },
2415 ** Messages which have been assigned a score greater than or equal to this
2416 ** variable's value are automatically marked "flagged".
2418 { "score_threshold_read", DT_NUM, R_NONE, UL &ScoreThresholdRead, UL -1 },
2421 ** Messages which have been assigned a score equal to or lower than the value
2422 ** of this variable are automatically marked as read by mutt. Since
2423 ** mutt scores are always greater than or equal to zero, the default setting
2424 ** of this variable will never mark a message read.
2426 { "send_charset", DT_STR, R_NONE, UL &SendCharset, UL "us-ascii:iso-8859-1:utf-8" },
2429 ** A list of character sets for outgoing messages. Mutt will use the
2430 ** first character set into which the text can be converted exactly.
2431 ** If your ``$$charset'' is not iso-8859-1 and recipients may not
2432 ** understand UTF-8, it is advisable to include in the list an
2433 ** appropriate widely used standard character set (such as
2434 ** iso-8859-2, koi8-r or iso-2022-jp) either instead of or after
2437 { "sendmail", DT_PATH, R_NONE, UL &Sendmail, UL SENDMAIL " -oem -oi" },
2440 ** Specifies the program and arguments used to deliver mail sent by Mutt.
2441 ** Mutt expects that the specified program interprets additional
2442 ** arguments as recipient addresses.
2444 { "sendmail_wait", DT_NUM, R_NONE, UL &SendmailWait, 0 },
2447 ** Specifies the number of seconds to wait for the ``$$sendmail'' process
2448 ** to finish before giving up and putting delivery in the background.
2450 ** Mutt interprets the value of this variable as follows:
2452 ** .dt >0 .dd number of seconds to wait for sendmail to finish before continuing
2453 ** .dt 0 .dd wait forever for sendmail to finish
2454 ** .dt <0 .dd always put sendmail in the background without waiting
2457 ** Note that if you specify a value other than 0, the output of the child
2458 ** process will be put in a temporary file. If there is some error, you
2459 ** will be informed as to where to find the output.
2461 { "shell", DT_PATH, R_NONE, UL &Shell, 0 },
2464 ** Command to use when spawning a subshell. By default, the user's login
2465 ** shell from /etc/passwd is used.
2468 { "save_unsubscribed",DT_BOOL, R_NONE, OPTSAVEUNSUB, 0 },
2471 ** When \fIset\fP, info about unsubscribed newsgroups will be saved into
2472 ** ``newsrc'' file and into cache.
2474 { "show_new_news", DT_BOOL, R_NONE, OPTSHOWNEWNEWS, 1 },
2477 ** If \fIset\fP, newsserver will be asked for new newsgroups on entering
2478 ** the browser. Otherwise, it will be done only once for a newsserver.
2479 ** Also controls whether or not number of new articles of subscribed
2480 ** newsgroups will be then checked.
2482 { "show_only_unread", DT_BOOL, R_NONE, OPTSHOWONLYUNREAD, 0 },
2485 ** If \fIset\fP, only subscribed newsgroups that contain unread articles
2486 ** will be displayed in browser.
2489 { "sig_dashes", DT_BOOL, R_NONE, OPTSIGDASHES, 1 },
2492 ** If set, a line containing ``-- '' will be inserted before your
2493 ** ``$$signature''. It is \fBstrongly\fP recommended that you not unset
2494 ** this variable unless your ``signature'' contains just your name. The
2495 ** reason for this is because many software packages use ``-- \n'' to
2496 ** detect your signature. For example, Mutt has the ability to highlight
2497 ** the signature in a different color in the builtin pager.
2499 { "sig_on_top", DT_BOOL, R_NONE, OPTSIGONTOP, 0},
2502 ** If set, the signature will be included before any quoted or forwarded
2503 ** text. It is \fBstrongly\fP recommended that you do not set this variable
2504 ** unless you really know what you are doing, and are prepared to take
2505 ** some heat from netiquette guardians.
2507 { "signature", DT_PATH, R_NONE, UL &Signature, UL "~/.signature" },
2510 ** Specifies the filename of your signature, which is appended to all
2511 ** outgoing messages. If the filename ends with a pipe (``|''), it is
2512 ** assumed that filename is a shell command and input should be read from
2515 { "simple_search", DT_STR, R_NONE, UL &SimpleSearch, UL "~f %s | ~s %s" },
2518 ** Specifies how Mutt should expand a simple search into a real search
2519 ** pattern. A simple search is one that does not contain any of the ~
2520 ** operators. See ``$patterns'' for more information on search patterns.
2522 ** For example, if you simply type joe at a search or limit prompt, Mutt
2523 ** will automatically expand it to the value specified by this variable.
2524 ** For the default value it would be:
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 set, long lines are wrapped at a word boundary. If
2533 ** unset, 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 in the beginning
2543 { "sleep_time", DT_NUM, R_NONE, UL &SleepTime, 1 },
2546 ** Specifies time, in seconds, to pause while displaying certain informational
2547 ** messages, while moving from folder to folder and after expunging
2548 ** messages from the current folder. The default is to pause one second, so
2549 ** a value of zero for this option suppresses the pause.
2551 { "sort", DT_SORT, R_INDEX|R_RESORT, UL &Sort, SORT_DATE },
2554 ** Specifies how to sort messages in the \fIindex\fP menu. Valid values
2558 ** . date or date-sent
2561 ** . mailbox-order (unsorted)
2569 ** You may optionally use the reverse- prefix to specify reverse sorting
2570 ** order (example: set sort=reverse-date-sent).
2572 { "sort_alias", DT_SORT|DT_SORT_ALIAS, R_NONE, UL &SortAlias, SORT_ALIAS },
2575 ** Specifies how the entries in the `alias' menu are sorted. The
2576 ** following are legal values:
2579 ** . address (sort alphabetically by email address)
2580 ** . alias (sort alphabetically by alias name)
2581 ** . unsorted (leave in order specified in .muttrc)
2584 { "sort_aux", DT_SORT|DT_SORT_AUX, R_INDEX|R_RESORT_BOTH, UL &SortAux, SORT_DATE },
2587 ** When sorting by threads, this variable controls how threads are sorted
2588 ** in relation to other threads, and how the branches of the thread trees
2589 ** are sorted. This can be set to any value that ``$$sort'' can, except
2590 ** threads (in that case, mutt will just use date-sent). You can also
2591 ** specify the last- prefix in addition to the reverse- prefix, but last-
2592 ** must come after reverse-. The last- prefix causes messages to be
2593 ** sorted against its siblings by which has the last descendant, using
2594 ** the rest of sort_aux as an ordering. For instance, set sort_aux=last-
2595 ** date-received would mean that if a new message is received in a
2596 ** thread, that thread becomes the last one displayed (or the first, if
2597 ** you have set sort=reverse-threads.) Note: For reversed ``$$sort''
2598 ** order $$sort_aux is reversed again (which is not the right thing to do,
2599 ** but kept to not break any existing configuration setting).
2601 { "sort_browser", DT_SORT|DT_SORT_BROWSER, R_NONE, UL &BrowserSort, SORT_SUBJECT },
2604 ** Specifies how to sort entries in the file browser. By default, the
2605 ** entries are sorted alphabetically. Valid values:
2608 ** . alpha (alphabetically)
2614 ** You may optionally use the reverse- prefix to specify reverse sorting
2615 ** order (example: set sort_browser=reverse-date).
2617 { "sort_re", DT_BOOL, R_INDEX|R_RESORT|R_RESORT_INIT, OPTSORTRE, 1 },
2620 ** This variable is only useful when sorting by threads with
2621 ** ``$$strict_threads'' unset. In that case, it changes the heuristic
2622 ** mutt uses to thread messages by subject. With sort_re set, mutt will
2623 ** only attach a message as the child of another message by subject if
2624 ** the subject of the child message starts with a substring matching the
2625 ** setting of ``$$reply_regexp''. With sort_re unset, mutt will attach
2626 ** the message whether or not this is the case, as long as the
2627 ** non-``$$reply_regexp'' parts of both messages are identical.
2629 { "spoolfile", DT_PATH, R_NONE, UL &Spoolfile, 0 },
2632 ** If your spool mailbox is in a non-default place where Mutt cannot find
2633 ** it, you can specify its location with this variable. Mutt will
2634 ** automatically set this variable to the value of the environment
2635 ** variable $$$MAIL if it is not set.
2637 { "status_chars", DT_STR, R_BOTH, UL &StChars, UL "-*%A" },
2640 ** Controls the characters used by the "%r" indicator in
2641 ** ``$$status_format''. The first character is used when the mailbox is
2642 ** unchanged. The second is used when the mailbox has been changed, and
2643 ** it needs to be resynchronized. The third is used if the mailbox is in
2644 ** read-only mode, or if the mailbox will not be written when exiting
2645 ** that mailbox (You can toggle whether to write changes to a mailbox
2646 ** with the toggle-write operation, bound by default to "%"). The fourth
2647 ** is used to indicate that the current folder has been opened in attach-
2648 ** message mode (Certain operations like composing a new mail, replying,
2649 ** forwarding, etc. are not permitted in this mode).
2651 { "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)---" },
2654 ** Controls the format of the status line displayed in the \fIindex\fP
2655 ** menu. This string is similar to ``$$index_format'', but has its own
2656 ** set of printf()-like sequences:
2659 ** .dt %b .dd number of mailboxes with new mail *
2660 ** .dt %d .dd number of deleted messages *
2661 ** .dt %f .dd the full pathname of the current mailbox
2662 ** .dt %F .dd number of flagged messages *
2663 ** .dt %h .dd local hostname
2664 ** .dt %l .dd size (in bytes) of the current mailbox *
2665 ** .dt %L .dd size (in bytes) of the messages shown
2666 ** (i.e., which match the current limit) *
2667 ** .dt %m .dd the number of messages in the mailbox *
2668 ** .dt %M .dd the number of messages shown (i.e., which match the current limit) *
2669 ** .dt %n .dd number of new messages in the mailbox *
2670 ** .dt %o .dd number of old unread messages
2671 ** .dt %p .dd number of postponed messages *
2672 ** .dt %P .dd percentage of the way through the index
2673 ** .dt %r .dd modified/read-only/won't-write/attach-message indicator,
2674 ** according to $$status_chars
2675 ** .dt %s .dd current sorting mode ($$sort)
2676 ** .dt %S .dd current aux sorting method ($$sort_aux)
2677 ** .dt %t .dd number of tagged messages *
2678 ** .dt %u .dd number of unread messages *
2679 ** .dt %v .dd Mutt version string
2680 ** .dt %V .dd currently active limit pattern, if any *
2681 ** .dt %>X .dd right justify the rest of the string and pad with "X"
2682 ** .dt %|X .dd pad to the end of the line with "X"
2685 ** * = can be optionally printed if nonzero
2687 ** Some of the above sequences can be used to optionally print a string
2688 ** if their value is nonzero. For example, you may only want to see the
2689 ** number of flagged messages if such messages exist, since zero is not
2690 ** particularly meaningful. To optionally print a string based upon one
2691 ** of the above sequences, the following construct is used
2693 ** %?<sequence_char>?<optional_string>?
2695 ** where \fIsequence_char\fP is a character from the table above, and
2696 ** \fIoptional_string\fP is the string you would like printed if
2697 ** \fIstatus_char\fP is nonzero. \fIoptional_string\fP \fBmay\fP contain
2698 ** other sequence as well as normal text, but you may \fBnot\fP nest
2699 ** optional strings.
2701 ** Here is an example illustrating how to optionally print the number of
2702 ** new messages in a mailbox:
2703 ** %?n?%n new messages.?
2705 ** Additionally you can switch between two strings, the first one, if a
2706 ** value is zero, the second one, if the value is nonzero, by using the
2707 ** following construct:
2708 ** %?<sequence_char>?<if_string>&<else_string>?
2710 ** You can additionally force the result of any printf-like sequence to
2711 ** be lowercase by prefixing the sequence character with an underscore
2712 ** (_) sign. For example, if you want to display the local hostname in
2713 ** lowercase, you would use:
2716 ** If you prefix the sequence character with a colon (:) character, mutt
2717 ** will replace any dots in the expansion by underscores. This might be helpful
2718 ** with IMAP folders that don't like dots in folder names.
2720 { "status_on_top", DT_BOOL, R_BOTH, OPTSTATUSONTOP, 0 },
2723 ** Setting this variable causes the ``status bar'' to be displayed on
2724 ** the first line of the screen rather than near the bottom.
2726 { "strict_threads", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTSTRICTTHREADS, 0 },
2729 ** If set, threading will only make use of the ``In-Reply-To'' and
2730 ** ``References'' fields when you ``$$sort'' by message threads. By
2731 ** default, messages with the same subject are grouped together in
2732 ** ``pseudo threads.'' This may not always be desirable, such as in a
2733 ** personal mailbox where you might have several unrelated messages with
2734 ** the subject ``hi'' which will get grouped together.
2736 { "suspend", DT_BOOL, R_NONE, OPTSUSPEND, 1 },
2739 ** When \fIunset\fP, mutt won't stop when the user presses the terminal's
2740 ** \fIsusp\fP key, usually ``control-Z''. This is useful if you run mutt
2741 ** inside an xterm using a command like xterm -e mutt.
2743 { "text_flowed", DT_BOOL, R_NONE, OPTTEXTFLOWED, 0 },
2746 ** When set, mutt will generate text/plain; format=flowed attachments.
2747 ** This format is easier to handle for some mailing software, and generally
2748 ** just looks like ordinary text. To actually make use of this format's
2749 ** features, you'll need support in your editor.
2751 ** Note that $$indent_string is ignored when this option is set.
2753 { "thread_received", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTTHREADRECEIVED, 0 },
2756 ** When set, mutt uses the date received rather than the date sent
2757 ** to thread messages by subject.
2759 { "thorough_search", DT_BOOL, R_NONE, OPTTHOROUGHSRC, 0 },
2762 ** Affects the \fI~b\fP and \fI~h\fP search operations described in
2763 ** section ``$patterns'' above. If set, the headers and attachments of
2764 ** messages to be searched are decoded before searching. If unset,
2765 ** messages are searched as they appear in the folder.
2767 { "tilde", DT_BOOL, R_PAGER, OPTTILDE, 0 },
2770 ** When set, the internal-pager will pad blank lines to the bottom of the
2771 ** screen with a tilde (~).
2773 { "timeout", DT_NUM, R_NONE, UL &Timeout, 600 },
2776 ** This variable controls the \fInumber of seconds\fP Mutt will wait
2777 ** for a key to be pressed in the main menu before timing out and
2778 ** checking for new mail. A value of zero or less will cause Mutt
2779 ** to never time out.
2781 { "tmpdir", DT_PATH, R_NONE, UL &Tempdir, 0 },
2784 ** This variable allows you to specify where Mutt will place its
2785 ** temporary files needed for displaying and composing messages. If
2786 ** this variable is not set, the environment variable TMPDIR is
2787 ** used. If TMPDIR is not set then "/tmp" is used.
2789 { "to_chars", DT_STR, R_BOTH, UL &Tochars, UL " +TCFL" },
2792 ** Controls the character used to indicate mail addressed to you. The
2793 ** first character is the one used when the mail is NOT addressed to your
2794 ** address (default: space). The second is used when you are the only
2795 ** recipient of the message (default: +). The third is when your address
2796 ** appears in the TO header field, but you are not the only recipient of
2797 ** the message (default: T). The fourth character is used when your
2798 ** address is specified in the CC header field, but you are not the only
2799 ** recipient. The fifth character is used to indicate mail that was sent
2800 ** by \fIyou\fP. The sixth character is used to indicate when a mail
2801 ** was sent to a mailing-list you subscribe to (default: L).
2803 { "trash", DT_PATH, R_NONE, UL &TrashPath, 0 },
2806 ** If set, this variable specifies the path of the trash folder where the
2807 ** mails marked for deletion will be moved, instead of being irremediably
2810 ** NOTE: When you delete a message in the trash folder, it is really
2811 ** deleted, so that you have a way to clean the trash.
2814 { "tunnel", DT_STR, R_NONE, UL &Tunnel, UL 0 },
2817 ** Setting this variable will cause mutt to open a pipe to a command
2818 ** instead of a raw socket. You may be able to use this to set up
2819 ** preauthenticated connections to your IMAP/POP3 server. Example:
2821 ** tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
2823 ** NOTE: For this example to work you must be able to log in to the remote
2824 ** machine without having to enter a password.
2827 { "use_8bitmime", DT_BOOL, R_NONE, OPTUSE8BITMIME, 0 },
2830 ** \fBWarning:\fP do not set this variable unless you are using a version
2831 ** of sendmail which supports the -B8BITMIME flag (such as sendmail
2832 ** 8.8.x) or you may not be able to send mail.
2834 ** When \fIset\fP, Mutt will invoke ``$$sendmail'' with the -B8BITMIME
2835 ** flag when sending 8-bit messages to enable ESMTP negotiation.
2837 { "use_domain", DT_BOOL, R_NONE, OPTUSEDOMAIN, 1 },
2840 ** When set, Mutt will qualify all local addresses (ones without the
2841 ** @host portion) with the value of ``$$hostname''. If \fIunset\fP, no
2842 ** addresses will be qualified.
2844 { "use_from", DT_BOOL, R_NONE, OPTUSEFROM, 1 },
2847 ** When \fIset\fP, Mutt will generate the `From:' header field when
2848 ** sending messages. If \fIunset\fP, no `From:' header field will be
2849 ** generated unless the user explicitly sets one using the ``$my_hdr''
2852 #ifdef HAVE_GETADDRINFO
2853 { "use_ipv6", DT_BOOL, R_NONE, OPTUSEIPV6, 1},
2856 ** When \fIset\fP, Mutt will look for IPv6 addresses of hosts it tries to
2857 ** contact. If this option is unset, Mutt will restrict itself to IPv4 addresses.
2858 ** Normally, the default should work.
2860 #endif /* HAVE_GETADDRINFO */
2861 { "user_agent", DT_BOOL, R_NONE, OPTXMAILER, 1},
2864 ** When \fIset\fP, mutt will add a "User-Agent" header to outgoing
2865 ** messages, indicating which version of mutt was used for composing
2868 { "visual", DT_PATH, R_NONE, UL &Visual, 0 },
2871 ** Specifies the visual editor to invoke when the \fI~v\fP command is
2872 ** given in the builtin editor.
2874 { "wait_key", DT_BOOL, R_NONE, OPTWAITKEY, 1 },
2877 ** Controls whether Mutt will ask you to press a key after \fIshell-
2878 ** escape\fP, \fIpipe-message\fP, \fIpipe-entry\fP, \fIprint-message\fP,
2879 ** and \fIprint-entry\fP commands.
2881 ** It is also used when viewing attachments with ``$auto_view'', provided
2882 ** that the corresponding mailcap entry has a \fIneedsterminal\fP flag,
2883 ** and the external program is interactive.
2885 ** When set, Mutt will always ask for a key. When unset, Mutt will wait
2886 ** for a key only if the external command returned a non-zero status.
2888 { "weed", DT_BOOL, R_NONE, OPTWEED, 1 },
2891 ** When set, mutt will weed headers when when displaying, forwarding,
2892 ** printing, or replying to messages.
2894 { "wrap_search", DT_BOOL, R_NONE, OPTWRAPSEARCH, 1 },
2897 ** Controls whether searches wrap around the end of the mailbox.
2899 ** When set, searches will wrap around the first (or last) message. When
2900 ** unset, searches will not wrap.
2902 { "wrapmargin", DT_NUM, R_PAGER, UL &WrapMargin, 0 },
2905 ** Controls the size of the margin remaining at the right side of
2906 ** the terminal when mutt's pager does smart wrapping.
2908 { "write_inc", DT_NUM, R_NONE, UL &WriteInc, 10 },
2911 ** When writing a mailbox, a message will be printed every
2912 ** \fIwrite_inc\fP messages to indicate progress. If set to 0, only a
2913 ** single message will be displayed before writing a mailbox.
2915 ** Also see the ``$$read_inc'' variable.
2917 { "write_bcc", DT_BOOL, R_NONE, OPTWRITEBCC, 1},
2920 ** Controls whether mutt writes out the Bcc header when preparing
2921 ** messages to be sent. Exim users may wish to use this.
2923 {"xterm_icon", DT_STR, R_BOTH, UL &XtermIcon, UL "M%?n?AIL&ail?"},
2926 ** Controls the format of the icon title, as long as xterm_set_titles
2927 ** is enabled. This string is identical in formatting to the one used by
2928 ** ``$$status_format''.
2930 {"xterm_set_titles", DT_BOOL, R_BOTH, OPTXTERMSETTITLES, 0},
2933 ** Controls whether mutt sets the xterm title bar and icon name
2934 ** (as long as you're in an appropriate terminal). The default must
2935 ** be off to force in the validity checking.
2937 {"xterm_title", DT_STR, R_BOTH, UL &XtermTitle, UL "Mutt with %?m?%m messages&no messages?%?n? [%n New]?"},
2940 ** Controls the format of the title bar of the xterm provided that
2941 ** xterm_set_titles has been set. This string is identical in formatting
2942 ** to the one used by ``$$status_format''.
2945 { "x_comment_to", DT_BOOL, R_NONE, OPTXCOMMENTTO, 0 },
2948 ** If \fIset\fP, Mutt will add ``X-Comment-To:'' field (that contains full
2949 ** name of original article author) to article that followuped to newsgroup.
2956 const struct mapping_t SortMethods[] = {
2957 { "date", SORT_DATE },
2958 { "date-sent", SORT_DATE },
2959 { "date-received", SORT_RECEIVED },
2960 { "mailbox-order", SORT_ORDER },
2961 { "subject", SORT_SUBJECT },
2962 { "from", SORT_FROM },
2963 { "size", SORT_SIZE },
2964 { "threads", SORT_THREADS },
2966 { "score", SORT_SCORE },
2970 /* same as SortMethods, but with "threads" replaced by "date" */
2972 const struct mapping_t SortAuxMethods[] = {
2973 { "date", SORT_DATE },
2974 { "date-sent", SORT_DATE },
2975 { "date-received", SORT_RECEIVED },
2976 { "mailbox-order", SORT_ORDER },
2977 { "subject", SORT_SUBJECT },
2978 { "from", SORT_FROM },
2979 { "size", SORT_SIZE },
2980 { "threads", SORT_DATE }, /* note: sort_aux == threads
2984 { "score", SORT_SCORE },
2989 const struct mapping_t SortBrowserMethods[] = {
2990 { "alpha", SORT_SUBJECT },
2991 { "date", SORT_DATE },
2992 { "size", SORT_SIZE },
2993 { "unsorted", SORT_ORDER },
2997 const struct mapping_t SortAliasMethods[] = {
2998 { "alias", SORT_ALIAS },
2999 { "address", SORT_ADDRESS },
3000 { "unsorted", SORT_ORDER },
3004 const struct mapping_t SortKeyMethods[] = {
3005 { "address", SORT_ADDRESS },
3006 { "date", SORT_DATE },
3007 { "keyid", SORT_KEYID },
3008 { "trust", SORT_TRUST },
3013 /* functions used to parse commands in a rc file */
3015 static int parse_list (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3016 static int parse_rx_list (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3017 static int parse_unlist (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3018 static int parse_rx_unlist (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3020 static int parse_unlists (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3021 static int parse_alias (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3022 static int parse_unalias (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3023 static int parse_ignore (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3024 static int parse_unignore (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3025 static int parse_source (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3026 static int parse_set (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3027 static int parse_my_hdr (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3028 static int parse_unmy_hdr (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3029 static int parse_subscribe (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3034 int (*func) (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3038 struct command_t Commands[] = {
3039 { "alternates", parse_rx_list, UL &Alternates },
3040 { "unalternates", parse_rx_unlist, UL &Alternates },
3042 { "account-hook", mutt_parse_hook, M_ACCOUNTHOOK },
3044 { "alias", parse_alias, 0 },
3045 { "auto_view", parse_list, UL &AutoViewList },
3046 { "alternative_order", parse_list, UL &AlternativeOrderList},
3047 { "bind", mutt_parse_bind, 0 },
3048 { "charset-hook", mutt_parse_hook, M_CHARSETHOOK },
3050 { "color", mutt_parse_color, 0 },
3051 { "uncolor", mutt_parse_uncolor, 0 },
3053 { "exec", mutt_parse_exec, 0 },
3054 { "fcc-hook", mutt_parse_hook, M_FCCHOOK },
3055 { "fcc-save-hook", mutt_parse_hook, M_FCCHOOK | M_SAVEHOOK },
3056 { "folder-hook", mutt_parse_hook, M_FOLDERHOOK },
3057 { "hdr_order", parse_list, UL &HeaderOrderList },
3059 { "iconv-hook", mutt_parse_hook, M_ICONVHOOK },
3061 { "ignore", parse_ignore, 0 },
3062 { "lists", parse_rx_list, UL &MailLists },
3063 { "macro", mutt_parse_macro, 0 },
3064 { "mailboxes", mutt_parse_mailboxes, M_MAILBOXES },
3065 { "unmailboxes", mutt_parse_mailboxes, M_UNMAILBOXES },
3066 { "message-hook", mutt_parse_hook, M_MESSAGEHOOK },
3067 { "mbox-hook", mutt_parse_hook, M_MBOXHOOK },
3068 { "mime_lookup", parse_list, UL &MimeLookupList },
3069 { "unmime_lookup", parse_unlist, UL &MimeLookupList },
3070 { "mono", mutt_parse_mono, 0 },
3071 { "my_hdr", parse_my_hdr, 0 },
3072 { "pgp-hook", mutt_parse_hook, M_CRYPTHOOK },
3073 { "crypt-hook", mutt_parse_hook, M_CRYPTHOOK },
3074 { "push", mutt_parse_push, 0 },
3075 { "reply-hook", mutt_parse_hook, M_REPLYHOOK },
3076 { "reset", parse_set, M_SET_RESET },
3077 { "save-hook", mutt_parse_hook, M_SAVEHOOK },
3078 { "score", mutt_parse_score, 0 },
3079 { "send-hook", mutt_parse_hook, M_SENDHOOK },
3080 { "set", parse_set, 0 },
3081 { "source", parse_source, 0 },
3082 { "subscribe", parse_subscribe, 0 },
3083 { "toggle", parse_set, M_SET_INV },
3084 { "unalias", parse_unalias, 0 },
3085 { "unalternative_order",parse_unlist, UL &AlternativeOrderList },
3086 { "unauto_view", parse_unlist, UL &AutoViewList },
3087 { "unhdr_order", parse_unlist, UL &HeaderOrderList },
3088 { "unhook", mutt_parse_unhook, 0 },
3089 { "unignore", parse_unignore, 0 },
3090 { "unlists", parse_unlists, 0 },
3091 { "unmono", mutt_parse_unmono, 0 },
3092 { "unmy_hdr", parse_unmy_hdr, 0 },
3093 { "unscore", mutt_parse_unscore, 0 },
3094 { "unset", parse_set, M_SET_UNSET },
3095 { "unsubscribe", parse_rx_unlist, UL &SubscribedLists },