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