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