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