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