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