X-Git-Url: https://git.llucax.com/software/mutt-debian.git/blobdiff_plain/14c29200cb58d3c4a0830265f2433849781858d0..0ead8aa66b21bc03c84c1516ac959d5ecbc664b5:/init.h?ds=sidebyside diff --git a/init.h b/init.h index 4333be8..98b26ec 100644 --- a/init.h +++ b/init.h @@ -1,21 +1,21 @@ /* - * Copyright (C) 1996-2002 Michael R. Elkins + * Copyright (C) 1996-2002,2007 Michael R. Elkins * Copyright (C) 2004 g10 Code GmbH - * + * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. - * + * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. - * + * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - */ + */ #ifdef _MAKEDOC # include "config.h" @@ -102,11 +102,14 @@ struct option_t MuttVars[] = { { "alias_file", DT_PATH, R_NONE, UL &AliasFile, UL "~/.muttrc" }, /* ** .pp - ** The default file in which to save aliases created by the - ** ``$create-alias'' function. + ** The default file in which to save aliases created by the + ** \fC$\fP function. Entries added to this file are + ** encoded in the character set specified by $$config_charset if it + ** is \fIset\fP or the current character set otherwise. ** .pp ** \fBNote:\fP Mutt will not automatically source this file; you must - ** explicitly use the ``$source'' command for it to be executed. + ** explicitly use the ``$source'' command for it to be executed in case + ** this option points to a dedicated alias file. ** .pp ** The default for this option is the currently used muttrc file, or ** ``~/.muttrc'' if no user muttrc was found. @@ -114,12 +117,11 @@ struct option_t MuttVars[] = { { "alias_format", DT_STR, R_NONE, UL &AliasFmt, UL "%4n %2f %t %-10a %r" }, /* ** .pp - ** Specifies the format of the data displayed for the `alias' menu. The - ** following printf(3)-style sequences are available: - ** .pp + ** Specifies the format of the data displayed for the ``$alias'' menu. The + ** following \fCprintf(3)\fP-style sequences are available: ** .dl ** .dt %a .dd alias name - ** .dt %f .dd flags - currently, a "d" for an alias marked for deletion + ** .dt %f .dd flags - currently, a ``d'' for an alias marked for deletion ** .dt %n .dd index number ** .dt %r .dd address which alias expands to ** .dt %t .dd character which indicates if the alias is tagged for inclusion @@ -134,18 +136,23 @@ struct option_t MuttVars[] = { { "allow_ansi", DT_BOOL, R_NONE, OPTALLOWANSI, 0 }, /* ** .pp - ** Controls whether ANSI color codes in messages (and color tags in + ** Controls whether ANSI color codes in messages (and color tags in ** rich text messages) are to be interpreted. - ** Messages containing these codes are rare, but if this option is set, + ** Messages containing these codes are rare, but if this option is \fIset\fP, ** their text will be colored accordingly. Note that this may override ** your color choices, and even present a security problem, since a - ** message could include a line like "[-- PGP output follows ..." and - ** give it the same color as your attachment color. + ** message could include a line like + ** .ts + ** [-- PGP output follows ... + ** .te + ** .pp + ** and give it the same color as your attachment color (see also + ** $$crypt_timestamp). */ { "arrow_cursor", DT_BOOL, R_BOTH, OPTARROWCURSOR, 0 }, /* ** .pp - ** When set, an arrow (``->'') will be used to indicate the current entry + ** When \fIset\fP, an arrow (``->'') will be used to indicate the current entry ** in menus instead of highlighting the whole line. On slow network or modem ** links this will make response faster because there is less that has to ** be redrawn on the screen when moving to the next or previous entries @@ -154,21 +161,21 @@ struct option_t MuttVars[] = { { "ascii_chars", DT_BOOL, R_BOTH, OPTASCIICHARS, 0 }, /* ** .pp - ** If set, Mutt will use plain ASCII characters when displaying thread + ** If \fIset\fP, Mutt will use plain ASCII characters when displaying thread ** and attachment trees, instead of the default \fIACS\fP characters. */ { "askbcc", DT_BOOL, R_NONE, OPTASKBCC, 0 }, /* ** .pp - ** If set, Mutt will prompt you for blind-carbon-copy (Bcc) recipients + ** If \fIset\fP, Mutt will prompt you for blind-carbon-copy (Bcc) recipients ** before editing an outgoing message. */ { "askcc", DT_BOOL, R_NONE, OPTASKCC, 0 }, /* ** .pp - ** If set, Mutt will prompt you for carbon-copy (Cc) recipients before + ** If \fIset\fP, Mutt will prompt you for carbon-copy (Cc) recipients before ** editing the body of an outgoing message. - */ + */ { "assumed_charset", DT_STR, R_NONE, UL &AssumedCharset, UL 0}, /* ** .pp @@ -177,11 +184,12 @@ struct option_t MuttVars[] = { ** Header field values and message body content without character encoding ** indication would be assumed that they are written in one of this list. ** By default, all the header fields and message body without any charset - ** indication are assumed to be in "us-ascii". + ** indication are assumed to be in ``us-ascii''. ** .pp ** For example, Japanese users might prefer this: - ** .pp - ** set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8" + ** .ts + ** set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8" + ** .te ** .pp ** However, only the first content is valid for the message body. */ @@ -189,46 +197,49 @@ struct option_t MuttVars[] = { /* ** .pp ** This variable is a colon-separated list of character encoding - ** schemes for text file attachments. - ** If unset, $$charset value will be used instead. + ** schemes for text file attachments. Mutt uses this setting to guess + ** which encoding files being attached are encoded in to convert them to + ** a proper character set given in $$send_charset. + ** .pp + ** If \fIunset\fP, the value of $$charset will be used instead. ** For example, the following configuration would work for Japanese ** text handling: + ** .ts + ** set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8" + ** .te ** .pp - ** set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8" - ** .pp - ** Note: "iso-2022-*" must be put at the head of the value as shown above - ** if included. + ** Note: for Japanese users, ``iso-2022-*'' must be put at the head + ** of the value as shown above if included. */ { "attach_format", DT_STR, R_NONE, UL &AttachFormat, UL "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] " }, /* ** .pp - ** This variable describes the format of the `attachment' menu. The - ** following printf-style sequences are understood: - ** .pp + ** This variable describes the format of the ``attachment'' menu. The + ** following \fCprintf(3)\fP-style sequences are understood: ** .dl ** .dt %C .dd charset - ** .dt %c .dd requires charset conversion (n or c) + ** .dt %c .dd requires charset conversion (``n'' or ``c'') ** .dt %D .dd deleted flag ** .dt %d .dd description ** .dt %e .dd MIME content-transfer-encoding ** .dt %f .dd filename - ** .dt %I .dd disposition (I=inline, A=attachment) + ** .dt %I .dd disposition (``I'' for inline, ``A'' for attachment) ** .dt %m .dd major MIME type ** .dt %M .dd MIME subtype ** .dt %n .dd attachment number - ** .dt %Q .dd "Q", if MIME part qualifies for attachment counting + ** .dt %Q .dd ``Q'', if MIME part qualifies for attachment counting ** .dt %s .dd size ** .dt %t .dd tagged flag ** .dt %T .dd graphic tree characters ** .dt %u .dd unlink (=to delete) flag ** .dt %X .dd number of qualifying MIME parts in this part and its children ** (please see the ``$attachments'' section for possible speed effects) - ** .dt %>X .dd right justify the rest of the string and pad with character "X" - ** .dt %|X .dd pad to the end of the line with character "X" - ** .dt %*X .dd soft-fill with character "X" as pad + ** .dt %>X .dd right justify the rest of the string and pad with character ``X'' + ** .dt %|X .dd pad to the end of the line with character ``X'' + ** .dt %*X .dd soft-fill with character ``X'' as pad ** .de ** .pp - ** For an explanation of `soft-fill', see the ``$$index_format'' documentation. + ** For an explanation of ``soft-fill'', see the $$index_format documentation. */ { "attach_sep", DT_STR, R_NONE, UL &AttachSep, UL "\n" }, /* @@ -239,48 +250,54 @@ struct option_t MuttVars[] = { { "attach_split", DT_BOOL, R_NONE, OPTATTACHSPLIT, 1 }, /* ** .pp - ** If this variable is unset, when operating (saving, printing, piping, + ** If this variable is \fIunset\fP, when operating (saving, printing, piping, ** etc) on a list of tagged attachments, Mutt will concatenate the ** attachments and will operate on them as a single attachment. The - ** ``$$attach_sep'' separator is added after each attachment. When set, + ** $$attach_sep separator is added after each attachment. When \fIset\fP, ** Mutt will operate on the attachments one by one. */ { "attribution", DT_STR, R_NONE, UL &Attribution, UL "On %d, %n wrote:" }, /* ** .pp ** This is the string that will precede a message which has been included - ** in a reply. For a full listing of defined printf()-like sequences see - ** the section on ``$$index_format''. + ** in a reply. For a full listing of defined \fCprintf(3)\fP-like sequences see + ** the section on $$index_format. + */ + { "auto_tag", DT_BOOL, R_NONE, OPTAUTOTAG, 0 }, + /* + ** .pp + ** When \fIset\fP, functions in the \fIindex\fP menu which affect a message + ** will be applied to all tagged messages (if there are any). When + ** unset, you must first use the \fC\fP function (bound to ``;'' + ** by default) to make the next function apply to all tagged messages. */ { "autoedit", DT_BOOL, R_NONE, OPTAUTOEDIT, 0 }, /* ** .pp - ** When set along with ``$$edit_headers'', Mutt will skip the initial - ** send-menu and allow you to immediately begin editing the body of your + ** When \fIset\fP along with $$edit_headers, Mutt will skip the initial + ** send-menu (prompting for subject and recipients) and allow you to + ** immediately begin editing the body of your ** message. The send-menu may still be accessed once you have finished ** editing the body of your message. ** .pp - ** Also see ``$$fast_reply''. - */ - { "auto_tag", DT_BOOL, R_NONE, OPTAUTOTAG, 0 }, - /* ** .pp - ** When set, functions in the \fIindex\fP menu which affect a message - ** will be applied to all tagged messages (if there are any). When - ** unset, you must first use the tag-prefix function (default: ";") to - ** make the next function apply to all tagged messages. + ** \fBNote:\fP when this option is \fIset\fP, you cannot use send-hooks that depend + ** on the recipients when composing a new (non-reply) message, as the initial + ** list of recipients is empty. + ** .pp + ** Also see $$fast_reply. */ { "beep", DT_BOOL, R_NONE, OPTBEEP, 1 }, /* ** .pp - ** When this variable is set, mutt will beep when an error occurs. + ** When this variable is \fIset\fP, mutt will beep when an error occurs. */ { "beep_new", DT_BOOL, R_NONE, OPTBEEPNEW, 0 }, /* ** .pp - ** When this variable is set, mutt will beep whenever it prints a message + ** When this variable is \fIset\fP, mutt will beep whenever it prints a message ** notifying you of new mail. This is independent of the setting of the - ** ``$$beep'' variable. + ** $$beep variable. */ { "bounce", DT_QUAD, R_NONE, OPT_BOUNCE, M_ASKYES }, /* @@ -293,29 +310,65 @@ struct option_t MuttVars[] = { { "bounce_delivered", DT_BOOL, R_NONE, OPTBOUNCEDELIVERED, 1 }, /* ** .pp - ** When this variable is set, mutt will include Delivered-To headers when - ** bouncing messages. Postfix users may wish to unset this variable. + ** When this variable is \fIset\fP, mutt will include Delivered-To headers when + ** bouncing messages. Postfix users may wish to \fIunset\fP this variable. */ { "braille_friendly", DT_BOOL, R_NONE, OPTBRAILLEFRIENDLY, 0 }, /* ** .pp - ** When this variable is set, mutt will place the cursor at the beginning - ** of the current line in menus, even when the arrow_cursor variable - ** is unset, making it easier for blind persons using Braille displays to - ** follow these menus. The option is disabled by default because many + ** When this variable is \fIset\fP, mutt will place the cursor at the beginning + ** of the current line in menus, even when the $$arrow_cursor variable + ** is \fIunset\fP, making it easier for blind persons using Braille displays to + ** follow these menus. The option is \fIunset\fP by default because many ** visual terminals don't permit making the cursor invisible. */ - { "check_mbox_size", DT_BOOL, R_NONE, OPTCHECKMBOXSIZE, 0 }, +#if defined(USE_SSL) + { "certificate_file", DT_PATH, R_NONE, UL &SslCertFile, UL "~/.mutt_certificates" }, /* ** .pp - ** When this variable is set, mutt will use file size attribute instead of - ** access time when checking for new mail. + ** This variable specifies the file where the certificates you trust + ** are saved. When an unknown certificate is encountered, you are asked + ** if you accept it or not. If you accept it, the certificate can also + ** be saved in this file and further connections are automatically + ** accepted. + ** .pp + ** You can also manually add CA certificates in this file. Any server + ** certificate that is signed with one of these CA certificates is + ** also automatically accepted. + ** .pp + ** Example: + ** .ts + ** set certificate_file=~/.mutt/certificates + ** .te + ** */ +#endif { "charset", DT_STR, R_NONE, UL &Charset, UL 0 }, /* ** .pp ** Character set your terminal uses to display and enter textual data. ** It is also the fallback for $$send_charset. + ** .pp + ** Upon startup Mutt tries to derive this value from environment variables + ** such as \fC$$$LC_CTYPE\fP or \fC$$$LANG\fP. + ** .pp + ** \fBNote:\fP It should only be set in case Mutt isn't abled to determine the + ** character set used correctly. + */ + { "check_mbox_size", DT_BOOL, R_NONE, OPTCHECKMBOXSIZE, 0 }, + /* + ** .pp + ** When this variable is \fIset\fP, mutt will use file size attribute instead of + ** access time when checking for new mail in mbox and mmdf folders. + ** .pp + ** This variable is \fIunset\fP by default and should only be enabled when + ** new mail detection for these folder types is unreliable or doesn't work. + ** .pp + ** Note that enabling this variable should happen before any ``$mailboxes'' + ** directives occur in configuration files regarding mbox or mmdf folders + ** because mutt needs to determine the initial new mail status of such a + ** mailbox by performing a fast mailbox scan when it is defined. + ** Afterwards the new mail status is tracked by file size changes. */ { "check_new", DT_BOOL, R_NONE, OPTCHECKNEW, 1 }, /* @@ -327,7 +380,7 @@ struct option_t MuttVars[] = { ** mailbox is open. Especially with MH mailboxes, this operation can ** take quite some time since it involves scanning the directory and ** checking each file to see if it has already been looked at. If - ** \fIcheck_new\fP is \fIunset\fP, no check for new mail is performed + ** this variable is \fIunset\fP, no check for new mail is performed ** while the mailbox is open. */ { "collapse_unread", DT_BOOL, R_NONE, OPTCOLLAPSEUNREAD, 1 }, @@ -336,53 +389,54 @@ struct option_t MuttVars[] = { ** When \fIunset\fP, Mutt will not collapse a thread if it contains any ** unread messages. */ - { "uncollapse_jump", DT_BOOL, R_NONE, OPTUNCOLLAPSEJUMP, 0 }, - /* - ** .pp - ** When \fIset\fP, Mutt will jump to the next unread message, if any, - ** when the current thread is \fIun\fPcollapsed. - */ { "compose_format", DT_STR, R_BOTH, UL &ComposeFormat, UL "-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-" }, /* ** .pp - ** Controls the format of the status line displayed in the \fICompose\fP - ** menu. This string is similar to ``$$status_format'', but has its own - ** set of printf()-like sequences: - ** .pp + ** Controls the format of the status line displayed in the ``compose'' + ** menu. This string is similar to $$status_format, but has its own + ** set of \fCprintf(3)\fP-like sequences: ** .dl - ** .dt %a .dd total number of attachments + ** .dt %a .dd total number of attachments ** .dt %h .dd local hostname ** .dt %l .dd approximate size (in bytes) of the current message ** .dt %v .dd Mutt version string ** .de ** .pp - ** See the text describing the ``$$status_format'' option for more - ** information on how to set ``$$compose_format''. + ** See the text describing the $$status_format option for more + ** information on how to set $$compose_format. */ { "config_charset", DT_STR, R_NONE, UL &ConfigCharset, UL 0 }, /* ** .pp ** When defined, Mutt will recode commands in rc files from this - ** encoding. + ** encoding to the current character set as specified by $$charset + ** and aliases written to $$alias_file from the current character set. + ** .pp + ** Please note that if setting $$charset it must be done before + ** setting $$config_charset. + ** .pp + ** Recoding should be avoided as it may render unconvertable + ** characters as question marks which can lead to undesired + ** side effects (for example in regular expressions). */ { "confirmappend", DT_BOOL, R_NONE, OPTCONFIRMAPPEND, 1 }, /* ** .pp - ** When set, Mutt will prompt for confirmation when appending messages to + ** When \fIset\fP, Mutt will prompt for confirmation when appending messages to ** an existing mailbox. */ { "confirmcreate", DT_BOOL, R_NONE, OPTCONFIRMCREATE, 1 }, /* ** .pp - ** When set, Mutt will prompt for confirmation when saving messages to a + ** When \fIset\fP, Mutt will prompt for confirmation when saving messages to a ** mailbox which does not yet exist before creating it. */ { "connect_timeout", DT_NUM, R_NONE, UL &ConnectTimeout, 30 }, /* ** .pp - ** Causes Mutt to timeout a network connection (for IMAP or POP) after this + ** Causes Mutt to timeout a network connection (for IMAP, POP or SMTP) after this ** many seconds if the connection is not able to be established. A negative - ** value causes Mutt to wait indefinitely for the connection to succeed. + ** value causes Mutt to wait indefinitely for the connection attempt to succeed. */ { "content_type", DT_STR, R_NONE, UL &ContentType, UL "text/plain" }, /* @@ -393,69 +447,143 @@ struct option_t MuttVars[] = { /* ** .pp ** This variable controls whether or not copies of your outgoing messages - ** will be saved for later references. Also see ``$$record'', - ** ``$$save_name'', ``$$force_name'' and ``$fcc-hook''. + ** will be saved for later references. Also see $$record, + ** $$save_name, $$force_name and ``$fcc-hook''. + */ + { "pgp_autoencrypt", DT_SYN, R_NONE, UL "crypt_autoencrypt", 0 }, + { "crypt_autoencrypt", DT_BOOL, R_NONE, OPTCRYPTAUTOENCRYPT, 0 }, + /* + ** .pp + ** Setting this variable will cause Mutt to always attempt to PGP + ** encrypt outgoing messages. This is probably only useful in + ** connection to the ``$send-hook'' command. It can be overridden + ** by use of the pgp menu, when encryption is not required or + ** signing is requested as well. If $$smime_is_default is \fIset\fP, + ** then OpenSSL is used instead to create S/MIME messages and + ** settings can be overridden by use of the smime menu instead. + ** (Crypto only) + */ + { "crypt_autopgp", DT_BOOL, R_NONE, OPTCRYPTAUTOPGP, 1 }, + /* + ** .pp + ** This variable controls whether or not mutt may automatically enable + ** PGP encryption/signing for messages. See also $$crypt_autoencrypt, + ** $$crypt_replyencrypt, + ** $$crypt_autosign, $$crypt_replysign and $$smime_is_default. + */ + { "pgp_autosign", DT_SYN, R_NONE, UL "crypt_autosign", 0 }, + { "crypt_autosign", DT_BOOL, R_NONE, OPTCRYPTAUTOSIGN, 0 }, + /* + ** .pp + ** Setting this variable will cause Mutt to always attempt to + ** cryptographically sign outgoing messages. This can be overridden + ** by use of the pgp menu, when signing is not required or + ** encryption is requested as well. If $$smime_is_default is \fIset\fP, + ** then OpenSSL is used instead to create S/MIME messages and settings can + ** be overridden by use of the smime menu instead of the pgp menu. + ** (Crypto only) + */ + { "crypt_autosmime", DT_BOOL, R_NONE, OPTCRYPTAUTOSMIME, 1 }, + /* + ** .pp + ** This variable controls whether or not mutt may automatically enable + ** S/MIME encryption/signing for messages. See also $$crypt_autoencrypt, + ** $$crypt_replyencrypt, + ** $$crypt_autosign, $$crypt_replysign and $$smime_is_default. + */ + { "pgp_replyencrypt", DT_SYN, R_NONE, UL "crypt_replyencrypt", 1 }, + { "crypt_replyencrypt", DT_BOOL, R_NONE, OPTCRYPTREPLYENCRYPT, 1 }, + /* + ** .pp + ** If \fIset\fP, automatically PGP or OpenSSL encrypt replies to messages which are + ** encrypted. + ** (Crypto only) + */ + { "pgp_replysign", DT_SYN, R_NONE, UL "crypt_replysign", 0 }, + { "crypt_replysign", DT_BOOL, R_NONE, OPTCRYPTREPLYSIGN, 0 }, + /* + ** .pp + ** If \fIset\fP, automatically PGP or OpenSSL sign replies to messages which are + ** signed. + ** .pp + ** \fBNote:\fP this does not work on messages that are encrypted + ** \fIand\fP signed! + ** (Crypto only) + */ + { "pgp_replysignencrypted", DT_SYN, R_NONE, UL "crypt_replysignencrypted", 0}, + { "crypt_replysignencrypted", DT_BOOL, R_NONE, OPTCRYPTREPLYSIGNENCRYPTED, 0 }, + /* + ** .pp + ** If \fIset\fP, automatically PGP or OpenSSL sign replies to messages + ** which are encrypted. This makes sense in combination with + ** $$crypt_replyencrypt, because it allows you to sign all + ** messages which are automatically encrypted. This works around + ** the problem noted in $$crypt_replysign, that mutt is not able + ** to find out whether an encrypted message is also signed. + ** (Crypto only) + */ + { "crypt_timestamp", DT_BOOL, R_NONE, OPTCRYPTTIMESTAMP, 1 }, + /* + ** .pp + ** If \fIset\fP, mutt will include a time stamp in the lines surrounding + ** PGP or S/MIME output, so spoofing such lines is more difficult. + ** If you are using colors to mark these lines, and rely on these, + ** you may \fIunset\fP this setting. + ** (Crypto only) */ - { "crypt_use_gpgme", DT_BOOL, R_NONE, OPTCRYPTUSEGPGME, 0 }, /* ** .pp ** This variable controls the use of the GPGME-enabled crypto backends. - ** If it is set and Mutt was built with gpgme support, the gpgme code for + ** If it is \fIset\fP and Mutt was built with gpgme support, the gpgme code for ** S/MIME and PGP will be used instead of the classic code. Note that - ** you need to set this option in .muttrc; it won't have any effect when + ** you need to set this option in .muttrc; it won't have any effect when ** used interactively. */ { "crypt_use_pka", DT_BOOL, R_NONE, OPTCRYPTUSEPKA, 0 }, /* - ** .pp Controls whether mutt uses PKA - ** (http://www.g10code.de/docs/pka-intro.de.pdf) during signature - ** verification (only supported by the GPGME backend). - */ - - { "crypt_autopgp", DT_BOOL, R_NONE, OPTCRYPTAUTOPGP, 1 }, - /* ** .pp - ** This variable controls whether or not mutt may automatically enable - ** PGP encryption/signing for messages. See also ``$$crypt_autoencrypt'', - ** ``$$crypt_replyencrypt'', - ** ``$$crypt_autosign'', ``$$crypt_replysign'' and ``$$smime_is_default''. + ** Controls whether mutt uses PKA + ** (see http://www.g10code.de/docs/pka-intro.de.pdf) during signature + ** verification (only supported by the GPGME backend). */ - { "crypt_autosmime", DT_BOOL, R_NONE, OPTCRYPTAUTOSMIME, 1 }, + { "pgp_verify_sig", DT_SYN, R_NONE, UL "crypt_verify_sig", 0}, + { "crypt_verify_sig", DT_QUAD, R_NONE, OPT_VERIFYSIG, M_YES }, /* ** .pp - ** This variable controls whether or not mutt may automatically enable - ** S/MIME encryption/signing for messages. See also ``$$crypt_autoencrypt'', - ** ``$$crypt_replyencrypt'', - ** ``$$crypt_autosign'', ``$$crypt_replysign'' and ``$$smime_is_default''. + ** If \fI``yes''\fP, always attempt to verify PGP or S/MIME signatures. + ** If \fI``ask-*''\fP, ask whether or not to verify the signature. + ** If \Fi``no''\fP, never attempt to verify cryptographic signatures. + ** (Crypto only) */ { "date_format", DT_STR, R_BOTH, UL &DateFmt, UL "!%a, %b %d, %Y at %I:%M:%S%p %Z" }, /* ** .pp ** This variable controls the format of the date printed by the ``%d'' - ** sequence in ``$$index_format''. This is passed to the \fIstrftime\fP - ** call to process the date. See the man page for \fIstrftime(3)\fP for - ** the proper syntax. + ** sequence in $$index_format. This is passed to the \fCstrftime(3)\fP + ** function to process the date, see the man page for the proper syntax. ** .pp ** Unless the first character in the string is a bang (``!''), the month ** and week day names are expanded according to the locale specified in - ** the variable ``$$locale''. If the first character in the string is a + ** the variable $$locale. If the first character in the string is a ** bang, the bang is discarded, and the month and week day names in the ** rest of the string are expanded in the \fIC\fP locale (that is in US ** English). - */ + */ { "default_hook", DT_STR, R_NONE, UL &DefaultHook, UL "~f %s !~P | (~P ~C %s)" }, /* ** .pp - ** This variable controls how message-hooks, reply-hooks, send-hooks, - ** send2-hooks, save-hooks, and fcc-hooks will + ** This variable controls how ``$message-hook'', ``$reply-hook'', ``$send-hook'', + ** ``$send2-hook'', ``$save-hook'', and ``$fcc-hook'' will ** be interpreted if they are specified with only a simple regexp, ** instead of a matching pattern. The hooks are expanded when they are ** declared, so a hook will be interpreted according to the value of this - ** variable at the time the hook is declared. The default value matches + ** variable at the time the hook is declared. + ** .pp + ** The default value matches ** if the message is either from a user matching the regular expression ** given, or if it is from you (if the from address matches - ** ``alternates'') and is to or cc'ed to a user matching the given + ** ``$alternates'') and is to or cc'ed to a user matching the given ** regular expression. */ { "delete", DT_QUAD, R_NONE, OPT_DELETE, M_ASKYES }, @@ -477,7 +605,7 @@ struct option_t MuttVars[] = { /* ** .pp ** If this option is \fIset\fP, mutt's received-attachments menu will not show the subparts of - ** individual messages in a multipart/digest. To see these subparts, press 'v' on that menu. + ** individual messages in a multipart/digest. To see these subparts, press ``v'' on that menu. */ { "display_filter", DT_PATH, R_PAGER, UL &DisplayFilter, UL "" }, /* @@ -490,7 +618,7 @@ struct option_t MuttVars[] = { { "dotlock_program", DT_PATH, R_NONE, UL &MuttDotlock, UL BINDIR "/mutt_dotlock" }, /* ** .pp - ** Contains the path of the mutt_dotlock (8) binary to be used by + ** Contains the path of the \fCmutt_dotlock(8)\fP binary to be used by ** mutt. */ #endif @@ -504,13 +632,16 @@ struct option_t MuttVars[] = { ** \fIdelay\fP, to be notified of message delays, \fIsuccess\fP, to be ** notified of successful transmission. ** .pp - ** Example: set dsn_notify="failure,delay" + ** Example: + ** .ts + ** set dsn_notify="failure,delay" + ** .te ** .pp ** \fBNote:\fP when using $$sendmail for delivery, you should not enable ** this unless you are either using Sendmail 8.8.x or greater or a MTA - ** providing a sendmail(1)-compatible interface supporting the -N option - ** for DSN. For SMTP delivery, it depends on the server whether DSN is - ** supported or not. + ** providing a \fCsendmail(1)\fP-compatible interface supporting the \fC-N\fP option + ** for DSN. For SMTP delivery, DSN support is autodetected so that it + ** depends on the server whether DSN will be used or not. */ { "dsn_return", DT_STR, R_NONE, UL &DsnReturn, UL "" }, /* @@ -519,21 +650,24 @@ struct option_t MuttVars[] = { ** messages. It may be set to either \fIhdrs\fP to return just the ** message header, or \fIfull\fP to return the full message. ** .pp - ** Example: set dsn_return=hdrs + ** Example: + ** .ts + ** set dsn_return=hdrs + ** .te ** .pp ** \fBNote:\fP when using $$sendmail for delivery, you should not enable ** this unless you are either using Sendmail 8.8.x or greater or a MTA - ** providing a sendmail(1)-compatible interface supporting the -R option - ** for DSN. For SMTP delivery, it depends on the server whether DSN is - ** supported or not. + ** providing a \fCsendmail(1)\fP-compatible interface supporting the \fC-R\fP option + ** for DSN. For SMTP delivery, DSN support is autodetected so that it + ** depends on the server whether DSN will be used or not. */ { "duplicate_threads", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTDUPTHREADS, 1 }, /* ** .pp - ** This variable controls whether mutt, when sorting by threads, threads - ** messages with the same message-id together. If it is set, it will indicate + ** This variable controls whether mutt, when $$sort is set to \fIthreads\fP, threads + ** messages with the same Message-Id together. If it is \fIset\fP, it will indicate ** that it thinks they are duplicates of each other with an equals sign - ** in the thread diagram. + ** in the thread tree. */ { "edit_headers", DT_BOOL, R_NONE, OPTEDITHDRS, 0 }, /* @@ -546,27 +680,36 @@ struct option_t MuttVars[] = { */ { "edit_hdrs", DT_SYN, R_NONE, UL "edit_headers", 0 }, /* - */ + */ { "editor", DT_PATH, R_NONE, UL &Editor, 0 }, /* ** .pp ** This variable specifies which editor is used by mutt. - ** It defaults to the value of the VISUAL, or EDITOR, environment - ** variable, or to the string "vi" if neither of those are set. + ** It defaults to the value of the \fC$$$VISUAL\fP, or \fC$$$EDITOR\fP, environment + ** variable, or to the string ``vi'' if neither of those are set. */ { "encode_from", DT_BOOL, R_NONE, OPTENCODEFROM, 0 }, /* ** .pp ** When \fIset\fP, mutt will quoted-printable encode messages when - ** they contain the string "From " in the beginning of a line. - ** Useful to avoid the tampering certain mail delivery and transport - ** agents tend to do with messages. + ** they contain the string ``From '' (note the trailing space) in the beginning of a line. + ** This is useful to avoid the tampering certain mail delivery and transport + ** agents tend to do with messages (in order to prevent tools from + ** misinterpreting the line as a mbox message separator). + */ +#if defined(USE_SSL_OPENSSL) + { "entropy_file", DT_PATH, R_NONE, UL &SslEntropyFile, 0 }, + /* + ** .pp + ** The file which includes random data that is used to initialize SSL + ** library functions. */ +#endif { "envelope_from_address", DT_ADDR, R_NONE, UL &EnvFrom, 0 }, /* ** .pp ** Manually sets the \fIenvelope\fP sender for outgoing messages. - ** This value is ignored if ``$$use_envelope_from'' is unset. + ** This value is ignored if $$use_envelope_from is \fIunset\fP. */ { "escape", DT_STR, R_NONE, UL &EscChar, UL "~" }, /* @@ -576,14 +719,14 @@ struct option_t MuttVars[] = { { "fast_reply", DT_BOOL, R_NONE, OPTFASTREPLY, 0 }, /* ** .pp - ** When set, the initial prompt for recipients and subject are skipped + ** When \fIset\fP, the initial prompt for recipients and subject are skipped ** when replying to messages, and the initial prompt for subject is ** skipped when forwarding messages. ** .pp - ** \fBNote:\fP this variable has no effect when the ``$$autoedit'' - ** variable is set. + ** \fBNote:\fP this variable has no effect when the $$autoedit + ** variable is \fIset\fP. */ - { "fcc_attach", DT_BOOL, R_NONE, OPTFCCATTACH, 1 }, + { "fcc_attach", DT_QUAD, R_NONE, OPT_FCCATTACH, M_YES }, /* ** .pp ** This variable controls whether or not attachments on outgoing messages @@ -592,7 +735,7 @@ struct option_t MuttVars[] = { { "fcc_clear", DT_BOOL, R_NONE, OPTFCCCLEAR, 0 }, /* ** .pp - ** When this variable is set, FCCs will be stored unencrypted and + ** When this variable is \fIset\fP, FCCs will be stored unencrypted and ** unsigned, even when the actual message is encrypted and/or ** signed. ** (PGP only) @@ -600,51 +743,54 @@ struct option_t MuttVars[] = { { "folder", DT_PATH, R_NONE, UL &Maildir, UL "~/Mail" }, /* ** .pp - ** Specifies the default location of your mailboxes. A `+' or `=' at the + ** Specifies the default location of your mailboxes. A ``+'' or ``='' at the ** beginning of a pathname will be expanded to the value of this - ** variable. Note that if you change this variable from the default + ** variable. Note that if you change this variable (from the default) ** value you need to make sure that the assignment occurs \fIbefore\fP - ** you use `+' or `=' for any other variables since expansion takes place - ** during the `set' command. + ** you use ``+'' or ``='' for any other variables since expansion takes place + ** when handling the ``$mailboxes'' command. */ { "folder_format", DT_STR, R_INDEX, UL &FolderFormat, UL "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f" }, /* ** .pp ** This variable allows you to customize the file browser display to your - ** personal taste. This string is similar to ``$$index_format'', but has - ** its own set of printf()-like sequences: - ** .pp + ** personal taste. This string is similar to $$index_format, but has + ** its own set of \fCprintf(3)\fP-like sequences: ** .dl ** .dt %C .dd current file number ** .dt %d .dd date/time folder was last modified - ** .dt %f .dd filename + ** .dt %f .dd filename (``/'' is appended to directory names, + ** ``@'' to symbolic links and ``*'' to executable + ** files) ** .dt %F .dd file permissions ** .dt %g .dd group name (or numeric gid, if missing) ** .dt %l .dd number of hard links ** .dt %N .dd N if folder has new mail, blank otherwise ** .dt %s .dd size in bytes - ** .dt %t .dd * if the file is tagged, blank otherwise + ** .dt %t .dd ``*'' if the file is tagged, blank otherwise ** .dt %u .dd owner name (or numeric uid, if missing) - ** .dt %>X .dd right justify the rest of the string and pad with character "X" - ** .dt %|X .dd pad to the end of the line with character "X" - ** .dt %*X .dd soft-fill with character "X" as pad + ** .dt %>X .dd right justify the rest of the string and pad with character ``X'' + ** .dt %|X .dd pad to the end of the line with character ``X'' + ** .dt %*X .dd soft-fill with character ``X'' as pad ** .de ** .pp - ** For an explanation of `soft-fill', see the ``$$index_format'' documentation. + ** For an explanation of ``soft-fill'', see the $$index_format documentation. */ { "followup_to", DT_BOOL, R_NONE, OPTFOLLOWUPTO, 1 }, /* ** .pp - ** Controls whether or not the \fIMail-Followup-To\fP header field is + ** Controls whether or not the ``Mail-Followup-To:'' header field is ** generated when sending mail. When \fIset\fP, Mutt will generate this ** field when you are replying to a known mailing list, specified with - ** the ``subscribe'' or ``$lists'' commands. + ** the ``$subscribe'' or ``$lists'' commands. ** .pp ** This field has two purposes. First, preventing you from ** receiving duplicate copies of replies to messages which you send ** to mailing lists, and second, ensuring that you do get a reply ** separately for any messages sent to known lists to which you are - ** not subscribed. The header will contain only the list's address + ** not subscribed. + ** .pp + ** The header will contain only the list's address ** for subscribed lists, and both the list address and your own ** email address for unsubscribed lists. Without this header, a ** group reply to your message sent to a subscribed list will be @@ -654,23 +800,35 @@ struct option_t MuttVars[] = { { "force_name", DT_BOOL, R_NONE, OPTFORCENAME, 0 }, /* ** .pp - ** This variable is similar to ``$$save_name'', except that Mutt will + ** This variable is similar to $$save_name, except that Mutt will ** store a copy of your outgoing message by the username of the address ** you are sending to even if that mailbox does not exist. ** .pp - ** Also see the ``$$record'' variable. + ** Also see the $$record variable. */ { "forward_decode", DT_BOOL, R_NONE, OPTFORWDECODE, 1 }, /* ** .pp - ** Controls the decoding of complex MIME messages into text/plain when + ** Controls the decoding of complex MIME messages into \fCtext/plain\fP when ** forwarding a message. The message header is also RFC2047 decoded. - ** This variable is only used, if ``$$mime_forward'' is \fIunset\fP, - ** otherwise ``$$mime_forward_decode'' is used instead. + ** This variable is only used, if $$mime_forward is \fIunset\fP, + ** otherwise $$mime_forward_decode is used instead. */ { "forw_decode", DT_SYN, R_NONE, UL "forward_decode", 0 }, /* */ + { "forward_decrypt", DT_BOOL, R_NONE, OPTFORWDECRYPT, 1 }, + /* + ** .pp + ** Controls the handling of encrypted messages when forwarding a message. + ** When \fIset\fP, the outer layer of encryption is stripped off. This + ** variable is only used if $$mime_forward is \fIset\fP and + ** $$mime_forward_decode is \fIunset\fP. + ** (PGP only) + */ + { "forw_decrypt", DT_SYN, R_NONE, UL "forward_decrypt", 0 }, + /* + */ { "forward_edit", DT_QUAD, R_NONE, OPT_FORWEDIT, M_YES }, /* ** .pp @@ -682,17 +840,17 @@ struct option_t MuttVars[] = { /* ** .pp ** This variable controls the default subject when forwarding a message. - ** It uses the same format sequences as the ``$$index_format'' variable. + ** It uses the same format sequences as the $$index_format variable. */ - { "forw_format", DT_SYN, R_NONE, UL "forward_format", 0 }, + { "forw_format", DT_SYN, R_NONE, UL "forward_format", 0 }, /* */ { "forward_quote", DT_BOOL, R_NONE, OPTFORWQUOTE, 0 }, /* ** .pp - ** When \fIset\fP forwarded messages included in the main body of the - ** message (when ``$$mime_forward'' is \fIunset\fP) will be quoted using - ** ``$$indent_string''. + ** When \fIset\fP, forwarded messages included in the main body of the + ** message (when $$mime_forward is \fIunset\fP) will be quoted using + ** $$indent_string. */ { "forw_quote", DT_SYN, R_NONE, UL "forward_quote", 0 }, /* @@ -700,27 +858,26 @@ struct option_t MuttVars[] = { { "from", DT_ADDR, R_NONE, UL &From, UL 0 }, /* ** .pp - ** When set, this variable contains a default from address. It - ** can be overridden using my_hdr (including from send-hooks) and - ** ``$$reverse_name''. This variable is ignored if ``$$use_from'' - ** is unset. + ** When \fIset\fP, this variable contains a default from address. It + ** can be overridden using ``$my_hdr'' (including from a ``$send-hook'') and + ** $$reverse_name. This variable is ignored if $$use_from is \fIunset\fP. ** .pp - ** Defaults to the contents of the environment variable EMAIL. + ** This setting defaults to the contents of the environment variable \fC$$$EMAIL\fP. */ { "gecos_mask", DT_RX, R_NONE, UL &GecosMask, UL "^[^,]*" }, /* ** .pp ** A regular expression used by mutt to parse the GECOS field of a password - ** entry when expanding the alias. By default the regular expression is set - ** to "^[^,]*" which will return the string up to the first "," encountered. - ** If the GECOS field contains a string like "lastname, firstname" then you - ** should set the gecos_mask=".*". - ** .pp - ** This can be useful if you see the following behavior: you address a e-mail - ** to user ID stevef whose full name is Steve Franklin. If mutt expands - ** stevef to "Franklin" stevef@foo.bar then you should set the gecos_mask to + ** entry when expanding the alias. The default value + ** will return the string up to the first ``,'' encountered. + ** If the GECOS field contains a string like ``lastname, firstname'' then you + ** should set it to ``\fC.*\fP''. + ** .pp + ** This can be useful if you see the following behavior: you address an e-mail + ** to user ID ``stevef'' whose full name is ``Steve Franklin''. If mutt expands + ** ``stevef'' to ``"Franklin" stevef@foo.bar'' then you should set the $$gecos_mask to ** a regular expression that will match the whole name so mutt will expand - ** "Franklin" to "Franklin, Steve". + ** ``Franklin'' to ``Franklin, Steve''. */ { "hdr_format", DT_SYN, R_NONE, UL "index_format", 0 }, /* @@ -728,22 +885,58 @@ struct option_t MuttVars[] = { { "hdrs", DT_BOOL, R_NONE, OPTHDRS, 1 }, /* ** .pp - ** When unset, the header fields normally added by the ``$my_hdr'' + ** When \fIunset\fP, the header fields normally added by the ``$my_hdr'' ** command are not created. This variable \fImust\fP be unset before - ** composing a new message or replying in order to take effect. If set, + ** composing a new message or replying in order to take effect. If \fIset\fP, ** the user defined header fields are added to every new message. */ { "header", DT_BOOL, R_NONE, OPTHEADER, 0 }, /* ** .pp - ** When set, this variable causes Mutt to include the header + ** When \fIset\fP, this variable causes Mutt to include the header ** of the message you are replying to into the edit buffer. - ** The ``$$weed'' setting applies. - */ + ** The $$weed setting applies. + */ +#ifdef USE_HCACHE + { "header_cache", DT_PATH, R_NONE, UL &HeaderCache, 0 }, + /* + ** .pp + ** This variable points to the header cache database. + ** If pointing to a directory Mutt will contain a header cache + ** database file per folder, if pointing to a file that file will + ** be a single global header cache. By default it is \fIunset\fP so no header + ** caching will be used. + ** .pp + ** Header caching can greatly improve speed when opening POP, IMAP + ** MH or Maildir folders, see ``$caching'' for details. + */ +#if defined(HAVE_QDBM) || defined(HAVE_TC) + { "header_cache_compress", DT_BOOL, R_NONE, OPTHCACHECOMPRESS, 1 }, + /* + ** .pp + ** When mutt is compiled with qdbm or tokyocabinet as header cache backend, + ** this option determines whether the database will be compressed. + ** Compression results in database files roughly being one fifth + ** of the usual diskspace, but the uncompression can result in a + ** slower opening of cached folder(s) which in general is still + ** much faster than opening non header cached folders. + */ +#endif /* HAVE_QDBM */ +#if defined(HAVE_GDBM) || defined(HAVE_DB4) + { "header_cache_pagesize", DT_STR, R_NONE, UL &HeaderCachePageSize, UL "16384" }, + /* + ** .pp + ** When mutt is compiled with either gdbm or bdb4 as the header cache backend, + ** this option changes the database page size. Too large or too small + ** values can waste space, memory, or CPU time. The default should be more + ** or less optimal for most use cases. + */ +#endif /* HAVE_GDBM || HAVE_DB4 */ +#endif /* USE_HCACHE */ { "help", DT_BOOL, R_BOTH, OPTHELP, 1 }, /* ** .pp - ** When set, help lines describing the bindings for the major functions + ** When \fIset\fP, help lines describing the bindings for the major functions ** provided by each menu are displayed on the first line of the screen. ** .pp ** \fBNote:\fP The binding will not be displayed correctly if the @@ -755,49 +948,49 @@ struct option_t MuttVars[] = { { "hidden_host", DT_BOOL, R_NONE, OPTHIDDENHOST, 0 }, /* ** .pp - ** When set, mutt will skip the host name part of ``$$hostname'' variable + ** When \fIset\fP, mutt will skip the host name part of $$hostname variable ** when adding the domain part to addresses. This variable does not - ** affect the generation of Message-IDs, and it will not lead to the + ** affect the generation of Message-IDs, and it will not lead to the ** cut-off of first-level domains. */ { "hide_limited", DT_BOOL, R_TREE|R_INDEX, OPTHIDELIMITED, 0 }, /* ** .pp - ** When set, mutt will not show the presence of messages that are hidden + ** When \fIset\fP, mutt will not show the presence of messages that are hidden ** by limiting, in the thread tree. */ { "hide_missing", DT_BOOL, R_TREE|R_INDEX, OPTHIDEMISSING, 1 }, /* ** .pp - ** When set, mutt will not show the presence of missing messages in the + ** When \fIset\fP, mutt will not show the presence of missing messages in the ** thread tree. */ { "hide_thread_subject", DT_BOOL, R_TREE|R_INDEX, OPTHIDETHREADSUBJECT, 1 }, /* ** .pp - ** When set, mutt will not show the subject of messages in the thread + ** When \fIset\fP, mutt will not show the subject of messages in the thread ** tree that have the same subject as their parent or closest previously ** displayed sibling. */ { "hide_top_limited", DT_BOOL, R_TREE|R_INDEX, OPTHIDETOPLIMITED, 0 }, /* ** .pp - ** When set, mutt will not show the presence of messages that are hidden + ** When \fIset\fP, mutt will not show the presence of messages that are hidden ** by limiting, at the top of threads in the thread tree. Note that when - ** $$hide_limited is set, this option will have no effect. + ** $$hide_limited is \fIset\fP, this option will have no effect. */ { "hide_top_missing", DT_BOOL, R_TREE|R_INDEX, OPTHIDETOPMISSING, 1 }, /* ** .pp - ** When set, mutt will not show the presence of missing messages at the + ** When \fIset\fP, mutt will not show the presence of missing messages at the ** top of threads in the thread tree. Note that when $$hide_missing is - ** set, this option will have no effect. + ** \fIset\fP, this option will have no effect. */ { "history", DT_NUM, R_NONE, UL &HistSize, 10 }, /* ** .pp ** This variable controls the size (in number of strings remembered) of - ** the string history buffer. The buffer is cleared each time the + ** the string history buffer per category. The buffer is cleared each time the ** variable is set. */ { "history_file", DT_PATH, R_NONE, UL &HistFile, UL "~/.mutthistory" }, @@ -805,6 +998,17 @@ struct option_t MuttVars[] = { ** .pp ** The file in which Mutt will save its history. */ + { "honor_disposition", DT_BOOL, R_NONE, OPTHONORDISP, 0 }, + /* + ** .pp + ** When \fIset\fP, Mutt will not display attachments with a + ** disposition of ``attachment'' inline even if it could + ** render the part to plain text. These MIME parts can only + ** be viewed from the attachment menu. + ** .pp + ** If \fIunset\fP, Mutt will render all MIME parts it can + ** properly transform to plain text. + */ { "honor_followup_to", DT_QUAD, R_NONE, OPT_MFUPTO, M_YES }, /* ** .pp @@ -820,33 +1024,33 @@ struct option_t MuttVars[] = { ** Message-Id headers. ** .pp ** Its value is determined at startup as follows: If the node's name - ** as returned by the uname(3) function contains the hostname and the + ** as returned by the \fCuname(3)\fP function contains the hostname and the ** domain, these are used to construct $$hostname. If there is no ** domain part returned, Mutt will look for a ``domain'' or ``search'' - ** line in /etc/resolv.conf to determine the domain. Optionally, Mutt + ** line in \fC/etc/resolv.conf\fP to determine the domain. Optionally, Mutt ** can be compiled with a fixed domain name in which case a detected ** one is not used. ** .pp - ** Also see ``$$use_domain'' and ``$$hidden_host''. + ** Also see $$use_domain and $$hidden_host. */ { "ignore_linear_white_space", DT_BOOL, R_NONE, OPTIGNORELWS, 0 }, /* ** .pp ** This option replaces linear-white-space between encoded-word - ** and *text to a single space to prevent the display of MIME-encoded - ** ``Subject'' field from being divided into multiple lines. + ** and text to a single space to prevent the display of MIME-encoded + ** ``Subject:'' field from being divided into multiple lines. */ { "ignore_list_reply_to", DT_BOOL, R_NONE, OPTIGNORELISTREPLYTO, 0 }, /* ** .pp - ** Affects the behaviour of the \fIreply\fP function when replying to - ** messages from mailing lists (as defined by the ``subscribe'' or - ** ``$lists'' commands). When set, if the ``Reply-To:'' field is + ** Affects the behaviour of the \fC\fP function when replying to + ** messages from mailing lists (as defined by the ``$subscribe'' or + ** ``$lists'' commands). When \fIset\fP, if the ``Reply-To:'' field is ** set to the same value as the ``To:'' field, Mutt assumes that the ** ``Reply-To:'' field was set by the mailing list to automate responses ** to the list, and will ignore this field. To direct a response to the - ** mailing list when this option is set, use the \fIlist-reply\fP - ** function; \fIgroup-reply\fP will reply to both the sender and the + ** mailing list when this option is \fIset\fP, use the \fC$\fP + ** function; \fC\fP will reply to both the sender and the ** list. */ #ifdef USE_IMAP @@ -855,13 +1059,16 @@ struct option_t MuttVars[] = { ** .pp ** This is a colon-delimited list of authentication methods mutt may ** attempt to use to log in to an IMAP server, in the order mutt should - ** try them. Authentication methods are either 'login' or the right - ** side of an IMAP 'AUTH=xxx' capability string, eg 'digest-md5', 'gssapi' - ** or 'cram-md5'. This parameter is case-insensitive. If this - ** parameter is \fIunset\fP (the default) mutt will try all available methods, + ** try them. Authentication methods are either ``login'' or the right + ** side of an IMAP ``AUTH=xxx'' capability string, eg ``digest-md5'', ``gssapi'' + ** or ``cram-md5''. This option is case-insensitive. If it's + ** \fIunset\fP (the default) mutt will try all available methods, ** in order from most-secure to least-secure. ** .pp - ** Example: set imap_authenticators="gssapi:cram-md5:login" + ** Example: + ** .ts + ** set imap_authenticators="gssapi:cram-md5:login" + ** .te ** .pp ** \fBNote:\fP Mutt will only fall back to other authentication methods if ** the previous methods are unavailable. If a method is available but @@ -872,33 +1079,39 @@ struct option_t MuttVars[] = { ** .pp ** When \fIset\fP, mutt will fetch the set of subscribed folders from ** your server on connection, and add them to the set of mailboxes - ** it polls for new mail. See also the ``$mailboxes'' command. + ** it polls for new mail just as if you had issued individual ``$mailboxes'' + ** commands. */ { "imap_delim_chars", DT_STR, R_NONE, UL &ImapDelimChars, UL "/." }, /* ** .pp ** This contains the list of characters which you would like to treat ** as folder separators for displaying IMAP paths. In particular it - ** helps in using the '=' shortcut for your \fIfolder\fP variable. + ** helps in using the ``='' shortcut for your \fIfolder\fP variable. */ { "imap_headers", DT_STR, R_INDEX, UL &ImapHeaders, UL 0}, /* ** .pp ** Mutt requests these header fields in addition to the default headers - ** ("DATE FROM SUBJECT TO CC MESSAGE-ID REFERENCES CONTENT-TYPE - ** CONTENT-DESCRIPTION IN-REPLY-TO REPLY-TO LINES X-LABEL") from IMAP + ** (``Date:'', ``From:'', ``Subject:'', ``To:'', ``Cc:'', ``Message-Id:'', + ** ``References:'', ``Content-Type:'', ``Content-Description:'', ``In-Reply-To:'', + ** ``Reply-To:'', ``Lines:'', ``List-Post:'', ``X-Label:'') from IMAP ** servers before displaying the index menu. You may want to add more - ** headers for spam detection. \fBNote:\fP This is a space separated list. + ** headers for spam detection. + ** .pp + ** \fBNote:\fP This is a space separated list, items should be uppercase + ** and not contain the colon, e.g. ``X-BOGOSITY X-SPAM-STATUS'' for the + ** ``X-Bogosity:'' and ``X-Spam-Status:'' header fields. */ { "imap_idle", DT_BOOL, R_NONE, OPTIMAPIDLE, 0 }, /* - ** .pp - ** When \fIset\fP, mutt will attempt to use the IMAP IDLE extension - ** to check for new mail in the current mailbox. Some servers - ** (dovecot was the inspiration for this option) react badly - ** to mutt's implementation. If your connection seems to freeze - ** up periodically, try unsetting this. - */ + ** .pp + ** When \fIset\fP, mutt will attempt to use the IMAP IDLE extension + ** to check for new mail in the current mailbox. Some servers + ** (dovecot was the inspiration for this option) react badly + ** to mutt's implementation. If your connection seems to freeze + ** up periodically, try unsetting this. + */ { "imap_keepalive", DT_NUM, R_NONE, UL &ImapKeepalive, 900 }, /* ** .pp @@ -915,20 +1128,22 @@ struct option_t MuttVars[] = { ** .pp ** This variable configures whether IMAP folder browsing will look for ** only subscribed folders or all folders. This can be toggled in the - ** IMAP browser with the \fItoggle-subscribed\fP function. + ** IMAP browser with the \fC\fP function. */ { "imap_login", DT_STR, R_NONE, UL &ImapLogin, UL 0 }, /* ** .pp ** Your login name on the IMAP server. ** .pp - ** This variable defaults to the value of \fIimap_user\fP. + ** This variable defaults to the value of $$imap_user. */ { "imap_pass", DT_STR, R_NONE, UL &ImapPass, UL 0 }, /* ** .pp ** Specifies the password for your IMAP account. If \fIunset\fP, Mutt will - ** prompt you for your password when you invoke the fetch-mail function. + ** prompt you for your password when you invoke the \fC\fP function + ** or try to open an IMAP folder. + ** .pp ** \fBWarning\fP: you should only use this option when you are on a ** fairly secure machine, because the superuser can read your muttrc even ** if you are the only one who can read the file. @@ -950,6 +1165,17 @@ struct option_t MuttVars[] = { ** but can make closing an IMAP folder somewhat slower. This option ** exists to appease speed freaks. */ + { "imap_pipeline_depth", DT_NUM, R_NONE, UL &ImapPipelineDepth, 15 }, + /* + ** .pp + ** Controls the number of IMAP commands that may be queued up before they + ** are sent to the server. A deeper pipeline reduces the amount of time + ** mutt must wait for the server, and can make IMAP servers feel much + ** more responsive. But not all servers correctly handle pipelined commands, + ** so if you have problems you might want to try setting this variable to 0. + ** .pp + ** \fBNote:\fP Changes to this variable have no effect on open connections. + */ { "imap_servernoise", DT_BOOL, R_NONE, OPTIMAPSERVERNOISE, 1 }, /* ** .pp @@ -972,7 +1198,7 @@ struct option_t MuttVars[] = { /* ** .pp ** If set to ``yes'', mutt will look for a mailcap entry with the - ** copiousoutput flag set for \fIevery\fP MIME attachment it doesn't have + ** ``\fCcopiousoutput\fP'' flag set for \fIevery\fP MIME attachment it doesn't have ** an internal viewer defined for. If such an entry is found, mutt will ** use the viewer defined in that entry to convert the body part to text ** form. @@ -996,8 +1222,11 @@ struct option_t MuttVars[] = { ** message to which you are replying. You are strongly encouraged not to ** change this value, as it tends to agitate the more fanatical netizens. ** .pp + ** The value of this option is ignored if $$text_flowed is set, too because + ** the quoting mechanism is strictly defined for format=flowed. + ** .pp ** This option is a format string, please see the description of - ** ``$$index_format'' for supported printf()-style sequences. + ** $$index_format for supported \fCprintf(3)\fP-style sequences. */ { "indent_str", DT_SYN, R_NONE, UL "indent_string", 0 }, /* @@ -1008,21 +1237,20 @@ struct option_t MuttVars[] = { ** This variable allows you to customize the message index display to ** your personal taste. ** .pp - ** ``Format strings'' are similar to the strings used in the ``C'' - ** function printf to format output (see the man page for more detail). + ** ``Format strings'' are similar to the strings used in the C + ** function \fCprintf(3)\fP to format output (see the man page for more details). ** The following sequences are defined in Mutt: - ** .pp ** .dl ** .dt %a .dd address of the author ** .dt %A .dd reply-to address (if present; otherwise: address of author) - ** .dt %b .dd filename of the original message folder (think mailBox) + ** .dt %b .dd filename of the original message folder (think mailbox) ** .dt %B .dd the list to which the letter was sent, or else the folder name (%b). ** .dt %c .dd number of characters (bytes) in the message ** .dt %C .dd current message number ** .dt %d .dd date and time of the message in the format specified by - ** ``date_format'' converted to sender's time zone + ** $$date_format converted to sender's time zone ** .dt %D .dd date and time of the message in the format specified by - ** ``date_format'' converted to the local time zone + ** $$date_format converted to the local time zone ** .dt %e .dd current message number in thread ** .dt %E .dd number of messages in current thread ** .dt %f .dd sender (address + real name), either From: or Return-Path: @@ -1031,57 +1259,56 @@ struct option_t MuttVars[] = { ** .dt %i .dd message-id of the current message ** .dt %l .dd number of lines in the message (does not work with maildir, ** mh, and possibly IMAP folders) - ** .dt %L .dd If an address in the To or CC header field matches an address - ** defined by the users ``subscribe'' command, this displays + ** .dt %L .dd If an address in the ``To:'' or ``Cc:'' header field matches an address + ** defined by the users ``$subscribe'' command, this displays ** "To ", otherwise the same as %F. ** .dt %m .dd total number of message in the mailbox ** .dt %M .dd number of hidden messages if the thread is collapsed. ** .dt %N .dd message score ** .dt %n .dd author's real name (or address if missing) - ** .dt %O .dd (_O_riginal save folder) Where mutt would formerly have - ** stashed the message: list name or recipient name if no list + ** .dt %O .dd original save folder where mutt would formerly have + ** stashed the message: list name or recipient name + ** if not sent to a list ** .dt %P .dd progress indicator for the builtin pager (how much of the file has been displayed) ** .dt %s .dd subject of the message - ** .dt %S .dd status of the message (N/D/d/!/r/\(as) - ** .dt %t .dd `to:' field (recipients) + ** .dt %S .dd status of the message (``N''/``D''/``d''/``!''/``r''/\(as) + ** .dt %t .dd ``To:'' field (recipients) ** .dt %T .dd the appropriate character from the $$to_chars string ** .dt %u .dd user (login) name of the author ** .dt %v .dd first name of the author, or the recipient if the message is from you ** .dt %X .dd number of attachments ** (please see the ``$attachments'' section for possible speed effects) - ** .dt %y .dd `x-label:' field, if present - ** .dt %Y .dd `x-label' field, if present, and (1) not at part of a thread tree, - ** (2) at the top of a thread, or (3) `x-label' is different from - ** preceding message's `x-label'. + ** .dt %y .dd ``X-Label:'' field, if present + ** .dt %Y .dd ``X-Label:'' field, if present, and \fI(1)\fP not at part of a thread tree, + ** \fI(2)\fP at the top of a thread, or \fI(3)\fP ``X-Label:'' is different from + ** preceding message's ``X-Label:''. ** .dt %Z .dd message status flags ** .dt %{fmt} .dd the date and time of the message is converted to sender's ** time zone, and ``fmt'' is expanded by the library function - ** ``strftime''; a leading bang disables locales + ** \fCstrftime(3)\fP; a leading bang disables locales ** .dt %[fmt] .dd the date and time of the message is converted to the local ** time zone, and ``fmt'' is expanded by the library function - ** ``strftime''; a leading bang disables locales + ** \fCstrftime(3)\fP; a leading bang disables locales ** .dt %(fmt) .dd the local date and time when the message was received. - ** ``fmt'' is expanded by the library function ``strftime''; + ** ``fmt'' is expanded by the library function \fCstrftime(3)\fP; ** a leading bang disables locales ** .dt % .dd the current local time. ``fmt'' is expanded by the library - ** function ``strftime''; a leading bang disables locales. - ** .dt %>X .dd right justify the rest of the string and pad with character "X" - ** .dt %|X .dd pad to the end of the line with character "X" - ** .dt %*X .dd soft-fill with character "X" as pad + ** function \fCstrftime(3)\fP; a leading bang disables locales. + ** .dt %>X .dd right justify the rest of the string and pad with character ``X'' + ** .dt %|X .dd pad to the end of the line with character ``X'' + ** .dt %*X .dd soft-fill with character ``X'' as pad ** .de ** .pp - ** `Soft-fill' deserves some explanation. Normal right-justification - ** will print everything to the left of the %>, displaying padding and - ** the whatever lies to the right only if there's room. By contrast, + ** ``Soft-fill'' deserves some explanation: Normal right-justification + ** will print everything to the left of the ``%>'', displaying padding and + ** whatever lies to the right only if there's room. By contrast, ** soft-fill gives priority to the right-hand side, guaranteeing space ** to display it and showing padding only if there's still room. If ** necessary, soft-fill will eat text leftwards to make room for ** rightward text. ** .pp - ** Note that these expandos are supported in + ** Note that these expandos are supported in ** ``$save-hook'', ``$fcc-hook'' and ``$fcc-save-hook'', too. - ** .pp - ** See also: ``$$to_chars''. */ { "ispell", DT_PATH, R_NONE, UL &Ispell, UL ISPELL }, /* @@ -1091,21 +1318,21 @@ struct option_t MuttVars[] = { { "keep_flagged", DT_BOOL, R_NONE, OPTKEEPFLAGGED, 0 }, /* ** .pp - ** If set, read messages marked as flagged will not be moved - ** from your spool mailbox to your ``$$mbox'' mailbox, or as a result of + ** If \fIset\fP, read messages marked as flagged will not be moved + ** from your spool mailbox to your $$mbox mailbox, or as a result of ** a ``$mbox-hook'' command. */ { "locale", DT_STR, R_BOTH, UL &Locale, UL "C" }, /* ** .pp - ** The locale used by \fIstrftime(3)\fP to format dates. Legal values are - ** the strings your system accepts for the locale variable \fILC_TIME\fP. + ** The locale used by \fCstrftime(3)\fP to format dates. Legal values are + ** the strings your system accepts for the locale environment variable \fC$$$LC_TIME\fP. */ { "mail_check", DT_NUM, R_NONE, UL &BuffyTimeout, 5 }, /* ** .pp ** This variable configures how often (in seconds) mutt should look for - ** new mail. Also see the ``$$timeout'' variable. + ** new mail. Also see the $$timeout variable. */ { "mailcap_path", DT_STR, R_NONE, UL &MailcapPath, 0 }, /* @@ -1116,7 +1343,7 @@ struct option_t MuttVars[] = { { "mailcap_sanitize", DT_BOOL, R_NONE, OPTMAILCAPSANITIZE, 1 }, /* ** .pp - ** If set, mutt will restrict possible characters in mailcap % expandos + ** If \fIset\fP, mutt will restrict possible characters in mailcap % expandos ** to a well-defined set of safe characters. This is the safe setting, ** but we are not sure it doesn't break some more advanced MIME stuff. ** .pp @@ -1124,49 +1351,20 @@ struct option_t MuttVars[] = { ** DOING!\fP */ #ifdef USE_HCACHE - { "header_cache", DT_PATH, R_NONE, UL &HeaderCache, 0 }, - /* - ** .pp - ** The header_cache variable points to the header cache database. - ** If header_cache points to a directory it will contain a header cache - ** database per folder. If header_cache points to a file that file will - ** be a single global header cache. By default it is unset so no header - ** caching will be used. - */ { "maildir_header_cache_verify", DT_BOOL, R_NONE, OPTHCACHEVERIFY, 1 }, /* ** .pp ** Check for Maildir unaware programs other than mutt having modified maildir - ** files when the header cache is in use. This incurs one stat(2) per - ** message every time the folder is opened. - */ -#if defined(HAVE_GDBM) || defined(HAVE_DB4) - { "header_cache_pagesize", DT_STR, R_NONE, UL &HeaderCachePageSize, UL "16384" }, - /* - ** .pp - ** When mutt is compiled with either gdbm or bdb4 as the header cache backend, - ** this option changes the database page size. Too large or too small - ** values can waste space, memory, or CPU time. The default should be more - ** or less optimal for most use cases. - */ -#endif /* HAVE_GDBM || HAVE_DB4 */ -#if defined(HAVE_QDBM) - { "header_cache_compress", DT_BOOL, R_NONE, OPTHCACHECOMPRESS, 1 }, - /* - ** .pp - ** When mutt is compiled with qdbm as header cache backend, - ** this option determines whether the database will be compressed. - ** Compression results in database files roughly being one fifth - ** of the usual diskspace, but the uncompression can result in a - ** slower opening of cached folder(s). + ** files when the header cache is in use. This incurs one \fCstat(2)\fP per + ** message every time the folder is opened (which can be very slow for NFS + ** folders). */ -#endif /* HAVE_QDBM */ -#endif /* USE_HCACHE */ +#endif { "maildir_trash", DT_BOOL, R_NONE, OPTMAILDIRTRASH, 0 }, /* ** .pp - ** If set, messages marked as deleted will be saved with the maildir - ** (T)rashed flag instead of unlinked. \fBNOTE:\fP this only applies + ** If \fIset\fP, messages marked as deleted will be saved with the maildir + ** trashed flag instead of unlinked. \fBNote:\fP this only applies ** to maildir-style mailboxes. Setting it will have no effect on other ** mailbox types. */ @@ -1175,16 +1373,17 @@ struct option_t MuttVars[] = { ** .pp ** Controls whether or not mutt marks \fInew\fP \fBunread\fP ** messages as \fIold\fP if you exit a mailbox without reading them. - ** With this option set, the next time you start mutt, the messages - ** will show up with an "O" next to them in the index menu, + ** With this option \fIset\fP, the next time you start mutt, the messages + ** will show up with an ``O'' next to them in the index menu, ** indicating that they are old. */ { "markers", DT_BOOL, R_PAGER, OPTMARKERS, 1 }, /* ** .pp ** Controls the display of wrapped lines in the internal pager. If set, a - ** ``+'' marker is displayed at the beginning of wrapped lines. Also see - ** the ``$$smart_wrap'' variable. + ** ``+'' marker is displayed at the beginning of wrapped lines. + ** .pp + ** Also see the $$smart_wrap variable. */ { "mask", DT_RX, R_NONE, UL &Mask, UL "!^\\.[^.]" }, /* @@ -1196,26 +1395,23 @@ struct option_t MuttVars[] = { { "mbox", DT_PATH, R_BOTH, UL &Inbox, UL "~/mbox" }, /* ** .pp - ** This specifies the folder into which read mail in your ``$$spoolfile'' + ** This specifies the folder into which read mail in your $$spoolfile ** folder will be appended. + ** .pp + ** Also see the $$move variable. */ { "mbox_type", DT_MAGIC,R_NONE, UL &DefaultMagic, M_MBOX }, /* ** .pp ** The default mailbox type used when creating new folders. May be any of - ** mbox, MMDF, MH and Maildir. - */ - { "metoo", DT_BOOL, R_NONE, OPTMETOO, 0 }, - /* - ** .pp - ** If unset, Mutt will remove your address (see the ``alternates'' - ** command) from the list of recipients when replying to a message. + ** ``mbox'', ``MMDF'', ``MH'' and ``Maildir''. This is overriden by the + ** \fC-m\fP command-line option. */ { "menu_context", DT_NUM, R_NONE, UL &MenuContext, 0 }, /* ** .pp ** This variable controls the number of lines of context that are given - ** when scrolling through menus. (Similar to ``$$pager_context''.) + ** when scrolling through menus. (Similar to $$pager_context.) */ { "menu_move_off", DT_BOOL, R_NONE, OPTMENUMOVEOFF, 1 }, /* @@ -1232,36 +1428,78 @@ struct option_t MuttVars[] = { ** is cleared and the next or previous page of the menu is displayed ** (useful for slow links to avoid many redraws). */ - { "meta_key", DT_BOOL, R_NONE, OPTMETAKEY, 0 }, +#if defined(USE_IMAP) || defined(USE_POP) + { "message_cache_clean", DT_BOOL, R_NONE, OPTMESSAGECACHECLEAN, 0 }, /* ** .pp - ** If set, forces Mutt to interpret keystrokes with the high bit (bit 8) - ** set as if the user had pressed the ESC key and whatever key remains - ** after having the high bit removed. For example, if the key pressed - ** has an ASCII value of 0xf8, then this is treated as if the user had - ** pressed ESC then ``x''. This is because the result of removing the - ** high bit from ``0xf8'' is ``0x78'', which is the ASCII character - ** ``x''. + ** If \fIset\fP, mutt will clean out obsolete entries from the message cache when + ** the mailbox is synchronized. You probably only want to set it + ** every once in a while, since it can be a little slow + ** (especially for large folders). */ - { "mh_purge", DT_BOOL, R_NONE, OPTMHPURGE, 0 }, + { "message_cachedir", DT_PATH, R_NONE, UL &MessageCachedir, 0 }, /* ** .pp - ** When unset, mutt will mimic mh's behaviour and rename deleted messages - ** to \fI,\fP in mh folders instead of really deleting - ** them. If the variable is set, the message files will simply be - ** deleted. + ** Set this to a directory and mutt will cache copies of messages from + ** your IMAP and POP servers here. You are free to remove entries at any + ** time. + ** .pp + ** When setting this variable to a directory, mutt needs to fetch every + ** remote message only once and can perform regular expression searches + ** as fast as for local folders. + ** .pp + ** Also see the $$message_cache_clean variable. */ - { "mh_seq_flagged", DT_STR, R_NONE, UL &MhFlagged, UL "flagged" }, +#endif + { "message_format", DT_STR, R_NONE, UL &MsgFmt, UL "%s" }, /* ** .pp - ** The name of the MH sequence used for flagged messages. + ** This is the string displayed in the ``attachment'' menu for + ** attachments of type \fCmessage/rfc822\fP. For a full listing of defined + ** \fCprintf(3)\fP-like sequences see the section on $$index_format. */ - { "mh_seq_replied", DT_STR, R_NONE, UL &MhReplied, UL "replied" }, + { "msg_format", DT_SYN, R_NONE, UL "message_format", 0 }, /* - ** .pp - ** The name of the MH sequence used to tag replied messages. */ - { "mh_seq_unseen", DT_STR, R_NONE, UL &MhUnseen, UL "unseen" }, + { "meta_key", DT_BOOL, R_NONE, OPTMETAKEY, 0 }, + /* + ** .pp + ** If \fIset\fP, forces Mutt to interpret keystrokes with the high bit (bit 8) + ** set as if the user had pressed the Esc key and whatever key remains + ** after having the high bit removed. For example, if the key pressed + ** has an ASCII value of \fC0xf8\fP, then this is treated as if the user had + ** pressed Esc then ``x''. This is because the result of removing the + ** high bit from \fC0xf8\fP is \fC0x78\fP, which is the ASCII character + ** ``x''. + */ + { "metoo", DT_BOOL, R_NONE, OPTMETOO, 0 }, + /* + ** .pp + ** If \fIunset\fP, Mutt will remove your address (see the ``$alternates'' + ** command) from the list of recipients when replying to a message. + */ + { "mh_purge", DT_BOOL, R_NONE, OPTMHPURGE, 0 }, + /* + ** .pp + ** When \fIunset\fP, mutt will mimic mh's behaviour and rename deleted messages + ** to \fI,\fP in mh folders instead of really deleting + ** them. This leaves the message on disk but makes programs reading the folder + ** ignore it. If the variable is \fIset\fP, the message files will simply be + ** deleted. + ** .pp + ** This option is similar to $$maildir_trash for Maildir folders. + */ + { "mh_seq_flagged", DT_STR, R_NONE, UL &MhFlagged, UL "flagged" }, + /* + ** .pp + ** The name of the MH sequence used for flagged messages. + */ + { "mh_seq_replied", DT_STR, R_NONE, UL &MhReplied, UL "replied" }, + /* + ** .pp + ** The name of the MH sequence used to tag replied messages. + */ + { "mh_seq_unseen", DT_STR, R_NONE, UL &MhUnseen, UL "unseen" }, /* ** .pp ** The name of the MH sequence used for unseen messages. @@ -1269,42 +1507,39 @@ struct option_t MuttVars[] = { { "mime_forward", DT_QUAD, R_NONE, OPT_MIMEFWD, M_NO }, /* ** .pp - ** When set, the message you are forwarding will be attached as a - ** separate MIME part instead of included in the main body of the + ** When \fIset\fP, the message you are forwarding will be attached as a + ** separate \fCmessage/rfc822\fP MIME part instead of included in the main body of the ** message. This is useful for forwarding MIME messages so the receiver ** can properly view the message as it was delivered to you. If you like ** to switch between MIME and not MIME from mail to mail, set this - ** variable to ask-no or ask-yes. + ** variable to ``ask-no'' or ``ask-yes''. ** .pp - ** Also see ``$$forward_decode'' and ``$$mime_forward_decode''. + ** Also see $$forward_decode and $$mime_forward_decode. */ { "mime_forward_decode", DT_BOOL, R_NONE, OPTMIMEFORWDECODE, 0 }, /* ** .pp - ** Controls the decoding of complex MIME messages into text/plain when - ** forwarding a message while ``$$mime_forward'' is \fIset\fP. Otherwise - ** ``$$forward_decode'' is used instead. + ** Controls the decoding of complex MIME messages into \fCtext/plain\fP when + ** forwarding a message while $$mime_forward is \fIset\fP. Otherwise + ** $$forward_decode is used instead. */ { "mime_fwd", DT_SYN, R_NONE, UL "mime_forward", 0 }, /* */ - { "mime_forward_rest", DT_QUAD, R_NONE, OPT_MIMEFWDREST, M_YES }, /* ** .pp - ** When forwarding multiple attachments of a MIME message from the recvattach + ** When forwarding multiple attachments of a MIME message from the attachment ** menu, attachments which cannot be decoded in a reasonable manner will - ** be attached to the newly composed message if this option is set. + ** be attached to the newly composed message if this option is \fIset\fP. */ - #ifdef MIXMASTER { "mix_entry_format", DT_STR, R_NONE, UL &MixEntryFormat, UL "%4n %c %-16s %a" }, /* ** .pp ** This variable describes the format of a remailer line on the mixmaster - ** chain selection screen. The following printf-like sequences are + ** chain selection screen. The following \fCprintf(3)\fP-like sequences are ** supported: - ** .pp ** .dl ** .dt %n .dd The running number on the menu. ** .dt %c .dd Remailer capabilities. @@ -1321,46 +1556,17 @@ struct option_t MuttVars[] = { ** mixmaster chain. */ #endif - - - { "move", DT_QUAD, R_NONE, OPT_MOVE, M_ASKNO }, + { "move", DT_QUAD, R_NONE, OPT_MOVE, M_NO }, /* ** .pp ** Controls whether or not Mutt will move read messages - ** from your spool mailbox to your ``$$mbox'' mailbox, or as a result of + ** from your spool mailbox to your $$mbox mailbox, or as a result of ** a ``$mbox-hook'' command. */ -#if defined(USE_IMAP) || defined(USE_POP) - { "message_cachedir", DT_PATH, R_NONE, UL &MessageCachedir, 0 }, - /* - ** .pp - ** Set this to a directory and mutt will cache copies of messages from - ** your IMAP and POP servers here. You are free to remove entries at any - ** time, for instance if stale entries accumulate because you have - ** deleted messages with another mail client. - */ - { "message_cache_clean", DT_BOOL, R_NONE, OPTMESSAGECACHECLEAN, 0 }, - /* - ** .pp - ** If set, mutt will clean out obsolete entries from the cache when - ** the mailbox is synchronized. You probably only want to set it - ** every once in a while, since it can be a little slow. - */ -#endif - { "message_format", DT_STR, R_NONE, UL &MsgFmt, UL "%s" }, - /* - ** .pp - ** This is the string displayed in the ``attachment'' menu for - ** attachments of type message/rfc822. For a full listing of defined - ** printf()-like sequences see the section on ``$$index_format''. - */ - { "msg_format", DT_SYN, R_NONE, UL "message_format", 0 }, - /* - */ { "narrow_tree", DT_BOOL, R_TREE|R_INDEX, OPTNARROWTREE, 0 }, /* ** .pp - ** This variable, when set, makes the thread tree narrower, allowing + ** This variable, when \fIset\fP, makes the thread tree narrower, allowing ** deeper threads to fit on the screen. */ #ifdef USE_SOCKET @@ -1368,17 +1574,17 @@ struct option_t MuttVars[] = { /* ** .pp ** Operations that expect to transfer a large amount of data over the - ** network will update their progress every \fInet_inc\fP kilobytes. + ** network will update their progress every $$net_inc kilobytes. ** If set to 0, no progress messages will be displayed. ** .pp - ** See also ``$$read_inc'' and ``$$write_inc''. + ** See also $$read_inc, $$write_inc and $$net_inc. */ -#endif +#endif { "pager", DT_PATH, R_NONE, UL &Pager, UL "builtin" }, /* ** .pp ** This variable specifies which pager you would like to use to view - ** messages. builtin means to use the builtin pager, otherwise this + ** messages. The value ``builtin'' means to use the builtin pager, otherwise this ** variable should specify the pathname of the external pager you would ** like to use. ** .pp @@ -1394,13 +1600,17 @@ struct option_t MuttVars[] = { ** when displaying the next or previous page in the internal pager. By ** default, Mutt will display the line after the last one on the screen ** at the top of the next page (0 lines of context). + ** .pp + ** This variable also specifies the amount of context given for search + ** results. If positive, this many lines will be given before a match, + ** if 0, the match will be top-aligned. */ { "pager_format", DT_STR, R_PAGER, UL &PagerFmt, UL "-%Z- %C/%m: %-20.20n %s%* -- (%P)" }, /* ** .pp ** This variable controls the format of the one-line message ``status'' ** displayed before each message in either the internal or an external - ** pager. The valid sequences are listed in the ``$$index_format'' + ** pager. The valid sequences are listed in the $$index_format ** section. */ { "pager_index_lines",DT_NUM, R_PAGER, UL &PagerIndexLines, 0 }, @@ -1412,140 +1622,124 @@ struct option_t MuttVars[] = { ** giving the reader the context of a few messages before and after the ** message. This is useful, for example, to determine how many messages ** remain to be read in the current thread. One of the lines is reserved - ** for the status bar from the index, so a \fIpager_index_lines\fP of 6 + ** for the status bar from the index, so a setting of 6 ** will only show 5 lines of the actual index. A value of 0 results in ** no index being shown. If the number of messages in the current folder - ** is less than \fIpager_index_lines\fP, then the index will only use as + ** is less than $$pager_index_lines, then the index will only use as ** many lines as it needs. */ { "pager_stop", DT_BOOL, R_NONE, OPTPAGERSTOP, 0 }, /* ** .pp - ** When set, the internal-pager will \fBnot\fP move to the next message - ** when you are at the end of a message and invoke the \fInext-page\fP + ** When \fIset\fP, the internal-pager will \fBnot\fP move to the next message + ** when you are at the end of a message and invoke the \fC\fP ** function. */ - { "pgp_autosign", DT_SYN, R_NONE, UL "crypt_autosign", 0 }, - { "crypt_autosign", DT_BOOL, R_NONE, OPTCRYPTAUTOSIGN, 0 }, + { "pgp_auto_decode", DT_BOOL, R_NONE, OPTPGPAUTODEC, 0 }, /* ** .pp - ** Setting this variable will cause Mutt to always attempt to - ** cryptographically sign outgoing messages. This can be overridden - ** by use of the \fIpgp-menu\fP, when signing is not required or - ** encryption is requested as well. If ``$$smime_is_default'' is set, - ** then OpenSSL is used instead to create S/MIME messages and settings can - ** be overridden by use of the \fIsmime-menu\fP. - ** (Crypto only) + ** If \fIset\fP, mutt will automatically attempt to decrypt traditional PGP + ** messages whenever the user performs an operation which ordinarily would + ** result in the contents of the message being operated on. For example, + ** if the user displays a pgp-traditional message which has not been manually + ** checked with the \fC$\fP function, mutt will automatically + ** check the message for traditional pgp. */ - { "pgp_autoencrypt", DT_SYN, R_NONE, UL "crypt_autoencrypt", 0 }, - { "crypt_autoencrypt", DT_BOOL, R_NONE, OPTCRYPTAUTOENCRYPT, 0 }, + { "pgp_create_traditional", DT_SYN, R_NONE, UL "pgp_autoinline", 0 }, + { "pgp_autoinline", DT_BOOL, R_NONE, OPTPGPAUTOINLINE, 0 }, /* ** .pp - ** Setting this variable will cause Mutt to always attempt to PGP - ** encrypt outgoing messages. This is probably only useful in - ** connection to the \fIsend-hook\fP command. It can be overridden - ** by use of the \fIpgp-menu\fP, when encryption is not required or - ** signing is requested as well. IF ``$$smime_is_default'' is set, - ** then OpenSSL is used instead to create S/MIME messages and - ** settings can be overridden by use of the \fIsmime-menu\fP. - ** (Crypto only) - */ - { "pgp_ignore_subkeys", DT_BOOL, R_NONE, OPTPGPIGNORESUB, 1}, - /* + ** This option controls whether Mutt generates old-style inline + ** (traditional) PGP encrypted or signed messages under certain + ** circumstances. This can be overridden by use of the pgp menu, + ** when inline is not required. ** .pp - ** Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead, - ** the principal key will inherit the subkeys' capabilities. Unset this - ** if you want to play interesting key selection games. + ** Note that Mutt might automatically use PGP/MIME for messages + ** which consist of more than a single MIME part. Mutt can be + ** configured to ask before sending PGP/MIME messages when inline + ** (traditional) would not work. + ** .pp + ** Also see the $$pgp_mime_auto variable. + ** .pp + ** Also note that using the old-style PGP message format is \fBstrongly\fP + ** \fBdeprecated\fP. ** (PGP only) */ - { "pgp_replyencrypt", DT_SYN, R_NONE, UL "crypt_replyencrypt", 1 }, - { "crypt_replyencrypt", DT_BOOL, R_NONE, OPTCRYPTREPLYENCRYPT, 1 }, + { "pgp_check_exit", DT_BOOL, R_NONE, OPTPGPCHECKEXIT, 1 }, /* ** .pp - ** If set, automatically PGP or OpenSSL encrypt replies to messages which are - ** encrypted. - ** (Crypto only) + ** If \fIset\fP, mutt will check the exit code of the PGP subprocess when + ** signing or encrypting. A non-zero exit code means that the + ** subprocess failed. + ** (PGP only) */ - { "pgp_replysign", DT_SYN, R_NONE, UL "crypt_replysign", 0 }, - { "crypt_replysign", DT_BOOL, R_NONE, OPTCRYPTREPLYSIGN, 0 }, + { "pgp_clearsign_command", DT_STR, R_NONE, UL &PgpClearSignCommand, 0 }, /* ** .pp - ** If set, automatically PGP or OpenSSL sign replies to messages which are - ** signed. + ** This format is used to create an old-style ``clearsigned'' PGP + ** message. Note that the use of this format is \fBstrongly\fP + ** \fBdeprecated\fP. ** .pp - ** \fBNote:\fP this does not work on messages that are encrypted - ** \fBand\fP signed! - ** (Crypto only) + ** This is a format string, see the $$pgp_decode_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (PGP only) */ - { "pgp_replysignencrypted", DT_SYN, R_NONE, UL "crypt_replysignencrypted", 0}, - { "crypt_replysignencrypted", DT_BOOL, R_NONE, OPTCRYPTREPLYSIGNENCRYPTED, 0 }, + { "pgp_decode_command", DT_STR, R_NONE, UL &PgpDecodeCommand, 0}, /* ** .pp - ** If set, automatically PGP or OpenSSL sign replies to messages - ** which are encrypted. This makes sense in combination with - ** ``$$crypt_replyencrypt'', because it allows you to sign all - ** messages which are automatically encrypted. This works around - ** the problem noted in ``$$crypt_replysign'', that mutt is not able - ** to find out whether an encrypted message is also signed. - ** (Crypto only) - */ - { "crypt_timestamp", DT_BOOL, R_NONE, OPTCRYPTTIMESTAMP, 1 }, - /* + ** This format strings specifies a command which is used to decode + ** application/pgp attachments. ** .pp - ** If set, mutt will include a time stamp in the lines surrounding - ** PGP or S/MIME output, so spoofing such lines is more difficult. - ** If you are using colors to mark these lines, and rely on these, - ** you may unset this setting. - ** (Crypto only) - */ - { "pgp_use_gpg_agent", DT_BOOL, R_NONE, OPTUSEGPGAGENT, 0}, - /* + ** The PGP command formats have their own set of \fCprintf(3)\fP-like sequences: + ** .dl + ** .dt %p .dd Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty + ** string otherwise. Note: This may be used with a %? construct. + ** .dt %f .dd Expands to the name of a file containing a message. + ** .dt %s .dd Expands to the name of a file containing the signature part + ** . of a \fCmultipart/signed\fP attachment when verifying it. + ** .dt %a .dd The value of $$pgp_sign_as. + ** .dt %r .dd One or more key IDs. + ** .de ** .pp - ** If set, mutt will use a possibly-running gpg-agent process. + ** For examples on how to configure these formats for the various versions + ** of PGP which are floating around, see the pgp and gpg sample configuration files in + ** the \fCsamples/\fP subdirectory which has been installed on your system + ** alongside the documentation. ** (PGP only) */ - { "pgp_verify_sig", DT_SYN, R_NONE, UL "crypt_verify_sig", 0}, - { "crypt_verify_sig", DT_QUAD, R_NONE, OPT_VERIFYSIG, M_YES }, + { "pgp_decrypt_command", DT_STR, R_NONE, UL &PgpDecryptCommand, 0}, /* ** .pp - ** If ``yes'', always attempt to verify PGP or S/MIME signatures. - ** If ``ask'', ask whether or not to verify the signature. - ** If ``no'', never attempt to verify cryptographic signatures. - ** (Crypto only) - */ - { "smime_is_default", DT_BOOL, R_NONE, OPTSMIMEISDEFAULT, 0}, - /* + ** This command is used to decrypt a PGP encrypted message. ** .pp - ** The default behaviour of mutt is to use PGP on all auto-sign/encryption - ** operations. To override and to use OpenSSL instead this must be set. - ** However, this has no effect while replying, since mutt will automatically - ** select the same application that was used to sign/encrypt the original - ** message. (Note that this variable can be overridden by unsetting $$crypt_autosmime.) - ** (S/MIME only) + ** This is a format string, see the $$pgp_decode_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (PGP only) */ - { "smime_ask_cert_label", DT_BOOL, R_NONE, OPTASKCERTLABEL, 1 }, + { "pgp_encrypt_only_command", DT_STR, R_NONE, UL &PgpEncryptOnlyCommand, 0}, /* ** .pp - ** This flag controls whether you want to be asked to enter a label - ** for a certificate about to be added to the database or not. It is - ** set by default. - ** (S/MIME only) + ** This command is used to encrypt a body part without signing it. + ** .pp + ** This is a format string, see the $$pgp_decode_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (PGP only) */ - { "smime_decrypt_use_default_key", DT_BOOL, R_NONE, OPTSDEFAULTDECRYPTKEY, 1 }, + { "pgp_encrypt_sign_command", DT_STR, R_NONE, UL &PgpEncryptSignCommand, 0}, /* ** .pp - ** If set (default) this tells mutt to use the default key for decryption. Otherwise, - ** if manage multiple certificate-key-pairs, mutt will try to use the mailbox-address - ** to determine the key to use. It will ask you to supply a key, if it can't find one. - ** (S/MIME only) + ** This command is used to both sign and encrypt a body part. + ** .pp + ** This is a format string, see the $$pgp_decode_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (PGP only) */ { "pgp_entry_format", DT_STR, R_NONE, UL &PgpEntryFormat, UL "%4n %t%f %4l/0x%k %-4a %2c %u" }, /* ** .pp ** This variable allows you to customize the PGP key selection menu to - ** your personal taste. This string is similar to ``$$index_format'', but - ** has its own set of printf()-like sequences: - ** .pp + ** your personal taste. This string is similar to $$index_format, but + ** has its own set of \fCprintf(3)\fP-like sequences: ** .dl ** .dt %n .dd number ** .dt %k .dd key id @@ -1555,11 +1749,29 @@ struct option_t MuttVars[] = { ** .dt %f .dd flags ** .dt %c .dd capabilities ** .dt %t .dd trust/validity of the key-uid association - ** .dt %[] .dd date of the key where is an strftime(3) expression + ** .dt %[] .dd date of the key where is an \fCstrftime(3)\fP expression ** .de ** .pp ** (PGP only) */ + { "pgp_export_command", DT_STR, R_NONE, UL &PgpExportCommand, 0}, + /* + ** .pp + ** This command is used to export a public key from the user's + ** key ring. + ** .pp + ** This is a format string, see the $$pgp_decode_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (PGP only) + */ + { "pgp_getkeys_command", DT_STR, R_NONE, UL &PgpGetkeysCommand, 0}, + /* + ** .pp + ** This command is invoked whenever mutt will need public key information. + ** Of the sequences supported by $$pgp_decode_command, %r is the only + ** \fCprintf(3)\fP-like sequence used with this format. + ** (PGP only) + */ { "pgp_good_sign", DT_RX, R_NONE, UL &PgpGoodSign, 0 }, /* ** .pp @@ -1568,46 +1780,69 @@ struct option_t MuttVars[] = { ** the text. Use this variable if the exit code from the command is 0 ** even for bad signatures. ** (PGP only) - */ - { "pgp_check_exit", DT_BOOL, R_NONE, OPTPGPCHECKEXIT, 1 }, + */ + { "pgp_ignore_subkeys", DT_BOOL, R_NONE, OPTPGPIGNORESUB, 1}, /* ** .pp - ** If set, mutt will check the exit code of the PGP subprocess when - ** signing or encrypting. A non-zero exit code means that the - ** subprocess failed. + ** Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead, + ** the principal key will inherit the subkeys' capabilities. \fIUnset\fP this + ** if you want to play interesting key selection games. ** (PGP only) */ - { "pgp_long_ids", DT_BOOL, R_NONE, OPTPGPLONGIDS, 0 }, + { "pgp_import_command", DT_STR, R_NONE, UL &PgpImportCommand, 0}, /* ** .pp - ** If set, use 64 bit PGP key IDs. Unset uses the normal 32 bit Key IDs. + ** This command is used to import a key from a message into + ** the user's public key ring. + ** .pp + ** This is a format string, see the $$pgp_decode_command command for + ** possible \fCprintf(3)\fP-like sequences. ** (PGP only) */ - { "pgp_retainable_sigs", DT_BOOL, R_NONE, OPTPGPRETAINABLESIG, 0 }, + { "pgp_list_pubring_command", DT_STR, R_NONE, UL &PgpListPubringCommand, 0}, + /* + ** .pp + ** This command is used to list the public key ring's contents. The + ** output format must be analogous to the one used by + ** .ts + ** gpg --list-keys --with-colons. + ** .te + ** .pp + ** This format is also generated by the \fCpgpring\fP utility which comes + ** with mutt. + ** .pp + ** This is a format string, see the $$pgp_decode_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (PGP only) + */ + { "pgp_list_secring_command", DT_STR, R_NONE, UL &PgpListSecringCommand, 0}, /* ** .pp - ** If set, signed and encrypted messages will consist of nested - ** multipart/signed and multipart/encrypted body parts. + ** This command is used to list the secret key ring's contents. The + ** output format must be analogous to the one used by: + ** .ts + ** gpg --list-keys --with-colons. + ** .te ** .pp - ** This is useful for applications like encrypted and signed mailing - ** lists, where the outer layer (multipart/encrypted) can be easily - ** removed, while the inner multipart/signed part is retained. + ** This format is also generated by the \fCpgpring\fP utility which comes + ** with mutt. + ** .pp + ** This is a format string, see the $$pgp_decode_command command for + ** possible \fCprintf(3)\fP-like sequences. ** (PGP only) */ - { "pgp_create_traditional", DT_SYN, R_NONE, UL "pgp_autoinline", 0 }, - { "pgp_autoinline", DT_BOOL, R_NONE, OPTPGPAUTOINLINE, 0 }, + { "pgp_long_ids", DT_BOOL, R_NONE, OPTPGPLONGIDS, 0 }, /* ** .pp - ** This option controls whether Mutt generates old-style inline - ** (traditional) PGP encrypted or signed messages under certain - ** circumstances. This can be overridden by use of the \fIpgp-menu\fP, - ** when inline is not required. + ** If \fIset\fP, use 64 bit PGP key IDs, if \fIunset\fP use the normal 32 bit key IDs. + ** (PGP only) + */ + { "pgp_mime_auto", DT_QUAD, R_NONE, OPT_PGPMIMEAUTO, M_ASKYES }, + /* ** .pp - ** Note that Mutt might automatically use PGP/MIME for messages - ** which consist of more than a single MIME part. Mutt can be - ** configured to ask before sending PGP/MIME messages when inline - ** (traditional) would not work. - ** See also: ``$$pgp_mime_auto''. + ** This option controls whether Mutt will prompt you for + ** automatically sending a (signed/encrypted) message using + ** PGP/MIME when inline (traditional) fails (for any reason). ** .pp ** Also note that using the old-style PGP message format is \fBstrongly\fP ** \fBdeprecated\fP. @@ -1620,7 +1855,7 @@ struct option_t MuttVars[] = { ** Setting this variable will cause Mutt to always attempt to ** create an inline (traditional) message when replying to a ** message which is PGP encrypted/signed inline. This can be - ** overridden by use of the \fIpgp-menu\fP, when inline is not + ** overridden by use of the pgp menu, when inline is not ** required. This option does not automatically detect if the ** (replied-to) message is inline; instead it relies on Mutt ** internals for previously checked/flagged messages. @@ -1629,17 +1864,29 @@ struct option_t MuttVars[] = { ** which consist of more than a single MIME part. Mutt can be ** configured to ask before sending PGP/MIME messages when inline ** (traditional) would not work. - ** See also: ``$$pgp_mime_auto''. + ** .pp + ** Also see the $$pgp_mime_auto variable. ** .pp ** Also note that using the old-style PGP message format is \fBstrongly\fP ** \fBdeprecated\fP. ** (PGP only) - ** + ** + */ + { "pgp_retainable_sigs", DT_BOOL, R_NONE, OPTPGPRETAINABLESIG, 0 }, + /* + ** .pp + ** If \fIset\fP, signed and encrypted messages will consist of nested + ** \fCmultipart/signed\fP and \fCmultipart/encrypted\fP body parts. + ** .pp + ** This is useful for applications like encrypted and signed mailing + ** lists, where the outer layer (\fCmultipart/encrypted\fP) can be easily + ** removed, while the inner \fCmultipart/signed\fP part is retained. + ** (PGP only) */ { "pgp_show_unusable", DT_BOOL, R_NONE, OPTPGPSHOWUNUSABLE, 1 }, /* ** .pp - ** If set, mutt will display non-usable keys on the PGP key selection + ** If \fIset\fP, mutt will display non-usable keys on the PGP key selection ** menu. This includes keys which have been revoked, have expired, or ** have been marked as ``disabled'' by the user. ** (PGP only) @@ -1649,451 +1896,82 @@ struct option_t MuttVars[] = { ** .pp ** If you have more than one key pair, this option allows you to specify ** which of your private keys to use. It is recommended that you use the - ** keyid form to specify your key (e.g., ``0x00112233''). + ** keyid form to specify your key (e.g. \fC0x00112233\fP). ** (PGP only) */ - { "pgp_strict_enc", DT_BOOL, R_NONE, OPTPGPSTRICTENC, 1 }, + { "pgp_sign_command", DT_STR, R_NONE, UL &PgpSignCommand, 0}, /* ** .pp - ** If set, Mutt will automatically encode PGP/MIME signed messages as - ** \fIquoted-printable\fP. Please note that unsetting this variable may - ** lead to problems with non-verifyable PGP signatures, so only change - ** this if you know what you are doing. - ** (PGP only) - */ - { "pgp_timeout", DT_NUM, R_NONE, UL &PgpTimeout, 300 }, - /* + ** This command is used to create the detached PGP signature for a + ** \fCmultipart/signed\fP PGP/MIME body part. ** .pp - ** The number of seconds after which a cached passphrase will expire if - ** not used. + ** This is a format string, see the $$pgp_decode_command command for + ** possible \fCprintf(3)\fP-like sequences. ** (PGP only) */ { "pgp_sort_keys", DT_SORT|DT_SORT_KEYS, R_NONE, UL &PgpSortKeys, SORT_ADDRESS }, /* ** .pp - ** Specifies how the entries in the `pgp keys' menu are sorted. The + ** Specifies how the entries in the pgp menu are sorted. The ** following are legal values: - ** .pp ** .dl ** .dt address .dd sort alphabetically by user id ** .dt keyid .dd sort alphabetically by key id ** .dt date .dd sort by key creation date ** .dt trust .dd sort by the trust of the key - ** .de - ** .pp - ** If you prefer reverse order of the above values, prefix it with - ** `reverse-'. - ** (PGP only) - */ - { "pgp_mime_auto", DT_QUAD, R_NONE, OPT_PGPMIMEAUTO, M_ASKYES }, - /* - ** .pp - ** This option controls whether Mutt will prompt you for - ** automatically sending a (signed/encrypted) message using - ** PGP/MIME when inline (traditional) fails (for any reason). - ** .pp - ** Also note that using the old-style PGP message format is \fBstrongly\fP - ** \fBdeprecated\fP. - ** (PGP only) - */ - { "pgp_auto_decode", DT_BOOL, R_NONE, OPTPGPAUTODEC, 0 }, - /* - ** .pp - ** If set, mutt will automatically attempt to decrypt traditional PGP - ** messages whenever the user performs an operation which ordinarily would - ** result in the contents of the message being operated on. For example, - ** if the user displays a pgp-traditional message which has not been manually - ** checked with the check-traditional-pgp function, mutt will automatically - ** check the message for traditional pgp. - */ - - - /* XXX Default values! */ - - { "pgp_decode_command", DT_STR, R_NONE, UL &PgpDecodeCommand, 0}, - /* - ** .pp - ** This format strings specifies a command which is used to decode - ** application/pgp attachments. - ** .pp - ** The PGP command formats have their own set of printf-like sequences: - ** .pp - ** .dl - ** .dt %p .dd Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty - ** string otherwise. Note: This may be used with a %? construct. - ** .dt %f .dd Expands to the name of a file containing a message. - ** .dt %s .dd Expands to the name of a file containing the signature part - ** . of a multipart/signed attachment when verifying it. - ** .dt %a .dd The value of $$pgp_sign_as. - ** .dt %r .dd One or more key IDs. - ** .de - ** .pp - ** For examples on how to configure these formats for the various versions - ** of PGP which are floating around, see the pgp*.rc and gpg.rc files in - ** the samples/ subdirectory which has been installed on your system - ** alongside the documentation. - ** (PGP only) - */ - { "pgp_getkeys_command", DT_STR, R_NONE, UL &PgpGetkeysCommand, 0}, - /* - ** .pp - ** This command is invoked whenever mutt will need public key information. - ** %r is the only printf-like sequence used with this format. - ** (PGP only) - */ - { "pgp_verify_command", DT_STR, R_NONE, UL &PgpVerifyCommand, 0}, - /* - ** .pp - ** This command is used to verify PGP signatures. - ** (PGP only) - */ - { "pgp_decrypt_command", DT_STR, R_NONE, UL &PgpDecryptCommand, 0}, - /* - ** .pp - ** This command is used to decrypt a PGP encrypted message. - ** (PGP only) - */ - { "pgp_clearsign_command", DT_STR, R_NONE, UL &PgpClearSignCommand, 0 }, - /* - ** .pp - ** This format is used to create a old-style "clearsigned" PGP - ** message. Note that the use of this format is \fBstrongly\fP - ** \fBdeprecated\fP. - ** (PGP only) - */ - { "pgp_sign_command", DT_STR, R_NONE, UL &PgpSignCommand, 0}, - /* - ** .pp - ** This command is used to create the detached PGP signature for a - ** multipart/signed PGP/MIME body part. - ** (PGP only) - */ - { "pgp_encrypt_sign_command", DT_STR, R_NONE, UL &PgpEncryptSignCommand, 0}, - /* - ** .pp - ** This command is used to both sign and encrypt a body part. - ** (PGP only) - */ - { "pgp_encrypt_only_command", DT_STR, R_NONE, UL &PgpEncryptOnlyCommand, 0}, - /* - ** .pp - ** This command is used to encrypt a body part without signing it. - ** (PGP only) - */ - { "pgp_import_command", DT_STR, R_NONE, UL &PgpImportCommand, 0}, - /* - ** .pp - ** This command is used to import a key from a message into - ** the user's public key ring. - ** (PGP only) - */ - { "pgp_export_command", DT_STR, R_NONE, UL &PgpExportCommand, 0}, - /* - ** .pp - ** This command is used to export a public key from the user's - ** key ring. - ** (PGP only) - */ - { "pgp_verify_key_command", DT_STR, R_NONE, UL &PgpVerifyKeyCommand, 0}, - /* - ** .pp - ** This command is used to verify key information from the key selection - ** menu. - ** (PGP only) - */ - { "pgp_list_secring_command", DT_STR, R_NONE, UL &PgpListSecringCommand, 0}, - /* - ** .pp - ** This command is used to list the secret key ring's contents. The - ** output format must be analogous to the one used by - ** gpg --list-keys --with-colons. - ** .pp - ** This format is also generated by the pgpring utility which comes - ** with mutt. - ** (PGP only) - */ - { "pgp_list_pubring_command", DT_STR, R_NONE, UL &PgpListPubringCommand, 0}, - /* - ** .pp - ** This command is used to list the public key ring's contents. The - ** output format must be analogous to the one used by - ** gpg --list-keys --with-colons. - ** .pp - ** This format is also generated by the pgpring utility which comes - ** with mutt. - ** (PGP only) - */ - { "forward_decrypt", DT_BOOL, R_NONE, OPTFORWDECRYPT, 1 }, - /* - ** .pp - ** Controls the handling of encrypted messages when forwarding a message. - ** When set, the outer layer of encryption is stripped off. This - ** variable is only used if ``$$mime_forward'' is \fIset\fP and - ** ``$$mime_forward_decode'' is \fIunset\fP. - ** (PGP only) - */ - { "forw_decrypt", DT_SYN, R_NONE, UL "forward_decrypt", 0 }, - /* - */ - - { "smime_timeout", DT_NUM, R_NONE, UL &SmimeTimeout, 300 }, - /* - ** .pp - ** The number of seconds after which a cached passphrase will expire if - ** not used. - ** (S/MIME only) - */ - { "smime_encrypt_with", DT_STR, R_NONE, UL &SmimeCryptAlg, 0 }, - /* - ** .pp - ** This sets the algorithm that should be used for encryption. - ** Valid choices are "des", "des3", "rc2-40", "rc2-64", "rc2-128". - ** If unset "3des" (TripleDES) is used. - ** (S/MIME only) - */ - { "smime_keys", DT_PATH, R_NONE, UL &SmimeKeys, 0 }, - /* - ** .pp - ** Since there is no pubring/secring as with PGP, mutt has to handle - ** storage ad retrieval of keys/certs by itself. This is very basic right now, - ** and stores keys and certificates in two different directories, both - ** named as the hash-value retrieved from OpenSSL. There is an index file - ** which contains mailbox-address keyid pair, and which can be manually - ** edited. This one points to the location of the private keys. - ** (S/MIME only) - */ - { "smime_ca_location", DT_PATH, R_NONE, UL &SmimeCALocation, 0 }, - /* - ** .pp - ** This variable contains the name of either a directory, or a file which - ** contains trusted certificates for use with OpenSSL. - ** (S/MIME only) - */ - { "smime_certificates", DT_PATH, R_NONE, UL &SmimeCertificates, 0 }, - /* - ** .pp - ** Since there is no pubring/secring as with PGP, mutt has to handle - ** storage and retrieval of keys by itself. This is very basic right - ** now, and keys and certificates are stored in two different - ** directories, both named as the hash-value retrieved from - ** OpenSSL. There is an index file which contains mailbox-address - ** keyid pairs, and which can be manually edited. This one points to - ** the location of the certificates. - ** (S/MIME only) - */ - { "smime_decrypt_command", DT_STR, R_NONE, UL &SmimeDecryptCommand, 0}, - /* - ** .pp - ** This format string specifies a command which is used to decrypt - ** application/x-pkcs7-mime attachments. - ** .pp - ** The OpenSSL command formats have their own set of printf-like sequences - ** similar to PGP's: - ** .pp - ** .dl - ** .dt %f .dd Expands to the name of a file containing a message. - ** .dt %s .dd Expands to the name of a file containing the signature part - ** . of a multipart/signed attachment when verifying it. - ** .dt %k .dd The key-pair specified with $$smime_default_key - ** .dt %c .dd One or more certificate IDs. - ** .dt %a .dd The algorithm used for encryption. - ** .dt %C .dd CA location: Depending on whether $$smime_ca_location - ** . points to a directory or file, this expands to - ** . "-CApath $$smime_ca_location" or "-CAfile $$smime_ca_location". - ** .de - ** .pp - ** For examples on how to configure these formats, see the smime.rc in - ** the samples/ subdirectory which has been installed on your system - ** alongside the documentation. - ** (S/MIME only) - */ - { "smime_verify_command", DT_STR, R_NONE, UL &SmimeVerifyCommand, 0}, - /* - ** .pp - ** This command is used to verify S/MIME signatures of type multipart/signed. - ** (S/MIME only) - */ - { "smime_verify_opaque_command", DT_STR, R_NONE, UL &SmimeVerifyOpaqueCommand, 0}, - /* - ** .pp - ** This command is used to verify S/MIME signatures of type - ** application/x-pkcs7-mime. - ** (S/MIME only) - */ - { "smime_sign_command", DT_STR, R_NONE, UL &SmimeSignCommand, 0}, - /* - ** .pp - ** This command is used to created S/MIME signatures of type - ** multipart/signed, which can be read by all mail clients. - ** (S/MIME only) - */ - { "smime_sign_opaque_command", DT_STR, R_NONE, UL &SmimeSignOpaqueCommand, 0}, - /* - ** .pp - ** This command is used to created S/MIME signatures of type - ** application/x-pkcs7-signature, which can only be handled by mail - ** clients supporting the S/MIME extension. - ** (S/MIME only) - */ - { "smime_encrypt_command", DT_STR, R_NONE, UL &SmimeEncryptCommand, 0}, - /* - ** .pp - ** This command is used to create encrypted S/MIME messages. - ** (S/MIME only) - */ - { "smime_pk7out_command", DT_STR, R_NONE, UL &SmimePk7outCommand, 0}, - /* - ** .pp - ** This command is used to extract PKCS7 structures of S/MIME signatures, - ** in order to extract the public X509 certificate(s). - ** (S/MIME only) - */ - { "smime_get_cert_command", DT_STR, R_NONE, UL &SmimeGetCertCommand, 0}, - /* - ** .pp - ** This command is used to extract X509 certificates from a PKCS7 structure. - ** (S/MIME only) - */ - { "smime_get_signer_cert_command", DT_STR, R_NONE, UL &SmimeGetSignerCertCommand, 0}, - /* - ** .pp - ** This command is used to extract only the signers X509 certificate from a S/MIME - ** signature, so that the certificate's owner may get compared to the - ** email's 'From'-field. - ** (S/MIME only) - */ - { "smime_import_cert_command", DT_STR, R_NONE, UL &SmimeImportCertCommand, 0}, - /* - ** .pp - ** This command is used to import a certificate via smime_keys. - ** (S/MIME only) - */ - { "smime_get_cert_email_command", DT_STR, R_NONE, UL &SmimeGetCertEmailCommand, 0}, - /* - ** .pp - ** This command is used to extract the mail address(es) used for storing - ** X509 certificates, and for verification purposes (to check whether the - ** certificate was issued for the sender's mailbox). - ** (S/MIME only) - */ - { "smime_sign_as", DT_SYN, R_NONE, UL "smime_default_key", 0 }, - { "smime_default_key", DT_STR, R_NONE, UL &SmimeDefaultKey, 0 }, - /* - ** .pp - ** This is the default key-pair to use for signing. This must be set to the - ** keyid (the hash-value that OpenSSL generates) to work properly - ** (S/MIME only) - */ - -#if defined(USE_SSL) -#ifdef USE_SSL_OPENSSL - { "ssl_client_cert", DT_PATH, R_NONE, UL &SslClientCert, 0 }, - /* - ** .pp - ** The file containing a client certificate and its associated private - ** key. - */ -#endif /* USE_SSL_OPENSSL */ - { "ssl_force_tls", DT_BOOL, R_NONE, OPTSSLFORCETLS, 0 }, - /* - ** .pp - ** If this variable is set, Mutt will require that all connections - ** to remote servers be encrypted. Furthermore it will attempt to - ** negotiate TLS even if the server does not advertise the capability, - ** since it would otherwise have to abort the connection anyway. This - ** option supersedes ``$$ssl_starttls''. - */ - { "ssl_starttls", DT_QUAD, R_NONE, OPT_SSLSTARTTLS, M_YES }, - /* - ** .pp - ** If set (the default), mutt will attempt to use STARTTLS on servers - ** advertising the capability. When unset, mutt will not attempt to - ** use STARTTLS regardless of the server's capabilities. - */ - { "certificate_file", DT_PATH, R_NONE, UL &SslCertFile, UL "~/.mutt_certificates" }, - /* - ** .pp - ** This variable specifies the file where the certificates you trust - ** are saved. When an unknown certificate is encountered, you are asked - ** if you accept it or not. If you accept it, the certificate can also - ** be saved in this file and further connections are automatically - ** accepted. - ** .pp - ** You can also manually add CA certificates in this file. Any server - ** certificate that is signed with one of these CA certificates are - ** also automatically accepted. - ** .pp - ** Example: set certificate_file=~/.mutt/certificates - */ -# ifdef USE_SSL_OPENSSL - { "ssl_usesystemcerts", DT_BOOL, R_NONE, OPTSSLSYSTEMCERTS, 1 }, - /* - ** .pp - ** If set to \fIyes\fP, mutt will use CA certificates in the - ** system-wide certificate store when checking if server certificate - ** is signed by a trusted CA. - */ - { "entropy_file", DT_PATH, R_NONE, UL &SslEntropyFile, 0 }, - /* - ** .pp - ** The file which includes random data that is used to initialize SSL - ** library functions. - */ - { "ssl_use_sslv2", DT_BOOL, R_NONE, OPTSSLV2, 1 }, - /* + ** .de ** .pp - ** This variables specifies whether to attempt to use SSLv2 in the - ** SSL authentication process. + ** If you prefer reverse order of the above values, prefix it with + ** ``reverse-''. + ** (PGP only) */ -# endif /* defined USE_SSL_OPENSSL */ - { "ssl_use_sslv3", DT_BOOL, R_NONE, OPTSSLV3, 1 }, + { "pgp_strict_enc", DT_BOOL, R_NONE, OPTPGPSTRICTENC, 1 }, /* ** .pp - ** This variables specifies whether to attempt to use SSLv3 in the - ** SSL authentication process. + ** If \fIset\fP, Mutt will automatically encode PGP/MIME signed messages as + ** quoted-printable. Please note that unsetting this variable may + ** lead to problems with non-verifyable PGP signatures, so only change + ** this if you know what you are doing. + ** (PGP only) */ - { "ssl_use_tlsv1", DT_BOOL, R_NONE, OPTTLSV1, 1 }, + { "pgp_timeout", DT_NUM, R_NONE, UL &PgpTimeout, 300 }, /* ** .pp - ** This variables specifies whether to attempt to use TLSv1 in the - ** SSL authentication process. + ** The number of seconds after which a cached passphrase will expire if + ** not used. + ** (PGP only) */ -# ifdef USE_SSL_GNUTLS - { "ssl_min_dh_prime_bits", DT_NUM, R_NONE, UL &SslDHPrimeBits, 0 }, + { "pgp_use_gpg_agent", DT_BOOL, R_NONE, OPTUSEGPGAGENT, 0}, /* ** .pp - ** This variable specifies the minimum acceptable prime size (in bits) - ** for use in any Diffie-Hellman key exchange. A value of 0 will use - ** the default from the GNUTLS library. + ** If \fIset\fP, mutt will use a possibly-running \fCgpg-agent(1)\fP process. + ** (PGP only) */ - { "ssl_ca_certificates_file", DT_PATH, R_NONE, UL &SslCACertFile, 0 }, + { "pgp_verify_command", DT_STR, R_NONE, UL &PgpVerifyCommand, 0}, /* ** .pp - ** This variable specifies a file containing trusted CA certificates. - ** Any server certificate that is signed with one of these CA - ** certificates are also automatically accepted. + ** This command is used to verify PGP signatures. ** .pp - ** Example: set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt + ** This is a format string, see the $$pgp_decode_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (PGP only) */ -# endif /* USE_SSL_GNUTLS */ -#endif /* defined(USE_SSL) */ - - { "pipe_split", DT_BOOL, R_NONE, OPTPIPESPLIT, 0 }, + { "pgp_verify_key_command", DT_STR, R_NONE, UL &PgpVerifyKeyCommand, 0}, /* ** .pp - ** Used in connection with the \fIpipe-message\fP command and the ``tag- - ** prefix'' operator. If this variable is unset, when piping a list of - ** tagged messages Mutt will concatenate the messages and will pipe them - ** as a single folder. When set, Mutt will pipe the messages one by one. - ** In both cases the messages are piped in the current sorted order, - ** and the ``$$pipe_sep'' separator is added after each message. + ** This command is used to verify key information from the key selection + ** menu. + ** .pp + ** This is a format string, see the $$pgp_decode_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (PGP only) */ { "pipe_decode", DT_BOOL, R_NONE, OPTPIPEDECODE, 0 }, /* ** .pp - ** Used in connection with the \fIpipe-message\fP command. When unset, - ** Mutt will pipe the messages without any preprocessing. When set, Mutt - ** will weed headers and will attempt to PGP/MIME decode the messages + ** Used in connection with the \fC\fP command. When \fIunset\fP, + ** Mutt will pipe the messages without any preprocessing. When \fIset\fP, Mutt + ** will weed headers and will attempt to decode the messages ** first. */ { "pipe_sep", DT_STR, R_NONE, UL &PipeSep, UL "\n" }, @@ -2102,27 +1980,40 @@ struct option_t MuttVars[] = { ** The separator to add between messages when piping a list of tagged ** messages to an external Unix command. */ + { "pipe_split", DT_BOOL, R_NONE, OPTPIPESPLIT, 0 }, + /* + ** .pp + ** Used in connection with the \fC\fP function following + ** \fC\fP. If this variable is \fIunset\fP, when piping a list of + ** tagged messages Mutt will concatenate the messages and will pipe them + ** all concatenated. When \fIset\fP, Mutt will pipe the messages one by one. + ** In both cases the messages are piped in the current sorted order, + ** and the $$pipe_sep separator is added after each message. + */ #ifdef USE_POP + { "pop_auth_try_all", DT_BOOL, R_NONE, OPTPOPAUTHTRYALL, 1 }, + /* + ** .pp + ** If \fIset\fP, Mutt will try all available authentication methods. + ** When \fIunset\fP, Mutt will only fall back to other authentication + ** methods if the previous methods are unavailable. If a method is + ** available but authentication fails, Mutt will not connect to the POP server. + */ { "pop_authenticators", DT_STR, R_NONE, UL &PopAuthenticators, UL 0 }, /* ** .pp ** This is a colon-delimited list of authentication methods mutt may ** attempt to use to log in to an POP server, in the order mutt should - ** try them. Authentication methods are either 'user', 'apop' or any - ** SASL mechanism, eg 'digest-md5', 'gssapi' or 'cram-md5'. - ** This parameter is case-insensitive. If this parameter is unset + ** try them. Authentication methods are either ``user'', ``apop'' or any + ** SASL mechanism, eg ``digest-md5'', ``gssapi'' or ``cram-md5''. + ** This option is case-insensitive. If this option is \fIunset\fP ** (the default) mutt will try all available methods, in order from ** most-secure to least-secure. ** .pp - ** Example: set pop_authenticators="digest-md5:apop:user" - */ - { "pop_auth_try_all", DT_BOOL, R_NONE, OPTPOPAUTHTRYALL, 1 }, - /* - ** .pp - ** If set, Mutt will try all available methods. When unset, Mutt will - ** only fall back to other authentication methods if the previous - ** methods are unavailable. If a method is available but authentication - ** fails, Mutt will not connect to the POP server. + ** Example: + ** .ts + ** set pop_authenticators="digest-md5:apop:user" + ** .te */ { "pop_checkinterval", DT_NUM, R_NONE, UL &PopCheckTimeout, 60 }, /* @@ -2133,29 +2024,42 @@ struct option_t MuttVars[] = { { "pop_delete", DT_QUAD, R_NONE, OPT_POPDELETE, M_ASKNO }, /* ** .pp - ** If set, Mutt will delete successfully downloaded messages from the POP - ** server when using the fetch-mail function. When unset, Mutt will + ** If \fIset\fP, Mutt will delete successfully downloaded messages from the POP + ** server when using the \fC$\fP function. When \fIunset\fP, Mutt will ** download messages but also leave them on the POP server. */ { "pop_host", DT_STR, R_NONE, UL &PopHost, UL "" }, /* ** .pp - ** The name of your POP server for the fetch-mail function. You + ** The name of your POP server for the \fC$\fP function. You ** can also specify an alternative port, username and password, ie: - ** .pp + ** .ts ** [pop[s]://][username[:password]@]popserver[:port] + ** .te + ** .pp + ** where ``[...]'' denotes an optional part. */ { "pop_last", DT_BOOL, R_NONE, OPTPOPLAST, 0 }, /* ** .pp - ** If this variable is set, mutt will try to use the "LAST" POP command + ** If this variable is \fIset\fP, mutt will try to use the ``\fCLAST\fP'' POP command ** for retrieving only unread messages from the POP server when using - ** the fetch-mail function. + ** the \fC$\fP function. + */ + { "pop_pass", DT_STR, R_NONE, UL &PopPass, UL "" }, + /* + ** .pp + ** Specifies the password for your POP account. If \fIunset\fP, Mutt will + ** prompt you for your password when you open a POP mailbox. + ** .pp + ** \fBWarning\fP: you should only use this option when you are on a + ** fairly secure machine, because the superuser can read your muttrc + ** even if you are the only one who can read the file. */ { "pop_reconnect", DT_QUAD, R_NONE, OPT_POPRECONNECT, M_ASKYES }, /* ** .pp - ** Controls whether or not Mutt will try to reconnect to POP server if + ** Controls whether or not Mutt will try to reconnect to the POP server if ** the connection is lost. */ { "pop_user", DT_STR, R_NONE, UL &PopUser, 0 }, @@ -2165,20 +2069,11 @@ struct option_t MuttVars[] = { ** .pp ** This variable defaults to your user name on the local machine. */ - { "pop_pass", DT_STR, R_NONE, UL &PopPass, UL "" }, - /* - ** .pp - ** Specifies the password for your POP account. If unset, Mutt will - ** prompt you for your password when you open POP mailbox. - ** \fBWarning\fP: you should only use this option when you are on a - ** fairly secure machine, because the superuser can read your muttrc - ** even if you are the only one who can read the file. - */ #endif /* USE_POP */ { "post_indent_string",DT_STR, R_NONE, UL &PostIndentString, UL "" }, /* ** .pp - ** Similar to the ``$$attribution'' variable, Mutt will append this + ** Similar to the $$attribution variable, Mutt will append this ** string after the inclusion of a message which is being replied to. */ { "post_indent_str", DT_SYN, R_NONE, UL "post_indent_string", 0 }, @@ -2187,34 +2082,37 @@ struct option_t MuttVars[] = { { "postpone", DT_QUAD, R_NONE, OPT_POSTPONE, M_ASKYES }, /* ** .pp - ** Controls whether or not messages are saved in the ``$$postponed'' - ** mailbox when you elect not to send immediately. Also see the - ** ``$$recall'' variable. + ** Controls whether or not messages are saved in the $$postponed + ** mailbox when you elect not to send immediately. + ** .pp + ** Also see the $$recall variable. */ - { "postponed", DT_PATH, R_NONE, UL &Postponed, UL "~/postponed" }, + { "postponed", DT_PATH, R_INDEX, UL &Postponed, UL "~/postponed" }, /* ** .pp ** Mutt allows you to indefinitely ``$postpone sending a message'' which ** you are editing. When you choose to postpone a message, Mutt saves it - ** in the mailbox specified by this variable. Also see the ``$$postpone'' - ** variable. + ** in the mailbox specified by this variable. + ** .pp + ** Also see the $$postpone variable. */ #ifdef USE_SOCKET { "preconnect", DT_STR, R_NONE, UL &Preconnect, UL 0}, /* ** .pp - ** If set, a shell command to be executed if mutt fails to establish + ** If \fIset\fP, a shell command to be executed if mutt fails to establish ** a connection to the server. This is useful for setting up secure - ** connections, e.g. with ssh(1). If the command returns a nonzero + ** connections, e.g. with \fCssh(1)\fP. If the command returns a nonzero ** status, mutt gives up opening the server. Example: + ** .ts + ** set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net \(rs + ** sleep 20 < /dev/null > /dev/null" + ** .te ** .pp - ** preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net - ** sleep 20 < /dev/null > /dev/null" - ** .pp - ** Mailbox 'foo' on mailhost.net can now be reached - ** as '{localhost:1234}foo'. + ** Mailbox ``foo'' on ``mailhost.net'' can now be reached + ** as ``{localhost:1234}foo''. ** .pp - ** NOTE: For this example to work, you must be able to log in to the + ** Note: For this example to work, you must be able to log in to the ** remote machine without having to enter a password. */ #endif /* USE_SOCKET */ @@ -2222,8 +2120,8 @@ struct option_t MuttVars[] = { /* ** .pp ** Controls whether or not Mutt really prints messages. - ** This is set to \fIask-no\fP by default, because some people - ** accidentally hit ``p'' often (like me). + ** This is set to ``ask-no'' by default, because some people + ** accidentally hit ``p'' often. */ { "print_command", DT_PATH, R_NONE, UL &PrintCmd, UL "lpr" }, /* @@ -2236,10 +2134,10 @@ struct option_t MuttVars[] = { { "print_decode", DT_BOOL, R_NONE, OPTPRINTDECODE, 1 }, /* ** .pp - ** Used in connection with the print-message command. If this - ** option is set, the message is decoded before it is passed to the + ** Used in connection with the \fC\fP command. If this + ** option is \fIset\fP, the message is decoded before it is passed to the ** external command specified by $$print_command. If this option - ** is unset, no processing will be applied to the message when + ** is \fIunset\fP, no processing will be applied to the message when ** printing it. The latter setting may be useful if you are using ** some advanced printer filter which is able to properly format ** e-mail messages for printing. @@ -2247,71 +2145,74 @@ struct option_t MuttVars[] = { { "print_split", DT_BOOL, R_NONE, OPTPRINTSPLIT, 0 }, /* ** .pp - ** Used in connection with the print-message command. If this option - ** is set, the command specified by $$print_command is executed once for - ** each message which is to be printed. If this option is unset, + ** Used in connection with the \fC\fP command. If this option + ** is \fIset\fP, the command specified by $$print_command is executed once for + ** each message which is to be printed. If this option is \fIunset\fP, ** the command specified by $$print_command is executed only once, and ** all the messages are concatenated, with a form feed as the message ** separator. ** .pp - ** Those who use the \fBenscript\fP(1) program's mail-printing mode will - ** most likely want to set this option. + ** Those who use the \fCenscript\fP(1) program's mail-printing mode will + ** most likely want to \fIset\fP this option. */ { "prompt_after", DT_BOOL, R_NONE, OPTPROMPTAFTER, 1 }, /* ** .pp - ** If you use an \fIexternal\fP ``$$pager'', setting this variable will + ** If you use an \fIexternal\fP $$pager, setting this variable will ** cause Mutt to prompt you for a command when the pager exits rather - ** than returning to the index menu. If unset, Mutt will return to the + ** than returning to the index menu. If \fIunset\fP, Mutt will return to the ** index menu when the external pager exits. */ { "query_command", DT_PATH, R_NONE, UL &QueryCmd, UL "" }, /* ** .pp ** This specifies the command that mutt will use to make external address - ** queries. The string should contain a %s, which will be substituted + ** queries. The string should contain a ``%s'', which will be substituted ** with the query string the user types. See ``$query'' for more ** information. */ { "query_format", DT_STR, R_NONE, UL &QueryFormat, UL "%4c %t %-25.25a %-25.25n %?e?(%e)?" }, /* ** .pp - ** This variable describes the format of the `query' menu. The - ** following printf-style sequences are understood: - ** .pp + ** This variable describes the format of the ``query'' menu. The + ** following \fCprintf(3)\fP-style sequences are understood: ** .dl ** .dt %a .dd destination address ** .dt %c .dd current entry number ** .dt %e .dd extra information * ** .dt %n .dd destination name ** .dt %t .dd ``*'' if current entry is tagged, a space otherwise - ** .dt %>X .dd right justify the rest of the string and pad with "X" - ** .dt %|X .dd pad to the end of the line with "X" - ** .dt %*X .dd soft-fill with character "X" as pad + ** .dt %>X .dd right justify the rest of the string and pad with ``X'' + ** .dt %|X .dd pad to the end of the line with ``X'' + ** .dt %*X .dd soft-fill with character ``X'' as pad ** .de ** .pp - ** For an explanation of `soft-fill', see the ``$$index_format'' documentation. + ** For an explanation of ``soft-fill'', see the $$index_format documentation. ** .pp - ** * = can be optionally printed if nonzero, see the ``$$status_format'' documentation. + ** * = can be optionally printed if nonzero, see the $$status_format documentation. */ { "quit", DT_QUAD, R_NONE, OPT_QUIT, M_YES }, /* ** .pp ** This variable controls whether ``quit'' and ``exit'' actually quit - ** from mutt. If it set to yes, they do quit, if it is set to no, they - ** have no effect, and if it is set to ask-yes or ask-no, you are + ** from mutt. If this option is \fIset\fP, they do quit, if it is \fIunset\fP, they + ** have no effect, and if it is set to \fIask-yes\fP or \fIask-no\fP, you are ** prompted for confirmation when you try to quit. */ { "quote_regexp", DT_RX, R_PAGER, UL &QuoteRegexp, UL "^([ \t]*[|>:}#])+" }, /* ** .pp - ** A regular expression used in the internal-pager to determine quoted - ** sections of text in the body of a message. + ** A regular expression used in the internal pager to determine quoted + ** sections of text in the body of a message. Quoted text may be filtered + ** out using the \fC\fP command, or colored according to the + ** ``color quoted'' family of directives. + ** .pp + ** Higher levels of quoting may be colored differently (``color quoted1'', + ** ``color quoted2'', etc.). The quoting level is determined by removing + ** the last character from the matched text and recursively reapplying + ** the regular expression until it fails to produce a match. ** .pp - ** \fBNote:\fP In order to use the \fIquoted\fP\fBx\fP patterns in the - ** internal pager, you need to set this to a regular expression that - ** matches \fIexactly\fP the quote characters at the beginning of quoted - ** lines. + ** Match detection may be overridden by the $$smileys regular expression. */ { "read_inc", DT_NUM, R_NONE, UL &ReadInc, 10 }, /* @@ -2319,28 +2220,28 @@ struct option_t MuttVars[] = { ** If set to a value greater than 0, Mutt will display which message it ** is currently on when reading a mailbox or when performing search actions ** such as search and limit. The message is printed after - ** \fIread_inc\fP messages have been read or searched (e.g., if set to 25, Mutt will + ** this many messages have been read or searched (e.g., if set to 25, Mutt will ** print a message when it is at message 25, and then again when it gets ** to message 50). This variable is meant to indicate progress when ** reading or searching large mailboxes which may take some time. ** When set to 0, only a single message will appear before the reading ** the mailbox. ** .pp - ** Also see the ``$$write_inc'' variable and the ``Tuning'' section of the - ** manual for performance considerations. + ** Also see the $$write_inc, $$net_inc and $$time_inc variables and the + ** ``$tuning'' section of the manual for performance considerations. */ { "read_only", DT_BOOL, R_NONE, OPTREADONLY, 0 }, /* ** .pp - ** If set, all folders are opened in read-only mode. + ** If \fIset\fP, all folders are opened in read-only mode. */ { "realname", DT_STR, R_BOTH, UL &Realname, 0 }, /* ** .pp - ** This variable specifies what "real" or "personal" name should be used + ** This variable specifies what ``real'' or ``personal'' name should be used ** when sending messages. ** .pp - ** By default, this is the GECOS field from /etc/passwd. Note that this + ** By default, this is the GECOS field from \fC/etc/passwd\fP. Note that this ** variable will \fInot\fP be used when the user has set a real name ** in the $$from variable. */ @@ -2348,10 +2249,12 @@ struct option_t MuttVars[] = { /* ** .pp ** Controls whether or not Mutt recalls postponed messages - ** when composing a new message. Also see ``$$postponed''. + ** when composing a new message. ** .pp - ** Setting this variable to ``yes'' is not generally useful, and thus not + ** \fISetting\fP this variable to is not generally useful, and thus not ** recommended. + ** .pp + ** Also see $$postponed variable. */ { "record", DT_PATH, R_NONE, UL &Outbox, UL "~/sent" }, /* @@ -2359,10 +2262,10 @@ struct option_t MuttVars[] = { ** This specifies the file into which your outgoing messages should be ** appended. (This is meant as the primary method for saving a copy of ** your messages, but another way to do this is using the ``$my_hdr'' - ** command to create a \fIBcc:\fP field with your email address in it.) + ** command to create a ``Bcc:'' field with your email address in it.) ** .pp - ** The value of \fI$$record\fP is overridden by the ``$$force_name'' and - ** ``$$save_name'' variables, and the ``$fcc-hook'' command. + ** The value of \fI$$record\fP is overridden by the $$force_name and + ** $$save_name variables, and the ``$fcc-hook'' command. */ { "reply_regexp", DT_RX, R_INDEX|R_RESORT, UL &ReplyRegexp, UL "^(re([\\[0-9\\]+])*|aw):[ \t]*" }, /* @@ -2374,15 +2277,17 @@ struct option_t MuttVars[] = { { "reply_self", DT_BOOL, R_NONE, OPTREPLYSELF, 0 }, /* ** .pp - ** If unset and you are replying to a message sent by you, Mutt will + ** If \fIunset\fP and you are replying to a message sent by you, Mutt will ** assume that you want to reply to the recipients of that message rather ** than to yourself. + ** .pp + ** Also see the ``$alternates'' command. */ { "reply_to", DT_QUAD, R_NONE, OPT_REPLYTO, M_ASKYES }, /* ** .pp - ** If set, when replying to a message, Mutt will use the address listed - ** in the Reply-to: header as the recipient of the reply. If unset, + ** If \fIset\fP, when replying to a message, Mutt will use the address listed + ** in the Reply-to: header as the recipient of the reply. If \fIunset\fP, ** it will use the address in the From: header field instead. This ** option is useful for reading a mailing list that sets the Reply-To: ** header field to the list address and you want to send a private @@ -2391,83 +2296,86 @@ struct option_t MuttVars[] = { { "resolve", DT_BOOL, R_NONE, OPTRESOLVE, 1 }, /* ** .pp - ** When set, the cursor will be automatically advanced to the next + ** When \fIset\fP, the cursor will be automatically advanced to the next ** (possibly undeleted) message whenever a command that modifies the ** current message is executed. */ { "reverse_alias", DT_BOOL, R_BOTH, OPTREVALIAS, 0 }, /* ** .pp - ** This variable controls whether or not Mutt will display the "personal" + ** This variable controls whether or not Mutt will display the ``personal'' ** name from your aliases in the index menu if it finds an alias that ** matches the message's sender. For example, if you have the following ** alias: - ** .pp ** .ts - ** alias juser abd30425@somewhere.net (Joe User) + ** alias juser abd30425@somewhere.net (Joe User) ** .te ** .pp ** and then you receive mail which contains the following header: - ** .pp ** .ts - ** From: abd30425@somewhere.net + ** From: abd30425@somewhere.net ** .te ** .pp ** It would be displayed in the index menu as ``Joe User'' instead of ** ``abd30425@somewhere.net.'' This is useful when the person's e-mail - ** address is not human friendly (like CompuServe addresses). + ** address is not human friendly. */ { "reverse_name", DT_BOOL, R_BOTH, OPTREVNAME, 0 }, /* ** .pp ** It may sometimes arrive that you receive mail to a certain machine, ** move the messages to another machine, and reply to some the messages - ** from there. If this variable is set, the default \fIFrom:\fP line of + ** from there. If this variable is \fIset\fP, the default \fIFrom:\fP line of ** the reply messages is built using the address where you received the ** messages you are replying to \fBif\fP that address matches your - ** alternates. If the variable is unset, or the address that would be - ** used doesn't match your alternates, the \fIFrom:\fP line will use + ** ``$alternates''. If the variable is \fIunset\fP, or the address that would be + ** used doesn't match your ``$alternates'', the \fIFrom:\fP line will use ** your address on the current machine. + ** .pp + ** Also see the ``$alternates'' command. */ { "reverse_realname", DT_BOOL, R_BOTH, OPTREVREAL, 1 }, /* ** .pp - ** This variable fine-tunes the behaviour of the $reverse_name feature. - ** When it is set, mutt will use the address from incoming messages as-is, - ** possibly including eventual real names. When it is unset, mutt will - ** override any such real names with the setting of the $realname variable. + ** This variable fine-tunes the behaviour of the $$reverse_name feature. + ** When it is \fIset\fP, mutt will use the address from incoming messages as-is, + ** possibly including eventual real names. When it is \fIunset\fP, mutt will + ** override any such real names with the setting of the $$realname variable. */ { "rfc2047_parameters", DT_BOOL, R_NONE, OPTRFC2047PARAMS, 0 }, /* ** .pp - ** When this variable is set, Mutt will decode RFC-2047-encoded MIME + ** When this variable is \fIset\fP, Mutt will decode RFC2047-encoded MIME ** parameters. You want to set this variable when mutt suggests you - ** to save attachments to files named like this: + ** to save attachments to files named like: + ** .ts ** =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?= + ** .te ** .pp - ** When this variable is set interactively, the change doesn't have - ** the desired effect before you have changed folders. + ** When this variable is \fIset\fP interactively, the change won't be + ** active until you change folders. ** .pp - ** Note that this use of RFC 2047's encoding is explicitly, + ** Note that this use of RFC2047's encoding is explicitly ** prohibited by the standard, but nevertheless encountered in the ** wild. - ** Also note that setting this parameter will \fInot\fP have the effect + ** .pp + ** Also note that setting this parameter will \fInot\fP have the effect ** that mutt \fIgenerates\fP this kind of encoding. Instead, mutt will - ** unconditionally use the encoding specified in RFC 2231. + ** unconditionally use the encoding specified in RFC2231. */ { "save_address", DT_BOOL, R_NONE, OPTSAVEADDRESS, 0 }, /* ** .pp - ** If set, mutt will take the sender's full address when choosing a - ** default folder for saving a mail. If ``$$save_name'' or ``$$force_name'' - ** is set too, the selection of the fcc folder will be changed as well. + ** If \fIset\fP, mutt will take the sender's full address when choosing a + ** default folder for saving a mail. If $$save_name or $$force_name + ** is \fIset\fP too, the selection of the Fcc folder will be changed as well. */ { "save_empty", DT_BOOL, R_NONE, OPTSAVEEMPTY, 1 }, /* ** .pp - ** When unset, mailboxes which contain no saved messages will be removed - ** when closed (the exception is ``$$spoolfile'' which is never removed). - ** If set, mailboxes are never removed. + ** When \fIunset\fP, mailboxes which contain no saved messages will be removed + ** when closed (the exception is $$spoolfile which is never removed). + ** If \fIset\fP, mailboxes are never removed. ** .pp ** \fBNote:\fP This only applies to mbox and MMDF folders, Mutt does not ** delete MH and Maildir directories. @@ -2475,180 +2383,396 @@ struct option_t MuttVars[] = { { "save_history", DT_NUM, R_NONE, UL &SaveHist, 0 }, /* ** .pp - ** This variable controls the size of the history saved in the - ** ``$$history_file'' file. + ** This variable controls the size of the history (per category) saved in the + ** $$history_file file. */ { "save_name", DT_BOOL, R_NONE, OPTSAVENAME, 0 }, /* ** .pp ** This variable controls how copies of outgoing messages are saved. - ** When set, a check is made to see if a mailbox specified by the + ** When \fIset\fP, a check is made to see if a mailbox specified by the ** recipient address exists (this is done by searching for a mailbox in - ** the ``$$folder'' directory with the \fIusername\fP part of the + ** the $$folder directory with the \fIusername\fP part of the ** recipient address). If the mailbox exists, the outgoing message will ** be saved to that mailbox, otherwise the message is saved to the - ** ``$$record'' mailbox. + ** $$record mailbox. ** .pp - ** Also see the ``$$force_name'' variable. + ** Also see the $$force_name variable. */ { "score", DT_BOOL, R_NONE, OPTSCORE, 1 }, /* ** .pp - ** When this variable is \fIunset\fP, scoring is turned off. This can - ** be useful to selectively disable scoring for certain folders when the - ** ``$$score_threshold_delete'' variable and friends are used. - ** + ** When this variable is \fIunset\fP, scoring is turned off. This can + ** be useful to selectively disable scoring for certain folders when the + ** $$score_threshold_delete variable and related are used. + ** + */ + { "score_threshold_delete", DT_NUM, R_NONE, UL &ScoreThresholdDelete, UL -1 }, + /* + ** .pp + ** Messages which have been assigned a score equal to or lower than the value + ** of this variable are automatically marked for deletion by mutt. Since + ** mutt scores are always greater than or equal to zero, the default setting + ** of this variable will never mark a message for deletion. + */ + { "score_threshold_flag", DT_NUM, R_NONE, UL &ScoreThresholdFlag, 9999 }, + /* + ** .pp + ** Messages which have been assigned a score greater than or equal to this + ** variable's value are automatically marked "flagged". + */ + { "score_threshold_read", DT_NUM, R_NONE, UL &ScoreThresholdRead, UL -1 }, + /* + ** .pp + ** Messages which have been assigned a score equal to or lower than the value + ** of this variable are automatically marked as read by mutt. Since + ** mutt scores are always greater than or equal to zero, the default setting + ** of this variable will never mark a message read. + */ + { "search_context", DT_NUM, R_NONE, UL &SearchContext, UL 0 }, + /* + ** .pp + ** For the pager, this variable specifies the number of lines shown + ** before search results. By default, search results will be top-aligned. + */ + { "send_charset", DT_STR, R_NONE, UL &SendCharset, UL "us-ascii:iso-8859-1:utf-8" }, + /* + ** .pp + ** A colon-delimited list of character sets for outgoing messages. Mutt will use the + ** first character set into which the text can be converted exactly. + ** If your $$charset is not ``iso-8859-1'' and recipients may not + ** understand ``UTF-8'', it is advisable to include in the list an + ** appropriate widely used standard character set (such as + ** ``iso-8859-2'', ``koi8-r'' or ``iso-2022-jp'') either instead of or after + ** ``iso-8859-1''. + ** .pp + ** In case the text cannot be converted into one of these exactly, + ** mutt uses $$charset as a fallback. + */ + { "sendmail", DT_PATH, R_NONE, UL &Sendmail, UL SENDMAIL " -oem -oi" }, + /* + ** .pp + ** Specifies the program and arguments used to deliver mail sent by Mutt. + ** Mutt expects that the specified program interprets additional + ** arguments as recipient addresses. + */ + { "sendmail_wait", DT_NUM, R_NONE, UL &SendmailWait, 0 }, + /* + ** .pp + ** Specifies the number of seconds to wait for the $$sendmail process + ** to finish before giving up and putting delivery in the background. + ** .pp + ** Mutt interprets the value of this variable as follows: + ** .dl + ** .dt >0 .dd number of seconds to wait for sendmail to finish before continuing + ** .dt 0 .dd wait forever for sendmail to finish + ** .dt <0 .dd always put sendmail in the background without waiting + ** .de + ** .pp + ** Note that if you specify a value other than 0, the output of the child + ** process will be put in a temporary file. If there is some error, you + ** will be informed as to where to find the output. + */ + { "shell", DT_PATH, R_NONE, UL &Shell, 0 }, + /* + ** .pp + ** Command to use when spawning a subshell. By default, the user's login + ** shell from \fC/etc/passwd\fP is used. + */ + { "sig_dashes", DT_BOOL, R_NONE, OPTSIGDASHES, 1 }, + /* + ** .pp + ** If \fIset\fP, a line containing ``-- '' (note the trailing space) will be inserted before your + ** $$signature. It is \fBstrongly\fP recommended that you not \fIunset\fP + ** this variable unless your signature contains just your name. The + ** reason for this is because many software packages use ``-- \n'' to + ** detect your signature. For example, Mutt has the ability to highlight + ** the signature in a different color in the builtin pager. + */ + { "sig_on_top", DT_BOOL, R_NONE, OPTSIGONTOP, 0}, + /* + ** .pp + ** If \fIset\fP, the signature will be included before any quoted or forwarded + ** text. It is \fBstrongly\fP recommended that you do not set this variable + ** unless you really know what you are doing, and are prepared to take + ** some heat from netiquette guardians. + */ + { "signature", DT_PATH, R_NONE, UL &Signature, UL "~/.signature" }, + /* + ** .pp + ** Specifies the filename of your signature, which is appended to all + ** outgoing messages. If the filename ends with a pipe (``|''), it is + ** assumed that filename is a shell command and input should be read from + ** its standard output. + */ + { "simple_search", DT_STR, R_NONE, UL &SimpleSearch, UL "~f %s | ~s %s" }, + /* + ** .pp + ** Specifies how Mutt should expand a simple search into a real search + ** pattern. A simple search is one that does not contain any of the ``~'' pattern + ** operators. See ``$patterns'' for more information on search patterns. + ** .pp + ** For example, if you simply type ``joe'' at a search or limit prompt, Mutt + ** will automatically expand it to the value specified by this variable by + ** replacing ``%s'' with the supplied string. + ** For the default value, ``joe'' would be expanded to: ``~f joe | ~s joe''. + */ + { "sleep_time", DT_NUM, R_NONE, UL &SleepTime, 1 }, + /* + ** .pp + ** Specifies time, in seconds, to pause while displaying certain informational + ** messages, while moving from folder to folder and after expunging + ** messages from the current folder. The default is to pause one second, so + ** a value of zero for this option suppresses the pause. + */ + { "smart_wrap", DT_BOOL, R_PAGER, OPTWRAP, 1 }, + /* + ** .pp + ** Controls the display of lines longer than the screen width in the + ** internal pager. If \fIset\fP, long lines are wrapped at a word boundary. If + ** \fIunset\fP, lines are simply wrapped at the screen edge. Also see the + ** $$markers variable. + */ + { "smileys", DT_RX, R_PAGER, UL &Smileys, UL "(>From )|(:[-^]?[][)(><}{|/DP])" }, + /* + ** .pp + ** The \fIpager\fP uses this variable to catch some common false + ** positives of $$quote_regexp, most notably smileys and not consider + ** a line quoted text if it also matches $$smileys. This mostly + ** happens at the beginning of a line. + */ + + + + { "smime_ask_cert_label", DT_BOOL, R_NONE, OPTASKCERTLABEL, 1 }, + /* + ** .pp + ** This flag controls whether you want to be asked to enter a label + ** for a certificate about to be added to the database or not. It is + ** \fIset\fP by default. + ** (S/MIME only) + */ + { "smime_ca_location", DT_PATH, R_NONE, UL &SmimeCALocation, 0 }, + /* + ** .pp + ** This variable contains the name of either a directory, or a file which + ** contains trusted certificates for use with OpenSSL. + ** (S/MIME only) + */ + { "smime_certificates", DT_PATH, R_NONE, UL &SmimeCertificates, 0 }, + /* + ** .pp + ** Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle + ** storage and retrieval of keys by itself. This is very basic right + ** now, and keys and certificates are stored in two different + ** directories, both named as the hash-value retrieved from + ** OpenSSL. There is an index file which contains mailbox-address + ** keyid pairs, and which can be manually edited. This option points to + ** the location of the certificates. + ** (S/MIME only) + */ + { "smime_decrypt_command", DT_STR, R_NONE, UL &SmimeDecryptCommand, 0}, + /* + ** .pp + ** This format string specifies a command which is used to decrypt + ** \fCapplication/x-pkcs7-mime\fP attachments. + ** .pp + ** The OpenSSL command formats have their own set of \fCprintf(3)\fP-like sequences + ** similar to PGP's: + ** .dl + ** .dt %f .dd Expands to the name of a file containing a message. + ** .dt %s .dd Expands to the name of a file containing the signature part + ** . of a \fCmultipart/signed\fP attachment when verifying it. + ** .dt %k .dd The key-pair specified with $$smime_default_key + ** .dt %c .dd One or more certificate IDs. + ** .dt %a .dd The algorithm used for encryption. + ** .dt %C .dd CA location: Depending on whether $$smime_ca_location + ** . points to a directory or file, this expands to + ** . ``-CApath $$smime_ca_location'' or ``-CAfile $$smime_ca_location''. + ** .de + ** .pp + ** For examples on how to configure these formats, see the \fCsmime.rc\fP in + ** the \fCsamples/\fP subdirectory which has been installed on your system + ** alongside the documentation. + ** (S/MIME only) + */ + { "smime_decrypt_use_default_key", DT_BOOL, R_NONE, OPTSDEFAULTDECRYPTKEY, 1 }, + /* + ** .pp + ** If \fIset\fP (default) this tells mutt to use the default key for decryption. Otherwise, + ** if managing multiple certificate-key-pairs, mutt will try to use the mailbox-address + ** to determine the key to use. It will ask you to supply a key, if it can't find one. + ** (S/MIME only) + */ + { "smime_sign_as", DT_SYN, R_NONE, UL "smime_default_key", 0 }, + { "smime_default_key", DT_STR, R_NONE, UL &SmimeDefaultKey, 0 }, + /* + ** .pp + ** This is the default key-pair to use for signing. This must be set to the + ** keyid (the hash-value that OpenSSL generates) to work properly + ** (S/MIME only) */ - { "score_threshold_delete", DT_NUM, R_NONE, UL &ScoreThresholdDelete, UL -1 }, + { "smime_encrypt_command", DT_STR, R_NONE, UL &SmimeEncryptCommand, 0}, /* ** .pp - ** Messages which have been assigned a score equal to or lower than the value - ** of this variable are automatically marked for deletion by mutt. Since - ** mutt scores are always greater than or equal to zero, the default setting - ** of this variable will never mark a message for deletion. - */ - { "score_threshold_flag", DT_NUM, R_NONE, UL &ScoreThresholdFlag, 9999 }, - /* + ** This command is used to create encrypted S/MIME messages. ** .pp - ** Messages which have been assigned a score greater than or equal to this - ** variable's value are automatically marked "flagged". + ** This is a format string, see the $$smime_decrypt_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (S/MIME only) */ - { "score_threshold_read", DT_NUM, R_NONE, UL &ScoreThresholdRead, UL -1 }, + { "smime_encrypt_with", DT_STR, R_NONE, UL &SmimeCryptAlg, 0 }, /* ** .pp - ** Messages which have been assigned a score equal to or lower than the value - ** of this variable are automatically marked as read by mutt. Since - ** mutt scores are always greater than or equal to zero, the default setting - ** of this variable will never mark a message read. + ** This sets the algorithm that should be used for encryption. + ** Valid choices are ``des'', ``des3'', ``rc2-40'', ``rc2-64'', ``rc2-128''. + ** If \fIunset\fP, ``3des'' (TripleDES) is used. + ** (S/MIME only) */ - { "send_charset", DT_STR, R_NONE, UL &SendCharset, UL "us-ascii:iso-8859-1:utf-8" }, + { "smime_get_cert_command", DT_STR, R_NONE, UL &SmimeGetCertCommand, 0}, /* ** .pp - ** A colon-delimited list of character sets for outgoing messages. Mutt will use the - ** first character set into which the text can be converted exactly. - ** If your ``$$charset'' is not iso-8859-1 and recipients may not - ** understand UTF-8, it is advisable to include in the list an - ** appropriate widely used standard character set (such as - ** iso-8859-2, koi8-r or iso-2022-jp) either instead of or after - ** "iso-8859-1". + ** This command is used to extract X509 certificates from a PKCS7 structure. ** .pp - ** In case the text cannot be converted into one of these exactly, - ** mutt uses ``$$charset'' as a fallback. + ** This is a format string, see the $$smime_decrypt_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (S/MIME only) */ - { "sendmail", DT_PATH, R_NONE, UL &Sendmail, UL SENDMAIL " -oem -oi" }, + { "smime_get_cert_email_command", DT_STR, R_NONE, UL &SmimeGetCertEmailCommand, 0}, /* ** .pp - ** Specifies the program and arguments used to deliver mail sent by Mutt. - ** Mutt expects that the specified program interprets additional - ** arguments as recipient addresses. + ** This command is used to extract the mail address(es) used for storing + ** X509 certificates, and for verification purposes (to check whether the + ** certificate was issued for the sender's mailbox). + ** .pp + ** This is a format string, see the $$smime_decrypt_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (S/MIME only) */ - { "sendmail_wait", DT_NUM, R_NONE, UL &SendmailWait, 0 }, + { "smime_get_signer_cert_command", DT_STR, R_NONE, UL &SmimeGetSignerCertCommand, 0}, /* ** .pp - ** Specifies the number of seconds to wait for the ``$$sendmail'' process - ** to finish before giving up and putting delivery in the background. - ** .pp - ** Mutt interprets the value of this variable as follows: - ** .dl - ** .dt >0 .dd number of seconds to wait for sendmail to finish before continuing - ** .dt 0 .dd wait forever for sendmail to finish - ** .dt <0 .dd always put sendmail in the background without waiting - ** .de + ** This command is used to extract only the signers X509 certificate from a S/MIME + ** signature, so that the certificate's owner may get compared to the + ** email's ``From:'' field. ** .pp - ** Note that if you specify a value other than 0, the output of the child - ** process will be put in a temporary file. If there is some error, you - ** will be informed as to where to find the output. + ** This is a format string, see the $$smime_decrypt_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (S/MIME only) */ - { "shell", DT_PATH, R_NONE, UL &Shell, 0 }, + { "smime_import_cert_command", DT_STR, R_NONE, UL &SmimeImportCertCommand, 0}, /* ** .pp - ** Command to use when spawning a subshell. By default, the user's login - ** shell from /etc/passwd is used. + ** This command is used to import a certificate via smime_keys. + ** .pp + ** This is a format string, see the $$smime_decrypt_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (S/MIME only) */ - { "sig_dashes", DT_BOOL, R_NONE, OPTSIGDASHES, 1 }, + { "smime_is_default", DT_BOOL, R_NONE, OPTSMIMEISDEFAULT, 0}, /* ** .pp - ** If set, a line containing ``-- '' will be inserted before your - ** ``$$signature''. It is \fBstrongly\fP recommended that you not unset - ** this variable unless your ``signature'' contains just your name. The - ** reason for this is because many software packages use ``-- \n'' to - ** detect your signature. For example, Mutt has the ability to highlight - ** the signature in a different color in the builtin pager. + ** The default behaviour of mutt is to use PGP on all auto-sign/encryption + ** operations. To override and to use OpenSSL instead this must be \fIset\fP. + ** However, this has no effect while replying, since mutt will automatically + ** select the same application that was used to sign/encrypt the original + ** message. (Note that this variable can be overridden by unsetting $$crypt_autosmime.) + ** (S/MIME only) */ - { "sig_on_top", DT_BOOL, R_NONE, OPTSIGONTOP, 0}, + { "smime_keys", DT_PATH, R_NONE, UL &SmimeKeys, 0 }, /* ** .pp - ** If set, the signature will be included before any quoted or forwarded - ** text. It is \fBstrongly\fP recommended that you do not set this variable - ** unless you really know what you are doing, and are prepared to take - ** some heat from netiquette guardians. + ** Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle + ** storage and retrieval of keys/certs by itself. This is very basic right now, + ** and stores keys and certificates in two different directories, both + ** named as the hash-value retrieved from OpenSSL. There is an index file + ** which contains mailbox-address keyid pair, and which can be manually + ** edited. This option points to the location of the private keys. + ** (S/MIME only) */ - { "signature", DT_PATH, R_NONE, UL &Signature, UL "~/.signature" }, + { "smime_pk7out_command", DT_STR, R_NONE, UL &SmimePk7outCommand, 0}, /* ** .pp - ** Specifies the filename of your signature, which is appended to all - ** outgoing messages. If the filename ends with a pipe (``|''), it is - ** assumed that filename is a shell command and input should be read from - ** its stdout. + ** This command is used to extract PKCS7 structures of S/MIME signatures, + ** in order to extract the public X509 certificate(s). + ** .pp + ** This is a format string, see the $$smime_decrypt_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (S/MIME only) */ - { "simple_search", DT_STR, R_NONE, UL &SimpleSearch, UL "~f %s | ~s %s" }, + { "smime_sign_command", DT_STR, R_NONE, UL &SmimeSignCommand, 0}, /* ** .pp - ** Specifies how Mutt should expand a simple search into a real search - ** pattern. A simple search is one that does not contain any of the ~ - ** operators. See ``$patterns'' for more information on search patterns. + ** This command is used to created S/MIME signatures of type + ** \fCmultipart/signed\fP, which can be read by all mail clients. + ** .pp + ** This is a format string, see the $$smime_decrypt_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (S/MIME only) + */ + { "smime_sign_opaque_command", DT_STR, R_NONE, UL &SmimeSignOpaqueCommand, 0}, + /* ** .pp - ** For example, if you simply type joe at a search or limit prompt, Mutt - ** will automatically expand it to the value specified by this variable. - ** For the default value it would be: + ** This command is used to created S/MIME signatures of type + ** \fCapplication/x-pkcs7-signature\fP, which can only be handled by mail + ** clients supporting the S/MIME extension. ** .pp - ** ~f joe | ~s joe + ** This is a format string, see the $$smime_decrypt_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (S/MIME only) */ - { "smart_wrap", DT_BOOL, R_PAGER, OPTWRAP, 1 }, + { "smime_timeout", DT_NUM, R_NONE, UL &SmimeTimeout, 300 }, /* ** .pp - ** Controls the display of lines longer than the screen width in the - ** internal pager. If set, long lines are wrapped at a word boundary. If - ** unset, lines are simply wrapped at the screen edge. Also see the - ** ``$$markers'' variable. + ** The number of seconds after which a cached passphrase will expire if + ** not used. + ** (S/MIME only) */ - { "smileys", DT_RX, R_PAGER, UL &Smileys, UL "(>From )|(:[-^]?[][)(><}{|/DP])" }, + { "smime_verify_command", DT_STR, R_NONE, UL &SmimeVerifyCommand, 0}, /* ** .pp - ** The \fIpager\fP uses this variable to catch some common false - ** positives of ``$$quote_regexp'', most notably smileys in the beginning - ** of a line + ** This command is used to verify S/MIME signatures of type \fCmultipart/signed\fP. + ** .pp + ** This is a format string, see the $$smime_decrypt_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (S/MIME only) */ - { "sleep_time", DT_NUM, R_NONE, UL &SleepTime, 1 }, + { "smime_verify_opaque_command", DT_STR, R_NONE, UL &SmimeVerifyOpaqueCommand, 0}, /* ** .pp - ** Specifies time, in seconds, to pause while displaying certain informational - ** messages, while moving from folder to folder and after expunging - ** messages from the current folder. The default is to pause one second, so - ** a value of zero for this option suppresses the pause. + ** This command is used to verify S/MIME signatures of type + ** \fCapplication/x-pkcs7-mime\fP. + ** .pp + ** This is a format string, see the $$smime_decrypt_command command for + ** possible \fCprintf(3)\fP-like sequences. + ** (S/MIME only) */ #ifdef USE_SMTP # ifdef USE_SASL { "smtp_authenticators", DT_STR, R_NONE, UL &SmtpAuthenticators, UL 0 }, /* - ** .pp - ** This is a colon-delimited list of authentication methods mutt may - ** attempt to use to log in to an SMTP server, in the order mutt should - ** try them. Authentication methods are any SASL mechanism, eg - ** ``digest-md5'', ``gssapi'' or ``cram-md5''. - ** This parameter is case-insensitive. If this parameter is unset - ** (the default) mutt will try all available methods, in order from - ** most-secure to least-secure. - ** .pp - ** Example: set smtp_authenticators="digest-md5:cram-md5" - */ + ** .pp + ** This is a colon-delimited list of authentication methods mutt may + ** attempt to use to log in to an SMTP server, in the order mutt should + ** try them. Authentication methods are any SASL mechanism, eg + ** ``digest-md5'', ``gssapi'' or ``cram-md5''. + ** This option is case-insensitive. If it is ``unset'' + ** (the default) mutt will try all available methods, in order from + ** most-secure to least-secure. + ** .pp + ** Example: + ** .ts + ** set smtp_authenticators="digest-md5:cram-md5" + ** .te + */ # endif /* USE_SASL */ { "smtp_pass", DT_STR, R_NONE, UL &SmtpPass, UL 0 }, /* ** .pp ** Specifies the password for your SMTP account. If \fIunset\fP, Mutt will ** prompt you for your password when you first send mail via SMTP. - ** See ``$smtp_url'' to configure mutt to send mail via SMTP. + ** See $$smtp_url to configure mutt to send mail via SMTP. + ** .pp ** \fBWarning\fP: you should only use this option when you are on a ** fairly secure machine, because the superuser can read your muttrc even ** if you are the only one who can read the file. @@ -2656,63 +2780,69 @@ struct option_t MuttVars[] = { { "smtp_url", DT_STR, R_NONE, UL &SmtpUrl, UL 0 }, /* ** .pp - ** Defines the SMTP ``smart'' host where sent messages should relayed for + ** Defines the SMTP smarthost where sent messages should relayed for ** delivery. This should take the form of an SMTP URL, eg: + ** .ts + ** smtp[s]://[user[:pass]@]host[:port]/ + ** .te ** .pp - ** smtp[s]://[user[:pass]@]host[:port]/ - ** .pp - ** Setting this variable overrides the value of the ``$$sendmail'' + ** where ``[...]'' denotes an optional part. + ** Setting this variable overrides the value of the $$sendmail ** variable. */ #endif /* USE_SMTP */ { "sort", DT_SORT, R_INDEX|R_RESORT, UL &Sort, SORT_DATE }, /* ** .pp - ** Specifies how to sort messages in the \fIindex\fP menu. Valid values + ** Specifies how to sort messages in the ``index'' menu. Valid values ** are: - ** .pp - ** .ts - ** . date or date-sent - ** . date-received - ** . from - ** . mailbox-order (unsorted) - ** . score - ** . size - ** . spam - ** . subject - ** . threads - ** . to - ** .te - ** .pp - ** You may optionally use the reverse- prefix to specify reverse sorting - ** order (example: set sort=reverse-date-sent). + ** .il + ** .dd date or date-sent + ** .dd date-received + ** .dd from + ** .dd mailbox-order (unsorted) + ** .dd score + ** .dd size + ** .dd spam + ** .dd subject + ** .dd threads + ** .dd to + ** .ie + ** .pp + ** You may optionally use the ``reverse-'' prefix to specify reverse sorting + ** order (example: ``\fCset sort=reverse-date-sent\fP''). */ { "sort_alias", DT_SORT|DT_SORT_ALIAS, R_NONE, UL &SortAlias, SORT_ALIAS }, /* ** .pp - ** Specifies how the entries in the `alias' menu are sorted. The + ** Specifies how the entries in the ``alias'' menu are sorted. The ** following are legal values: - ** .pp - ** .ts - ** . address (sort alphabetically by email address) - ** . alias (sort alphabetically by alias name) - ** . unsorted (leave in order specified in .muttrc) - ** .te + ** .il + ** .dd address (sort alphabetically by email address) + ** .dd alias (sort alphabetically by alias name) + ** .dd unsorted (leave in order specified in .muttrc) + ** .ie */ { "sort_aux", DT_SORT|DT_SORT_AUX, R_INDEX|R_RESORT_BOTH, UL &SortAux, SORT_DATE }, /* ** .pp ** When sorting by threads, this variable controls how threads are sorted ** in relation to other threads, and how the branches of the thread trees - ** are sorted. This can be set to any value that ``$$sort'' can, except - ** threads (in that case, mutt will just use date-sent). You can also - ** specify the last- prefix in addition to the reverse- prefix, but last- - ** must come after reverse-. The last- prefix causes messages to be + ** are sorted. This can be set to any value that $$sort can, except + ** ``threads'' (in that case, mutt will just use ``date-sent''). You can also + ** specify the ``last-'' prefix in addition to the ``reverse-'' prefix, but ``last-'' + ** must come after ``reverse-''. The ``last-'' prefix causes messages to be ** sorted against its siblings by which has the last descendant, using - ** the rest of sort_aux as an ordering. For instance, set sort_aux=last- - ** date-received would mean that if a new message is received in a + ** the rest of $$sort_aux as an ordering. For instance, + ** .ts + ** set sort_aux=last-date-received + ** .te + ** .pp + ** would mean that if a new message is received in a ** thread, that thread becomes the last one displayed (or the first, if - ** you have set sort=reverse-threads.) Note: For reversed ``$$sort'' + ** you have ``\fCset sort=reverse-threads\fP''.) + ** .pp + ** Note: For reversed $$sort ** order $$sort_aux is reversed again (which is not the right thing to do, ** but kept to not break any existing configuration setting). */ @@ -2721,36 +2851,35 @@ struct option_t MuttVars[] = { ** .pp ** Specifies how to sort entries in the file browser. By default, the ** entries are sorted alphabetically. Valid values: + ** .il + ** .dd alpha (alphabetically) + ** .dd date + ** .dd size + ** .dd unsorted + ** .ie ** .pp - ** .ts - ** . alpha (alphabetically) - ** . date - ** . size - ** . unsorted - ** .te - ** .pp - ** You may optionally use the reverse- prefix to specify reverse sorting - ** order (example: set sort_browser=reverse-date). + ** You may optionally use the ``reverse-'' prefix to specify reverse sorting + ** order (example: ``\fCset sort_browser=reverse-date\fP''). */ { "sort_re", DT_BOOL, R_INDEX|R_RESORT|R_RESORT_INIT, OPTSORTRE, 1 }, /* ** .pp ** This variable is only useful when sorting by threads with - ** ``$$strict_threads'' unset. In that case, it changes the heuristic - ** mutt uses to thread messages by subject. With sort_re set, mutt will + ** $$strict_threads \fIunset\fP. In that case, it changes the heuristic + ** mutt uses to thread messages by subject. With $$sort_re \fIset\fP, mutt will ** only attach a message as the child of another message by subject if ** the subject of the child message starts with a substring matching the - ** setting of ``$$reply_regexp''. With sort_re unset, mutt will attach + ** setting of $$reply_regexp. With $$sort_re \fIunset\fP, mutt will attach ** the message whether or not this is the case, as long as the - ** non-``$$reply_regexp'' parts of both messages are identical. + ** non-$$reply_regexp parts of both messages are identical. */ { "spam_separator", DT_STR, R_NONE, UL &SpamSep, UL "," }, /* ** .pp - ** ``$spam_separator'' controls what happens when multiple spam headers - ** are matched: if unset, each successive header will overwrite any - ** previous matches value for the spam label. If set, each successive - ** match will append to the previous, using ``$spam_separator'' as a + ** This variable controls what happens when multiple spam headers + ** are matched: if \fIunset\fP, each successive header will overwrite any + ** previous matches value for the spam label. If \fIset\fP, each successive + ** match will append to the previous, using this variable's value as a ** separator. */ { "spoolfile", DT_PATH, R_NONE, UL &Spoolfile, 0 }, @@ -2758,19 +2887,111 @@ struct option_t MuttVars[] = { ** .pp ** If your spool mailbox is in a non-default place where Mutt cannot find ** it, you can specify its location with this variable. Mutt will - ** automatically set this variable to the value of the environment - ** variable $$$MAIL if it is not set. + ** initially set this variable to the value of the environment + ** variable \fC$$$MAIL\fP or \fC$$$MAILDIR\fP if either is defined. + */ +#if defined(USE_SSL) +#ifdef USE_SSL_GNUTLS + { "ssl_ca_certificates_file", DT_PATH, R_NONE, UL &SslCACertFile, 0 }, + /* + ** .pp + ** This variable specifies a file containing trusted CA certificates. + ** Any server certificate that is signed with one of these CA + ** certificates is also automatically accepted. + ** .pp + ** Example: + ** .ts + ** set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt + ** .te + */ +#endif /* USE_SSL_GNUTLS */ + { "ssl_client_cert", DT_PATH, R_NONE, UL &SslClientCert, 0 }, + /* + ** .pp + ** The file containing a client certificate and its associated private + ** key. + */ + { "ssl_force_tls", DT_BOOL, R_NONE, OPTSSLFORCETLS, 0 }, + /* + ** .pp + ** If this variable is \fIset\fP, Mutt will require that all connections + ** to remote servers be encrypted. Furthermore it will attempt to + ** negotiate TLS even if the server does not advertise the capability, + ** since it would otherwise have to abort the connection anyway. This + ** option supersedes $$ssl_starttls. + */ +# ifdef USE_SSL_GNUTLS + { "ssl_min_dh_prime_bits", DT_NUM, R_NONE, UL &SslDHPrimeBits, 0 }, + /* + ** .pp + ** This variable specifies the minimum acceptable prime size (in bits) + ** for use in any Diffie-Hellman key exchange. A value of 0 will use + ** the default from the GNUTLS library. + */ +# endif /* USE_SSL_GNUTLS */ + { "ssl_starttls", DT_QUAD, R_NONE, OPT_SSLSTARTTLS, M_YES }, + /* + ** .pp + ** If \fIset\fP (the default), mutt will attempt to use \fCSTARTTLS\fP on servers + ** advertising the capability. When \fIunset\fP, mutt will not attempt to + ** use \fCSTARTTLS\fP regardless of the server's capabilities. + */ +# ifdef USE_SSL_OPENSSL + { "ssl_use_sslv2", DT_BOOL, R_NONE, OPTSSLV2, 0 }, + /* + ** .pp + ** This variable specifies whether to attempt to use SSLv2 in the + ** SSL authentication process. + */ +# endif /* defined USE_SSL_OPENSSL */ + { "ssl_use_sslv3", DT_BOOL, R_NONE, OPTSSLV3, 1 }, + /* + ** .pp + ** This variable specifies whether to attempt to use SSLv3 in the + ** SSL authentication process. + */ + { "ssl_use_tlsv1", DT_BOOL, R_NONE, OPTTLSV1, 1 }, + /* + ** .pp + ** This variable specifies whether to attempt to use TLSv1 in the + ** SSL authentication process. + */ +#ifdef USE_SSL_OPENSSL + { "ssl_usesystemcerts", DT_BOOL, R_NONE, OPTSSLSYSTEMCERTS, 1 }, + /* + ** .pp + ** If set to \fIyes\fP, mutt will use CA certificates in the + ** system-wide certificate store when checking if a server certificate + ** is signed by a trusted CA. + */ +#endif + { "ssl_verify_dates", DT_BOOL, R_NONE, OPTSSLVERIFYDATES, 1 }, + /* + ** .pp + ** If \fIset\fP (the default), mutt will not automatically accept a server + ** certificate that is either not yet valid or already expired. You should + ** only unset this for particular known hosts, using the + ** \fC$\fP function. + */ + { "ssl_verify_host", DT_BOOL, R_NONE, OPTSSLVERIFYHOST, 1 }, + /* + ** .pp + ** If \fIset\fP (the default), mutt will not automatically accept a server + ** certificate whose host name does not match the host used in your folder + ** URL. You should only unset this for particular known hosts, using + ** the \fC$\fP function. */ +#endif /* defined(USE_SSL) */ { "status_chars", DT_STR, R_BOTH, UL &StChars, UL "-*%A" }, /* ** .pp - ** Controls the characters used by the "%r" indicator in - ** ``$$status_format''. The first character is used when the mailbox is + ** Controls the characters used by the ``%r'' indicator in + ** $$status_format. The first character is used when the mailbox is ** unchanged. The second is used when the mailbox has been changed, and ** it needs to be resynchronized. The third is used if the mailbox is in ** read-only mode, or if the mailbox will not be written when exiting ** that mailbox (You can toggle whether to write changes to a mailbox - ** with the toggle-write operation, bound by default to "%"). The fourth + ** with the \fC\fP operation, bound by default to ``%''). The fourth ** is used to indicate that the current folder has been opened in attach- ** message mode (Certain operations like composing a new mail, replying, ** forwarding, etc. are not permitted in this mode). @@ -2778,10 +2999,9 @@ struct option_t MuttVars[] = { { "status_format", DT_STR, R_BOTH, UL &Status, UL "-%r-Mutt: %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)---" }, /* ** .pp - ** Controls the format of the status line displayed in the \fIindex\fP - ** menu. This string is similar to ``$$index_format'', but has its own - ** set of printf()-like sequences: - ** .pp + ** Controls the format of the status line displayed in the ``index'' + ** menu. This string is similar to $$index_format, but has its own + ** set of \fCprintf(3)\fP-like sequences: ** .dl ** .dt %b .dd number of mailboxes with new mail * ** .dt %d .dd number of deleted messages * @@ -2789,7 +3009,7 @@ struct option_t MuttVars[] = { ** .dt %F .dd number of flagged messages * ** .dt %h .dd local hostname ** .dt %l .dd size (in bytes) of the current mailbox * - ** .dt %L .dd size (in bytes) of the messages shown + ** .dt %L .dd size (in bytes) of the messages shown ** (i.e., which match the current limit) * ** .dt %m .dd the number of messages in the mailbox * ** .dt %M .dd the number of messages shown (i.e., which match the current limit) * @@ -2805,12 +3025,12 @@ struct option_t MuttVars[] = { ** .dt %u .dd number of unread messages * ** .dt %v .dd Mutt version string ** .dt %V .dd currently active limit pattern, if any * - ** .dt %>X .dd right justify the rest of the string and pad with "X" - ** .dt %|X .dd pad to the end of the line with "X" - ** .dt %*X .dd soft-fill with character "X" as pad + ** .dt %>X .dd right justify the rest of the string and pad with ``X'' + ** .dt %|X .dd pad to the end of the line with ``X'' + ** .dt %*X .dd soft-fill with character ``X'' as pad ** .de ** .pp - ** For an explanation of `soft-fill', see the ``$$index_format'' documentation. + ** For an explanation of ``soft-fill'', see the $$index_format documentation. ** .pp ** * = can be optionally printed if nonzero ** .pp @@ -2820,7 +3040,7 @@ struct option_t MuttVars[] = { ** particularly meaningful. To optionally print a string based upon one ** of the above sequences, the following construct is used: ** .pp - ** %??? + ** \fC%???\fP ** .pp ** where \fIsequence_char\fP is a character from the table above, and ** \fIoptional_string\fP is the string you would like printed if @@ -2830,88 +3050,98 @@ struct option_t MuttVars[] = { ** .pp ** Here is an example illustrating how to optionally print the number of ** new messages in a mailbox: - ** %?n?%n new messages.? + ** .pp + ** \fC%?n?%n new messages.?\fP ** .pp ** You can also switch between two strings using the following construct: ** .pp - ** %??&? + ** \fC%??&?\fP ** .pp ** If the value of \fIsequence_char\fP is non-zero, \fIif_string\fP will ** be expanded, otherwise \fIelse_string\fP will be expanded. ** .pp - ** You can force the result of any printf-like sequence to be lowercase - ** by prefixing the sequence character with an underscore (_) sign. + ** You can force the result of any \fCprintf(3)\fP-like sequence to be lowercase + ** by prefixing the sequence character with an underscore (``_'') sign. ** For example, if you want to display the local hostname in lowercase, - ** you would use: - ** %_h + ** you would use: ``\fC%_h\fP''. ** .pp - ** If you prefix the sequence character with a colon (:) character, mutt - ** will replace any dots in the expansion by underscores. This might be helpful + ** If you prefix the sequence character with a colon (``:'') character, mutt + ** will replace any dots in the expansion by underscores. This might be helpful ** with IMAP folders that don't like dots in folder names. */ { "status_on_top", DT_BOOL, R_BOTH, OPTSTATUSONTOP, 0 }, /* ** .pp ** Setting this variable causes the ``status bar'' to be displayed on - ** the first line of the screen rather than near the bottom. + ** the first line of the screen rather than near the bottom. If $$help + ** is \fIset\fP, too it'll be placed at the bottom. */ { "strict_threads", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTSTRICTTHREADS, 0 }, /* ** .pp - ** If set, threading will only make use of the ``In-Reply-To'' and - ** ``References'' fields when you ``$$sort'' by message threads. By + ** If \fIset\fP, threading will only make use of the ``In-Reply-To'' and + ** ``References:'' fields when you $$sort by message threads. By ** default, messages with the same subject are grouped together in ** ``pseudo threads.''. This may not always be desirable, such as in a ** personal mailbox where you might have several unrelated messages with - ** the subject ``hi'' which will get grouped together. See also - ** ``$$sort_re'' for a less drastic way of controlling this + ** the subjects like ``hi'' which will get grouped together. See also + ** $$sort_re for a less drastic way of controlling this ** behaviour. */ { "suspend", DT_BOOL, R_NONE, OPTSUSPEND, 1 }, /* ** .pp ** When \fIunset\fP, mutt won't stop when the user presses the terminal's - ** \fIsusp\fP key, usually ``control-Z''. This is useful if you run mutt - ** inside an xterm using a command like xterm -e mutt. + ** \fIsusp\fP key, usually ``^Z''. This is useful if you run mutt + ** inside an xterm using a command like ``\fCxterm -e mutt\fP''. */ { "text_flowed", DT_BOOL, R_NONE, OPTTEXTFLOWED, 0 }, /* ** .pp - ** When set, mutt will generate text/plain; format=flowed attachments. + ** When \fIset\fP, mutt will generate ``format=flowed'' bodies with a content type + ** of ``\fCtext/plain; format=flowed\fP''. ** This format is easier to handle for some mailing software, and generally - ** just looks like ordinary text. To actually make use of this format's + ** just looks like ordinary text. To actually make use of this format's ** features, you'll need support in your editor. ** .pp - ** Note that $$indent_string is ignored when this option is set. + ** Note that $$indent_string is ignored when this option is \fIset\fP. */ - { "thread_received", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTTHREADRECEIVED, 0 }, + { "thorough_search", DT_BOOL, R_NONE, OPTTHOROUGHSRC, 0 }, /* ** .pp - ** When set, mutt uses the date received rather than the date sent - ** to thread messages by subject. + ** Affects the \fC~b\fP and \fC~h\fP search operations described in + ** section ``$patterns''. If \fIset\fP, the headers and body/attachments of + ** messages to be searched are decoded before searching. If \fIunset\fP, + ** messages are searched as they appear in the folder. + ** .pp + ** Users searching attachments or for non-ASCII characters should \fIset\fP + ** this value because decoding also includes MIME parsing/decoding and possible + ** character set conversions. Otherwise mutt will attempt to match against the + ** raw message received (for example quoted-printable encoded or with encoded + ** headers) which may lead to incorrect search results. */ - { "thorough_search", DT_BOOL, R_NONE, OPTTHOROUGHSRC, 0 }, + { "thread_received", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTTHREADRECEIVED, 0 }, /* ** .pp - ** Affects the \fI~b\fP and \fI~h\fP search operations described in - ** section ``$patterns'' above. If set, the headers and attachments of - ** messages to be searched are decoded before searching. If unset, - ** messages are searched as they appear in the folder. + ** When \fIset\fP, mutt uses the date received rather than the date sent + ** to thread messages by subject. */ { "tilde", DT_BOOL, R_PAGER, OPTTILDE, 0 }, /* ** .pp - ** When set, the internal-pager will pad blank lines to the bottom of the - ** screen with a tilde (~). + ** When \fIset\fP, the internal-pager will pad blank lines to the bottom of the + ** screen with a tilde (``~''). */ { "time_inc", DT_NUM, R_NONE, UL &TimeInc, 0 }, /* ** .pp - ** Along with ``$read_inc'', ``$write_inc'', and ``$net_inc'', this + ** Along with $$read_inc, $$write_inc, and $$net_inc, this ** variable controls the frequency with which progress updates are - ** displayed. It suppresses updates less than ``$time_inc'' milliseconds + ** displayed. It suppresses updates less than $$time_inc milliseconds ** apart. This can improve throughput on systems with slow terminals, ** or when running mutt on a remote system. + ** .pp + ** Also see the ``$tuning'' section of the manual for performance considerations. */ { "timeout", DT_NUM, R_NONE, UL &Timeout, 600 }, /* @@ -2933,22 +3163,22 @@ struct option_t MuttVars[] = { ** .pp ** This variable allows you to specify where Mutt will place its ** temporary files needed for displaying and composing messages. If - ** this variable is not set, the environment variable TMPDIR is - ** used. If TMPDIR is not set then "/tmp" is used. + ** this variable is not set, the environment variable \fC$$$TMPDIR\fP is + ** used. If \fC$$$TMPDIR\fP is not set then ``\fC/tmp\fP'' is used. */ { "to_chars", DT_STR, R_BOTH, UL &Tochars, UL " +TCFL" }, /* ** .pp ** Controls the character used to indicate mail addressed to you. The - ** first character is the one used when the mail is NOT addressed to your - ** address (default: space). The second is used when you are the only - ** recipient of the message (default: +). The third is when your address - ** appears in the TO header field, but you are not the only recipient of - ** the message (default: T). The fourth character is used when your - ** address is specified in the CC header field, but you are not the only + ** first character is the one used when the mail is \fInot\fP addressed to your + ** address. The second is used when you are the only + ** recipient of the message. The third is when your address + ** appears in the ``To:'' header field, but you are not the only recipient of + ** the message. The fourth character is used when your + ** address is specified in the ``Cc:'' header field, but you are not the only ** recipient. The fifth character is used to indicate mail that was sent ** by \fIyou\fP. The sixth character is used to indicate when a mail - ** was sent to a mailing-list you subscribe to (default: L). + ** was sent to a mailing-list you subscribe to. */ #ifdef USE_SOCKET { "tunnel", DT_STR, R_NONE, UL &Tunnel, UL 0 }, @@ -2956,43 +3186,54 @@ struct option_t MuttVars[] = { ** .pp ** Setting this variable will cause mutt to open a pipe to a command ** instead of a raw socket. You may be able to use this to set up - ** preauthenticated connections to your IMAP/POP3 server. Example: - ** .pp - ** tunnel="ssh -q mailhost.net /usr/local/libexec/imapd" + ** preauthenticated connections to your IMAP/POP3/SMTP server. Example: + ** .ts + ** set tunnel="ssh -q mailhost.net /usr/local/libexec/imapd" + ** .te ** .pp - ** NOTE: For this example to work you must be able to log in to the remote + ** Note: For this example to work you must be able to log in to the remote ** machine without having to enter a password. + ** .pp + ** When set, Mutt uses the tunnel for all remote connections. + ** Please see ``$account-hook'' in the manual for how to use different + ** tunnel commands per connection. */ #endif + { "uncollapse_jump", DT_BOOL, R_NONE, OPTUNCOLLAPSEJUMP, 0 }, + /* + ** .pp + ** When \fIset\fP, Mutt will jump to the next unread message, if any, + ** when the current thread is \fIun\fPcollapsed. + */ { "use_8bitmime", DT_BOOL, R_NONE, OPTUSE8BITMIME, 0 }, /* ** .pp ** \fBWarning:\fP do not set this variable unless you are using a version - ** of sendmail which supports the -B8BITMIME flag (such as sendmail + ** of sendmail which supports the \fC-B8BITMIME\fP flag (such as sendmail ** 8.8.x) or you may not be able to send mail. ** .pp - ** When \fIset\fP, Mutt will invoke ``$$sendmail'' with the -B8BITMIME + ** When \fIset\fP, Mutt will invoke $$sendmail with the \fC-B8BITMIME\fP ** flag when sending 8-bit messages to enable ESMTP negotiation. */ { "use_domain", DT_BOOL, R_NONE, OPTUSEDOMAIN, 1 }, /* ** .pp - ** When set, Mutt will qualify all local addresses (ones without the - ** @host portion) with the value of ``$$hostname''. If \fIunset\fP, no + ** When \fIset\fP, Mutt will qualify all local addresses (ones without the + ** ``@host'' portion) with the value of $$hostname. If \fIunset\fP, no ** addresses will be qualified. */ { "use_envelope_from", DT_BOOL, R_NONE, OPTENVFROM, 0 }, /* ** .pp ** When \fIset\fP, mutt will set the \fIenvelope\fP sender of the message. - ** If ``$$envelope_from_address'' is set, it will be used as the sender - ** address. If not, mutt will attempt to derive the sender from the - ** "From:" header. + ** If $$envelope_from_address is \fIset\fP, it will be used as the sender + ** address. If \fIunset\fP, mutt will attempt to derive the sender from the + ** ``From:'' header. ** .pp ** Note that this information is passed to sendmail command using the - ** "-f" command line switch. Therefore setting this option is not useful - ** if the ``$$sendmail'' variable already contains "-f" or if the - ** executable pointed to by $$sendmail doesn't support the "-f" switch. + ** \fC-f\fP command line switch. Therefore setting this option is not useful + ** if the $$sendmail variable already contains \fC-f\fP or if the + ** executable pointed to by $$sendmail doesn't support the \fC-f\fP switch. */ { "envelope_from", DT_SYN, R_NONE, UL "use_envelope_from", 0 }, /* @@ -3000,8 +3241,8 @@ struct option_t MuttVars[] = { { "use_from", DT_BOOL, R_NONE, OPTUSEFROM, 1 }, /* ** .pp - ** When \fIset\fP, Mutt will generate the `From:' header field when - ** sending messages. If \fIunset\fP, no `From:' header field will be + ** When \fIset\fP, Mutt will generate the ``From:'' header field when + ** sending messages. If \fIunset\fP, no ``From:'' header field will be ** generated unless the user explicitly sets one using the ``$my_hdr'' ** command. */ @@ -3019,41 +3260,42 @@ struct option_t MuttVars[] = { /* ** .pp ** When \fIset\fP, Mutt will look for IPv6 addresses of hosts it tries to - ** contact. If this option is unset, Mutt will restrict itself to IPv4 addresses. + ** contact. If this option is \fIunset\fP, Mutt will restrict itself to IPv4 addresses. ** Normally, the default should work. */ #endif /* HAVE_GETADDRINFO */ { "user_agent", DT_BOOL, R_NONE, OPTXMAILER, 1}, /* ** .pp - ** When \fIset\fP, mutt will add a "User-Agent" header to outgoing + ** When \fIset\fP, mutt will add a ``User-Agent:'' header to outgoing ** messages, indicating which version of mutt was used for composing ** them. */ { "visual", DT_PATH, R_NONE, UL &Visual, 0 }, /* ** .pp - ** Specifies the visual editor to invoke when the \fI~v\fP command is + ** Specifies the visual editor to invoke when the ``\fC~v\fP'' command is ** given in the builtin editor. */ { "wait_key", DT_BOOL, R_NONE, OPTWAITKEY, 1 }, /* ** .pp - ** Controls whether Mutt will ask you to press a key after \fIshell- - ** escape\fP, \fIpipe-message\fP, \fIpipe-entry\fP, \fIprint-message\fP, - ** and \fIprint-entry\fP commands. + ** Controls whether Mutt will ask you to press a key after an external command + ** has been invoked by these functions: \fC\fP, + ** \fC\fP, \fC\fP, \fC\fP, + ** and \fC\fP commands. ** .pp ** It is also used when viewing attachments with ``$auto_view'', provided ** that the corresponding mailcap entry has a \fIneedsterminal\fP flag, ** and the external program is interactive. ** .pp - ** When set, Mutt will always ask for a key. When unset, Mutt will wait + ** When \fIset\fP, Mutt will always ask for a key. When \fIunset\fP, Mutt will wait ** for a key only if the external command returned a non-zero status. */ { "weed", DT_BOOL, R_NONE, OPTWEED, 1 }, /* ** .pp - ** When set, mutt will weed headers when displaying, forwarding, + ** When \fIset\fP, mutt will weed headers when displaying, forwarding, ** printing, or replying to messages. */ { "wrap", DT_NUM, R_PAGER, UL &Wrap, 0 }, @@ -3066,36 +3308,37 @@ struct option_t MuttVars[] = { { "wrap_search", DT_BOOL, R_NONE, OPTWRAPSEARCH, 1 }, /* ** .pp - ** Controls whether searches wrap around the end of the mailbox. + ** Controls whether searches wrap around the end. ** .pp - ** When set, searches will wrap around the first (or last) message. When - ** unset, searches will not wrap. + ** When \fIset\fP, searches will wrap around the first (or last) item. When + ** \fIunset\fP, incremental searches will not wrap. */ { "wrapmargin", DT_NUM, R_PAGER, UL &Wrap, 0 }, /* ** .pp - ** (DEPRECATED) Equivalent to setting $wrap with a negative value. + ** (DEPRECATED) Equivalent to setting $$wrap with a negative value. + */ + { "write_bcc", DT_BOOL, R_NONE, OPTWRITEBCC, 1}, + /* + ** .pp + ** Controls whether mutt writes out the ``Bcc:'' header when preparing + ** messages to be sent. Exim users may wish to unset this. If mutt + ** is set to deliver directly via SMTP (see $$smtp_url), this + ** option does nothing: mutt will never write out the ``Bcc:'' header + ** in this case. */ { "write_inc", DT_NUM, R_NONE, UL &WriteInc, 10 }, /* ** .pp ** When writing a mailbox, a message will be printed every - ** \fIwrite_inc\fP messages to indicate progress. If set to 0, only a + ** $$write_inc messages to indicate progress. If set to 0, only a ** single message will be displayed before writing a mailbox. ** .pp - ** Also see the ``$$read_inc'' variable. - */ - { "write_bcc", DT_BOOL, R_NONE, OPTWRITEBCC, 1}, - /* - ** .pp - ** Controls whether mutt writes out the Bcc header when preparing - ** messages to be sent. Exim users may wish to unset this. If mutt - ** is set to deliver directly via SMTP (see ``$$smtp_url''), this - ** option does nothing: mutt will never write out the BCC header - ** in this case. + ** Also see the $$read_inc, $$net_inc and $$time_inc variables and the + ** ``$tuning'' section of the manual for performance considerations. */ /*--*/ - { NULL } + { NULL, 0, 0, 0, 0 } }; const struct mapping_t SortMethods[] = { @@ -3110,7 +3353,7 @@ const struct mapping_t SortMethods[] = { { "to", SORT_TO }, { "score", SORT_SCORE }, { "spam", SORT_SPAM }, - { NULL, 0 } + { NULL, 0 } }; /* same as SortMethods, but with "threads" replaced by "date" */ @@ -3124,28 +3367,28 @@ const struct mapping_t SortAuxMethods[] = { { "from", SORT_FROM }, { "size", SORT_SIZE }, { "threads", SORT_DATE }, /* note: sort_aux == threads - * isn't possible. + * isn't possible. */ { "to", SORT_TO }, { "score", SORT_SCORE }, { "spam", SORT_SPAM }, - { NULL, 0 } + { NULL, 0 } }; - + const struct mapping_t SortBrowserMethods[] = { { "alpha", SORT_SUBJECT }, { "date", SORT_DATE }, { "size", SORT_SIZE }, { "unsorted", SORT_ORDER }, - { NULL } + { NULL, 0 } }; const struct mapping_t SortAliasMethods[] = { { "alias", SORT_ALIAS }, { "address", SORT_ADDRESS }, { "unsorted", SORT_ORDER }, - { NULL } + { NULL, 0 } }; const struct mapping_t SortKeyMethods[] = { @@ -3153,7 +3396,7 @@ const struct mapping_t SortKeyMethods[] = { { "date", SORT_DATE }, { "keyid", SORT_KEYID }, { "trust", SORT_TRUST }, - { NULL } + { NULL, 0 } }; @@ -3194,7 +3437,6 @@ struct command_t char *name; int (*func) (BUFFER *, BUFFER *, unsigned long, BUFFER *); unsigned long data; - unsigned long data1; }; struct command_t Commands[] = { @@ -3222,7 +3464,7 @@ struct command_t Commands[] = { { "ungroup", parse_ungroup, 0 }, { "hdr_order", parse_list, UL &HeaderOrderList }, #ifdef HAVE_ICONV - { "iconv-hook", mutt_parse_hook, M_ICONVHOOK }, + { "iconv-hook", mutt_parse_hook, M_ICONVHOOK }, #endif { "ignore", parse_ignore, 0 }, { "lists", parse_lists, 0 }, @@ -3262,5 +3504,5 @@ struct command_t Commands[] = { { "unscore", mutt_parse_unscore, 0 }, { "unset", parse_set, M_SET_UNSET }, { "unsubscribe", parse_unsubscribe, 0 }, - { NULL } + { NULL, NULL, 0 } };