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