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