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