On Friday, 29 July 2005 at 15:06, Brendan Cully wrote: > On Wednesday, 27 July 2005 at 08:54, Brendan Cully wrote: > > On Wednesday, 27 July 2005 at 10:44, David Champion wrote: > > > I would propose that one person take existing documentation files and do > > > any translation that can be done by script, producing something roughly > > > approximating docbook. Then he or she would parcel these files up into > > > manageable chunks and hand them out to volunteers. The volunteers > > > could then send their parcels to a second-stage proofreader, who would > > > pass them back to the first person to be reassembled. This way it > > > doesn't become an overwhelming task for one or two people, but something > > > achievable by distributed means. > > > > > > That first person would need to be familiar with docbook, though. :) > > > > A lot of this can probably be done simply by running sgmltools -b > > lb2db on the sgml files. Then the proofreading and hand tuning kicks > > in. The other task is to rewrite makedoc to produce docbook > > output. This is also probably pretty straightforward, but it does > > require learning docbook first. I learned enough to be dangerous a > > while ago, but have since forgotten it all... > > I've played around with this a little bit and it doesn't look like the > ld2db output is quite functional. I'd have to dig into docbook a bit > more to figure out how easily those errors can be resolved. Here's a first draft. All I can say about it is it renders to HTML (with xsltproc). It's not ready to replace the current system, and a bunch of the cross-references are currently broken, but it's a starting point. I think the rest of the work is going to end up being manual. I'd also like to point out that I really have no idea what I'm doing with docbook.
diff -r e1ed910b6103 doc/manual.sgml.head
--- a/doc/manual.sgml.head Sat Jul 30 11:42:36 2005
+++ b/doc/manual.sgml.head Fri Jul 29 23:04:50 2005
@@ -1,111 +1,224 @@
-<!doctype linuxdoc system>
-
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
<article>
-<title>The Mutt E-Mail Client
-<author>by Michael Elkins <htmlurl url="mailto:me@xxxxxxxxxx";
name="<me@xxxxxxxxxx>">
-<date>version @VERSION@
-<abstract>
-``All mail clients suck. This one just sucks less.'' -me, circa 1995
-</abstract>
-
-<toc>
-
-<sect>Introduction
-<p>
-<bf/Mutt/ is a small but very powerful text-based MIME mail client. Mutt is
+<artheader>
+ <title>The Mutt E-Mail Client</title>
+ <author>
+ <firstname>Michael</firstname>
+ <surname>Elkins</surname>
+ <authorblurb>
+ <para>
+ <ulink url="mailto:me@xxxxxxxxxx";><me@xxxxxxxxxx></ulink>
+ </para>
+ </authorblurb>
+ </author>
+ <pubdate>version @VERSION@</pubdate>
+
+ <abstract>
+ <para>
+ ``All mail clients suck. This one just sucks less.'' -me, circa 1995
+ </para>
+ </abstract>
+</artheader>
+
+<sect1>
+<title>Introduction</title>
+
+<para>
+<emphasis remap="bf">Mutt</emphasis> is a small but very powerful text-based
MIME mail client. Mutt is
highly configurable, and is well suited to the mail power user with advanced
features like key bindings, keyboard macros, mail threading, regular
expression searches and a powerful pattern matching language for selecting
groups of messages.
-
-<sect1>Mutt Home Page
-<p>
-<htmlurl url="http://www.mutt.org/";
-name="http://www.mutt.org/";>
-
-<sect1>Mailing Lists
-<p>
+</para>
+
+<sect2>
+<title>Mutt Home Page</title>
+
+<para>
+<ulink
+URL="http://www.mutt.org/";
+>http://www.mutt.org/</ulink
+>
+</para>
+
+</sect2>
+
+<sect2>
+<title>Mailing Lists</title>
+
+<para>
To subscribe to one of the following mailing lists, send a message with the
-word <em/subscribe/ in the body to
-<tt/list-name/<em/-request/<tt/@mutt.org/.
-
-<itemize>
-<item><htmlurl url="mailto:mutt-announce-request@xxxxxxxx";
-name="mutt-announce@xxxxxxxx"> -- low traffic list for announcements
-<item><htmlurl url="mailto:mutt-users-request@xxxxxxxx";
-name="mutt-users@xxxxxxxx"> -- help, bug reports and feature requests
-<item><htmlurl url="mailto:mutt-dev-request@xxxxxxxx";
name="mutt-dev@xxxxxxxx"> -- development mailing list
-</itemize>
-
-<bf/Note:/ all messages posted to <em/mutt-announce/ are automatically
-forwarded to <em/mutt-users/, so you do not need to be subscribed to both
+word <emphasis>subscribe</emphasis> in the body to
+<literal remap="tt">list-name</literal><emphasis>-request</emphasis><literal
remap="tt">@mutt.org</literal>.
+</para>
+
+<para>
+
+<itemizedlist>
+<listitem>
+
+<para>
+<ulink
+URL="mailto:mutt-announce-request@xxxxxxxx";
+>mutt-announce@xxxxxxxx</ulink
+> -- low traffic list for announcements
+</para>
+</listitem>
+<listitem>
+
+<para>
+<ulink
+URL="mailto:mutt-users-request@xxxxxxxx";
+>mutt-users@xxxxxxxx</ulink
+> -- help, bug reports and feature requests
+</para>
+</listitem>
+<listitem>
+
+<para>
+<ulink
+URL="mailto:mutt-dev-request@xxxxxxxx";
+>mutt-dev@xxxxxxxx</ulink
+> -- development mailing list
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> all messages posted to
<emphasis>mutt-announce</emphasis> are automatically
+forwarded to <emphasis>mutt-users</emphasis>, so you do not need to be
subscribed to both
lists.
-
-<sect1>Software Distribution Sites
-<p>
-<itemize>
-<item><htmlurl url="ftp://ftp.mutt.org/mutt/";
-name="ftp://ftp.mutt.org/mutt/";>
-</itemize>
-<p>
-For a list of mirror sites, please refer to <htmlurl
-url="http://www.mutt.org/download.html";
-name="http://www.mutt.org/download.html";>.
-
-<sect1>IRC
-<p>
-Visit channel <em/#mutt/ on <htmlurl
-url="http://www.freenode.net/"; name="irc.freenode.net
-(www.freenode.net)"> to chat with other people interested in Mutt.
-
-<sect1>USENET
-<p>
-See the newsgroup <htmlurl url="news:comp.mail.mutt"; name="comp.mail.mutt">.
-
-<sect1>Copyright
-<p>
+</para>
+
+</sect2>
+
+<sect2>
+<title>Software Distribution Sites</title>
+
+<para>
+
+<itemizedlist>
+<listitem>
+
+<para>
+<ulink
+URL="ftp://ftp.mutt.org/mutt/";
+>ftp://ftp.mutt.org/mutt/</ulink
+>
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+<para>
+For a list of mirror sites, please refer to <ulink
+URL="http://www.mutt.org/download.html";
+>http://www.mutt.org/download.html</ulink
+>.
+</para>
+
+</sect2>
+
+<sect2>
+<title>IRC</title>
+
+<para>
+Visit channel <emphasis>#mutt</emphasis> on <ulink
+URL="http://www.freenode.net/";
+>irc.freenode.net (www.freenode.net)</ulink
+> to chat with other people interested in Mutt.
+</para>
+
+</sect2>
+
+<sect2>
+<title>USENET</title>
+
+<para>
+See the newsgroup <ulink
+URL="news:comp.mail.mutt";
+>comp.mail.mutt</ulink
+>.
+</para>
+
+</sect2>
+
+<sect2>
+<title>Copyright</title>
+
+<para>
Mutt is Copyright (C) 1996-2000 Michael R. Elkins
<me@xxxxxxxxxx> and others
-
+</para>
+
+<para>
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.
-
+</para>
+
+<para>
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.
-
+</para>
+
+<para>
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
-
-<sect>Getting Started
-<p>
-
+</para>
+
+</sect2>
+
+</sect1>
+
+<sect1>
+<title>Getting Started</title>
+
+<para>
This section is intended as a brief overview of how to use Mutt. There are
many other features which are described elsewhere in the manual. There
is even more information available in the Mutt FAQ and various web
-pages. See the <htmlurl url="http://www.mutt.org/mutt/";
-name="Mutt Page"> for more details.
-
+pages. See the <ulink
+URL="http://www.mutt.org/mutt/";
+>Mutt Page</ulink
+> for more details.
+</para>
+
+<para>
The keybindings described in this section are the defaults as distributed.
Your local system administrator may have altered the defaults for your site.
You can always type ``?'' in any menu to display the current bindings.
-
+</para>
+
+<para>
The first thing you need to do is invoke mutt, simply by typing mutt
at the command line. There are various command-line options, see
-either the mutt man page or the <ref id="commandline" name="reference">.
-
-<sect1>Moving Around in Menus
-<p>
-
+either the mutt man page or the <xref linkend="commandline"/>.
+</para>
+
+<sect2>
+<title>Moving Around in Menus</title>
+
+<para>
Information is presented in menus, very similar to ELM. Here is a table
showing the common keys used to navigate menus in Mutt.
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
j or Down next-entry move to the next entry
k or Up previous-entry move to the previous entry
z or PageDn page-down go to the next page
@@ -114,60 +227,84 @@
* or End last-entry jump to the last entry
q quit exit the current menu
? help list all keybindings for the current menu
-</verb></tscreen>
-
-<sect1>Editing Input Fields<label id="editing">
-<p>
+</screen>
+
+</para>
+
+</sect2>
+
+<sect2 id="editing">
+<title>Editing Input Fields</title>
+
+<para>
Mutt has a builtin line editor which is used as the primary way to input
textual data such as email addresses or filenames. The keys used to move
around while editing are very similar to those of Emacs.
-
-<tscreen><verb>
-^A or <Home> bol move to the start of the line
-^B or <Left> backward-char move back one char
+</para>
+
+<para>
+
+<screen>
+^A or <Home> bol move to the start of the line
+^B or <Left> backward-char move back one char
Esc B backward-word move back one word
-^D or <Delete> delete-char delete the char under the cursor
-^E or <End> eol move to the end of the line
-^F or <Right> forward-char move forward one char
+^D or <Delete> delete-char delete the char under the cursor
+^E or <End> eol move to the end of the line
+^F or <Right> forward-char move forward one char
Esc F forward-word move forward one word
-<Tab> complete complete filename or alias
+<Tab> complete complete filename or alias
^T complete-query complete address with query
^K kill-eol delete to the end of the line
ESC d kill-eow delete to the end ot the word
^W kill-word kill the word in front of the cursor
^U kill-line delete entire line
^V quote-char quote the next typed key
-<Up> history-up recall previous string from history
-<Down> history-down recall next string from history
-<BackSpace> backspace kill the char in front of the cursor
+<Up> history-up recall previous string from history
+<Down> history-down recall next string from history
+<BackSpace> backspace kill the char in front of the cursor
Esc u upcase-word convert word to upper case
Esc l downcase-word convert word to lower case
Esc c capitalize-word capitalize the word
^G n/a abort
-<Return> n/a finish editing
-</verb></tscreen>
-
-You can remap the <em/editor/ functions using the <ref id="bind" name="bind">
-command. For example, to make the <em/Delete/ key delete the character in
+<Return> n/a finish editing
+</screen>
+
+</para>
+
+<para>
+You can remap the <emphasis>editor</emphasis> functions using the
+<xref linkend="bind"/>
+command. For example, to make the <emphasis>Delete</emphasis> key delete the
character in
front of the cursor rather than under, you could use
-
-<tt/bind editor <delete> backspace/
-
-<sect1>Reading Mail - The Index and Pager
-<p>
-
+</para>
+
+<para>
+<literal remap="tt">bind editor <delete> backspace</literal>
+</para>
+
+</sect2>
+
+<sect2>
+<title>Reading Mail - The Index and Pager</title>
+
+<para>
Similar to many other mail clients, there are two modes in which mail is
read in Mutt. The first is the index of messages in the mailbox, which is
called the ``index'' in Mutt. The second mode is the display of the
message contents. This is called the ``pager.''
-
+</para>
+
+<para>
The next few sections describe the functions provided in each of these
modes.
-
-<sect2>The Message Index
-<p>
-
-<tscreen><verb>
+</para>
+
+<sect3>
+<title>The Message Index</title>
+
+<para>
+
+<screen>
c change to a different mailbox
ESC c change to a folder in read-only mode
C copy the current message to another mailbox
@@ -189,68 +326,212 @@
u undelete-message
v view-attachments
x abort changes and exit
-<Return> display-message
-<Tab> jump to the next new message
+<Return> display-message
+<Tab> jump to the next new message
@ show the author's full e-mail address
$ save changes to mailbox
/ search
ESC / search-reverse
^L clear and redraw the screen
^T untag messages matching a pattern
-</verb></tscreen>
-
-<sect3>Status Flags
-<p>
-
+</screen>
+
+</para>
+
+<sect4>
+<title>Status Flags</title>
+
+<para>
In addition to who sent the message and the subject, a short summary of
the disposition of each message is printed beside the message number.
Zero or more of the following ``flags'' may appear, which mean:
-
-<p>
-<descrip>
-<tag/D/ message is deleted (is marked for deletion)
-<tag/d/ message have attachments marked for deletion
-<tag/K/ contains a PGP public key
-<tag/N/ message is new
-<tag/O/ message is old
-<tag/P/ message is PGP encrypted
-<tag/r/ message has been replied to
-<tag/S/ message is signed, and the signature is succesfully verified
-<tag/s/ message is signed
-<tag/!/ message is flagged
-<tag/*/ message is tagged
-</descrip>
-
+</para>
+
+<para>
+<variablelist>
+
+<varlistentry>
+<term>D</term>
+<listitem>
+<para>
+message is deleted (is marked for deletion)
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>d</term>
+<listitem>
+<para>
+message have attachments marked for deletion
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>K</term>
+<listitem>
+<para>
+contains a PGP public key
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>N</term>
+<listitem>
+<para>
+message is new
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>O</term>
+<listitem>
+<para>
+message is old
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>P</term>
+<listitem>
+<para>
+message is PGP encrypted
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>r</term>
+<listitem>
+<para>
+message has been replied to
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>S</term>
+<listitem>
+<para>
+message is signed, and the signature is succesfully verified
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>s</term>
+<listitem>
+<para>
+message is signed
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>!</term>
+<listitem>
+<para>
+message is flagged
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>*</term>
+<listitem>
+<para>
+message is tagged
+</para>
+</listitem>
+</varlistentry>
+</variablelist>
+</para>
+
+<para>
Some of the status flags can be turned on or off using
-<itemize>
-<item><bf/set-flag/ (default: w)
-<item><bf/clear-flag/ (default: W)
-</itemize>
-
-<p>
+
+<itemizedlist>
+<listitem>
+
+<para>
+<emphasis remap="bf">set-flag</emphasis> (default: w)
+</para>
+</listitem>
+<listitem>
+
+<para>
+<emphasis remap="bf">clear-flag</emphasis> (default: W)
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+<para>
Furthermore, the following flags reflect who the message is addressed
to. They can be customized with the
-<ref id="to_chars" name="$to_chars"> variable.
-
-<p>
-<descrip>
-<tag/+/ message is to you and you only
-<tag/T/ message is to you, but also to or cc'ed to others
-<tag/C/ message is cc'ed to you
-<tag/F/ message is from you
-<tag/L/ message is sent to a subscribed mailing list
-</descrip>
-
-<sect2>The Pager
-<p>
-
+<xref LinkEnd="to-chars"/> variable.
+</para>
+
+<para>
+<variablelist>
+
+<varlistentry>
+<term>+</term>
+<listitem>
+<para>
+message is to you and you only
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>T</term>
+<listitem>
+<para>
+message is to you, but also to or cc'ed to others
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>C</term>
+<listitem>
+<para>
+message is cc'ed to you
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>F</term>
+<listitem>
+<para>
+message is from you
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>L</term>
+<listitem>
+<para>
+message is sent to a subscribed mailing list
+</para>
+</listitem>
+</varlistentry>
+</variablelist>
+</para>
+
+</sect4>
+
+</sect3>
+
+<sect3>
+<title>The Pager</title>
+
+<para>
By default, Mutt uses its builtin pager to display the body of messages.
-The pager is very similar to the Unix program <em/less/ though not nearly as
+The pager is very similar to the Unix program <emphasis>less</emphasis> though
not nearly as
featureful.
-
-<tscreen><verb>
-<Return> go down one line
-<Space> display the next page (or next message if at the end of a
message)
+</para>
+
+<para>
+
+<screen>
+<Return> go down one line
+<Space> display the next page (or next message if at the end
of a message)
- go back to the previous page
n search for next match
S skip beyond quoted text
@@ -260,27 +541,36 @@
ESC / search backwards for a regular expression
\ toggle search pattern coloring
^ jump to the top of the message
-</verb></tscreen>
-
-In addition, many of the functions from the <em/index/ are available in
-the pager, such as <em/delete-message/ or <em/copy-message/ (this is one
+</screen>
+
+</para>
+
+<para>
+In addition, many of the functions from the <emphasis>index</emphasis> are
available in
+the pager, such as <emphasis>delete-message</emphasis> or
<emphasis>copy-message</emphasis> (this is one
advantage over using an external pager to view messages).
-
+</para>
+
+<para>
Also, the internal pager supports a couple other advanced features. For
one, it will accept and translate the ``standard'' nroff sequences for
bold and underline. These sequences are a series of either the letter,
-backspace (^H), the letter again for bold or the letter, backspace,
+backspace (ˆH), the letter again for bold or the letter, backspace,
``_'' for denoting underline. Mutt will attempt to display these
in bold and underline respectively if your terminal supports them. If
-not, you can use the bold and underline <ref id="color" name="color">
+not, you can use the bold and underline <xref LinkEnd="color"/>
objects to specify a color or mono attribute for them.
-
+</para>
+
+<para>
Additionally, the internal pager supports the ANSI escape sequences for
character attributes. Mutt translates them into the correct color and
character settings. The sequences Mutt supports are:
-
-<p>
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
ESC [ Ps;Ps;Ps;...;Ps m
where Ps =
0 All Attributes Off
@@ -300,20 +590,31 @@
5 magenta
6 cyan
7 white
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
Mutt uses these attributes for handling text/enriched messages, and they
-can also be used by an external <ref id="auto_view" name="autoview">
-script for highlighting purposes. <bf/Note:/ If you change the colors for your
+can also be used by an external <xref LinkEnd="auto-view"/>
+script for highlighting purposes. <emphasis remap="bf">Note:</emphasis> If
you change the colors for your
display, for example by changing the color associated with color2 for
your xterm, then that color will be used instead of green.
-
-<sect2>Threaded Mode<label id="threads">
-<p>
-When the mailbox is <ref id="sort" name="sorted"> by <em/threads/, there are
-a few additional functions available in the <em/index/ and <em/pager/ modes.
-
-<tscreen><verb>
+</para>
+
+</sect3>
+
+<sect3 id="threads">
+<title>Threaded Mode</title>
+
+<para>
+When the mailbox is <xref LinkEnd="sort"/> by <emphasis>threads</emphasis>,
there are
+a few additional functions available in the <emphasis>index</emphasis> and
<emphasis>pager</emphasis> modes.
+</para>
+
+<para>
+
+<screen>
^D delete-thread delete all messages in the current thread
^U undelete-thread undelete all messages in the current thread
^N next-thread jump to the start of the next thread
@@ -328,148 +629,228 @@
ESC v collapse-thread toggle collapse for the current thread
ESC V collapse-all toggle collapse for all threads
P parent-message jump to parent message in thread
-</verb></tscreen>
-
-<bf/Note:/ Collapsing a thread displays only the first message
+</screen>
+
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> Collapsing a thread displays only the
first message
in the thread and hides the others. This is useful when threads
contain so many messages that you can only see a handful of threads on
-the screen. See %M in <ref
id="index_format"name="$index_format">.
-For example, you could use "%?M?(#%03M)&(%4l)?" in
<ref
-id="index_format"name="$index_format"> to optionally
+the screen. See %M in <xref LinkEnd="index-format"/>.
+For example, you could use "%?M?(#%03M)&(%4l)?"
in <xref LinkEnd="index-format"/> to optionally
display the number of hidden messages if the thread is collapsed.
-
-See also: <ref id="strict_threads" name="$strict_threads">.
-
-<sect2>Miscellaneous Functions
-<p><bf/create-alias/<label id="create-alias"> (default: a)<newline>
-
+</para>
+
+<para>
+See also: <xref LinkEnd="strict-threads"/>.
+</para>
+
+</sect3>
+
+<sect3>
+<title>Miscellaneous Functions</title>
+
+<para>
+<emphasis remap="bf">create-alias</emphasis><anchor id="create-alias"/>
(default: a)
+
+</para>
+
+<para>
Creates a new alias based upon the current message (or prompts for a
-new one). Once editing is complete, an <ref id="alias" name="alias">
-command is added to the file specified by the <ref id="alias_file"
-name="$alias_file"> variable for future use. <bf/Note:/
-Specifying an <ref id="alias_file" name="$alias_file">
-does not add the aliases specified there-in, you must also <ref
-id="source" name="source"> the file.
-
-<p><bf/check-traditional-pgp/<label id="check-traditional-pgp"> (default: ESC
P)<newline>
-
+new one). Once editing is complete, an <xref LinkEnd="alias"/>
+command is added to the file specified by the <xref LinkEnd="alias-file"/>
variable for future use. <emphasis remap="bf">Note:</emphasis>
+Specifying an <xref LinkEnd="alias-file"/>
+does not add the aliases specified there-in, you must also <xref
LinkEnd="source"/> the file.
+</para>
+
+<para>
+<emphasis remap="bf">check-traditional-pgp</emphasis><anchor
id="check-traditional-pgp"/> (default: ESC P)
+
+</para>
+
+<para>
This function will search the current message for content signed or
encrypted with PGP the "traditional" way, that is, without proper
MIME tagging. Technically, this function will temporarily change
the MIME content types of the body parts containing PGP data; this
-is similar to the <ref id="edit-type" name="edit-type"> function's
+is similar to the <xref LinkEnd="edit-type"/> function's
effect.
-
-
-<p><bf/display-toggle-weed/<label id="display-toggle-weed"> (default:
h)<newline>
-
-Toggles the weeding of message header fields specified by <ref id="ignore"
-name="ignore"> commands.
-
-<p><bf/edit/<label id="edit"> (default: e)<newline>
-
+</para>
+
+<para>
+<emphasis remap="bf">display-toggle-weed</emphasis><anchor
id="display-toggle-weed"/> (default: h)
+
+</para>
+
+<para>
+Toggles the weeding of message header fields specified by <xref
LinkEnd="ignore"/> commands.
+</para>
+
+<para>
+<emphasis remap="bf">edit</emphasis><anchor id="edit"/> (default: e)
+
+</para>
+
+<para>
This command (available in the ``index'' and ``pager'') allows you to
edit the raw current message as it's present in the mail folder.
After you have finished editing, the changed message will be
appended to the current folder, and the original message will be
marked for deletion.
-
-<p><bf/edit-type/<label id="edit-type"><newline>
-(default: ^E on the attachment menu, and in the pager and index menus; ^T on
the
+</para>
+
+<para>
+<emphasis remap="bf">edit-type</emphasis><anchor id="edit-type"/>
+
+(default: ˆE on the attachment menu, and in the pager and index menus;
ˆT on the
compose menu)
-
+</para>
+
+<para>
This command is used to temporarily edit an attachment's content
type to fix, for instance, bogus character set parameters. When
invoked from the index or from the pager, you'll have the
opportunity to edit the top-level attachment's content type. On the
-<ref id="attach_menu" name="attachment menu">, you can change any
+<xref LinkEnd="attach-menu"/>, you can change any
attachment's content type. These changes are not persistent, and get
lost upon changing folders.
-
-Note that this command is also available on the <ref
-id="compose_menu" name="compose menu">. There, it's used to
+</para>
+
+<para>
+Note that this command is also available on the <xref
LinkEnd="compose-menu"/>. There, it's used to
fine-tune the properties of attachments you are going to send.
-
-<p><bf/enter-command/<label id="enter-command"> (default: ``:'')<newline>
-
+</para>
+
+<para>
+<emphasis remap="bf">enter-command</emphasis><anchor id="enter-command"/>
(default: ``:'')
+
+</para>
+
+<para>
This command is used to execute any command you would normally put in a
configuration file. A common use is to check the settings of variables, or
-in conjunction with <ref id="macro" name="macros"> to change settings on the
+in conjunction with <xref LinkEnd="macro"/> to change settings on the
fly.
-
-<p><bf/extract-keys/<label id="extract-keys"> (default: ^K)<newline>
-
+</para>
+
+<para>
+<emphasis remap="bf">extract-keys</emphasis><anchor id="extract-keys"/>
(default: ˆK)
+
+</para>
+
+<para>
This command extracts PGP public keys from the current or tagged
message(s) and adds them to your PGP public key ring.
-
-<p><bf/forget-passphrase/<label id="forget-passphrase"> (default:
-^F)<newline>
-
+</para>
+
+<para>
+<emphasis remap="bf">forget-passphrase</emphasis><anchor
id="forget-passphrase"/> (default:
+ˆF)
+
+</para>
+
+<para>
This command wipes the passphrase(s) from memory. It is useful, if
you misspelled the passphrase.
-
-<p><bf/list-reply/<label id="list-reply"> (default: L)<newline>
-
+</para>
+
+<para>
+<emphasis remap="bf">list-reply</emphasis><anchor id="list-reply"/> (default:
L)
+
+</para>
+
+<para>
Reply to the current or tagged message(s) by extracting any addresses which
-match the regular expressions given by the <ref id="lists" name="lists or
subscribe">
-commands, but also honor any <tt/Mail-Followup-To/ header(s) if the
-<ref id="honor_followup_to" name="$honor_followup_to">
+match the regular expressions given by the <xref LinkEnd="lists"/>
+commands, but also honor any <literal remap="tt">Mail-Followup-To</literal>
header(s) if the
+<xref LinkEnd="honor-followup-to"/>
configuration variable is set. Using this when replying to messages posted
to mailing lists helps avoid duplicate copies being sent to the author of
the message you are replying to.
-
-<bf/pipe-message/<label id="pipe-message"> (default: |)<newline>
-
+</para>
+
+<para>
+<emphasis remap="bf">pipe-message</emphasis><anchor id="pipe-message"/>
(default: |)
+
+</para>
+
+<para>
Asks for an external Unix command and pipes the current or
-tagged message(s) to it. The variables <ref id="pipe_decode"
-name="$pipe_decode">, <ref id="pipe_split"
-name="$pipe_split">, <ref id="pipe_sep"
-name="$pipe_sep"> and <ref id="wait_key"
-name="$wait_key"> control the exact behaviour of this
+tagged message(s) to it. The variables <xref LinkEnd="pipe-decode"/>, <xref
LinkEnd="pipe-split"/>, <xref LinkEnd="pipe-sep"/> and <xref
LinkEnd="wait-key"/> control the exact behaviour of this
function.
-
-<bf/resend-message/<label id="resend-message"> (default: ESC e)<newline>
-
+</para>
+
+<para>
+<emphasis remap="bf">resend-message</emphasis><anchor id="resend-message"/>
(default: ESC e)
+
+</para>
+
+<para>
With resend-message, mutt takes the current message as a template for a
new message. This function is best described as "recall from arbitrary
folders". It can conveniently be used to forward MIME messages while
preserving the original mail structure. Note that the amount of headers
-included here depends on the value of the <ref id="weed" name="$weed">
+included here depends on the value of the <xref LinkEnd="weed"/>
variable.
-
+</para>
+
+<para>
This function is also available from the attachment menu. You can use this
to easily resend a message which was included with a bounce message
as a message/rfc822 body part.
-
-<bf/shell-escape/<label id="shell-escape"> (default: !)<newline>
-
-Asks for an external Unix command and executes it. The <ref
-id="wait_key" name="$wait_key"> can be used to control
+</para>
+
+<para>
+<emphasis remap="bf">shell-escape</emphasis><anchor id="shell-escape"/>
(default: !)
+
+</para>
+
+<para>
+Asks for an external Unix command and executes it. The <xref
LinkEnd="wait-key"/> can be used to control
whether Mutt will wait for a key to be pressed when the command returns
(presumably to let the user read the output of the command), based on
the return status of the named command.
-
-<bf/toggle-quoted/<label id="toggle-quoted"> (default: T)<newline>
-
-The <em/pager/ uses the <ref id="quote_regexp"
-name="$quote_regexp"> variable to detect quoted text when
+</para>
+
+<para>
+<emphasis remap="bf">toggle-quoted</emphasis><anchor id="toggle-quoted"/>
(default: T)
+
+</para>
+
+<para>
+The <emphasis>pager</emphasis> uses the <xref LinkEnd="quote-regexp"/>
variable to detect quoted text when
displaying the body of the message. This function toggles the display
of the quoted material in the message. It is particularly useful when
are interested in just the response and there is a large amount of
quoted text in the way.
-
-<bf/skip-quoted/<label id="skip-quoted"> (default: S)<newline>
-
+</para>
+
+<para>
+<emphasis remap="bf">skip-quoted</emphasis><anchor id="skip-quoted"/>
(default: S)
+
+</para>
+
+<para>
This function will go to the next line of non-quoted text which come
after a line of quoted text in the internal pager.
-
-<sect1>Sending Mail
-<p>
-
-The following bindings are available in the <em/index/ for sending
+</para>
+
+</sect3>
+
+</sect2>
+
+<sect2>
+<title>Sending Mail</title>
+
+<para>
+The following bindings are available in the <emphasis>index</emphasis> for
sending
messages.
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
m compose compose a new message
r reply reply to sender
g group-reply reply to all recipients
@@ -477,41 +858,43 @@
f forward forward message
b bounce bounce (remail) message
ESC k mail-key mail a PGP public key to someone
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
Bouncing a message sends the message as is to the recipient you
specify. Forwarding a message allows you to add comments or
modify the message you are forwarding. These items are discussed
-in greater detail in the next chapter <ref id="forwarding_mail"
-name="``Forwarding and Bouncing Mail''">.
-
-Mutt will then enter the <em/compose/ menu and prompt you for the
+in greater detail in the next chapter <xref LinkEnd="forwarding-mail"/>.
+</para>
+
+<para>
+Mutt will then enter the <emphasis>compose</emphasis> menu and prompt you for
the
recipients to place on the ``To:'' header field. Next, it will ask
you for the ``Subject:'' field for the message, providing a default if
-you are replying to or forwarding a message. See also <ref id="askcc"
-name="$askcc">, <ref id="askbcc" name="$askbcc">, <ref
-id="autoedit" name="$autoedit">, <ref id="bounce"
-name="$bounce">, and <ref id="fast_reply"
-name="$fast_reply"> for changing how Mutt asks these
+you are replying to or forwarding a message. See also <xref
LinkEnd="askcc"/>, <xref LinkEnd="askbcc"/>, <xref LinkEnd="autoedit"/>, <xref
LinkEnd="bounce"/>, and <xref LinkEnd="fast-reply"/> for changing how Mutt asks
these
questions.
-
-Mutt will then automatically start your <ref id="editor"
-name="$editor"> on the message body. If the <ref id="edit_headers"
-name="$edit_headers"> variable is set, the headers will be at
+</para>
+
+<para>
+Mutt will then automatically start your <xref LinkEnd="editor"/> on the
message body. If the <xref LinkEnd="edit-headers"/> variable is set, the
headers will be at
the top of the message in your editor. Any messages you are replying
-to will be added in sort order to the message, with appropriate <ref
-id="attribution" name="$attribution">, <ref id="indent_string"
-name="$indent_string"> and <ref id="post_indent_string"
-name="$post_indent_string">. When forwarding a
-message, if the <ref id="mime_forward" name="$mime_forward">
+to will be added in sort order to the message, with appropriate <xref
LinkEnd="attribution"/>, <xref LinkEnd="indent-string"/> and <xref
LinkEnd="post-indent-string"/>. When forwarding a
+message, if the <xref LinkEnd="mime-forward"/>
variable is unset, a copy of the forwarded message will be included. If
-you have specified a <ref id="signature" name="$signature">, it
+you have specified a <xref LinkEnd="signature"/>, it
will be appended to the message.
-
+</para>
+
+<para>
Once you have finished editing the body of your mail message, you are
-returned to the <em/compose/ menu. The following options are available:
-
-<tscreen><verb>
+returned to the <emphasis>compose</emphasis> menu. The following options are
available:
+</para>
+
+<para>
+
+<screen>
a attach-file attach a file
A attach-message attach message(s) to the message
ESC k attach-key attach a PGP public key
@@ -532,48 +915,75 @@
w write-fcc write the message to a folder
i ispell check spelling (if available on your system)
^F forget-passphrase wipe passphrase(s) from memory
-</verb></tscreen>
-
-<bf/Note:/ The attach-message function will prompt you for a folder to
+</screen>
+
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> The attach-message function will prompt
you for a folder to
attach messages from. You can now tag messages in that folder and they
will be attached to the message you are sending. Note that certain
operations like composing a new mail, replying, forwarding, etc. are
-not permitted when you are in that folder. The %r in <ref
-id="status_format" name="$status_format"> will change to
+not permitted when you are in that folder. The %r in <xref
LinkEnd="status-format"/> will change to
a 'A' to indicate that you are in attach-message mode.
-
-<sect2>Editing the message header
-<p>
+</para>
+
+<sect3>
+<title>Editing the message header</title>
+
+<para>
When editing the header of your outgoing message, there are a couple of
special features available.
-
-If you specify<newline>
-<tt/Fcc:/ <em/filename/<newline>
-Mutt will pick up <em/filename/
-just as if you had used the <em/edit-fcc/ function in the <em/compose/ menu.
-
-You can also attach files to your message by specifying<newline>
-<tt/Attach:/ <em/filename/ [ <em/description/ ]<newline>
-where <em/filename/ is the file to attach and <em/description/ is an
+</para>
+
+<para>
+If you specify
+
+<literal remap="tt">Fcc:</literal> <emphasis>filename</emphasis>
+
+Mutt will pick up <emphasis>filename</emphasis>
+just as if you had used the <emphasis>edit-fcc</emphasis> function in the
<emphasis>compose</emphasis> menu.
+</para>
+
+<para>
+You can also attach files to your message by specifying
+
+<literal remap="tt">Attach:</literal> <emphasis>filename</emphasis> [
<emphasis>description</emphasis> ]
+
+where <emphasis>filename</emphasis> is the file to attach and
<emphasis>description</emphasis> is an
optional string to use as the description of the attached file.
-
-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
+</para>
+
+<para>
+When replying to messages, if you remove the <emphasis>In-Reply-To:</emphasis>
field from
+the header field, Mutt will not generate a <emphasis>References:</emphasis>
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>
+</para>
+
+<para>
+Also see <xref LinkEnd="edit-headers"/>.
+</para>
+
+</sect3>
+
+<sect3>
+<title>Using Mutt with PGP</title>
+
+<para>
If you want to use PGP, you can specify
-
-<tt/Pgp:/ [ <tt/E/ | <tt/S/ | <tt/S/<em/<id>/ ] <newline>
-
+</para>
+
+<para>
+<literal remap="tt">Pgp:</literal> [ <literal remap="tt">E</literal>
| <literal remap="tt">S</literal> | <literal
remap="tt">S</literal><emphasis><id></emphasis> ]
+
+</para>
+
+<para>
``E'' encrypts, ``S'' signs and
-``S<id>'' signs with the given key, setting <ref
-id="pgp_sign_as" name="$pgp_sign_as"> permanently.
-
+``S<id>'' signs with the given key, setting <xref
LinkEnd="pgp-sign-as"/> permanently.
+</para>
+
+<para>
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
@@ -581,892 +991,1530 @@
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.
-
+</para>
+
+<para>
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
+usually, abort this prompt using <literal remap="tt">ˆG</literal>. When
you do so, mutt will
return to the compose screen.
-
+</para>
+
+<para>
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">)
+</para>
+
+<para>
+Most fields of the entries in the key selection menu (see also <xref
LinkEnd="pgp-entry-format"/>)
have obvious meanings. But some explanations on the capabilities, flags,
and validity fields are in order.
-
+</para>
+
+<para>
The flags sequence (%f) will expand to one of the following flags:
-<tscreen><verb>
+
+<screen>
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>
-
+</screen>
+
+</para>
+
+<para>
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
+the key's encryption capabilities: A minus sign (<emphasis
remap="bf">-</emphasis>) means
+that the key cannot be used for encryption. A dot (<emphasis
remap="bf">.</emphasis>) 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
+also be used for encryption. The letter <emphasis remap="bf">e</emphasis>
indicates that
this key can be used for encryption.
-
+</para>
+
+<para>
The second character indicates the key's signing capabilities. Once
-again, a ``<bf/-/'' implies ``not for signing'', ``<bf/./'' implies
+again, a ``<emphasis remap="bf">-</emphasis>'' implies ``not for signing'',
``<emphasis remap="bf">.</emphasis>'' 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/+/)
+``<emphasis remap="bf">s</emphasis>'' denotes a key which can be used for
signing.
+</para>
+
+<para>
+Finally, the validity field (%t) indicates how well-certified a user-id
+is. A question mark (<emphasis remap="bf">?</emphasis>) indicates undefined
validity, a minus
+character (<emphasis remap="bf">-</emphasis>) marks an untrusted association,
a space character
+means a partially trusted association, and a plus character (<emphasis
remap="bf">+</emphasis>)
indicates complete validity.
-
-<sect2>Sending anonymous messages via mixmaster.
-
-<p>
+</para>
+
+</sect3>
+
+<sect3>
+<title>Sending anonymous messages via mixmaster.</title>
+
+<para>
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. Mixmaster support in mutt is for
mixmaster version 2.04 (beta 45 appears to be the latest) and 2.03.
It does not support earlier versions or the later so-called version 3 betas,
of which the latest appears to be called 2.9b23.
-
+</para>
+
+<para>
To use it, you'll have to obey certain restrictions. Most
-important, you cannot use the <tt/Cc/ and <tt/Bcc/ headers. To tell
+important, you cannot use the <literal remap="tt">Cc</literal> and <literal
remap="tt">Bcc</literal> headers. To tell
Mutt to use mixmaster, you have to select a remailer chain, using
the mix function on the compose menu.
-
+</para>
+
+<para>
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
+</para>
+
+<para>
+You can navigate in the chain using the <literal
remap="tt">chain-prev</literal> and
+<literal remap="tt">chain-next</literal> functions, which are by default bound
to the left
+and right arrows and to the <literal remap="tt">h</literal> and <literal
remap="tt">l</literal> 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/.
+position, use the <literal remap="tt">insert</literal> function. To append a
remailer behind
+the current chain position, use <literal remap="tt">select-entry</literal> or
<literal remap="tt">append</literal>.
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.
-
+<literal remap="tt">accept</literal> them pressing (by default) the <literal
remap="tt">Return</literal> key.
+</para>
+
+<para>
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_entry_format">). Most important is
+<xref LinkEnd="mix-entry-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>
-
+</para>
+
+</sect3>
+
+</sect2>
+
+<sect2 id="forwarding-mail">
+<title>Forwarding and Bouncing Mail</title>
+
+<para>
Bouncing and forwarding let you send an existing message to recipients
-that you specify. Bouncing a message uses the <ref id="sendmail"
-name="sendmail"> command to send a copy to alternative addresses as if
+that you specify. Bouncing a message uses the <xref LinkEnd="sendmail"/>
command to send a copy to alternative addresses as if
they were the message's original recipients. Forwarding a message, on
the other hand, allows you to modify the message before it is resent
(for example, by adding your own comments).
-
+</para>
+
+<para>
The following keys are bound by default:
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
f forward forward message
b bounce bounce (remail) message
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
Forwarding can be done by including the original message in the new
message's body (surrounded by indicating lines) or including it as a MIME
-attachment, depending on the value of the <ref id="mime_forward"
-name="$mime_forward"> variable. Decoding of attachments,
-like in the pager, can be controlled by the <ref id="forward_decode"
-name="$forward_decode"> and <ref id="mime_forward_decode"
-name="$mime_forward_decode"> variables,
+attachment, depending on the value of the <xref LinkEnd="mime-forward"/>
variable. Decoding of attachments,
+like in the pager, can be controlled by the <xref LinkEnd="forward-decode"/>
and <xref LinkEnd="mime-forward-decode"/> variables,
respectively. The desired forwarding format may depend on the content,
-therefore <em/$mime_forward/ is a quadoption which, for
+therefore <emphasis>$mime_forward</emphasis> is a quadoption
which, for
example, can be set to ``ask-no''.
-
+</para>
+
+<para>
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.
-
+<xref LinkEnd="weed"/> variable, unless <xref LinkEnd="mime-forward"/> is set.
+</para>
+
+<para>
Editing the message to forward follows the same procedure as sending or
replying to a message does.
-
-<sect1>Postponing Mail<label id="postponing_mail">
-<p>
-
+</para>
+
+</sect2>
+
+<sect2 id="postponing-mail">
+<title>Postponing Mail</title>
+
+<para>
At times it is desirable to delay sending a message that you have
-already begun to compose. When the <em/postpone-message/ function is
-used in the <em/compose/ menu, the body of your message and attachments
-are stored in the mailbox specified by the <ref id="postponed"
-name="$postponed"> variable. This means that you can recall the
+already begun to compose. When the <emphasis>postpone-message</emphasis>
function is
+used in the <emphasis>compose</emphasis> menu, the body of your message and
attachments
+are stored in the mailbox specified by the <xref LinkEnd="postponed"/>
variable. This means that you can recall the
message even if you exit Mutt and then restart it at a later time.
-
+</para>
+
+<para>
Once a message is postponed, there are several ways to resume it. From the
-command line you can use the ``-p'' option, or if you <em/compose/ a new
-message from the <em/index/ or <em/pager/ you will be prompted if postponed
+command line you can use the ``-p'' option, or if you
<emphasis>compose</emphasis> a new
+message from the <emphasis>index</emphasis> or <emphasis>pager</emphasis> you
will be prompted if postponed
messages exist. If multiple messages are currently postponed, the
-<em/postponed/ menu will pop up and you can select which message you would
+<emphasis>postponed</emphasis> menu will pop up and you can select which
message you would
like to resume.
-
-<bf/Note:/ If you postpone a reply to a message, the reply setting of
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> If you postpone a reply to a message,
the reply setting of
the message is only updated when you actually finish the message and
send it. Also, you must be in the same folder with the message you
replied to for the status of the message to be updated.
-
-See also the <ref id="postpone" name="$postpone"> quad-option.
-
-<sect>Configuration
-<p>
-
+</para>
+
+<para>
+See also the <xref LinkEnd="postpone"/> quad-option.
+</para>
+
+</sect2>
+
+</sect1>
+
+<sect1>
+<title>Configuration</title>
+
+<para>
While the default configuration (or ``preferences'') make Mutt
usable right out of the box, it is often desirable to tailor Mutt to
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>/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
+system administrator), unless the ``-n'' <xref LinkEnd="commandline"/> option
is specified. This file is typically
+<literal remap="tt">/usr/local/share/mutt/Muttrc</literal> or <literal
remap="tt">/etc/Muttrc</literal>. Mutt
+will next look for a file named <literal remap="tt">.muttrc</literal> 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
-<tt>.mutt/muttrc</tt>.
-
-<tt>.muttrc</tt> is the file where you will usually place your <ref
- id="commands" name="commands"> to configure Mutt.
-
+a subdirectory named <literal remap="tt">.mutt</literal>, mutt try to load a
file named
+<literal remap="tt">.mutt/muttrc</literal>.
+</para>
+
+<para>
+<literal remap="tt">.muttrc</literal> is the file where you will usually place
your <xref LinkEnd="commands"/> to configure Mutt.
+</para>
+
+<para>
In addition, mutt supports version specific configuration files that are
parsed instead of the default files as explained above. For instance, if
-your system has a <tt/Muttrc-0.88/ file in the system configuration
+your system has a <literal remap="tt">Muttrc-0.88</literal> file in the system
configuration
directory, and you are running version 0.88 of mutt, this file will be
-sourced instead of the <tt/Muttrc/ file. The same is true of the user
-configuration file, if you have a file <tt/.muttrc-0.88.6/ in your home
+sourced instead of the <literal remap="tt">Muttrc</literal> file. The same is
true of the user
+configuration file, if you have a file <literal
remap="tt">.muttrc-0.88.6</literal> in your home
directory, when you run mutt version 0.88.6, it will source this file
-instead of the default <tt/.muttrc/ file. The version number is the
-same which is visible using the ``-v'' <ref id="commandline"
-name="command line"> switch or using the <tt/show-version/ key (default:
+instead of the default <literal remap="tt">.muttrc</literal> file. The
version number is the
+same which is visible using the ``-v'' <xref LinkEnd="commandline"/> switch or
using the <literal remap="tt">show-version</literal> key (default:
V) from the index menu.
-
-<sect1>Syntax of Initialization Files<label id="muttrc-syntax">
-<p>
-
-An initialization file consists of a series of <ref id="commands"
-name="commands">. Each line of the file may contain one or more commands.
+</para>
+
+<sect2 id="muttrc-syntax">
+<title>Syntax of Initialization Files</title>
+
+<para>
+An initialization file consists of a series of <xref LinkEnd="commands"/>.
Each line of the file may contain one or more commands.
When multiple commands are used, they must be separated by a semicolon (;).
-<tscreen><verb>
+
+<screen>
set realname='Mutt user' ; ignore x-
-</verb></tscreen>
+</screen>
+
The hash mark, or pound sign
(``#''), is used as a ``comment'' character. You can use it to
annotate your initialization file. All text after the comment character
to the end of the line is ignored. For example,
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
my_hdr X-Disclaimer: Why are you listening to me? # This is a comment
-</verb></tscreen>
-
-Single quotes (') and double quotes (&dquot;) can be used to quote strings
+</screen>
+
+</para>
+
+<para>
+Single quotes (') and double quotes (") can be used to quote strings
which contain spaces or other special characters. The difference between
the two types of quotes is similar to that of many popular shell programs,
namely that a single quote is used to specify a literal string (one that is
not interpreted for shell variables or quoting with a backslash [see
next paragraph]), while double quotes indicate a string for which
should be evaluated. For example, backtics are evaluated inside of double
-quotes, but <bf/not/ for single quotes.
-
+quotes, but <emphasis remap="bf">not</emphasis> for single quotes.
+</para>
+
+<para>
\ quotes the next character, just as in shells such as bash and zsh.
-For example, if want to put quotes ``&dquot;'' inside of a string, you can use
+For example, if want to put quotes ``"'' inside of a string, you can use
``\'' to force the next character to be a literal instead of interpreted
character.
-<tscreen><verb>
+
+<screen>
set realname="Michael \"MuttDude\" Elkins"
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
``\\'' means to insert a literal ``\'' into the line.
``\n'' and ``\r'' have their usual C meanings of linefeed and
carriage-return, respectively.
-
+</para>
+
+<para>
A \ at the end of a line can be used to split commands over
multiple lines, provided that the split points don't appear in the
middle of command names.
-
+</para>
+
+<para>
It is also possible to substitute the output of a Unix command in an
initialization file. This is accomplished by enclosing the command in
backquotes (``). For example,
-<tscreen><verb>
+
+<screen>
my_hdr X-Operating-System: `uname -a`
-</verb></tscreen>
+</screen>
+
The output of the Unix command ``uname -a'' will be substituted before the
line is parsed. Note that since initialization files are line oriented, only
the first line of output from the Unix command will be substituted.
-
+</para>
+
+<para>
UNIX environments can be accessed like the way it is done in shells like
sh and bash: Prepend the name of the environment by a ``$''. For
example,
-<tscreen><verb>
+
+<screen>
set record=+sent_on_$HOSTNAME
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
The commands understood by mutt are explained in the next paragraphs.
-For a complete list, see the <ref id="commands" name="command reference">.
-
-<sect1>Defining/Using aliases<label id="alias">
-<p>
-
-Usage: <tt/alias/ <em/key/ <em/address/ [ , <em/address/, ... ]
-
+For a complete list, see the <xref LinkEnd="commands"/>.
+</para>
+
+</sect2>
+
+<sect2 id="alias">
+<title>Defining/Using aliases</title>
+
+<para>
+Usage: <literal remap="tt">alias</literal> <emphasis>key</emphasis>
<emphasis>address</emphasis> [ , <emphasis>address</emphasis>, ... ]
+</para>
+
+<para>
It's usually very cumbersome to remember or type out the address of someone
you are communicating with. Mutt allows you to create ``aliases'' which map
a short string to a full address.
-
-<bf/Note:/ if you want to create an alias for a group (by specifying more than
-one address), you <bf/must/ separate the addresses with a comma (``,'').
-
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> if you want to create an alias for a
group (by specifying more than
+one address), you <emphasis remap="bf">must</emphasis> separate the addresses
with a comma (``,'').
+</para>
+
+<para>
To remove an alias or aliases (``*'' means all aliases):
-
-<tt/unalias/ [ * | <em/key/ <em/.../ ]
-
-<tscreen><verb>
+</para>
+
+<para>
+<literal remap="tt">unalias</literal> [ * |
<emphasis>key</emphasis> <emphasis>...</emphasis> ]
+</para>
+
+<para>
+
+<screen>
alias muttdude me@xxxxxxxxxx (Michael Elkins)
alias theguys manny, moe, jack
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
Unlike other mailers, Mutt doesn't require aliases to be defined
-in a special file. The <tt/alias/ command can appear anywhere in
-a configuration file, as long as this file is <ref id="source"
-name="sourced">. Consequently, you can have multiple alias files, or
+in a special file. The <literal remap="tt">alias</literal> command can appear
anywhere in
+a configuration file, as long as this file is <xref LinkEnd="source"/>.
Consequently, you can have multiple alias files, or
you can have all aliases defined in your muttrc.
-
-On the other hand, the <ref id="create-alias" name="create-alias">
-function can use only one file, the one pointed to by the <ref
-id="alias_file" name="$alias_file"> variable (which is
-<tt>˜/.muttrc</tt> by default). This file is not special either,
+</para>
+
+<para>
+On the other hand, the <xref LinkEnd="create-alias"/>
+function can use only one file, the one pointed to by the <xref
LinkEnd="alias-file"/> variable (which is
+<literal remap="tt">˜/.muttrc</literal> by default). This file is not
special either,
in the sense that Mutt will happily append aliases to any file, but in
-order for the new aliases to take effect you need to explicitly <ref
-id="source" name="source"> this file too.
-
+order for the new aliases to take effect you need to explicitly <xref
LinkEnd="source"/> this file too.
+</para>
+
+<para>
For example:
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
source /usr/local/share/Mutt.aliases
source ~/.mail_aliases
set alias_file=~/.mail_aliases
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
To use aliases, you merely use the alias at any place in mutt where mutt
-prompts for addresses, such as the <em/To:/ or <em/Cc:/ prompt. You can
+prompts for addresses, such as the <emphasis>To:</emphasis> or
<emphasis>Cc:</emphasis> prompt. You can
also enter aliases in your editor at the appropriate headers if you have the
-<ref id="edit_headers" name="$edit_headers"> variable set.
-
+<xref LinkEnd="edit-headers"/> variable set.
+</para>
+
+<para>
In addition, at the various address prompts, you can use the tab character
to expand a partial alias to the full alias. If there are multiple matches,
mutt will bring up a menu with the matching aliases. In order to be
presented with the full list of aliases, you must hit tab with out a partial
alias, such as at the beginning of the prompt or after a comma denoting
multiple addresses.
-
+</para>
+
+<para>
In the alias menu, you can select as many aliases as you want with the
-<em/select-entry/ key (default: RET), and use the <em/exit/ key
+<emphasis>select-entry</emphasis> key (default: RET), and use the
<emphasis>exit</emphasis> key
(default: q) to return to the address prompt.
-
-<sect1>Changing the default key bindings<label id="bind">
-<p>
-Usage: <tt/bind/ <em/map/ <em/key/ <em/function/
-
+</para>
+
+</sect2>
+
+<sect2 id="bind">
+<title>Changing the default key bindings</title>
+
+<para>
+Usage: <literal remap="tt">bind</literal> <emphasis>map</emphasis>
<emphasis>key</emphasis> <emphasis>function</emphasis>
+</para>
+
+<para>
This command allows you to change the default key bindings (operation
invoked when pressing a key).
-
-<em/map/ specifies in which menu the binding belongs. Multiple maps may
+</para>
+
+<para>
+<emphasis>map</emphasis> specifies in which menu the binding belongs.
Multiple maps may
be specified by separating them with commas (no additional whitespace is
allowed). The currently defined maps are:
-
-<label id="maps">
-<descrip>
-<tag/generic/
+</para>
+
+<para>
+<anchor id="maps"/>
+<variablelist>
+
+<varlistentry>
+<term>generic</term>
+<listitem>
+<para>
This is not a real menu, but is used as a fallback for all of the other
menus except for the pager and editor modes. If a key is not defined in
another menu, Mutt will look for a binding to use in this menu. This allows
you to bind a key to a certain function in multiple menus instead of having
multiple bind statements to accomplish the same task.
-<tag/alias/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>alias</term>
+<listitem>
+<para>
The alias menu is the list of your personal aliases as defined in your
muttrc. It is the mapping from a short alias name to the full email
address(es) of the recipient(s).
-<tag/attach/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>attach</term>
+<listitem>
+<para>
The attachment menu is used to access the attachments on received messages.
-<tag/browser/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>browser</term>
+<listitem>
+<para>
The browser is used for both browsing the local directory structure, and for
listing all of your incoming mailboxes.
-<tag/editor/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>editor</term>
+<listitem>
+<para>
The editor is the line-based editor the user enters text data.
-<tag/index/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>index</term>
+<listitem>
+<para>
The index is the list of messages contained in a mailbox.
-<tag/compose/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>compose</term>
+<listitem>
+<para>
The compose menu is the screen used when sending a new message.
-<tag/pager/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>pager</term>
+<listitem>
+<para>
The pager is the mode used to display message/attachment data, and help
listings.
-<tag/pgp/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>pgp</term>
+<listitem>
+<para>
The pgp menu is used to select the OpenPGP keys used for encrypting outgoing
messages.
-<tag/postpone/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>postpone</term>
+<listitem>
+<para>
The postpone menu is similar to the index menu, except is used when
recalling a message the user was composing, but saved until later.
-</descrip>
-
-<em/key/ is the key (or key sequence) you wish to bind. To specify a
-control character, use the sequence <em/\Cx/, where <em/x/ is the
+</para>
+</listitem>
+</varlistentry>
+</variablelist>
+</para>
+
+<para>
+<emphasis>key</emphasis> is the key (or key sequence) you wish to bind. To
specify a
+control character, use the sequence <emphasis>\Cx</emphasis>, where
<emphasis>x</emphasis> is the
letter of the control character (for example, to specify control-A use
-``\Ca''). Note that the case of <em/x/ as well as <em/\C/ is
-ignored, so that <em/\CA/, <em/\Ca/, <em/\cA/ and <em/\ca/
are all
+``\Ca''). Note that the case of <emphasis>x</emphasis> as well as
<emphasis>\C</emphasis> is
+ignored, so that <emphasis>\CA</emphasis>, <emphasis>\Ca</emphasis>,
<emphasis>\cA</emphasis> and <emphasis>\ca</emphasis> are all
equivalent. An alternative form is to specify the key as a three digit
-octal number prefixed with a ``\'' (for example <em/\177/ is
-equivalent to <em/\c?/).
-
-In addition, <em/key/ may consist of:
-
-<tscreen><verb>
+octal number prefixed with a ``\'' (for example
<emphasis>\177</emphasis> is
+equivalent to <emphasis>\c?</emphasis>).
+</para>
+
+<para>
+In addition, <emphasis>key</emphasis> may consist of:
+</para>
+
+<para>
+
+<screen>
\t tab
-<tab> tab
+<tab> tab
\r carriage return
\n newline
\e escape
-<esc> escape
-<up> up arrow
-<down> down arrow
-<left> left arrow
-<right> right arrow
-<pageup> Page Up
-<pagedown> Page Down
-<backspace> Backspace
-<delete> Delete
-<insert> Insert
-<enter> Enter
-<return> Return
-<home> Home
-<end> End
-<space> Space bar
-<f1> function key 1
-<f10> function key 10
-</verb></tscreen>
-
-<em/key/ does not need to be enclosed in quotes unless it contains a
+<esc> escape
+<up> up arrow
+<down> down arrow
+<left> left arrow
+<right> right arrow
+<pageup> Page Up
+<pagedown> Page Down
+<backspace> Backspace
+<delete> Delete
+<insert> Insert
+<enter> Enter
+<return> Return
+<home> Home
+<end> End
+<space> Space bar
+<f1> function key 1
+<f10> function key 10
+</screen>
+
+</para>
+
+<para>
+<emphasis>key</emphasis> does not need to be enclosed in quotes unless it
contains a
space (`` '').
-
-<em/function/ specifies which action to take when <em/key/ is pressed.
-For a complete list of functions, see the <ref id="functions"
-name="reference">. The special function <tt/noop/ unbinds the specified key
+</para>
+
+<para>
+<emphasis>function</emphasis> specifies which action to take when
<emphasis>key</emphasis> is pressed.
+For a complete list of functions, see the <xref LinkEnd="functions"/>. The
special function <literal remap="tt">noop</literal> unbinds the specified key
sequence.
-
-<sect1>Defining aliases for character sets <label id="charset-hook">
-<p>
-Usage: <tt/charset-hook/ <em/alias/ <em/charset/<newline>
-Usage: <tt/iconv-hook/ <em/charset/ <em/local-charset/
-
-The <tt/charset-hook/ command defines an alias for a character set.
+</para>
+
+</sect2>
+
+<sect2 id="charset-hook">
+<title>Defining aliases for character sets </title>
+
+<para>
+Usage: <literal remap="tt">charset-hook</literal> <emphasis>alias</emphasis>
<emphasis>charset</emphasis>
+
+Usage: <literal remap="tt">iconv-hook</literal> <emphasis>charset</emphasis>
<emphasis>local-charset</emphasis>
+</para>
+
+<para>
+The <literal remap="tt">charset-hook</literal> 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.
-
-The <tt/iconv-hook/ command defines a system-specific name for a
+</para>
+
+<para>
+The <literal remap="tt">iconv-hook</literal> command defines a system-specific
name for a
character set. This is helpful when your systems character
conversion library insists on using strange, system-specific names
for character sets.
-
-
-<sect1>Setting variables based upon mailbox<label id="folder-hook">
-<p>
-Usage: <tt/folder-hook/ [!]<em/regexp/ <em/command/
-
+</para>
+
+</sect2>
+
+<sect2 id="folder-hook">
+<title>Setting variables based upon mailbox</title>
+
+<para>
+Usage: <literal remap="tt">folder-hook</literal>
[!]<emphasis>regexp</emphasis> <emphasis>command</emphasis>
+</para>
+
+<para>
It is often desirable to change settings based on which mailbox you are
reading. The folder-hook command provides a method by which you can execute
-any configuration command. <em/regexp/ is a regular expression specifying
-in which mailboxes to execute <em/command/ before loading. If a mailbox
+any configuration command. <emphasis>regexp</emphasis> is a regular
expression specifying
+in which mailboxes to execute <emphasis>command</emphasis> before loading. If
a mailbox
matches multiple folder-hook's, they are executed in the order given in the
muttrc.
-
-<bf/Note:/ if you use the ``!'' shortcut for <ref id="spoolfile"
-name="$spoolfile"> at the beginning of the pattern, you must place it
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> if you use the ``!'' shortcut for <xref
LinkEnd="spoolfile"/> at the beginning of the pattern, you must place it
inside of double or single quotes in order to distinguish it from the
-logical <em/not/ operator for the expression.
-
-Note that the settings are <em/not/ restored when you leave the mailbox.
+logical <emphasis>not</emphasis> operator for the expression.
+</para>
+
+<para>
+Note that the settings are <emphasis>not</emphasis> restored when you leave
the mailbox.
For example, a command action to perform is to change the sorting method
based upon the mailbox being read:
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
folder-hook mutt set sort=threads
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
However, the sorting method is not restored to its previous value when
-reading a different mailbox. To specify a <em/default/ command, use the
+reading a different mailbox. To specify a <emphasis>default</emphasis>
command, use the
pattern ``.'':
-
-<p>
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
folder-hook . set sort=date-sent
-</verb></tscreen>
-
-<sect1>Keyboard macros<label id="macro">
-<p>
-Usage: <tt/macro/ <em/menu/ <em/key/ <em/sequence/ [ <em/description/
]
-
+</screen>
+
+</para>
+
+</sect2>
+
+<sect2 id="macro">
+<title>Keyboard macros</title>
+
+<para>
+Usage: <literal remap="tt">macro</literal> <emphasis>menu</emphasis>
<emphasis>key</emphasis> <emphasis>sequence</emphasis> [
<emphasis>description</emphasis> ]
+</para>
+
+<para>
Macros are useful when you would like a single key to perform a series of
-actions. When you press <em/key/ in menu <em/menu/, Mutt will behave as if
-you had typed <em/sequence/. So if you have a common sequence of commands
+actions. When you press <emphasis>key</emphasis> in menu
<emphasis>menu</emphasis>, Mutt will behave as if
+you had typed <emphasis>sequence</emphasis>. So if you have a common sequence
of commands
you type, you can create a macro to execute those commands with a single
key.
-
-<em/menu/ is the <ref id="maps" name="map"> which the macro will be bound.
+</para>
+
+<para>
+<emphasis>menu</emphasis> is the <xref LinkEnd="maps"/> which the macro will
be bound.
Multiple maps may be specified by separating multiple menu arguments by
commas. Whitespace may not be used in between the menu arguments and the
commas separating them.
-
-<em/key/ and <em/sequence/ are expanded by the same rules as the <ref
-id="bind" name="key bindings">. There are some additions however. The
-first is that control characters in <em/sequence/ can also be specified
-as <em/ˆx/. In order to get a caret (`ˆ'') you need to use
-<em/ˆˆ/. Secondly, to specify a certain key such as <em/up/
+</para>
+
+<para>
+<emphasis>key</emphasis> and <emphasis>sequence</emphasis> are expanded by the
same rules as the <xref LinkEnd="bind"/>. There are some additions however.
The
+first is that control characters in <emphasis>sequence</emphasis> can also be
specified
+as <emphasis>ˆx</emphasis>. In order to get a caret (`ˆ'') you need
to use
+<emphasis>ˆˆ</emphasis>. Secondly, to specify a certain key such as
<emphasis>up</emphasis>
or to invoke a function directly, you can use the format
-<em/<key name>/ and <em/<function name>/. For a listing of key
-names see the section on <ref id="bind" name="key bindings">. Functions
-are listed in the <ref id="functions" name="function reference">.
-
+<emphasis><key name></emphasis> and <emphasis><function
name></emphasis>. For a listing of key
+names see the section on <xref LinkEnd="bind"/>. Functions
+are listed in the <xref LinkEnd="functions"/>.
+</para>
+
+<para>
The advantage with using function names directly is that the macros will
work regardless of the current key bindings, so they are not dependent on
the user having particular key definitions. This makes them more robust
and portable, and also facilitates defining of macros in files used by more
than one user (eg. the system Muttrc).
-
-Optionally you can specify a descriptive text after <em/sequence/,
+</para>
+
+<para>
+Optionally you can specify a descriptive text after
<emphasis>sequence</emphasis>,
which is shown in the help screens.
-
-<bf/Note:/ Macro definitions (if any) listed in the help screen(s), are
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> Macro definitions (if any) listed in the
help screen(s), are
silently truncated at the screen width, and are not wrapped.
-
-<sect1>Using color and mono video attributes<label id="color">
-<p>
-Usage: <tt/color/ <em/object/ <em/foreground/ <em/background/ [
<em/regexp/ ]<newline>
-Usage: <tt/color/ index <em/foreground/ <em/background/ <em/pattern/<newline>
-Usage: <tt/uncolor/ index <em/pattern/ [ <em/pattern/ ... ]<newline>
-
+</para>
+
+</sect2>
+
+<sect2 id="color">
+<title>Using color and mono video attributes</title>
+
+<para>
+Usage: <literal remap="tt">color</literal> <emphasis>object</emphasis>
<emphasis>foreground</emphasis> <emphasis>background</emphasis> [
<emphasis>regexp</emphasis> ]
+
+Usage: <literal remap="tt">color</literal> index
<emphasis>foreground</emphasis> <emphasis>background</emphasis>
<emphasis>pattern</emphasis>
+
+Usage: <literal remap="tt">uncolor</literal> index
<emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
+
+</para>
+
+<para>
If your terminal supports color, you can spice up Mutt by creating your own
color scheme. To define the color of an object (type of information), you
-must specify both a foreground color <bf/and/ a background color (it is not
+must specify both a foreground color <emphasis remap="bf">and</emphasis> a
background color (it is not
possible to only specify one or the other).
-
-<em/object/ can be one of:
-
-<itemize>
-<item>attachment
-<item>body (match <em/regexp/ in the body of messages)
-<item>bold (hiliting bold patterns in the body of messages)
-<item>error (error messages printed by Mutt)
-<item>header (match <em/regexp/ in the message header)
-<item>hdrdefault (default color of the message header in the pager)
-<item>index (match <em/pattern/ in the message index)
-<item>indicator (arrow or bar used to indicate the current item in a menu)
-<item>markers (the ``+'' markers at the beginning of wrapped lines in the
pager)
-<item>message (informational messages)
-<item>normal
-<item>quoted (text matching <ref id="quote_regexp"
-name="$quote_regexp"> in the body of a message)
-<item>quoted1, quoted2, ..., quoted<bf/N/ (higher levels of quoting)
-<item>search (hiliting of words in the pager)
-<item>signature
-<item>status (mode lines used to display info about the mailbox or message)
-<item>tilde (the ``˜'' used to pad blank lines in the pager)
-<item>tree (thread tree drawn in the message index and attachment menu)
-<item>underline (hiliting underlined patterns in the body of messages)
-</itemize>
-
-<em/foreground/ and <em/background/ can be one of the following:
-
-<itemize>
-<item>white
-<item>black
-<item>green
-<item>magenta
-<item>blue
-<item>cyan
-<item>yellow
-<item>red
-<item>default
-<item>color<em/x/
-</itemize>
-
-<em/foreground/ can optionally be prefixed with the keyword <tt/bright/ to make
-the foreground color boldfaced (e.g., <tt/brightred/).
-
-If your terminal supports it, the special keyword <em/default/ can be
-used as a transparent color. The value <em/brightdefault/ is also valid.
-If Mutt is linked against the <em/S-Lang/ library, you also need to set
-the <em/COLORFGBG/ environment variable to the default colors of your
+</para>
+
+<para>
+<emphasis>object</emphasis> can be one of:
+</para>
+
+<para>
+
+<itemizedlist>
+<listitem>
+
+<para>
+attachment
+</para>
+</listitem>
+<listitem>
+
+<para>
+body (match <emphasis>regexp</emphasis> in the body of messages)
+</para>
+</listitem>
+<listitem>
+
+<para>
+bold (hiliting bold patterns in the body of messages)
+</para>
+</listitem>
+<listitem>
+
+<para>
+error (error messages printed by Mutt)
+</para>
+</listitem>
+<listitem>
+
+<para>
+header (match <emphasis>regexp</emphasis> in the message header)
+</para>
+</listitem>
+<listitem>
+
+<para>
+hdrdefault (default color of the message header in the pager)
+</para>
+</listitem>
+<listitem>
+
+<para>
+index (match <emphasis>pattern</emphasis> in the message index)
+</para>
+</listitem>
+<listitem>
+
+<para>
+indicator (arrow or bar used to indicate the current item in a menu)
+</para>
+</listitem>
+<listitem>
+
+<para>
+markers (the ``+'' markers at the beginning of wrapped lines in the pager)
+</para>
+</listitem>
+<listitem>
+
+<para>
+message (informational messages)
+</para>
+</listitem>
+<listitem>
+
+<para>
+normal
+</para>
+</listitem>
+<listitem>
+
+<para>
+quoted (text matching <xref LinkEnd="quote-regexp"/> in the body of a message)
+</para>
+</listitem>
+<listitem>
+
+<para>
+quoted1, quoted2, ..., quoted<emphasis remap="bf">N</emphasis> (higher levels
of quoting)
+</para>
+</listitem>
+<listitem>
+
+<para>
+search (hiliting of words in the pager)
+</para>
+</listitem>
+<listitem>
+
+<para>
+signature
+</para>
+</listitem>
+<listitem>
+
+<para>
+status (mode lines used to display info about the mailbox or message)
+</para>
+</listitem>
+<listitem>
+
+<para>
+tilde (the ``˜'' used to pad blank lines in the pager)
+</para>
+</listitem>
+<listitem>
+
+<para>
+tree (thread tree drawn in the message index and attachment menu)
+</para>
+</listitem>
+<listitem>
+
+<para>
+underline (hiliting underlined patterns in the body of messages)
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+<para>
+<emphasis>foreground</emphasis> and <emphasis>background</emphasis> can be one
of the following:
+</para>
+
+<para>
+
+<itemizedlist>
+<listitem>
+
+<para>
+white
+</para>
+</listitem>
+<listitem>
+
+<para>
+black
+</para>
+</listitem>
+<listitem>
+
+<para>
+green
+</para>
+</listitem>
+<listitem>
+
+<para>
+magenta
+</para>
+</listitem>
+<listitem>
+
+<para>
+blue
+</para>
+</listitem>
+<listitem>
+
+<para>
+cyan
+</para>
+</listitem>
+<listitem>
+
+<para>
+yellow
+</para>
+</listitem>
+<listitem>
+
+<para>
+red
+</para>
+</listitem>
+<listitem>
+
+<para>
+default
+</para>
+</listitem>
+<listitem>
+
+<para>
+color<emphasis>x</emphasis>
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+<para>
+<emphasis>foreground</emphasis> can optionally be prefixed with the keyword
<literal remap="tt">bright</literal> to make
+the foreground color boldfaced (e.g., <literal remap="tt">brightred</literal>).
+</para>
+
+<para>
+If your terminal supports it, the special keyword <emphasis>default</emphasis>
can be
+used as a transparent color. The value <emphasis>brightdefault</emphasis> is
also valid.
+If Mutt is linked against the <emphasis>S-Lang</emphasis> library, you also
need to set
+the <emphasis>COLORFGBG</emphasis> environment variable to the default colors
of your
terminal for this to work; for example (for Bourne-like shells):
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
set COLORFGBG="green;black"
export COLORFGBG
-</verb></tscreen>
-
-<bf/Note:/ The <em/S-Lang/ library requires you to use the <em/lightgray/
-and <em/brown/ keywords instead of <em/white/ and <em/yellow/ when
+</screen>
+
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> The <emphasis>S-Lang</emphasis> library
requires you to use the <emphasis>lightgray</emphasis>
+and <emphasis>brown</emphasis> keywords instead of <emphasis>white</emphasis>
and <emphasis>yellow</emphasis> when
setting this variable.
-
-<bf/Note:/ The uncolor command can be applied to the index object only. It
-removes entries from the list. You <bf/must/ specify the same pattern
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> The uncolor command can be applied to
the index object only. It
+removes entries from the list. You <emphasis remap="bf">must</emphasis>
specify the same pattern
specified in the color command for it to be removed. The pattern ``*'' is
a special token which means to clear the color index list of all entries.
-
-Mutt also recognizes the keywords <em/color0/, <em/color1/, …,
-<em/color/<bf/N-1/ (<bf/N/ being the number of colors supported
+</para>
+
+<para>
+Mutt also recognizes the keywords <emphasis>color0</emphasis>,
<emphasis>color1</emphasis>, …,
+<emphasis>color</emphasis><emphasis remap="bf">N-1</emphasis> (<emphasis
remap="bf">N</emphasis> being the number of colors supported
by your terminal). This is useful when you remap the colors for your
-display (for example by changing the color associated with <em/color2/
+display (for example by changing the color associated with
<emphasis>color2</emphasis>
for your xterm), since color names may then lose their normal meaning.
-
+</para>
+
+<para>
If your terminal does not support color, it is still possible change the video
attributes through the use of the ``mono'' command:
-
-Usage: <tt/mono/ <em/<object> <attribute>/ [ <em/regexp/
]<newline>
-Usage: <tt/mono/ index <em/attribute/ <em/pattern/<newline>
-Usage: <tt/unmono/ index <em/pattern/ [ <em/pattern/ ... ]<newline>
-
-where <em/attribute/ is one of the following:
-
-<itemize>
-<item>none
-<item>bold
-<item>underline
-<item>reverse
-<item>standout
-</itemize>
-
-<sect1>Ignoring (weeding) unwanted message headers<label id="ignore">
-<p>
-Usage: <tt/[un]ignore/ <em/pattern/ [ <em/pattern/ ... ]
-
+</para>
+
+<para>
+Usage: <literal remap="tt">mono</literal> <emphasis><object>
<attribute></emphasis> [ <emphasis>regexp</emphasis> ]
+
+Usage: <literal remap="tt">mono</literal> index <emphasis>attribute</emphasis>
<emphasis>pattern</emphasis>
+
+Usage: <literal remap="tt">unmono</literal> index <emphasis>pattern</emphasis>
[ <emphasis>pattern</emphasis> ... ]
+
+</para>
+
+<para>
+where <emphasis>attribute</emphasis> is one of the following:
+</para>
+
+<para>
+
+<itemizedlist>
+<listitem>
+
+<para>
+none
+</para>
+</listitem>
+<listitem>
+
+<para>
+bold
+</para>
+</listitem>
+<listitem>
+
+<para>
+underline
+</para>
+</listitem>
+<listitem>
+
+<para>
+reverse
+</para>
+</listitem>
+<listitem>
+
+<para>
+standout
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+</sect2>
+
+<sect2 id="ignore">
+<title>Ignoring (weeding) unwanted message headers</title>
+
+<para>
+Usage: <literal remap="tt">[un]ignore</literal>
<emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
+</para>
+
+<para>
Messages often have many header fields added by automatic processing systems,
or which may not seem useful to display on the screen. This command allows
you to specify header fields which you don't normally want to see.
-
+</para>
+
+<para>
You do not need to specify the full header field name. For example,
``ignore content-'' will ignore all header fields that begin with the pattern
``content-''. ``ignore *'' will ignore all headers.
-
+</para>
+
+<para>
To remove a previously added token from the list, use the ``unignore'' command.
The ``unignore'' command will make Mutt display headers with the given pattern.
For example, if you do ``ignore x-'' it is possible to ``unignore x-mailer''.
-
+</para>
+
+<para>
``unignore *'' will remove all tokens from the ignore list.
-
+</para>
+
+<para>
For example:
-<tscreen><verb>
+
+<screen>
# Sven's draconian header weeding
ignore *
unignore from date subject to cc
unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
unignore posted-to:
-</verb></tscreen>
-
-<sect1>Alternative addresses<label id="alternates">
-<p>
-Usage: <tt/[un]alternates/ <em/regexp/ [ <em/regexp/ ...
]<newline>
-
+</screen>
+
+</para>
+
+</sect2>
+
+<sect2 id="alternates">
+<title>Alternative addresses</title>
+
+<para>
+Usage: <literal remap="tt">[un]alternates</literal>
<emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+
+</para>
+
+<para>
With various functions, mutt will treat messages differently,
depending on whether you sent them or whether you received them from
someone else. For instance, when replying to a message that you
sent to a different party, mutt will automatically suggest to send
the response to the original message's recipients -- responding to
-yourself won't make much sense in many cases. (See <ref
-id="reply_to" name="$reply_to">.)
-
+yourself won't make much sense in many cases. (See <xref
LinkEnd="reply-to"/>.)
+</para>
+
+<para>
Many users receive e-mail under a number of different addresses. To
fully use mutt's features here, the program must be able to
recognize what e-mail addresses you receive mail under. That's the
-purpose of the <tt/alternates/ command: It takes a list of regular
+purpose of the <literal remap="tt">alternates</literal> command: It takes a
list of regular
expressions, each of which can identify an address under which you
receive e-mail.
-
-The <tt/unalternates/ command can be used to write exceptions to
-<tt/alternates/ patterns. If an address matches something in an
-<tt/alternates/ command, but you nonetheless do not think it is
-from you, you can list a more precise pattern under an <tt/unalternates/
+</para>
+
+<para>
+The <literal remap="tt">unalternates</literal> command can be used to write
exceptions to
+<literal remap="tt">alternates</literal> patterns. If an address matches
something in an
+<literal remap="tt">alternates</literal> command, but you nonetheless do not
think it is
+from you, you can list a more precise pattern under an <literal
remap="tt">unalternates</literal>
command.
-
-To remove a regular expression from the <tt/alternates/ list, use the
-<tt/unalternates/ command with exactly the same <em/regexp/.
-Likewise, if the <em/regexp/ for a <tt/alternates/ command matches
-an entry on the <tt/unalternates/ list, that <tt/unalternates/
-entry will be removed. If the <em/regexp/ for <tt/unalternates/
-is ``*'', <em/all entries/ on <tt/alternates/ will be removed.
-
-<sect1>Mailing lists<label id="lists">
-<p>
-Usage: <tt/[un]lists/ <em/regexp/ [ <em/regexp/ ...
]<newline>
-Usage: <tt/[un]subscribe/ <em/regexp/ [ <em/regexp/ ... ]
-
-Mutt has a few nice features for <ref id="using_lists" name="handling
-mailing lists">. In order to take advantage of them, you must
+</para>
+
+<para>
+To remove a regular expression from the <literal
remap="tt">alternates</literal> list, use the
+<literal remap="tt">unalternates</literal> command with exactly the same
<emphasis>regexp</emphasis>.
+Likewise, if the <emphasis>regexp</emphasis> for a <literal
remap="tt">alternates</literal> command matches
+an entry on the <literal remap="tt">unalternates</literal> list, that <literal
remap="tt">unalternates</literal>
+entry will be removed. If the <emphasis>regexp</emphasis> for <literal
remap="tt">unalternates</literal>
+is ``*'', <emphasis>all entries</emphasis> on <literal
remap="tt">alternates</literal> will be removed.
+</para>
+
+</sect2>
+
+<sect2 id="lists">
+<title>Mailing lists</title>
+
+<para>
+Usage: <literal remap="tt">[un]lists</literal>
<emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+
+Usage: <literal remap="tt">[un]subscribe</literal>
<emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+</para>
+
+<para>
+Mutt has a few nice features for <xref LinkEnd="using-lists"/>. In order to
take advantage of them, you must
specify which addresses belong to mailing lists, and which mailing
-lists you are subscribed to. Once you have done this, the <ref
-id="list-reply" name="list-reply"> function will work for all known lists.
+lists you are subscribed to. Once you have done this, the <xref
LinkEnd="list-reply"/> function will work for all known lists.
Additionally, when you send a message to a subscribed list, mutt will
add a Mail-Followup-To header to tell other users' mail user agents
not to send copies of replies to your personal address. Note that
the Mail-Followup-To header is a non-standard extension which is not
supported by all mail user agents. Adding it is not bullet-proof against
receiving personal CCs of list messages. Also note that the generation
-of the Mail-Followup-To header is controlled by the <ref id="followup_to"
-name="$followup_to"> configuration variable.
-
+of the Mail-Followup-To header is controlled by the <xref
LinkEnd="followup-to"/> configuration variable.
+</para>
+
+<para>
More precisely, Mutt maintains lists of patterns for the addresses
of known and subscribed mailing lists. Every subscribed mailing
list is known. To mark a mailing list as known, use the ``lists''
command. To mark it as subscribed, use ``subscribe''.
-
+</para>
+
+<para>
You can use regular expressions with both commands. To mark all
messages sent to a specific bug report's address on mutt's bug
tracking system as list mail, for instance, you could say
-``subscribe [0-9]*@bugs.guug.de''. Often, it's sufficient to just
+``subscribe [0-9]*@bugs.guug.de''. Often, it's sufficient to just
give a portion of the list's e-mail address.
-
+</para>
+
+<para>
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@xxxxxxxx/. So, to tell Mutt that this is a
+addresssed to <emphasis>mutt-users@xxxxxxxx</emphasis>. So, to tell Mutt that
this is a
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 instead.
If you also happen to get mail from someone whose address is
-<em/mutt-users@xxxxxxxxxxx/, you could use ``lists
mutt-users@mutt\\.org''
+<emphasis>mutt-users@xxxxxxxxxxx</emphasis>, you could use ``lists
mutt-users@mutt\\.org''
or ``subscribe mutt-users@mutt\\.org'' to
match only mail from the actual list.
-
+</para>
+
+<para>
The ``unlists'' command is used to remove a token from the list of
known and subscribed mailing-lists. Use ``unlists *'' to remove all
tokens.
-
+</para>
+
+<para>
To remove a mailing list from the list of subscribed mailing lists,
but keep it on the list of known mailing lists, use ``unsubscribe''.
-
-<sect1>Using Multiple spool mailboxes<label id="mbox-hook">
-<p>
-Usage: <tt/mbox-hook/ [!]<em/pattern/ <em/mailbox/
-
+</para>
+
+</sect2>
+
+<sect2 id="mbox-hook">
+<title>Using Multiple spool mailboxes</title>
+
+<para>
+Usage: <literal remap="tt">mbox-hook</literal>
[!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
+</para>
+
+<para>
This command is used to move read messages from a specified mailbox to a
different mailbox automatically when you quit or change folders.
-<em/pattern/ is a regular expression specifying the mailbox to treat as a
-``spool'' mailbox and <em/mailbox/ specifies where mail should be saved when
+<emphasis>pattern</emphasis> is a regular expression specifying the mailbox to
treat as a
+``spool'' mailbox and <emphasis>mailbox</emphasis> specifies where mail should
be saved when
read.
-
-Unlike some of the other <em/hook/ commands, only the <em/first/ matching
+</para>
+
+<para>
+Unlike some of the other <emphasis>hook</emphasis> commands, only the
<emphasis>first</emphasis> matching
pattern is used (it is not possible to save read mail in more than a single
mailbox).
-
-<sect1>Defining mailboxes which receive mail<label id="mailboxes">
-<p>
-Usage: <tt/[un]mailboxes/ [!]<em/filename/ [
<em/filename/ ... ]
-
+</para>
+
+</sect2>
+
+<sect2 id="mailboxes">
+<title>Defining mailboxes which receive mail</title>
+
+<para>
+Usage: <literal remap="tt">[un]mailboxes</literal>
[!]<emphasis>filename</emphasis> [ <emphasis>filename</emphasis>
... ]
+</para>
+
+<para>
This command specifies folders which can receive mail and
which will be checked for new messages. By default, the
main menu status bar displays how many of these folders have
new messages.
-<p>
-When changing folders, pressing <em/space/ will cycle
+</para>
+
+<para>
+When changing folders, pressing <emphasis>space</emphasis> will cycle
through folders with new mail.
-<p>
+</para>
+
+<para>
Pressing TAB in the directory browser will bring up a menu showing the files
-specified by the <tt/mailboxes/ command, and indicate which contain new
+specified by the <literal remap="tt">mailboxes</literal> command, and indicate
which contain new
messages. Mutt will automatically enter this mode when invoked from the
-command line with the <tt/-y/ option.
-
+command line with the <literal remap="tt">-y</literal> option.
+</para>
+
+<para>
The ``unmailboxes'' command is used to remove a token from the list
of folders which receive mail. Use ``unmailboxes *'' to remove all
tokens.
-
-<p>
-<bf/Note:/ new mail is detected by comparing the last modification time to
-the last access time. Utilities like <tt/biff/ or <tt/frm/ or any other
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> new mail is detected by comparing the
last modification time to
+the last access time. Utilities like <literal remap="tt">biff</literal> or
<literal remap="tt">frm</literal> or any other
program which accesses the mailbox might cause Mutt to never detect new mail
for that mailbox if they do not properly reset the access time. Backup
tools are another common reason for updated access times.
-<p>
-
-<bf/Note:/ the filenames in the <tt/mailboxes/ command are resolved when
-the command is executed, so if these names contain <ref id="shortcuts"
-name="shortcut characters"> (such as ``='' and ``!''), any variable
-definition that affect these characters (like <ref id="folder"
-name="$folder"> and <ref id="spoolfile" name="$spoolfile">)
-should be executed before the <tt/mailboxes/ command.
-
-<sect1>User defined headers<label id="my_hdr">
-<p>
-Usage:<newline>
-<tt/my_hdr/ <em/string/<newline>
-<tt/unmy_hdr/ <em/field/ [ <em/field/ ... ]
-
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> the filenames in the <literal
remap="tt">mailboxes</literal> command are resolved when
+the command is executed, so if these names contain <xref LinkEnd="shortcuts"/>
(such as ``='' and ``!''), any variable
+definition that affect these characters (like <xref LinkEnd="folder"/> and
<xref LinkEnd="spoolfile"/>)
+should be executed before the <literal remap="tt">mailboxes</literal> command.
+</para>
+
+</sect2>
+
+<sect2 id="my-hdr">
+<title>User defined headers</title>
+
+<para>
+Usage:
+
+<literal remap="tt">my_hdr</literal> <emphasis>string</emphasis>
+
+<literal remap="tt">unmy_hdr</literal> <emphasis>field</emphasis>
[ <emphasis>field</emphasis> ... ]
+</para>
+
+<para>
The ``my_hdr'' command allows you to create your own header
fields which will be added to every message you send.
-
+</para>
+
+<para>
For example, if you would like to add an ``Organization:'' header field to
all of your outgoing messages, you can put the command
-
-<quote>
-my_hdr Organization: A Really Big Company, Anytown, USA
-</quote>
-
-in your <tt/.muttrc/.
-
-<bf/Note:/ space characters are <em/not/ allowed between the keyword and
+</para>
+
+<para>
+<quote
+>my_hdr Organization: A Really Big Company, Anytown, USA</quote
+>
+</para>
+
+<para>
+in your <literal remap="tt">.muttrc</literal>.
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> space characters are
<emphasis>not</emphasis> allowed between the keyword and
the colon (``:''). The standard for electronic mail (RFC822) says that
space is illegal there, so Mutt enforces the rule.
-
+</para>
+
+<para>
If you would like to add a header field to a single message, you should
-either set the <ref id="edit_headers" name="edit_headers"> variable,
-or use the <em/edit-headers/ function (default: ``E'') in the send-menu so
+either set the <xref LinkEnd="edit-headers"/> variable,
+or use the <emphasis>edit-headers</emphasis> function (default: ``E'') in the
send-menu so
that you can edit the header of your message along with the body.
-
+</para>
+
+<para>
To remove user defined header fields, use the ``unmy_hdr''
command. You may specify an asterisk (``*'') to remove all header
fields, or the fields to remove. For example, to remove all ``To'' and
``Cc'' header fields, you could use:
-
-<quote>
-unmy_hdr to cc
-</quote>
-
-<sect1>Defining the order of headers when viewing messages<label
id="hdr_order">
-<p>
-Usage: <tt/hdr_order/ <em/header1/ <em/header2/ <em/header3/
-
+</para>
+
+<para>
+<quote
+>unmy_hdr to cc</quote
+>
+</para>
+
+</sect2>
+
+<sect2 id="hdr-order">
+<title>Defining the order of headers when viewing messages</title>
+
+<para>
+Usage: <literal remap="tt">hdr_order</literal>
<emphasis>header1</emphasis> <emphasis>header2</emphasis>
<emphasis>header3</emphasis>
+</para>
+
+<para>
With this command, you can specify an order in which mutt will attempt
to present headers to you when viewing messages.
-
-``unhdr_order *'' will clear all previous headers from the order list,
+</para>
+
+<para>
+``unhdr_order *'' will clear all previous headers from the order list,
thus removing the header order effects set by the system-wide startup
file.
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
hdr_order From Date: From: To: Cc: Subject:
-</verb></tscreen>
-
-<sect1>Specify default save filename<label id="save-hook">
-<p>
-Usage: <tt/save-hook/ [!]<em/pattern/ <em/filename/
-
+</screen>
+
+</para>
+
+</sect2>
+
+<sect2 id="save-hook">
+<title>Specify default save filename</title>
+
+<para>
+Usage: <literal remap="tt">save-hook</literal>
[!]<emphasis>pattern</emphasis> <emphasis>filename</emphasis>
+</para>
+
+<para>
This command is used to override the default filename used when saving
-messages. <em/filename/ will be used as the default filename if the message is
-<em/From:/ an address matching <em/regexp/ or if you are the author and the
-message is addressed <em/to:/ something matching <em/regexp/.
-
-See <ref id="pattern_hook" name="Message Matching in Hooks"> for information
on the exact format of <em/pattern/.
-
+messages. <emphasis>filename</emphasis> will be used as the default filename
if the message is
+<emphasis>From:</emphasis> an address matching <emphasis>regexp</emphasis> or
if you are the author and the
+message is addressed <emphasis>to:</emphasis> something matching
<emphasis>regexp</emphasis>.
+</para>
+
+<para>
+See <xref LinkEnd="pattern-hook"/> for information on the exact format of
<emphasis>pattern</emphasis>.
+</para>
+
+<para>
Examples:
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
save-hook aol\\.com$ +spam
-</verb></tscreen>
-
-Also see the <ref id="fcc-save-hook" name="fcc-save-hook"> command.
-
-<sect1>Specify default Fcc: mailbox when composing<label id="fcc-hook">
-<p>
-Usage: <tt/fcc-hook/ [!]<em/pattern/ <em/mailbox/
-
+</screen>
+
+</para>
+
+<para>
+Also see the <xref LinkEnd="fcc-save-hook"/> command.
+</para>
+
+</sect2>
+
+<sect2 id="fcc-hook">
+<title>Specify default Fcc: mailbox when composing</title>
+
+<para>
+Usage: <literal remap="tt">fcc-hook</literal>
[!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
+</para>
+
+<para>
This command is used to save outgoing mail in a mailbox other than
-<ref id="record" name="$record">. Mutt searches the initial list of
-message recipients for the first matching <em/regexp/ and uses <em/mailbox/
+<xref LinkEnd="record"/>. Mutt searches the initial list of
+message recipients for the first matching <emphasis>regexp</emphasis> and uses
<emphasis>mailbox</emphasis>
as the default Fcc: mailbox. If no match is found the message will be saved
-to <ref id="record" name="$record"> mailbox.
-
-See <ref id="pattern_hook" name="Message Matching in Hooks"> for information
on the exact format of <em/pattern/.
-
-Example: <tt/fcc-hook [@.]aol\\.com$ +spammers/
-
+to <xref LinkEnd="record"/> mailbox.
+</para>
+
+<para>
+See <xref LinkEnd="pattern-hook"/> for information on the exact format of
<emphasis>pattern</emphasis>.
+</para>
+
+<para>
+Example: <literal remap="tt">fcc-hook
[@.]aol\\.com$ +spammers</literal>
+</para>
+
+<para>
The above will save a copy of all messages going to the aol.com domain to
-the `+spammers' mailbox by default. Also see the <ref id="fcc-save-hook"
-name="fcc-save-hook"> command.
-
-<sect1>Specify default save filename and default Fcc: mailbox at once<label
-id="fcc-save-hook">
-<p>
-Usage: <tt/fcc-save-hook/ [!]<em/pattern/ <em/mailbox/
-
-This command is a shortcut, equivalent to doing both a <ref id="fcc-hook"
name="fcc-hook">
-and a <ref id="save-hook" name="save-hook"> with its arguments.
-
-<sect1>Change settings based upon message recipients<label
id="send-hook"><label id="reply-hook"><label id="send2-hook">
-<p>
-Usage: <tt/reply-hook/ [!]<em/pattern/ <em/command/<newline>
-Usage: <tt/send-hook/ [!]<em/pattern/ <em/command/<newline>
-Usage: <tt/send2-hook/ [!]<em/pattern/ <em/command/
-
+the `+spammers' mailbox by default. Also see the <xref
LinkEnd="fcc-save-hook"/> command.
+</para>
+
+</sect2>
+
+<sect2 id="fcc-save-hook">
+<title>Specify default save filename and default Fcc: mailbox at once</title>
+
+<para>
+Usage: <literal remap="tt">fcc-save-hook</literal>
[!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
+</para>
+
+<para>
+This command is a shortcut, equivalent to doing both a <xref
LinkEnd="fcc-hook"/>
+and a <xref LinkEnd="save-hook"/> with its arguments.
+</para>
+
+</sect2>
+
+<sect2 id="send-hook">
+<title>Change settings based upon message recipients</title>
+
+<para>
+Usage: <literal remap="tt">reply-hook</literal>
[!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
+
+Usage: <literal remap="tt">send-hook</literal>
[!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
+
+Usage: <literal remap="tt">send2-hook</literal>
[!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
+</para>
+
+<para>
These commands can be used to execute arbitrary configuration commands based
-upon recipients of the message. <em/pattern/ is a regular expression
-matching the desired address. <em/command/ is executed when <em/regexp/
+upon recipients of the message. <emphasis>pattern</emphasis> is a regular
expression
+matching the desired address. <emphasis>command</emphasis> is executed when
<emphasis>regexp</emphasis>
matches recipients of the message.
-
-<tt/reply-hook/ is matched against the message you are <em/replying/
-<bf/to/, instead of the message you are <em/sending/. <tt/send-hook/ is
-matched against all messages, both <em/new/ and <em/replies/. <bf/Note:/
-<tt/reply-hook/s are matched <bf/before/ the <tt/send-hook/, <bf/regardless/
+</para>
+
+<para>
+<literal remap="tt">reply-hook</literal> is matched against the message you
are <emphasis>replying</emphasis>
+<emphasis remap="bf">to</emphasis>, instead of the message you are
<emphasis>sending</emphasis>. <literal remap="tt">send-hook</literal> is
+matched against all messages, both <emphasis>new</emphasis> and
<emphasis>replies</emphasis>. <emphasis remap="bf">Note:</emphasis>
+<literal remap="tt">reply-hook</literal>s are matched <emphasis
remap="bf">before</emphasis> the <literal remap="tt">send-hook</literal>,
<emphasis remap="bf">regardless</emphasis>
of the order specified in the users's configuration file.
-
-<tt/send2-hook/ is matched every time a message is changed, either
+</para>
+
+<para>
+<literal remap="tt">send2-hook</literal> is matched every time a message is
changed, either
by editing it, or by using the compose menu to change its recipients
-or subject. <tt/send2-hook/ is executed after <tt/send-hook/, and
-can, e.g., be used to set parameters such as the <ref id="sendmail"
-name="$sendmail"> variable depending on the message's sender
+or subject. <literal remap="tt">send2-hook</literal> is executed after
<literal remap="tt">send-hook</literal>, and
+can, e.g., be used to set parameters such as the <xref LinkEnd="sendmail"/>
variable depending on the message's sender
address.
-
-For each type of <tt/send-hook/ or <tt/reply-hook/, when multiple matches
+</para>
+
+<para>
+For each type of <literal remap="tt">send-hook</literal> or <literal
remap="tt">reply-hook</literal>, when multiple matches
occur, commands are executed in the order they are specified in the muttrc
(for that type of hook).
-
-See <ref id="pattern_hook" name="Message Matching in Hooks"> for information
on the exact format of <em/pattern/.
-
-Example: <tt/send-hook mutt &dquot;set mime_forward signature=''&dquot;/
-
+</para>
+
+<para>
+See <xref LinkEnd="pattern-hook"/> for information on the exact format of
<emphasis>pattern</emphasis>.
+</para>
+
+<para>
+Example: <literal remap="tt">send-hook mutt "set mime_forward
signature=''"</literal>
+</para>
+
+<para>
Another typical use for this command is to change the values of the
-<ref id="attribution" name="$attribution">, <ref id="signature"
-name="$signature"> and <ref id="locale" name="$locale">
+<xref LinkEnd="attribution"/>, <xref LinkEnd="signature"/> and <xref
LinkEnd="locale"/>
variables in order to change the language of the attributions and
signatures based upon the recipients.
-
-<bf/Note:/ the send-hook's are only executed ONCE after getting the initial
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> the send-hook's are only executed ONCE
after getting the initial
list of recipients. Adding a recipient after replying or editing the
message will NOT cause any send-hook to be executed. Also note that
-my_hdr commands which modify recipient headers, or the message's
+my_hdr commands which modify recipient headers, or the message's
subject, don't have any effect on the current message when executed
from a send-hook.
-
-<sect1>Change settings before formatting a message<label id="message-hook">
-<p>
-Usage: <tt/message-hook/ [!]<em/pattern/ <em/command/
-
+</para>
+
+</sect2>
+
+<sect2 id="message-hook">
+<title>Change settings before formatting a message</title>
+
+<para>
+Usage: <literal remap="tt">message-hook</literal>
[!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
+</para>
+
+<para>
This command can be used to execute arbitrary configuration commands
before viewing or formatting a message based upon information about the
message.
-<em/command/ is executed if the <em/pattern/ matches the message to be
+<emphasis>command</emphasis> is executed if the <emphasis>pattern</emphasis>
matches the message to be
displayed. When multiple matches occur, commands are executed in the order
they are specified in the muttrc.
-
-See <ref id="pattern_hook" name="Message Matching in Hooks"> for
-information on the exact format of <em/pattern/.
-
+</para>
+
+<para>
+See <xref LinkEnd="pattern-hook"/> for
+information on the exact format of <emphasis>pattern</emphasis>.
+</para>
+
+<para>
Example:
-<tscreen><verb>
+
+<screen>
message-hook ~A 'set pager=builtin'
message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""'
-</verb></tscreen>
-
-<sect1>Choosing the cryptographic key of the recipient<label id="crypt-hook">
-<p>
-Usage: <tt/crypt-hook/ <em/pattern/ <em/keyid/
-
+</screen>
+
+</para>
+
+</sect2>
+
+<sect2 id="crypt-hook">
+<title>Choosing the cryptographic key of the recipient</title>
+
+<para>
+Usage: <literal remap="tt">crypt-hook</literal> <emphasis>pattern</emphasis>
<emphasis>keyid</emphasis>
+</para>
+
+<para>
When encrypting messages with PGP or OpenSSL, you may want to associate a
certain
key with a given e-mail address automatically, either because the
recipient's public key can't be deduced from the destination address,
@@ -1474,403 +2522,745 @@
normally use. The crypt-hook command provides a method by which you can
specify the ID of the public key to be used when encrypting messages to
a certain recipient.
-
+</para>
+
+<para>
The meaning of "key id" is to be taken broadly in this context: You
can either put a numerical key ID here, an e-mail address, or even
just a real name.
-
-<sect1>Adding key sequences to the keyboard buffer<label id="push">
-<p>
-Usage: <tt/push/ <em/string/
-
+</para>
+
+</sect2>
+
+<sect2 id="push">
+<title>Adding key sequences to the keyboard buffer</title>
+
+<para>
+Usage: <literal remap="tt">push</literal> <emphasis>string</emphasis>
+</para>
+
+<para>
This command adds the named string to the keyboard buffer. The string may
contain control characters, key names and function names like the sequence
-string in the <ref id="macro" name="macro"> command. You may use it to
+string in the <xref LinkEnd="macro"/> command. You may use it to
automatically run a sequence of commands at startup, or when entering
certain folders.
-
-<sect1>Executing functions<label id="exec">
-<p>
-Usage: <tt/exec/ <em/function/ [ <em/function/ ... ]
-
+</para>
+
+</sect2>
+
+<sect2 id="exec">
+<title>Executing functions</title>
+
+<para>
+Usage: <literal remap="tt">exec</literal> <emphasis>function</emphasis> [
<emphasis>function</emphasis> ... ]
+</para>
+
+<para>
This command can be used to execute any function. Functions are
-listed in the <ref id="functions" name="function reference">.
+listed in the <xref LinkEnd="functions"/>.
``exec function'' is equivalent to ``push <function>''.
-
-<sect1>Message Scoring<label id="score-command">
-<p>
-Usage: <tt/score/ <em/pattern/ <em/value/<newline>
-Usage: <tt/unscore/ <em/pattern/ [ <em/pattern/ ... ]
-
-The <tt/score/ commands adds <em/value/ to a message's score if <em/pattern/
-matches it. <em/pattern/ is a string in the format described in the <ref
-id="patterns" name="patterns"> section (note: For efficiency reasons, patterns
-which scan information not available in the index, such as <tt>˜b</tt>,
-<tt>˜B</tt> or <tt>˜h</tt>, may not be used). <em/value/ is a
+</para>
+
+</sect2>
+
+<sect2 id="score-command">
+<title>Message Scoring</title>
+
+<para>
+Usage: <literal remap="tt">score</literal> <emphasis>pattern</emphasis>
<emphasis>value</emphasis>
+
+Usage: <literal remap="tt">unscore</literal> <emphasis>pattern</emphasis>
[ <emphasis>pattern</emphasis> ... ]
+</para>
+
+<para>
+The <literal remap="tt">score</literal> commands adds
<emphasis>value</emphasis> to a message's score if <emphasis>pattern</emphasis>
+matches it. <emphasis>pattern</emphasis> is a string in the format described
in the <xref LinkEnd="patterns"/> section (note: For efficiency reasons,
patterns
+which scan information not available in the index, such as <literal
remap="tt">˜b</literal>,
+<literal remap="tt">˜B</literal> or <literal
remap="tt">˜h</literal>, may not be used). <emphasis>value</emphasis> is
a
positive or negative integer. A message's final score is the sum total of all
-matching <tt/score/ entries. However, you may optionally prefix <em/value/
with
+matching <literal remap="tt">score</literal> entries. However, you may
optionally prefix <emphasis>value</emphasis> with
an equal sign (=) to cause evaluation to stop at a particular entry if there is
a match. Negative final scores are rounded up to 0.
-
-The <tt/unscore/ command removes score entries from the list. You <bf/must/
-specify the same pattern specified in the <tt/score/ command for it to be
+</para>
+
+<para>
+The <literal remap="tt">unscore</literal> command removes score entries from
the list. You <emphasis remap="bf">must</emphasis>
+specify the same pattern specified in the <literal remap="tt">score</literal>
command for it to be
removed. The pattern ``*'' is a special token which means to clear the list
of all score entries.
-
-<sect1>Spam detection<label id="spam">
-<p>
-Usage: <tt/spam/ <em/pattern/ <em/format/<newline>
-Usage: <tt/nospam/ <em/pattern/
-
+</para>
+
+</sect2>
+
+<sect2 id="spam">
+<title>Spam detection</title>
+
+<para>
+Usage: <literal remap="tt">spam</literal> <emphasis>pattern</emphasis>
<emphasis>format</emphasis>
+
+Usage: <literal remap="tt">nospam</literal> <emphasis>pattern</emphasis>
+</para>
+
+<para>
Mutt has generalized support for external spam-scoring filters.
-By defining your spam patterns with the <tt/spam/ and <tt/nospam/
-commands, you can <em/limit/, <em/search/, and <em/sort/ your
+By defining your spam patterns with the <literal remap="tt">spam</literal> and
<literal remap="tt">nospam</literal>
+commands, you can <emphasis>limit</emphasis>, <emphasis>search</emphasis>, and
<emphasis>sort</emphasis> your
mail based on its spam attributes, as determined by the external
filter. You also can display the spam attributes in your index
-display using the <tt/%H/ selector in the <ref id="index_format"
-name="$index_format"> variable. (Tip: try <tt/%?H?[%H] ?/
+display using the <literal remap="tt">%H</literal> selector in the
<xref LinkEnd="index-format"/> variable. (Tip: try <literal
remap="tt">%?H?[%H] ?</literal>
to display spam tags only when they are defined for a given message.)
-
+</para>
+
+<para>
Your first step is to define your external filter's spam patterns using
-the <tt/spam/ command. <em/pattern/ should be a regular expression
+the <literal remap="tt">spam</literal> command. <emphasis>pattern</emphasis>
should be a regular expression
that matches a header in a mail message. If any message in the mailbox
matches this regular expression, it will receive a ``spam tag'' or
-``spam attribute'' (unless it also matches a <tt/nospam/ pattern -- see
+``spam attribute'' (unless it also matches a <literal
remap="tt">nospam</literal> pattern -- see
below.) The appearance of this attribute is entirely up to you, and is
-governed by the <em/format/ parameter. <em/format/ can be any static
-text, but it also can include back-references from the <em/pattern/
+governed by the <emphasis>format</emphasis> parameter.
<emphasis>format</emphasis> can be any static
+text, but it also can include back-references from the
<emphasis>pattern</emphasis>
expression. (A regular expression ``back-reference'' refers to a
-sub-expression contained within parentheses.) <tt/%1/ is replaced with
-the first back-reference in the regex, <tt/%2/ with the second, etc.
-
+sub-expression contained within parentheses.) <literal
remap="tt">%1</literal> is replaced with
+the first back-reference in the regex, <literal remap="tt">%2</literal>
with the second, etc.
+</para>
+
+<para>
If you're using multiple spam filters, a message can have more than
-one spam-related header. You can define <tt/spam/ patterns for each
+one spam-related header. You can define <literal remap="tt">spam</literal>
patterns for each
filter you use. If a message matches two or more of these patterns, and
the $spam_separator variable is set to a string, then the
-message's spam tag will consist of all the <em/format/ strings joined
+message's spam tag will consist of all the <emphasis>format</emphasis> strings
joined
together, with the value of $spam_separator separating
them.
-
+</para>
+
+<para>
For example, suppose I use DCC, SpamAssassin, and PureMessage. I might
define these spam settings:
-<tscreen><verb>
+
+<screen>
spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1"
spam "X-Spam-Status: Yes" "90+/SA"
spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
set spam_separator=", "
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
If I then received a message that DCC registered with ``many'' hits
under the ``Fuz2'' checksum, and that PureMessage registered with a
-97% probability of being spam, that message's spam tag would read
-<tt>90+/DCC-Fuz2, 97/PM</tt>. (The four characters before ``=many'' in a
+97% probability of being spam, that message's spam tag would read
+<literal remap="tt">90+/DCC-Fuz2, 97/PM</literal>. (The four characters before
``=many'' in a
DCC report indicate the checksum used -- in this case, ``Fuz2''.)
-
+</para>
+
+<para>
If the $spam_separator variable is unset, then each
spam pattern match supercedes the previous one. Instead of getting
-joined <em/format/ strings, you'll get only the last one to match.
-
+joined <emphasis>format</emphasis> strings, you'll get only the last one to
match.
+</para>
+
+<para>
The spam tag is what will be displayed in the index when you use
-<tt/%H/ in the <tt/$index_format/ variable. It's also the
-string that the <tt/~H/ pattern-matching expression matches against for
-<em/search/ and <em/limit/ functions. And it's what sorting by spam
+<literal remap="tt">%H</literal> in the <literal
remap="tt">$index_format</literal> variable. It's also the
+string that the <literal remap="tt">˜H</literal> pattern-matching
expression matches against for
+<emphasis>search</emphasis> and <emphasis>limit</emphasis> functions. And it's
what sorting by spam
attribute will use as a sort key.
-
+</para>
+
+<para>
That's a pretty complicated example, and most people's actual
environments will have only one spam filter. The simpler your
configuration, the more effective mutt can be, especially when it comes
to sorting.
-
-Generally, when you sort by spam tag, mutt will sort <em/lexically/ --
+</para>
+
+<para>
+Generally, when you sort by spam tag, mutt will sort
<emphasis>lexically</emphasis> --
that is, by ordering strings alphnumerically. However, if a spam tag
begins with a number, mutt will sort numerically first, and lexically
only when two numbers are equal in value. (This is like UNIX's
-<tt/sort -n/.) A message with no spam attributes at all -- that is, one
-that didn't match <em/any/ of your <tt/spam/ patterns -- is sorted at
+<literal remap="tt">sort -n</literal>.) A message with no spam attributes at
all -- that is, one
+that didn't match <emphasis>any</emphasis> of your <literal
remap="tt">spam</literal> patterns -- is sorted at
lowest priority. Numbers are sorted next, beginning with 0 and ranging
upward. Finally, non-numeric strings are sorted, with ``a'' taking lower
priority than ``z''. Clearly, in general, sorting by spam tags is most
effective when you can coerce your filter to give you a raw number. But
in case you can't, mutt can still do something useful.
-
-The <tt/nospam/ command can be used to write exceptions to <tt/spam/
-patterns. If a header pattern matches something in a <tt/spam/ command,
+</para>
+
+<para>
+The <literal remap="tt">nospam</literal> command can be used to write
exceptions to <literal remap="tt">spam</literal>
+patterns. If a header pattern matches something in a <literal
remap="tt">spam</literal> command,
but you nonetheless do not want it to receive a spam tag, you can list a
-more precise pattern under a <tt/nospam/ command.
-
-If the <em/pattern/ given to <tt/nospam/ is exactly the same as the
-<em/pattern/ on an existing <tt/spam/ list entry, the effect will be to
+more precise pattern under a <literal remap="tt">nospam</literal> command.
+</para>
+
+<para>
+If the <emphasis>pattern</emphasis> given to <literal
remap="tt">nospam</literal> is exactly the same as the
+<emphasis>pattern</emphasis> on an existing <literal remap="tt">spam</literal>
list entry, the effect will be to
remove the entry from the spam list, instead of adding an exception.
-Likewise, if the <em/pattern/ for a <tt/spam/ command matches an entry
-on the <tt/nospam/ list, that <tt/nospam/ entry will be removed. If the
-<em/pattern/ for <tt/nospam/ is ``*'', <em/all entries on both lists/
-will be removed. This might be the default action if you use <tt/spam/
-and <tt/nospam/ in conjunction with a <tt/folder-hook/.
-
-You can have as many <tt/spam/ or <tt/nospam/ commands as you like.
+Likewise, if the <emphasis>pattern</emphasis> for a <literal
remap="tt">spam</literal> command matches an entry
+on the <literal remap="tt">nospam</literal> list, that <literal
remap="tt">nospam</literal> entry will be removed. If the
+<emphasis>pattern</emphasis> for <literal remap="tt">nospam</literal> is
``*'', <emphasis>all entries on both lists</emphasis>
+will be removed. This might be the default action if you use <literal
remap="tt">spam</literal>
+and <literal remap="tt">nospam</literal> in conjunction with a <literal
remap="tt">folder-hook</literal>.
+</para>
+
+<para>
+You can have as many <literal remap="tt">spam</literal> or <literal
remap="tt">nospam</literal> commands as you like.
You can even do your own primitive spam detection within mutt -- for
-example, if you consider all mail from <tt/MAILER-DAEMON/ to be spam,
-you can use a <tt/spam/ command like this:
-
-<tscreen><verb>
+example, if you consider all mail from <literal
remap="tt">MAILER-DAEMON</literal> to be spam,
+you can use a <literal remap="tt">spam</literal> command like this:
+</para>
+
+<para>
+
+<screen>
spam "^From: .*MAILER-DAEMON" "999"
-</verb></tscreen>
-
-
-<sect1>Setting variables<label id="set">
-<p>
-Usage: <tt/set/ [no|inv]<em/variable/[=<em/value/] [
<em/variable/ ... ]<newline>
-Usage: <tt/toggle/ <em/variable/ [<em/variable/ ... ]<newline>
-Usage: <tt/unset/ <em/variable/ [<em/variable/ ... ]<newline>
-Usage: <tt/reset/ <em/variable/ [<em/variable/ ... ]
-
-This command is used to set (and unset) <ref id="variables"
-name="configuration variables">. There are four basic types of variables:
-boolean, number, string and quadoption. <em/boolean/ variables can be
-<em/set/ (true) or <em/unset/ (false). <em/number/ variables can be
+</screen>
+
+</para>
+
+</sect2>
+
+<sect2 id="set">
+<title>Setting variables</title>
+
+<para>
+Usage: <literal remap="tt">set</literal>
[no|inv]<emphasis>variable</emphasis>[=<emphasis>value</emphasis>]
[ <emphasis>variable</emphasis> ... ]
+
+Usage: <literal remap="tt">toggle</literal> <emphasis>variable</emphasis>
[<emphasis>variable</emphasis> ... ]
+
+Usage: <literal remap="tt">unset</literal> <emphasis>variable</emphasis>
[<emphasis>variable</emphasis> ... ]
+
+Usage: <literal remap="tt">reset</literal> <emphasis>variable</emphasis>
[<emphasis>variable</emphasis> ... ]
+</para>
+
+<para>
+This command is used to set (and unset) <xref LinkEnd="variables"/>. There
are four basic types of variables:
+boolean, number, string and quadoption. <emphasis>boolean</emphasis>
variables can be
+<emphasis>set</emphasis> (true) or <emphasis>unset</emphasis> (false).
<emphasis>number</emphasis> variables can be
assigned a positive integer value.
-
-<em/string/ variables consist of any number of printable characters.
-<em/strings/ must be enclosed in quotes if they contain spaces or tabs. You
-may also use the ``C'' escape sequences <bf/\n/ and <bf/\t/ for
+</para>
+
+<para>
+<emphasis>string</emphasis> variables consist of any number of printable
characters.
+<emphasis>strings</emphasis> must be enclosed in quotes if they contain spaces
or tabs. You
+may also use the ``C'' escape sequences <emphasis
remap="bf">\n</emphasis> and <emphasis remap="bf">\t</emphasis> for
newline and tab, respectively.
-
-<em/quadoption/ variables are used to control whether or not to be prompted
-for certain actions, or to specify a default action. A value of <em/yes/
+</para>
+
+<para>
+<emphasis>quadoption</emphasis> variables are used to control whether or not
to be prompted
+for certain actions, or to specify a default action. A value of
<emphasis>yes</emphasis>
will cause the action to be carried out automatically as if you had answered
-yes to the question. Similarly, a value of <em/no/ will cause the the
+yes to the question. Similarly, a value of <emphasis>no</emphasis> will cause
the the
action to be carried out as if you had answered ``no.'' A value of
-<em/ask-yes/ will cause a prompt with a default answer of ``yes'' and
-<em/ask-no/ will provide a default answer of ``no.''
-
-Prefixing a variable with ``no'' will unset it. Example: <tt/set noaskbcc/.
-
-For <em/boolean/ variables, you may optionally prefix the variable name with
-<tt/inv/ to toggle the value (on or off). This is useful when writing
-macros. Example: <tt/set invsmart_wrap/.
-
-The <tt/toggle/ command automatically prepends the <tt/inv/ prefix to all
+<emphasis>ask-yes</emphasis> will cause a prompt with a default answer of
``yes'' and
+<emphasis>ask-no</emphasis> will provide a default answer of ``no.''
+</para>
+
+<para>
+Prefixing a variable with ``no'' will unset it. Example: <literal
remap="tt">set noaskbcc</literal>.
+</para>
+
+<para>
+For <emphasis>boolean</emphasis> variables, you may optionally prefix the
variable name with
+<literal remap="tt">inv</literal> to toggle the value (on or off). This is
useful when writing
+macros. Example: <literal remap="tt">set invsmart_wrap</literal>.
+</para>
+
+<para>
+The <literal remap="tt">toggle</literal> command automatically prepends the
<literal remap="tt">inv</literal> prefix to all
specified variables.
-
-The <tt/unset/ command automatically prepends the <tt/no/ prefix to all
+</para>
+
+<para>
+The <literal remap="tt">unset</literal> command automatically prepends the
<literal remap="tt">no</literal> prefix to all
specified variables.
-
-Using the enter-command function in the <em/index/ menu, you can query the
+</para>
+
+<para>
+Using the enter-command function in the <emphasis>index</emphasis> menu, you
can query the
value of a variable by prefixing the name of the variable with a question
mark:
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
set ?allow_8bit
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
The question mark is actually only required for boolean and quadoption
variables.
-
-The <tt/reset/ command resets all given variables to the compile time
+</para>
+
+<para>
+The <literal remap="tt">reset</literal> command resets all given variables to
the compile time
defaults (hopefully mentioned in this manual). If you use the command
-<tt/set/ and prefix the variable with ``&'' this has the same
+<literal remap="tt">set</literal> and prefix the variable with ``&'' this
has the same
behavior as the reset command.
-
-With the <tt/reset/ command there exists the special variable ``all'',
+</para>
+
+<para>
+With the <literal remap="tt">reset</literal> command there exists the special
variable ``all'',
which allows you to reset all variables to their system defaults.
-
-<sect1>Reading initialization commands from another file<label id="source">
-<p>
-Usage: <tt/source/ <em/filename/
-
+</para>
+
+</sect2>
+
+<sect2 id="source">
+<title>Reading initialization commands from another file</title>
+
+<para>
+Usage: <literal remap="tt">source</literal> <emphasis>filename</emphasis>
+</para>
+
+<para>
This command allows the inclusion of initialization commands
from other files. For example, I place all of my aliases in
-<tt>˜/.mail_aliases</tt> so that I can make my
-<tt>˜/.muttrc</tt> readable and keep my aliases private.
-
+<literal remap="tt">˜/.mail_aliases</literal> so that I can make
my
+<literal remap="tt">˜/.muttrc</literal> readable and keep my aliases
private.
+</para>
+
+<para>
If the filename begins with a tilde (``˜''), it will be expanded to the
path of your home directory.
-
-If the filename ends with a vertical bar (|), then <em/filename/ is
+</para>
+
+<para>
+If the filename ends with a vertical bar (|), then
<emphasis>filename</emphasis> is
considered to be an executable program from which to read input (eg.
-<tt>source ~/bin/myscript|</tt>).
-
-<sect1>Removing hooks<label id="unhook">
-<p>
-Usage: <tt/unhook/ [ * | <em/hook-type/ ]
-
+<literal remap="tt">source ˜/bin/myscript|</literal>).
+</para>
+
+</sect2>
+
+<sect2 id="unhook">
+<title>Removing hooks</title>
+
+<para>
+Usage: <literal remap="tt">unhook</literal> [ * |
<emphasis>hook-type</emphasis> ]
+</para>
+
+<para>
This command permits you to flush hooks you have previously defined.
You can either remove all hooks by giving the ``*'' character as an
argument, or you can remove all hooks of a specific type by saying
-something like <tt/unhook send-hook/.
-
-<sect>Advanced Usage
-
-<sect1>Regular Expressions<label id="regexp">
-<p>
+something like <literal remap="tt">unhook send-hook</literal>.
+</para>
+
+</sect2>
+
+</sect1>
+
+<sect1>
+<title>Advanced Usage</title>
+
+<sect2 id="regexp">
+<title>Regular Expressions</title>
+
+<para>
All string patterns in Mutt including those in more complex
-<ref id="patterns" name="patterns"> must be specified
+<xref LinkEnd="patterns"/> must be specified
using regular expressions (regexp) in the ``POSIX extended'' syntax (which
is more or less the syntax used by egrep and GNU awk). For your
convenience, we have included below a brief description of this syntax.
-
+</para>
+
+<para>
The search is case sensitive if the pattern contains at least one upper
case letter, and case insensitive otherwise. Note that ``\''
must be quoted if used for a regular expression in an initialization
command: ``\\''.
-
+</para>
+
+<para>
A regular expression is a pattern that describes a set of strings.
Regular expressions are constructed analogously to arithmetic
expressions, by using various operators to combine smaller expressions.
-
-Note that the regular expression can be enclosed/delimited by either &dquot;
+</para>
+
+<para>
+Note that the regular expression can be enclosed/delimited by either "
or ' which is useful if the regular expression includes a white-space
-character. See <ref id="muttrc-syntax" name="Syntax of Initialization Files">
-for more information on &dquot; and ' delimiter processing. To match a
-literal &dquot; or ' you must preface it with \ (backslash).
-
+character. See <xref LinkEnd="muttrc-syntax"/>
+for more information on " and ' delimiter processing. To match a
+literal " or ' you must preface it with \ (backslash).
+</para>
+
+<para>
The fundamental building blocks are the regular expressions that match
a single character. Most characters, including all letters and digits,
are regular expressions that match themselves. Any metacharacter with
special meaning may be quoted by preceding it with a backslash.
-
+</para>
+
+<para>
The period ``.'' matches any single character. The caret ``ˆ'' and
-the dollar sign ``&dollar'' are metacharacters that respectively match
+the dollar sign ``$'' are metacharacters that respectively match
the empty string at the beginning and end of a line.
-
+</para>
+
+<para>
A list of characters enclosed by ``['' and ``]'' matches any
single character in that list; if the first character of the list
-is a caret ``ˆ'' then it matches any character <bf/not/ in the
-list. For example, the regular expression <bf/[0123456789]/
+is a caret ``ˆ'' then it matches any character <emphasis
remap="bf">not</emphasis> in the
+list. For example, the regular expression <emphasis
remap="bf">[0123456789]</emphasis>
matches any single digit. A range of ASCII characters may be specified
by giving the first and last characters, separated by a hyphen
``-''. Most metacharacters lose their special meaning inside
lists. To include a literal ``]'' place it first in the list.
Similarly, to include a literal ``ˆ'' place it anywhere but first.
Finally, to include a literal hyphen ``-'' place it last.
-
+</para>
+
+<para>
Certain named classes of characters are predefined. Character classes
consist of ``[:'', a keyword denoting the class, and ``:]''.
The following classes are defined by the POSIX standard:
-
-<descrip>
-<tag/[:alnum:]/
+</para>
+
+<para>
+<variablelist>
+
+<varlistentry>
+<term>[:alnum:]</term>
+<listitem>
+<para>
Alphanumeric characters.
-<tag/[:alpha:]/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>[:alpha:]</term>
+<listitem>
+<para>
Alphabetic characters.
-<tag/[:blank:]/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>[:blank:]</term>
+<listitem>
+<para>
Space or tab characters.
-<tag/[:cntrl:]/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>[:cntrl:]</term>
+<listitem>
+<para>
Control characters.
-<tag/[:digit:]/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>[:digit:]</term>
+<listitem>
+<para>
Numeric characters.
-<tag/[:graph:]/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>[:graph:]</term>
+<listitem>
+<para>
Characters that are both printable and visible. (A space is printable,
but not visible, while an ``a'' is both.)
-<tag/[:lower:]/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>[:lower:]</term>
+<listitem>
+<para>
Lower-case alphabetic characters.
-<tag/[:print:]/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>[:print:]</term>
+<listitem>
+<para>
Printable characters (characters that are not control characters.)
-<tag/[:punct:]/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>[:punct:]</term>
+<listitem>
+<para>
Punctuation characters (characters that are not letter, digits, control
characters, or space characters).
-<tag/[:space:]/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>[:space:]</term>
+<listitem>
+<para>
Space characters (such as space, tab and formfeed, to name a few).
-<tag/[:upper:]/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>[:upper:]</term>
+<listitem>
+<para>
Upper-case alphabetic characters.
-<tag/[:xdigit:]/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>[:xdigit:]</term>
+<listitem>
+<para>
Characters that are hexadecimal digits.
-</descrip>
-
+</para>
+</listitem>
+</varlistentry>
+</variablelist>
+</para>
+
+<para>
A character class is only valid in a regular expression inside the
brackets of a character list. Note that the brackets in these
class names are part of the symbolic names, and must be included
in addition to the brackets delimiting the bracket list. For
-example, <bf/[[:digit:]]/ is equivalent to
-<bf/[0-9]/.
-
+example, <emphasis remap="bf">[[:digit:]]</emphasis> is
equivalent to
+<emphasis remap="bf">[0-9]</emphasis>.
+</para>
+
+<para>
Two additional special sequences can appear in character lists. These
apply to non-ASCII character sets, which can have single symbols (called
collating elements) that are represented with more than one character,
as well as several characters that are equivalent for collating or
sorting purposes:
-
-<descrip>
-<tag/Collating Symbols/
+</para>
+
+<para>
+<variablelist>
+
+<varlistentry>
+<term>Collating Symbols</term>
+<listitem>
+<para>
A collating symbol is a multi-character collating element enclosed in
``[.'' and ``.]''. For example, if ``ch'' is a collating
-element, then <bf/[[.ch.]]/ is a regexp that matches
-this collating element, while <bf/[ch]/ is a regexp that
+element, then <emphasis remap="bf">[[.ch.]]</emphasis> is
a regexp that matches
+this collating element, while <emphasis remap="bf">[ch]</emphasis>
is a regexp that
matches either ``c'' or ``h''.
-<tag/Equivalence Classes/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>Equivalence Classes</term>
+<listitem>
+<para>
An equivalence class is a locale-specific name for a list of
characters that are equivalent. The name is enclosed in ``[=''
and ``=]''. For example, the name ``e'' might be used to
represent all of ``è'' ``é'' and ``e''. In this case,
-<bf/[[=e=]]/ is a regexp that matches any of
+<emphasis remap="bf">[[=e=]]</emphasis> is a regexp that
matches any of
``è'', ``é'' and ``e''.
-</descrip>
-
+</para>
+</listitem>
+</varlistentry>
+</variablelist>
+</para>
+
+<para>
A regular expression matching a single character may be followed by one
of several repetition operators:
-
-<descrip>
-<tag/?/
+</para>
+
+<para>
+<variablelist>
+
+<varlistentry>
+<term>?</term>
+<listitem>
+<para>
The preceding item is optional and matched at most once.
-<tag/*/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>*</term>
+<listitem>
+<para>
The preceding item will be matched zero or more times.
-<tag/+/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>+</term>
+<listitem>
+<para>
The preceding item will be matched one or more times.
-<tag/{n}/
-The preceding item is matched exactly <em/n/ times.
-<tag/{n,}/
-The preceding item is matched <em/n/ or more times.
-<tag/{,m}/
-The preceding item is matched at most <em/m/ times.
-<tag/{n,m}/
-The preceding item is matched at least <em/n/ times, but no more than
-<em/m/ times.
-</descrip>
-
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>{n}</term>
+<listitem>
+<para>
+The preceding item is matched exactly <emphasis>n</emphasis> times.
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>{n,}</term>
+<listitem>
+<para>
+The preceding item is matched <emphasis>n</emphasis> or more times.
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>{,m}</term>
+<listitem>
+<para>
+The preceding item is matched at most <emphasis>m</emphasis> times.
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>{n,m}</term>
+<listitem>
+<para>
+The preceding item is matched at least <emphasis>n</emphasis> times, but no
more than
+<emphasis>m</emphasis> times.
+</para>
+</listitem>
+</varlistentry>
+</variablelist>
+</para>
+
+<para>
Two regular expressions may be concatenated; the resulting regular
expression matches any string formed by concatenating two substrings
that respectively match the concatenated subexpressions.
-
-Two regular expressions may be joined by the infix operator ``|'';
+</para>
+
+<para>
+Two regular expressions may be joined by the infix operator ``|'';
the resulting regular expression matches any string matching either
subexpression.
-
+</para>
+
+<para>
Repetition takes precedence over concatenation, which in turn takes
precedence over alternation. A whole subexpression may be enclosed in
parentheses to override these precedence rules.
-
-<bf/Note:/ If you compile Mutt with the GNU <em/rx/ package, the
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> If you compile Mutt with the GNU
<emphasis>rx</emphasis> package, the
following operators may also be used in regular expressions:
-
-<descrip>
-<tag/\\y/
+</para>
+
+<para>
+<variablelist>
+
+<varlistentry>
+<term>\\y</term>
+<listitem>
+<para>
Matches the empty string at either the beginning or the end of a word.
-<tag/\\B/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>\\B</term>
+<listitem>
+<para>
Matches the empty string within a word.
-<tag/\\</
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>\\<</term>
+<listitem>
+<para>
Matches the empty string at the beginning of a word.
-<tag/\\>/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>\\></term>
+<listitem>
+<para>
Matches the empty string at the end of a word.
-<tag/\\w/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>\\w</term>
+<listitem>
+<para>
Matches any word-constituent character (letter, digit, or underscore).
-<tag/\\W/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>\\W</term>
+<listitem>
+<para>
Matches any character that is not word-constituent.
-<tag/\\`/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>\\`</term>
+<listitem>
+<para>
Matches the empty string at the beginning of a buffer (string).
-<tag/\\'/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>\\'</term>
+<listitem>
+<para>
Matches the empty string at the end of a buffer.
-</descrip>
-
+</para>
+</listitem>
+</varlistentry>
+</variablelist>
+</para>
+
+<para>
Please note however that these operators are not defined by POSIX, so
they may or may not be available in stock libraries on various systems.
-
-<sect1>Patterns<label id="patterns">
-<p>
+</para>
+
+</sect2>
+
+<sect2 id="patterns">
+<title>Patterns</title>
+
+<para>
Many of Mutt's commands allow you to specify a pattern to match
(limit, tag-pattern, delete-pattern, etc.). There are several ways to select
messages:
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
~A all messages
~b EXPR messages which contain EXPR in the message body
~B EXPR messages which contain EXPR in the whole message
@@ -1911,156 +3301,273 @@
~z [MIN]-[MAX] messages with a size in the range MIN to MAX *)
~= duplicated messages (see $duplicate_threads)
~$ unreferenced messages (requires threaded view)
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
Where EXPR, USER, ID, and SUBJECT are
-<ref id="regexp" name="regular expressions">. Special attention has to be
+<xref LinkEnd="regexp"/>. Special attention has to be
made when using regular expressions inside of patterns. Specifically,
Mutt's parser for these patterns will strip one level of backslash (\),
which is normally used for quoting. If it is your intention to use a
backslash in the regular expression, you will need to use two backslashes
instead (\\).
-
-*) The forms <tt/<[MAX]/, <tt/>[MIN]/,
-<tt/[MIN]-/ and <tt/-[MAX]/
+</para>
+
+<para>
+*) The forms <literal remap="tt"><[MAX]</literal>, <literal
remap="tt">>[MIN]</literal>,
+<literal remap="tt">[MIN]-</literal> and <literal
remap="tt">-[MAX]</literal>
are allowed, too.
-
-<sect2>Pattern Modifier
-<p>
-
+</para>
+
+<sect3>
+<title>Pattern Modifier</title>
+
+<para>
Note that patterns matching 'lists' of addresses (notably c,C,p,P and t)
match if there is at least one match in the whole list. If you want to
make sure that all elements of that list match, you need to prefix your
-pattern with ^.
+pattern with ˆ.
This example matches all mails which only has recipients from Germany.
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
^~C \.de$
-</verb></tscreen>
-
-<sect2>Complex Patterns
-<p>
-
+</screen>
+
+</para>
+
+</sect3>
+
+<sect3>
+<title>Complex Patterns</title>
+
+<para>
Logical AND is performed by specifying more than one criterion. For
example:
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
~t mutt ~f elkins
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
would select messages which contain the word ``mutt'' in the list of
-recipients <bf/and/ that have the word ``elkins'' in the ``From'' header
+recipients <emphasis remap="bf">and</emphasis> that have the word ``elkins''
in the ``From'' header
field.
-
+</para>
+
+<para>
Mutt also recognizes the following operators to create more complex search
patterns:
-
-<itemize>
-<item>! -- logical NOT operator
-<item>| -- logical OR operator
-<item>() -- logical grouping operator
-</itemize>
-
+</para>
+
+<para>
+
+<itemizedlist>
+<listitem>
+
+<para>
+! -- logical NOT operator
+</para>
+</listitem>
+<listitem>
+
+<para>
+| -- logical OR operator
+</para>
+</listitem>
+<listitem>
+
+<para>
+() -- logical grouping operator
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+<para>
Here is an example illustrating a complex search pattern. This pattern will
select all messages which do not contain ``mutt'' in the ``To'' or ``Cc''
field and which are from ``elkins''.
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
!(~t mutt|~c mutt) ~f elkins
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
Here is an example using white space in the regular expression (note
-the ' and &dquot; delimiters). For this to match, the mail's subject must
-match the ``^Junk +From +Me$'' and it must be from either ``Jim +Somebody''
+the ' and " delimiters). For this to match, the mail's subject must
+match the ``ˆJunk +From +Me$'' and it must be from either ``Jim
+Somebody''
or ``Ed +SomeoneElse'':
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
'~s "^Junk +From +Me$" ~f ("Jim +Somebody"|"Ed +SomeoneElse")'
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
Note that if a regular expression contains parenthesis, or a vertical bar
-("|"), you <bf/must/ enclose the expression in double or single quotes since
+("|"), you <emphasis remap="bf">must</emphasis> enclose the expression
in double or single quotes since
those characters are also used to separate different parts of Mutt's
pattern language. For example,
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
~f "me@(mutt\.org|cs\.hmc\.edu)"
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
Without the quotes, the parenthesis wouldn't end.
-This would be seperated to two OR'd patterns: <em/˜f me@(mutt\.org/
-and <em/cs\.hmc\.edu)/. They are never what you want.
-
-<sect2>Searching by Date
-<p>
-Mutt supports two types of dates, <em/absolute/ and <em/relative/.
-
-<bf/Absolute/. Dates <bf/must/ be in DD/MM/YY format (month and year are
+This would be seperated to two OR'd patterns: <emphasis>˜f
me@(mutt\.org</emphasis>
+and <emphasis>cs\.hmc\.edu)</emphasis>. They are never what you want.
+</para>
+
+</sect3>
+
+<sect3>
+<title>Searching by Date</title>
+
+<para>
+Mutt supports two types of dates, <emphasis>absolute</emphasis> and
<emphasis>relative</emphasis>.
+</para>
+
+<para>
+<emphasis remap="bf">Absolute</emphasis>. Dates <emphasis
remap="bf">must</emphasis> be in DD/MM/YY format (month and year are
optional, defaulting to the current month and year). An example of a valid
range of dates is:
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
Limit to messages matching: ~d 20/1/95-31/10
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
If you omit the minimum (first) date, and just specify ``-DD/MM/YY'', all
-messages <em/before/ the given date will be selected. If you omit the maximum
-(second) date, and specify ``DD/MM/YY-'', all messages <em/after/ the given
+messages <emphasis>before</emphasis> the given date will be selected. If you
omit the maximum
+(second) date, and specify ``DD/MM/YY-'', all messages
<emphasis>after</emphasis> the given
date will be selected. If you specify a single date with no dash (``-''),
only messages sent on the given date will be selected.
-
-<bf/Error Margins/. You can add error margins to absolute dates.
+</para>
+
+<para>
+<emphasis remap="bf">Error Margins</emphasis>. You can add error margins to
absolute dates.
An error margin is a sign (+ or -), followed by a digit, followed by
one of the following units:
-<verb>
+
+<screen>
y years
m months
w weeks
d days
-</verb>
+</screen>
+
As a special case, you can replace the sign by a ``*'' character,
which is equivalent to giving identical plus and minus error margins.
-
+</para>
+
+<para>
Example: To select any messages two weeks around January 15, 2001,
you'd use the following pattern:
-<tscreen><verb>
+
+<screen>
+
Limit to messages matching: ~d 15/1/2001*2w
-</verb></tscreen>
-
-
-<bf/Relative/. This type of date is relative to the current date, and may
+</screen>
+
+</para>
+
+<para>
+<emphasis remap="bf">Relative</emphasis>. This type of date is relative to
the current date, and may
be specified as:
-<itemize>
-<item>><em/offset/ (messages older than <em/offset/ units)
-<item><<em/offset/ (messages newer than <em/offset/ units)
-<item>=<em/offset/ (messages exactly <em/offset/ units old)
-</itemize>
-
-<em/offset/ is specified as a positive number with one of the following
+
+<itemizedlist>
+<listitem>
+
+<para>
+><emphasis>offset</emphasis> (messages older than
<emphasis>offset</emphasis> units)
+</para>
+</listitem>
+<listitem>
+
+<para>
+<<emphasis>offset</emphasis> (messages newer than
<emphasis>offset</emphasis> units)
+</para>
+</listitem>
+<listitem>
+
+<para>
+=<emphasis>offset</emphasis> (messages exactly <emphasis>offset</emphasis>
units old)
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+<para>
+<emphasis>offset</emphasis> is specified as a positive number with one of the
following
units:
-<verb>
+
+<screen>
y years
m months
w weeks
d days
-</verb>
-
+</screen>
+
+</para>
+
+<para>
Example: to select messages less than 1 month old, you would use
-<tscreen><verb>
-Limit to messages matching: ~d <1m
-</verb></tscreen>
-
-
-
-<bf/Note:/ all dates used when searching are relative to the
-<bf/local/ time zone, so unless you change the setting of your <ref
-id="index_format" name="$index_format"> to include a
-<tt/%[...]/ format, these are <bf/not/ the dates shown
+
+<screen>
+Limit to messages matching: ~d <1m
+</screen>
+
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> all dates used when searching are
relative to the
+<emphasis remap="bf">local</emphasis> time zone, so unless you change the
setting of your <xref LinkEnd="index-format"/> to include a
+<literal remap="tt">%[...]</literal> format, these are
<emphasis remap="bf">not</emphasis> the dates shown
in the main index.
-
-<sect1>Using Tags
-<p>
-
+</para>
+
+</sect3>
+
+</sect2>
+
+<sect2>
+<title>Using Tags</title>
+
+<para>
Sometimes it is desirable to perform an operation on a group of
messages all at once rather than one at a time. An example might be
to save messages to a mailing list to a separate folder, or to
@@ -2068,114 +3575,196 @@
matching a pattern, use the tag-pattern function, which is bound to
``shift-T'' by default. Or you can select individual messages by
hand using the ``tag-message'' function, which is bound to ``t'' by
-default. See <ref id="patterns" name="patterns"> for Mutt's pattern
+default. See <xref LinkEnd="patterns"/> for Mutt's pattern
matching syntax.
-
+</para>
+
+<para>
Once you have tagged the desired messages, you can use the
``tag-prefix'' operator, which is the ``;'' (semicolon) key by default.
-When the ``tag-prefix'' operator is used, the <bf/next/ operation will
+When the ``tag-prefix'' operator is used, the <emphasis
remap="bf">next</emphasis> operation will
be applied to all tagged messages if that operation can be used in that
-manner. If the <ref id="auto_tag" name="$auto_tag">
+manner. If the <xref LinkEnd="auto-tag"/>
variable is set, the next operation applies to the tagged messages
automatically, without requiring the ``tag-prefix''.
-
-In <ref id="macro" name="macros"> or <ref id="push" name="push"> commands,
+</para>
+
+<para>
+In <xref LinkEnd="macro"/> or <xref LinkEnd="push"/> commands,
you can use the ``tag-prefix-cond'' operator. If there are no tagged
messages, mutt will "eat" the rest of the macro to abort it's execution.
Mutt will stop "eating" the macro when it encounters the ``end-cond''
operator; after this operator the rest of the macro will be executed as
normal.
-
-<sect1>Using Hooks<label id="hooks">
-<p>
-A <em/hook/ is a concept borrowed from the EMACS editor which allows you to
+</para>
+
+</sect2>
+
+<sect2 id="hooks">
+<title>Using Hooks</title>
+
+<para>
+A <emphasis>hook</emphasis> is a concept borrowed from the EMACS editor which
allows you to
execute arbitrary commands before performing some operation. For example,
you may wish to tailor your configuration based upon which mailbox you are
-reading, or to whom you are sending mail. In the Mutt world, a <em/hook/
-consists of a <ref id="regexp" name="regular expression"> or
-<ref id="patterns" name="pattern"> along with a
+reading, or to whom you are sending mail. In the Mutt world, a
<emphasis>hook</emphasis>
+consists of a <xref LinkEnd="regexp"/> or
+<xref LinkEnd="patterns"/> along with a
configuration option/command. See
-<itemize>
-<item><ref id="folder-hook" name="folder-hook">
-<item><ref id="send-hook" name="send-hook">
-<item><ref id="message-hook" name="message-hook">
-<item><ref id="save-hook" name="save-hook">
-<item><ref id="mbox-hook" name="mbox-hook">
-<item><ref id="fcc-hook" name="fcc-hook">
-<item><ref id="fcc-save-hook" name="fcc-save-hook">
-</itemize>
-for specific details on each type of <em/hook/ available.
-
-<bf/Note:/ if a hook changes configuration settings, these changes remain
+
+<itemizedlist>
+<listitem>
+
+<para>
+<xref LinkEnd="folder-hook"/>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<xref LinkEnd="send-hook"/>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<xref LinkEnd="message-hook"/>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<xref LinkEnd="save-hook"/>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<xref LinkEnd="mbox-hook"/>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<xref LinkEnd="fcc-hook"/>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<xref LinkEnd="fcc-save-hook"/>
+</para>
+</listitem>
+
+</itemizedlist>
+
+for specific details on each type of <emphasis>hook</emphasis> available.
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> if a hook changes configuration
settings, these changes remain
effective until the end of the current mutt session. As this is generally
not desired, a default hook needs to be added before all other hooks to
restore configuration defaults. Here is an example with send-hook and the
-my_hdr directive:
-
-<tscreen><verb>
+my_hdr directive:
+</para>
+
+<para>
+
+<screen>
send-hook . 'unmy_hdr From:'
send-hook ~C'^b@b\.b$' my_hdr from: c@xxx
-</verb></tscreen>
-
-<sect2>Message Matching in Hooks<label id="pattern_hook">
-<p>
-Hooks that act upon messages (<tt/send-hook, save-hook, fcc-hook,
-message-hook/) are evaluated in a slightly different manner. For the other
-types of hooks, a <ref id="regexp" name="regular expression"> is
+</screen>
+
+</para>
+
+<sect3 id="pattern-hook">
+<title>Message Matching in Hooks</title>
+
+<para>
+Hooks that act upon messages (<literal remap="tt">send-hook, save-hook,
fcc-hook,
+message-hook</literal>) are evaluated in a slightly different manner. For the
other
+types of hooks, a <xref LinkEnd="regexp"/> is
sufficient. But in dealing with messages a finer grain of control is
needed for matching since for different purposes you want to match
different criteria.
-
-Mutt allows the use of the <ref id="patterns" name="search pattern">
+</para>
+
+<para>
+Mutt allows the use of the <xref LinkEnd="patterns"/>
language for matching messages in hook commands. This works in
-exactly the same way as it would when <em/limiting/ or
-<em/searching/ the mailbox, except that you are restricted to those
+exactly the same way as it would when <emphasis>limiting</emphasis> or
+<emphasis>searching</emphasis> the mailbox, except that you are restricted to
those
operators which match information mutt extracts from the header of
the message (i.e. from, to, cc, date, subject, etc.).
-
+</para>
+
+<para>
For example, if you wanted to set your return address based upon sending
mail to a specific address, you could do something like:
-<tscreen><verb>
-send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt User <user@host>'
-</verb></tscreen>
+
+<screen>
+send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt User <user@host>'
+</screen>
+
which would execute the given command when sending mail to
-<em/me@xxxxxxxxxx/.
-
+<emphasis>me@xxxxxxxxxx</emphasis>.
+</para>
+
+<para>
However, it is not required that you write the pattern to match using the
-full searching language. You can still specify a simple <em/regular
-expression/ like the other hooks, in which case Mutt will translate your
+full searching language. You can still specify a simple <emphasis>regular
+expression</emphasis> like the other hooks, in which case Mutt will translate
your
pattern into the full language, using the translation specified by the
-<ref id="default_hook" name="$default_hook"> variable. The
+<xref LinkEnd="default-hook"/> variable. The
pattern is translated at the time the hook is declared, so the value of
-<ref id="default_hook" name="$default_hook"> that is in effect
+<xref LinkEnd="default-hook"/> that is in effect
at that time will be used.
-
-<sect1>External Address Queries<label id="query">
-<p>
+</para>
+
+</sect3>
+
+</sect2>
+
+<sect2 id="query">
+<title>External Address Queries</title>
+
+<para>
Mutt supports connecting to external directory databases such as LDAP,
ph/qi, bbdb, or NIS through a wrapper script which connects to mutt
-using a simple interface. Using the <ref id="query_command"
-name="$query_command"> variable, you specify the wrapper
+using a simple interface. Using the <xref LinkEnd="query-command"/> variable,
you specify the wrapper
command to use. For example:
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
set query_command = "mutt_ldap_query.pl '%s'"
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
The wrapper script should accept the query on the command-line. It
should return a one line message, then each matching response on a
single line, each line containing a tab separated address then name then
some other optional information. On error, or if there are no matching
addresses, return a non-zero exit code and a one line error message.
-
+</para>
+
+<para>
An example multiple response output:
-<tscreen><verb>
+
+<screen>
Searching database ... 20 entries ... 3 matching:
me@xxxxxxxxxx Michael Elkins mutt dude
blong@xxxxxxxxxxx Brandon Long mutt and more
roessler@xxxxxxx Thomas Roessler mutt pgp
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
There are two mechanisms for accessing the query function of mutt. One
is to do a query from the index menu using the query function (default: Q).
This will prompt for a query, then bring up the query menu which will
@@ -2183,331 +3772,502 @@
addresses to create aliases, or to mail. You can tag multiple addresses
to mail, start a new query, or have a new query appended to the current
responses.
-
+</para>
+
+<para>
The other mechanism for accessing the query function is for address
completion, similar to the alias completion. In any prompt for address
-entry, you can use the complete-query function (default: ^T) to run a
+entry, you can use the complete-query function (default: ˆT) to run a
query based on the current address you have typed. Like aliases, mutt
will look for what you have typed back to the last space or comma. If
there is a single response for that query, mutt will expand the address
in place. If there are multiple responses, mutt will activate the query
menu. At the query menu, you can select one or more addresses to be
added to the prompt.
-
-<sect1>Mailbox Formats
-<p>
+</para>
+
+</sect2>
+
+<sect2>
+<title>Mailbox Formats</title>
+
+<para>
Mutt supports reading and writing of four different mailbox formats:
mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there
is no need to use a flag for different mailbox types. When creating new
-mailboxes, Mutt uses the default specified with the <ref id="mbox_type"
-name="$mbox_type"> variable.
-
-<bf/mbox/. This is the most widely used mailbox format for UNIX. All
+mailboxes, Mutt uses the default specified with the <xref
LinkEnd="mbox-type"/> variable.
+</para>
+
+<para>
+<emphasis remap="bf">mbox</emphasis>. This is the most widely used mailbox
format for UNIX. All
messages are stored in a single file. Each message has a line of the form:
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
From me@xxxxxxxxxx Fri, 11 Apr 1997 11:44:56 PST
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
to denote the start of a new message (this is often referred to as the
``From_'' line).
-
-<bf/MMDF/. This is a variant of the <em/mbox/ format. Each message is
-surrounded by lines containing ``^A^A^A^A'' (four control-A's).
-
-<bf/MH/. A radical departure from <em/mbox/ and <em/MMDF/, a mailbox
+</para>
+
+<para>
+<emphasis remap="bf">MMDF</emphasis>. This is a variant of the
<emphasis>mbox</emphasis> format. Each message is
+surrounded by lines containing ``ˆAˆAˆAˆA'' (four
control-A's).
+</para>
+
+<para>
+<emphasis remap="bf">MH</emphasis>. A radical departure from
<emphasis>mbox</emphasis> and <emphasis>MMDF</emphasis>, a mailbox
consists of a directory and each message is stored in a separate file.
The filename indicates the message number (however, this is may not
correspond to the message number Mutt displays). Deleted messages are
-renamed with a comma (,) prepended to the filename. <bf/Note:/ Mutt
-detects this type of mailbox by looking for either <tt/.mh_sequences/
-or <tt/.xmhcache/ (needed to distinguish normal directories from MH
+renamed with a comma (,) prepended to the filename. <emphasis
remap="bf">Note:</emphasis> Mutt
+detects this type of mailbox by looking for either <literal
remap="tt">.mh_sequences</literal>
+or <literal remap="tt">.xmhcache</literal> (needed to distinguish normal
directories from MH
mailboxes).
-
-<bf/Maildir/. The newest of the mailbox formats, used by the Qmail MTA (a
-replacement for sendmail). Similar to <em/MH/, except that it adds three
-subdirectories of the mailbox: <em/tmp/, <em/new/ and <em/cur/. Filenames
+</para>
+
+<para>
+<emphasis remap="bf">Maildir</emphasis>. The newest of the mailbox formats,
used by the Qmail MTA (a
+replacement for sendmail). Similar to <emphasis>MH</emphasis>, except that it
adds three
+subdirectories of the mailbox: <emphasis>tmp</emphasis>,
<emphasis>new</emphasis> and <emphasis>cur</emphasis>. Filenames
for the messages are chosen in such a way they are unique, even when two
programs are writing the mailbox over NFS, which means that no file locking
is needed.
-
-<sect1>Mailbox Shortcuts<label id="shortcuts">
-<p>
+</para>
+
+</sect2>
+
+<sect2 id="shortcuts">
+<title>Mailbox Shortcuts</title>
+
+<para>
There are a number of built in shortcuts which refer to specific mailboxes.
These shortcuts can be used anywhere you are prompted for a file or mailbox
path.
-
-<itemize>
-<item>! -- refers to your <ref id="spoolfile" name="$spoolfile">
(incoming) mailbox
-<item>> -- refers to your <ref id="mbox" name="$mbox"> file
-<item>< -- refers to your <ref id="record" name="$record"> file
-<item>^ -- refers to the current mailbox
-<item>- or !! -- refers to the file you've last visited
-<item>˜ -- refers to your home directory
-<item>= or + -- refers to your <ref id="folder" name="$folder">
directory
-<item>@<em/alias/ -- refers to the <ref id="save-hook"
-name="default save folder"> as determined by the address of the alias
-</itemize>
-
-<sect1>Handling Mailing Lists<label id="using_lists">
-<p>
-
+</para>
+
+<para>
+
+<itemizedlist>
+<listitem>
+
+<para>
+! -- refers to your <xref LinkEnd="spoolfile"/> (incoming) mailbox
+</para>
+</listitem>
+<listitem>
+
+<para>
+> -- refers to your <xref LinkEnd="mbox"/> file
+</para>
+</listitem>
+<listitem>
+
+<para>
+< -- refers to your <xref LinkEnd="record"/> file
+</para>
+</listitem>
+<listitem>
+
+<para>
+ˆ -- refers to the current mailbox
+</para>
+</listitem>
+<listitem>
+
+<para>
+- or !! -- refers to the file you've last visited
+</para>
+</listitem>
+<listitem>
+
+<para>
+˜ -- refers to your home directory
+</para>
+</listitem>
+<listitem>
+
+<para>
+= or + -- refers to your <xref LinkEnd="folder"/> directory
+</para>
+</listitem>
+<listitem>
+
+<para>
+@<emphasis>alias</emphasis> -- refers to the <xref LinkEnd="save-hook"/> as
determined by the address of the alias
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+</sect2>
+
+<sect2 id="using-lists">
+<title>Handling Mailing Lists</title>
+
+<para>
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 subscribe"> commands in your muttrc.
-
+accomplished through the use of the <xref LinkEnd="lists"/> commands in your
muttrc.
+</para>
+
+<para>
Now that Mutt knows what your mailing lists are, it can do several
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''
+the <emphasis>index</emphasis> menu display. This is useful to distinguish
between
+personal and list mail in the same mailbox. In the <xref
LinkEnd="index-format"/> variable, the escape ``%L''
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).
-
+</para>
+
+<para>
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
+function, which by default is bound to ``L'' in the <emphasis>index</emphasis>
menu
+and <emphasis>pager</emphasis>, helps reduce the clutter by only replying to
the
known mailing list addresses instead of all recipients (except as
-specified by <tt/Mail-Followup-To/, see below).
-
-Mutt also supports the <tt/Mail-Followup-To/ header. When you send
+specified by <literal remap="tt">Mail-Followup-To</literal>, see below).
+</para>
+
+<para>
+Mutt also supports the <literal remap="tt">Mail-Followup-To</literal> 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
+subscribed mailing lists, and if the <xref LinkEnd="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 or list-replies (also known as ``followups'') 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.
-
+</para>
+
+<para>
Conversely, when group-replying or list-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
+has a <literal remap="tt">Mail-Followup-To</literal> header, mutt will respect
this header if
+the <xref LinkEnd="honor-followup-to"/> configuration
variable is set. Using list-reply will in this case also make sure
that the reply goes to the mailing list, even if it's not specified
-in the list of recipients in the <tt/Mail-Followup-To/.
-
+in the list of recipients in the <literal
remap="tt">Mail-Followup-To</literal>.
+</para>
+
+<para>
Note that, when header editing is enabled, you can create a
-<tt/Mail-Followup-To/ header manually. Mutt will only auto-generate
+<literal remap="tt">Mail-Followup-To</literal> header manually. Mutt will
only auto-generate
this header if it doesn't exist when you send the message.
-
-
+</para>
+
+<para>
The other method some mailing list admins use is to generate a
``Reply-To'' field which points back to the mailing list address rather
than the author of the message. This can create problems when trying
to reply directly to the author in private, since most mail clients
will automatically reply to the address given in the ``Reply-To''
-field. Mutt uses the <ref id="reply_to" name="$reply_to">
-variable to help decide which address to use. If set to <em/ask-yes/ or
-<em/ask-no/, you will be
+field. Mutt uses the <xref LinkEnd="reply-to"/>
+variable to help decide which address to use. If set to
<emphasis>ask-yes</emphasis> or
+<emphasis>ask-no</emphasis>, you will be
prompted as to whether or not you would like to use the address given in
the ``Reply-To'' field, or reply directly to the address given in the
-``From'' field. When set to <em/yes/, the ``Reply-To'' field will be used when
+``From'' field. When set to <emphasis>yes</emphasis>, the ``Reply-To'' field
will be used when
present.
-
+</para>
+
+<para>
The ``X-Label:'' header field can be used to further identify mailing
lists or list subject matter (or just to annotate messages
-individually). The <ref id="index_format"
-name="$index_format"> variable's ``%y'' and
+individually). The <xref LinkEnd="index-format"/> variable's ``%y'' and
``%Y'' escapes can be used to expand ``X-Label:'' fields in the
index, and Mutt's pattern-matcher can match regular expressions to
-``X-Label:'' fields with the ``~y'' selector. ``X-Label:'' is not a
+``X-Label:'' fields with the `` y'' selector. ``X-Label:'' is not a
standard message header field, but it can easily be inserted by procmail
and other mail filtering agents.
-
-Lastly, Mutt has the ability to <ref id="sort" name="sort"> the mailbox into
-<ref id="threads" name="threads">. A thread is a group of messages which all
relate to the same
+</para>
+
+<para>
+Lastly, Mutt has the ability to <xref LinkEnd="sort"/> the mailbox into
+<xref LinkEnd="threads"/>. A thread is a group of messages which all relate
to the same
subject. This is usually organized into a tree-like structure where a
message and all of its replies are represented graphically. If you've ever
used a threaded news client, this is the same concept. It makes dealing
with large volume mailing lists easier because you can easily delete
uninteresting threads and quickly find topics of value.
-
-<sect1>Editing threads
-<p>
+</para>
+
+</sect2>
+
+<sect2>
+<title>Editing threads</title>
+
+<para>
Mutt has the ability to dynamically restructure threads that are broken
either by misconfigured software or bad behaviour from some
correspondents. This allows to clean your mailboxes formats) from these
annoyances which make it hard to follow a discussion.
-
+</para>
+
+<para>
If you want to use these functions with IMAP, you need to compile Mutt
-with the <em/--enable-imap-edit-threads/ configure flag.
-
-<sect2>Linking threads
-<p>
-
+with the <emphasis>--enable-imap-edit-threads</emphasis> configure flag.
+</para>
+
+<sect3>
+<title>Linking threads</title>
+
+<para>
Some mailers tend to "forget" to correctly set the "In-Reply-To:" and
"References:" headers when replying to a message. This results in broken
discussions because Mutt has not enough information to guess the correct
threading.
You can fix this by tagging the reply, then moving to the parent message
-and using the ``link-threads'' function (bound to & by default). The
+and using the ``link-threads'' function (bound to & by default). The
reply will then be connected to this "parent" message.
-
+</para>
+
+<para>
You can also connect multiple childs at once, tagging them and using the
-tag-prefix command (';') or the auto_tag option.
-
-<sect2>Breaking threads
-<p>
-
+tag-prefix command (';') or the auto_tag option.
+</para>
+
+</sect3>
+
+<sect3>
+<title>Breaking threads</title>
+
+<para>
On mailing lists, some people are in the bad habit of starting a new
discussion by hitting "reply" to any message from the list and changing
the subject to a totally unrelated one.
You can fix such threads by using the ``break-thread'' function (bound
-by default to #), which will turn the subthread starting from the
+by default to #), which will turn the subthread starting from the
current message into a whole different thread.
-
-<sect1>Delivery Status Notification (DSN) Support
-<p>
-
+</para>
+
+</sect3>
+
+</sect2>
+
+<sect2>
+<title>Delivery Status Notification (DSN) Support</title>
+
+<para>
RFC1894 defines a set of MIME content types for relaying information
about the status of electronic mail messages. These can be thought of as
``return receipts.'' Berkeley sendmail 8.8.x currently has some command
line options in which the mail client can make requests as to what type
of status messages should be returned.
-
-To support this, there are two variables. <ref id="dsn_notify"
-name="$dsn_notify"> is used to request receipts for
+</para>
+
+<para>
+To support this, there are two variables. <xref LinkEnd="dsn-notify"/> is used
to request receipts for
different results (such as failed message, message delivered, etc.).
-<ref id="dsn_return" name="$dsn_return"> requests how much
+<xref LinkEnd="dsn-return"/> requests how much
of your message should be returned with the receipt (headers or full
message). Refer to the man page on sendmail for more details on DSN.
-
-<sect1>POP3 Support (OPTIONAL)
-<p>
-
-If Mutt was compiled with POP3 support (by running the <em/configure/
-script with the <em/--enable-pop/ flag), it has the ability to work
+</para>
+
+</sect2>
+
+<sect2>
+<title>POP3 Support (OPTIONAL)</title>
+
+<para>
+If Mutt was compiled with POP3 support (by running the
<emphasis>configure</emphasis>
+script with the <emphasis>--enable-pop</emphasis> flag), it has the ability to
work
with mailboxes located on a remote POP3 server and fetch mail for local
browsing.
-
+</para>
+
+<para>
You can access the remote POP3 mailbox by selecting the folder
-<tt>pop://popserver/</tt>.
-
+<literal remap="tt">pop://popserver/</literal>.
+</para>
+
+<para>
You can select an alternative port by specifying it with the server, ie:
-<tt>pop://popserver:port/</tt>.
-
+<literal remap="tt">pop://popserver:port/</literal>.
+</para>
+
+<para>
You can also specify different username for each folder, ie:
-<tt>pop://username@popserver[:port]/</tt>.
-
+<literal remap="tt">pop://username@popserver[:port]/</literal>.
+</para>
+
+<para>
Polling for new mail is more expensive over POP3 than locally. For this
reason the frequency at which Mutt will check for mail remotely can be
controlled by the
-<ref id="pop_checkinterval" name="$pop_checkinterval">
+<xref LinkEnd="pop-checkinterval"/>
variable, which defaults to every 60 seconds.
-
-If Mutt was compiled with SSL support (by running the <em/configure/
-script with the <em/--with-ssl/ flag), connections to POP3 servers
+</para>
+
+<para>
+If Mutt was compiled with SSL support (by running the
<emphasis>configure</emphasis>
+script with the <emphasis>--with-ssl</emphasis> flag), connections to POP3
servers
can be encrypted. This naturally requires that the server supports
SSL encrypted connections. To access a folder with POP3/SSL, you should
use pops: prefix, ie:
-<tt>pops://[username@]popserver[:port]/</tt>.
-
-Another way to access your POP3 mail is the <em/fetch-mail/ function
-(default: G). It allows to connect to <ref id="pop_host"
-name="pop_host">, fetch all your new mail and place it in the
-local <ref id="spoolfile" name="spoolfile">. After this
+<literal remap="tt">pops://[username@]popserver[:port]/</literal>.
+</para>
+
+<para>
+Another way to access your POP3 mail is the <emphasis>fetch-mail</emphasis>
function
+(default: G). It allows to connect to <xref LinkEnd="pop-host"/>, fetch all
your new mail and place it in the
+local <xref LinkEnd="spoolfile"/>. After this
point, Mutt runs exactly as if the mail had always been local.
-
-<bf/Note:/ If you only need to fetch all messages to local mailbox
-you should consider using a specialized program, such as <htmlurl
-url="http://www.ccil.org/~esr/fetchmail"; name="fetchmail">
-
-<sect1>IMAP Support (OPTIONAL)
-<p>
-
-If Mutt was compiled with IMAP support (by running the <em/configure/
-script with the <em/--enable-imap/ flag), it has the ability to work
+</para>
+
+<para>
+<emphasis remap="bf">Note:</emphasis> If you only need to fetch all messages
to local mailbox
+you should consider using a specialized program, such as <ulink
+URL="http://www.ccil.org/~esr/fetchmail";
+>fetchmail</ulink
+>
+</para>
+
+</sect2>
+
+<sect2>
+<title>IMAP Support (OPTIONAL)</title>
+
+<para>
+If Mutt was compiled with IMAP support (by running the
<emphasis>configure</emphasis>
+script with the <emphasis>--enable-imap</emphasis> flag), it has the ability
to work
with folders located on a remote IMAP server.
-
+</para>
+
+<para>
You can access the remote inbox by selecting the folder
-<tt>imap://imapserver/INBOX</tt>, where <tt/imapserver/ is the name of the
-IMAP server and <tt/INBOX/ is the special name for your spool mailbox on
+<literal remap="tt">imap://imapserver/INBOX</literal>, where <literal
remap="tt">imapserver</literal> is the name of the
+IMAP server and <literal remap="tt">INBOX</literal> is the special name for
your spool mailbox on
the IMAP server. If you want to access another mail folder at the IMAP
-server, you should use <tt>imap://imapserver/path/to/folder</tt> where
-<tt>path/to/folder</tt> is the path of the folder you want to access.
-
+server, you should use <literal
remap="tt">imap://imapserver/path/to/folder</literal> where
+<literal remap="tt">path/to/folder</literal> is the path of the folder you
want to access.
+</para>
+
+<para>
You can select an alternative port by specifying it with the server, ie:
-<tt>imap://imapserver:port/INBOX</tt>.
-
+<literal remap="tt">imap://imapserver:port/INBOX</literal>.
+</para>
+
+<para>
You can also specify different username for each folder, ie:
-<tt>imap://username@imapserver[:port]/INBOX</tt>.
-
-If Mutt was compiled with SSL support (by running the <em/configure/
-script with the <em/--with-ssl/ flag), connections to IMAP servers
+<literal remap="tt">imap://username@imapserver[:port]/INBOX</literal>.
+</para>
+
+<para>
+If Mutt was compiled with SSL support (by running the
<emphasis>configure</emphasis>
+script with the <emphasis>--with-ssl</emphasis> flag), connections to IMAP
servers
can be encrypted. This naturally requires that the server supports
SSL encrypted connections. To access a folder with IMAP/SSL, you should
-use <tt>imaps://[username@]imapserver[:port]/path/to/folder</tt> as your
+use <literal
remap="tt">imaps://[username@]imapserver[:port]/path/to/folder</literal> as
your
folder path.
-
+</para>
+
+<para>
Pine-compatible notation is also supported, ie
-<tt>{[username@]imapserver[:port][/ssl]}path/to/folder</tt>
-
+<literal
remap="tt">{[username@]imapserver[:port][/ssl]}path/to/folder</literal>
+</para>
+
+<para>
Note that not all servers use / as the hierarchy separator. Mutt should
correctly notice which separator is being used by the server and convert
paths accordingly.
-
+</para>
+
+<para>
When browsing folders on an IMAP server, you can toggle whether to look
at only the folders you are subscribed to, or all folders with the
-<em/toggle-subscribed/ command. See also the
-<ref id="imap_list_subscribed"
-name="$imap_list_subscribed"> variable.
-
+<emphasis>toggle-subscribed</emphasis> command. See also the
+<xref LinkEnd="imap-list-subscribed"/> variable.
+</para>
+
+<para>
Polling for new mail on an IMAP server can cause noticeable delays. So, you'll
want to carefully tune the
-<ref id="mail_check" name="$mail_check">
+<xref LinkEnd="mail-check"/>
and
-<ref id="timeout" name="$timeout">
+<xref LinkEnd="timeout"/>
variables. Personally I use
-<tscreen><verb>
+
+<screen>
set mail_check=90
set timeout=15
-</verb></tscreen>
+</screen>
+
with relatively good results over my slow modem line.
-
+</para>
+
+<para>
Note that if you are using mbox as the mail store on UW servers prior to
v12.250, the server has been reported to disconnect a client if another client
selects the same folder.
-
-<sect2>The Folder Browser
-<p>
-
+</para>
+
+<sect3>
+<title>The Folder Browser</title>
+
+<para>
As of version 1.2, mutt supports browsing mailboxes on an IMAP
server. This is mostly the same as the local file browser, with the
following differences:
-<itemize>
-<item>In lieu of file permissions, mutt displays the string "IMAP",
- possibly followed by the symbol "+", indicating
- that the entry contains both messages and subfolders. On
- Cyrus-like servers folders will often contain both messages and
- subfolders.
-<item>For the case where an entry can contain both messages and
- subfolders, the selection key (bound to <tt>enter</tt> by default)
- will choose to descend into the subfolder view. If you wish to view
- the messages in that folder, you must use <tt>view-file</tt> instead
- (bound to <tt>space</tt> by default).
-<item>You can create, delete and rename mailboxes with the
- <tt>create-mailbox</tt>, <tt>delete-mailbox</tt>, and
- <tt>rename-mailbox</tt> commands (default bindings: <tt>C</tt>,
- <tt>d</tt> and <tt>r</tt>, respectively). You may also
- <tt>subscribe</tt> and <tt>unsubscribe</tt> to mailboxes (normally
- these are bound to <tt>s</tt> and <tt>u</tt>, respectively).
-</itemize>
-
-<sect2>Authentication
-<p>
-
+
+<itemizedlist>
+<listitem>
+
+<para>
+In lieu of file permissions, mutt displays the string "IMAP",
+possibly followed by the symbol "+", indicating
+that the entry contains both messages and subfolders. On
+Cyrus-like servers folders will often contain both messages and
+subfolders.
+</para>
+</listitem>
+<listitem>
+
+<para>
+For the case where an entry can contain both messages and
+subfolders, the selection key (bound to <literal remap="tt">enter</literal> by
default)
+will choose to descend into the subfolder view. If you wish to view
+the messages in that folder, you must use <literal
remap="tt">view-file</literal> instead
+(bound to <literal remap="tt">space</literal> by default).
+</para>
+</listitem>
+<listitem>
+
+<para>
+You can create, delete and rename mailboxes with the
+<literal remap="tt">create-mailbox</literal>, <literal
remap="tt">delete-mailbox</literal>, and
+<literal remap="tt">rename-mailbox</literal> commands (default bindings:
<literal remap="tt">C</literal>,
+<literal remap="tt">d</literal> and <literal remap="tt">r</literal>,
respectively). You may also
+<literal remap="tt">subscribe</literal> and <literal
remap="tt">unsubscribe</literal> to mailboxes (normally
+these are bound to <literal remap="tt">s</literal> and <literal
remap="tt">u</literal>, respectively).
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+</sect3>
+
+<sect3>
+<title>Authentication</title>
+
+<para>
Mutt supports four authentication methods with IMAP servers: SASL,
GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add
NTLM authentication for you poor exchange users out there, but it has
@@ -2515,110 +4275,180 @@
the pseudo-protocol ANONYMOUS, which allows you to log in to a public
IMAP server without having an account. To use ANONYMOUS, simply make
your username blank or "anonymous".
-<p>
+</para>
+
+<para>
SASL is a special super-authenticator, which selects among several protocols
(including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most secure
method available on your host and the server. Using some of these methods
(including DIGEST-MD5 and possibly GSSAPI), your entire session will be
encrypted and invisible to those teeming network snoops. It is the best
option if you have it. To use it, you must have the Cyrus SASL library
-installed on your system and compile mutt with the <em/--with-sasl/ flag.
-<p>
+installed on your system and compile mutt with the
<emphasis>--with-sasl</emphasis> flag.
+</para>
+
+<para>
Mutt will try whichever methods are compiled in and available on the server,
in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN.
-
+</para>
+
+<para>
There are a few variables which control authentication:
-<itemize>
-<item><ref id="imap_user" name="$imap_user"> - controls
- the username under which you request authentication on the IMAP server,
- for all authenticators. This is overridden by an explicit username in
- the mailbox path (ie by using a mailbox name of the form
- <tt/{user@host}/).
-<item><ref id="imap_pass" name="$imap_pass"> - a
- password which you may preset, used by all authentication methods where
- a password is needed.
-<item><ref id="imap_authenticators"
- name="$imap_authenticators"> - a colon-delimited list of IMAP
- authentication methods to try, in the order you wish to try them. If
- specified, this overrides mutt's default (attempt everything, in the order
- listed above).
-</itemize>
-
-<sect1>Managing multiple IMAP/POP accounts (OPTIONAL)<label id="account-hook">
-<p>
-
+
+<itemizedlist>
+<listitem>
+
+<para>
+<xref LinkEnd="imap-user"/> - controls
+the username under which you request authentication on the IMAP server,
+for all authenticators. This is overridden by an explicit username in
+the mailbox path (ie by using a mailbox name of the form
+<literal remap="tt">{user@host}</literal>).
+</para>
+</listitem>
+<listitem>
+
+<para>
+<xref LinkEnd="imap-pass"/> - a
+password which you may preset, used by all authentication methods where
+a password is needed.
+</para>
+</listitem>
+<listitem>
+
+<para>
+<xref LinkEnd="imap-authenticators"/> - a colon-delimited list of IMAP
+authentication methods to try, in the order you wish to try them. If
+specified, this overrides mutt's default (attempt everything, in the order
+listed above).
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+</sect3>
+
+</sect2>
+
+<sect2 id="account-hook">
+<title>Managing multiple IMAP/POP accounts (OPTIONAL)</title>
+
+<para>
If you happen to have accounts on multiple IMAP and/or POP servers,
you may find managing all the authentication settings inconvenient and
error-prone. The account-hook command may help. This hook works like
folder-hook but is invoked whenever you access a remote mailbox
(including inside the folder browser), not just when you open the
mailbox.
-<p>
+</para>
+
+<para>
Some examples:
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'
-</verb></tscreen>
-
-<sect1>Start a WWW Browser on URLs (EXTERNAL)<label id="urlview">
-<p>
-If a message contains URLs (<em/unified resource locator/ = address in the
-WWW space like <em>http://www.mutt.org/</em>), it is efficient to get
+</screen>
+
+</para>
+
+</sect2>
+
+<sect2 id="urlview">
+<title>Start a WWW Browser on URLs (EXTERNAL)</title>
+
+<para>
+If a message contains URLs (<emphasis>unified resource locator</emphasis> =
address in the
+WWW space like <emphasis>http://www.mutt.org/</emphasis>), it is efficient to
get
a menu with all the URLs and start a WWW browser on one of them. This
functionality is provided by the external urlview program which can be
-retrieved at <htmlurl url="ftp://ftp.mutt.org/mutt/contrib/";
-name="ftp://ftp.mutt.org/mutt/contrib/";> and the configuration commands:
-<tscreen><verb>
+retrieved at <ulink
+URL="ftp://ftp.mutt.org/mutt/contrib/";
+>ftp://ftp.mutt.org/mutt/contrib/</ulink
+> and the configuration commands:
+
+<screen>
macro index \cb |urlview\n
macro pager \cb |urlview\n
-</verb></tscreen>
-
-<sect>Mutt's MIME Support
-<p>
+</screen>
+
+</para>
+
+</sect2>
+
+</sect1>
+
+<sect1>
+<title>Mutt's MIME Support</title>
+
+<para>
Quite a bit of effort has been made to make Mutt the premier text-mode
MIME MUA. Every effort has been made to provide the functionality that
the discerning MIME user requires, and the conformance to the standards
wherever possible. When configuring Mutt for MIME, there are two extra
types of configuration files which Mutt uses. One is the
-<tt/mime.types/ file, which contains the mapping of file extensions to
-IANA MIME types. The other is the <tt/mailcap/ file, which specifies
+<literal remap="tt">mime.types</literal> file, which contains the mapping of
file extensions to
+IANA MIME types. The other is the <literal remap="tt">mailcap</literal> file,
which specifies
the external commands to use for handling specific MIME types.
-
-<sect1>Using MIME in Mutt
-<p>
+</para>
+
+<sect2>
+<title>Using MIME in Mutt</title>
+
+<para>
There are three areas/menus in Mutt which deal with MIME, they are the
pager (while viewing a message), the attachment menu and the compose
menu.
-
-<sect2>Viewing MIME messages in the pager
-<p>
+</para>
+
+<sect3>
+<title>Viewing MIME messages in the pager</title>
+
+<para>
When you select a message from the index and view it in the pager, Mutt
decodes the message to a text representation. Mutt internally supports
-a number of MIME types, including <tt>text/plain, text/enriched,
-message/rfc822, and message/news</tt>. In addition, the export
+a number of MIME types, including <literal remap="tt">text/plain,
text/enriched,
+message/rfc822, and message/news</literal>. In addition, the export
controlled version of Mutt recognizes a variety of PGP MIME types,
including PGP/MIME and application/pgp.
-
+</para>
+
+<para>
Mutt will denote attachments with a couple lines describing them.
These lines are of the form:
-<tscreen><verb>
+
+<screen>
[-- Attachment #1: Description --]
[-- Type: text/plain, Encoding: 7bit, Size: 10000 --]
-</verb></tscreen>
-Where the <tt/Description/ is the description or filename given for the
-attachment, and the <tt/Encoding/ is one of
-<tt>7bit/8bit/quoted-printable/base64/binary</tt>.
-
+</screen>
+
+Where the <literal remap="tt">Description</literal> is the description or
filename given for the
+attachment, and the <literal remap="tt">Encoding</literal> is one of
+<literal remap="tt">7bit/8bit/quoted-printable/base64/binary</literal>.
+</para>
+
+<para>
If Mutt cannot deal with a MIME type, it will display a message like:
-<tscreen><verb>
+
+<screen>
[-- image/gif is unsupported (use 'v' to view this part) --]
-</verb></tscreen>
-
-<sect2>The Attachment Menu<label id="attach_menu">
-<p>
-The default binding for <tt/view-attachments/ is `v', which displays the
+</screen>
+
+</para>
+
+</sect3>
+
+<sect3 id="attach-menu">
+<title>The Attachment Menu</title>
+
+<para>
+The default binding for <literal remap="tt">view-attachments</literal> is `v',
which displays the
attachment menu for a message. The attachment menu displays a list of
the attachments in a message. From the attachment menu, you can save,
print, pipe, delete, and view attachments. You can apply these
@@ -2627,15 +4457,24 @@
current message from this menu, and only the current attachment (or the
attachments tagged) will be quoted in your reply. You can view
attachments as text, or view them using the mailcap viewer definition.
-
+</para>
+
+<para>
Finally, you can apply the usual message-related functions (like
-<ref id="resend-message" name="resend-message">, and the reply
-and forward functions) to attachments of type <tt>message/rfc822</tt>.
-
+<xref LinkEnd="resend-message"/>, and the reply
+and forward functions) to attachments of type <literal
remap="tt">message/rfc822</literal>.
+</para>
+
+<para>
See the help on the attachment menu for more information.
-
-<sect2>The Compose Menu<label id="compose_menu">
-<p>
+</para>
+
+</sect3>
+
+<sect3 id="compose-menu">
+<title>The Compose Menu</title>
+
+<para>
The compose menu is the menu you see before you send a message. It
allows you to edit the recipient list, the subject, and other aspects
of your message. It also contains a list of the attachments of your
@@ -2643,50 +4482,69 @@
filter, pipe, edit, compose, review, and rename an attachment or a
list of tagged attachments. You can also modifying the attachment
information, notably the type, encoding and description.
-
+</para>
+
+<para>
Attachments appear as follows:
-<verb>
-- 1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no
description>
- 2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no
description>
-</verb>
-
+
+<screen>
+- 1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no
description>
+ 2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no
description>
+</screen>
+
+</para>
+
+<para>
The '-' denotes that Mutt will delete the file after sending (or
postponing, or cancelling) the message. It can be toggled with the
-<tt/toggle-unlink/ command (default: u). The next field is the MIME
-content-type, and can be changed with the <tt/edit-type/ command
-(default: ^T). The next field is the encoding for the attachment,
+<literal remap="tt">toggle-unlink</literal> command (default: u). The next
field is the MIME
+content-type, and can be changed with the <literal
remap="tt">edit-type</literal> command
+(default: ˆT). The next field is the encoding for the attachment,
which allows a binary message to be encoded for transmission on 7bit
-links. It can be changed with the <tt/edit-encoding/ command
-(default: ^E). The next field is the size of the attachment,
+links. It can be changed with the <literal remap="tt">edit-encoding</literal>
command
+(default: ˆE). The next field is the size of the attachment,
rounded to kilobytes or megabytes. The next field is the filename,
-which can be changed with the <tt/rename-file/ command (default: R).
+which can be changed with the <literal remap="tt">rename-file</literal>
command (default: R).
The final field is the description of the attachment, and can be
-changed with the <tt/edit-description/ command (default: d).
-
-<sect1>MIME Type configuration with <tt/mime.types/
-<p>
+changed with the <literal remap="tt">edit-description</literal> command
(default: d).
+</para>
+
+</sect3>
+
+</sect2>
+
+<sect2>
+<title>MIME Type configuration with <literal
remap="tt">mime.types</literal></title>
+
+<para>
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>/usr/local/share/mutt/mime.types</tt> or
-<tt>/etc/mime.types</tt>
-
+personal mime.types file at <literal
remap="tt">${HOME}/.mime.types</literal>, and then
+the system mime.types file at <literal
remap="tt">/usr/local/share/mutt/mime.types</literal> or
+<literal remap="tt">/etc/mime.types</literal>
+</para>
+
+<para>
The mime.types file consist of lines containing a MIME type and a space
separated list of extensions. For example:
-<tscreen><verb>
+
+<screen>
application/postscript ps eps
application/pgp pgp
audio/x-aiff aif aifc aiff
-</verb></tscreen>
-A sample <tt/mime.types/ file comes with the Mutt distribution, and
+</screen>
+
+A sample <literal remap="tt">mime.types</literal> file comes with the Mutt
distribution, and
should contain most of the MIME types you are likely to use.
-
+</para>
+
+<para>
If Mutt can not determine the mime type by the extension of the file you
attach, it will look at the file. If the file is free of binary
information, Mutt will assume that the file is plain text, and mark it
-as <tt>text/plain</tt>. If the file contains binary information, then Mutt
will
-mark it as <tt>application/octet-stream</tt>. You can change the MIME
-type that Mutt assigns to an attachment by using the <tt/edit-type/
-command from the compose menu (default: ^T). The MIME type is actually a
+as <literal remap="tt">text/plain</literal>. If the file contains binary
information, then Mutt will
+mark it as <literal remap="tt">application/octet-stream</literal>. You can
change the MIME
+type that Mutt assigns to an attachment by using the <literal
remap="tt">edit-type</literal>
+command from the compose menu (default: ˆT). The MIME type is actually a
major mime type followed by the sub-type, separated by a '/'. 6 major
types: application, text, image, video, audio, and model have been approved
after various internet discussions. Mutt recognises all of these if the
@@ -2695,51 +4553,75 @@
molecular modelling community to pass molecular data in various forms to
various molecular viewers. Non-recognised mime types should only be used
if the recipient of the message is likely to be expecting such attachments.
-
-<sect1>MIME Viewer configuration with <tt/mailcap/
-<p>
+</para>
+
+</sect2>
+
+<sect2>
+<title>MIME Viewer configuration with <literal
remap="tt">mailcap</literal></title>
+
+<para>
Mutt supports RFC 1524 MIME Configuration, in particular the Unix
specific format specified in Appendix A of RFC 1524. This file format
is commonly referred to as the mailcap format. Many MIME compliant
programs utilize the mailcap format, allowing you to specify handling
for all MIME types in one place for all programs. Programs known to
use this format include Netscape, XMosaic, lynx and metamail.
-
+</para>
+
+<para>
In order to handle various MIME types that Mutt can not handle
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>
+
+<screen>
${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.
-
+</screen>
+
+where <literal remap="tt">$HOME</literal> is your home directory.
+</para>
+
+<para>
In particular, the metamail distribution will install a mailcap file,
-usually as <tt>/usr/local/etc/mailcap</tt>, which contains some baseline
+usually as <literal remap="tt">/usr/local/etc/mailcap</literal>, which
contains some baseline
entries.
-
-<sect2>The Basics of the mailcap file
-<p>
+</para>
+
+<sect3>
+<title>The Basics of the mailcap file</title>
+
+<para>
A mailcap file consists of a series of lines which are comments, blank,
or definitions.
-
+</para>
+
+<para>
A comment line consists of a # character followed by anything you want.
-
+</para>
+
+<para>
A blank line is blank.
-
+</para>
+
+<para>
A definition line consists of a content type, a view command, and any
number of optional fields. Each field of a definition line is divided
by a semicolon ';' character.
-
+</para>
+
+<para>
The content type is specified in the MIME standard type/subtype method.
For example,
-<tt>text/plain, text/html, image/gif, </tt>
+<literal remap="tt">text/plain, text/html, image/gif, </literal>
etc. In addition, the mailcap format includes two formats for
wildcards, one using the special '*' subtype, the other is the implicit
-wild, where you only include the major type. For example, <tt>image/*</tt>, or
-<tt>video,</tt> will match all image types and video types,
+wild, where you only include the major type. For example, <literal
remap="tt">image/*</literal>, or
+<literal remap="tt">video,</literal> will match all image types and video
types,
respectively.
-
+</para>
+
+<para>
The view command is a Unix command for viewing the type specified. There
are two different types of commands supported. The default is to send
the body of the MIME message to the command on stdin. You can change
@@ -2749,237 +4631,383 @@
the name of the temporary file. In both cases, Mutt will turn over the
terminal to the view program until the program quits, at which time Mutt
will remove the temporary file if it exists.
-
+</para>
+
+<para>
So, in the simplest form, you can send a text/plain message to the
external pager more on stdin:
-<tscreen><verb>
+
+<screen>
text/plain; more
-</verb></tscreen>
+</screen>
+
Or, you could send the message as a file:
-<tscreen><verb>
+
+<screen>
text/plain; more %s
-</verb></tscreen>
+</screen>
+
Perhaps you would like to use lynx to interactively view a text/html
message:
-<tscreen><verb>
+
+<screen>
text/html; lynx %s
-</verb></tscreen>
+</screen>
+
In this case, lynx does not support viewing a file from stdin, so you
must use the %s syntax.
-<bf/Note:/ <em>Some older versions of lynx contain a bug where they
+<emphasis remap="bf">Note:</emphasis> <emphasis>Some older versions of lynx
contain a bug where they
will check the mailcap file for a viewer for text/html. They will find
the line which calls lynx, and run it. This causes lynx to continuously
-spawn itself to view the object.</em>
-
+spawn itself to view the object.</emphasis>
+</para>
+
+<para>
On the other hand, maybe you don't want to use lynx interactively, you
just want to have it convert the text/html to text/plain, then you can
use:
-<tscreen><verb>
+
+<screen>
text/html; lynx -dump %s | more
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
Perhaps you wish to use lynx to view text/html files, and a pager on
all other text formats, then you would use the following:
-<tscreen><verb>
+
+<screen>
text/html; lynx %s
text/*; more
-</verb></tscreen>
+</screen>
+
This is the simplest form of a mailcap file.
-
-<sect2>Secure use of mailcap
-<p>
+</para>
+
+</sect3>
+
+<sect3>
+<title>Secure use of mailcap</title>
+
+<para>
The interpretion of shell meta-characters embedded in MIME parameters
can lead to security problems in general. Mutt tries to quote parameters
-in expansion of %s syntaxes properly, and avoids risky characters by
-substituting them, see the <ref id="mailcap_sanitize"
-name="mailcap_sanitize"> variable.
-
+in expansion of %s syntaxes properly, and avoids risky characters by
+substituting them, see the <xref LinkEnd="mailcap-sanitize"/> variable.
+</para>
+
+<para>
Although mutt's procedures to invoke programs with mailcap seem to be
safe, there are other applications parsing mailcap, maybe taking less care
of it. Therefore you should pay attention to the following rules:
-
-<em/Keep the %-expandos away from shell quoting./
+</para>
+
+<para>
+<emphasis>Keep the %-expandos away from shell quoting.</emphasis>
Don't quote them with single or double quotes. Mutt does this for
you, the right way, as should any other program which interprets
mailcap. Don't put them into backtick expansions. Be highly careful
with eval statements, and avoid them if possible at all. Trying to fix
broken behaviour with quotes introduces new leaks - there is no
alternative to correct quoting in the first place.
-
-If you have to use the %-expandos' values in context where you need
+</para>
+
+<para>
+If you have to use the %-expandos' values in context where you need
quoting or backtick expansions, put that value into a shell variable
and reference the shell variable where necessary, as in the following
-example (using <tt/$charset/ inside the backtick expansion is safe,
+example (using <literal remap="tt">$charset</literal> inside the
backtick expansion is safe,
since it is not itself subject to any further expansion):
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \
- && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1
-</verb></tscreen>
-
-<sect2>Advanced mailcap Usage
-<p>
-
-<sect3>Optional Fields
-<p>
+ && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1
+</screen>
+
+</para>
+
+</sect3>
+
+<sect3>
+<title>Advanced mailcap Usage</title>
+
+<sect4>
+<title>Optional Fields</title>
+
+<para>
In addition to the required content-type and view command fields, you
can add semi-colon ';' separated fields to set flags and other options.
Mutt recognizes the following optional fields:
-<descrip>
-<tag/copiousoutput/
+<variablelist>
+
+<varlistentry>
+<term>copiousoutput</term>
+<listitem>
+<para>
This flag tells Mutt that the command passes possibly large amounts of
text on stdout. This causes Mutt to invoke a pager (either the internal
pager or the external pager defined by the pager variable) on the output
of the view command. Without this flag, Mutt assumes that the command
-is interactive. One could use this to replace the pipe to <tt>more</tt>
-in the <tt>lynx -dump</tt> example in the Basic section:
-<tscreen><verb>
+is interactive. One could use this to replace the pipe to <literal
remap="tt">more</literal>
+in the <literal remap="tt">lynx -dump</literal> example in the Basic section:
+
+<screen>
text/html; lynx -dump %s ; copiousoutput
-</verb></tscreen>
+</screen>
+
This will cause lynx to format the text/html output as text/plain
and Mutt will use your standard pager to display the results.
-<tag/needsterminal/
-Mutt uses this flag when viewing attachments with <ref id="auto_view"
-name="autoview">, in order to decide whether it should honor the setting
-of the <ref id="wait_key" name="$wait_key"> variable or
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>needsterminal</term>
+<listitem>
+<para>
+Mutt uses this flag when viewing attachments with <xref LinkEnd="auto-view"/>,
in order to decide whether it should honor the setting
+of the <xref LinkEnd="wait-key"/> variable or
not. When an attachment is viewed using an interactive program, and the
-corresponding mailcap entry has a <em/needsterminal/ flag, Mutt will use
-<ref id="wait_key" name="$wait_key"> and the exit status
+corresponding mailcap entry has a <emphasis>needsterminal</emphasis> flag,
Mutt will use
+<xref LinkEnd="wait-key"/> and the exit status
of the program to decide if it will ask you to press a key after the
external program has exited. In all other situations it will not prompt
you for a key.
-<tag>compose=<command></tag>
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>compose=<command></term>
+<listitem>
+<para>
This flag specifies the command to use to create a new attachment of a
specific MIME type. Mutt supports this from the compose menu.
-<tag>composetyped=<command></tag>
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>composetyped=<command></term>
+<listitem>
+<para>
This flag specifies the command to use to create a new attachment of a
specific MIME type. This command differs from the compose command in
that mutt will expect standard MIME headers on the data. This can be
used to specify parameters, filename, description, etc. for a new
attachment. Mutt supports this from the compose menu.
-<tag>print=<command></tag>
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>print=<command></term>
+<listitem>
+<para>
This flag specifies the command to use to print a specific MIME type.
Mutt supports this from the attachment and compose menus.
-<tag>edit=<command></tag>
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>edit=<command></term>
+<listitem>
+<para>
This flag specifies the command to use to edit a specific MIME type.
Mutt supports this from the compose menu, and also uses it to compose
new attachments. Mutt will default to the defined editor for text
attachments.
-<tag>nametemplate=<template></tag>
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>nametemplate=<template></term>
+<listitem>
+<para>
This field specifies the format for the file denoted by %s in the
command fields. Certain programs will require a certain file extension,
for instance, to correctly view a file. For instance, lynx will only
-interpret a file as <tt>text/html</tt> if the file ends in <tt/.html/.
-So, you would specify lynx as a <tt>text/html</tt> viewer with a line in
+interpret a file as <literal remap="tt">text/html</literal> if the file ends
in <literal remap="tt">.html</literal>.
+So, you would specify lynx as a <literal remap="tt">text/html</literal> viewer
with a line in
the mailcap file like:
-<tscreen><verb>
+
+<screen>
text/html; lynx %s; nametemplate=%s.html
-</verb></tscreen>
-<tag>test=<command></tag>
+</screen>
+
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>test=<command></term>
+<listitem>
+<para>
This field specifies a command to run to test whether this mailcap
entry should be used. The command is defined with the command expansion
rules defined in the next section. If the command returns 0, then the
test passed, and Mutt uses this entry. If the command returns non-zero,
then the test failed, and Mutt continues searching for the right entry.
-<bf/Note:/ <em>the content-type must match before Mutt performs the test.</em>
+<emphasis remap="bf">Note:</emphasis> <emphasis>the content-type must match
before Mutt performs the test.</emphasis>
For example:
-<tscreen><verb>
+
+<screen>
text/html; netscape -remote 'openURL(%s)' ; test=RunningX
text/html; lynx %s
-</verb></tscreen>
+</screen>
+
In this example, Mutt will run the program RunningX which will return 0
if the X Window manager is running, and non-zero if it isn't. If
RunningX returns 0, then Mutt will call netscape to display the
text/html object. If RunningX doesn't return 0, then Mutt will go on
to the next entry and use lynx to display the text/html object.
-</descrip>
-
-<sect3>Search Order
-<p>
+</para>
+</listitem>
+</varlistentry>
+</variablelist>
+</para>
+
+</sect4>
+
+<sect4>
+<title>Search Order</title>
+
+<para>
When searching for an entry in the mailcap file, Mutt will search for
the most useful entry for its purpose. For instance, if you are
-attempting to print an <tt>image/gif</tt>, and you have the following
+attempting to print an <literal remap="tt">image/gif</literal>, and you have
the following
entries in your mailcap file, Mutt will search for an entry with the
print command:
-<tscreen><verb>
+
+<screen>
image/*; xv %s
image/gif; ; print= anytopnm %s | pnmtops | lpr; \
nametemplate=%s.gif
-</verb></tscreen>
-Mutt will skip the <tt>image/*</tt> entry and use the <tt>image/gif</tt>
+</screen>
+
+Mutt will skip the <literal remap="tt">image/*</literal> entry and use the
<literal remap="tt">image/gif</literal>
entry with the print command.
-
-In addition, you can use this with <ref id="auto_view" name="Autoview">
+</para>
+
+<para>
+In addition, you can use this with <xref LinkEnd="auto-view"/>
to denote two commands for viewing an attachment, one to be viewed
automatically, the other to be viewed interactively from the attachment
menu. In addition, you can then use the test feature to determine which
viewer to use interactively depending on your environment.
-<tscreen><verb>
+
+<screen>
text/html; netscape -remote 'openURL(%s)' ; test=RunningX
text/html; lynx %s; nametemplate=%s.html
text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput
-</verb></tscreen>
-For <ref id="auto_view" name="Autoview">, Mutt will choose the third
+</screen>
+
+For <xref LinkEnd="auto-view"/>, Mutt will choose the third
entry because of the copiousoutput tag. For interactive viewing, Mutt
will run the program RunningX to determine if it should use the first
entry. If the program returns non-zero, Mutt will use the second entry
for interactive viewing.
-
-<sect3>Command Expansion
-<p>
+</para>
+
+</sect4>
+
+<sect4>
+<title>Command Expansion</title>
+
+<para>
The various commands defined in the mailcap files are passed to the
-<tt>/bin/sh</tt> shell using the system() function. Before the
-command is passed to <tt>/bin/sh -c</tt>, it is parsed to expand
+<literal remap="tt">/bin/sh</literal> shell using the system() function.
Before the
+command is passed to <literal remap="tt">/bin/sh -c</literal>, it is parsed to
expand
various special parameters with information from Mutt. The keywords
Mutt expands are:
-<descrip>
-<tag/%s/
+<variablelist>
+
+<varlistentry>
+<term>%s</term>
+<listitem>
+<para>
As seen in the basic mailcap section, this variable is expanded
to a filename specified by the calling program. This file contains
the body of the message to view/print/edit or where the composing
program should place the results of composition. In addition, the
use of this keyword causes Mutt to not pass the body of the message
to the view/print/edit program on stdin.
-<tag/%t/
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>%t</term>
+<listitem>
+<para>
Mutt will expand %t to the text representation of the content
type of the message in the same form as the first parameter of the
-mailcap definition line, ie <tt>text/html</tt> or
-<tt>image/gif</tt>.
-<tag>%{<parameter>}</tag>
+mailcap definition line, ie <literal remap="tt">text/html</literal> or
+<literal remap="tt">image/gif</literal>.
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>%{<parameter>}</term>
+<listitem>
+<para>
Mutt will expand this to the value of the specified parameter
from the Content-Type: line of the mail message. For instance, if
Your mail message contains:
-<tscreen><verb>
+
+<screen>
Content-Type: text/plain; charset=iso-8859-1
-</verb></tscreen>
-then Mutt will expand %{charset} to iso-8859-1. The default metamail
+</screen>
+
+then Mutt will expand %{charset} to iso-8859-1. The default
metamail
mailcap file uses this feature to test the charset to spawn an xterm
using the right charset to view the message.
-<tag>\%</tag>
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>\%</term>
+<listitem>
+<para>
This will be replaced by a %
-</descrip>
+</para>
+</listitem>
+</varlistentry>
+</variablelist>
Mutt does not currently support the %F and %n keywords
specified in RFC 1524. The main purpose of these parameters is for
multipart messages, which is handled internally by Mutt.
-
-<sect2>Example mailcap files
-<p>
+</para>
+
+</sect4>
+
+</sect3>
+
+<sect3>
+<title>Example mailcap files</title>
+
+<para>
This mailcap file is fairly simple and standard:
-<code>
+
+<programlisting>
# I'm always running X :)
-video/*; xanim %s > /dev/null
-image/*; xv %s > /dev/null
+video/*; xanim %s > /dev/null
+image/*; xv %s > /dev/null
# I'm always running netscape (if my computer had more memory, maybe)
text/html; netscape -remote 'openURL(%s)'
-</code>
-
+</programlisting>
+
+</para>
+
+<para>
This mailcap file shows quite a number of examples:
-
-<code>
+</para>
+
+<para>
+
+<programlisting>
# Use xanim to view all videos Xanim produces a header on startup,
# send that to /dev/null so I don't see it
-video/*; xanim %s > /dev/null
+video/*; xanim %s > /dev/null
# Send html to a running netscape by remote
text/html; netscape -remote 'openURL(%s)'; test=RunningNetscape
@@ -3008,67 +5036,105 @@
# Convert images to text using the netpbm tools
image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
-pbmtoascii -1x2 ) 2>&1 ; copiousoutput
+pbmtoascii -1x2 ) 2>&1 ; copiousoutput
# Send excel spreadsheets to my NT box
application/ms-excel; open.pl %s
-</code>
-
-<sect1>MIME Autoview<label id="auto_view">
-<p>
+</programlisting>
+
+</para>
+
+</sect3>
+
+</sect2>
+
+<sect2 id="auto-view">
+<title>MIME Autoview</title>
+
+<para>
In addition to explicitly telling Mutt to view an attachment with the
MIME viewer defined in the mailcap file, Mutt has support for
automatically viewing MIME attachments while in the pager.
-
+</para>
+
+<para>
To work, you must define a viewer in the mailcap file which uses the
-<tt/copiousoutput/ option to denote that it is non-interactive.
+<literal remap="tt">copiousoutput</literal> option to denote that it is
non-interactive.
Usually, you also use the entry to convert the attachment to a text
representation which you can view in the pager.
-
-You then use the <tt/auto_view/ muttrc command to list the
+</para>
+
+<para>
+You then use the <literal remap="tt">auto_view</literal> muttrc command
to list the
content-types that you wish to view automatically.
-
+</para>
+
+<para>
For instance, if you set auto_view to:
-<tscreen><verb>
+
+<screen>
auto_view text/html application/x-gunzip application/postscript image/gif
application/x-tar-gz
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
Mutt could use the following mailcap entries to automatically view
attachments of these types.
-<tscreen><verb>
+
+<screen>
text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html
image/*; anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm |
pgmtopbm | pbmtoascii ; copiousoutput
application/x-gunzip; gzcat; copiousoutput
application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
application/postscript; ps2ascii %s; copiousoutput
-</verb></tscreen>
-
-``unauto_view'' can be used to remove previous entries from the autoview list.
+</screen>
+
+</para>
+
+<para>
+``unauto_view'' can be used to remove previous entries from the
autoview list.
This can be used with message-hook to autoview messages based on size, etc.
-``unauto_view *'' will remove all previous entries.
-
-<sect1>MIME Multipart/Alternative<label id="alternative_order">
-<p>
+``unauto_view *'' will remove all previous entries.
+</para>
+
+</sect2>
+
+<sect2 id="alternative-order">
+<title>MIME Multipart/Alternative</title>
+
+<para>
Mutt has some heuristics for determining which attachment of a
multipart/alternative type to display. First, mutt will check the
alternative_order list to determine if one of the available types
is preferred. The alternative_order list consists of a number of
mimetypes in order, including support for implicit and explicit
wildcards, for example:
-<tscreen><verb>
+
+<screen>
alternative_order text/enriched text/plain text application/postscript image/*
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
Next, mutt will check if any of the types have a defined
-<ref id="auto_view" name="auto_view">, and use that. Failing
+<xref LinkEnd="auto-view"/>, and use that. Failing
that, Mutt will look for any text type. As a last attempt, mutt will
look for any type it knows how to handle.
-
-To remove a MIME type from the <tt/alternative_order/ list, use the
-<tt/unalternative_order/ command.
-
-<sect1>MIME Lookup<label id="mime_lookup">
-<p>
+</para>
+
+<para>
+To remove a MIME type from the <literal
remap="tt">alternative_order</literal> list, use the
+<literal remap="tt">unalternative_order</literal> command.
+</para>
+
+</sect2>
+
+<sect2 id="mime-lookup">
+<title>MIME Lookup</title>
+
+<para>
Mutt's mime_lookup list specifies a list of mime-types that should not
be treated according to their mailcap entry. This option is designed to
deal with binary types such as application/octet-stream. When an attachment's
@@ -3077,22 +5143,38 @@
associated with this extension will then be used to process the attachment
according to the rules in the mailcap file and according to any other
configuration
options (such as auto_view) specified. Common usage would be:
-<tscreen><verb>
+
+<screen>
mime_lookup application/octet-stream application/X-Lotus-Manuscript
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
In addition, the unmime_lookup command may be used to disable this
feature
for any particular mime-type if it had been set, for example, in a global
muttrc.
-
-<sect>Reference
-<sect1>Command line options<label id="commandline">
-<p>
-Running <tt/mutt/ with no arguments will make Mutt attempt to read your spool
+</para>
+
+</sect2>
+
+</sect1>
+
+<sect1>
+<title>Reference</title>
+
+<sect2 id="commandline">
+<title>Command line options</title>
+
+<para>
+Running <literal remap="tt">mutt</literal> with no arguments will make Mutt
attempt to read your spool
mailbox. However, it is possible to read other mailboxes and
to send messages from the command line as well.
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
-A expand an alias
-a attach a file to a message
-b specify a blind carbon-copy (BCC) address
@@ -3115,135 +5197,366 @@
-y show a menu containing the files specified by the mailboxes command
-z exit immediately if there are no messages in the mailbox
-Z open the first folder with new message,exit immediately if none
-</verb></tscreen>
-
+</screen>
+
+</para>
+
+<para>
To read messages in a mailbox
-
-<tt/mutt/ [ -nz ] [ -F <em/muttrc/ ] [ -m <em/type/
] [ -f <em/mailbox/ ]
-
+</para>
+
+<para>
+<literal remap="tt">mutt</literal> [ -nz ] [ -F
<emphasis>muttrc</emphasis> ] [ -m <emphasis>type</emphasis> ]
[ -f <emphasis>mailbox</emphasis> ]
+</para>
+
+<para>
To compose a new message
-
-<tt/mutt/ [ -n ] [ -F <em/muttrc/ ] [ -a <em/file/
] [ -c <em/address/ ] [ -i <em/filename/ ] [ -s
<em/subject/ ] <em/address/ [ <em/address/ ... ]
-
+</para>
+
+<para>
+<literal remap="tt">mutt</literal> [ -n ] [ -F
<emphasis>muttrc</emphasis> ] [ -a <emphasis>file</emphasis> ]
[ -c <emphasis>address</emphasis> ] [ -i
<emphasis>filename</emphasis> ] [ -s <emphasis>subject</emphasis>
] <emphasis>address</emphasis> [ <emphasis>address</emphasis> ...
]
+</para>
+
+<para>
Mutt also supports a ``batch'' mode to send prepared messages. Simply redirect
input from the file you wish to send. For example,
-
-<tt>mutt -s &dquot;data set for run #2&dquot; professor@xxxxxxxxxxxxx
-< ˜/run2.dat</tt>
-
+</para>
+
+<para>
+<literal remap="tt">mutt -s "data set for run #2"
professor@xxxxxxxxxxxxx
+< ˜/run2.dat</literal>
+</para>
+
+<para>
This command will send a message to ``professor@xxxxxxxxxxxxx'' with a subject
of ``data set for run #2''. In the body of the message will be the
contents
of the file ``˜/run2.dat''.
-
-<sect1>Configuration Commands<label id="commands">
-<p>
+</para>
+
+</sect2>
+
+<sect2 id="commands">
+<title>Configuration Commands</title>
+
+<para>
The following are the commands understood by mutt.
-
-<itemize>
-<item>
-<tt><ref id="account-hook" name="account-hook"></tt> <em/pattern/ <em/command/
-<item>
-<tt><ref id="alias" name="alias"></tt> <em/key/ <em/address/ [ ,
<em/address/, ... ]
-<item>
-<tt><ref id="alias" name="unalias"></tt> [ * | <em/key/ ... ]
-<item>
-<tt><ref id="alternates" name="alternates"></tt> <em/regexp/ [
<em/regexp/ ... ]
-<item>
-<tt><ref id="alternates" name="unalternates"></tt> [ * | <em/regexp/ ...
]
-<item>
-<tt><ref id="alternative_order" name="alternative_order"></tt>
<em/mimetype/ [ <em/mimetype/ ... ]
-<item>
-<tt><ref id="alternative_order" name="unalternative_order"></tt>
<em/mimetype/ [ <em/mimetype/ ... ]
-<item>
-<tt><ref id="auto_view" name="auto_view"></tt> <em/mimetype/ [
<em/mimetype/ ... ]
-<item>
-<tt><ref id="auto_view" name="unauto_view"></tt> <em/mimetype/ [
<em/mimetype/ ... ]
-<item>
-<tt><ref id="bind" name="bind"></tt> <em/map/ <em/key/ <em/function/
-<item>
-<tt><ref id="charset-hook" name="charset-hook"></tt> <em/alias/ <em/charset/
-<item>
-<tt><ref id="color" name="color"></tt> <em/object/ <em/foreground/
<em/background/ [ <em/regexp/ ]
-<item>
-<tt><ref id="color" name="uncolor"></tt> <em/index/ <em/pattern/ [
<em/pattern/ ... ]
-<item>
-<tt><ref id="exec" name="exec"></tt> <em/function/ [ <em/function/ ...
]
-<item>
-<tt><ref id="fcc-hook" name="fcc-hook"></tt> <em/pattern/ <em/mailbox/
-<item>
-<tt><ref id="fcc-save-hook" name="fcc-save-hook"></tt> <em/pattern/
<em/mailbox/
-<item>
-<tt><ref id="folder-hook" name="folder-hook"></tt> <em/pattern/ <em/command/
-<item>
-<tt><ref id="hdr_order" name="hdr_order"></tt> <em/header/ [
<em/header/ ... ]
-<item>
-<tt><ref id="hdr_order" name="unhdr_order"></tt> <em/header/ [
<em/header/ ... ]
-<item>
-<tt><ref id="charset-hook" name="iconv-hook"></tt> <em/charset/
<em/local-charset/
-<item>
-<tt><ref id="ignore" name="ignore"></tt> <em/pattern/ [ <em/pattern/ ...
]
-<item>
-<tt><ref id="ignore" name="unignore"></tt> <em/pattern/ [ <em/pattern/
... ]
-<item>
-<tt><ref id="lists" name="lists"></tt> <em/regexp/ [ <em/regexp/ ...
]
-<item>
-<tt><ref id="lists" name="unlists"></tt> <em/regexp/ [ <em/regexp/ ...
]
-<item>
-<tt><ref id="macro" name="macro"></tt> <em/menu/ <em/key/ <em/sequence/ [
<em/description/ ]
-<item>
-<tt><ref id="mailboxes" name="mailboxes"></tt> <em/filename/ [
<em/filename/ ... ]
-<item>
-<tt><ref id="mbox-hook" name="mbox-hook"></tt> <em/pattern/ <em/mailbox/
-<item>
-<tt><ref id="message-hook" name="message-hook"></tt> <em/pattern/ <em/command/
-<item>
-<tt><ref id="mime_lookup" name="mime_lookup"></tt> <em/mimetype/ [
<em/mimetype/ ... ]
-<item>
-<tt><ref id="mime_lookup" name="unmime_lookup"></tt> <em/mimetype/
[ <em/mimetype/ ... ]
-<item>
-<tt><ref id="color" name="mono"></tt> <em/object attribute/ [ <em/regexp/
]
-<item>
-<tt><ref id="color" name="unmono"></tt> <em/index/ <em/pattern/ [
<em/pattern/ ... ]
-<item>
-<tt><ref id="my_hdr" name="my_hdr"></tt> <em/string/
-<item>
-<tt><ref id="my_hdr" name="unmy_hdr"></tt> <em/field/ [ <em/field/
... ]
-<item>
-<tt><ref id="crypt-hook" name="crypt-hook"></tt> <em/pattern/ <em/key-id/
-<item>
-<tt><ref id="push" name="push"></tt> <em/string/
-<item>
-<tt><ref id="set" name="reset"></tt> <em/variable/ [<em/variable/ ...
]
-<item>
-<tt><ref id="save-hook" name="save-hook"></tt> <em/regexp/ <em/filename/
-<item>
-<tt><ref id="score-command" name="score"></tt> <em/pattern/ <em/value/
-<item>
-<tt><ref id="score-command" name="unscore"></tt> <em/pattern/ [
<em/pattern/ ... ]
-<item>
-<tt><ref id="send-hook" name="send-hook"></tt> <em/regexp/ <em/command/
-<item>
-<tt><ref id="reply-hook" name="reply-hook"></tt> <em/regexp/ <em/command/
-<item>
-<tt><ref id="set" name="set"></tt>
[no|inv]<em/variable/[=<em/value/] [ <em/variable/ ...
]
-<item>
-<tt><ref id="set" name="unset"></tt> <em/variable/ [<em/variable/ ...
]
-<item>
-<tt><ref id="source" name="source"></tt> <em/filename/
-<item>
-<tt><ref id="spam" name="spam"></tt> <em/pattern/ <em/format/
-<item>
-<tt><ref id="spam" name="nospam"></tt> <em/pattern/
-<item>
-<tt><ref id="lists" name="subscribe"></tt> <em/regexp/ [ <em/regexp/ ...
]
-<item>
-<tt><ref id="lists" name="unsubscribe"></tt> <em/regexp/ [ <em/regexp/
... ]
-<item>
-<tt><ref id="set" name="toggle"></tt> <em/variable/ [<em/variable/ ...
]
-<item>
-<tt><ref id="unhook" name="unhook"></tt> <em/hook-type/
-</itemize>
-
-<sect1>Configuration variables<label id="variables">
-<p>
-
+</para>
+
+<para>
+
+<itemizedlist>
+<listitem>
+
+<para>
+<literal remap="tt"><link linkend="account-hook">account-hook</link></literal>
<emphasis>pattern</emphasis> <emphasis>command</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="alias">alias</link></literal>
<emphasis>key</emphasis> <emphasis>address</emphasis> [ ,
<emphasis>address</emphasis>, ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="alias">alias</link></literal> [ *
| <emphasis>key</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="alternates">alternates</link></literal>
<emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="alternates">alternates</link></literal>
[ * | <emphasis>regexp</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link
LinkEnd="alternative-order">alternative-order</link></literal>
<emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link
LinkEnd="alternative-order">alternative-order</link></literal>
<emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="auto-view">auto-view</link></literal>
<emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="auto-view">auto-view</link></literal>
<emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="bind">bind</link></literal>
<emphasis>map</emphasis> <emphasis>key</emphasis> <emphasis>function</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="charset-hook">charset-hook</link></literal>
<emphasis>alias</emphasis> <emphasis>charset</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="color">color</link></literal>
<emphasis>object</emphasis> <emphasis>foreground</emphasis>
<emphasis>background</emphasis> [ <emphasis>regexp</emphasis> ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="color">color</link></literal>
<emphasis>index</emphasis> <emphasis>pattern</emphasis> [
<emphasis>pattern</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="exec">exec</link></literal>
<emphasis>function</emphasis> [ <emphasis>function</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="fcc-hook">fcc-hook</link></literal>
<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link
LinkEnd="fcc-save-hook">fcc-save-hook</link></literal>
<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="folder-hook">folder-hook</link></literal>
<emphasis>pattern</emphasis> <emphasis>command</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="hdr-order">hdr-order</link></literal>
<emphasis>header</emphasis> [ <emphasis>header</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="hdr-order">hdr-order</link></literal>
<emphasis>header</emphasis> [ <emphasis>header</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="charset-hook">charset-hook</link></literal>
<emphasis>charset</emphasis> <emphasis>local-charset</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="ignore">ignore</link></literal>
<emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="ignore">ignore</link></literal>
<emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="lists">lists</link></literal>
<emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="lists">lists</link></literal>
<emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="macro">macro</link></literal>
<emphasis>menu</emphasis> <emphasis>key</emphasis>
<emphasis>sequence</emphasis> [ <emphasis>description</emphasis> ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="mailboxes">mailboxes</link></literal>
<emphasis>filename</emphasis> [ <emphasis>filename</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="mbox-hook">mbox-hook</link></literal>
<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="message-hook">message-hook</link></literal>
<emphasis>pattern</emphasis> <emphasis>command</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="mime-lookup">mime-lookup</link></literal>
<emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="mime-lookup">mime-lookup</link></literal>
<emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="color">color</link></literal>
<emphasis>object attribute</emphasis> [ <emphasis>regexp</emphasis> ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="color">color</link></literal>
<emphasis>index</emphasis> <emphasis>pattern</emphasis> [
<emphasis>pattern</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="my-hdr">my-hdr</link></literal>
<emphasis>string</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="my-hdr">my-hdr</link></literal>
<emphasis>field</emphasis> [ <emphasis>field</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="crypt-hook">crypt-hook</link></literal>
<emphasis>pattern</emphasis> <emphasis>key-id</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="push">push</link></literal>
<emphasis>string</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="set">set</link></literal>
<emphasis>variable</emphasis> [<emphasis>variable</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="save-hook">save-hook</link></literal>
<emphasis>regexp</emphasis> <emphasis>filename</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link
LinkEnd="score-command">score-command</link></literal>
<emphasis>pattern</emphasis> <emphasis>value</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link
LinkEnd="score-command">score-command</link></literal>
<emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="send-hook">send-hook</link></literal>
<emphasis>regexp</emphasis> <emphasis>command</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="reply-hook">reply-hook</link></literal>
<emphasis>regexp</emphasis> <emphasis>command</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="set">set</link></literal>
[no|inv]<emphasis>variable</emphasis>[=<emphasis>value</emphasis>]
[ <emphasis>variable</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="set">set</link></literal>
<emphasis>variable</emphasis> [<emphasis>variable</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="source">source</link></literal>
<emphasis>filename</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="spam">spam</link></literal>
<emphasis>pattern</emphasis> <emphasis>format</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="spam">spam</link></literal>
<emphasis>pattern</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="lists">lists</link></literal>
<emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="lists">lists</link></literal>
<emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="set">set</link></literal>
<emphasis>variable</emphasis> [<emphasis>variable</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal remap="tt"><link LinkEnd="unhook">unhook</link></literal>
<emphasis>hook-type</emphasis>
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+</sect2>
+
+<sect2 id="variables">
+<title>Configuration variables</title>
diff -r e1ed910b6103 doc/manual.sgml.tail
--- a/doc/manual.sgml.tail Sat Jul 30 11:42:36 2005
+++ b/doc/manual.sgml.tail Fri Jul 29 23:04:50 2005
@@ -1,20 +1,29 @@
-<sect1>Functions<label id="functions">
-<p>
+</sect2>
+
+<sect2 id="functions">
+<title>Functions</title>
+
+<para>
The following is the list of available functions listed by the mapping
in which they are available. The default key setting is given, and an
explanation of what the function does. The key bindings of these
-functions can be changed with the <ref name="bind" id="bind">
+functions can be changed with the <xref linkend="bind"/>
command.
-
-<sect2>generic
-<p>
-
-The <em/generic/ menu is not a real menu, but specifies common functions
-(such as movement) available in all menus except for <em/pager/ and
-<em/editor/. Changing settings for this menu will affect the default
+</para>
+
+<sect3>
+<title>generic</title>
+
+<para>
+The <emphasis>generic</emphasis> menu is not a real menu, but specifies common
functions
+(such as movement) available in all menus except for
<emphasis>pager</emphasis> and
+<emphasis>editor</emphasis>. Changing settings for this menu will affect the
default
bindings for all menus (except as noted).
-
-<verb>
+</para>
+
+<para>
+
+<screen>
bottom-page L move to the bottom of the page
current-bottom not bound move current entry to bottom of page
current-middle not bound move current entry to middle of page
@@ -29,10 +38,10 @@
last-entry * move to the last entry
middle-page M move to the middle of the page
next-entry j move to the next entry
-next-line > scroll down one line
+next-line > scroll down one line
next-page z move to the next page
previous-entry k move to the previous entry
-previous-line < scroll up one line
+previous-line < scroll up one line
previous-page Z move to the previous page
refresh ^L clear and redraw the screen
search / search for a regular expression
@@ -46,10 +55,18 @@
tag-prefix-cond not bound apply next function ONLY to tagged messages
top-page H move to the top of the page
what-key not bound display the keycode for a key press
-</verb>
-<sect2>index
-<p>
-<verb>
+</screen>
+
+</para>
+
+</sect3>
+
+<sect3>
+<title>index</title>
+
+<para>
+
+<screen>
bounce-message b remail a message to another user
change-folder c open a different folder
change-folder-readonly ESC c open a different folder in read only mode
@@ -117,10 +134,18 @@
undelete-thread ^U undelete all messages in thread
untag-pattern ^T untag messages matching a pattern
view-attachments v show MIME attachments
-</verb>
-<sect2>pager
-<p>
-<verb>
+</screen>
+
+</para>
+
+</sect3>
+
+<sect3>
+<title>pager</title>
+
+<para>
+
+<screen>
bottom not bound jump to the bottom of the message
bounce-message b remail a message to another user
change-folder c open a different folder
@@ -193,17 +218,33 @@
undelete-subthread ESC u undelete all messages in subthread
undelete-thread ^U undelete all messages in thread
view-attachments v show MIME attachments
-</verb>
-<sect2>alias
-<p>
-<verb>
+</screen>
+
+</para>
+
+</sect3>
+
+<sect3>
+<title>alias</title>
+
+<para>
+
+<screen>
search / search for a regular expression
search-next n search for next match
search-reverse ESC / search backwards for a regular expression
-</verb>
-<sect2>query
-<p>
-<verb>
+</screen>
+
+</para>
+
+</sect3>
+
+<sect3>
+<title>query</title>
+
+<para>
+
+<screen>
create-alias a create an alias from a message sender
mail m compose a new mail message
query Q query external program for addresses
@@ -212,10 +253,18 @@
search-next n search for next match
search-opposite not bound search for next match in opposite direction
search-reverse ESC / search backwards for a regular expression
-</verb>
-<sect2>attach
-<p>
-<verb>
+</screen>
+
+</para>
+
+</sect3>
+
+<sect3>
+<title>attach</title>
+
+<para>
+
+<screen>
bounce-message b remail a message to another user
collapse-parts v toggle display of subparts
delete-entry d delete the current entry
@@ -234,10 +283,18 @@
view-attach RET view attachment using mailcap entry if necessary
view-mailcap m force viewing of attachment using mailcap
view-text T view attachment as text
-</verb>
-<sect2>compose
-<p>
-<verb>
+</screen>
+
+</para>
+
+</sect3>
+
+<sect3>
+<title>compose</title>
+
+<para>
+
+<screen>
attach-file a attach a file(s) to this message
attach-message A attach message(s) to this message
attach-key ESC k attach a PGP public key
@@ -271,16 +328,32 @@
toggle-unlink u toggle whether to delete file after sending it
view-attach RET view attachment using mailcap entry if necessary
write-fcc w write the message to a folder
-</verb>
-<sect2>postpone
-<p>
-<verb>
+</screen>
+
+</para>
+
+</sect3>
+
+<sect3>
+<title>postpone</title>
+
+<para>
+
+<screen>
delete-entry d delete the current entry
undelete-entry u undelete the current entry
-</verb>
-<sect2>browser
-<p>
-<verb>
+</screen>
+
+</para>
+
+</sect3>
+
+<sect3>
+<title>browser</title>
+
+<para>
+
+<screen>
change-dir c change directories
check-new TAB check mailboxes for new mail
enter-mask m enter a file mask
@@ -295,16 +368,32 @@
subscribe s subscribe to current mailbox (IMAP Only)
unsubscribe u unsubscribe to current mailbox (IMAP Only)
toggle-subscribed T toggle view all/subscribed mailboxes (IMAP Only)
-</verb>
-<sect2>pgp
-<p>
-<verb>
+</screen>
+
+</para>
+
+</sect3>
+
+<sect3>
+<title>pgp</title>
+
+<para>
+
+<screen>
view-name % view the key's user id
verify-key c verify a PGP public key
-</verb>
-<sect2>editor
-<p>
-<verb>
+</screen>
+
+</para>
+
+</sect3>
+
+<sect3>
+<title>editor</title>
+
+<para>
+
+<screen>
backspace BackSpace delete the char in front of the cursor
backward-char ^B move the cursor one character to the left
backward-word ESC b move the cursor to the previous word
@@ -327,64 +416,257 @@
quote-char ^V quote the next typed key
transpose-chars not bound transpose character under cursor with previous
upcase-word ESC u uppercase all characters in current word
-</verb>
-
-<sect>Miscellany
-<p>
-
-<sect1>Acknowledgements
-<p>
+</screen>
+
+</para>
+
+</sect3>
+
+</sect2>
+
+</sect1>
+
+<sect1>
+<title>Miscellany</title>
+
+<sect2>
+<title>Acknowledgements</title>
+
+<para>
Kari Hurtta
-<htmlurl url="mailto:kari.hurtta@xxxxxx"; name="<kari.hurtta@xxxxxx>">
+<ulink
+URL="mailto:kari.hurtta@xxxxxx";
+><kari.hurtta@xxxxxx></ulink
+>
co-developed the original MIME parsing code back in the ELM-ME days.
-
+</para>
+
+<para>
The following people have been very helpful to the development of Mutt:
-
-Vikas Agnihotri <htmlurl url="mailto:vikasa@xxxxxxxxxxx";
name="<vikasa@xxxxxxxxxxx>">,<newline>
-Francois Berjon <htmlurl url="mailto:Francois.Berjon@xxxxxxxxxxxxxxxxxxxxxx";
name="<Francois.Berjon@xxxxxxxxxxxxxxxxxxxxxx>">,<newline>
-Aric Blumer <htmlurl url="mailto:aric@xxxxxxxx";
name="<aric@xxxxxxxx>">,<newline>
-John Capo <htmlurl url="mailto:jc@xxxxxxxx";
name="<jc@xxxxxxxx>">,<newline>
-David Champion <htmlurl url="mailto:dgc@xxxxxxxxxxxx";
name="<dgc@xxxxxxxxxxxx">,<newline>
-Brendan Cully <htmlurl url="mailto:brendan@xxxxxxxxxx";
name="<brendan@xxxxxxxxxx>">,<newline>
-Liviu Daia <htmlurl url="mailto:daia@xxxxxxxxxxxxxxx";
name="<daia@xxxxxxxxxxxxxxx>">,<newline>
-Thomas E. Dickey <htmlurl url="mailto:dickey@xxxxxxxxxxxxxxxx";
name="<dickey@xxxxxxxxxxxxxxxx>">,<newline>
-David DeSimone <htmlurl url="mailto:fox@xxxxxxxxxxxxx";
name="<fox@xxxxxxxxxxxxx>">,<newline>
-Nickolay N. Dudorov <htmlurl url="mailto:nnd@xxxxxxxxxxxxxxxx";
name="<nnd@xxxxxxxxxxxxxxxx>">,<newline>
-Ruslan Ermilov <htmlurl url="mailto:ru@xxxxxxxxxxx";
name="<ru@xxxxxxxxxxx>">,<newline>
-Edmund Grimley Evans <htmlurl url="mailto:edmundo@xxxxxxxx";
name="<edmundo@xxxxxxxx">,<newline>
-Michael Finken <htmlurl url="mailto:finken@xxxxxxxxxx";
name="<finken@xxxxxxxxxx>">,<newline>
-Sven Guckes <htmlurl url="mailto:guckes@xxxxxxxxxxxxxxxxx";
name="<guckes@xxxxxxxxxxxxxxxxx>">,<newline>
-Lars Hecking <htmlurl url="mailto:lhecking@xxxxxxx";
name="<lhecking@xxxxxxx>">,<newline>
-Mark Holloman <htmlurl url="mailto:holloman@xxxxxxxxx";
name="<holloman@xxxxxxxxx>">,<newline>
-Andreas Holzmann <htmlurl url="mailto:holzmann@xxxxxxxxxxxxxxxxx";
name="<holzmann@xxxxxxxxxxxxxxxxx>">,<newline>
-Marco d'Itri <htmlurl url="mailto:md@xxxxxxxx";
name="<md@xxxxxxxx>">,<newline>
-Bj�rn Jacke <htmlurl url="mailto:bjacke@xxxxxxxx";
name="<bjacke@xxxxxxxx>">,<newline>
-Byrial Jensen <htmlurl url="mailto:byrial@xxxxxxxx";
name="<byrial@xxxxxxxx>">,<newline>
-David Jeske <htmlurl url="mailto:jeske@xxxxxxxxx";
name="<jeske@xxxxxxxxx>">,<newline>
-Christophe Kalt <htmlurl url="mailto:kalt@xxxxxxxxxxxxxxxx";
name="<kalt@xxxxxxxxxxxxxxxx>">,<newline>
-Tommi Komulainen <htmlurl url="mailto:Tommi.Komulainen@xxxxxx";
name="<Tommi.Komulainen@xxxxxx>">,<newline>
-Felix von Leitner (a.k.a ``Fefe'') <htmlurl
url="mailto:leitner@xxxxxxxxxxxxxxxxx";
name="<leitner@xxxxxxxxxxxxxxxxx>">,<newline>
-Brandon Long <htmlurl url="mailto:blong@xxxxxxxxxxx";
name="<blong@xxxxxxxxxxx>">,<newline>
-Jimmy M�kel� <htmlurl url="mailto:jmy@xxxxxxxxxxxxx";
name="<jmy@xxxxxxxxxxxxx>">,<newline>
-Lars Marowsky-Bree <htmlurl url="mailto:lmb@xxxxxxxxxxxxxxxxxxxx";
name="<lmb@xxxxxxxxxxxxxxxxxxxx>">,<newline>
-Thomas ``Mike'' Michlmayr <htmlurl url="mailto:mike@xxxxxxxxxxxxxx";
name="<mike@xxxxxxxxxxxxxx>">,<newline>
-Andrew W. Nosenko <htmlurl url="mailto:awn@xxxxxxxxx";
name="<awn@xxxxxxxxx>">,<newline>
-David O'Brien <htmlurl url="mailto:obrien@xxxxxxxxxxxxxxxxxxx";
name="<obrien@xxxxxxxxxxxxxxxxxxx>">,<newline>
-Clint Olsen <htmlurl url="mailto:olsenc@xxxxxxxxxxxxxxxx";
name="<olsenc@xxxxxxxxxxxxxxxx>">,<newline>
-Park Myeong Seok <htmlurl url="mailto:pms@xxxxxxxxxxxxxxxxxxx";
name="<pms@xxxxxxxxxxxxxxxxxxx>">,<newline>
-Thomas Parmelan <htmlurl url="mailto:tom@xxxxxxxxxxxxxx";
name="<tom@xxxxxxxxxxxxxx>">,<newline>
-Ollivier Robert <htmlurl url="mailto:roberto@xxxxxxxxxxxxxxxxx";
name="<roberto@xxxxxxxxxxxxxxxxx>">,<newline>
-Thomas Roessler <htmlurl url="mailto:roessler@xxxxxxxxxxxxxxxxxx";
name="<roessler@xxxxxxxxxxxxxxxxxx>">,<newline>
-Roland Rosenfeld <htmlurl url="roland@xxxxxxxxxxxx"
name="<roland@xxxxxxxxxxxx>">,<newline>
-TAKIZAWA Takashi <htmlurl url="taki@xxxxxxxxxxxxxxxx"
name="<taki@xxxxxxxxxxxxxxxx>">,<newline>
-Allain Thivillon <htmlurl url="mailto:Allain.Thivillon@xxxxxxx";
name="<Allain.Thivillon@xxxxxxx>">,<newline>
-Gero Treuner <htmlurl url="mailto:gero@xxxxxxxxxxxxxxxxxxxxxxx";
name="<gero@xxxxxxxxxxxxxxxxxxxxxxx>">,<newline>
-Vsevolod Volkov <htmlurl url="mailto:vvv@xxxxxxxxx";
name="<vvv@xxxxxxxxx>">,<newline>
-Ken Weinert <htmlurl url="mailto:kenw@xxxxxxx"; name="<kenw@xxxxxxx>">
-
-<sect1>About this document
-<p>
+</para>
+
+<para>
+Vikas Agnihotri <ulink
+URL="mailto:vikasa@xxxxxxxxxxx";
+><vikasa@xxxxxxxxxxx></ulink
+>,
+
+Francois Berjon <ulink
+URL="mailto:Francois.Berjon@xxxxxxxxxxxxxxxxxxxxxx";
+><Francois.Berjon@xxxxxxxxxxxxxxxxxxxxxx></ulink
+>,
+
+Aric Blumer <ulink
+URL="mailto:aric@xxxxxxxx";
+><aric@xxxxxxxx></ulink
+>,
+
+John Capo <ulink
+URL="mailto:jc@xxxxxxxx";
+><jc@xxxxxxxx></ulink
+>,
+
+David Champion <ulink
+URL="mailto:dgc@xxxxxxxxxxxx";
+><dgc@xxxxxxxxxxxx</ulink
+>,
+
+Brendan Cully <ulink
+URL="mailto:brendan@xxxxxxxxxx";
+><brendan@xxxxxxxxxx></ulink
+>,
+
+Liviu Daia <ulink
+URL="mailto:daia@xxxxxxxxxxxxxxx";
+><daia@xxxxxxxxxxxxxxx></ulink
+>,
+
+Thomas E. Dickey <ulink
+URL="mailto:dickey@xxxxxxxxxxxxxxxx";
+><dickey@xxxxxxxxxxxxxxxx></ulink
+>,
+
+David DeSimone <ulink
+URL="mailto:fox@xxxxxxxxxxxxx";
+><fox@xxxxxxxxxxxxx></ulink
+>,
+
+Nickolay N. Dudorov <ulink
+URL="mailto:nnd@xxxxxxxxxxxxxxxx";
+><nnd@xxxxxxxxxxxxxxxx></ulink
+>,
+
+Ruslan Ermilov <ulink
+URL="mailto:ru@xxxxxxxxxxx";
+><ru@xxxxxxxxxxx></ulink
+>,
+
+Edmund Grimley Evans <ulink
+URL="mailto:edmundo@xxxxxxxx";
+><edmundo@xxxxxxxx</ulink
+>,
+
+Michael Finken <ulink
+URL="mailto:finken@xxxxxxxxxx";
+><finken@xxxxxxxxxx></ulink
+>,
+
+Sven Guckes <ulink
+URL="mailto:guckes@xxxxxxxxxxxxxxxxx";
+><guckes@xxxxxxxxxxxxxxxxx></ulink
+>,
+
+Lars Hecking <ulink
+URL="mailto:lhecking@xxxxxxx";
+><lhecking@xxxxxxx></ulink
+>,
+
+Mark Holloman <ulink
+URL="mailto:holloman@xxxxxxxxx";
+><holloman@xxxxxxxxx></ulink
+>,
+
+Andreas Holzmann <ulink
+URL="mailto:holzmann@xxxxxxxxxxxxxxxxx";
+><holzmann@xxxxxxxxxxxxxxxxx></ulink
+>,
+
+Marco d'Itri <ulink
+URL="mailto:md@xxxxxxxx";
+><md@xxxxxxxx></ulink
+>,
+
+Björn Jacke <ulink
+URL="mailto:bjacke@xxxxxxxx";
+><bjacke@xxxxxxxx></ulink
+>,
+
+Byrial Jensen <ulink
+URL="mailto:byrial@xxxxxxxx";
+><byrial@xxxxxxxx></ulink
+>,
+
+David Jeske <ulink
+URL="mailto:jeske@xxxxxxxxx";
+><jeske@xxxxxxxxx></ulink
+>,
+
+Christophe Kalt <ulink
+URL="mailto:kalt@xxxxxxxxxxxxxxxx";
+><kalt@xxxxxxxxxxxxxxxx></ulink
+>,
+
+Tommi Komulainen <ulink
+URL="mailto:Tommi.Komulainen@xxxxxx";
+><Tommi.Komulainen@xxxxxx></ulink
+>,
+
+Felix von Leitner (a.k.a ``Fefe'') <ulink
+URL="mailto:leitner@xxxxxxxxxxxxxxxxx";
+><leitner@xxxxxxxxxxxxxxxxx></ulink
+>,
+
+Brandon Long <ulink
+URL="mailto:blong@xxxxxxxxxxx";
+><blong@xxxxxxxxxxx></ulink
+>,
+
+Jimmy Mäkelä <ulink
+URL="mailto:jmy@xxxxxxxxxxxxx";
+><jmy@xxxxxxxxxxxxx></ulink
+>,
+
+Lars Marowsky-Bree <ulink
+URL="mailto:lmb@xxxxxxxxxxxxxxxxxxxx";
+><lmb@xxxxxxxxxxxxxxxxxxxx></ulink
+>,
+
+Thomas ``Mike'' Michlmayr <ulink
+URL="mailto:mike@xxxxxxxxxxxxxx";
+><mike@xxxxxxxxxxxxxx></ulink
+>,
+
+Andrew W. Nosenko <ulink
+URL="mailto:awn@xxxxxxxxx";
+><awn@xxxxxxxxx></ulink
+>,
+
+David O'Brien <ulink
+URL="mailto:obrien@xxxxxxxxxxxxxxxxxxx";
+><obrien@xxxxxxxxxxxxxxxxxxx></ulink
+>,
+
+Clint Olsen <ulink
+URL="mailto:olsenc@xxxxxxxxxxxxxxxx";
+><olsenc@xxxxxxxxxxxxxxxx></ulink
+>,
+
+Park Myeong Seok <ulink
+URL="mailto:pms@xxxxxxxxxxxxxxxxxxx";
+><pms@xxxxxxxxxxxxxxxxxxx></ulink
+>,
+
+Thomas Parmelan <ulink
+URL="mailto:tom@xxxxxxxxxxxxxx";
+><tom@xxxxxxxxxxxxxx></ulink
+>,
+
+Ollivier Robert <ulink
+URL="mailto:roberto@xxxxxxxxxxxxxxxxx";
+><roberto@xxxxxxxxxxxxxxxxx></ulink
+>,
+
+Thomas Roessler <ulink
+URL="mailto:roessler@xxxxxxxxxxxxxxxxxx";
+><roessler@xxxxxxxxxxxxxxxxxx></ulink
+>,
+
+Roland Rosenfeld <ulink
+URL="roland@xxxxxxxxxxxx"
+><roland@xxxxxxxxxxxx></ulink
+>,
+
+TAKIZAWA Takashi <ulink
+URL="taki@xxxxxxxxxxxxxxxx"
+><taki@xxxxxxxxxxxxxxxx></ulink
+>,
+
+Allain Thivillon <ulink
+URL="mailto:Allain.Thivillon@xxxxxxx";
+><Allain.Thivillon@xxxxxxx></ulink
+>,
+
+Gero Treuner <ulink
+URL="mailto:gero@xxxxxxxxxxxxxxxxxxxxxxx";
+><gero@xxxxxxxxxxxxxxxxxxxxxxx></ulink
+>,
+
+Vsevolod Volkov <ulink
+URL="mailto:vvv@xxxxxxxxx";
+><vvv@xxxxxxxxx></ulink
+>,
+
+Ken Weinert <ulink
+URL="mailto:kenw@xxxxxxx";
+><kenw@xxxxxxx></ulink
+>
+</para>
+
+</sect2>
+
+<sect2>
+<title>About this document</title>
+
+<para>
This document was written in SGML, and then rendered using the
-<htmlurl url="http://www.sgmltools.org/"; name="sgml-tools"> package.
+<ulink
+URL="http://www.sgmltools.org/";
+>sgml-tools</ulink
+> package.
+</para>
+
+</sect2>
+
+</sect1>
</article>
diff -r e1ed910b6103 init.h
--- a/init.h Sat Jul 30 11:42:36 2005
+++ b/init.h Fri Jul 29 23:04:50 2005
@@ -1057,7 +1057,7 @@
** \fBDON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE
** DOING!\fP
*/
-#if USE_HCACHE
+#ifdef USE_HCACHE
{ "header_cache", DT_PATH, R_NONE, UL &HeaderCache, 0 },
/*
** .pp
diff -r e1ed910b6103 makedoc.c
--- a/makedoc.c Sat Jul 30 11:42:36 2005
+++ b/makedoc.c Fri Jul 29 23:04:50 2005
@@ -22,7 +22,7 @@
**
** -> a commented muttrc configuration file
** -> nroff, suitable for inclusion in a manual page
- ** -> linuxdoc-sgml, suitable for inclusion in the
+ ** -> docbook-xml, suitable for inclusion in the
** SGML-based manual
**
**/
@@ -72,6 +72,8 @@
#define D_INIT (1 << 5)
#define D_DL (1 << 6)
#define D_DT (1 << 7)
+#define D_DD (1 << 8)
+#define D_PA (1 << 9)
enum
{
@@ -80,13 +82,16 @@
SP_END_FT,
SP_NEWLINE,
SP_NEWPAR,
+ SP_END_PAR,
SP_STR,
SP_START_TAB,
SP_END_TAB,
SP_START_DL,
SP_DT,
SP_DD,
+ SP_END_DD,
SP_END_DL,
+ SP_END_SECT,
SP_REFER
};
@@ -107,6 +112,7 @@
static void pretty_default (char *, size_t, const char *, int);
static int sgml_fputc (int, FILE *);
static int sgml_fputs (const char *, FILE *);
+static int sgml_id_fputs (const char *, FILE *);
int main (int argc, char *argv[])
{
@@ -594,7 +600,7 @@
case '%': return fputs ("%", out);
case '&': return fputs ("&", out);
case '\\': return fputs ("\", out);
- case '"': return fputs ("&dquot;", out);
+ case '"': return fputs (""", out);
case '[': return fputs ("[", out);
case ']': return fputs ("]", out);
case '~': return fputs ("˜", out);
@@ -608,6 +614,25 @@
if (sgml_fputc ((unsigned int) *s, out) == EOF)
return EOF;
+ return 0;
+}
+
+/* reduce CDATA to ID */
+static int sgml_id_fputs (const char *s, FILE* out)
+{
+ char id;
+
+ for (; *s; s++)
+ {
+ if (*s == '_')
+ id = '-';
+ else
+ id = *s;
+
+ if (fputc ((unsigned int) id, out) == EOF)
+ return EOF;
+ }
+
return 0;
}
@@ -667,18 +692,20 @@
/* SGML based manual */
case F_SGML:
{
- fputs ("\n<sect2>", out); sgml_fputs (varname, out);
- fprintf (out, "<label id=\"%s\">", varname);
- fprintf (out, "\n<p>\nType: %s<newline>", type2human (type));
+ fputs ("\n<sect3 id=\"", out);
+ sgml_id_fputs(varname, out);
+ fputs ("\">\n<title>", out);
+ sgml_fputs (varname, out);
+ fprintf (out, "</title>\n<para>\nType: %s", type2human (type));
if (type == DT_STR || type == DT_RX || type == DT_ADDR || type ==
DT_PATH)
{
- fputs ("\nDefault: &dquot;", out);
+ fputs ("\nDefault: "", out);
sgml_print_strval (val, out);
- fputs ("&dquot;\n", out);
+ fputs (""\n</para>\n", out);
}
else
- fprintf (out, "\nDefault: %s\n", val);
+ fprintf (out, "\nDefault: %s\n</para>\n", val);
break;
}
/* make gcc happy */
@@ -728,6 +755,9 @@
exit (1);
}
+ if (docstat & (D_PA))
+ docstat = print_it (SP_END_PAR, NULL, out, docstat);
+
if (docstat & (D_TAB))
docstat = print_it (SP_END_TAB, NULL, out, docstat);
@@ -736,6 +766,8 @@
if (docstat & (D_EM | D_BF))
docstat = print_it (SP_END_FT, NULL, out, docstat);
+
+ docstat = print_it (SP_END_SECT, NULL, out, docstat);
docstat = print_it (SP_NEWLINE, NULL, out, 0);
@@ -971,21 +1003,21 @@
{
case SP_END_FT:
{
- if (docstat & D_EM) fputs ("</em>", out);
- if (docstat & D_BF) fputs ("</bf>", out);
+ if (docstat & D_EM) fputs ("</emphasis>", out);
+ if (docstat & D_BF) fputs ("</emphasis>", out);
docstat &= ~(D_EM|D_BF);
break;
}
case SP_START_BF:
{
- fputs ("<bf>", out);
+ fputs ("<emphasis remap=\"bf\">", out);
docstat |= D_BF;
docstat &= ~D_EM;
break;
}
case SP_START_EM:
{
- fputs ("<em>", out);
+ fputs ("<emphasis>", out);
docstat |= D_EM;
docstat &= ~D_BF;
break;
@@ -1011,46 +1043,68 @@
if (!(onl & D_NL))
fputc ('\n', out);
- fputs ("<p>\n", out);
+ if (docstat & D_PA)
+ fputs("</para>\n", out);
+ fputs ("<para>\n", out);
docstat |= D_NP;
- break;
- }
+ docstat |= D_PA;
+
+ break;
+ }
+ case SP_END_PAR:
+ {
+ fputs ("</para>\n", out);
+ docstat &= ~D_PA;
+ break;
+ }
case SP_START_TAB:
{
- fputs ("\n<tscreen><verb>\n", out);
+ fputs ("\n<screen>\n", out);
docstat |= D_TAB | D_NL;
break;
}
case SP_END_TAB:
{
- fputs ("\n</verb></tscreen>", out);
+ fputs ("\n</screen>", out);
docstat &= ~D_TAB;
docstat |= D_NL;
break;
}
case SP_START_DL:
{
- fputs ("\n<descrip>\n", out);
+ fputs ("\n<variablelist>\n", out);
docstat |= D_DL;
break;
}
case SP_DT:
{
- fputs ("<tag>", out);
+ fputs ("<varlistentry><term>", out);
break;
}
case SP_DD:
{
- fputs ("</tag>", out);
- break;
- }
+ docstat |= D_DD;
+ fputs ("</term>\n<listitem><para>", out);
+ break;
+ }
+ case SP_END_DD:
+ {
+ docstat &= ~D_DD;
+ fputs ("</para></listitem></varlistentry>\n", out);
+ break;
+ }
case SP_END_DL:
{
- fputs ("</descrip>\n", out);
- docstat &= ~D_DL;
- break;
- }
+ fputs ("</para></listitem></varlistentry></variablelist>\n", out);
+ docstat &= ~(D_DD|D_DL);
+ break;
+ }
+ case SP_END_SECT:
+ {
+ fputs ("</sect3>", out);
+ break;
+ }
case SP_STR:
{
if (docstat & D_TAB)
@@ -1082,11 +1136,9 @@
break;
case F_SGML:
- fprintf (out, "<ref id=\"%s\" name=\"", ref);
- if (output_dollar)
- fputs ("$", out);
- sgml_fputs (ref, out);
- fputs ("\">", out);
+ fputs ("<xref linkend=\"", out);
+ sgml_id_fputs (ref, out);
+ fputs ("\"/>", out);
break;
default:
@@ -1160,6 +1212,11 @@
}
else if (!strncmp (s, ".dt", 3))
{
+ if (docstat & D_DD)
+ {
+ docstat = commit_buff (buff, &d, out, docstat);
+ docstat = print_it (SP_END_DD, NULL, out, docstat);
+ }
docstat = commit_buff (buff, &d, out, docstat);
docstat = print_it (SP_DT, NULL, out, docstat);
s += 3;
Attachment:
pgpsAckEnB0OZ.pgp
Description: PGP signature