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