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