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