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