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