diff options
| author | Thomas Roessler <roessler@does-not-exist.org> | 1999-08-08 14:00:37 +0000 |
|---|---|---|
| committer | Thomas Roessler <roessler@does-not-exist.org> | 1999-08-08 14:00:37 +0000 |
| commit | 08100e8736043b8894095695a800cb2f46011538 (patch) | |
| tree | 62b50df2831eec4884a82e476e2d1583225c1ba2 /doc | |
| parent | 7cfcaf584ec80529ea41d340ce11d27a5f8627a6 (diff) | |
Documentation updates; autogeneration of documentation from init.h.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.in | 57 | ||||
| -rw-r--r-- | doc/devel-notes.txt | 69 | ||||
| -rw-r--r-- | doc/dotlock.man (renamed from doc/dotlock.man.in) | 0 | ||||
| -rw-r--r-- | doc/manual.sgml (renamed from doc/manual.sgml.in) | 2538 | ||||
| -rw-r--r-- | doc/manual.sgml.head | 2544 | ||||
| -rw-r--r-- | doc/manual.sgml.tail | 359 | ||||
| -rw-r--r-- | doc/mutt.man (renamed from doc/mutt.man.in) | 22 | ||||
| -rw-r--r-- | doc/muttrc.man | 3072 | ||||
| -rw-r--r-- | doc/muttrc.man.head | 379 | ||||
| -rw-r--r-- | doc/muttrc.man.tail | 17 |
10 files changed, 8058 insertions, 999 deletions
diff --git a/doc/Makefile.in b/doc/Makefile.in index 0a8d69b1..552ab471 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -26,12 +26,18 @@ LDFLAGS=@LDFLAGS@ subdir = doc -DISTFILES = Makefile.in dotlock.man.in \ - manual.sgml.in mutt.man.in \ +DISTFILES = Makefile.in dotlock.man \ + mutt.man \ PGP-Notes.txt \ applying-patches.txt \ devel-notes.txt \ - manual.txt + manual.txt \ + muttrc.man.head \ + muttrc.man.tail \ + muttrc.man \ + manual.sgml.head \ + manual.sgml.tail \ + manual.sgml srcdir_DOCFILES = PGP-Notes.txt applying-patches.txt \ devel-notes.txt \ @@ -43,7 +49,7 @@ topsrcdir_DOCFILES = COPYRIGHT GPL INSTALL ChangeLog \ DOCFILES = manual.txt -all: mutt.man dotlock.man try-html try-txt +all: try-html try-txt complete: all html @@ -59,10 +65,12 @@ try-txt: html: manual.html -install: dotlock.man mutt.man all +install: all $(top_srcdir)/mkinstalldirs $(DESTDIR)$(mandir)/man1 + $(top_srcdir)/mkinstalldirs $(DESTDIR)$(mandir)/man5 $(INSTALL) -m 644 mutt.man $(DESTDIR)$(mandir)/man1/mutt.1 $(INSTALL) -m 644 dotlock.man $(DESTDIR)$(mandir)/man1/mutt_dotlock.1 + $(INSTALL) -m 644 muttrc.man $(DESTDIR)$(mandir)/man5/muttrc.5 $(top_srcdir)/mkinstalldirs $(DESTDIR)$(docdir) for f in $(DOCFILES) ; do $(INSTALL) -m 644 $$f $(DESTDIR)$(docdir) ; done for f in $(srcdir_DOCFILES) ; do $(INSTALL) -m 644 $(srcdir)/$$f $(DESTDIR)$(docdir) ; done @@ -78,6 +86,8 @@ install-html: html uninstall: -rm -f $(DESTDIR)$(mandir)/man1/mutt.1 + -rm -f $(DESTDIR)$(mandir)/man1/mutt_dotlock.1 + -rm -f $(DESTDIR)$(mandir)/man5/muttrc.5 -rm -rf $(DESTDIR)$(docdir) manual.txt: manual.sgml @@ -87,7 +97,7 @@ manual.html: manual.sgml sgml2html manual clean: - rm -f *~ *.html *.orig *.rej *.man manual.sgml + rm -f *~ *.html *.orig *.rej stamp-doc-sgml stamp-doc-man clean-real: rm -f manual.txt @@ -101,21 +111,32 @@ Makefile: Makefile.in ../config.status cd .. \ && CONFIG_FILES=$(subdir)/$@ CONFIG_HEADERS= $(SHELL) ./config.status -mutt.man: mutt.man.in ../config.status - cd .. \ - && CONFIG_FILES=$(subdir)/$@ CONFIG_HEADERS= $(SHELL) ./config.status - -dotlock.man: dotlock.man.in ../config.status - cd .. \ - && CONFIG_FILES=$(subdir)/$@ CONFIG_HEADERS= $(SHELL) ./config.status - -manual.sgml: manual.sgml.in ../config.status - cd .. \ - && CONFIG_FILES=$(subdir)/$@ CONFIG_HEADERS= $(SHELL) ./config.status - distdir = ../$(PACKAGE)-$(VERSION)/$(subdir) dist distdir: Makefile $(DISTFILES) for file in $(DISTFILES) ; do \ ln $(srcdir)/$$file $(distdir) 2> /dev/null \ || cp -p $(srcdir)/$$file $(distdir); \ done + +../makedoc: $(top_srcdir)/makedoc.c + (cd .. && make makedoc) + +# hack around autoconf mixing up patterns. +at=@ + +update-doc: ../makedoc stamp-doc-sgml stamp-doc-man + +stamp-doc-man: ../makedoc $(top_srcdir)/init.h muttrc.man.head muttrc.man.tail + cpp -D_MAKEDOC -C -I.. -I $(top_srcdir) -include ../config.h \ + $(top_srcdir)/init.h | ../makedoc -m | \ + cat $(srcdir)/muttrc.man.head - $(srcdir)/muttrc.man.tail\ + > muttrc.man + touch stamp-doc-man + +stamp-doc-sgml: ../makedoc $(top_srcdir)/init.h manual.sgml.head manual.sgml.tail + ( sed -e "s/$(at)VERSION$(at)/`cat $(top_srcdir)/VERSION`/" manual.sgml.head ;\ + cpp -D_MAKEDOC -C -I.. -I $(top_srcdir) -include ../config.h \ + $(top_srcdir)/init.h | ../makedoc -s ) | \ + cat - $(srcdir)/manual.sgml.tail > manual.sgml + touch stamp-doc-sgml + diff --git a/doc/devel-notes.txt b/doc/devel-notes.txt index 3f650817..2ed04e8f 100644 --- a/doc/devel-notes.txt +++ b/doc/devel-notes.txt @@ -1,6 +1,6 @@ Subject: Developers' notes From: Thomas Roessler <roessler@guug.de> -Date: Wed, 21 Oct 1998 17:51:30 +0200 +Date: Fri, 6 Aug 1999 09:09:58 +0200 Required tools @@ -97,10 +97,73 @@ Style Guide Help keep Mutt small! - when adding new options, make the old behaviour the - default. Please include the new option and it's default - setting with the global Muttrc file. + default. - try to keep mutt as portable as possible. +Documentation +------------- + +Please document your changes. Note that there are several places +where you may have to add documentation: + +- doc/manual.smgl.{head,tail} contain The Manual. + +- doc/muttrc.man.{head,tail} contain an abriged version of The + Manual in nroff format (see man(7)), which deals with + configuration file commands. + +Configuration _variables_ are documented directly in init.h. The +parts of The Manual and the muttrc manual page dealing with these +variables, and the global Muttrc, are generated automatically from +that documentation. To start this process, type "make update-doc" +in the top-level source directory. + +Note that you may have to update the makedoc utility (makedoc.c) +when adding new data types to init.h. + +More precisely, variable name, type, and default value are directly +extracted from the initializer for the MuttVars array. Documentation +is exepected in special comments which _follow_ the initializer. +For a line to be included with the documentation, it must (after, +possibly, some white space) begin with with either "/**" or "**". +Any following white space is ignored. The rest of the line is +expected to be plain text, with some formatting instructions roughly +similar to [ntg]roff: + + - \fI switches to italics + + - \fB switches to boldface + + - \fP switches to normal display + + - \(as can be used to represent an asterisk (*). This is intended + to help avoiding character sequences such as /* or */ inside + comments. + + - \(rs can be used to represent a backslash (\). This is intended + to help avoiding poblems when trying to represent any of the \ + sequences used by makedoc. + + - .ts on a line starts a "verbose tscreen" environment (name taken from + SGML). Please try to keep lines inside such an environment + short; a length of abut 40 characters should be ok. This is + necessary to avoid a really bad-looking muttrc (5) manual page. + + - .te on a line finishes this environment. + + - .pp on a line starts a paragraph. + + - $word will be converted to a reference to word, where appropriate. + Note that $$word is possible as well. + + (Not yet implemented in makedoc, but please use it nevertheless + when writing documentation!) + + - '. ' in the beginning of a line expands to two space characters. + This is used to protect indentations in tables. + +Do _not_ use any other SGML or nroff formatting instructions here! + $Id$ diff --git a/doc/dotlock.man.in b/doc/dotlock.man index 18b55bbf..18b55bbf 100644 --- a/doc/dotlock.man.in +++ b/doc/dotlock.man diff --git a/doc/manual.sgml.in b/doc/manual.sgml index 2b71598e..78101512 100644 --- a/doc/manual.sgml.in +++ b/doc/manual.sgml @@ -4,7 +4,7 @@ <title>The Mutt E-Mail Client <author>by Michael Elkins <htmlurl url="mailto:me@cs.hmc.edu" name="<me@cs.hmc.edu>"> -<date>version @VERSION@ +<date>version 0.96.3 <abstract> ``All mail clients suck. This one just sucks less.'' -me, circa 1995 </abstract> @@ -491,6 +491,11 @@ When replying to messages, if you remove the <em/In-Reply-To:/ field from the header field, Mutt will not generate a <em/References:/ field, which allows you to create a new message thread. +Also see <ref id="edit_headers" name="edit_headers">. + +<sect2>Using Mutt with PGP + +<p> If you want to use PGP, you can specify <tt/Pgp:/ [ <tt/E/ | <tt/S/ | <tt/S<id/> ] <newline> @@ -499,7 +504,91 @@ If you want to use PGP, you can specify ``S<id>'' signs with the given key, setting <ref id="pgp_sign_as" name="$pgp_sign_as"> permanently. -Also see <ref id="edit_headers" name="edit_headers">. +If you have told mutt to PGP encrypt a message, it will guide you +through a key selection process when you try to send the message. +Mutt will not ask you any questions about keys which have a +certified user ID matching one of the message recipients' mail +addresses. However, there may be situations in which there are +several keys, weakly certified user ID fields, or where no matching +keys can be found. + +In these cases, you are dropped into a menu with a list of keys from +which you can select one. When you quit this menu, or mutt can't +find any matching keys, you are prompted for a user ID. You can, as +usually, abort this prompt using <tt/^G/. When you do so, mutt will +return to the compose screen. + +Once you have successfully finished the key selection, the message +will be encrypted using the selected public keys, and sent out. + +Most fields of the entries in the key selection menu (see also <ref +id="pgp_entry_format" name="$pgp_entry_format">) +have obvious meanings. But some explanations on the capabilities, flags, +and validity fields are in order. + +The flags sequence (%f) will expand to one of the following flags: +<tscreen><verb> +R The key has been revoked and can't be used. +X The key is expired and can't be used. +d You have marked the key as disabled. +c There are unknown critical self-signature + packets. +</verb></tscreen> + +The capabilities field (%c) expands to a two-character sequence +representing a key's capabilities. The first character gives +the key's encryption capabilities: A minus sign (<bf/-/) means +that the key cannot be used for encryption. A dot (<bf/./) means that +it's marked as a signature key in one of the user IDs, but may +also be used for encryption. The letter <bf/e/ indicates that +this key can be used for encryption. + +The second character indicates the key's signing capabilities. Once +again, a ``<bf/-/'' implies ``not for signing'', ``<bf/./'' implies +that the key is marked as an encryption key in one of the user-ids, and +``<bf/s/'' denotes a key which can be used for signing. + +Finally, the validity field (%t) indicates how well-certified a user-id +is. A question mark (<bf/?/) indicates undefined validity, a minus +character (<bf/-/) marks an untrusted association, a space character +means a partially trusted association, and a plus character (<bf/+/) +indicates complete validity. + +<sect2>Sending anonymous messages via mixmaster. + +<p> +You may also have configured mutt to co-operate with Mixmaster, an +anonymous remailer. Mixmaster permits you to send your messages +anonymously using a chain of remailers. + +To use it, you'll have to obey certain restrictions. Most +important, you cannot ues the <tt/Cc/ and <tt/Bcc/ headers. To tell +Mutt to use mixmaster, you have to select a remailer chain, using +the mix function on the compose menu. + +The chain selection screen is divided into two parts. In the +(larger) upper part, you get a list of remailers you may use. In +the lower part, you see the currently selected chain of remailers. + +You can navigate in the chain using the <tt/chain-prev/ and +<tt/chain-next/ functions, which are by default bound to the left +and right arrows and to the <tt/h/ and <tt/l/ keys (think vi +keyboard bindings). To insert a remailer at the current chain +position, use the <tt/insert/ function. To append a remailer behind +the current chain position, use <tt/select-entry/ or <tt/append/. +You can also delete entries from the chain, using the corresponding +function. Finally, to abandon your changes, leave the menu, or +<tt/accept/ them pressing (by default) the <tt/Return/ key. + +Note that different remailers do have different capabilities, +indicated in the %c entry of the remailer menu lines (see +<ref id="mix_entry_format" +name="$mix_etry_format">). Most important is +the ``middleman'' capability, indicated by a capital ``M'': This +means that the remailer in question cannot be used as the final +element of a chain, but will only forward messages to other +mixmaster remailers. For details on the other capabilities, please +have a look at the mixmaster documentation. <sect1>Forwarding and Bouncing Mail<label id="forwarding_mail"> <p> @@ -529,10 +618,9 @@ respectively. The desired forwarding format may depend on the content, therefore <em/$mime_forward/ is a quadoption which, for example, can be set to ``ask-no''. -Messages are always forwarded with full headers, except when -$mime_forward=no, $forward_decode=yes and -<ref id="forward_weed" name="$forward_weed">=yes (which -is the default). +The inclusion of headers is controlled by the current setting of the +<ref id="weed" name="$weed"> variable, unless <ref +id="mime_forward" name="mime_forward"> is set. Editing the message to forward follows the same procedure as sending or replying to a message does. @@ -570,7 +658,7 @@ suit your own tastes. When Mutt is first invoked, it will attempt to read the ``system'' configuration file (defaults set by your local system administrator), unless the ``-n'' <ref id="commandline" name="command line"> option is specified. This file is typically -<tt>@sharedir@/Muttrc</tt> or <tt>@sysconfdir@/Muttrc</tt>. Mutt +<tt>/usr/local/share/mutt/Muttrc</tt> or <tt>/etc/Muttrc</tt>. Mutt will next look for a file named <tt>.muttrc</tt> in your home directory. If this file does not exist and your home directory has a subdirectory named <tt/.mutt/, mutt try to load a file named @@ -779,6 +867,14 @@ For a complete list of functions, see the <ref id="functions" name="reference">. The special function <tt/noop/ unbinds the specify key sequence. +<sect1>Defining aliases for character sets <label id="charset-hook"> +<p> +Usage: <tt/charset-hook/ <em/alias/ <em/charset/ + +This command defines an alias for a character set. This is useful +to properly display messages which are tagged with a character set +name not known to mutt. + <sect1>Setting variables based upon mailbox<label id="folder-hook"> <p> Usage: <tt/folder-hook/ [!]<em/regexp/ <em/command/ @@ -958,22 +1054,34 @@ unignore posted-to: <sect1>Mailing lists<label id="lists"> <p> -Usage: <tt/[un]lists/ <em/address/ [ <em/address/ ... ] +Usage: <tt/[un]lists/ <em/address/ [ <em/address/ ... ]<newline> +Usage: <tt/[un]subscribe/ <em/address/ [ <em/address/ ... ] Mutt has a few nice features for <ref id="using_lists" name="handling mailing lists">. In order to take advantage of them, you must specify which addresses -belong to mailing lists. +belong to mailing lists, and which mailing lists you are subscribed +to. + +More precisely, Mutt maintains lists of known and subscribed mailing +lists. Obviously, every subscribed mailing list is known. To mark +a mailing list as known, use the ``lists'' command. To mark it as +subscribed, use ``subscribe''. Specify as much of the address as you need to to remove ambiguity. For example, if you've subscribed to the Mutt mailing list, you will receive mail addresssed to <em/mutt-users@mutt.org/. So, to tell Mutt that this is a -mailing list, you could add ``lists mutt-users'' to your initialization file. +mailing list, you could add ``lists mutt-users'' to your +initialization file. To tell mutt that you are subscribed to it, +add ``subscribe mutt-users'' to your initialization file. If you also happen to get mail from someone whose address is <em/mutt-users@example.com/. you could use ``lists mutt-users@mutt.org'' to match only mail from the actual list. -The ``unlists'' command is to remove a token from the list of mailing-lists. -Use ``unlists *'' to remove all tokens. +The ``unlists'' command is used to remove a token from the list of +mailing-lists. Use ``unlists *'' to remove all tokens. To mark a +mailing list which is subscribed as known, but unsubscribed, use the +``unsubscribe'' command. + <sect1>Using Multiple spool mailboxes<label id="mbox-hook"> <p> @@ -1724,15 +1832,17 @@ name="default save folder"> as determined by the address of the alias <sect1>Handling Mailing Lists<label id="using_lists"> <p> -Mutt has a few configuration options that make dealing with large amounts of -mail easier. The first thing you must do is to let Mutt know what addresses -you consider to be mailing lists (technically this does not have to be a -mailing list, but that is what it is most often used for). This is -accomplished through the use of the <ref id="lists" name="lists"> command in -your muttrc. +Mutt has a few configuration options that make dealing with large +amounts of mail easier. The first thing you must do is to let Mutt +know what addresses you consider to be mailing lists (technically +this does not have to be a mailing list, but that is what it is most +often used for), and what lists you are subscribed to. This is +accomplished through the use of the <ref id="lists" name="lists"> +and <ref id="lists" name="subscribe"> commands in your muttrc. Now that Mutt knows what your mailing lists are, it can do several -things, the first of which is the ability to show the list name in +things, the first of which is the ability to show the name of a list +through which you received a message (i.e., of a subscribed list) in the <em/index/ menu display. This is useful to distinguish between personal and list mail in the same mailbox. In the <ref id="index_format" name="$index_format"> variable, the escape ``%L'' @@ -1740,12 +1850,30 @@ will return the string ``To <list>'' when ``list'' appears in the ``To'' field, and ``Cc <list>'' when it appears in the ``Cc'' field (otherwise it returns the name of the author). -Often times the ``To'' and ``Cc'' fields in mailing list messages tend to -get quite large. Most people do not bother to remove the author of the -message they are reply to from the list, resulting in two or more copies -being sent to that person. The ``list-reply'' function, which by default is -bound to ``L'' in the <em/index/ menu and <em/pager/, helps reduce the clutter -by only replying to the mailing list addresses instead of all recipients. +Often times the ``To'' and ``Cc'' fields in mailing list messages +tend to get quite large. Most people do not bother to remove the +author of the message they are reply to from the list, resulting in +two or more copies being sent to that person. The ``list-reply'' +function, which by default is bound to ``L'' in the <em/index/ menu +and <em/pager/, helps reduce the clutter by only replying to the +known mailing list addresses instead of all recipients. + +As an alternative, mutt supports the <tt/Mail-Followup-To/ header. +When you send a message to a list of recipients which includes one +or several subscribed mailing lists, and if the <ref +id="followup_to" name="$followup_to"> option is set, +mutt will generate a Mail-Followup-To header which contains all the +recipients to whom you send this message, but not your address. This +indicates that group-replies to this message should only be sent to +the original recipients of the message, and not separately to you - +you'll receive your copy through one of the mailing lists you are +subscribed to. + +Conversely, when group-replying to a message which has a +<tt/Mail-Followup-To/ header, mutt will respect this header if the +<ref id="honor_followup_to" +name="$honor_followup_to"> configuration +variable is set. The other method some mailing list admins use is to generate a ``Reply-To'' field which points back to the mailing list address rather @@ -1944,8 +2072,8 @@ can be changed with the <tt/edit-description/ command (default: d). <p> When you add an attachment to your mail message, Mutt searches your personal mime.types file at <tt>${HOME}/.mime.types</tt>, and then -the system mime.types file at <tt>@sharedir@/mime.types</tt> or -<tt>@sysconfdir@/mime.types</tt> +the system mime.types file at <tt>/usr/local/share/mutt/mime.types</tt> or +<tt>/etc/mime.types</tt> The mime.types file consist of lines containing a MIME type and a space separated list of extensions. For example: @@ -1982,7 +2110,7 @@ internally, Mutt parses a series of external configuration files to find an external handler. The default search string for these files is a colon delimited list set to <tscreen><verb> -${HOME}/.mailcap:@sharedir@/mailcap:@sysconfdir@/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap +${HOME}/.mailcap:/usr/local/share/mutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap </verb></tscreen> where <tt/$HOME/ is your home directory. @@ -2414,111 +2542,136 @@ The following are the commands understood by mutt. <sect1>Configuration variables<label id="variables"> <p> + <sect2>abort_nosubject<label id="abort_nosubject"> <p> Type: quadoption<newline> Default: ask-yes -If set to <em/yes/, when composing messages and no subject is given -at the subject prompt, composition will be aborted. If set to <em/no/, -composing messages with no subject given at the subject prompt will -never be aborted. +<p> +If set to <em>yes</em>, when composing messages and no subject is given +at the subject prompt, composition will be aborted. If set to +<em>no</em>, composing messages with no subject given at the subject +prompt will never be aborted. + <sect2>abort_unmodified<label id="abort_unmodified"> <p> Type: quadoption<newline> Default: yes -If set to <em/yes/, composition will automatically abort after editing the -message body if no changes are made to the file (this check only happens -after the <em/first/ edit of the file). When set to <em/no/, composition -will never be aborted. +<p> +If set to <em>yes</em>, composition will automatically abort after +editing the message body if no changes are made to the file (this +check only happens after the <em>first</em> edit of the file). When set +to <em>no</em>, composition will never be aborted. + <sect2>alias_file<label id="alias_file"> <p> -Type: string<newline> -Default: ˜/.muttrc +Type: path<newline> +Default: &dquot;~/.muttrc&dquot; -The default file in which to save aliases created by the -<ref id="create-alias" name="create-alias"> function. +<p> +The default file in which to save aliases created by the +``create-alias'' function. +<p> +<bf>Note:</bf> Mutt will not automatically source this file; you must +explicitly use the ``source'' command for it to be executed. -<bf/Note:/ Mutt will not automatically source this file; you must -explicitly use the <ref id="source" name="source"> command for it to be -executed. <sect2>alias_format<label id="alias_format"> <p> Type: string<newline> -Default: &dquot;%2n %t %-10a %r&dquot; +Default: &dquot;%4n %t %-10a %r&dquot; +<p> Specifies the format of the data displayed for the `alias' menu. The -following printf(3)-style sequences are available. +following printf(3)-style sequences are available: +<p> -<verb> +<tscreen><verb> %a alias name %n index number %r address which alias expands to -%t character which indicates if the alias is tagged for inclusion (*/ ) -</verb> +%t character which indicates if the alias is + tagged for inclusion + +</verb></tscreen> -<sect2>allow_8bit +<sect2>allow_8bit<label id="allow_8bit"> <p> Type: boolean<newline> -Default: set +Default: yes + +<p> +Controls whether 8-bit data is converted to 7-bit using either Quoted- +Printable or Base64 encoding when sending mail. -Controls whether 8-bit data is converted to 7-bit using either Quoted-Printable -or Base64 encoding when sending mail. <sect2>alternates<label id="alternates"> <p> -Type: string<newline> -Default: none +Type: regular expression<newline> +Default: &dquot;&dquot; + +<p> +A regexp that allows you to specify <em>alternate</em> addresses where +you receive mail. This affects Mutt's idea about messages from you +and addressed to you. -A regexp that allows you to specify <em/alternate/ addresses where you -receive mail. This affects Mutt's idea about messages from you and -addressed to you. <sect2>arrow_cursor<label id="arrow_cursor"> <p> Type: boolean<newline> -Default: unset +Default: no + +<p> +When set, an arrow (``->'') will be used to indicate the current entry +in menus instead of hiliting 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 +in the menu. -When set, an arrow (``->'') will be used to indicate the current entry in -menus instead of hiliting 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 in the menu. <sect2>ascii_chars<label id="ascii_chars"> <p> Type: boolean<newline> -Default: unset +Default: no + +<p> +If set, Mutt will use plain ASCII characters when displaying thread +and attachment trees, instead of the default <em>ACS</em> characters. -If set, Mutt will use plain ASCII characters when displaying thread and -attachment trees, instead of the default <em/ACS/ characters. <sect2>askbcc<label id="askbcc"> <p> Type: boolean<newline> -Default: unset +Default: no + +<p> +If set, Mutt will prompt you for blind-carbon-copy (Bcc) recipients +before editing an outgoing message. -If set, Mutt will prompt you for blind-carbon-copy (Bcc) recipients before -editing an outgoing message. <sect2>askcc<label id="askcc"> <p> Type: boolean<newline> -Default: unset +Default: no + +<p> +If set, Mutt will prompt you for carbon-copy (Cc) recipients before +editing the body of an outgoing message. -If set, Mutt will prompt you for carbon-copy (Cc) recipients before editing -the body of an outgoing message. <sect2>attach_format<label id="attach_format"> <p> -Type: format string<newline> -Default: &dquot;%u%D%t%2n %T%.40d%> [%.7m/%.10M, %.6e, %s] &dquot; +Type: string<newline> +Default: &dquot;%u%D%t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] &dquot; +<p> This variable describes the format of the `attachment' menu. The following printf-style sequences are understood: +<p> <tscreen><verb> %D deleted flag @@ -2531,283 +2684,367 @@ following printf-style sequences are understood: %s size %t tagged flag %u unlink (=to delete) flag +%>X right justify the rest of the + string and pad with character "X" +%|X pad to the end of the line with + character "X" -%>X right justify the rest of the string and pad with character "X" -%|X pad to the end of the line with character "X" </verb></tscreen> <sect2>attach_sep<label id="attach_sep"> <p> Type: string<newline> -Default: newline +Default: &dquot;\n&dquot; +<p> The separator to add between attachments when operating (saving, printing, piping, etc) on a list of tagged attachments. + <sect2>attach_split<label id="attach_split"> <p> Type: boolean<newline> -Default: set +Default: yes +<p> If this variable is unset, 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 <ref -id="attach_sep" name="$attach_sep"> separator is added -after each attachment. When set, Mutt will operate on the attachments -one by one. +attachments and will operate on them as a single attachment. The +``attach_sep'' separator is added after each attachment. When set, +Mutt will operate on the attachments one by one. + <sect2>attribution<label id="attribution"> <p> -Type: format string<newline> +Type: string<newline> Default: &dquot;On %d, %n wrote:&dquot; -This is the string that will precede a message which has been included in -a reply. For a full listing of defined escape sequences -see the section on <ref id="index_format" name="$index_format">. +<p> +This is the string that will precede a message which has been included +in a reply. For a full listing of defined escape sequences see the +section on ``index_format''. + <sect2>autoedit<label id="autoedit"> <p> Type: boolean<newline> -Default: unset +Default: no -When set, Mutt will skip the initial send-menu and allow you to immediately -begin editing the body of your message when replying to another message. -The send-menu may still be accessed once you have finished editing the body -of your message. +<p> +When set, Mutt will skip the initial send-menu and allow you to +immediately begin editing the body of your message when replying to +another message. The send-menu may still be accessed once you have +finished editing the body of your message. +<p> +If the ``edit_headers'' variable is also set, the initial prompts in +the send-menu are always skipped, even when composing a new message. -If the <ref id="edit_headers" name="$edit_headers"> variable is -also set, the initial prompts in the send-menu are always skipped, even -when composing a new message. <sect2>auto_tag<label id="auto_tag"> <p> Type: boolean<newline> -Default: unset +Default: no + +<p> +When set, functions in the <em>index</em> 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: &dquot;;&dquot;) to +make the next function apply to all tagged messages. -When set, functions in the <em/index/ 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. <sect2>beep<label id="beep"> <p> Type: boolean<newline> -Default: set +Default: yes +<p> When this variable is set, mutt will beep when an error occurs. + <sect2>beep_new<label id="beep_new"> <p> -Type boolean<newline> -Default: unset +Type: boolean<newline> +Default: no + +<p> +When this variable is set, mutt will beep whenever it prints a message +notifying you of new mail. This is independent of the setting of the +``beep'' variable. -When this variable is set, mutt will beep whenever it prints a -message notifying you of new mail. This is independent of the -setting of the <ref id="beep" name="beep"> variable. <sect2>bounce_delivered<label id="bounce_delivered"> <p> -Type boolean<newline> -Default: set +Type: boolean<newline> +Default: yes + +<p> +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 set, mutt will include Delivered-To headers -when bouncing messages. Postfix users may wish to unset this -variable. <sect2>charset<label id="charset"> <p> Type: string<newline> -Default: iso-8859-1 +Default: &dquot;iso-8859-1&dquot; + +<p> +Character set your terminal uses to display and enter textual data. +This information is required to properly label outgoing messages which +contain 8-bit characters so that receiving parties can display your +messages in the correct character set. -Character set your terminal uses to display and enter textual data. This -information is required to properly label outgoing messages which contain -8-bit characters so that receiving parties can display your messages in the -correct character set. <sect2>check_new<label id="check_new"> <p> Type: boolean<newline> -Default: set +Default: yes -<bf/Note:/ this option only affects <em/maildir/ and <em/MH/ style +<p> +<bf>Note:</bf> this option only affects <em>maildir</em> and <em>MH</em> style mailboxes. +<p> +When <em>set</em>, Mutt will check for new mail delivered while the +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 +<em>check_new</em> is <em>unset</em>, no check for new mail is performed +while the mailbox is open. -When <em/set/, Mutt will check for new mail delivered while the 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 <em/check_new/ -is <em/unset/, no check for new mail is performed while the mailbox is -open. <sect2>collapse_unread<label id="collapse_unread"> <p> Type: boolean<newline> -Default: set +Default: yes -When <em/unset/, Mutt will not collapse a thread if it contains any +<p> +When <em>unset</em>, Mutt will not collapse a thread if it contains any unread messages. + +<sect2>uncollapse_jump<label id="uncollapse_jump"> +<p> +Type: boolean<newline> +Default: no + +<p> +When <em>set</em>, Mutt will jump to the next unread message, if any, +when the current thread is <em>un</em>collapsed. + + <sect2>confirmappend<label id="confirmappend"> <p> Type: boolean&l |