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