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