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