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