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