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