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