]> git.llucax.com Git - software/mutt-debian.git/blob - init.h
lintian clean: adding some overrides, fixing manpage errors, addign a missing manpage...
[software/mutt-debian.git] / init.h
1 /*
2  * Copyright (C) 1996-2002,2007 Michael R. Elkins <me@mutt.org>
3  * Copyright (C) 2004 g10 Code GmbH
4  * 
5  *     This program is free software; you can redistribute it and/or modify
6  *     it under the terms of the GNU General Public License as published by
7  *     the Free Software Foundation; either version 2 of the License, or
8  *     (at your option) any later version.
9  * 
10  *     This program is distributed in the hope that it will be useful,
11  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *     GNU General Public License for more details.
14  * 
15  *     You should have received a copy of the GNU General Public License
16  *     along with this program; if not, write to the Free Software
17  *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
18  */ 
19
20 #ifdef _MAKEDOC
21 # include "config.h"
22 # include "doc/makedoc-defs.h"
23 #else
24 # include "sort.h"
25 #endif
26
27 #include "buffy.h"
28
29 #ifndef _MAKEDOC
30 #define DT_MASK         0x0f
31 #define DT_BOOL         1 /* boolean option */
32 #define DT_NUM          2 /* a number */
33 #define DT_STR          3 /* a string */
34 #define DT_PATH         4 /* a pathname */
35 #define DT_QUAD         5 /* quad-option (yes/no/ask-yes/ask-no) */
36 #define DT_SORT         6 /* sorting methods */
37 #define DT_RX           7 /* regular expressions */
38 #define DT_MAGIC        8 /* mailbox type */
39 #define DT_SYN          9 /* synonym for another variable */
40 #define DT_ADDR        10 /* e-mail address */
41
42 #define DTYPE(x) ((x) & DT_MASK)
43
44 /* subtypes */
45 #define DT_SUBTYPE_MASK 0xf0
46 #define DT_SORT_ALIAS   0x10
47 #define DT_SORT_BROWSER 0x20
48 #define DT_SORT_KEYS    0x40
49 #define DT_SORT_AUX     0x80
50
51 /* flags to parse_set() */
52 #define M_SET_INV       (1<<0)  /* default is to invert all vars */
53 #define M_SET_UNSET     (1<<1)  /* default is to unset all vars */
54 #define M_SET_RESET     (1<<2)  /* default is to reset all vars to default */
55
56 /* forced redraw/resort types */
57 #define R_NONE          0
58 #define R_INDEX         (1<<0)
59 #define R_PAGER         (1<<1)
60 #define R_RESORT        (1<<2)  /* resort the mailbox */
61 #define R_RESORT_SUB    (1<<3)  /* resort subthreads */
62 #define R_RESORT_INIT   (1<<4)  /* resort from scratch */
63 #define R_TREE          (1<<5)  /* redraw the thread tree */
64 #define R_BOTH          (R_INDEX | R_PAGER)
65 #define R_RESORT_BOTH   (R_RESORT | R_RESORT_SUB)
66
67 struct option_t
68 {
69   char *option;
70   short type;
71   short flags;
72   unsigned long data;
73   unsigned long init; /* initial value */
74 };
75
76 #define UL (unsigned long)
77
78 #endif /* _MAKEDOC */
79
80 #ifndef ISPELL
81 #define ISPELL "ispell"
82 #endif
83
84 struct option_t MuttVars[] = {
85   /*++*/
86   { "abort_nosubject",  DT_QUAD, R_NONE, OPT_SUBJECT, M_ASKYES },
87   /*
88   ** .pp
89   ** If set to \fIyes\fP, when composing messages and no subject is given
90   ** at the subject prompt, composition will be aborted.  If set to
91   ** \fIno\fP, composing messages with no subject given at the subject
92   ** prompt will never be aborted.
93   */
94   { "abort_unmodified", DT_QUAD, R_NONE, OPT_ABORT, M_YES },
95   /*
96   ** .pp
97   ** If set to \fIyes\fP, composition will automatically abort after
98   ** editing the message body if no changes are made to the file (this
99   ** check only happens after the \fIfirst\fP edit of the file).  When set
100   ** to \fIno\fP, composition will never be aborted.
101   */
102   { "alias_file",       DT_PATH, R_NONE, UL &AliasFile, UL "~/.muttrc" },
103   /*
104   ** .pp
105   ** The default file in which to save aliases created by the
106   ** \fC$<create-alias>\fP function. Entries added to this file are
107   ** encoded in the character set specified by $$config_charset if it
108   ** is \fIset\fP or the current character set otherwise.
109   ** .pp
110   ** \fBNote:\fP Mutt will not automatically source this file; you must
111   ** explicitly use the ``$source'' command for it to be executed in case
112   ** this option points to a dedicated alias file.
113   ** .pp
114   ** The default for this option is the currently used muttrc file, or
115   ** ``~/.muttrc'' if no user muttrc was found.
116   */
117   { "alias_format",     DT_STR,  R_NONE, UL &AliasFmt, UL "%4n %2f %t %-10a   %r" },
118   /*
119   ** .pp
120   ** Specifies the format of the data displayed for the ``$alias'' menu.  The
121   ** following \fCprintf(3)\fP-style sequences are available:
122   ** .dl
123   ** .dt %a .dd alias name
124   ** .dt %f .dd flags - currently, a ``d'' for an alias marked for deletion
125   ** .dt %n .dd index number
126   ** .dt %r .dd address which alias expands to
127   ** .dt %t .dd character which indicates if the alias is tagged for inclusion
128   ** .de
129   */
130   { "allow_8bit",       DT_BOOL, R_NONE, OPTALLOW8BIT, 1 },
131   /*
132   ** .pp
133   ** Controls whether 8-bit data is converted to 7-bit using either Quoted-
134   ** Printable or Base64 encoding when sending mail.
135   */
136   { "allow_ansi",      DT_BOOL, R_NONE, OPTALLOWANSI, 0 },
137   /*
138   ** .pp
139   ** Controls whether ANSI color codes in messages (and color tags in
140   ** rich text messages) are to be interpreted.
141   ** Messages containing these codes are rare, but if this option is \fIset\fP,
142   ** their text will be colored accordingly. Note that this may override
143   ** your color choices, and even present a security problem, since a
144   ** message could include a line like
145   ** .ts
146   ** [-- PGP output follows ...
147   ** .te
148   ** .pp
149   ** and give it the same color as your attachment color (see also
150   ** $$crypt_timestamp).
151   */
152   { "arrow_cursor",     DT_BOOL, R_BOTH, OPTARROWCURSOR, 0 },
153   /*
154   ** .pp
155   ** When \fIset\fP, an arrow (``->'') will be used to indicate the current entry
156   ** in menus instead of highlighting the whole line.  On slow network or modem
157   ** links this will make response faster because there is less that has to
158   ** be redrawn on the screen when moving to the next or previous entries
159   ** in the menu.
160   */
161   { "ascii_chars",      DT_BOOL, R_BOTH, OPTASCIICHARS, 0 },
162   /*
163   ** .pp
164   ** If \fIset\fP, Mutt will use plain ASCII characters when displaying thread
165   ** and attachment trees, instead of the default \fIACS\fP characters.
166   */
167   { "askbcc",           DT_BOOL, R_NONE, OPTASKBCC, 0 },
168   /*
169   ** .pp
170   ** If \fIset\fP, Mutt will prompt you for blind-carbon-copy (Bcc) recipients
171   ** before editing an outgoing message.
172   */
173   { "askcc",            DT_BOOL, R_NONE, OPTASKCC, 0 },
174   /*
175   ** .pp
176   ** If \fIset\fP, Mutt will prompt you for carbon-copy (Cc) recipients before
177   ** editing the body of an outgoing message.
178   */
179   { "assumed_charset", DT_STR, R_NONE, UL &AssumedCharset, UL 0},
180   /*
181   ** .pp
182   ** This variable is a colon-separated list of character encoding
183   ** schemes for messages without character encoding indication.
184   ** Header field values and message body content without character encoding
185   ** indication would be assumed that they are written in one of this list.
186   ** By default, all the header fields and message body without any charset
187   ** indication are assumed to be in ``us-ascii''.
188   ** .pp
189   ** For example, Japanese users might prefer this:
190   ** .ts
191   ** set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
192   ** .te
193   ** .pp
194   ** However, only the first content is valid for the message body.
195   */
196   { "attach_charset",    DT_STR,  R_NONE, UL &AttachCharset, UL 0 },
197   /*
198   ** .pp
199   ** This variable is a colon-separated list of character encoding
200   ** schemes for text file attachments.
201   ** If \fIunset\fP, the value of $$charset will be used instead.
202   ** For example, the following configuration would work for Japanese
203   ** text handling:
204   ** .ts
205   ** set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
206   ** .te
207   ** .pp
208   ** Note: for Japanese users, ``iso-2022-*'' must be put at the head
209   ** of the value as shown above if included.
210   */
211   { "attach_format",    DT_STR,  R_NONE, UL &AttachFormat, UL "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] " },
212   /*
213   ** .pp
214   ** This variable describes the format of the ``attachment'' menu.  The
215   ** following \fCprintf(3)\fP-style sequences are understood:
216   ** .dl
217   ** .dt %C  .dd charset
218   ** .dt %c  .dd requires charset conversion (``n'' or ``c'')
219   ** .dt %D  .dd deleted flag
220   ** .dt %d  .dd description
221   ** .dt %e  .dd MIME content-transfer-encoding
222   ** .dt %f  .dd filename
223   ** .dt %I  .dd disposition (``I'' for inline, ``A'' for attachment)
224   ** .dt %m  .dd major MIME type
225   ** .dt %M  .dd MIME subtype
226   ** .dt %n  .dd attachment number
227   ** .dt %Q  .dd ``Q'', if MIME part qualifies for attachment counting
228   ** .dt %s  .dd size
229   ** .dt %t  .dd tagged flag
230   ** .dt %T  .dd graphic tree characters
231   ** .dt %u  .dd unlink (=to delete) flag
232   ** .dt %X  .dd number of qualifying MIME parts in this part and its children
233   **             (please see the ``$attachments'' section for possible speed effects)
234   ** .dt %>X .dd right justify the rest of the string and pad with character ``X''
235   ** .dt %|X .dd pad to the end of the line with character ``X''
236   ** .dt %*X .dd soft-fill with character ``X'' as pad
237   ** .de
238   ** .pp
239   ** For an explanation of ``soft-fill'', see the $$index_format documentation.
240   */
241   { "attach_sep",       DT_STR,  R_NONE, UL &AttachSep, UL "\n" },
242   /*
243   ** .pp
244   ** The separator to add between attachments when operating (saving,
245   ** printing, piping, etc) on a list of tagged attachments.
246   */
247   { "attach_split",     DT_BOOL, R_NONE, OPTATTACHSPLIT, 1 },
248   /*
249   ** .pp
250   ** If this variable is \fIunset\fP, when operating (saving, printing, piping,
251   ** etc) on a list of tagged attachments, Mutt will concatenate the
252   ** attachments and will operate on them as a single attachment. The
253   ** $$attach_sep separator is added after each attachment. When \fIset\fP,
254   ** Mutt will operate on the attachments one by one.
255   */
256   { "attribution",      DT_STR,  R_NONE, UL &Attribution, UL "On %d, %n wrote:" },
257   /*
258   ** .pp
259   ** This is the string that will precede a message which has been included
260   ** in a reply.  For a full listing of defined \fCprintf(3)\fP-like sequences see
261   ** the section on $$index_format.
262   */
263   { "autoedit",         DT_BOOL, R_NONE, OPTAUTOEDIT, 0 },
264   /*
265   ** .pp
266   ** When \fIset\fP along with $$edit_headers, Mutt will skip the initial
267   ** send-menu (prompting for subject and recipients) and allow you to
268   ** immediately begin editing the body of your
269   ** message.  The send-menu may still be accessed once you have finished
270   ** editing the body of your message.
271   ** .pp
272   ** Also see $$fast_reply.
273   */
274   { "auto_tag",         DT_BOOL, R_NONE, OPTAUTOTAG, 0 },
275   /*
276   ** .pp
277   ** When \fIset\fP, functions in the \fIindex\fP menu which affect a message
278   ** will be applied to all tagged messages (if there are any).  When
279   ** unset, you must first use the \fC<tag-prefix>\fP function (bound to ``;''
280   ** by default) to make the next function apply to all tagged messages.
281   */
282   { "beep",             DT_BOOL, R_NONE, OPTBEEP, 1 },
283   /*
284   ** .pp
285   ** When this variable is \fIset\fP, mutt will beep when an error occurs.
286   */
287   { "beep_new",         DT_BOOL, R_NONE, OPTBEEPNEW, 0 },
288   /*
289   ** .pp
290   ** When this variable is \fIset\fP, mutt will beep whenever it prints a message
291   ** notifying you of new mail.  This is independent of the setting of the
292   ** $$beep variable.
293   */
294   { "bounce",   DT_QUAD, R_NONE, OPT_BOUNCE, M_ASKYES },
295   /*
296   ** .pp
297   ** Controls whether you will be asked to confirm bouncing messages.
298   ** If set to \fIyes\fP you don't get asked if you want to bounce a
299   ** message. Setting this variable to \fIno\fP is not generally useful,
300   ** and thus not recommended, because you are unable to bounce messages.
301   */
302   { "bounce_delivered", DT_BOOL, R_NONE, OPTBOUNCEDELIVERED, 1 },
303   /*
304   ** .pp
305   ** When this variable is \fIset\fP, mutt will include Delivered-To headers when
306   ** bouncing messages.  Postfix users may wish to \fIunset\fP this variable.
307   */
308   { "braille_friendly", DT_BOOL, R_NONE, OPTBRAILLEFRIENDLY, 0 },
309   /*
310   ** .pp
311   ** When this variable is \fIset\fP, mutt will place the cursor at the beginning
312   ** of the current line in menus, even when the $$arrow_cursor variable
313   ** is \fIunset\fP, making it easier for blind persons using Braille displays to
314   ** follow these menus.  The option is \fIunset\fP by default because many
315   ** visual terminals don't permit making the cursor invisible.
316   */
317   { "check_mbox_size",  DT_BOOL, R_NONE, OPTCHECKMBOXSIZE, 0 },
318   /*
319   ** .pp
320   ** When this variable is \fIset\fP, mutt will use file size attribute instead of
321   ** access time when checking for new mail in mbox and mmdf folders.
322   ** .pp
323   ** This variable is \fIunset\fP by default and should only be enabled when
324   ** new mail detection for these folder types is unreliable or doesn't work.
325   ** .pp
326   ** Note that enabling this variable should happen before any ``$mailboxes''
327   ** directives occur in configuration files regarding mbox or mmdf folders
328   ** because mutt needs to determine the initial new mail status of such a
329   ** mailbox by performing a fast mailbox scan when it is defined.
330   ** Afterwards the new mail status is tracked by file size changes.
331   */
332   { "charset",          DT_STR,  R_NONE, UL &Charset, UL 0 },
333   /*
334   ** .pp
335   ** Character set your terminal uses to display and enter textual data.
336   ** It is also the fallback for $$send_charset.
337   ** .pp
338   ** Upon startup Mutt tries to derive this value from environment variables
339   ** such as \fC$$$LC_CTYPE\fP or \fC$$$LANG\fP.
340   ** .pp
341   ** \fBNote:\fP It should only be set in case Mutt isn't abled to determine the
342   ** character set used correctly.
343   */
344   { "check_new",        DT_BOOL, R_NONE, OPTCHECKNEW, 1 },
345   /*
346   ** .pp
347   ** \fBNote:\fP this option only affects \fImaildir\fP and \fIMH\fP style
348   ** mailboxes.
349   ** .pp
350   ** When \fIset\fP, Mutt will check for new mail delivered while the
351   ** mailbox is open.  Especially with MH mailboxes, this operation can
352   ** take quite some time since it involves scanning the directory and
353   ** checking each file to see if it has already been looked at.  If
354   ** this variable is \fIunset\fP, no check for new mail is performed
355   ** while the mailbox is open.
356   */
357   { "collapse_unread",  DT_BOOL, R_NONE, OPTCOLLAPSEUNREAD, 1 },
358   /*
359   ** .pp
360   ** When \fIunset\fP, Mutt will not collapse a thread if it contains any
361   ** unread messages.
362   */
363   { "uncollapse_jump",  DT_BOOL, R_NONE, OPTUNCOLLAPSEJUMP, 0 },
364   /*
365   ** .pp
366   ** When \fIset\fP, Mutt will jump to the next unread message, if any,
367   ** when the current thread is \fIun\fPcollapsed.
368   */
369   { "compose_format",   DT_STR,  R_BOTH, UL &ComposeFormat, UL "-- Mutt: Compose  [Approx. msg size: %l   Atts: %a]%>-" },
370   /*
371   ** .pp
372   ** Controls the format of the status line displayed in the ``compose''
373   ** menu.  This string is similar to $$status_format, but has its own
374   ** set of \fCprintf(3)\fP-like sequences:
375   ** .dl
376   ** .dt %a .dd total number of attachments
377   ** .dt %h .dd local hostname
378   ** .dt %l .dd approximate size (in bytes) of the current message
379   ** .dt %v .dd Mutt version string
380   ** .de
381   ** .pp
382   ** See the text describing the $$status_format option for more
383   ** information on how to set $$compose_format.
384   */
385   { "config_charset",   DT_STR,  R_NONE, UL &ConfigCharset, UL 0 },
386   /*
387   ** .pp
388   ** When defined, Mutt will recode commands in rc files from this
389   ** encoding to the current character set as specified by $$charset
390   ** and aliases written to $$alias_file from the current character set.
391   ** .pp
392   ** Please note that if setting $$charset it must be done before
393   ** setting $$config_charset.
394   ** .pp
395   ** Recoding should be avoided as it may render unconvertable
396   ** characters as question marks which can lead to undesired
397   ** side effects (for example in regular expressions).
398   */
399   { "confirmappend",    DT_BOOL, R_NONE, OPTCONFIRMAPPEND, 1 },
400   /*
401   ** .pp
402   ** When \fIset\fP, Mutt will prompt for confirmation when appending messages to
403   ** an existing mailbox.
404   */
405   { "confirmcreate",    DT_BOOL, R_NONE, OPTCONFIRMCREATE, 1 },
406   /*
407   ** .pp
408   ** When \fIset\fP, Mutt will prompt for confirmation when saving messages to a
409   ** mailbox which does not yet exist before creating it.
410   */
411   { "connect_timeout",  DT_NUM, R_NONE, UL &ConnectTimeout, 30 },
412   /*
413   ** .pp
414   ** Causes Mutt to timeout a network connection (for IMAP, POP or SMTP) after this
415   ** many seconds if the connection is not able to be established.  A negative
416   ** value causes Mutt to wait indefinitely for the connection attempt to succeed.
417   */
418   { "content_type",     DT_STR, R_NONE, UL &ContentType, UL "text/plain" },
419   /*
420   ** .pp
421   ** Sets the default Content-Type for the body of newly composed messages.
422   */
423   { "copy",             DT_QUAD, R_NONE, OPT_COPY, M_YES },
424   /*
425   ** .pp
426   ** This variable controls whether or not copies of your outgoing messages
427   ** will be saved for later references.  Also see $$record,
428   ** $$save_name, $$force_name and ``$fcc-hook''.
429   */
430   { "crypt_use_gpgme",  DT_BOOL, R_NONE, OPTCRYPTUSEGPGME, 0 },
431   /*
432   ** .pp
433   ** This variable controls the use of the GPGME-enabled crypto backends.
434   ** If it is \fIset\fP and Mutt was built with gpgme support, the gpgme code for
435   ** S/MIME and PGP will be used instead of the classic code.  Note that
436   ** you need to set this option in .muttrc; it won't have any effect when
437   ** used interactively.
438   */
439   { "crypt_use_pka", DT_BOOL, R_NONE, OPTCRYPTUSEPKA, 0 },
440   /*
441   ** .pp
442   ** Controls whether mutt uses PKA
443   ** (see http://www.g10code.de/docs/pka-intro.de.pdf) during signature
444   ** verification (only supported by the GPGME backend).
445   */
446   { "crypt_autopgp",    DT_BOOL, R_NONE, OPTCRYPTAUTOPGP, 1 },
447   /*
448   ** .pp
449   ** This variable controls whether or not mutt may automatically enable
450   ** PGP encryption/signing for messages.  See also $$crypt_autoencrypt,
451   ** $$crypt_replyencrypt,
452   ** $$crypt_autosign, $$crypt_replysign and $$smime_is_default.
453   */
454   { "crypt_autosmime",  DT_BOOL, R_NONE, OPTCRYPTAUTOSMIME, 1 },
455   /*
456   ** .pp
457   ** This variable controls whether or not mutt may automatically enable
458   ** S/MIME encryption/signing for messages. See also $$crypt_autoencrypt,
459   ** $$crypt_replyencrypt,
460   ** $$crypt_autosign, $$crypt_replysign and $$smime_is_default.
461   */
462   { "date_format",      DT_STR,  R_BOTH, UL &DateFmt, UL "!%a, %b %d, %Y at %I:%M:%S%p %Z" },
463   /*
464   ** .pp
465   ** This variable controls the format of the date printed by the ``%d''
466   ** sequence in $$index_format.  This is passed to the \fCstrftime(3)\fP
467   ** function to process the date, see the man page for the proper syntax.
468   ** .pp
469   ** Unless the first character in the string is a bang (``!''), the month
470   ** and week day names are expanded according to the locale specified in
471   ** the variable $$locale. If the first character in the string is a
472   ** bang, the bang is discarded, and the month and week day names in the
473   ** rest of the string are expanded in the \fIC\fP locale (that is in US
474   ** English).
475   */
476   { "default_hook",     DT_STR,  R_NONE, UL &DefaultHook, UL "~f %s !~P | (~P ~C %s)" },
477   /*
478   ** .pp
479   ** This variable controls how ``$message-hook'', ``$reply-hook'', ``$send-hook'',
480   ** ``$send2-hook'', ``$save-hook'', and ``$fcc-hook'' will
481   ** be interpreted if they are specified with only a simple regexp,
482   ** instead of a matching pattern.  The hooks are expanded when they are
483   ** declared, so a hook will be interpreted according to the value of this
484   ** variable at the time the hook is declared.
485   ** .pp
486   ** The default value matches
487   ** if the message is either from a user matching the regular expression
488   ** given, or if it is from you (if the from address matches
489   ** ``$alternates'') and is to or cc'ed to a user matching the given
490   ** regular expression.
491   */
492   { "delete",           DT_QUAD, R_NONE, OPT_DELETE, M_ASKYES },
493   /*
494   ** .pp
495   ** Controls whether or not messages are really deleted when closing or
496   ** synchronizing a mailbox.  If set to \fIyes\fP, messages marked for
497   ** deleting will automatically be purged without prompting.  If set to
498   ** \fIno\fP, messages marked for deletion will be kept in the mailbox.
499   */
500   { "delete_untag",     DT_BOOL, R_NONE, OPTDELETEUNTAG, 1 },
501   /*
502   ** .pp
503   ** If this option is \fIset\fP, mutt will untag messages when marking them
504   ** for deletion.  This applies when you either explicitly delete a message,
505   ** or when you save it to another folder.
506   */
507   { "digest_collapse",  DT_BOOL, R_NONE, OPTDIGESTCOLLAPSE, 1},
508   /*
509   ** .pp
510   ** If this option is \fIset\fP, mutt's received-attachments menu will not show the subparts of
511   ** individual messages in a multipart/digest.  To see these subparts, press ``v'' on that menu.
512   */
513   { "display_filter",   DT_PATH, R_PAGER, UL &DisplayFilter, UL "" },
514   /*
515   ** .pp
516   ** When set, specifies a command used to filter messages.  When a message
517   ** is viewed it is passed as standard input to $$display_filter, and the
518   ** filtered message is read from the standard output.
519   */
520 #if defined(DL_STANDALONE) && defined(USE_DOTLOCK)
521   { "dotlock_program",  DT_PATH, R_NONE, UL &MuttDotlock, UL BINDIR "/mutt_dotlock" },
522   /*
523   ** .pp
524   ** Contains the path of the \fCmutt_dotlock(8)\fP binary to be used by
525   ** mutt.
526   */
527 #endif
528   { "dsn_notify",       DT_STR,  R_NONE, UL &DsnNotify, UL "" },
529   /*
530   ** .pp
531   ** This variable sets the request for when notification is returned.  The
532   ** string consists of a comma separated list (no spaces!) of one or more
533   ** of the following: \fInever\fP, to never request notification,
534   ** \fIfailure\fP, to request notification on transmission failure,
535   ** \fIdelay\fP, to be notified of message delays, \fIsuccess\fP, to be
536   ** notified of successful transmission.
537   ** .pp
538   ** Example:
539   ** .ts
540   ** set dsn_notify="failure,delay"
541   ** .te
542   ** .pp
543   ** \fBNote:\fP when using $$sendmail for delivery, you should not enable
544   ** this unless you are either using Sendmail 8.8.x or greater or a MTA
545   ** providing a \fCsendmail(1)\fP-compatible interface supporting the \fC-N\fP option
546   ** for DSN. For SMTP delivery, DSN support is autodetected so that it
547   ** depends on the server whether DSN will be used or not.
548   */
549   { "dsn_return",       DT_STR,  R_NONE, UL &DsnReturn, UL "" },
550   /*
551   ** .pp
552   ** This variable controls how much of your message is returned in DSN
553   ** messages.  It may be set to either \fIhdrs\fP to return just the
554   ** message header, or \fIfull\fP to return the full message.
555   ** .pp
556   ** Example:
557   ** .ts
558   ** set dsn_return=hdrs
559   ** .te
560   ** .pp
561   ** \fBNote:\fP when using $$sendmail for delivery, you should not enable
562   ** this unless you are either using Sendmail 8.8.x or greater or a MTA
563   ** providing a \fCsendmail(1)\fP-compatible interface supporting the \fC-R\fP option
564   ** for DSN. For SMTP delivery, DSN support is autodetected so that it
565   ** depends on the server whether DSN will be used or not.
566   */
567   { "duplicate_threads",        DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTDUPTHREADS, 1 },
568   /*
569   ** .pp
570   ** This variable controls whether mutt, when $$sort is set to \fIthreads\fP, threads
571   ** messages with the same Message-Id together.  If it is \fIset\fP, it will indicate
572   ** that it thinks they are duplicates of each other with an equals sign
573   ** in the thread tree.
574   */
575   { "edit_headers",     DT_BOOL, R_NONE, OPTEDITHDRS, 0 },
576   /*
577   ** .pp
578   ** This option allows you to edit the header of your outgoing messages
579   ** along with the body of your message.
580   ** .pp
581   ** \fBNote\fP that changes made to the References: and Date: headers are
582   ** ignored for interoperability reasons.
583   */
584   { "edit_hdrs",        DT_SYN,  R_NONE, UL "edit_headers", 0 },
585   /*
586   */
587   { "editor",           DT_PATH, R_NONE, UL &Editor, 0 },
588   /*
589   ** .pp
590   ** This variable specifies which editor is used by mutt.
591   ** It defaults to the value of the \fC$$$VISUAL\fP, or \fC$$$EDITOR\fP, environment
592   ** variable, or to the string ``vi'' if neither of those are set.
593   */
594   { "encode_from",      DT_BOOL, R_NONE, OPTENCODEFROM, 0 },
595   /*
596   ** .pp
597   ** When \fIset\fP, mutt will quoted-printable encode messages when
598   ** they contain the string ``From '' (note the trailing space) in the beginning of a line.
599   ** This is useful to avoid the tampering certain mail delivery and transport
600   ** agents tend to do with messages (in order to prevent tools from
601   ** misinterpreting the line as a mbox message separator).
602   */
603   { "envelope_from_address", DT_ADDR, R_NONE, UL &EnvFrom, 0 },
604   /*
605   ** .pp
606   ** Manually sets the \fIenvelope\fP sender for outgoing messages.
607   ** This value is ignored if $$use_envelope_from is \fIunset\fP.
608   */
609   { "escape",           DT_STR,  R_NONE, UL &EscChar, UL "~" },
610   /*
611   ** .pp
612   ** Escape character to use for functions in the builtin editor.
613   */
614   { "fast_reply",       DT_BOOL, R_NONE, OPTFASTREPLY, 0 },
615   /*
616   ** .pp
617   ** When \fIset\fP, the initial prompt for recipients and subject are skipped
618   ** when replying to messages, and the initial prompt for subject is
619   ** skipped when forwarding messages.
620   ** .pp
621   ** \fBNote:\fP this variable has no effect when the $$autoedit
622   ** variable is \fIset\fP.
623   */
624   { "fcc_attach",       DT_BOOL, R_NONE, OPTFCCATTACH, 1 },
625   /*
626   ** .pp
627   ** This variable controls whether or not attachments on outgoing messages
628   ** are saved along with the main body of your message.
629   */
630   { "fcc_clear",        DT_BOOL, R_NONE, OPTFCCCLEAR, 0 },
631   /*
632   ** .pp
633   ** When this variable is \fIset\fP, FCCs will be stored unencrypted and
634   ** unsigned, even when the actual message is encrypted and/or
635   ** signed.
636   ** (PGP only)
637   */
638   { "folder",           DT_PATH, R_NONE, UL &Maildir, UL "~/Mail" },
639   /*
640   ** .pp
641   ** Specifies the default location of your mailboxes.  A ``+'' or ``='' at the
642   ** beginning of a pathname will be expanded to the value of this
643   ** variable.  Note that if you change this variable (from the default)
644   ** value you need to make sure that the assignment occurs \fIbefore\fP
645   ** you use ``+'' or ``='' for any other variables since expansion takes place
646   ** when handling the ``$mailboxes'' command.
647   */
648   { "folder_format",    DT_STR,  R_INDEX, UL &FolderFormat, UL "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f" },
649   /*
650   ** .pp
651   ** This variable allows you to customize the file browser display to your
652   ** personal taste.  This string is similar to $$index_format, but has
653   ** its own set of \fCprintf(3)\fP-like sequences:
654   ** .dl
655   ** .dt %C  .dd current file number
656   ** .dt %d  .dd date/time folder was last modified
657   ** .dt %f  .dd filename
658   ** .dt %F  .dd file permissions
659   ** .dt %g  .dd group name (or numeric gid, if missing)
660   ** .dt %l  .dd number of hard links
661   ** .dt %N  .dd N if folder has new mail, blank otherwise
662   ** .dt %s  .dd size in bytes
663   ** .dt %t  .dd ``*'' if the file is tagged, blank otherwise
664   ** .dt %u  .dd owner name (or numeric uid, if missing)
665   ** .dt %>X .dd right justify the rest of the string and pad with character ``X''
666   ** .dt %|X .dd pad to the end of the line with character ``X''
667   ** .dt %*X .dd soft-fill with character ``X'' as pad
668   ** .de
669   ** .pp
670   ** For an explanation of ``soft-fill'', see the $$index_format documentation.
671   */
672   { "followup_to",      DT_BOOL, R_NONE, OPTFOLLOWUPTO, 1 },
673   /*
674   ** .pp
675   ** Controls whether or not the ``Mail-Followup-To:'' header field is
676   ** generated when sending mail.  When \fIset\fP, Mutt will generate this
677   ** field when you are replying to a known mailing list, specified with
678   ** the ``$subscribe'' or ``$lists'' commands.
679   ** .pp
680   ** This field has two purposes.  First, preventing you from
681   ** receiving duplicate copies of replies to messages which you send
682   ** to mailing lists, and second, ensuring that you do get a reply
683   ** separately for any messages sent to known lists to which you are
684   ** not subscribed.
685   ** .pp
686   ** The header will contain only the list's address
687   ** for subscribed lists, and both the list address and your own
688   ** email address for unsubscribed lists.  Without this header, a
689   ** group reply to your message sent to a subscribed list will be
690   ** sent to both the list and your address, resulting in two copies
691   ** of the same email for you.
692   */
693   { "force_name",       DT_BOOL, R_NONE, OPTFORCENAME, 0 },
694   /*
695   ** .pp
696   ** This variable is similar to $$save_name, except that Mutt will
697   ** store a copy of your outgoing message by the username of the address
698   ** you are sending to even if that mailbox does not exist.
699   ** .pp
700   ** Also see the $$record variable.
701   */
702   { "forward_decode",   DT_BOOL, R_NONE, OPTFORWDECODE, 1 },
703   /*
704   ** .pp
705   ** Controls the decoding of complex MIME messages into \fCtext/plain\fP when
706   ** forwarding a message.  The message header is also RFC2047 decoded.
707   ** This variable is only used, if $$mime_forward is \fIunset\fP,
708   ** otherwise $$mime_forward_decode is used instead.
709   */
710   { "forw_decode",      DT_SYN,  R_NONE, UL "forward_decode", 0 },
711   /*
712   */
713   { "forward_edit",     DT_QUAD, R_NONE, OPT_FORWEDIT, M_YES },
714   /*
715   ** .pp
716   ** This quadoption controls whether or not the user is automatically
717   ** placed in the editor when forwarding messages.  For those who always want
718   ** to forward with no modification, use a setting of ``no''.
719   */
720   { "forward_format",   DT_STR,  R_NONE, UL &ForwFmt, UL "[%a: %s]" },
721   /*
722   ** .pp
723   ** This variable controls the default subject when forwarding a message.
724   ** It uses the same format sequences as the $$index_format variable.
725   */
726   { "forw_format",      DT_SYN,  R_NONE, UL "forward_format", 0 },
727   /*
728   */
729   { "forward_quote",    DT_BOOL, R_NONE, OPTFORWQUOTE, 0 },
730   /*
731   ** .pp
732   ** When \fIset\fP, forwarded messages included in the main body of the
733   ** message (when $$mime_forward is \fIunset\fP) will be quoted using
734   ** $$indent_string.
735   */
736   { "forw_quote",       DT_SYN,  R_NONE, UL "forward_quote", 0 },
737   /*
738   */
739   { "from",             DT_ADDR, R_NONE, UL &From, UL 0 },
740   /*
741   ** .pp
742   ** When \fIset\fP, this variable contains a default from address.  It
743   ** can be overridden using ``$my_hdr'' (including from a ``$send-hook'') and
744   ** $$reverse_name.  This variable is ignored if $$use_from is \fIunset\fP.
745   ** .pp
746   ** This setting defaults to the contents of the environment variable \fC$$$EMAIL\fP.
747   */
748   { "gecos_mask",       DT_RX,   R_NONE, UL &GecosMask, UL "^[^,]*" },
749   /*
750   ** .pp
751   ** A regular expression used by mutt to parse the GECOS field of a password
752   ** entry when expanding the alias.  The default value
753   ** will return the string up to the first ``,'' encountered.
754   ** If the GECOS field contains a string like ``lastname, firstname'' then you
755   ** should set it to ``\fC.*\fP''.
756   ** .pp
757   ** This can be useful if you see the following behavior: you address a e-mail
758   ** to user ID ``stevef'' whose full name is ``Steve Franklin''.  If mutt expands
759   ** ``stevef'' to ``"Franklin" stevef@foo.bar'' then you should set the $$gecos_mask to
760   ** a regular expression that will match the whole name so mutt will expand
761   ** ``Franklin'' to ``Franklin, Steve''.
762   */
763   { "hdr_format",       DT_SYN,  R_NONE, UL "index_format", 0 },
764   /*
765   */
766   { "hdrs",             DT_BOOL, R_NONE, OPTHDRS, 1 },
767   /*
768   ** .pp
769   ** When \fIunset\fP, the header fields normally added by the ``$my_hdr''
770   ** command are not created.  This variable \fImust\fP be unset before
771   ** composing a new message or replying in order to take effect.  If \fIset\fP,
772   ** the user defined header fields are added to every new message.
773   */
774   { "header",           DT_BOOL, R_NONE, OPTHEADER, 0 },
775   /*
776   ** .pp
777   ** When \fIset\fP, this variable causes Mutt to include the header
778   ** of the message you are replying to into the edit buffer.
779   ** The $$weed setting applies.
780   */
781   { "help",             DT_BOOL, R_BOTH, OPTHELP, 1 },
782   /*
783   ** .pp
784   ** When \fIset\fP, help lines describing the bindings for the major functions
785   ** provided by each menu are displayed on the first line of the screen.
786   ** .pp
787   ** \fBNote:\fP The binding will not be displayed correctly if the
788   ** function is bound to a sequence rather than a single keystroke.  Also,
789   ** the help line may not be updated if a binding is changed while Mutt is
790   ** running.  Since this variable is primarily aimed at new users, neither
791   ** of these should present a major problem.
792   */
793   { "hidden_host",      DT_BOOL, R_NONE, OPTHIDDENHOST, 0 },
794   /*
795   ** .pp
796   ** When \fIset\fP, mutt will skip the host name part of $$hostname variable
797   ** when adding the domain part to addresses.  This variable does not
798   ** affect the generation of Message-IDs, and it will not lead to the
799   ** cut-off of first-level domains.
800   */
801   { "hide_limited",     DT_BOOL, R_TREE|R_INDEX, OPTHIDELIMITED, 0 },
802   /*
803   ** .pp
804   ** When \fIset\fP, mutt will not show the presence of messages that are hidden
805   ** by limiting, in the thread tree.
806   */
807   { "hide_missing",     DT_BOOL, R_TREE|R_INDEX, OPTHIDEMISSING, 1 },
808   /*
809   ** .pp
810   ** When \fIset\fP, mutt will not show the presence of missing messages in the
811   ** thread tree.
812   */
813   { "hide_thread_subject", DT_BOOL, R_TREE|R_INDEX, OPTHIDETHREADSUBJECT, 1 },
814   /*
815   ** .pp
816   ** When \fIset\fP, mutt will not show the subject of messages in the thread
817   ** tree that have the same subject as their parent or closest previously
818   ** displayed sibling.
819   */
820   { "hide_top_limited", DT_BOOL, R_TREE|R_INDEX, OPTHIDETOPLIMITED, 0 },
821   /*
822   ** .pp
823   ** When \fIset\fP, mutt will not show the presence of messages that are hidden
824   ** by limiting, at the top of threads in the thread tree.  Note that when
825   ** $$hide_limited is \fIset\fP, this option will have no effect.
826   */
827   { "hide_top_missing", DT_BOOL, R_TREE|R_INDEX, OPTHIDETOPMISSING, 1 },
828   /*
829   ** .pp
830   ** When \fIset\fP, mutt will not show the presence of missing messages at the
831   ** top of threads in the thread tree.  Note that when $$hide_missing is
832   ** \fIset\fP, this option will have no effect.
833   */
834   { "history",          DT_NUM,  R_NONE, UL &HistSize, 10 },
835   /*
836   ** .pp
837   ** This variable controls the size (in number of strings remembered) of
838   ** the string history buffer per category. The buffer is cleared each time the
839   ** variable is set.
840   */
841   { "history_file",     DT_PATH, R_NONE, UL &HistFile, UL "~/.mutthistory" },
842   /*
843   ** .pp
844   ** The file in which Mutt will save its history.
845   */
846   { "honor_followup_to", DT_QUAD, R_NONE, OPT_MFUPTO, M_YES },
847   /*
848   ** .pp
849   ** This variable controls whether or not a Mail-Followup-To header is
850   ** honored when group-replying to a message.
851   */
852   { "hostname",         DT_STR,  R_NONE, UL &Fqdn, 0 },
853   /*
854   ** .pp
855   ** Specifies the fully-qualified hostname of the system mutt is running on
856   ** containing the host's name and the DNS domain it belongs to. It is used
857   ** as the domain part (after ``@'') for local email addresses as well as
858   ** Message-Id headers.
859   ** .pp
860   ** Its value is determined at startup as follows: If the node's name
861   ** as returned by the \fCuname(3)\fP function contains the hostname and the
862   ** domain, these are used to construct $$hostname. If there is no
863   ** domain part returned, Mutt will look for a ``domain'' or ``search''
864   ** line in \fC/etc/resolv.conf\fP to determine the domain. Optionally, Mutt
865   ** can be compiled with a fixed domain name in which case a detected
866   ** one is not used.
867   ** .pp
868   ** Also see $$use_domain and $$hidden_host.
869   */
870   { "ignore_linear_white_space",    DT_BOOL, R_NONE, OPTIGNORELWS, 0 },
871   /*
872   ** .pp
873   ** This option replaces linear-white-space between encoded-word
874   ** and text to a single space to prevent the display of MIME-encoded
875   ** ``Subject:'' field from being divided into multiple lines.
876   */
877   { "ignore_list_reply_to", DT_BOOL, R_NONE, OPTIGNORELISTREPLYTO, 0 },
878   /*
879   ** .pp
880   ** Affects the behaviour of the \fC<reply>\fP function when replying to
881   ** messages from mailing lists (as defined by the ``$subscribe'' or
882   ** ``$lists'' commands).  When \fIset\fP, if the ``Reply-To:'' field is
883   ** set to the same value as the ``To:'' field, Mutt assumes that the
884   ** ``Reply-To:'' field was set by the mailing list to automate responses
885   ** to the list, and will ignore this field.  To direct a response to the
886   ** mailing list when this option is \fIset\fP, use the \fC$<list-reply>\fP
887   ** function; \fC<group-reply>\fP will reply to both the sender and the
888   ** list.
889   */
890 #ifdef USE_IMAP
891   { "imap_authenticators", DT_STR, R_NONE, UL &ImapAuthenticators, UL 0 },
892   /*
893   ** .pp
894   ** This is a colon-delimited list of authentication methods mutt may
895   ** attempt to use to log in to an IMAP server, in the order mutt should
896   ** try them.  Authentication methods are either ``login'' or the right
897   ** side of an IMAP ``AUTH=xxx'' capability string, eg ``digest-md5'', ``gssapi''
898   ** or ``cram-md5''. This option is case-insensitive. If it's
899   ** \fIunset\fP (the default) mutt will try all available methods,
900   ** in order from most-secure to least-secure.
901   ** .pp
902   ** Example:
903   ** .ts
904   ** set imap_authenticators="gssapi:cram-md5:login"
905   ** .te
906   ** .pp
907   ** \fBNote:\fP Mutt will only fall back to other authentication methods if
908   ** the previous methods are unavailable. If a method is available but
909   ** authentication fails, mutt will not connect to the IMAP server.
910   */
911   { "imap_check_subscribed",  DT_BOOL, R_NONE, OPTIMAPCHECKSUBSCRIBED, 0 },
912   /*
913    ** .pp
914    ** When \fIset\fP, mutt will fetch the set of subscribed folders from
915    ** your server on connection, and add them to the set of mailboxes
916    ** it polls for new mail just as if you had issued individual ``$mailboxes''
917    ** commands.
918    */
919   { "imap_delim_chars",         DT_STR, R_NONE, UL &ImapDelimChars, UL "/." },
920   /*
921   ** .pp
922   ** This contains the list of characters which you would like to treat
923   ** as folder separators for displaying IMAP paths. In particular it
924   ** helps in using the ``='' shortcut for your \fIfolder\fP variable.
925   */
926   { "imap_headers",     DT_STR, R_INDEX, UL &ImapHeaders, UL 0},
927   /*
928   ** .pp
929   ** Mutt requests these header fields in addition to the default headers
930   ** (``Date:'', ``From:'', ``Subject:'', ``To:'', ``Cc:'', ``Message-Id:'',
931   ** ``References:'', ``Content-Type:'', ``Content-Description:'', ``In-Reply-To:'',
932   ** ``Reply-To:'', ``Lines:'', ``List-Post:'', ``X-Label:'') from IMAP
933   ** servers before displaying the index menu. You may want to add more
934   ** headers for spam detection.
935   ** .pp
936   ** \fBNote:\fP This is a space separated list, items should be uppercase
937   ** and not contain the colon, e.g. ``X-BOGOSITY X-SPAM-STATUS'' for the
938   ** ``X-Bogosity:'' and ``X-Spam-Status:'' header fields.
939   */
940   { "imap_idle",                DT_BOOL, R_NONE, OPTIMAPIDLE, 0 },
941   /*
942   ** .pp
943   ** When \fIset\fP, mutt will attempt to use the IMAP IDLE extension
944   ** to check for new mail in the current mailbox. Some servers
945   ** (dovecot was the inspiration for this option) react badly
946   ** to mutt's implementation. If your connection seems to freeze
947   ** up periodically, try unsetting this.
948   */
949   { "imap_keepalive",           DT_NUM,  R_NONE, UL &ImapKeepalive, 900 },
950   /*
951   ** .pp
952   ** This variable specifies the maximum amount of time in seconds that mutt
953   ** will wait before polling open IMAP connections, to prevent the server
954   ** from closing them before mutt has finished with them. The default is
955   ** well within the RFC-specified minimum amount of time (30 minutes) before
956   ** a server is allowed to do this, but in practice the RFC does get
957   ** violated every now and then. Reduce this number if you find yourself
958   ** getting disconnected from your IMAP server due to inactivity.
959   */
960   { "imap_list_subscribed",     DT_BOOL, R_NONE, OPTIMAPLSUB, 0 },
961   /*
962   ** .pp
963   ** This variable configures whether IMAP folder browsing will look for
964   ** only subscribed folders or all folders.  This can be toggled in the
965   ** IMAP browser with the \fC<toggle-subscribed>\fP function.
966   */
967   { "imap_login",       DT_STR,  R_NONE, UL &ImapLogin, UL 0 },
968   /*
969   ** .pp
970   ** Your login name on the IMAP server.
971   ** .pp
972   ** This variable defaults to the value of $$imap_user.
973   */
974   { "imap_pass",        DT_STR,  R_NONE, UL &ImapPass, UL 0 },
975   /*
976   ** .pp
977   ** Specifies the password for your IMAP account.  If \fIunset\fP, Mutt will
978   ** prompt you for your password when you invoke the \fC$<fetch-mail>\fP function
979   ** or try to open an IMAP folder.
980   ** .pp
981   ** \fBWarning\fP: you should only use this option when you are on a
982   ** fairly secure machine, because the superuser can read your muttrc even
983   ** if you are the only one who can read the file.
984   */
985   { "imap_passive",             DT_BOOL, R_NONE, OPTIMAPPASSIVE, 1 },
986   /*
987   ** .pp
988   ** When \fIset\fP, mutt will not open new IMAP connections to check for new
989   ** mail.  Mutt will only check for new mail over existing IMAP
990   ** connections.  This is useful if you don't want to be prompted to
991   ** user/password pairs on mutt invocation, or if opening the connection
992   ** is slow.
993   */
994   { "imap_peek", DT_BOOL, R_NONE, OPTIMAPPEEK, 1 },
995   /*
996   ** .pp
997   ** When \fIset\fP, mutt will avoid implicitly marking your mail as read whenever
998   ** you fetch a message from the server. This is generally a good thing,
999   ** but can make closing an IMAP folder somewhat slower. This option
1000   ** exists to appease speed freaks.
1001   */
1002   { "imap_pipeline_depth", DT_NUM,  R_NONE, UL &ImapPipelineDepth, 15 },
1003   /*
1004   ** .pp
1005   ** Controls the number of IMAP commands that may be queued up before they
1006   ** are sent to the server. A deeper pipeline reduces the amount of time
1007   ** mutt must wait for the server, and can make IMAP servers feel much
1008   ** more responsive. But not all servers correctly handle pipelined commands,
1009   ** so if you have problems you might want to try setting this variable to 0.
1010   ** .pp
1011   ** \fBNote:\fP Changes to this variable have no effect on open connections.
1012   */
1013   { "imap_servernoise",         DT_BOOL, R_NONE, OPTIMAPSERVERNOISE, 1 },
1014   /*
1015   ** .pp
1016   ** When \fIset\fP, mutt will display warning messages from the IMAP
1017   ** server as error messages. Since these messages are often
1018   ** harmless, or generated due to configuration problems on the
1019   ** server which are out of the users' hands, you may wish to suppress
1020   ** them at some point.
1021   */
1022   { "imap_user",        DT_STR,  R_NONE, UL &ImapUser, UL 0 },
1023   /*
1024   ** .pp
1025   ** The name of the user whose mail you intend to access on the IMAP
1026   ** server.
1027   ** .pp
1028   ** This variable defaults to your user name on the local machine.
1029   */
1030 #endif
1031   { "implicit_autoview", DT_BOOL,R_NONE, OPTIMPLICITAUTOVIEW, 0},
1032   /*
1033   ** .pp
1034   ** If set to ``yes'', mutt will look for a mailcap entry with the
1035   ** ``\fCcopiousoutput\fP'' flag set for \fIevery\fP MIME attachment it doesn't have
1036   ** an internal viewer defined for.  If such an entry is found, mutt will
1037   ** use the viewer defined in that entry to convert the body part to text
1038   ** form.
1039   */
1040   { "include",          DT_QUAD, R_NONE, OPT_INCLUDE, M_ASKYES },
1041   /*
1042   ** .pp
1043   ** Controls whether or not a copy of the message(s) you are replying to
1044   ** is included in your reply.
1045   */
1046   { "include_onlyfirst",        DT_BOOL, R_NONE, OPTINCLUDEONLYFIRST, 0},
1047   /*
1048   ** .pp
1049   ** Controls whether or not Mutt includes only the first attachment
1050   ** of the message you are replying.
1051   */
1052   { "indent_string",    DT_STR,  R_NONE, UL &Prefix, UL "> " },
1053   /*
1054   ** .pp
1055   ** Specifies the string to prepend to each line of text quoted in a
1056   ** message to which you are replying.  You are strongly encouraged not to
1057   ** change this value, as it tends to agitate the more fanatical netizens.
1058   ** .pp
1059   ** This option is a format string, please see the description of
1060   ** $$index_format for supported \fCprintf(3)\fP-style sequences.
1061   ** .pp
1062   ** Because for \fCformat=lowed\fP style messages the quoting mechanism
1063   ** is strictly defined, this setting is ignored if $$text_flowed is
1064   ** \fIset\fP.
1065   */
1066   { "indent_str",       DT_SYN,  R_NONE, UL "indent_string", 0 },
1067   /*
1068   */
1069   { "index_format",     DT_STR,  R_BOTH, UL &HdrFmt, UL "%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s" },
1070   /*
1071   ** .pp
1072   ** This variable allows you to customize the message index display to
1073   ** your personal taste.
1074   ** .pp
1075   ** ``Format strings'' are similar to the strings used in the C
1076   ** function \fCprintf(3)\fP to format output (see the man page for more details).
1077   ** The following sequences are defined in Mutt:
1078   ** .dl
1079   ** .dt %a .dd address of the author
1080   ** .dt %A .dd reply-to address (if present; otherwise: address of author)
1081   ** .dt %b .dd filename of the original message folder (think mailbox)
1082   ** .dt %B .dd the list to which the letter was sent, or else the folder name (%b).
1083   ** .dt %c .dd number of characters (bytes) in the message
1084   ** .dt %C .dd current message number
1085   ** .dt %d .dd date and time of the message in the format specified by
1086   **            $$date_format converted to sender's time zone
1087   ** .dt %D .dd date and time of the message in the format specified by
1088   **            $$date_format converted to the local time zone
1089   ** .dt %e .dd current message number in thread
1090   ** .dt %E .dd number of messages in current thread
1091   ** .dt %f .dd sender (address + real name), either From: or Return-Path:
1092   ** .dt %F .dd author name, or recipient name if the message is from you
1093   ** .dt %H .dd spam attribute(s) of this message
1094   ** .dt %i .dd message-id of the current message
1095   ** .dt %l .dd number of lines in the message (does not work with maildir,
1096   **            mh, and possibly IMAP folders)
1097   ** .dt %L .dd If an address in the ``To:'' or ``Cc:'' header field matches an address
1098   **            defined by the users ``$subscribe'' command, this displays
1099   **            "To <list-name>", otherwise the same as %F.
1100   ** .dt %m .dd total number of message in the mailbox
1101   ** .dt %M .dd number of hidden messages if the thread is collapsed.
1102   ** .dt %N .dd message score
1103   ** .dt %n .dd author's real name (or address if missing)
1104   ** .dt %O .dd original save folder where mutt would formerly have
1105   **            stashed the message: list name or recipient name
1106   **            if not sent to a list
1107   ** .dt %P .dd progress indicator for the builtin pager (how much of the file has been displayed)
1108   ** .dt %s .dd subject of the message
1109   ** .dt %S .dd status of the message (``N''/``D''/``d''/``!''/``r''/\(as)
1110   ** .dt %t .dd ``To:'' field (recipients)
1111   ** .dt %T .dd the appropriate character from the $$to_chars string
1112   ** .dt %u .dd user (login) name of the author
1113   ** .dt %v .dd first name of the author, or the recipient if the message is from you
1114   ** .dt %X .dd number of attachments
1115   **            (please see the ``$attachments'' section for possible speed effects)
1116   ** .dt %y .dd ``X-Label:'' field, if present
1117   ** .dt %Y .dd ``X-Label:'' field, if present, and \fI(1)\fP not at part of a thread tree,
1118   **            \fI(2)\fP at the top of a thread, or \fI(3)\fP ``X-Label:'' is different from
1119   **            preceding message's ``X-Label:''.
1120   ** .dt %Z .dd message status flags
1121   ** .dt %{fmt} .dd the date and time of the message is converted to sender's
1122   **                time zone, and ``fmt'' is expanded by the library function
1123   **                \fCstrftime(3)\fP; a leading bang disables locales
1124   ** .dt %[fmt] .dd the date and time of the message is converted to the local
1125   **                time zone, and ``fmt'' is expanded by the library function
1126   **                \fCstrftime(3)\fP; a leading bang disables locales
1127   ** .dt %(fmt) .dd the local date and time when the message was received.
1128   **                ``fmt'' is expanded by the library function \fCstrftime(3)\fP;
1129   **                a leading bang disables locales
1130   ** .dt %<fmt> .dd the current local time. ``fmt'' is expanded by the library
1131   **                function \fCstrftime(3)\fP; a leading bang disables locales.
1132   ** .dt %>X    .dd right justify the rest of the string and pad with character ``X''
1133   ** .dt %|X    .dd pad to the end of the line with character ``X''
1134   ** .dt %*X    .dd soft-fill with character ``X'' as pad
1135   ** .de
1136   ** .pp
1137   ** ``Soft-fill'' deserves some explanation: Normal right-justification
1138   ** will print everything to the left of the ``%>'', displaying padding and
1139   ** whatever lies to the right only if there's room. By contrast,
1140   ** soft-fill gives priority to the right-hand side, guaranteeing space
1141   ** to display it and showing padding only if there's still room. If
1142   ** necessary, soft-fill will eat text leftwards to make room for
1143   ** rightward text.
1144   ** .pp
1145   ** Note that these expandos are supported in
1146   ** ``$save-hook'', ``$fcc-hook'' and ``$fcc-save-hook'', too.
1147   */
1148   { "ispell",           DT_PATH, R_NONE, UL &Ispell, UL ISPELL },
1149   /*
1150   ** .pp
1151   ** How to invoke ispell (GNU's spell-checking software).
1152   */
1153   { "keep_flagged", DT_BOOL, R_NONE, OPTKEEPFLAGGED, 0 },
1154   /*
1155   ** .pp
1156   ** If \fIset\fP, read messages marked as flagged will not be moved
1157   ** from your spool mailbox to your $$mbox mailbox, or as a result of
1158   ** a ``$mbox-hook'' command.
1159   */
1160   { "locale",           DT_STR,  R_BOTH, UL &Locale, UL "C" },
1161   /*
1162   ** .pp
1163   ** The locale used by \fCstrftime(3)\fP to format dates. Legal values are
1164   ** the strings your system accepts for the locale environment variable \fC$$$LC_TIME\fP.
1165   */
1166   { "mail_check",       DT_NUM,  R_NONE, UL &BuffyTimeout, 5 },
1167   /*
1168   ** .pp
1169   ** This variable configures how often (in seconds) mutt should look for
1170   ** new mail. Also see the $$timeout variable.
1171   */
1172   { "mailcap_path",     DT_STR,  R_NONE, UL &MailcapPath, 0 },
1173   /*
1174   ** .pp
1175   ** This variable specifies which files to consult when attempting to
1176   ** display MIME bodies not directly supported by Mutt.
1177   */
1178   { "mailcap_sanitize", DT_BOOL, R_NONE, OPTMAILCAPSANITIZE, 1 },
1179   /*
1180   ** .pp
1181   ** If \fIset\fP, mutt will restrict possible characters in mailcap % expandos
1182   ** to a well-defined set of safe characters.  This is the safe setting,
1183   ** but we are not sure it doesn't break some more advanced MIME stuff.
1184   ** .pp
1185   ** \fBDON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE
1186   ** DOING!\fP
1187   */
1188 #ifdef USE_HCACHE
1189   { "header_cache", DT_PATH, R_NONE, UL &HeaderCache, 0 },
1190   /*
1191   ** .pp
1192   ** This variable points to the header cache database.
1193   ** If pointing to a directory Mutt will contain a header cache
1194   ** database file per folder, if pointing to a file that file will
1195   ** be a single global header cache. By default it is \fIunset\fP so no header
1196   ** caching will be used.
1197   ** .pp
1198   ** Header caching can greatly improve speed when opening POP, IMAP
1199   ** MH or Maildir folders, see ``$caching'' for details.
1200   */
1201   { "maildir_header_cache_verify", DT_BOOL, R_NONE, OPTHCACHEVERIFY, 1 },
1202   /*
1203   ** .pp
1204   ** Check for Maildir unaware programs other than mutt having modified maildir
1205   ** files when the header cache is in use.  This incurs one \fCstat(2)\fP per
1206   ** message every time the folder is opened (which can be very slow for NFS
1207   ** folders).
1208   */
1209 #if defined(HAVE_GDBM) || defined(HAVE_DB4)
1210   { "header_cache_pagesize", DT_STR, R_NONE, UL &HeaderCachePageSize, UL "16384" },
1211   /*
1212   ** .pp
1213   ** When mutt is compiled with either gdbm or bdb4 as the header cache backend,
1214   ** this option changes the database page size.  Too large or too small
1215   ** values can waste space, memory, or CPU time. The default should be more
1216   ** or less optimal for most use cases.
1217   */
1218 #endif /* HAVE_GDBM || HAVE_DB4 */
1219 #if defined(HAVE_QDBM) || defined(HAVE_TC)
1220   { "header_cache_compress", DT_BOOL, R_NONE, OPTHCACHECOMPRESS, 1 },
1221   /*
1222   ** .pp
1223   ** When mutt is compiled with qdbm or tokyocabinet as header cache backend,
1224   ** this option determines whether the database will be compressed.
1225   ** Compression results in database files roughly being one fifth
1226   ** of the usual diskspace, but the uncompression can result in a
1227   ** slower opening of cached folder(s) which in general is still
1228   ** much faster than opening non header cached folders.
1229   */
1230 #endif /* HAVE_QDBM */
1231 #endif /* USE_HCACHE */
1232   { "maildir_trash", DT_BOOL, R_NONE, OPTMAILDIRTRASH, 0 },
1233   /*
1234   ** .pp
1235   ** If \fIset\fP, messages marked as deleted will be saved with the maildir
1236   ** trashed flag instead of unlinked.  \fBNote:\fP this only applies
1237   ** to maildir-style mailboxes.  Setting it will have no effect on other
1238   ** mailbox types.
1239   */
1240   { "mark_old",         DT_BOOL, R_BOTH, OPTMARKOLD, 1 },
1241   /*
1242   ** .pp
1243   ** Controls whether or not mutt marks \fInew\fP \fBunread\fP
1244   ** messages as \fIold\fP if you exit a mailbox without reading them.
1245   ** With this option \fIset\fP, the next time you start mutt, the messages
1246   ** will show up with an ``O'' next to them in the index menu,
1247   ** indicating that they are old.
1248   */
1249   { "markers",          DT_BOOL, R_PAGER, OPTMARKERS, 1 },
1250   /*
1251   ** .pp
1252   ** Controls the display of wrapped lines in the internal pager. If set, a
1253   ** ``+'' marker is displayed at the beginning of wrapped lines.
1254   ** .pp
1255   ** Also see the $$smart_wrap variable.
1256   */
1257   { "mask",             DT_RX,   R_NONE, UL &Mask, UL "!^\\.[^.]" },
1258   /*
1259   ** .pp
1260   ** A regular expression used in the file browser, optionally preceded by
1261   ** the \fInot\fP operator ``!''.  Only files whose names match this mask
1262   ** will be shown. The match is always case-sensitive.
1263   */
1264   { "mbox",             DT_PATH, R_BOTH, UL &Inbox, UL "~/mbox" },
1265   /*
1266   ** .pp
1267   ** This specifies the folder into which read mail in your $$spoolfile
1268   ** folder will be appended.
1269   ** .pp
1270   ** Also see the $$move variable.
1271   */
1272   { "mbox_type",        DT_MAGIC,R_NONE, UL &DefaultMagic, M_MBOX },
1273   /*
1274   ** .pp
1275   ** The default mailbox type used when creating new folders. May be any of
1276   ** ``mbox'', ``MMDF'', ``MH'' and ``Maildir''.
1277   */
1278   { "metoo",            DT_BOOL, R_NONE, OPTMETOO, 0 },
1279   /*
1280   ** .pp
1281   ** If \fIunset\fP, Mutt will remove your address (see the ``$alternates''
1282   ** command) from the list of recipients when replying to a message.
1283   */
1284   { "menu_context",     DT_NUM,  R_NONE, UL &MenuContext, 0 },
1285   /*
1286   ** .pp
1287   ** This variable controls the number of lines of context that are given
1288   ** when scrolling through menus. (Similar to $$pager_context.)
1289   */
1290   { "menu_move_off",    DT_BOOL, R_NONE, OPTMENUMOVEOFF, 1 },
1291   /*
1292   ** .pp
1293   ** When \fIunset\fP, the bottom entry of menus will never scroll up past
1294   ** the bottom of the screen, unless there are less entries than lines.
1295   ** When \fIset\fP, the bottom entry may move off the bottom.
1296   */
1297   { "menu_scroll",      DT_BOOL, R_NONE, OPTMENUSCROLL, 0 },
1298   /*
1299   ** .pp
1300   ** When \fIset\fP, menus will be scrolled up or down one line when you
1301   ** attempt to move across a screen boundary.  If \fIunset\fP, the screen
1302   ** is cleared and the next or previous page of the menu is displayed
1303   ** (useful for slow links to avoid many redraws).
1304   */
1305   { "meta_key",         DT_BOOL, R_NONE, OPTMETAKEY, 0 },
1306   /*
1307   ** .pp
1308   ** If \fIset\fP, forces Mutt to interpret keystrokes with the high bit (bit 8)
1309   ** set as if the user had pressed the Esc key and whatever key remains
1310   ** after having the high bit removed.  For example, if the key pressed
1311   ** has an ASCII value of \fC0xf8\fP, then this is treated as if the user had
1312   ** pressed Esc then ``x''.  This is because the result of removing the
1313   ** high bit from \fC0xf8\fP is \fC0x78\fP, which is the ASCII character
1314   ** ``x''.
1315   */
1316   { "mh_purge",         DT_BOOL, R_NONE, OPTMHPURGE, 0 },
1317   /*
1318   ** .pp
1319   ** When \fIunset\fP, mutt will mimic mh's behaviour and rename deleted messages
1320   ** to \fI,<old file name>\fP in mh folders instead of really deleting
1321   ** them. This leaves the message on disk but makes programs reading the folder
1322   ** ignore it. If the variable is \fIset\fP, the message files will simply be
1323   ** deleted.
1324   ** .pp
1325   ** This option is similar to $$maildir_trash for Maildir folders.
1326   */
1327   { "mh_seq_flagged",   DT_STR, R_NONE, UL &MhFlagged, UL "flagged" },
1328   /*
1329   ** .pp
1330   ** The name of the MH sequence used for flagged messages.
1331   */
1332   { "mh_seq_replied",   DT_STR, R_NONE, UL &MhReplied, UL "replied" },
1333   /*
1334   ** .pp
1335   ** The name of the MH sequence used to tag replied messages.
1336   */
1337   { "mh_seq_unseen",    DT_STR, R_NONE, UL &MhUnseen, UL "unseen" },
1338   /*
1339   ** .pp
1340   ** The name of the MH sequence used for unseen messages.
1341   */
1342   { "mime_forward",     DT_QUAD, R_NONE, OPT_MIMEFWD, M_NO },
1343   /*
1344   ** .pp
1345   ** When \fIset\fP, the message you are forwarding will be attached as a
1346   ** separate \fCmessage/rfc822\fP MIME part instead of included in the main body of the
1347   ** message.  This is useful for forwarding MIME messages so the receiver
1348   ** can properly view the message as it was delivered to you. If you like
1349   ** to switch between MIME and not MIME from mail to mail, set this
1350   ** variable to ``ask-no'' or ``ask-yes''.
1351   ** .pp
1352   ** Also see $$forward_decode and $$mime_forward_decode.
1353   */
1354   { "mime_forward_decode", DT_BOOL, R_NONE, OPTMIMEFORWDECODE, 0 },
1355   /*
1356   ** .pp
1357   ** Controls the decoding of complex MIME messages into \fCtext/plain\fP when
1358   ** forwarding a message while $$mime_forward is \fIset\fP. Otherwise
1359   ** $$forward_decode is used instead.
1360   */
1361   { "mime_fwd",         DT_SYN,  R_NONE, UL "mime_forward", 0 },
1362   /*
1363   */
1364   { "mime_forward_rest", DT_QUAD, R_NONE, OPT_MIMEFWDREST, M_YES },
1365   /*
1366   ** .pp
1367   ** When forwarding multiple attachments of a MIME message from the attachment
1368   ** menu, attachments which cannot be decoded in a reasonable manner will
1369   ** be attached to the newly composed message if this option is \fIset\fP.
1370   */
1371 #ifdef MIXMASTER
1372   { "mix_entry_format", DT_STR,  R_NONE, UL &MixEntryFormat, UL "%4n %c %-16s %a" },
1373   /*
1374   ** .pp
1375   ** This variable describes the format of a remailer line on the mixmaster
1376   ** chain selection screen.  The following \fCprintf(3)\fP-like sequences are
1377   ** supported:
1378   ** .dl
1379   ** .dt %n .dd The running number on the menu.
1380   ** .dt %c .dd Remailer capabilities.
1381   ** .dt %s .dd The remailer's short name.
1382   ** .dt %a .dd The remailer's e-mail address.
1383   ** .de
1384   */
1385   { "mixmaster",        DT_PATH, R_NONE, UL &Mixmaster, UL MIXMASTER },
1386   /*
1387   ** .pp
1388   ** This variable contains the path to the Mixmaster binary on your
1389   ** system.  It is used with various sets of parameters to gather the
1390   ** list of known remailers, and to finally send a message through the
1391   ** mixmaster chain.
1392   */
1393 #endif
1394   { "move",             DT_QUAD, R_NONE, OPT_MOVE, M_NO },
1395   /*
1396   ** .pp
1397   ** Controls whether or not Mutt will move read messages
1398   ** from your spool mailbox to your $$mbox mailbox, or as a result of
1399   ** a ``$mbox-hook'' command.
1400   */
1401 #if defined(USE_IMAP) || defined(USE_POP)
1402   { "message_cachedir", DT_PATH,        R_NONE, UL &MessageCachedir, 0 },
1403   /*
1404   ** .pp
1405   ** Set this to a directory and mutt will cache copies of messages from
1406   ** your IMAP and POP servers here. You are free to remove entries at any
1407   ** time.
1408   ** .pp
1409   ** When setting this variable to a directory, mutt needs to fetch every
1410   ** remote message only once and can perform regular expression searches
1411   ** as fast as for local folders.
1412   ** .pp
1413   ** Also see the $$message_cache_clean variable.
1414   */
1415   { "message_cache_clean", DT_BOOL, R_NONE, OPTMESSAGECACHECLEAN, 0 },
1416   /*
1417   ** .pp
1418   ** If \fIset\fP, mutt will clean out obsolete entries from the message cache when
1419   ** the mailbox is synchronized. You probably only want to set it
1420   ** every once in a while, since it can be a little slow
1421   ** (especially for large folders).
1422   */
1423 #endif
1424   { "message_format",   DT_STR,  R_NONE, UL &MsgFmt, UL "%s" },
1425   /*
1426   ** .pp
1427   ** This is the string displayed in the ``attachment'' menu for
1428   ** attachments of type \fCmessage/rfc822\fP.  For a full listing of defined
1429   ** \fCprintf(3)\fP-like sequences see the section on $$index_format.
1430   */
1431   { "msg_format",       DT_SYN,  R_NONE, UL "message_format", 0 },
1432   /*
1433   */
1434   { "narrow_tree",      DT_BOOL, R_TREE|R_INDEX, OPTNARROWTREE, 0 },
1435   /*
1436   ** .pp
1437   ** This variable, when \fIset\fP, makes the thread tree narrower, allowing
1438   ** deeper threads to fit on the screen.
1439   */
1440 #ifdef USE_SOCKET
1441   { "net_inc",  DT_NUM,  R_NONE, UL &NetInc, 10 },
1442   /*
1443    ** .pp
1444    ** Operations that expect to transfer a large amount of data over the
1445    ** network will update their progress every $$net_inc kilobytes.
1446    ** If set to 0, no progress messages will be displayed.
1447    ** .pp
1448    ** See also $$read_inc, $$write_inc and $$net_inc.
1449    */
1450 #endif
1451   { "pager",            DT_PATH, R_NONE, UL &Pager, UL "builtin" },
1452   /*
1453   ** .pp
1454   ** This variable specifies which pager you would like to use to view
1455   ** messages. The value ``builtin'' means to use the builtin pager, otherwise this
1456   ** variable should specify the pathname of the external pager you would
1457   ** like to use.
1458   ** .pp
1459   ** Using an external pager may have some disadvantages: Additional
1460   ** keystrokes are necessary because you can't call mutt functions
1461   ** directly from the pager, and screen resizes cause lines longer than
1462   ** the screen width to be badly formatted in the help menu.
1463   */
1464   { "pager_context",    DT_NUM,  R_NONE, UL &PagerContext, 0 },
1465   /*
1466   ** .pp
1467   ** This variable controls the number of lines of context that are given
1468   ** when displaying the next or previous page in the internal pager.  By
1469   ** default, Mutt will display the line after the last one on the screen
1470   ** at the top of the next page (0 lines of context).
1471   */
1472   { "pager_format",     DT_STR,  R_PAGER, UL &PagerFmt, UL "-%Z- %C/%m: %-20.20n   %s%*  -- (%P)" },
1473   /*
1474   ** .pp
1475   ** This variable controls the format of the one-line message ``status''
1476   ** displayed before each message in either the internal or an external
1477   ** pager.  The valid sequences are listed in the $$index_format
1478   ** section.
1479   */
1480   { "pager_index_lines",DT_NUM,  R_PAGER, UL &PagerIndexLines, 0 },
1481   /*
1482   ** .pp
1483   ** Determines the number of lines of a mini-index which is shown when in
1484   ** the pager.  The current message, unless near the top or bottom of the
1485   ** folder, will be roughly one third of the way down this mini-index,
1486   ** giving the reader the context of a few messages before and after the
1487   ** message.  This is useful, for example, to determine how many messages
1488   ** remain to be read in the current thread.  One of the lines is reserved
1489   ** for the status bar from the index, so a setting of 6
1490   ** will only show 5 lines of the actual index.  A value of 0 results in
1491   ** no index being shown.  If the number of messages in the current folder
1492   ** is less than $$pager_index_lines, then the index will only use as
1493   ** many lines as it needs.
1494   */
1495   { "pager_stop",       DT_BOOL, R_NONE, OPTPAGERSTOP, 0 },
1496   /*
1497   ** .pp
1498   ** When \fIset\fP, the internal-pager will \fBnot\fP move to the next message
1499   ** when you are at the end of a message and invoke the \fC<next-page>\fP
1500   ** function.
1501   */
1502   { "pgp_autosign",     DT_SYN,  R_NONE, UL "crypt_autosign", 0 },
1503   { "crypt_autosign",   DT_BOOL, R_NONE, OPTCRYPTAUTOSIGN, 0 },
1504   /*
1505   ** .pp
1506   ** Setting this variable will cause Mutt to always attempt to
1507   ** cryptographically sign outgoing messages.  This can be overridden
1508   ** by use of the pgp menu, when signing is not required or
1509   ** encryption is requested as well. If $$smime_is_default is \fIset\fP,
1510   ** then OpenSSL is used instead to create S/MIME messages and settings can
1511   ** be overridden by use of the smime menu instead of the pgp menu.
1512   ** (Crypto only)
1513   */
1514   { "pgp_autoencrypt",          DT_SYN,  R_NONE, UL "crypt_autoencrypt", 0 },
1515   { "crypt_autoencrypt",        DT_BOOL, R_NONE, OPTCRYPTAUTOENCRYPT, 0 },
1516   /*
1517   ** .pp
1518   ** Setting this variable will cause Mutt to always attempt to PGP
1519   ** encrypt outgoing messages.  This is probably only useful in
1520   ** connection to the ``$send-hook'' command.  It can be overridden
1521   ** by use of the pgp menu, when encryption is not required or
1522   ** signing is requested as well.  If $$smime_is_default is \fIset\fP,
1523   ** then OpenSSL is used instead to create S/MIME messages and
1524   ** settings can be overridden by use of the smime menu instead.
1525   ** (Crypto only)
1526   */
1527   { "pgp_ignore_subkeys", DT_BOOL, R_NONE, OPTPGPIGNORESUB, 1},
1528   /*
1529   ** .pp
1530   ** Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead,
1531   ** the principal key will inherit the subkeys' capabilities.  \fIUnset\fP this
1532   ** if you want to play interesting key selection games.
1533   ** (PGP only)
1534   */
1535   { "pgp_replyencrypt",         DT_SYN,  R_NONE, UL "crypt_replyencrypt", 1  },
1536   { "crypt_replyencrypt",       DT_BOOL, R_NONE, OPTCRYPTREPLYENCRYPT, 1 },
1537   /*
1538   ** .pp
1539   ** If \fIset\fP, automatically PGP or OpenSSL encrypt replies to messages which are
1540   ** encrypted.
1541   ** (Crypto only)
1542   */
1543   { "pgp_replysign",    DT_SYN, R_NONE, UL "crypt_replysign", 0 },
1544   { "crypt_replysign",  DT_BOOL, R_NONE, OPTCRYPTREPLYSIGN, 0 },
1545   /*
1546   ** .pp
1547   ** If \fIset\fP, automatically PGP or OpenSSL sign replies to messages which are
1548   ** signed.
1549   ** .pp
1550   ** \fBNote:\fP this does not work on messages that are encrypted
1551   ** \fIand\fP signed!
1552   ** (Crypto only)
1553   */
1554   { "pgp_replysignencrypted",   DT_SYN,  R_NONE, UL "crypt_replysignencrypted", 0},
1555   { "crypt_replysignencrypted", DT_BOOL, R_NONE, OPTCRYPTREPLYSIGNENCRYPTED, 0 },
1556   /*
1557   ** .pp
1558   ** If \fIset\fP, automatically PGP or OpenSSL sign replies to messages
1559   ** which are encrypted. This makes sense in combination with
1560   ** $$crypt_replyencrypt, because it allows you to sign all
1561   ** messages which are automatically encrypted.  This works around
1562   ** the problem noted in $$crypt_replysign, that mutt is not able
1563   ** to find out whether an encrypted message is also signed.
1564   ** (Crypto only)
1565   */
1566   { "crypt_timestamp", DT_BOOL, R_NONE, OPTCRYPTTIMESTAMP, 1 },
1567   /*
1568   ** .pp
1569   ** If \fIset\fP, mutt will include a time stamp in the lines surrounding
1570   ** PGP or S/MIME output, so spoofing such lines is more difficult.
1571   ** If you are using colors to mark these lines, and rely on these,
1572   ** you may \fIunset\fP this setting.
1573   ** (Crypto only)
1574   */
1575   { "pgp_use_gpg_agent", DT_BOOL, R_NONE, OPTUSEGPGAGENT, 0},
1576   /*
1577   ** .pp
1578   ** If \fIset\fP, mutt will use a possibly-running \fCgpg-agent(1)\fP process.
1579   ** (PGP only)
1580   */
1581   { "pgp_verify_sig",   DT_SYN,  R_NONE, UL "crypt_verify_sig", 0},
1582   { "crypt_verify_sig", DT_QUAD, R_NONE, OPT_VERIFYSIG, M_YES },
1583   /*
1584   ** .pp
1585   ** If \fI``yes''\fP, always attempt to verify PGP or S/MIME signatures.
1586   ** If \fI``ask-*''\fP, ask whether or not to verify the signature.
1587   ** If \Fi``no''\fP, never attempt to verify cryptographic signatures.
1588   ** (Crypto only)
1589   */
1590   { "smime_is_default", DT_BOOL,  R_NONE, OPTSMIMEISDEFAULT, 0},
1591   /*
1592   ** .pp
1593   ** The default behaviour of mutt is to use PGP on all auto-sign/encryption
1594   ** operations. To override and to use OpenSSL instead this must be \fIset\fP.
1595   ** However, this has no effect while replying, since mutt will automatically
1596   ** select the same application that was used to sign/encrypt the original
1597   ** message.  (Note that this variable can be overridden by unsetting $$crypt_autosmime.)
1598   ** (S/MIME only)
1599   */
1600   { "smime_ask_cert_label",     DT_BOOL, R_NONE, OPTASKCERTLABEL, 1 },
1601   /*
1602   ** .pp
1603   ** This flag controls whether you want to be asked to enter a label
1604   ** for a certificate about to be added to the database or not. It is
1605   ** \fIset\fP by default.
1606   ** (S/MIME only)
1607   */
1608   { "smime_decrypt_use_default_key",    DT_BOOL, R_NONE, OPTSDEFAULTDECRYPTKEY, 1 },
1609   /*
1610   ** .pp
1611   ** If \fIset\fP (default) this tells mutt to use the default key for decryption. Otherwise,
1612   ** if managing multiple certificate-key-pairs, mutt will try to use the mailbox-address
1613   ** to determine the key to use. It will ask you to supply a key, if it can't find one.
1614   ** (S/MIME only)
1615   */
1616   { "pgp_entry_format", DT_STR,  R_NONE, UL &PgpEntryFormat, UL "%4n %t%f %4l/0x%k %-4a %2c %u" },
1617   /*
1618   ** .pp
1619   ** This variable allows you to customize the PGP key selection menu to
1620   ** your personal taste. This string is similar to $$index_format, but
1621   ** has its own set of \fCprintf(3)\fP-like sequences:
1622   ** .dl
1623   ** .dt %n     .dd number
1624   ** .dt %k     .dd key id
1625   ** .dt %u     .dd user id
1626   ** .dt %a     .dd algorithm
1627   ** .dt %l     .dd key length
1628   ** .dt %f     .dd flags
1629   ** .dt %c     .dd capabilities
1630   ** .dt %t     .dd trust/validity of the key-uid association
1631   ** .dt %[<s>] .dd date of the key where <s> is an \fCstrftime(3)\fP expression
1632   ** .de
1633   ** .pp
1634   ** (PGP only)
1635   */
1636   { "pgp_good_sign",    DT_RX,  R_NONE, UL &PgpGoodSign, 0 },
1637   /*
1638   ** .pp
1639   ** If you assign a text to this variable, then a PGP signature is only
1640   ** considered verified if the output from $$pgp_verify_command contains
1641   ** the text. Use this variable if the exit code from the command is 0
1642   ** even for bad signatures.
1643   ** (PGP only)
1644   */
1645   { "pgp_check_exit",   DT_BOOL, R_NONE, OPTPGPCHECKEXIT, 1 },
1646   /*
1647   ** .pp
1648   ** If \fIset\fP, mutt will check the exit code of the PGP subprocess when
1649   ** signing or encrypting.  A non-zero exit code means that the
1650   ** subprocess failed.
1651   ** (PGP only)
1652   */
1653   { "pgp_long_ids",     DT_BOOL, R_NONE, OPTPGPLONGIDS, 0 },
1654   /*
1655   ** .pp
1656   ** If \fIset\fP, use 64 bit PGP key IDs, if \fIunset\fP use the normal 32 bit key IDs.
1657   ** (PGP only)
1658   */
1659   { "pgp_retainable_sigs", DT_BOOL, R_NONE, OPTPGPRETAINABLESIG, 0 },
1660   /*
1661   ** .pp
1662   ** If \fIset\fP, signed and encrypted messages will consist of nested
1663   ** \fCmultipart/signed\fP and \fCmultipart/encrypted\fP body parts.
1664   ** .pp
1665   ** This is useful for applications like encrypted and signed mailing
1666   ** lists, where the outer layer (\fCmultipart/encrypted\fP) can be easily
1667   ** removed, while the inner \fCmultipart/signed\fP part is retained.
1668   ** (PGP only)
1669   */
1670   { "pgp_create_traditional",   DT_SYN, R_NONE, UL "pgp_autoinline", 0 },
1671   { "pgp_autoinline",           DT_BOOL, R_NONE, OPTPGPAUTOINLINE, 0 },
1672   /*
1673   ** .pp
1674   ** This option controls whether Mutt generates old-style inline
1675   ** (traditional) PGP encrypted or signed messages under certain
1676   ** circumstances.  This can be overridden by use of the pgp menu,
1677   ** when inline is not required.
1678   ** .pp
1679   ** Note that Mutt might automatically use PGP/MIME for messages
1680   ** which consist of more than a single MIME part.  Mutt can be
1681   ** configured to ask before sending PGP/MIME messages when inline
1682   ** (traditional) would not work.
1683   ** .pp
1684   ** Also see the $$pgp_mime_auto variable.
1685   ** .pp
1686   ** Also note that using the old-style PGP message format is \fBstrongly\fP
1687   ** \fBdeprecated\fP.
1688   ** (PGP only)
1689   */
1690   { "pgp_auto_traditional",     DT_SYN, R_NONE, UL "pgp_replyinline", 0 },
1691   { "pgp_replyinline",          DT_BOOL, R_NONE, OPTPGPREPLYINLINE, 0 },
1692   /*
1693   ** .pp
1694   ** Setting this variable will cause Mutt to always attempt to
1695   ** create an inline (traditional) message when replying to a
1696   ** message which is PGP encrypted/signed inline.  This can be
1697   ** overridden by use of the pgp menu, when inline is not
1698   ** required.  This option does not automatically detect if the
1699   ** (replied-to) message is inline; instead it relies on Mutt
1700   ** internals for previously checked/flagged messages.
1701   ** .pp
1702   ** Note that Mutt might automatically use PGP/MIME for messages
1703   ** which consist of more than a single MIME part.  Mutt can be
1704   ** configured to ask before sending PGP/MIME messages when inline
1705   ** (traditional) would not work.
1706   ** .pp
1707   ** Also see the $$pgp_mime_auto variable.
1708   ** .pp
1709   ** Also note that using the old-style PGP message format is \fBstrongly\fP
1710   ** \fBdeprecated\fP.
1711   ** (PGP only)
1712   **
1713   */
1714   { "pgp_show_unusable", DT_BOOL, R_NONE, OPTPGPSHOWUNUSABLE, 1 },
1715   /*
1716   ** .pp
1717   ** If \fIset\fP, mutt will display non-usable keys on the PGP key selection
1718   ** menu.  This includes keys which have been revoked, have expired, or
1719   ** have been marked as ``disabled'' by the user.
1720   ** (PGP only)
1721   */
1722   { "pgp_sign_as",      DT_STR,  R_NONE, UL &PgpSignAs, 0 },
1723   /*
1724   ** .pp
1725   ** If you have more than one key pair, this option allows you to specify
1726   ** which of your private keys to use.  It is recommended that you use the
1727   ** keyid form to specify your key (e.g. \fC0x00112233\fP).
1728   ** (PGP only)
1729   */
1730   { "pgp_strict_enc",   DT_BOOL, R_NONE, OPTPGPSTRICTENC, 1 },
1731   /*
1732   ** .pp
1733   ** If \fIset\fP, Mutt will automatically encode PGP/MIME signed messages as
1734   ** quoted-printable.  Please note that unsetting this variable may
1735   ** lead to problems with non-verifyable PGP signatures, so only change
1736   ** this if you know what you are doing.
1737   ** (PGP only)
1738   */
1739   { "pgp_timeout",      DT_NUM,  R_NONE, UL &PgpTimeout, 300 },
1740   /*
1741   ** .pp
1742   ** The number of seconds after which a cached passphrase will expire if
1743   ** not used.
1744   ** (PGP only)
1745   */
1746   { "pgp_sort_keys",    DT_SORT|DT_SORT_KEYS, R_NONE, UL &PgpSortKeys, SORT_ADDRESS },
1747   /*
1748   ** .pp
1749   ** Specifies how the entries in the pgp menu are sorted. The
1750   ** following are legal values:
1751   ** .dl
1752   ** .dt address .dd sort alphabetically by user id
1753   ** .dt keyid   .dd sort alphabetically by key id
1754   ** .dt date    .dd sort by key creation date
1755   ** .dt trust   .dd sort by the trust of the key
1756   ** .de
1757   ** .pp
1758   ** If you prefer reverse order of the above values, prefix it with
1759   ** ``reverse-''.
1760   ** (PGP only)
1761   */
1762   { "pgp_mime_auto", DT_QUAD, R_NONE, OPT_PGPMIMEAUTO, M_ASKYES },
1763   /*
1764   ** .pp
1765   ** This option controls whether Mutt will prompt you for
1766   ** automatically sending a (signed/encrypted) message using
1767   ** PGP/MIME when inline (traditional) fails (for any reason).
1768   ** .pp
1769   ** Also note that using the old-style PGP message format is \fBstrongly\fP
1770   ** \fBdeprecated\fP.
1771   ** (PGP only)
1772   */
1773   { "pgp_auto_decode", DT_BOOL, R_NONE, OPTPGPAUTODEC, 0 },
1774   /*
1775   ** .pp
1776   ** If \fIset\fP, mutt will automatically attempt to decrypt traditional PGP
1777   ** messages whenever the user performs an operation which ordinarily would
1778   ** result in the contents of the message being operated on.  For example,
1779   ** if the user displays a pgp-traditional message which has not been manually
1780   ** checked with the \fC$<check-traditional-pgp>\fP function, mutt will automatically
1781   ** check the message for traditional pgp.
1782   */
1783
1784   /* XXX Default values! */
1785
1786   { "pgp_decode_command",       DT_STR, R_NONE, UL &PgpDecodeCommand, 0},
1787   /*
1788   ** .pp
1789   ** This format strings specifies a command which is used to decode
1790   ** application/pgp attachments.
1791   ** .pp
1792   ** The PGP command formats have their own set of \fCprintf(3)\fP-like sequences:
1793   ** .dl
1794   ** .dt %p .dd Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty
1795   **            string otherwise. Note: This may be used with a %? construct.
1796   ** .dt %f .dd Expands to the name of a file containing a message.
1797   ** .dt %s .dd Expands to the name of a file containing the signature part
1798   ** .          of a \fCmultipart/signed\fP attachment when verifying it.
1799   ** .dt %a .dd The value of $$pgp_sign_as.
1800   ** .dt %r .dd One or more key IDs.
1801   ** .de
1802   ** .pp
1803   ** For examples on how to configure these formats for the various versions
1804   ** of PGP which are floating around, see the pgp and gpg sample configuration files in
1805   ** the \fCsamples/\fP subdirectory which has been installed on your system
1806   ** alongside the documentation.
1807   ** (PGP only)
1808   */
1809   { "pgp_getkeys_command",      DT_STR, R_NONE, UL &PgpGetkeysCommand, 0},
1810   /*
1811   ** .pp
1812   ** This command is invoked whenever mutt will need public key information.
1813   ** Of the sequences supported by $$pgp_decode_command, %r is the only
1814   ** \fCprintf(3)\fP-like sequence used with this format.
1815   ** (PGP only)
1816   */
1817   { "pgp_verify_command",       DT_STR, R_NONE, UL &PgpVerifyCommand, 0},
1818   /*
1819   ** .pp
1820   ** This command is used to verify PGP signatures.
1821   ** .pp
1822   ** This is a format string, see the $$pgp_decode_command command for
1823   ** possible \fCprintf(3)\fP-like sequences.
1824   ** (PGP only)
1825   */
1826   { "pgp_decrypt_command",      DT_STR, R_NONE, UL &PgpDecryptCommand, 0},
1827   /*
1828   ** .pp
1829   ** This command is used to decrypt a PGP encrypted message.
1830   ** .pp
1831   ** This is a format string, see the $$pgp_decode_command command for
1832   ** possible \fCprintf(3)\fP-like sequences.
1833   ** (PGP only)
1834   */
1835   { "pgp_clearsign_command",    DT_STR, R_NONE, UL &PgpClearSignCommand, 0 },
1836   /*
1837   ** .pp
1838   ** This format is used to create a old-style ``clearsigned'' PGP
1839   ** message.  Note that the use of this format is \fBstrongly\fP
1840   ** \fBdeprecated\fP.
1841   ** .pp
1842   ** This is a format string, see the $$pgp_decode_command command for
1843   ** possible \fCprintf(3)\fP-like sequences.
1844   ** (PGP only)
1845   */
1846   { "pgp_sign_command",         DT_STR, R_NONE, UL &PgpSignCommand, 0},
1847   /*
1848   ** .pp
1849   ** This command is used to create the detached PGP signature for a
1850   ** \fCmultipart/signed\fP PGP/MIME body part.
1851   ** .pp
1852   ** This is a format string, see the $$pgp_decode_command command for
1853   ** possible \fCprintf(3)\fP-like sequences.
1854   ** (PGP only)
1855   */
1856   { "pgp_encrypt_sign_command", DT_STR, R_NONE, UL &PgpEncryptSignCommand, 0},
1857   /*
1858   ** .pp
1859   ** This command is used to both sign and encrypt a body part.
1860   ** .pp
1861   ** This is a format string, see the $$pgp_decode_command command for
1862   ** possible \fCprintf(3)\fP-like sequences.
1863   ** (PGP only)
1864   */
1865   { "pgp_encrypt_only_command", DT_STR, R_NONE, UL &PgpEncryptOnlyCommand, 0},
1866   /*
1867   ** .pp
1868   ** This command is used to encrypt a body part without signing it.
1869   ** .pp
1870   ** This is a format string, see the $$pgp_decode_command command for
1871   ** possible \fCprintf(3)\fP-like sequences.
1872   ** (PGP only)
1873   */
1874   { "pgp_import_command",       DT_STR, R_NONE, UL &PgpImportCommand, 0},
1875   /*
1876   ** .pp
1877   ** This command is used to import a key from a message into
1878   ** the user's public key ring.
1879   ** .pp
1880   ** This is a format string, see the $$pgp_decode_command command for
1881   ** possible \fCprintf(3)\fP-like sequences.
1882   ** (PGP only)
1883   */
1884   { "pgp_export_command",       DT_STR, R_NONE, UL &PgpExportCommand, 0},
1885   /*
1886   ** .pp
1887   ** This command is used to export a public key from the user's
1888   ** key ring.
1889   ** .pp
1890   ** This is a format string, see the $$pgp_decode_command command for
1891   ** possible \fCprintf(3)\fP-like sequences.
1892   ** (PGP only)
1893   */
1894   { "pgp_verify_key_command",   DT_STR, R_NONE, UL &PgpVerifyKeyCommand, 0},
1895   /*
1896   ** .pp
1897   ** This command is used to verify key information from the key selection
1898   ** menu.
1899   ** .pp
1900   ** This is a format string, see the $$pgp_decode_command command for
1901   ** possible \fCprintf(3)\fP-like sequences.
1902   ** (PGP only)
1903   */
1904   { "pgp_list_secring_command", DT_STR, R_NONE, UL &PgpListSecringCommand, 0},
1905   /*
1906   ** .pp
1907   ** This command is used to list the secret key ring's contents.  The
1908   ** output format must be analogous to the one used by:
1909   ** .ts
1910   ** gpg --list-keys --with-colons.
1911   ** .te
1912   ** .pp
1913   ** This format is also generated by the \fCpgpring\fP utility which comes
1914   ** with mutt.
1915   ** .pp
1916   ** This is a format string, see the $$pgp_decode_command command for
1917   ** possible \fCprintf(3)\fP-like sequences.
1918   ** (PGP only)
1919   */
1920   { "pgp_list_pubring_command", DT_STR, R_NONE, UL &PgpListPubringCommand, 0},
1921   /*
1922   ** .pp
1923   ** This command is used to list the public key ring's contents.  The
1924   ** output format must be analogous to the one used by
1925   ** .ts
1926   ** gpg --list-keys --with-colons.
1927   ** .te
1928   ** .pp
1929   ** This format is also generated by the \fCpgpring\fP utility which comes
1930   ** with mutt.
1931   ** .pp
1932   ** This is a format string, see the $$pgp_decode_command command for
1933   ** possible \fCprintf(3)\fP-like sequences.
1934   ** (PGP only)
1935   */
1936   { "forward_decrypt",  DT_BOOL, R_NONE, OPTFORWDECRYPT, 1 },
1937   /*
1938   ** .pp
1939   ** Controls the handling of encrypted messages when forwarding a message.
1940   ** When \fIset\fP, the outer layer of encryption is stripped off.  This
1941   ** variable is only used if $$mime_forward is \fIset\fP and
1942   ** $$mime_forward_decode is \fIunset\fP.
1943   ** (PGP only)
1944   */
1945   { "forw_decrypt",     DT_SYN,  R_NONE, UL "forward_decrypt", 0 },
1946   /*
1947   */
1948   { "smime_timeout",            DT_NUM,  R_NONE, UL &SmimeTimeout, 300 },
1949   /*
1950   ** .pp
1951   ** The number of seconds after which a cached passphrase will expire if
1952   ** not used.
1953   ** (S/MIME only)
1954   */
1955   { "smime_encrypt_with",       DT_STR,  R_NONE, UL &SmimeCryptAlg, 0 },
1956   /*
1957   ** .pp
1958   ** This sets the algorithm that should be used for encryption.
1959   ** Valid choices are ``des'', ``des3'', ``rc2-40'', ``rc2-64'', ``rc2-128''.
1960   ** If \fIunset\fP, ``3des'' (TripleDES) is used.
1961   ** (S/MIME only)
1962   */
1963   { "smime_keys",               DT_PATH, R_NONE, UL &SmimeKeys, 0 },
1964   /*
1965   ** .pp
1966   ** Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
1967   ** storage and retrieval of keys/certs by itself. This is very basic right now,
1968   ** and stores keys and certificates in two different directories, both
1969   ** named as the hash-value retrieved from OpenSSL. There is an index file
1970   ** which contains mailbox-address keyid pair, and which can be manually
1971   ** edited. This option points to the location of the private keys.
1972   ** (S/MIME only)
1973   */
1974   { "smime_ca_location",        DT_PATH, R_NONE, UL &SmimeCALocation, 0 },
1975   /*
1976   ** .pp
1977   ** This variable contains the name of either a directory, or a file which
1978   ** contains trusted certificates for use with OpenSSL.
1979   ** (S/MIME only)
1980   */
1981   { "smime_certificates",       DT_PATH, R_NONE, UL &SmimeCertificates, 0 },
1982   /*
1983   ** .pp
1984   ** Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
1985   ** storage and retrieval of keys by itself. This is very basic right
1986   ** now, and keys and certificates are stored in two different
1987   ** directories, both named as the hash-value retrieved from
1988   ** OpenSSL. There is an index file which contains mailbox-address
1989   ** keyid pairs, and which can be manually edited. This option points to
1990   ** the location of the certificates.
1991   ** (S/MIME only)
1992   */
1993   { "smime_decrypt_command",    DT_STR, R_NONE, UL &SmimeDecryptCommand, 0},
1994   /*
1995   ** .pp
1996   ** This format string specifies a command which is used to decrypt
1997   ** \fCapplication/x-pkcs7-mime\fP attachments.
1998   ** .pp
1999   ** The OpenSSL command formats have their own set of \fCprintf(3)\fP-like sequences
2000   ** similar to PGP's:
2001   ** .dl
2002   ** .dt %f .dd Expands to the name of a file containing a message.
2003   ** .dt %s .dd Expands to the name of a file containing the signature part
2004   ** .          of a \fCmultipart/signed\fP attachment when verifying it.
2005   ** .dt %k .dd The key-pair specified with $$smime_default_key
2006   ** .dt %c .dd One or more certificate IDs.
2007   ** .dt %a .dd The algorithm used for encryption.
2008   ** .dt %C .dd CA location:  Depending on whether $$smime_ca_location
2009   ** .          points to a directory or file, this expands to
2010   ** .          ``-CApath $$smime_ca_location'' or ``-CAfile $$smime_ca_location''.
2011   ** .de
2012   ** .pp
2013   ** For examples on how to configure these formats, see the \fCsmime.rc\fP in
2014   ** the \fCsamples/\fP subdirectory which has been installed on your system
2015   ** alongside the documentation.
2016   ** (S/MIME only)
2017   */
2018   { "smime_verify_command",     DT_STR, R_NONE, UL &SmimeVerifyCommand, 0},
2019   /*
2020   ** .pp
2021   ** This command is used to verify S/MIME signatures of type \fCmultipart/signed\fP.
2022   ** .pp
2023   ** This is a format string, see the $$smime_decrypt_command command for
2024   ** possible \fCprintf(3)\fP-like sequences.
2025   ** (S/MIME only)
2026   */
2027   { "smime_verify_opaque_command",      DT_STR, R_NONE, UL &SmimeVerifyOpaqueCommand, 0},
2028   /*
2029   ** .pp
2030   ** This command is used to verify S/MIME signatures of type
2031   ** \fCapplication/x-pkcs7-mime\fP.
2032   ** .pp
2033   ** This is a format string, see the $$smime_decrypt_command command for
2034   ** possible \fCprintf(3)\fP-like sequences.
2035   ** (S/MIME only)
2036   */
2037   { "smime_sign_command",       DT_STR, R_NONE, UL &SmimeSignCommand, 0},
2038   /*
2039   ** .pp
2040   ** This command is used to created S/MIME signatures of type
2041   ** \fCmultipart/signed\fP, which can be read by all mail clients.
2042   ** .pp
2043   ** This is a format string, see the $$smime_decrypt_command command for
2044   ** possible \fCprintf(3)\fP-like sequences.
2045   ** (S/MIME only)
2046   */
2047   { "smime_sign_opaque_command",        DT_STR, R_NONE, UL &SmimeSignOpaqueCommand, 0},
2048   /*
2049   ** .pp
2050   ** This command is used to created S/MIME signatures of type
2051   ** \fCapplication/x-pkcs7-signature\fP, which can only be handled by mail
2052   ** clients supporting the S/MIME extension.
2053   ** .pp
2054   ** This is a format string, see the $$smime_decrypt_command command for
2055   ** possible \fCprintf(3)\fP-like sequences.
2056   ** (S/MIME only)
2057   */
2058   { "smime_encrypt_command",    DT_STR, R_NONE, UL &SmimeEncryptCommand, 0},
2059   /*
2060   ** .pp
2061   ** This command is used to create encrypted S/MIME messages.
2062   ** .pp
2063   ** This is a format string, see the $$smime_decrypt_command command for
2064   ** possible \fCprintf(3)\fP-like sequences.
2065   ** (S/MIME only)
2066   */
2067   { "smime_pk7out_command",     DT_STR, R_NONE, UL &SmimePk7outCommand, 0},
2068   /*
2069   ** .pp
2070   ** This command is used to extract PKCS7 structures of S/MIME signatures,
2071   ** in order to extract the public X509 certificate(s).
2072   ** .pp
2073   ** This is a format string, see the $$smime_decrypt_command command for
2074   ** possible \fCprintf(3)\fP-like sequences.
2075   ** (S/MIME only)
2076   */
2077   { "smime_get_cert_command",   DT_STR, R_NONE, UL &SmimeGetCertCommand, 0},
2078   /*
2079   ** .pp
2080   ** This command is used to extract X509 certificates from a PKCS7 structure.
2081   ** .pp
2082   ** This is a format string, see the $$smime_decrypt_command command for
2083   ** possible \fCprintf(3)\fP-like sequences.
2084   ** (S/MIME only)
2085   */
2086   { "smime_get_signer_cert_command",    DT_STR, R_NONE, UL &SmimeGetSignerCertCommand, 0},
2087   /*
2088   ** .pp
2089   ** This command is used to extract only the signers X509 certificate from a S/MIME
2090   ** signature, so that the certificate's owner may get compared to the
2091   ** email's ``From:'' field.
2092   ** .pp
2093   ** This is a format string, see the $$smime_decrypt_command command for
2094   ** possible \fCprintf(3)\fP-like sequences.
2095   ** (S/MIME only)
2096   */
2097   { "smime_import_cert_command",        DT_STR, R_NONE, UL &SmimeImportCertCommand, 0},
2098   /*
2099   ** .pp
2100   ** This command is used to import a certificate via smime_keys.
2101   ** .pp
2102   ** This is a format string, see the $$smime_decrypt_command command for
2103   ** possible \fCprintf(3)\fP-like sequences.
2104   ** (S/MIME only)
2105   */
2106   { "smime_get_cert_email_command",     DT_STR, R_NONE, UL &SmimeGetCertEmailCommand, 0},
2107   /*
2108   ** .pp
2109   ** This command is used to extract the mail address(es) used for storing
2110   ** X509 certificates, and for verification purposes (to check whether the
2111   ** certificate was issued for the sender's mailbox).
2112   ** .pp
2113   ** This is a format string, see the $$smime_decrypt_command command for
2114   ** possible \fCprintf(3)\fP-like sequences.
2115   ** (S/MIME only)
2116   */
2117   { "smime_sign_as",                    DT_SYN,  R_NONE, UL "smime_default_key", 0 },
2118   { "smime_default_key",                DT_STR,  R_NONE, UL &SmimeDefaultKey, 0 },
2119   /*
2120   ** .pp
2121   ** This is the default key-pair to use for signing. This must be set to the
2122   ** keyid (the hash-value that OpenSSL generates) to work properly
2123   ** (S/MIME only)
2124   */
2125 #if defined(USE_SSL)
2126   { "ssl_client_cert", DT_PATH, R_NONE, UL &SslClientCert, 0 },
2127   /*
2128   ** .pp
2129   ** The file containing a client certificate and its associated private
2130   ** key.
2131   */
2132   { "ssl_force_tls",            DT_BOOL, R_NONE, OPTSSLFORCETLS, 0 },
2133   /*
2134    ** .pp
2135    ** If this variable is \fIset\fP, Mutt will require that all connections
2136    ** to remote servers be encrypted. Furthermore it will attempt to
2137    ** negotiate TLS even if the server does not advertise the capability,
2138    ** since it would otherwise have to abort the connection anyway. This
2139    ** option supersedes $$ssl_starttls.
2140    */
2141   { "ssl_starttls", DT_QUAD, R_NONE, OPT_SSLSTARTTLS, M_YES },
2142   /*
2143   ** .pp
2144   ** If \fIset\fP (the default), mutt will attempt to use \fCSTARTTLS\fP on servers
2145   ** advertising the capability. When \fIunset\fP, mutt will not attempt to
2146   ** use \fCSTARTTLS\fP regardless of the server's capabilities.
2147   */
2148   { "certificate_file", DT_PATH, R_NONE, UL &SslCertFile, UL "~/.mutt_certificates" },
2149   /*
2150   ** .pp
2151   ** This variable specifies the file where the certificates you trust
2152   ** are saved. When an unknown certificate is encountered, you are asked
2153   ** if you accept it or not. If you accept it, the certificate can also
2154   ** be saved in this file and further connections are automatically
2155   ** accepted.
2156   ** .pp
2157   ** You can also manually add CA certificates in this file. Any server
2158   ** certificate that is signed with one of these CA certificates is
2159   ** also automatically accepted.
2160   ** .pp
2161   ** Example:
2162   ** .ts
2163   ** set certificate_file=~/.mutt/certificates
2164   ** .te
2165   */
2166 # ifdef USE_SSL_OPENSSL
2167   { "ssl_usesystemcerts", DT_BOOL, R_NONE, OPTSSLSYSTEMCERTS, 1 },
2168   /*
2169   ** .pp
2170   ** If set to \fIyes\fP, mutt will use CA certificates in the
2171   ** system-wide certificate store when checking if a server certificate
2172   ** is signed by a trusted CA.
2173   */
2174   { "entropy_file",     DT_PATH, R_NONE, UL &SslEntropyFile, 0 },
2175   /*
2176   ** .pp
2177   ** The file which includes random data that is used to initialize SSL
2178   ** library functions.
2179    */
2180   { "ssl_use_sslv2", DT_BOOL, R_NONE, OPTSSLV2, 1 },
2181   /*
2182   ** .pp
2183   ** This variables specifies whether to attempt to use SSLv2 in the
2184   ** SSL authentication process.
2185   */
2186 # endif /* defined USE_SSL_OPENSSL */
2187   { "ssl_use_sslv3", DT_BOOL, R_NONE, OPTSSLV3, 1 },
2188   /*
2189   ** .pp
2190   ** This variables specifies whether to attempt to use SSLv3 in the
2191   ** SSL authentication process.
2192   */
2193   { "ssl_use_tlsv1", DT_BOOL, R_NONE, OPTTLSV1, 1 },
2194   /*
2195   ** .pp
2196   ** This variables specifies whether to attempt to use TLSv1 in the
2197   ** SSL authentication process.
2198   */
2199 # ifdef USE_SSL_GNUTLS
2200   { "ssl_min_dh_prime_bits", DT_NUM, R_NONE, UL &SslDHPrimeBits, 0 },
2201   /*
2202   ** .pp
2203   ** This variable specifies the minimum acceptable prime size (in bits)
2204   ** for use in any Diffie-Hellman key exchange. A value of 0 will use
2205   ** the default from the GNUTLS library.
2206   */
2207   { "ssl_ca_certificates_file", DT_PATH, R_NONE, UL &SslCACertFile, 0 },
2208   /*
2209   ** .pp
2210   ** This variable specifies a file containing trusted CA certificates.
2211   ** Any server certificate that is signed with one of these CA
2212   ** certificates is also automatically accepted.
2213   ** .pp
2214   ** Example:
2215   ** .ts
2216   ** set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
2217   ** .te
2218   */
2219 # endif /* USE_SSL_GNUTLS */
2220 #endif /* defined(USE_SSL) */
2221   { "pipe_split",       DT_BOOL, R_NONE, OPTPIPESPLIT, 0 },
2222   /*
2223   ** .pp
2224   ** Used in connection with the \fC<pipe-message>\fP function following
2225   ** \fC<tag-prefix>\fP.  If this variable is \fIunset\fP, when piping a list of
2226   ** tagged messages Mutt will concatenate the messages and will pipe them
2227   ** all concatenated.  When \fIset\fP, Mutt will pipe the messages one by one.
2228   ** In both cases the messages are piped in the current sorted order,
2229   ** and the $$pipe_sep separator is added after each message.
2230   */
2231   { "pipe_decode",      DT_BOOL, R_NONE, OPTPIPEDECODE, 0 },
2232   /*
2233   ** .pp
2234   ** Used in connection with the \fC<pipe-message>\fP command.  When \fIunset\fP,
2235   ** Mutt will pipe the messages without any preprocessing. When \fIset\fP, Mutt
2236   ** will weed headers and will attempt to decode the messages
2237   ** first.
2238   */
2239   { "pipe_sep",         DT_STR,  R_NONE, UL &PipeSep, UL "\n" },
2240   /*
2241   ** .pp
2242   ** The separator to add between messages when piping a list of tagged
2243   ** messages to an external Unix command.
2244   */
2245 #ifdef USE_POP
2246   { "pop_authenticators", DT_STR, R_NONE, UL &PopAuthenticators, UL 0 },
2247   /*
2248   ** .pp
2249   ** This is a colon-delimited list of authentication methods mutt may
2250   ** attempt to use to log in to an POP server, in the order mutt should
2251   ** try them.  Authentication methods are either ``user'', ``apop'' or any
2252   ** SASL mechanism, eg ``digest-md5'', ``gssapi'' or ``cram-md5''.
2253   ** This option is case-insensitive. If this option is \fIunset\fP
2254   ** (the default) mutt will try all available methods, in order from
2255   ** most-secure to least-secure.
2256   ** .pp
2257   ** Example:
2258   ** .ts
2259   ** set pop_authenticators="digest-md5:apop:user"
2260   ** .te
2261   */
2262   { "pop_auth_try_all", DT_BOOL, R_NONE, OPTPOPAUTHTRYALL, 1 },
2263   /*
2264   ** .pp
2265   ** If \fIset\fP, Mutt will try all available authentication methods.
2266   ** When \fIunset\fP, Mutt will only fall back to other authentication
2267   ** methods if the previous methods are unavailable. If a method is
2268   ** available but authentication fails, Mutt will not connect to the POP server.
2269   */
2270   { "pop_checkinterval", DT_NUM, R_NONE, UL &PopCheckTimeout, 60 },
2271   /*
2272   ** .pp
2273   ** This variable configures how often (in seconds) mutt should look for
2274   ** new mail in the currently selected mailbox if it is a POP mailbox.
2275   */
2276   { "pop_delete",       DT_QUAD, R_NONE, OPT_POPDELETE, M_ASKNO },
2277   /*
2278   ** .pp
2279   ** If \fIset\fP, Mutt will delete successfully downloaded messages from the POP
2280   ** server when using the \fC$<fetch-mail>\fP function.  When \fIunset\fP, Mutt will
2281   ** download messages but also leave them on the POP server.
2282   */
2283   { "pop_host",         DT_STR,  R_NONE, UL &PopHost, UL "" },
2284   /*
2285   ** .pp
2286   ** The name of your POP server for the \fC$<fetch-mail>\fP function.  You
2287   ** can also specify an alternative port, username and password, ie:
2288   ** .ts
2289   ** [pop[s]://][username[:password]@]popserver[:port]
2290   ** .te
2291   ** .pp
2292   ** where ``[...]'' denotes an optional part.
2293   */
2294   { "pop_last",         DT_BOOL, R_NONE, OPTPOPLAST, 0 },
2295   /*
2296   ** .pp
2297   ** If this variable is \fIset\fP, mutt will try to use the ``\fCLAST\fP'' POP command
2298   ** for retrieving only unread messages from the POP server when using
2299   ** the \fC$<fetch-mail>\fP function.
2300   */
2301   { "pop_reconnect",    DT_QUAD, R_NONE, OPT_POPRECONNECT, M_ASKYES },
2302   /*
2303   ** .pp
2304   ** Controls whether or not Mutt will try to reconnect to the POP server if
2305   ** the connection is lost.
2306   */
2307   { "pop_user",         DT_STR,  R_NONE, UL &PopUser, 0 },
2308   /*
2309   ** .pp
2310   ** Your login name on the POP server.
2311   ** .pp
2312   ** This variable defaults to your user name on the local machine.
2313   */
2314   { "pop_pass",         DT_STR,  R_NONE, UL &PopPass, UL "" },
2315   /*
2316   ** .pp
2317   ** Specifies the password for your POP account.  If \fIunset\fP, Mutt will
2318   ** prompt you for your password when you open a POP mailbox.
2319   ** .pp
2320   ** \fBWarning\fP: you should only use this option when you are on a
2321   ** fairly secure machine, because the superuser can read your muttrc
2322   ** even if you are the only one who can read the file.
2323   */
2324 #endif /* USE_POP */
2325   { "post_indent_string",DT_STR, R_NONE, UL &PostIndentString, UL "" },
2326   /*
2327   ** .pp
2328   ** Similar to the $$attribution variable, Mutt will append this
2329   ** string after the inclusion of a message which is being replied to.
2330   */
2331   { "post_indent_str",  DT_SYN,  R_NONE, UL "post_indent_string", 0 },
2332   /*
2333   */
2334   { "postpone",         DT_QUAD, R_NONE, OPT_POSTPONE, M_ASKYES },
2335   /*
2336   ** .pp
2337   ** Controls whether or not messages are saved in the $$postponed
2338   ** mailbox when you elect not to send immediately.
2339   ** .pp
2340   ** Also see the $$recall variable.
2341   */
2342   { "postponed",        DT_PATH, R_NONE, UL &Postponed, UL "~/postponed" },
2343   /*
2344   ** .pp
2345   ** Mutt allows you to indefinitely ``$postpone sending a message'' which
2346   ** you are editing.  When you choose to postpone a message, Mutt saves it
2347   ** in the mailbox specified by this variable.
2348   ** .pp
2349   ** Also see the $$postpone variable.
2350   */
2351 #ifdef USE_SOCKET
2352   { "preconnect",       DT_STR, R_NONE, UL &Preconnect, UL 0},
2353   /*
2354   ** .pp
2355   ** If \fIset\fP, a shell command to be executed if mutt fails to establish
2356   ** a connection to the server. This is useful for setting up secure
2357   ** connections, e.g. with \fCssh(1)\fP. If the command returns a  nonzero
2358   ** status, mutt gives up opening the server. Example:
2359   ** .ts
2360   ** set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net \(rs
2361   ** sleep 20 < /dev/null > /dev/null"
2362   ** .te
2363   ** .pp
2364   ** Mailbox ``foo'' on ``mailhost.net'' can now be reached
2365   ** as ``{localhost:1234}foo''.
2366   ** .pp
2367   ** Note: For this example to work, you must be able to log in to the
2368   ** remote machine without having to enter a password.
2369   */
2370 #endif /* USE_SOCKET */
2371   { "print",            DT_QUAD, R_NONE, OPT_PRINT, M_ASKNO },
2372   /*
2373   ** .pp
2374   ** Controls whether or not Mutt really prints messages.
2375   ** This is set to ``ask-no'' by default, because some people
2376   ** accidentally hit ``p'' often.
2377   */
2378   { "print_command",    DT_PATH, R_NONE, UL &PrintCmd, UL "lpr" },
2379   /*
2380   ** .pp
2381   ** This specifies the command pipe that should be used to print messages.
2382   */
2383   { "print_cmd",        DT_SYN,  R_NONE, UL "print_command", 0 },
2384   /*
2385   */
2386   { "print_decode",     DT_BOOL, R_NONE, OPTPRINTDECODE, 1 },
2387   /*
2388   ** .pp
2389   ** Used in connection with the \fC<print-message>\fP command.  If this
2390   ** option is \fIset\fP, the message is decoded before it is passed to the
2391   ** external command specified by $$print_command.  If this option
2392   ** is \fIunset\fP, no processing will be applied to the message when
2393   ** printing it.  The latter setting may be useful if you are using
2394   ** some advanced printer filter which is able to properly format
2395   ** e-mail messages for printing.
2396   */
2397   { "print_split",      DT_BOOL, R_NONE, OPTPRINTSPLIT,  0 },
2398   /*
2399   ** .pp
2400   ** Used in connection with the \fC<print-message>\fP command.  If this option
2401   ** is \fIset\fP, the command specified by $$print_command is executed once for
2402   ** each message which is to be printed.  If this option is \fIunset\fP,
2403   ** the command specified by $$print_command is executed only once, and
2404   ** all the messages are concatenated, with a form feed as the message
2405   ** separator.
2406   ** .pp
2407   ** Those who use the \fCenscript\fP(1) program's mail-printing mode will
2408   ** most likely want to \fIset\fP this option.
2409   */
2410   { "prompt_after",     DT_BOOL, R_NONE, OPTPROMPTAFTER, 1 },
2411   /*
2412   ** .pp
2413   ** If you use an \fIexternal\fP $$pager, setting this variable will
2414   ** cause Mutt to prompt you for a command when the pager exits rather
2415   ** than returning to the index menu.  If \fIunset\fP, Mutt will return to the
2416   ** index menu when the external pager exits.
2417   */
2418   { "query_command",    DT_PATH, R_NONE, UL &QueryCmd, UL "" },
2419   /*
2420   ** .pp
2421   ** This specifies the command that mutt will use to make external address
2422   ** queries.  The string should contain a ``%s'', which will be substituted
2423   ** with the query string the user types.  See ``$query'' for more
2424   ** information.
2425   */
2426   { "query_format",     DT_STR, R_NONE, UL &QueryFormat, UL "%4c %t %-25.25a %-25.25n %?e?(%e)?" },
2427   /*
2428   ** .pp
2429   ** This variable describes the format of the ``query'' menu. The
2430   ** following \fCprintf(3)\fP-style sequences are understood:
2431   ** .dl
2432   ** .dt %a  .dd destination address
2433   ** .dt %c  .dd current entry number
2434   ** .dt %e  .dd extra information *
2435   ** .dt %n  .dd destination name
2436   ** .dt %t  .dd ``*'' if current entry is tagged, a space otherwise
2437   ** .dt %>X .dd right justify the rest of the string and pad with ``X''
2438   ** .dt %|X .dd pad to the end of the line with ``X''
2439   ** .dt %*X .dd soft-fill with character ``X'' as pad
2440   ** .de
2441   ** .pp
2442   ** For an explanation of ``soft-fill'', see the $$index_format documentation.
2443   ** .pp
2444   ** * = can be optionally printed if nonzero, see the $$status_format documentation.
2445   */
2446   { "quit",             DT_QUAD, R_NONE, OPT_QUIT, M_YES },
2447   /*
2448   ** .pp
2449   ** This variable controls whether ``quit'' and ``exit'' actually quit
2450   ** from mutt.  If this option is \fIset\fP, they do quit, if it is \fIunset\fP, they
2451   ** have no effect, and if it is set to \fIask-yes\fP or \fIask-no\fP, you are
2452   ** prompted for confirmation when you try to quit.
2453   */
2454   { "quote_regexp",     DT_RX,   R_PAGER, UL &QuoteRegexp, UL "^([ \t]*[|>:}#])+" },
2455   /*
2456   ** .pp
2457   ** A regular expression used in the internal pager to determine quoted
2458   ** sections of text in the body of a message. Quoted text may be filtered
2459   ** out using the \fC<toggle-quoted>\fP command, or colored according to the
2460   ** ``color quoted'' family of directives.
2461   ** .pp
2462   ** Higher levels of quoting may be colored differently (``color quoted1'',
2463   ** ``color quoted2'', etc.). The quoting level is determined by removing
2464   ** the last character from the matched text and recursively reapplying
2465   ** the regular expression until it fails to produce a match.
2466   ** .pp
2467   ** Match detection may be overridden by the $$smileys regular expression.
2468   */
2469   { "read_inc",         DT_NUM,  R_NONE, UL &ReadInc, 10 },
2470   /*
2471   ** .pp
2472   ** If set to a value greater than 0, Mutt will display which message it
2473   ** is currently on when reading a mailbox or when performing search actions
2474   ** such as search and limit. The message is printed after
2475   ** this many messages have been read or searched (e.g., if set to 25, Mutt will
2476   ** print a message when it is at message 25, and then again when it gets
2477   ** to message 50).  This variable is meant to indicate progress when
2478   ** reading or searching large mailboxes which may take some time.
2479   ** When set to 0, only a single message will appear before the reading
2480   ** the mailbox.
2481   ** .pp
2482   ** Also see the $$write_inc, $$net_inc and $$time_inc variables and the
2483   ** ``$tuning'' section of the manual for performance considerations.
2484   */
2485   { "read_only",        DT_BOOL, R_NONE, OPTREADONLY, 0 },
2486   /*
2487   ** .pp
2488   ** If \fIset\fP, all folders are opened in read-only mode.
2489   */
2490   { "realname",         DT_STR,  R_BOTH, UL &Realname, 0 },
2491   /*
2492   ** .pp
2493   ** This variable specifies what ``real'' or ``personal'' name should be used
2494   ** when sending messages.
2495   ** .pp
2496   ** By default, this is the GECOS field from \fC/etc/passwd\fP.  Note that this
2497   ** variable will \fInot\fP be used when the user has set a real name
2498   ** in the $$from variable.
2499   */
2500   { "recall",           DT_QUAD, R_NONE, OPT_RECALL, M_ASKYES },
2501   /*
2502   ** .pp
2503   ** Controls whether or not Mutt recalls postponed messages
2504   ** when composing a new message.
2505   ** .pp
2506   ** \fISetting\fP this variable to is not generally useful, and thus not
2507   ** recommended.
2508   ** .pp
2509   ** Also see $$postponed variable.
2510   */
2511   { "record",           DT_PATH, R_NONE, UL &Outbox, UL "~/sent" },
2512   /*
2513   ** .pp
2514   ** This specifies the file into which your outgoing messages should be
2515   ** appended.  (This is meant as the primary method for saving a copy of
2516   ** your messages, but another way to do this is using the ``$my_hdr''
2517   ** command to create a ``Bcc:'' field with your email address in it.)
2518   ** .pp
2519   ** The value of \fI$$record\fP is overridden by the $$force_name and
2520   ** $$save_name variables, and the ``$fcc-hook'' command.
2521   */
2522   { "reply_regexp",     DT_RX,   R_INDEX|R_RESORT, UL &ReplyRegexp, UL "^(re([\\[0-9\\]+])*|aw):[ \t]*" },
2523   /*
2524   ** .pp
2525   ** A regular expression used to recognize reply messages when threading
2526   ** and replying. The default value corresponds to the English "Re:" and
2527   ** the German "Aw:".
2528   */
2529   { "reply_self",       DT_BOOL, R_NONE, OPTREPLYSELF, 0 },
2530   /*
2531   ** .pp
2532   ** If \fIunset\fP and you are replying to a message sent by you, Mutt will
2533   ** assume that you want to reply to the recipients of that message rather
2534   ** than to yourself.
2535   ** .pp
2536   ** Also see the ``$alternates'' command.
2537   */
2538   { "reply_to",         DT_QUAD, R_NONE, OPT_REPLYTO, M_ASKYES },
2539   /*
2540   ** .pp
2541   ** If \fIset\fP, when replying to a message, Mutt will use the address listed
2542   ** in the Reply-to: header as the recipient of the reply.  If \fIunset\fP,
2543   ** it will use the address in the From: header field instead.  This
2544   ** option is useful for reading a mailing list that sets the Reply-To:
2545   ** header field to the list address and you want to send a private
2546   ** message to the author of a message.
2547   */
2548   { "resolve",          DT_BOOL, R_NONE, OPTRESOLVE, 1 },
2549   /*
2550   ** .pp
2551   ** When \fIset\fP, the cursor will be automatically advanced to the next
2552   ** (possibly undeleted) message whenever a command that modifies the
2553   ** current message is executed.
2554   */
2555   { "reverse_alias",    DT_BOOL, R_BOTH, OPTREVALIAS, 0 },
2556   /*
2557   ** .pp
2558   ** This variable controls whether or not Mutt will display the ``personal''
2559   ** name from your aliases in the index menu if it finds an alias that
2560   ** matches the message's sender.  For example, if you have the following
2561   ** alias:
2562   ** .ts
2563   ** alias juser abd30425@somewhere.net (Joe User)
2564   ** .te
2565   ** .pp
2566   ** and then you receive mail which contains the following header:
2567   ** .ts
2568   ** From: abd30425@somewhere.net
2569   ** .te
2570   ** .pp
2571   ** It would be displayed in the index menu as ``Joe User'' instead of
2572   ** ``abd30425@somewhere.net.''  This is useful when the person's e-mail
2573   ** address is not human friendly.
2574   */
2575   { "reverse_name",     DT_BOOL, R_BOTH, OPTREVNAME, 0 },
2576   /*
2577   ** .pp
2578   ** It may sometimes arrive that you receive mail to a certain machine,
2579   ** move the messages to another machine, and reply to some the messages
2580   ** from there.  If this variable is \fIset\fP, the default \fIFrom:\fP line of
2581   ** the reply messages is built using the address where you received the
2582   ** messages you are replying to \fBif\fP that address matches your
2583   ** ``$alternates''.  If the variable is \fIunset\fP, or the address that would be
2584   ** used doesn't match your ``$alternates'', the \fIFrom:\fP line will use
2585   ** your address on the current machine.
2586   ** .pp
2587   ** Also see the ``$alternates'' command.
2588   */
2589   { "reverse_realname", DT_BOOL, R_BOTH, OPTREVREAL, 1 },
2590   /*
2591   ** .pp
2592   ** This variable fine-tunes the behaviour of the $$reverse_name feature.
2593   ** When it is \fIset\fP, mutt will use the address from incoming messages as-is,
2594   ** possibly including eventual real names.  When it is \fIunset\fP, mutt will
2595   ** override any such real names with the setting of the $$realname variable.
2596   */
2597   { "rfc2047_parameters", DT_BOOL, R_NONE, OPTRFC2047PARAMS, 0 },
2598   /*
2599   ** .pp
2600   ** When this variable is \fIset\fP, Mutt will decode RFC2047-encoded MIME
2601   ** parameters. You want to set this variable when mutt suggests you
2602   ** to save attachments to files named like:
2603   ** .ts
2604   ** =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
2605   ** .te
2606   ** .pp
2607   ** When this variable is \fIset\fP interactively, the change won't be
2608   ** active until you change folders.
2609   ** .pp
2610   ** Note that this use of RFC2047's encoding is explicitly
2611   ** prohibited by the standard, but nevertheless encountered in the
2612   ** wild.
2613   ** .pp
2614   ** Also note that setting this parameter will \fInot\fP have the effect
2615   ** that mutt \fIgenerates\fP this kind of encoding.  Instead, mutt will
2616   ** unconditionally use the encoding specified in RFC2231.
2617   */
2618   { "save_address",     DT_BOOL, R_NONE, OPTSAVEADDRESS, 0 },
2619   /*
2620   ** .pp
2621   ** If \fIset\fP, mutt will take the sender's full address when choosing a
2622   ** default folder for saving a mail. If $$save_name or $$force_name
2623   ** is \fIset\fP too, the selection of the Fcc folder will be changed as well.
2624   */
2625   { "save_empty",       DT_BOOL, R_NONE, OPTSAVEEMPTY, 1 },
2626   /*
2627   ** .pp
2628   ** When \fIunset\fP, mailboxes which contain no saved messages will be removed
2629   ** when closed (the exception is $$spoolfile which is never removed).
2630   ** If \fIset\fP, mailboxes are never removed.
2631   ** .pp
2632   ** \fBNote:\fP This only applies to mbox and MMDF folders, Mutt does not
2633   ** delete MH and Maildir directories.
2634   */
2635   { "save_history",     DT_NUM,  R_NONE, UL &SaveHist, 0 },
2636   /*
2637   ** .pp
2638   ** This variable controls the size of the history (per category) saved in the
2639   ** $$history_file file.
2640   */
2641   { "save_name",        DT_BOOL, R_NONE, OPTSAVENAME, 0 },
2642   /*
2643   ** .pp
2644   ** This variable controls how copies of outgoing messages are saved.
2645   ** When \fIset\fP, a check is made to see if a mailbox specified by the
2646   ** recipient address exists (this is done by searching for a mailbox in
2647   ** the $$folder directory with the \fIusername\fP part of the
2648   ** recipient address).  If the mailbox exists, the outgoing message will
2649   ** be saved to that mailbox, otherwise the message is saved to the
2650   ** $$record mailbox.
2651   ** .pp
2652   ** Also see the $$force_name variable.
2653   */
2654   { "score",            DT_BOOL, R_NONE, OPTSCORE, 1 },
2655   /*
2656   ** .pp
2657   ** When this variable is \fIunset\fP, scoring is turned off.  This can
2658   ** be useful to selectively disable scoring for certain folders when the
2659   ** $$score_threshold_delete variable and related are used.
2660   **
2661   */
2662   { "score_threshold_delete", DT_NUM, R_NONE, UL &ScoreThresholdDelete, UL -1 },
2663   /*
2664   ** .pp
2665   ** Messages which have been assigned a score equal to or lower than the value
2666   ** of this variable are automatically marked for deletion by mutt.  Since
2667   ** mutt scores are always greater than or equal to zero, the default setting
2668   ** of this variable will never mark a message for deletion.
2669   */
2670   { "score_threshold_flag", DT_NUM, R_NONE, UL &ScoreThresholdFlag, 9999 },
2671   /*
2672   ** .pp
2673   ** Messages which have been assigned a score greater than or equal to this
2674   ** variable's value are automatically marked "flagged".
2675   */
2676   { "score_threshold_read", DT_NUM, R_NONE, UL &ScoreThresholdRead, UL -1 },
2677   /*
2678   ** .pp
2679   ** Messages which have been assigned a score equal to or lower than the value
2680   ** of this variable are automatically marked as read by mutt.  Since
2681   ** mutt scores are always greater than or equal to zero, the default setting
2682   ** of this variable will never mark a message read.
2683   */
2684   { "send_charset",     DT_STR,  R_NONE, UL &SendCharset, UL "us-ascii:iso-8859-1:utf-8" },
2685   /*
2686   ** .pp
2687   ** A colon-delimited list of character sets for outgoing messages. Mutt will use the
2688   ** first character set into which the text can be converted exactly.
2689   ** If your $$charset is not ``iso-8859-1'' and recipients may not
2690   ** understand ``UTF-8'', it is advisable to include in the list an
2691   ** appropriate widely used standard character set (such as
2692   ** ``iso-8859-2'', ``koi8-r'' or ``iso-2022-jp'') either instead of or after
2693   ** ``iso-8859-1''.
2694   ** .pp
2695   ** In case the text cannot be converted into one of these exactly,
2696   ** mutt uses $$charset as a fallback.
2697   */
2698   { "sendmail",         DT_PATH, R_NONE, UL &Sendmail, UL SENDMAIL " -oem -oi" },
2699   /*
2700   ** .pp
2701   ** Specifies the program and arguments used to deliver mail sent by Mutt.
2702   ** Mutt expects that the specified program interprets additional
2703   ** arguments as recipient addresses.
2704   */
2705   { "sendmail_wait",    DT_NUM,  R_NONE, UL &SendmailWait, 0 },
2706   /*
2707   ** .pp
2708   ** Specifies the number of seconds to wait for the $$sendmail process
2709   ** to finish before giving up and putting delivery in the background.
2710   ** .pp
2711   ** Mutt interprets the value of this variable as follows:
2712   ** .dl
2713   ** .dt >0 .dd number of seconds to wait for sendmail to finish before continuing
2714   ** .dt 0  .dd wait forever for sendmail to finish
2715   ** .dt <0 .dd always put sendmail in the background without waiting
2716   ** .de
2717   ** .pp
2718   ** Note that if you specify a value other than 0, the output of the child
2719   ** process will be put in a temporary file.  If there is some error, you
2720   ** will be informed as to where to find the output.
2721   */
2722   { "shell",            DT_PATH, R_NONE, UL &Shell, 0 },
2723   /*
2724   ** .pp
2725   ** Command to use when spawning a subshell.  By default, the user's login
2726   ** shell from \fC/etc/passwd\fP is used.
2727   */
2728   { "sig_dashes",       DT_BOOL, R_NONE, OPTSIGDASHES, 1 },
2729   /*
2730   ** .pp
2731   ** If \fIset\fP, a line containing ``-- '' (note the trailing space) will be inserted before your
2732   ** $$signature.  It is \fBstrongly\fP recommended that you not \fIunset\fP
2733   ** this variable unless your signature contains just your name.  The
2734   ** reason for this is because many software packages use ``-- \n'' to
2735   ** detect your signature.  For example, Mutt has the ability to highlight
2736   ** the signature in a different color in the builtin pager.
2737   */
2738   { "sig_on_top",       DT_BOOL, R_NONE, OPTSIGONTOP, 0},
2739   /*
2740   ** .pp
2741   ** If \fIset\fP, the signature will be included before any quoted or forwarded
2742   ** text.  It is \fBstrongly\fP recommended that you do not set this variable
2743   ** unless you really know what you are doing, and are prepared to take
2744   ** some heat from netiquette guardians.
2745   */
2746   { "signature",        DT_PATH, R_NONE, UL &Signature, UL "~/.signature" },
2747   /*
2748   ** .pp
2749   ** Specifies the filename of your signature, which is appended to all
2750   ** outgoing messages.   If the filename ends with a pipe (``|''), it is
2751   ** assumed that filename is a shell command and input should be read from
2752   ** its standard output.
2753   */
2754   { "simple_search",    DT_STR,  R_NONE, UL &SimpleSearch, UL "~f %s | ~s %s" },
2755   /*
2756   ** .pp
2757   ** Specifies how Mutt should expand a simple search into a real search
2758   ** pattern.  A simple search is one that does not contain any of the ``~'' pattern
2759   ** operators.  See ``$patterns'' for more information on search patterns.
2760   ** .pp
2761   ** For example, if you simply type ``joe'' at a search or limit prompt, Mutt
2762   ** will automatically expand it to the value specified by this variable by
2763   ** replacing ``%s'' with the supplied string.
2764   ** For the default value, ``joe'' would be expanded to: ``~f joe | ~s joe''.
2765   */
2766   { "smart_wrap",       DT_BOOL, R_PAGER, OPTWRAP, 1 },
2767   /*
2768   ** .pp
2769   ** Controls the display of lines longer than the screen width in the
2770   ** internal pager. If \fIset\fP, long lines are wrapped at a word boundary.  If
2771   ** \fIunset\fP, lines are simply wrapped at the screen edge. Also see the
2772   ** $$markers variable.
2773   */
2774   { "smileys",          DT_RX,   R_PAGER, UL &Smileys, UL "(>From )|(:[-^]?[][)(><}{|/DP])" },
2775   /*
2776   ** .pp
2777   ** The \fIpager\fP uses this variable to catch some common false
2778   ** positives of $$quote_regexp, most notably smileys and not consider
2779   ** a line quoted text if it also matches $$smileys. This mostly
2780   ** happens at the beginning of a line.
2781   */
2782   { "sleep_time",       DT_NUM, R_NONE, UL &SleepTime, 1 },
2783   /*
2784   ** .pp
2785   ** Specifies time, in seconds, to pause while displaying certain informational
2786   ** messages, while moving from folder to folder and after expunging
2787   ** messages from the current folder.  The default is to pause one second, so
2788   ** a value of zero for this option suppresses the pause.
2789   */
2790 #ifdef USE_SMTP
2791 # ifdef USE_SASL
2792   { "smtp_authenticators", DT_STR, R_NONE, UL &SmtpAuthenticators, UL 0 },
2793   /*
2794   ** .pp
2795   ** This is a colon-delimited list of authentication methods mutt may
2796   ** attempt to use to log in to an SMTP server, in the order mutt should
2797   ** try them.  Authentication methods are any SASL mechanism, eg
2798   ** ``digest-md5'', ``gssapi'' or ``cram-md5''.
2799   ** This option is case-insensitive. If it is ``unset''
2800   ** (the default) mutt will try all available methods, in order from
2801   ** most-secure to least-secure.
2802   ** .pp
2803   ** Example:
2804   ** .ts
2805   ** set smtp_authenticators="digest-md5:cram-md5"
2806   ** .te
2807   */
2808 # endif /* USE_SASL */
2809   { "smtp_pass",        DT_STR,  R_NONE, UL &SmtpPass, UL 0 },
2810   /*
2811   ** .pp
2812   ** Specifies the password for your SMTP account.  If \fIunset\fP, Mutt will
2813   ** prompt you for your password when you first send mail via SMTP.
2814   ** See $$smtp_url to configure mutt to send mail via SMTP.
2815   ** .pp
2816   ** \fBWarning\fP: you should only use this option when you are on a
2817   ** fairly secure machine, because the superuser can read your muttrc even
2818   ** if you are the only one who can read the file.
2819   */
2820   { "smtp_url",         DT_STR, R_NONE, UL &SmtpUrl, UL 0 },
2821   /*
2822   ** .pp
2823   ** Defines the SMTP smarthost where sent messages should relayed for
2824   ** delivery. This should take the form of an SMTP URL, eg:
2825   ** .ts
2826   ** smtp[s]://[user[:pass]@]host[:port]/
2827   ** .te
2828   ** .pp
2829   ** ... where ``[...]'' denotes an optional part.
2830   ** Setting this variable overrides the value of the $$sendmail
2831   ** variable.
2832   */
2833 #endif /* USE_SMTP */
2834   { "sort",             DT_SORT, R_INDEX|R_RESORT, UL &Sort, SORT_DATE },
2835   /*
2836   ** .pp
2837   ** Specifies how to sort messages in the ``index'' menu.  Valid values
2838   ** are:
2839   ** .il
2840   ** .dd date or date-sent
2841   ** .dd date-received
2842   ** .dd from
2843   ** .dd mailbox-order (unsorted)
2844   ** .dd score
2845   ** .dd size
2846   ** .dd spam
2847   ** .dd subject
2848   ** .dd threads
2849   ** .dd to
2850   ** .ie
2851   ** .pp
2852   ** You may optionally use the ``reverse-'' prefix to specify reverse sorting
2853   ** order (example: ``\fCset sort=reverse-date-sent\fP'').
2854   */
2855   { "sort_alias",       DT_SORT|DT_SORT_ALIAS,  R_NONE, UL &SortAlias, SORT_ALIAS },
2856   /*
2857   ** .pp
2858   ** Specifies how the entries in the ``alias'' menu are sorted.  The
2859   ** following are legal values:
2860   ** .il
2861   ** .dd address (sort alphabetically by email address)
2862   ** .dd alias (sort alphabetically by alias name)
2863   ** .dd unsorted (leave in order specified in .muttrc)
2864   ** .ie
2865   */
2866   { "sort_aux",         DT_SORT|DT_SORT_AUX, R_INDEX|R_RESORT_BOTH, UL &SortAux, SORT_DATE },
2867   /*
2868   ** .pp
2869   ** When sorting by threads, this variable controls how threads are sorted
2870   ** in relation to other threads, and how the branches of the thread trees
2871   ** are sorted.  This can be set to any value that $$sort can, except
2872   ** ``threads'' (in that case, mutt will just use ``date-sent'').  You can also
2873   ** specify the ``last-'' prefix in addition to the ``reverse-'' prefix, but ``last-''
2874   ** must come after ``reverse-''.  The ``last-'' prefix causes messages to be
2875   ** sorted against its siblings by which has the last descendant, using
2876   ** the rest of $$sort_aux as an ordering.  For instance,
2877   ** .ts
2878   ** set sort_aux=last-date-received
2879   ** .te
2880   ** .pp
2881   ** would mean that if a new message is received in a
2882   ** thread, that thread becomes the last one displayed (or the first, if
2883   ** you have ``\fCset sort=reverse-threads\fP''.)
2884   ** .pp
2885   ** Note: For reversed $$sort
2886   ** order $$sort_aux is reversed again (which is not the right thing to do,
2887   ** but kept to not break any existing configuration setting).
2888   */
2889   { "sort_browser",     DT_SORT|DT_SORT_BROWSER, R_NONE, UL &BrowserSort, SORT_ALPHA },
2890   /*
2891   ** .pp
2892   ** Specifies how to sort entries in the file browser.  By default, the
2893   ** entries are sorted alphabetically.  Valid values:
2894   ** .il
2895   ** .dd alpha (alphabetically)
2896   ** .dd date
2897   ** .dd size
2898   ** .dd unsorted
2899   ** .ie
2900   ** .pp
2901   ** You may optionally use the ``reverse-'' prefix to specify reverse sorting
2902   ** order (example: ``\fCset sort_browser=reverse-date\fP'').
2903   */
2904   { "sort_re",          DT_BOOL, R_INDEX|R_RESORT|R_RESORT_INIT, OPTSORTRE, 1 },
2905   /*
2906   ** .pp
2907   ** This variable is only useful when sorting by threads with
2908   ** $$strict_threads \fIunset\fP.  In that case, it changes the heuristic
2909   ** mutt uses to thread messages by subject.  With $$sort_re \fIset\fP, mutt will
2910   ** only attach a message as the child of another message by subject if
2911   ** the subject of the child message starts with a substring matching the
2912   ** setting of $$reply_regexp.  With $$sort_re \fIunset\fP, mutt will attach
2913   ** the message whether or not this is the case, as long as the
2914   ** non-$$reply_regexp parts of both messages are identical.
2915   */
2916   { "spam_separator",   DT_STR, R_NONE, UL &SpamSep, UL "," },
2917   /*
2918   ** .pp
2919   ** This variable controls what happens when multiple spam headers
2920   ** are matched: if \fIunset\fP, each successive header will overwrite any
2921   ** previous matches value for the spam label. If \fIset\fP, each successive
2922   ** match will append to the previous, using this variable's value as a
2923   ** separator.
2924   */
2925   { "spoolfile",        DT_PATH, R_NONE, UL &Spoolfile, 0 },
2926   /*
2927   ** .pp
2928   ** If your spool mailbox is in a non-default place where Mutt cannot find
2929   ** it, you can specify its location with this variable.  Mutt will
2930   ** automatically set this variable to the value of the environment
2931   ** variable \fC$$$MAIL\fP if it is not set.
2932   */
2933   { "status_chars",     DT_STR,  R_BOTH, UL &StChars, UL "-*%A" },
2934   /*
2935   ** .pp
2936   ** Controls the characters used by the ``%r'' indicator in
2937   ** $$status_format. The first character is used when the mailbox is
2938   ** unchanged. The second is used when the mailbox has been changed, and
2939   ** it needs to be resynchronized. The third is used if the mailbox is in
2940   ** read-only mode, or if the mailbox will not be written when exiting
2941   ** that mailbox (You can toggle whether to write changes to a mailbox
2942   ** with the \fC<toggle-write>\fP operation, bound by default to ``%''). The fourth
2943   ** is used to indicate that the current folder has been opened in attach-
2944   ** message mode (Certain operations like composing a new mail, replying,
2945   ** forwarding, etc. are not permitted in this mode).
2946   */
2947   { "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)---" },
2948   /*
2949   ** .pp
2950   ** Controls the format of the status line displayed in the ``index''
2951   ** menu.  This string is similar to $$index_format, but has its own
2952   ** set of \fCprintf(3)\fP-like sequences:
2953   ** .dl
2954   ** .dt %b  .dd number of mailboxes with new mail *
2955   ** .dt %d  .dd number of deleted messages *
2956   ** .dt %f  .dd the full pathname of the current mailbox
2957   ** .dt %F  .dd number of flagged messages *
2958   ** .dt %h  .dd local hostname
2959   ** .dt %l  .dd size (in bytes) of the current mailbox *
2960   ** .dt %L  .dd size (in bytes) of the messages shown
2961   **             (i.e., which match the current limit) *
2962   ** .dt %m  .dd the number of messages in the mailbox *
2963   ** .dt %M  .dd the number of messages shown (i.e., which match the current limit) *
2964   ** .dt %n  .dd number of new messages in the mailbox *
2965   ** .dt %o  .dd number of old unread messages *
2966   ** .dt %p  .dd number of postponed messages *
2967   ** .dt %P  .dd percentage of the way through the index
2968   ** .dt %r  .dd modified/read-only/won't-write/attach-message indicator,
2969   **             according to $$status_chars
2970   ** .dt %s  .dd current sorting mode ($$sort)
2971   ** .dt %S  .dd current aux sorting method ($$sort_aux)
2972   ** .dt %t  .dd number of tagged messages *
2973   ** .dt %u  .dd number of unread messages *
2974   ** .dt %v  .dd Mutt version string
2975   ** .dt %V  .dd currently active limit pattern, if any *
2976   ** .dt %>X .dd right justify the rest of the string and pad with ``X''
2977   ** .dt %|X .dd pad to the end of the line with ``X''
2978   ** .dt %*X .dd soft-fill with character ``X'' as pad
2979   ** .de
2980   ** .pp
2981   ** For an explanation of ``soft-fill'', see the $$index_format documentation.
2982   ** .pp
2983   ** * = can be optionally printed if nonzero
2984   ** .pp
2985   ** Some of the above sequences can be used to optionally print a string
2986   ** if their value is nonzero.  For example, you may only want to see the
2987   ** number of flagged messages if such messages exist, since zero is not
2988   ** particularly meaningful.  To optionally print a string based upon one
2989   ** of the above sequences, the following construct is used:
2990   ** .pp
2991   **  \fC%?<sequence_char>?<optional_string>?\fP
2992   ** .pp
2993   ** where \fIsequence_char\fP is a character from the table above, and
2994   ** \fIoptional_string\fP is the string you would like printed if
2995   ** \fIsequence_char\fP is nonzero.  \fIoptional_string\fP \fBmay\fP contain
2996   ** other sequences as well as normal text, but you may \fBnot\fP nest
2997   ** optional strings.
2998   ** .pp
2999   ** Here is an example illustrating how to optionally print the number of
3000   ** new messages in a mailbox:
3001   ** .pp
3002   ** \fC%?n?%n new messages.?\fP
3003   ** .pp
3004   ** You can also switch between two strings using the following construct:
3005   ** .pp
3006   ** \fC%?<sequence_char>?<if_string>&<else_string>?\fP
3007   ** .pp
3008   ** If the value of \fIsequence_char\fP is non-zero, \fIif_string\fP will
3009   ** be expanded, otherwise \fIelse_string\fP will be expanded.
3010   ** .pp
3011   ** You can force the result of any \fCprintf(3)\fP-like sequence to be lowercase
3012   ** by prefixing the sequence character with an underscore (``_'') sign.
3013   ** For example, if you want to display the local hostname in lowercase,
3014   ** you would use: ``\fC%_h\fP''.
3015   ** .pp
3016   ** If you prefix the sequence character with a colon (``:'') character, mutt
3017   ** will replace any dots in the expansion by underscores. This might be helpful
3018   ** with IMAP folders that don't like dots in folder names.
3019   */
3020   { "status_on_top",    DT_BOOL, R_BOTH, OPTSTATUSONTOP, 0 },
3021   /*
3022   ** .pp
3023   ** Setting this variable causes the ``status bar'' to be displayed on
3024   ** the first line of the screen rather than near the bottom. If $$help
3025   ** is \fIset\fP, too it'll be placed at the bottom.
3026   */
3027   { "strict_threads",   DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTSTRICTTHREADS, 0 },
3028   /*
3029   ** .pp
3030   ** If \fIset\fP, threading will only make use of the ``In-Reply-To'' and
3031   ** ``References:'' fields when you $$sort by message threads.  By
3032   ** default, messages with the same subject are grouped together in
3033   ** ``pseudo threads.''. This may not always be desirable, such as in a
3034   ** personal mailbox where you might have several unrelated messages with
3035   ** the subjects like ``hi'' which will get grouped together. See also
3036   ** $$sort_re for a less drastic way of controlling this
3037   ** behaviour.
3038   */
3039   { "suspend",          DT_BOOL, R_NONE, OPTSUSPEND, 1 },
3040   /*
3041   ** .pp
3042   ** When \fIunset\fP, mutt won't stop when the user presses the terminal's
3043   ** \fIsusp\fP key, usually ``^Z''. This is useful if you run mutt
3044   ** inside an xterm using a command like ``\fCxterm -e mutt\fP''.
3045   */
3046   { "text_flowed",      DT_BOOL, R_NONE, OPTTEXTFLOWED,  0 },
3047   /*
3048   ** .pp
3049   ** When \fIset\fP, mutt will generate ``format=flowed'' bodies with a content type
3050   ** of ``\fCtext/plain; format=flowed\fP''.
3051   ** This format is easier to handle for some mailing software, and generally
3052   ** just looks like ordinary text.  To actually make use of this format's
3053   ** features, you'll need support in your editor.
3054   ** .pp
3055   ** Note that $$indent_string is ignored when this option is \fIset\fP.
3056   */
3057   { "thread_received",  DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTTHREADRECEIVED, 0 },
3058   /*
3059   ** .pp
3060   ** When \fIset\fP, mutt uses the date received rather than the date sent
3061   ** to thread messages by subject.
3062   */
3063   { "thorough_search",  DT_BOOL, R_NONE, OPTTHOROUGHSRC, 0 },
3064   /*
3065   ** .pp
3066   ** Affects the \fC~b\fP and \fC~h\fP search operations described in
3067   ** section ``$patterns''.  If \fIset\fP, the headers and body/attachments of
3068   ** messages to be searched are decoded before searching. If \fIunset\fP,
3069   ** messages are searched as they appear in the folder.
3070   ** .pp
3071   ** Users searching attachments or for non-ASCII characters should \fIset\fP
3072   ** this value because decoding also includes MIME parsing/decoding and possible
3073   ** character set conversions. Otherwise mutt will attempt to match against the
3074   ** raw message received (for example quoted-printable encoded or with encoded
3075   ** headers) which may lead to incorrect search results.
3076   */
3077   { "tilde",            DT_BOOL, R_PAGER, OPTTILDE, 0 },
3078   /*
3079   ** .pp
3080   ** When \fIset\fP, the internal-pager will pad blank lines to the bottom of the
3081   ** screen with a tilde (``~'').
3082   */
3083   { "time_inc",         DT_NUM,  R_NONE, UL &TimeInc, 0 },
3084   /*
3085   ** .pp
3086   ** Along with $$read_inc, $$write_inc, and $$net_inc, this
3087   ** variable controls the frequency with which progress updates are
3088   ** displayed. It suppresses updates less than $$time_inc milliseconds
3089   ** apart. This can improve throughput on systems with slow terminals,
3090   ** or when running mutt on a remote system.
3091   ** .pp
3092   ** Also see the ``$tuning'' section of the manual for performance considerations.
3093   */
3094   { "timeout",          DT_NUM,  R_NONE, UL &Timeout, 600 },
3095   /*
3096   ** .pp
3097   ** When Mutt is waiting for user input either idleing in menus or
3098   ** in an interactive prompt, Mutt would block until input is
3099   ** present. Depending on the context, this would prevent certain
3100   ** operations from working, like checking for new mail or keeping
3101   ** an IMAP connection alive.
3102   ** .pp
3103   ** This variable controls how many seconds Mutt will at most wait
3104   ** until it aborts waiting for input, performs these operations and
3105   ** continues to wait for input.
3106   ** .pp
3107   ** A value of zero or less will cause Mutt to never time out.
3108   */
3109   { "tmpdir",           DT_PATH, R_NONE, UL &Tempdir, 0 },
3110   /*
3111   ** .pp
3112   ** This variable allows you to specify where Mutt will place its
3113   ** temporary files needed for displaying and composing messages.  If
3114   ** this variable is not set, the environment variable \fC$$$TMPDIR\fP is
3115   ** used.  If \fC$$$TMPDIR\fP is not set then ``\fC/tmp\fP'' is used.
3116   */
3117   { "to_chars",         DT_STR,  R_BOTH, UL &Tochars, UL " +TCFL" },
3118   /*
3119   ** .pp
3120   ** Controls the character used to indicate mail addressed to you.  The
3121   ** first character is the one used when the mail is \fInot\fP addressed to your
3122   ** address.  The second is used when you are the only
3123   ** recipient of the message.  The third is when your address
3124   ** appears in the ``To:'' header field, but you are not the only recipient of
3125   ** the message.  The fourth character is used when your
3126   ** address is specified in the ``Cc:'' header field, but you are not the only
3127   ** recipient.  The fifth character is used to indicate mail that was sent
3128   ** by \fIyou\fP.  The sixth character is used to indicate when a mail
3129   ** was sent to a mailing-list you subscribe to.
3130   */
3131 #ifdef USE_SOCKET
3132   { "tunnel",            DT_STR, R_NONE, UL &Tunnel, UL 0 },
3133   /*
3134   ** .pp
3135   ** Setting this variable will cause mutt to open a pipe to a command
3136   ** instead of a raw socket. You may be able to use this to set up
3137   ** preauthenticated connections to your IMAP/POP3/SMTP server. Example:
3138   ** .ts
3139   ** set tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
3140   ** .te
3141   ** .pp
3142   ** Note: For this example to work you must be able to log in to the remote
3143   ** machine without having to enter a password.
3144   */
3145 #endif
3146   { "use_8bitmime",     DT_BOOL, R_NONE, OPTUSE8BITMIME, 0 },
3147   /*
3148   ** .pp
3149   ** \fBWarning:\fP do not set this variable unless you are using a version
3150   ** of sendmail which supports the \fC-B8BITMIME\fP flag (such as sendmail
3151   ** 8.8.x) or you may not be able to send mail.
3152   ** .pp
3153   ** When \fIset\fP, Mutt will invoke $$sendmail with the \fC-B8BITMIME\fP
3154   ** flag when sending 8-bit messages to enable ESMTP negotiation.
3155   */
3156   { "use_domain",       DT_BOOL, R_NONE, OPTUSEDOMAIN, 1 },
3157   /*
3158   ** .pp
3159   ** When \fIset\fP, Mutt will qualify all local addresses (ones without the
3160   ** ``@host'' portion) with the value of $$hostname.  If \fIunset\fP, no
3161   ** addresses will be qualified.
3162   */
3163   { "use_envelope_from",        DT_BOOL, R_NONE, OPTENVFROM, 0 },
3164   /*
3165    ** .pp
3166    ** When \fIset\fP, mutt will set the \fIenvelope\fP sender of the message.
3167    ** If $$envelope_from_address is \fIset\fP, it will be used as the sender
3168    ** address. If \fIunset\fP, mutt will attempt to derive the sender from the
3169    ** ``From:'' header.
3170    ** .pp
3171    ** Note that this information is passed to sendmail command using the
3172    ** \fC-f\fP command line switch. Therefore setting this option is not useful
3173    ** if the $$sendmail variable already contains \fC-f\fP or if the
3174    ** executable pointed to by $$sendmail doesn't support the \fC-f\fP switch.
3175    */
3176   { "envelope_from",    DT_SYN,  R_NONE, UL "use_envelope_from", 0 },
3177   /*
3178   */
3179   { "use_from",         DT_BOOL, R_NONE, OPTUSEFROM, 1 },
3180   /*
3181   ** .pp
3182   ** When \fIset\fP, Mutt will generate the ``From:'' header field when
3183   ** sending messages.  If \fIunset\fP, no ``From:'' header field will be
3184   ** generated unless the user explicitly sets one using the ``$my_hdr''
3185   ** command.
3186   */
3187 #ifdef HAVE_LIBIDN
3188   { "use_idn",          DT_BOOL, R_BOTH, OPTUSEIDN, 1},
3189   /*
3190   ** .pp
3191   ** When \fIset\fP, Mutt will show you international domain names decoded.
3192   ** Note: You can use IDNs for addresses even if this is \fIunset\fP.
3193   ** This variable only affects decoding.
3194   */
3195 #endif /* HAVE_LIBIDN */
3196 #ifdef HAVE_GETADDRINFO
3197   { "use_ipv6",         DT_BOOL, R_NONE, OPTUSEIPV6, 1},
3198   /*
3199   ** .pp
3200   ** When \fIset\fP, Mutt will look for IPv6 addresses of hosts it tries to
3201   ** contact.  If this option is \fIunset\fP, Mutt will restrict itself to IPv4 addresses.
3202   ** Normally, the default should work.
3203   */
3204 #endif /* HAVE_GETADDRINFO */
3205   { "user_agent",       DT_BOOL, R_NONE, OPTXMAILER, 1},
3206   /*
3207   ** .pp
3208   ** When \fIset\fP, mutt will add a ``User-Agent:'' header to outgoing
3209   ** messages, indicating which version of mutt was used for composing
3210   ** them.
3211   */
3212   { "visual",           DT_PATH, R_NONE, UL &Visual, 0 },
3213   /*
3214   ** .pp
3215   ** Specifies the visual editor to invoke when the ``\fC~v\fP'' command is
3216   ** given in the builtin editor.
3217   */
3218   { "wait_key",         DT_BOOL, R_NONE, OPTWAITKEY, 1 },
3219   /*
3220   ** .pp
3221   ** Controls whether Mutt will ask you to press a key after an external command
3222   ** has been invoked by these functions: \fC<shell-escape>\fP,
3223   ** \fC<pipe-message>\fP, \fC<pipe-entry>\fP, \fC<print-message>\fP,
3224   ** and \fC<print-entry>\fP commands.
3225   ** .pp
3226   ** It is also used when viewing attachments with ``$auto_view'', provided
3227   ** that the corresponding mailcap entry has a \fIneedsterminal\fP flag,
3228   ** and the external program is interactive.
3229   ** .pp
3230   ** When \fIset\fP, Mutt will always ask for a key. When \fIunset\fP, Mutt will wait
3231   ** for a key only if the external command returned a non-zero status.
3232   */
3233   { "weed",             DT_BOOL, R_NONE, OPTWEED, 1 },
3234   /*
3235   ** .pp
3236   ** When \fIset\fP, mutt will weed headers when displaying, forwarding,
3237   ** printing, or replying to messages.
3238   */
3239   { "wrap",             DT_NUM,  R_PAGER, UL &Wrap, 0 },
3240   /*
3241   ** .pp
3242   ** When set to a positive value, mutt will wrap text at $$wrap characters.
3243   ** When set to a negative value, mutt will wrap text so that there are $$wrap
3244   ** characters of empty space on the right side of the terminal.
3245   */
3246   { "wrap_search",      DT_BOOL, R_NONE, OPTWRAPSEARCH, 1 },
3247   /*
3248   ** .pp
3249   ** Controls whether searches wrap around the end.
3250   ** .pp
3251   ** When \fIset\fP, searches will wrap around the first (or last) item. When
3252   ** \fIunset\fP, incremental searches will not wrap.
3253   */
3254   { "wrapmargin",       DT_NUM,  R_PAGER, UL &Wrap, 0 },
3255   /*
3256   ** .pp
3257   ** (DEPRECATED) Equivalent to setting $$wrap with a negative value.
3258   */
3259   { "write_inc",        DT_NUM,  R_NONE, UL &WriteInc, 10 },
3260   /*
3261   ** .pp
3262   ** When writing a mailbox, a message will be printed every
3263   ** $$write_inc messages to indicate progress.  If set to 0, only a
3264   ** single message will be displayed before writing a mailbox.
3265   ** .pp
3266   ** Also see the $$read_inc, $$net_inc and $$time_inc variables and the
3267   ** ``$tuning'' section of the manual for performance considerations.
3268   */
3269   { "write_bcc",        DT_BOOL, R_NONE, OPTWRITEBCC, 1},
3270   /*
3271   ** .pp
3272   ** Controls whether mutt writes out the ``Bcc:'' header when preparing
3273   ** messages to be sent.  Exim users may wish to unset this. If mutt
3274   ** is set to deliver directly via SMTP (see $$smtp_url), this
3275   ** option does nothing: mutt will never write out the ``Bcc:'' header
3276   ** in this case.
3277   */
3278   /*--*/
3279   { NULL }
3280 };
3281
3282 const struct mapping_t SortMethods[] = {
3283   { "date",             SORT_DATE },
3284   { "date-sent",        SORT_DATE },
3285   { "date-received",    SORT_RECEIVED },
3286   { "mailbox-order",    SORT_ORDER },
3287   { "subject",          SORT_SUBJECT },
3288   { "from",             SORT_FROM },
3289   { "size",             SORT_SIZE },
3290   { "threads",          SORT_THREADS },
3291   { "to",               SORT_TO },
3292   { "score",            SORT_SCORE },
3293   { "spam",             SORT_SPAM },
3294   { NULL,               0 }
3295 };
3296
3297 /* same as SortMethods, but with "threads" replaced by "date" */
3298
3299 const struct mapping_t SortAuxMethods[] = {
3300   { "date",             SORT_DATE },
3301   { "date-sent",        SORT_DATE },
3302   { "date-received",    SORT_RECEIVED },
3303   { "mailbox-order",    SORT_ORDER },
3304   { "subject",          SORT_SUBJECT },
3305   { "from",             SORT_FROM },
3306   { "size",             SORT_SIZE },
3307   { "threads",          SORT_DATE },    /* note: sort_aux == threads
3308                                          * isn't possible. 
3309                                          */
3310   { "to",               SORT_TO },
3311   { "score",            SORT_SCORE },
3312   { "spam",             SORT_SPAM },
3313   { NULL,               0 }
3314 };
3315   
3316
3317 const struct mapping_t SortBrowserMethods[] = {
3318   { "alpha",    SORT_SUBJECT },
3319   { "date",     SORT_DATE },
3320   { "size",     SORT_SIZE },
3321   { "unsorted", SORT_ORDER },
3322   { NULL }
3323 };
3324
3325 const struct mapping_t SortAliasMethods[] = {
3326   { "alias",    SORT_ALIAS },
3327   { "address",  SORT_ADDRESS },
3328   { "unsorted", SORT_ORDER },
3329   { NULL }
3330 };
3331
3332 const struct mapping_t SortKeyMethods[] = {
3333   { "address",  SORT_ADDRESS },
3334   { "date",     SORT_DATE },
3335   { "keyid",    SORT_KEYID },
3336   { "trust",    SORT_TRUST },
3337   { NULL }
3338 };
3339
3340
3341 /* functions used to parse commands in a rc file */
3342
3343 static int parse_list (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3344 static int parse_spam_list (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3345 static int parse_unlist (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3346
3347 static int parse_group (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3348 static int parse_ungroup (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3349
3350 static int parse_lists (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3351 static int parse_unlists (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3352 static int parse_alias (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3353 static int parse_unalias (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3354 static int parse_ignore (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3355 static int parse_unignore (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3356 static int parse_source (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3357 static int parse_set (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3358 static int parse_my_hdr (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3359 static int parse_unmy_hdr (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3360 static int parse_subscribe (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3361 static int parse_unsubscribe (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3362 static int parse_attachments (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3363 static int parse_unattachments (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3364
3365
3366 static int parse_alternates (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3367 static int parse_unalternates (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3368
3369 /* Parse -group arguments */
3370 static int parse_group_context (group_context_t **ctx, BUFFER *buf, BUFFER *s, unsigned long data, BUFFER *err);
3371
3372
3373 struct command_t
3374 {
3375   char *name;
3376   int (*func) (BUFFER *, BUFFER *, unsigned long, BUFFER *);
3377   unsigned long data;
3378 };
3379
3380 struct command_t Commands[] = {
3381   { "alternates",       parse_alternates,       0 },
3382   { "unalternates",     parse_unalternates,     0 },
3383 #ifdef USE_SOCKET
3384   { "account-hook",     mutt_parse_hook,        M_ACCOUNTHOOK },
3385 #endif
3386   { "alias",            parse_alias,            0 },
3387   { "attachments",      parse_attachments,      0 },
3388   { "unattachments",parse_unattachments,0 },
3389   { "auto_view",        parse_list,             UL &AutoViewList },
3390   { "alternative_order",        parse_list,     UL &AlternativeOrderList},
3391   { "bind",             mutt_parse_bind,        0 },
3392   { "charset-hook",     mutt_parse_hook,        M_CHARSETHOOK },
3393 #ifdef HAVE_COLOR
3394   { "color",            mutt_parse_color,       0 },
3395   { "uncolor",          mutt_parse_uncolor,     0 },
3396 #endif
3397   { "exec",             mutt_parse_exec,        0 },
3398   { "fcc-hook",         mutt_parse_hook,        M_FCCHOOK },
3399   { "fcc-save-hook",    mutt_parse_hook,        M_FCCHOOK | M_SAVEHOOK },
3400   { "folder-hook",      mutt_parse_hook,        M_FOLDERHOOK },
3401   { "group",            parse_group,            0 },
3402   { "ungroup",          parse_ungroup,          0 },
3403   { "hdr_order",        parse_list,             UL &HeaderOrderList },
3404 #ifdef HAVE_ICONV
3405   { "iconv-hook",       mutt_parse_hook,        M_ICONVHOOK }, 
3406 #endif
3407   { "ignore",           parse_ignore,           0 },
3408   { "lists",            parse_lists,            0 },
3409   { "macro",            mutt_parse_macro,       0 },
3410   { "mailboxes",        mutt_parse_mailboxes,   M_MAILBOXES },
3411   { "unmailboxes",      mutt_parse_mailboxes,   M_UNMAILBOXES },
3412   { "message-hook",     mutt_parse_hook,        M_MESSAGEHOOK },
3413   { "mbox-hook",        mutt_parse_hook,        M_MBOXHOOK },
3414   { "mime_lookup",      parse_list,     UL &MimeLookupList },
3415   { "unmime_lookup",    parse_unlist,   UL &MimeLookupList },
3416   { "mono",             mutt_parse_mono,        0 },
3417   { "my_hdr",           parse_my_hdr,           0 },
3418   { "pgp-hook",         mutt_parse_hook,        M_CRYPTHOOK },
3419   { "crypt-hook",       mutt_parse_hook,        M_CRYPTHOOK },
3420   { "push",             mutt_parse_push,        0 },
3421   { "reply-hook",       mutt_parse_hook,        M_REPLYHOOK },
3422   { "reset",            parse_set,              M_SET_RESET },
3423   { "save-hook",        mutt_parse_hook,        M_SAVEHOOK },
3424   { "score",            mutt_parse_score,       0 },
3425   { "send-hook",        mutt_parse_hook,        M_SENDHOOK },
3426   { "send2-hook",       mutt_parse_hook,        M_SEND2HOOK },
3427   { "set",              parse_set,              0 },
3428   { "source",           parse_source,           0 },
3429   { "spam",             parse_spam_list,        M_SPAM },
3430   { "nospam",           parse_spam_list,        M_NOSPAM },
3431   { "subscribe",        parse_subscribe,        0 },
3432   { "toggle",           parse_set,              M_SET_INV },
3433   { "unalias",          parse_unalias,          0 },
3434   { "unalternative_order",parse_unlist,         UL &AlternativeOrderList },
3435   { "unauto_view",      parse_unlist,           UL &AutoViewList },
3436   { "unhdr_order",      parse_unlist,           UL &HeaderOrderList },
3437   { "unhook",           mutt_parse_unhook,      0 },
3438   { "unignore",         parse_unignore,         0 },
3439   { "unlists",          parse_unlists,          0 },
3440   { "unmono",           mutt_parse_unmono,      0 },
3441   { "unmy_hdr",         parse_unmy_hdr,         0 },
3442   { "unscore",          mutt_parse_unscore,     0 },
3443   { "unset",            parse_set,              M_SET_UNSET },
3444   { "unsubscribe",      parse_unsubscribe,      0 },
3445   { NULL }
3446 };