-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<?xml version="1.0" encoding="utf-8"?>
+<!-- THIS FILE IST NOT VALID DOCBOOK ! DTD REMOVED -->
+<!-- Please don't use html entities like [, ] ^ -->
+<!-- etc. they don't work with xml! -->
+<book xmlns:muttng-doc="http://mutt-ng.berlios.de/doc/#NS">
-<book>
-
-<bookinfo>
+<bookinfo> <!--{{{-->
<title>The Mutt Next Generation E-Mail Client</title>
<author>
<firstname>Andreas</firstname><surname>Krennmair</surname>
<firstname>Michael</firstname><surname>Elkins</surname>
<email>me@cs.hmc.edu</email>
</author>
- <pubdate>version devel-r473</pubdate>
+ <pubdate>version @VERSION@</pubdate>
<abstract>
<para>
Michael Elinks on mutt, circa 1995:
Sven Guckes on mutt, ca. 2003: ``But it still sucks!''
</para>
</abstract>
-</bookinfo>
+</bookinfo> <!--}}}-->
-<chapter> <!--{{{-->
- <title>Introduction </title>
-
- <sect1>
- <title>Overview </title>
+<chapter id="introduction"> <!--{{{-->
+ <title>Introduction</title>
+
+ <sect1 id="overview">
+ <title>Overview</title>
<para>
<emphasis role="bold">Mutt-ng</emphasis> is a small but very
</sect1>
- <sect1>
- <title>Mutt-ng Home Page </title>
+ <sect1 id="homepage">
+ <title>Mutt-ng Home Page</title>
<para>
- <ulink url="http://www.muttng.org/">http://www.muttng.org</ulink>
+ <muttng-doc:web url="http://www.muttng.org/"/>
</para>
<para>
</sect1>
- <sect1>
- <title>Mailing Lists </title>
+ <sect1 id="mailinglists">
+ <title>Mailing Lists</title>
<para>
</sect1>
- <sect1>
- <title>Software Distribution Sites </title>
+ <sect1 id="distrib-sites">
+ <title>Software Distribution Sites</title>
<para>
So far, there are no official releases of Mutt-ng, but you can
- download daily snapshots from <ulink
- url="http://mutt-ng.berlios.de/snapshots/"
- >http://mutt-ng.berlios.de/snapshots/</ulink>
+ download daily snapshots from <muttng-doc:web url="http://mutt-ng.berlios.de/snapshots/"/>
</para>
<para>
</sect1>
- <sect1>
- <title>IRC </title>
+ <sect1 id="irc">
+ <title>IRC</title>
<para>
Visit channel <emphasis>#muttng</emphasis> on <ulink
</sect1>
- <sect1>
- <title>Weblog </title>
+ <sect1 id="weblog">
+ <title>Weblog</title>
<para>
If you want to read fresh news about the latest development in
</sect1>
- <sect1>
- <title>Copyright </title>
+ <sect1 id="copyright">
+ <title>Copyright</title>
<para>
Mutt is Copyright (C) 1996-2000 Michael R. Elkins
<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.
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
</para>
</sect1>
-
+
+ <sect1 id="conventions">
+ <title>Manual Conventions</title>
+
+ <para>
+ This manual contains several (hopefully consistent) conventions to
+ specially layout different items in different fashions.
+ </para>
+
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>Configuration and environment variables will be printed
+ in a typewriter font and both prefixed with a dollar sign as
+ it's common for UNIX-like environments. Configuration
+ variables are lower-case only while environment variables
+ are upper-case only. <muttng-doc:varref
+ name="imap-mail-check"/> is a configuration variable while
+ <muttng-doc:envvar name="EDITOR"/> is an environment
+ variable.</para>
+ </listitem>
+ <listitem>
+ <para>Muttng-specific functions are enclosed in
+ <literal><></literal> and printed in a typewriter font,
+ too, as in <muttng-doc:funcref name="sync-mailbox"/>.</para>
+ </listitem>
+ <listitem>
+ <para>As common for UNIX-like environments, references to
+ manual pages are printed with the section enclosed in
+ braces, as in <muttng-doc:man name="vi"/> or <muttng-doc:man
+ name="muttngrc" sect="5"/>. Execute <literal>man [section]
+ [name]</literal> to view the manual page.</para>
+ </listitem>
+ <listitem>
+ <para>Keys are presented in the following way: ordinary keys
+ are just given as-is, e.g.
+ <muttng-doc:key>q</muttng-doc:key>. Control characters are
+ prefixed with <literal>C-</literal> (e.g. the screen can be
+ redraw by pressing <muttng-doc:key
+ mod="C">L</muttng-doc:key>) and <literal>E-</literal> for
+ Escape, e.g. a folder can be opened read-only with
+ <muttng-doc:key mod="E">c</muttng-doc:key>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ If, while reading this fine manual, you find any inconsistencies
+ of whatever kind, please contact the developers via
+ <email>mutt-ng-devel@lists.berlios.de</email> to report it.
+ </para>
+
+ </sect1>
+
</chapter>
- <!--}}}-->
+<!--}}}-->
-<chapter>
- <title>Getting Started </title>
+<chapter id="getting-started"> <!--{{{-->
+ <title>Getting Started</title>
- <sect1> <!--{{{-->
- <title>Basic Concepts </title>
+ <sect1 id="basic-concepts"> <!--{{{-->
+ <title>Basic Concepts</title>
- <sect2> <!--{{{-->
- <title>Screens and Menus </title>
+ <sect2 id="concept-screens-and-menus"> <!--{{{-->
+ <title>Screens and Menus</title>
<para>
mutt-ng offers different screens of which every has its special
</sect2>
<!--}}}-->
- <sect2> <!--{{{-->
- <title>Configuration </title>
+ <sect2 id="concept-configuration"> <!--{{{-->
+ <title>Configuration</title>
<para>
Mutt-ng does <emphasis>not</emphasis> feature an internal
</sect2>
<!--}}}-->
- <sect2> <!--{{{-->
- <title>Functions </title>
+ <sect2 id="concept-functions"> <!--{{{-->
+ <title>Functions</title>
<para>
Mutt-ng offers great flexibility due to the use of functions:
</sect2>
<!--}}}-->
- <sect2> <!--{{{-->
- <title>Interaction </title>
+ <sect2 id="concept-interaction"> <!--{{{-->
+ <title>Interaction</title>
<para>
Mutt-ng has two basic concepts of user interaction:
</sect2>
<!--}}}-->
- <sect2> <!--{{{-->
- <title>Modularization </title>
+ <sect2 id="concept-modularization"> <!--{{{-->
+ <title>Modularization</title>
<para>
Although mutt-ng has many functionality built-in, many
</sect2>
<!--}}}-->
- <sect2> <!--{{{-->
- <title>Patterns </title>
+ <sect2 id="concept-patterns"> <!--{{{-->
+ <title>Patterns</title>
<para>
Mutt-ng has a built-in pattern matching ``language'' which is
<!--}}}-->
- <sect1> <!--{{{-->
- <title>Screens and Menus </title>
+ <sect1 id="screens-and-menus"> <!--{{{-->
+ <title>Screens and Menus</title>
- <sect2>
- <title>Index </title>
+ <sect2 id="intro-index">
+ <title>Index</title>
<para>
The index is the screen that you usually see first when you
</sect2>
- <sect2>
- <title>Pager </title>
+ <sect2 id="intro-pager">
+ <title>Pager</title>
<para>
The pager is responsible for showing the email content. On the
</sect2>
- <sect2>
- <title>File Browser </title>
+ <sect2 id="intro-browser">
+ <title>File Browser</title>
<para>
The file browser is the interface to the local or remote
</sect2>
- <sect2>
- <title>Sidebar </title>
+ <sect2 id="intro-sidebar">
+ <title>Sidebar</title>
<para>
The sidebar comes in handy to manage mails which are spread
</sect2>
- <sect2>
- <title>Help </title>
+ <sect2 id="intro-help">
+ <title>Help</title>
<para>
The help screen is meant to offer a quick help to the user. It
</sect2>
- <sect2>
- <title>Compose Menu </title>
+ <sect2 id="intro-compose">
+ <title>Compose Menu</title>
<para>
The compose menu features a split screen containing the
</sect2>
- <sect2>
- <title>Alias Menu </title>
+ <sect2 id="intro-alias">
+ <title>Alias Menu</title>
<para>
The alias menu is used to help users finding the recipients
</sect2>
- <sect2>
- <title>Attachment Menu </title>
+ <sect2 id="intro-attach">
+ <title>Attachment Menu</title>
<para>
As will be later discussed in detail, mutt-ng features a good
</sect2>
- <sect2>
- <title>Key Menu </title>
+ <sect2 id="intro-keysel">
+ <title>Key Menu</title>
<para>
<literal>FIXME</literal>
</sect1>
<!--}}}-->
- <sect1> <!--{{{-->
- <title>Moving Around in Menus </title>
+ <sect1 id="moving"> <!--{{{-->
+ <title>Moving Around in Menus</title>
<para>
Information is presented in menus, very similar to ELM. Here is a
<para>
- <table>
- <title>Default Menu Movement Keys</title>
+ <table frame="none" rowsep="1" texstr="l|l|l">
+ <title>Most commonly used movement bindings</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
<row>
</thead>
<tbody>
<row>
- <entry><code>j</code> or <code>Down</code></entry>
- <entry><code>next-entry</code></entry>
+ <entry><muttng-doc:key>j</muttng-doc:key> or <muttng-doc:key>Down</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="next-entry"/></entry>
<entry>move to the next entry</entry>
</row>
<row>
- <entry><code>k</code> or <code>Up</code></entry>
- <entry><code>previous-entry</code></entry>
+ <entry><muttng-doc:key>k</muttng-doc:key> or <muttng-doc:key>Up</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="previous-entry"/></entry>
<entry>move to the previous entry</entry>
</row>
<row>
- <entry><code>z</code> or <code>PageDn</code></entry>
- <entry><code>page-down</code></entry>
+ <entry><muttng-doc:key>z</muttng-doc:key> or <muttng-doc:key>PageDn</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="page-down"/></entry>
<entry>go to the next page</entry>
</row>
<row>
- <entry><code>Z</code> or <code>PageUp</code></entry>
- <entry><code>page-up</code></entry>
+ <entry><muttng-doc:key>Z</muttng-doc:key> or <muttng-doc:key>PageUp</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="page-up"/></entry>
<entry>go to the previous page</entry>
</row>
<row>
- <entry><code>=</code> or <code>Home</code></entry>
- <entry><code>first-entry</code></entry>
+ <entry><muttng-doc:key>=</muttng-doc:key> or <muttng-doc:key>Home</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="first-entry"/></entry>
<entry>jump to the first entry</entry>
</row>
<row>
- <entry><code>*</code> or <code>End</code></entry>
- <entry><code>last-entry</code></entry>
+ <entry><muttng-doc:key>*</muttng-doc:key> or <muttng-doc:key>End</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="last-entry"/></entry>
<entry>jump to the last entry</entry>
</row>
<row>
- <entry><code>q</code></entry>
- <entry><code>quit</code></entry>
+ <entry><muttng-doc:key>q</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="quit"/></entry>
<entry>exit the current menu</entry>
</row>
<row>
- <entry><code>?</code></entry>
- <entry><code>help</code></entry>
+ <entry><muttng-doc:key>?</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="help"/></entry>
<entry>list all key bindings for the current menu</entry>
</row>
</tbody>
<!--}}}-->
<sect1 id="editing"> <!--{{{-->
- <title>Editing Input Fields </title>
+ <title>Editing Input Fields</title>
<para>
Mutt-ng has a builtin line editor which is used as the primary way to
<para>
- <table>
- <title>Built-In Editor Functions</title>
+ <table frame="none" rowsep="1" texstr="l|l|l">
+ <title>Line Editor Functions</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
<row>
</thead>
<tbody>
<row>
- <entry><code>^A or <Home> </code></entry>
- <entry><code>bol </code></entry>
+ <entry><muttng-doc:key mod="C">A</muttng-doc:key> or <muttng-doc:key>Home</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="bol"/></entry>
<entry>move to the start of the line</entry>
</row>
<row>
- <entry><code>^B or <Left> </code></entry>
- <entry><code>backward-char </code>
+ <entry><muttng-doc:key mod="C">B</muttng-doc:key> or <muttng-doc:key>Left</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="backward-char"/>
</entry><entry>move back one char</entry>
</row>
<row>
- <entry><code>Esc B </code></entry>
- <entry><code>backward-word </code></entry>
+ <entry><muttng-doc:key mod="E">B</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="backward-word"/></entry>
<entry>move back one word</entry>
</row>
<row>
- <entry><code>^D or <Delete> </code></entry>
- <entry><code>delete-char </code></entry>
+ <entry><muttng-doc:key mod="C">D</muttng-doc:key> or <muttng-doc:key>Delete</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="delete-char"/></entry>
<entry>delete the char under the cursor</entry>
</row>
<row>
- <entry><code>^E or <End> </code></entry>
- <entry><code>eol </code></entry>
+ <entry><muttng-doc:key mod="C">E</muttng-doc:key> or <muttng-doc:key>End</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="eol"/></entry>
<entry>move to the end of the line</entry>
</row>
<row>
- <entry><code>^F or <Right> </code></entry>
- <entry><code>forward-char </code></entry>
+ <entry><muttng-doc:key mod="C">F</muttng-doc:key> or <muttng-doc:key>Right</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="forward-char"/></entry>
<entry>move forward one char</entry>
</row>
<row>
- <entry><code>Esc F </code></entry>
- <entry><code>forward-word </code></entry>
+ <entry><muttng-doc:key mod="E">F</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="forward-word"/></entry>
<entry>move forward one word</entry>
</row>
<row>
- <entry><code><Tab> </code></entry>
- <entry><code>complete </code></entry>
+ <entry><muttng-doc:key>Tab</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="complete"/></entry>
<entry>complete filename or alias</entry>
</row>
<row>
- <entry><code>^T </code></entry>
- <entry><code>complete-query </code></entry>
+ <entry><muttng-doc:key mod="C">T</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="complete-query"/></entry>
<entry>complete address with query</entry>
</row>
<row>
- <entry><code>^K </code></entry>
- <entry><code>kill-eol </code></entry>
+ <entry><muttng-doc:key mod="C">K</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="kill-eol"/></entry>
<entry>delete to the end of the line</entry>
</row>
<row>
- <entry><code>ESC d </code></entry>
- <entry><code>kill-eow </code></entry>
+ <entry><muttng-doc:key mod="E">d</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="kill-eow"/></entry>
<entry>delete to the end of the word</entry>
</row>
<row>
- <entry><code>^W </code></entry>
- <entry><code>kill-word </code></entry>
+ <entry><muttng-doc:key mod="C">W</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="kill-word"/></entry>
<entry>kill the word in front of the cursor</entry>
</row>
<row>
- <entry><code>^U </code></entry>
- <entry><code>kill-line </code></entry>
+ <entry><muttng-doc:key mod="C">U</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="kill-line"/></entry>
<entry>delete entire line</entry>
</row>
<row>
- <entry><code>^V </code></entry>
- <entry><code>quote-char </code></entry>
+ <entry><muttng-doc:key mod="C">V</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="quote-char"/></entry>
<entry>quote the next typed key</entry>
</row>
<row>
- <entry><code><Up> </code></entry>
- <entry><code>history-up </code></entry>
+ <entry><muttng-doc:key>Up</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="history-up"/></entry>
<entry>recall previous string from history</entry>
</row>
<row>
- <entry><code><Down> </code></entry>
- <entry><code>history-down </code></entry>
+ <entry><muttng-doc:key>Down</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="history-down"/></entry>
<entry>recall next string from history</entry>
</row>
<row>
- <entry><code><BackSpace> </code></entry>
- <entry><code>backspace </code></entry>
+ <entry><muttng-doc:key>BackSpace</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="backspace"/></entry>
<entry>kill the char in front of the cursor</entry>
</row>
<row>
- <entry><code>Esc u </code></entry>
- <entry><code>upcase-word </code></entry>
+ <entry><muttng-doc:key mod="E">u</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="upcase-word"/></entry>
<entry>convert word to upper case</entry>
</row>
<row>
- <entry><code>Esc l </code></entry>
- <entry><code>downcase-word </code></entry>
+ <entry><muttng-doc:key mod="E">l</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="downcase-word"/></entry>
<entry>convert word to lower case</entry>
</row>
<row>
- <entry><code>Esc c </code></entry>
- <entry><code>capitalize-word </code></entry>
+ <entry><muttng-doc:key mod="E">c</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="capitalize-word"/></entry>
<entry>capitalize the word</entry>
</row>
<row>
- <entry><code>^G </code></entry>
- <entry><code>n/a </code></entry>
+ <entry><muttng-doc:key mod="C">G</muttng-doc:key></entry>
+ <entry></entry>
<entry>abort</entry>
</row>
<row>
- <entry><code><Return> </code></entry>
- <entry><code>n/a </code></entry>
+ <entry><muttng-doc:key>Return</muttng-doc:key></entry>
+ <entry></entry>
<entry>finish editing</entry>
</row>
</tbody>
</para>
<para>
- You can remap the <emphasis>editor</emphasis> functions using the <link linkend="bind">
- bind
- </link>
- command. For example, to make the <emphasis>Delete</emphasis> key
- delete the character in
- front of the cursor rather than under, you could use
+ You can remap the <emphasis>editor</emphasis> functions using the
+ <muttng-doc:cmdref name="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
</para>
<para>
<literal>bind editor <delete> backspace</literal>
</para>
- <para>
-
- </para>
-
</sect1>
<!--}}}-->
- <sect1>
- <title>Reading Mail - The Index and Pager </title> <!--{{{-->
+ <sect1 id="reading"> <!--{{{-->
+ <title>Reading Mail - The Index and Pager</title>
<para>
Similar to many other mail clients, there are two modes in which mail
modes.
</para>
- <sect2>
- <title>The Message Index</title> <!--{{{-->
+ <sect2 id="reading-index">
+ <title>The Message Index</title>
<para>
- <table>
- <title>Default Index Menu Bindings</title>
+ <table frame="none" rowsep="1" texstr="l|l|l">
+ <title>Most commonly used Index Bindings</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
<row>
</row>
</thead>
<tbody>
- <row><entry><code>c </code></entry><entry><code></code></entry><entry>change to a different mailbox</entry></row>
- <row><entry><code>ESC c </code></entry><entry><code></code></entry><entry>change to a folder in read-only mode</entry></row>
- <row><entry><code>C </code></entry><entry><code></code></entry><entry>copy the current message to another mailbox</entry></row>
- <row><entry><code>ESC C </code></entry><entry><code></code></entry><entry>decode a message and copy it to a folder</entry></row>
- <row><entry><code>ESC s </code></entry><entry><code></code></entry><entry>decode a message and save it to a folder</entry></row>
- <row><entry><code>D </code></entry><entry><code></code></entry><entry>delete messages matching a pattern</entry></row>
- <row><entry><code>d </code></entry><entry><code></code></entry><entry>delete the current message</entry></row>
- <row><entry><code>F </code></entry><entry><code></code></entry><entry>mark as important</entry></row>
- <row><entry><code>l </code></entry><entry><code></code></entry><entry>show messages matching a pattern</entry></row>
- <row><entry><code>N </code></entry><entry><code></code></entry><entry>mark message as new</entry></row>
- <row><entry><code>o </code></entry><entry><code></code></entry><entry>change the current sort method</entry></row>
- <row><entry><code>O </code></entry><entry><code></code></entry><entry>reverse sort the mailbox</entry></row>
- <row><entry><code>q </code></entry><entry><code></code></entry><entry>save changes and exit</entry></row>
- <row><entry><code>s </code></entry><entry><code></code></entry><entry>save-message</entry></row>
- <row><entry><code>T </code></entry><entry><code></code></entry><entry>tag messages matching a pattern</entry></row>
- <row><entry><code>t </code></entry><entry><code></code></entry><entry>toggle the tag on a message</entry></row>
- <row><entry><code>ESC t </code></entry><entry><code></code></entry><entry>toggle tag on entire message thread</entry></row>
- <row><entry><code>U </code></entry><entry><code></code></entry><entry>undelete messages matching a pattern</entry></row>
- <row><entry><code>u </code></entry><entry><code></code></entry><entry>undelete-message</entry></row>
- <row><entry><code>v </code></entry><entry><code></code></entry><entry>view-attachments</entry></row>
- <row><entry><code>x </code></entry><entry><code></code></entry><entry>abort changes and exit</entry></row>
- <row><entry><code><Return> </code></entry><entry><code></code></entry><entry>display-message</entry></row>
- <row><entry><code><Tab> </code></entry><entry><code></code></entry><entry>jump to the next new message</entry></row>
- <row><entry><code>@ </code></entry><entry><code></code></entry><entry>show the author's full e-mail address</entry></row>
- <row><entry><code>$ </code></entry><entry><code></code></entry><entry>save changes to mailbox</entry></row>
- <row><entry><code>/ </code></entry><entry><code></code></entry><entry>search</entry></row>
- <row><entry><code>ESC / </code></entry><entry><code></code></entry><entry>search-reverse</entry></row>
- <row><entry><code>^L </code></entry><entry><code></code></entry><entry>clear and redraw the screen</entry></row>
- <row><entry><code>^T </code></entry><entry><code></code></entry><entry>untag messages matching a pattern</entry></row>
+ <row>
+ <entry><muttng-doc:key>c</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>change to a different mailbox</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">c</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>change to a folder in read-only mode</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>C</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>copy the current message to another mailbox</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">C</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>decode a message and copy it to a folder</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">s</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>decode a message and save it to a folder</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>D</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>delete messages matching a pattern</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>d</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>delete the current message</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>F</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>mark as important</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>l</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>show messages matching a pattern</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>N</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>mark message as new</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>o</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>change the current sort method</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>O</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>reverse sort the mailbox</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>q</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>save changes and exit</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>s</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>save-message</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>T</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>tag messages matching a pattern</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>t</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>toggle the tag on a message</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">t</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>toggle tag on entire message thread</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>U</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>undelete messages matching a pattern</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>u</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>undelete-message</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>v</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>view-attachments</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>x</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>abort changes and exit</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>Return</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>display-message</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>Tab</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>jump to the next new or unread message</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>@</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>show the author's full e-mail address</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>$</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>save changes to mailbox</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>/</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>search</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">/</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>search-reverse</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="C">L</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>clear and redraw the screen</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="C">T</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>untag messages matching a pattern</entry>
+ </row>
</tbody>
</tgroup>
</table>
Furthermore, the following flags reflect who the message is
addressed
to. They can be customized with the
- <link linkend="to-chars">$to_chars</link> variable.
+ <muttng-doc:varref name="to-chars"/> variable.
</para>
<para>
</variablelist>
</para>
- <!--}}}-->
</sect3>
- <!--}}}-->
</sect2>
- <sect2>
- <title>The Pager</title> <!--{{{-->
+ <sect2 id="reading-pager">
+ <title>The Pager</title>
<para>
By default, Mutt-ng uses its builtin pager to display the body of
<para>
- <table>
- <title>Default Pager Menu Bindings</title>
+ <table frame="none" rowsep="1" texstr="l|l|l">
+ <title>Most commonly used Pager Bindings</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
<row>
</row>
</thead>
<tbody>
- <row><entry><code><Return> </code></entry><entry><code></code></entry><entry>go down one line</entry></row>
- <row><entry><code><Space> </code></entry><entry><code></code></entry><entry>display the next page (or next message if at the end of a message)</entry></row>
- <row><entry><code>- </code></entry><entry><code></code></entry><entry>go back to the previous page</entry></row>
- <row><entry><code>n </code></entry><entry><code></code></entry><entry>search for next match</entry></row>
- <row><entry><code>S </code></entry><entry><code></code></entry><entry>skip beyond quoted text</entry></row>
- <row><entry><code>T </code></entry><entry><code></code></entry><entry>toggle display of quoted text</entry></row>
- <row><entry><code>? </code></entry><entry><code></code></entry><entry>show key bindings</entry></row>
- <row><entry><code>/ </code></entry><entry><code></code></entry><entry>search for a regular expression (pattern)</entry></row>
- <row><entry><code>ESC / </code></entry><entry><code></code></entry><entry>search backwards for a regular expression</entry></row>
- <row><entry><code>\ </code></entry><entry><code></code></entry><entry>toggle search pattern coloring</entry></row>
- <row><entry><code>^ </code></entry><entry><code></code></entry><entry>jump to the top of the message</entry></row>
+ <row>
+ <entry><muttng-doc:key>Return</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>go down one line</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>Space</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>display the next page (or next message if at the end of a message)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>-</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>go back to the previous page</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>n</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>search for next match</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>S</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>skip beyond quoted text</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>T</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>toggle display of quoted text</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>?</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>show key bindings</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>/</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>search for a regular expression (pattern)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">/</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>search backwards for a regular expression</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>\</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>toggle search pattern coloring</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>^</muttng-doc:key></entry>
+ <entry><literal></literal></entry>
+ <entry>jump to the top of the message</entry>
+ </row>
</tbody>
</tgroup>
</table>
</para>
<para>
- Also, the internal pager supports a couple other advanced features.
- For
- one, it will accept and translate the ``standard'' nroff sequences
- forbold and underline. These sequences are a series of either the
- letter,
- backspace (ˆH), the letter again for bold or the letter,
- backspace,
- ``_'' for denoting underline. Mutt-ng will attempt to display
- these
- in bold and underline respectively if your terminal supports them. If
- not, you can use the bold and underline <link
-linkend="color">color</link>
- objects to specify a color or mono attribute for them.
+ Also, the internal pager supports a couple other advanced
+ features. For one, it will accept and translate the
+ ``standard'' nroff sequences forbold and underline. These
+ sequences are a series of either the letter, backspace
+ (<muttng-doc:key mod="C">H</muttng-doc:key>), the letter again for bold
+ or the letter, backspace, <muttng-doc:key>_</muttng-doc:key> for denoting
+ underline. Mutt-ng will attempt to display these in bold and
+ underline respectively if your terminal supports them. If not,
+ you can use the bold and underline <muttng-doc:cmdref
+ name="color"/> objects to specify a color or mono attribute
+ for them.
</para>
<para>
into the correct color and character settings. The sequences
Mutt-ng supports are: <literal>ESC [ Ps;Ps;Ps;...;Ps
m</literal> (see table below for possible values for
- <code>Ps</code>).
+ <literal>Ps</literal>).
</para>
<para>
- <table>
+ <table frame="none" rowsep="1" texstr="l|l">
<title>ANSI Escape Sequences</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
</row>
</thead>
<tbody>
- <row><entry><code>0 </code></entry><entry>All Attributes Off</entry></row>
- <row><entry><code>1 </code></entry><entry>Bold on</entry></row>
- <row><entry><code>4 </code></entry><entry>Underline on</entry></row>
- <row><entry><code>5 </code></entry><entry>Blink on</entry></row>
- <row><entry><code>7 </code></entry><entry>Reverse video on</entry></row>
- <row><entry><code>3x </code></entry><entry>Foreground color is x (see table below)</entry></row>
- <row><entry><code>4x </code></entry><entry>Background color is x (see table below)</entry></row>
+ <row>
+ <entry><literal>0</literal></entry>
+ <entry>All Attributes Off</entry>
+ </row>
+ <row>
+ <entry><literal>1</literal></entry>
+ <entry>Bold on</entry>
+ </row>
+ <row>
+ <entry><literal>4</literal></entry>
+ <entry>Underline on</entry>
+ </row>
+ <row>
+ <entry><literal>5</literal></entry>
+ <entry>Blink on</entry>
+ </row>
+ <row>
+ <entry><literal>7</literal></entry>
+ <entry>Reverse video on</entry>
+ </row>
+ <row>
+ <entry><literal>3x</literal></entry>
+ <entry>Foreground color is x (see table below)</entry>
+ </row>
+ <row>
+ <entry><literal>4x</literal></entry>
+ <entry>Background color is x (see table below)</entry>
+ </row>
</tbody>
</tgroup>
</table>
- <table>
+ <table frame="none" rowsep="1" texstr="l|l">
<title>ANSI Colors</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
</row>
</thead>
<tbody>
- <row><entry><code>0 </code></entry><entry>black</entry></row>
- <row><entry><code>1 </code></entry><entry>red</entry></row>
- <row><entry><code>2 </code></entry><entry>green</entry></row>
- <row><entry><code>3 </code></entry><entry>yellow</entry></row>
- <row><entry><code>4 </code></entry><entry>blue</entry></row>
- <row><entry><code>5 </code></entry><entry>magenta</entry></row>
- <row><entry><code>6 </code></entry><entry>cyan</entry></row>
- <row><entry><code>7 </code></entry><entry>white</entry></row>
+ <row>
+ <entry><literal>0</literal></entry>
+ <entry>black</entry>
+ </row>
+ <row>
+ <entry><literal>1</literal></entry>
+ <entry>red</entry>
+ </row>
+ <row>
+ <entry><literal>2</literal></entry>
+ <entry>green</entry>
+ </row>
+ <row>
+ <entry><literal>3</literal></entry>
+ <entry>yellow</entry>
+ </row>
+ <row>
+ <entry><literal>4</literal></entry>
+ <entry>blue</entry>
+ </row>
+ <row>
+ <entry><literal>5</literal></entry>
+ <entry>magenta</entry>
+ </row>
+ <row>
+ <entry><literal>6</literal></entry>
+ <entry>cyan</entry>
+ </row>
+ <row>
+ <entry><literal>7</literal></entry>
+ <entry>white</entry>
+ </row>
</tbody>
</tgroup>
</table>
<para>
Mutt-ng uses these attributes for handling text/enriched messages,
and they
- can also be used by an external <link
- linkend="auto-view">autoview</link>
+ can also be used by an external <muttng-doc:cmdref name="auto_view"/>
script for highlighting purposes. <emphasis role="bold">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.
</para>
- <!--}}}-->
</sect2>
<sect2 id="threads">
- <title>Threaded Mode</title> <!--{{{-->
+ <title>Threaded Mode</title>
<para>
When the mailbox is <link linkend="sort">sorted</link> by <emphasis>
<para>
- <table>
- <title>Default Thread Function Bindings</title>
+ <table frame="none" rowsep="1" texstr="l|l|l">
+ <title>Most commonly used thread-related bindings</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
<row>
</row>
</thead>
<tbody>
- <row><entry><code>^D </code></entry><entry><code>delete-thread </code></entry><entry>delete all messages in the current thread</entry></row>
- <row><entry><code>^U </code></entry><entry><code>undelete-thread </code></entry><entry>undelete all messages in the current thread</entry></row>
- <row><entry><code>^N </code></entry><entry><code>next-thread </code></entry><entry>jump to the start of the next thread</entry></row>
- <row><entry><code>^P </code></entry><entry><code>previous-thread </code></entry><entry>jump to the start of the previous thread</entry></row>
- <row><entry><code>^R </code></entry><entry><code>read-thread </code></entry><entry>mark the current thread as read</entry></row>
- <row><entry><code>ESC d </code></entry><entry><code>delete-subthread </code></entry><entry>delete all messages in the current subthread</entry></row>
- <row><entry><code>ESC u </code></entry><entry><code>undelete-subthread </code></entry><entry>undelete all messages in the current subthread</entry></row>
- <row><entry><code>ESC n </code></entry><entry><code>next-subthread </code></entry><entry>jump to the start of the next subthread</entry></row>
- <row><entry><code>ESC p </code></entry><entry><code>previous-subthread </code></entry><entry>jump to the start of the previous subthread</entry></row>
- <row><entry><code>ESC r </code></entry><entry><code>read-subthread </code></entry><entry>mark the current subthread as read </entry></row>
- <row><entry><code>ESC t </code></entry><entry><code>tag-thread </code></entry><entry>toggle the tag on the current thread</entry></row>
- <row><entry><code>ESC v </code></entry><entry><code>collapse-thread </code></entry><entry>toggle collapse for the current thread</entry></row>
- <row><entry><code>ESC V </code></entry><entry><code>collapse-all </code></entry><entry>toggle collapse for all threads</entry></row>
- <row><entry><code>P </code></entry><entry><code>parent-message </code></entry><entry>jump to parent message in thread</entry></row>
+ <row>
+ <entry><muttng-doc:key mod="C">D</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="delete-thread"/></entry>
+ <entry>delete all messages in the current thread</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="C">U</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="undelete-thread"/></entry>
+ <entry>undelete all messages in the current thread</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="C">N</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="next-thread"/></entry>
+ <entry>jump to the start of the next thread</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="C">P</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="previous-thread"/></entry>
+ <entry>jump to the start of the previous thread</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="C">R</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="read-thread"/></entry>
+ <entry>mark the current thread as read</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">d</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="delete-subthread"/></entry>
+ <entry>delete all messages in the current subthread</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">u</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="undelete-subthread"/></entry>
+ <entry>undelete all messages in the current subthread</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">n</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="next-subthread"/></entry>
+ <entry>jump to the start of the next subthread</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">p</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="previous-subthread"/></entry>
+ <entry>jump to the start of the previous subthread</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">r</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="read-subthread"/></entry>
+ <entry>mark the current subthread as read </entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">t</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="tag-thread"/></entry>
+ <entry>toggle the tag on the current thread</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">v</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="collapse-thread"/></entry>
+ <entry>toggle collapse for the current thread</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">V</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="collapse-all"/></entry>
+ <entry>toggle collapse for all threads</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>P</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="parent-message"/></entry>
+ <entry>jump to parent message in thread</entry>
+ </row>
</tbody>
</tgroup>
</table>
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
- onthe screen. See %M in <link
- linkend="index-format">
- index-format
- </link>
- .
+ onthe screen. See <literal>%M</literal> in
+ <muttng-doc:varref name="index-format"/>.
+ </para>
+
+ <para>
For example, you could use
- "%?M?(#%03M)&(%4l)?" in <link linkend="index-format">
- index-format
- </link>
+ <literal>%?M?(#%03M)&(%4l)?</literal> in <muttng-doc:varref name="index-format"/>
to optionally
display the number of hidden messages if the thread is collapsed.
</para>
<para>
- See also: <link linkend="strict-threads">strict-threads</link>.
+ See also the <muttng-doc:varref name="strict-threads"/> variable.
</para>
- <!--}}}-->
</sect2>
- <sect2>
- <title>Miscellaneous Functions</title> <!--{{{-->
+ <sect2 id="pager-functions">
+ <title>Miscellaneous Functions</title>
<para>
- <emphasis role="bold">create-alias</emphasis><anchor id="create-alias"/>
- (default: a)
-
+ <muttng-doc:funcdef name="create-alias"><muttng-doc:key>a</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
Creates a new alias based upon the current message (or prompts for a
- new one). Once editing is complete, an <link linkend="alias">alias</link>
- command is added to the file specified by the <link linkend="alias-file">
- alias-file
- </link>
+ new one). Once editing is complete, an <muttng-doc:cmdref name="alias"/>
+ command is added to the file specified by the <muttng-doc:varref name="alias-file"/>
variable for future use. <emphasis role="bold">Note:</emphasis>
- Specifying an <link linkend="alias-file">alias-file</link>
- does not add the aliases specified there-in, you must also <link linkend="source">
- source
- </link>
+ Specifying an <muttng-doc:varref name="alias-file"/>
+ does not add the aliases specified there-in, you must also <muttng-doc:cmdref name="source"/>
the file.
</para>
<para>
- <emphasis role="bold">check-traditional-pgp</emphasis><anchor id="check-traditional-pgp"/>
- (default: ESC P)
-
+ <muttng-doc:funcdef name="check-traditional-pgp"><muttng-doc:key mod="E">P</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
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 <link linkend="edit-type">edit-type</link>
+ is similar to the <muttng-doc:funcref name="edit-type"/>
function's
effect.
</para>
<para>
- <emphasis role="bold">display-toggle-weed</emphasis><anchor id="display-toggle-weed"/>
- (default: h)
-
+ <muttng-doc:funcdef name="display-toggle-weed"><muttng-doc:key>h</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
- Toggles the weeding of message header fields specified by <link linkend="ignore">
- ignore
- </link>
+ Toggles the weeding of message header fields specified by <muttng-doc:cmdref name="ignore"/>
commands.
</para>
<para>
- <emphasis role="bold">edit</emphasis><anchor id="edit"/>
- (default: e)
-
+ <muttng-doc:funcdef name="edit"><muttng-doc:key>e</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
</para>
<para>
- <emphasis role="bold">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)
+ <muttng-doc:funcdef name="edit-type"/>
+ (default: <muttng-doc:key mod="C">E</muttng-doc:key> on the attachment menu, and in the pager and index
+ menus; <muttng-doc:key mod="C">T</muttng-doc:key> on the compose menu)
</para>
<para>
</para>
<para>
- Note that this command is also available on the <link linkend="compose-menu">
- compose-menu
- </link>
+ Note that this command is also available on the <link linkend="compose-menu">compose-menu</link>
.There, it's used to
fine-tune the properties of attachments you are going to send.
</para>
<para>
- <emphasis role="bold">enter-command</emphasis><anchor id="enter-command"/>
- (default: ``:'')
-
+ <muttng-doc:funcdef name="enter-command"><muttng-doc:key>:</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
a
configuration file. A common use is to check the settings of
variables, or
- in conjunction with <link linkend="macro">macro</link> to change
+ in conjunction with <muttng-doc:cmdref name="macro"/> to change
settings on the
fly.
</para>
<para>
- <emphasis role="bold">extract-keys</emphasis><anchor id="extract-keys"/>
- (default: ˆK)
-
+ <muttng-doc:funcdef name="extract-keys"><muttng-doc:key mod="C">K</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
</para>
<para>
- <emphasis role="bold">forget-passphrase</emphasis><anchor id="forget-passphrase"/>
- (default:
- ˆF)
-
+ <muttng-doc:funcdef name="forget-passphrase"><muttng-doc:key mod="C">F</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
</para>
<para>
- <emphasis role="bold">list-reply</emphasis><anchor id="func-list-reply"/>
- (default: L)
-
+ <muttng-doc:funcdef name="list-reply"><muttng-doc:key>L</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
Reply to the current or tagged message(s) by extracting any addresses
which
- match the regular expressions given by the <link linkend="lists">
- lists
- </link>
+ match the regular expressions given by the <muttng-doc:cmdref name="lists"/>
commands, but also honor any <literal>Mail-Followup-To</literal>
header(s) if the
- <link linkend="honor-followup-to">honor-followup-to</link>
+ <muttng-doc:varref name="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
</para>
<para>
- <emphasis role="bold">pipe-message</emphasis><anchor id="pipe-message"/>
- (default: |)
-
+ <muttng-doc:funcdef name="pipe-message" default="|"/>
</para>
<para>
Asks for an external Unix command and pipes the current or
- tagged message(s) to it. The variables <link linkend="pipe-decode">
- pipe-decode
- </link>
- ,<link linkend="pipe-split">pipe-split</link>, <link linkend="pipe-sep">
- pipe-sep
- </link>
- and <link linkend="wait-key">wait-key</link> control the exact
- behavior of this
- function.
+ tagged message(s) to it. The variables
+ <muttng-doc:varref name="pipe-decode"/>,
+ <muttng-doc:varref name="pipe-split"/>,
+ <muttng-doc:varref name="pipe-decode"/> and
+ <muttng-doc:varref name="wait-key"/>
+ control the exact behavior of this function.
</para>
<para>
- <emphasis role="bold">resend-message</emphasis><anchor id="resend-message"/>
- (default: ESC e)
-
+ <muttng-doc:funcdef name="resend-message"><muttng-doc:key mod="E">e</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
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 <link linkend="weed">weed</link>
+ included here depends on the value of the <muttng-doc:varref name="weed"/>
variable.
</para>
</para>
<para>
- <emphasis role="bold">shell-escape</emphasis><anchor id="shell-escape"/>
- (default: !)
-
+ <muttng-doc:funcdef name="shell-escape"><muttng-doc:key>!</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
- Asks for an external Unix command and executes it. The <link linkend="wait-key">
- wait-key
- </link>
+ Asks for an external Unix command and executes it. The
+ <muttng-doc:varref name="wait-key"/>
can be used to control
whether Mutt-ng will wait for a key to be pressed when the command
returns
</para>
<para>
- <emphasis role="bold">toggle-quoted</emphasis><anchor id="toggle-quoted"/>
- (default: T)
-
+ <muttng-doc:funcdef name="toggle-quoted"><muttng-doc:key>T</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
- The <emphasis>pager</emphasis> uses the <link linkend="quote-regexp">
- quote-regexp
- </link>
+ The <emphasis>pager</emphasis> uses the
+ <muttng-doc:varref name="quote-regexp"/>
variable to detect quoted text when
displaying the body of the message. This function toggles the
displayof the quoted material in the message. It is particularly
</para>
<para>
- <emphasis role="bold">skip-quoted</emphasis><anchor id="skip-quoted"/>
- (default: S)
-
+ <muttng-doc:funcdef name="skip-quoted"><muttng-doc:key>S</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
</para>
- <!--}}}-->
</sect2>
- <!--}}}-->
</sect1>
+ <!--}}}-->
- <sect1>
- <title>Sending Mail </title> <!--{{{-->
+ <sect1 id="sending"> <!--{{{-->
+ <title>Sending Mail</title>
<para>
The following bindings are available in the <emphasis>index</emphasis>
<para>
- <table>
- <title>Default Mail Composition Bindings</title>
+ <table frame="none" rowsep="1" texstr="l|l|l">
+ <title>Most commonly used Mail Composition Bindings</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
<row>
</row>
</thead>
<tbody>
- <row><entry><code>m </code></entry><entry><code>compose </code></entry><entry>compose a new message</entry></row>
- <row><entry><code>r </code></entry><entry><code>reply </code></entry><entry>reply to sender</entry></row>
- <row><entry><code>g </code></entry><entry><code>group-reply </code></entry><entry>reply to all recipients</entry></row>
- <row><entry><code>L </code></entry><entry><code>list-reply </code></entry><entry>reply to mailing list address</entry></row>
- <row><entry><code>f </code></entry><entry><code>forward </code></entry><entry>forward message</entry></row>
- <row><entry><code>b </code></entry><entry><code>bounce </code></entry><entry>bounce (remail) message</entry></row>
- <row><entry><code>ESC k </code></entry><entry><code>mail-key </code></entry><entry>mail a PGP public key to someone</entry></row>
+ <row>
+ <entry><muttng-doc:key>m</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="compose"/></entry>
+ <entry>compose a new message</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>r</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="reply"/></entry>
+ <entry>reply to sender</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>g</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="group-reply"/></entry>
+ <entry>reply to all recipients</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>L</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="list-reply"/></entry>
+ <entry>reply to mailing list address</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>f</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="forward"/></entry>
+ <entry>forward message</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>b</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="bounce"/></entry>
+ <entry>bounce (remail) message</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">k</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="mail-key"/></entry>
+ <entry>mail a PGP public key to someone</entry>
+ </row>
</tbody>
</tgroup>
</table>
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 <link linkend="forwarding-mail">
- forwarding-mail
- </link>
- .
+ in greater detail in the next chapter <link linkend="forwarding-mail">forwarding-mail</link>.
</para>
- <sect2>
- <title>Composing new messages </title> <!--{{{-->
+ <sect2 id="sending-compose">
+ <title>Composing new messages</title>
<para>
- When you want to send an email using mutt-ng, simply press <literal>m</literal> on
+ When you want to send an email using mutt-ng, simply press <muttng-doc:key>m</muttng-doc:key> on
your keyboard. Then, mutt-ng asks for the recipient via a prompt in
the last line:
</para>
<para>
- <screen>
-To:</screen>
+ <muttng-doc:lstmail>
+To:</muttng-doc:lstmail>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
set editor = "vim +/^$/ -c ':set tw=72'"
set editor = "nano"
-set editor = "emacs"</screen>
+set editor = "emacs"</muttng-doc:lstconf>
</para>
<para>
If you don't set your preferred editor in your configuration, mutt-ng
- first looks whether the environment variable <literal>$VISUAL</literal> is set, and if
+ first looks whether the environment variable <muttng-doc:envvar name="VISUAL"/> is set, and if
so, it takes its value as editor command. Otherwise, it has a look
- at <literal>$EDITOR</literal> and takes its value if it is set. If no
+ at <muttng-doc:envvar name="EDITOR"/> and takes its value if it is set. If no
editor command
- can be found, mutt-ng simply assumes <literal>vi</literal> to be the
+ can be found, mutt-ng simply assumes <muttng-doc:man name="vi"/> to be the
default editor,
since it's the most widespread editor in the Unix world and it's
pretty
</para>
<para>
- At this point, you can add more attachments, pressing <literal>a</literal>, you
- can edit the recipient addresses, pressing <literal>t</literal> for
+ At this point, you can add more attachments, pressing <muttng-doc:key>a</muttng-doc:key>, you
+ can edit the recipient addresses, pressing <muttng-doc:key>t</muttng-doc:key> for
the "To:" field,
- <literal>c</literal> for the "Cc:" field, and <literal>b</literal>
+ <muttng-doc:key>c</muttng-doc:key> for the "Cc:" field, and <muttng-doc:key>b</muttng-doc:key>
for the "Bcc: field. You can
- also edit the subject the subject by simply pressing <literal>s</literal> or the
- email message that you've entered before by pressing <literal>e</literal>. You will
+ also edit the subject the subject by simply pressing <muttng-doc:key>s</muttng-doc:key> or the
+ email message that you've entered before by pressing <muttng-doc:key>e</muttng-doc:key>. You will
then again return to the editor. You can even edit the sender, by
pressing
<literal><esc>f</literal>, but this shall only be used with
<para>
- <screen>
-set edit_headers</screen>
+ <muttng-doc:lstconf>
+set edit_headers</muttng-doc:lstconf>
</para>
<para>
- <table>
- <title>Default Compose Menu Bindings</title>
+ <table frame="none" rowsep="1" texstr="l|l|l">
+ <title>Most commonly used Compose Menu Bindings</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
<row>
</row>
</thead>
<tbody>
- <row><entry><code>a </code></entry><entry><code>attach-file </code></entry><entry>attach a file</entry></row>
- <row><entry><code>A </code></entry><entry><code>attach-message </code></entry><entry>attach message(s) to the message</entry></row>
- <row><entry><code>ESC k </code></entry><entry><code>attach-key </code></entry><entry>attach a PGP public key</entry></row>
- <row><entry><code>d </code></entry><entry><code>edit-description </code></entry><entry>edit description on attachment</entry></row>
- <row><entry><code>D </code></entry><entry><code>detach-file </code></entry><entry>detach a file</entry></row>
- <row><entry><code>t </code></entry><entry><code>edit-to </code></entry><entry>edit the To field</entry></row>
- <row><entry><code>ESC f </code></entry><entry><code>edit-from </code></entry><entry>edit the From field</entry></row>
- <row><entry><code>r </code></entry><entry><code>edit-reply-to </code></entry><entry>edit the Reply-To field</entry></row>
- <row><entry><code>c </code></entry><entry><code>edit-cc </code></entry><entry>edit the Cc field</entry></row>
- <row><entry><code>b </code></entry><entry><code>edit-bcc </code></entry><entry>edit the Bcc field</entry></row>
- <row><entry><code>y </code></entry><entry><code>send-message </code></entry><entry>send the message</entry></row>
- <row><entry><code>s </code></entry><entry><code>edit-subject </code></entry><entry>edit the Subject</entry></row>
- <row><entry><code>S </code></entry><entry><code>smime-menu </code></entry><entry>select S/MIME options</entry></row>
- <row><entry><code>f </code></entry><entry><code>edit-fcc </code></entry><entry>specify an ``Fcc'' mailbox</entry></row>
- <row><entry><code>p </code></entry><entry><code>pgp-menu </code></entry><entry>select PGP options</entry></row>
- <row><entry><code>P </code></entry><entry><code>postpone-message </code></entry><entry>postpone this message until later</entry></row>
- <row><entry><code>q </code></entry><entry><code>quit </code></entry><entry>quit (abort) sending the message</entry></row>
- <row><entry><code>w </code></entry><entry><code>write-fcc </code></entry><entry>write the message to a folder</entry></row>
- <row><entry><code>i </code></entry><entry><code>ispell </code></entry><entry>check spelling (if available on your system)</entry></row>
- <row><entry><code>^F </code></entry><entry><code>forget-passphrase </code></entry><entry>wipe passphrase(s) from memory</entry></row>
+ <row>
+ <entry><muttng-doc:key>a</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="attach-file"/></entry>
+ <entry>attach a file</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>A</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="attach-message"/></entry>
+ <entry>attach message(s) to the message</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">k</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="attach-key"/></entry>
+ <entry>attach a PGP public key</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>d</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="edit-description"/></entry>
+ <entry>edit description on attachment</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>D</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="detach-file"/></entry>
+ <entry>detach a file</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>t</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="edit-to"/></entry>
+ <entry>edit the To field</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="E">f</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="edit-from"/></entry>
+ <entry>edit the From field</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>r</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="edit-reply-to"/></entry>
+ <entry>edit the Reply-To field</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>c</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="edit-cc"/></entry>
+ <entry>edit the Cc field</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>b</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="edit-bcc"/></entry>
+ <entry>edit the Bcc field</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>y</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="send-message"/></entry>
+ <entry>send the message</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>s</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="edit-subject"/></entry>
+ <entry>edit the Subject</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>S</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="smime-menu"/></entry>
+ <entry>select S/MIME options</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>f</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="edit-fcc"/></entry>
+ <entry>specify an ``Fcc'' mailbox</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>p</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="pgp-menu"/></entry>
+ <entry>select PGP options</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>P</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="postpone-message"/></entry>
+ <entry>postpone this message until later</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>q</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="quit"/></entry>
+ <entry>quit (abort) sending the message</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>w</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="write-fcc"/></entry>
+ <entry>write the message to a folder</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key>i</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="ispell"/></entry>
+ <entry>check spelling (if available on your system)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:key mod="C">F</muttng-doc:key></entry>
+ <entry><muttng-doc:funcref name="forget-passphrase"/></entry>
+ <entry>wipe passphrase(s) from memory</entry>
+ </row>
</tbody>
</tgroup>
</table>
theywill be attached to the message you are sending. Note that
certainoperations like composing a new mail, replying, forwarding,
etc. are
- not permitted when you are in that folder. The %r in <link linkend="status-format">
- status-format
- </link>
+ not permitted when you are in that folder. The <literal>%r</literal>
+ in <muttng-doc:varref name="status-format"/>
will change to
a 'A' to indicate that you are in attach-message mode.
</para>
</para>
- <!--}}}-->
</sect2>
- <sect2>
- <title>Replying </title> <!--{{{-->
+ <sect2 id="sending-reply">
+ <title>Replying</title>
- <sect3>
- <title>Simple Replies </title> <!--{{{-->
+ <sect3 id="sending-simple-reply">
+ <title>Simple Replies</title>
<para>
When you want to reply to an email message, select it in the index
- menu and then press <literal>r</literal>. Mutt-ng's behaviour is
+ menu and then press <muttng-doc:key>r</muttng-doc:key>. Mutt-ng's behaviour is
then similar to the
behaviour when you compose a message: first, you will be asked for
the recipient, then for the subject, and then, mutt-ng will start
<para>
- <screen>
+ <muttng-doc:lstmail>
On Mon, Mar 07, 2005 at 05:02:12PM +0100, Michael Svensson wrote:
> Bill, can you please send last month's progress report to Mr.
> Morgan? We also urgently need the cost estimation for the new
> production server that we want to set up before our customer's
-> project will go live.</screen>
+> project will go live.</muttng-doc:lstmail>
</para>
<para>
The quote attribution is configurable, by default it is set to
- <screen>
-set attribution = "On %d, %n wrote:"</screen>
+ <muttng-doc:lstconf>
+set attribution = "On %d, %n wrote:"</muttng-doc:lstconf>
</para>
<para>
It can also be set to something more compact, e.g.
- <screen>
-set attribution = "attribution="* %n <%a> [%(%y-%m-%d %H:%M)]:"</screen>
+ <muttng-doc:lstconf>
+set attribution = "attribution="* %n <%a> [%(%y-%m-%d %H:%M)]:"</muttng-doc:lstconf>
</para>
<para>
The example above results in the following attribution:
- <screen>
+ <muttng-doc:lstmail>
* Michael Svensson <svensson@foobar.com> [05-03-06 17:02]:
> Bill, can you please send last month's progress report to Mr.
> Morgan? We also urgently need the cost estimation for the new
> production server that we want to set up before our customer's
-> project will go live.</screen>
+> project will go live.</muttng-doc:lstmail>
</para>
</para>
- <!--}}}-->
</sect3>
- <sect3>
- <title>Group Replies </title> <!--{{{-->
+ <sect3 id="sending-group-reply">
+ <title>Group Replies</title>
<para>
In the situation where a group of people uses email as a
discussion, most of the emails will have one or more recipients,
and probably several "Cc:" recipients. The group reply
- functionalityensures that when you press <literal>g</literal>
- instead of <literal>r</literal> to do a reply,
+ functionalityensures that when you press <muttng-doc:key>g</muttng-doc:key>
+ instead of <muttng-doc:key>r</muttng-doc:key> to do a reply,
each and every recipient that is contained in the original message
will receive a copy of the message, either as normal recipient or
as "Cc:" recipient.
</para>
- <!--}}}-->
</sect3>
- <sect3>
- <title>List Replies </title> <!--{{{-->
+ <sect3 id="sending-list-reply">
+ <title>List Replies</title>
<para>
When you use mailing lists, it's generally better to send your
</para>
<para>
- To do a list reply, simply press <literal>L</literal>. If the email
+ To do a list reply, simply press <muttng-doc:key>L</muttng-doc:key>. If the email
contains
a <literal>Mail-Followup-To:</literal> header, its value will be
used as reply
<para>
- <screen>
-lists linuxevent@luga\.at vuln-dev@ mutt-ng-users@</screen>
+ <muttng-doc:lstconf>
+lists linuxevent@luga\.at vuln-dev@ mutt-ng-users@</muttng-doc:lstconf>
</para>
</para>
- <!--}}}-->
</sect3>
- <!--}}}-->
</sect2>
- <sect2>
- <title>Editing the message header </title>
+ <sect2 id="sending-edit-header">
+ <title>Editing the message header</title>
<para>
When editing the header of your outgoing message, there are a couple
<para>
You can also attach files to your message by specifying
-
- <literal>Attach:</literal> <emphasis>filename</emphasis> [ <emphasis>
- description
- </emphasis>
- ]
-
+
+ <muttng-doc:lstmail>
+Attach: filename [description]</muttng-doc:lstmail>
+
where <emphasis>filename</emphasis> is the file to attach and <emphasis>
description
</emphasis>
</para>
<para>
- Also see <link linkend="edit-headers">edit-headers</link>.
+ Also see the <muttng-doc:varref name="edit-headers"/> and
+ <muttng-doc:varref name="editor-headers"/> variables
</para>
<para>
</sect2>
- <sect2>
- <title>Using Mutt-ng with PGP </title>
+ <sect2 id="sending-crypto">
+ <title>Using Mutt-ng with PGP</title>
<para>
If you want to use PGP, you can specify
- </para>
-
- <para>
- <literal>Pgp:</literal> [ <literal>E</literal> | <literal>
- S
- </literal>
- | <literal>S</literal><emphasis><id></emphasis> ]
-
- </para>
- <para>
+ <muttng-doc:lstmail>
+Pgp: [E | S | S id]</muttng-doc:lstmail>
+
``E'' encrypts, ``S'' signs and
- ``S<id>'' signs with the given key, setting <link linkend="pgp-sign-as">
- pgp-sign-as
- </link>
+ ``S<id>'' signs with the given key, setting
+ <muttng-doc:varref name="pgp-sign-as"/>
permanently.
</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 <literal>ˆG</literal>. When
+ usually, abort this prompt using <muttng-doc:key mod="C">G</muttng-doc:key>. When
you do so, mutt will
return to the compose screen.
</para>
</para>
<para>
- Most fields of the entries in the key selection menu (see also <link linkend="pgp-entry-format">
- pgp-entry-format
- </link>
- )
+ Most fields of the entries in the key selection menu (see also
+ <muttng-doc:varref name="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
+ The flags sequence (%f) will expand to one of the following
flags:
- <table>
+ <table frame="none" rowsep="1" texstr="l|l">
<title>PGP Key Menu Flags</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
</row>
</thead>
<tbody>
- <row><entry><code>R </code></entry><entry>The key has been revoked and can't be used.</entry></row>
- <row><entry><code>X </code></entry><entry>The key is expired and can't be used.</entry></row>
- <row><entry><code>d </code></entry><entry>You have marked the key as disabled.</entry></row>
- <row><entry><code>c </code></entry><entry>There are unknown critical self-signature packets.</entry></row>
+ <row>
+ <entry><literal>R</literal></entry>
+ <entry>The key has been revoked and can't be used.</entry>
+ </row>
+ <row>
+ <entry><literal>X</literal></entry>
+ <entry>The key is expired and can't be used.</entry>
+ </row>
+ <row>
+ <entry><literal>d</literal></entry>
+ <entry>You have marked the key as disabled.</entry>
+ </row>
+ <row>
+ <entry><literal>c</literal></entry>
+ <entry>There are unknown critical self-signature packets.</entry>
+ </row>
</tbody>
</tgroup>
</table>
</para>
<para>
- The capabilities field (%c) expands to a two-character
+ The capabilities field (%c) expands to a two-character
sequencerepresenting a key's capabilities. The first character gives
the key's encryption capabilities: A minus sign (<emphasis role="bold">
-
</para>
<para>
- Finally, the validity field (%t) indicates how well-certified
+ Finally, the validity field (%t) indicates how well-certified
a user-id
is. A question mark (<emphasis role="bold">?</emphasis>) indicates
undefined validity, a minus
</sect2>
- <sect2>
- <title>Sending anonymous messages via mixmaster </title>
+ <sect2 id="sending-mixmaster">
+ <title>Sending anonymous messages via mixmaster</title>
<para>
You may also have configured mutt to co-operate with Mixmaster, an
and
<literal>chain-next</literal> functions, which are by default bound
to the left
- and right arrows and to the <literal>h</literal> and <literal>l</literal> keys (think vi
+ and right arrows and to the <muttng-doc:key>h</muttng-doc:key> and <muttng-doc:key>l</muttng-doc:key> keys (think vi
keyboard bindings). To insert a remailer at the current chain
position, use the <literal>insert</literal> function. To append a
remailer behind
<para>
Note that different remailers do have different capabilities,
- indicated in the %c entry of the remailer menu lines (see
- <link linkend="mix-entry-format">mix-entry-format</link>). Most
- important is
+ indicated in the <literal>%c</literal> entry of the remailer menu lines (see
+ <muttng-doc:varref name="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
</sect1>
<sect1 id="forwarding-mail">
- <title>Forwarding and Bouncing Mail </title>
+ <title>Forwarding and Bouncing Mail</title>
<para>
Often, it is necessary to forward mails to other people.
<para>
The first one is regular forwarding, as you probably know it from
- other mail clients. You simply press <literal>f</literal>, enter the
+ other mail clients. You simply press <muttng-doc:key>f</muttng-doc:key>, enter the
recipient
email address, the subject of the forwarded email, and then you can
edit the message to be forwarded in the editor. The forwarded
<para>
- <screen>
------ Forwarded message from Lucas User <luser@example.com> -----
+ <muttng-doc:lstmail>
+----- Forwarded message from Lucas User <luser@example.com> -----
-From: Lucas User <luser@example.com>
+From: Lucas User <luser@example.com>
Date: Thu, 02 Dec 2004 03:08:34 +0100
-To: Michael Random <mrandom@example.com>
+To: Michael Random <mrandom@example.com>
Subject: Re: blackmail
Pay me EUR 50,000.- cash or your favorite stuffed animal will die
a horrible death.
------ End forwarded message -----</screen>
+----- End forwarded message -----</muttng-doc:lstmail>
</para>
another
address, it will be sent in practically the same format you send it
(except for headers that are created during transporting the
- message). To bounce a message, press <literal>b</literal> and enter the
+ message). To bounce a message, press <muttng-doc:key>b</muttng-doc:key> and enter the
recipient
email address. By default, you are then asked whether you really
want to bounce the message to the specified recipient. If you answer
</sect1>
<sect1 id="postponing-mail">
- <title>Postponing Mail </title>
+ <title>Postponing Mail</title>
<para>
At times it is desirable to delay sending a message that you have
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 <link linkend="postponed">
- postponed
- </link>
- variable. This means that you can recall the
+ are stored in the mailbox specified by the
+ <muttng-doc:varref name="postponed"/> variable. This means that you can recall the
message even if you exit Mutt-ng and then restart it at a later time.
</para>
</para>
<para>
- See also the <link linkend="postpone">postpone</link> quad-option.
+ See also the <muttng-doc:varref name="postpone"/> quad-option.
</para>
<para>
</para>
</sect1>
+
+ <!--}}}-->
- </chapter>
+</chapter>
+<!--}}}-->
- <chapter>
- <title>Configuration </title>
+<chapter id="configuration"> <!--{{{-->
+ <title>Configuration</title>
- <sect1>
- <title>Locations of Configuration Files </title>
+ <sect1 id="configuration-files">
+ <title>Locations of Configuration Files</title>
<para>
While the default configuration (or ``preferences'') make Mutt-ng
</sect1>
- <sect1 id="muttrc-syntax">
- <title>Basic Syntax of Initialization Files </title>
+ <sect1 id="configuration-syntax">
+ <title>Basic Syntax of Initialization Files</title>
<para>
- An initialization file consists of a series of <link linkend="commands">
- commands
- </link>
- .Each line of the file may contain one or more commands.
+ An initialization file consists of a series of <link linkend="commands">commands</link>. Each line of the file may contain one or more commands.
When multiple commands are used, they must be separated by a semicolon
(;).
- <screen>
-set realname='Mutt-ng user' ; ignore x-</screen>
+ <muttng-doc:lstconf>
+set realname='Mutt-ng user' ; ignore x-</muttng-doc:lstconf>
The hash mark, or pound sign
- (``#''), is used as a ``comment'' character. You can use it to
+ (``#''), 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,
</para>
<para>
- <screen>
-my_hdr X-Disclaimer: Why are you listening to me? # This is a comment</screen>
+ <muttng-doc:lstconf>
+my_hdr X-Disclaimer: Why are you listening to me? # This is a comment</muttng-doc:lstconf>
</para>
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
+ (see
+ next paragraph), while double quotes indicate a string for which
should be evaluated. For example, backtics are evaluated inside of
double
quotes, but <emphasis role="bold">not</emphasis> for single quotes.
</para>
<para>
- \ quotes the next character, just as in shells such as bash and
+ \ quotes the next character, just as in shells such as bash and
zsh.
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
+ ``\'' to force the next character to be a literal instead of
interpreted
character.
- <screen>
-set realname="Michael \"MuttDude\" Elkins"</screen>
+ <muttng-doc:lstconf>
+set realname="Michael \"MuttDude\" Elkins"</muttng-doc:lstconf>
</para>
<para>
- ``\\'' means to insert a literal ``\'' into the line.
- ``\n'' and ``\r'' have their usual C meanings of linefeed and
+ ``\\'' 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
+ 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>
Please note that, unlike the various shells, mutt-ng interprets a
- ``\''
+ ``\''
at the end of a line also in comments. This allows you to disable a
command
- split over multiple lines with only one ``#''.
+ split over multiple lines with only one ``#''.
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
# folder-hook . \
-set realname="Michael \"MuttDude\" Elkins"</screen>
+set realname="Michael \"MuttDude\" Elkins"</muttng-doc:lstconf>
</para>
at the end of the commented line extends the current line with the next
line
- then referred to as a ``continuation line''. As the first line is
- commented with a hash (#) all following continuation lines are also
+ commented with a hash (#) all following continuation lines are also
part of a comment and therefore are ignored, too. So take care of
comments
when continuation lines are involved within your setup files!
<para>
- <screen>
+ <muttng-doc:lstconf>
line1\
line2a # line2b\
line3\
line4
-line5</screen>
+line5</muttng-doc:lstconf>
</para>
<para>
- line1 ``continues'' until line4. however, the part after the # is a
+ line1 ``continues'' until line4. however, the part after the # is a
comment which includes line3 and line4. line5 is a new line of its own
and
thus is interpreted again.
</sect1>
- <sect1>
- <title>Expansion within variables </title>
+ <sect1 id="configuration-expansion">
+ <title>Expansion within variables</title>
<para>
Besides just assign static content to variables, there's plenty of
ways of adding external and more or less dynamic content.
</para>
- <sect2>
- <title>Commands' Output </title>
+ <sect2 id="configuration-expansion-commands">
+ <title>Commands' Output</title>
<para>
It is possible to substitute the output of a Unix command in an
<para>
- <screen>
-my_hdr X-Operating-System: `uname -a`</screen>
+ <muttng-doc:lstconf>
+my_hdr X-Operating-System: `uname -a`</muttng-doc:lstconf>
</para>
</sect2>
- <sect2>
- <title>Environment Variables </title>
+ <sect2 id="configuration-expansion-environment">
+ <title>Environment Variables</title>
<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
- ``$'' sign. For example,
+ ``$'' sign. For example,
</para>
<para>
- <screen>
-set record=+sent_on_$HOSTNAME</screen>
+ <muttng-doc:lstconf>
+set record=+sent_on_$HOSTNAME</muttng-doc:lstconf>
</para>
<para>
- sets the <link linkend="record">record</link> variable to the
- string <emphasis>+sent_on_</emphasis> and appends the
+ sets the <muttng-doc:varref name="record"/> variable to the
+ string <emphasis>+sent_on_</emphasis> and appends the
value of the evironment
- variable <literal>$HOSTNAME</literal>.
+ variable <muttng-doc:envvar name="HOSTNAME"/>.
</para>
<para>
</sect2>
- <sect2>
- <title>Configuration Variables </title>
+ <sect2 id="configuration-expansion-config">
+ <title>Configuration Variables</title>
<para>
As for environment variables, the values of all configuration
<para>
- <screen>
-set imap_home_namespace = $folder</screen>
+ <muttng-doc:lstconf>
+set imap_home_namespace = $folder</muttng-doc:lstconf>
</para>
<para>
- would set the value of <link linkend="imap-home-namespace">
- imap-home-namespace
- </link>
- to the value to
- which <link linkend="folder">folder</link> is <emphasis>currently</emphasis> set
- to.
+ would set the value of <muttng-doc:varref name="imap-home-namespace"/>
+ to the value to which <muttng-doc:varref name="folder"/>
+ is <emphasis>currently</emphasis> set to.
</para>
<para>
<emphasis role="bold">Note:</emphasis> There're no logical links
established in such cases so
- that the the value for <link linkend="imap-home-namespace">
- imap-home-namespace
- </link>
+ that the the value for <muttng-doc:varref name="imap-home-namespace"/>
won't change even
- if <link linkend="folder">folder</link> gets changed.
+ if <muttng-doc:varref name="folder"/> gets changed.
</para>
<para>
</sect2>
- <sect2>
- <title>Self-Defined Variables </title>
+ <sect2 id="configuration-expansion-self">
+ <title>Self-Defined Variables</title>
<para>
Mutt-ng flexibly allows users to define their own variables. To
avoid conflicts with the standard set and to prevent misleading
error messages, there's a reserved namespace for them: all
- user-defined variables must be prefixed with <literal>user_</literal> and can be
+ user-defined variables must be prefixed with <literal>user_</literal> and can be
used just like any ordinary configuration or environment
variable.
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
macro generic <F1> "!less -r /path/to/manual" "Show manual"
-macro pager <F1> "!less -r /path/to/manual" "Show manual"</screen>
+macro pager <F1> "!less -r /path/to/manual" "Show manual"</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
set user_manualcmd = "!less -r /path/to_manual"
macro generic <F1> "$user_manualcmd<enter>" "Show manual"
macro pager <F1> "$user_manualcmd<enter>" "Show manual"
-macro index <F1> "$user_manualcmd<enter>" "Show manual"</screen>
+macro index <F1> "$user_manualcmd<enter>" "Show manual"</muttng-doc:lstconf>
</para>
<para>
- <screen>
-macro index <F2> "$user_manualcmd | grep '\^[ ]\\+~. '" "Show Patterns"</screen>
+ <muttng-doc:lstconf>
+macro index <F2> "$user_manualcmd | grep '\^[ ]\\+~. '" "Show Patterns"</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
set user_foo = 42
-set user_foo = 666</screen>
+set user_foo = 666</muttng-doc:lstconf>
</para>
<para>
- the variable <literal>$user_foo</literal> has a current value
+ the variable <literal>$user_foo</literal> has a current value
of 666 and an
initial of 42. The query
</para>
<para>
- <screen>
-set ?user_foo</screen>
+ <muttng-doc:lstconf>
+set ?user_foo</muttng-doc:lstconf>
</para>
<para>
- <screen>
-reset user_foo</screen>
+ <muttng-doc:lstconf>
+reset user_foo</muttng-doc:lstconf>
</para>
<para>
- <screen>
-unset user_foo</screen>
+ <muttng-doc:lstconf>
+unset user_foo</muttng-doc:lstconf>
</para>
</sect2>
- <sect2>
- <title>Pre-Defined Variables </title>
+ <sect2 id="configuration-expansion-predef">
+ <title>Pre-Defined Variables</title>
<para>
In order to allow users to share one setup over a number of
different machines without having to change its contents, there's a
number of pre-defined variables. These are prefixed with
- <literal>muttng_</literal> and are read-only, i.e. they cannot
+ <literal>muttng_</literal> and are read-only, i.e. they cannot
be set, unset or
reset. The reference chapter lists all available variables.
</para>
<para>
- <screen>
-muttng -Q muttng_docdir</screen>
+ <muttng-doc:lstshell>
+$ muttng -Q muttng_docdir</muttng-doc:lstshell>
</para>
<para>
- <screen>
-set user_manualcmd = '!less -r /path/to_manual'</screen>
+ <muttng-doc:lstconf>
+set user_manualcmd = '!less -r /path/to_manual'</muttng-doc:lstconf>
</para>
<para>
- <screen>
-set user_manualcmd = "!less -r $muttng_docdir/manual.txt"</screen>
+ <muttng-doc:lstconf>
+set user_manualcmd = "!less -r $muttng_docdir/manual.txt"</muttng-doc:lstconf>
</para>
<para>
- <screen>
-folder-hook . "set user_current_folder = $muttng_folder_name"</screen>
+ <muttng-doc:lstconf>
+folder-hook . "set user_current_folder = $muttng_folder_name"</muttng-doc:lstconf>
</para>
<para>
- <screen>
-folder-hook . "set user_current_folder = some_folder"</screen>
+ <muttng-doc:lstconf>
+folder-hook . "set user_current_folder = some_folder"</muttng-doc:lstconf>
</para>
<para>
- with <literal>some_folder</literal> being the name of the
+ with <literal>some_folder</literal> being the name of the
first folder muttng
opens. On the contrary,
</para>
<para>
- <screen>
-folder-hook . 'set user_current_folder = $muttng_folder_name'</screen>
+ <muttng-doc:lstconf>
+folder-hook . 'set user_current_folder = $muttng_folder_name'</muttng-doc:lstconf>
</para>
<para>
will be executed at runtime because of the single quotes so that
- <literal>user_current_folder</literal> will always have
+ <literal>user_current_folder</literal> will always have
the value of the currently
opened folder.
</para>
<para>
- <screen>
-folder-hook . 'source ~/.mutt/score-$muttng_folder_name'</screen>
+ <muttng-doc:lstconf>
+folder-hook . 'source ~/.mutt/score-$muttng_folder_name'</muttng-doc:lstconf>
</para>
</sect2>
- <sect2>
- <title>Type Conversions </title>
+ <sect2 id="configuration-expansion-typeconv">
+ <title>Type Conversions</title>
<para>
A note about variable's types during conversion: internally
<para>
- <screen>
+ <muttng-doc:lstconf>
set read_inc = 100
set folder = $read_inc
set read_inc = $folder
set user_magic_number = 42
-set folder = $user_magic_number</screen>
+set folder = $user_magic_number</muttng-doc:lstconf>
</para>
</sect1>
- <sect1 id="alias">
- <title>Defining/Using aliases </title>
-
+ <sect1>
+ <title>Defining/Using aliases</title>
+
<para>
- Usage: <literal>alias</literal> <emphasis>key</emphasis> <emphasis>
- address
- </emphasis>
- [ , <emphasis>address</emphasis>, ... ]
+ <muttng-doc:cmddef name="alias">
+ key address [, address,...]
+ </muttng-doc:cmddef>
</para>
<para>
</para>
<para>
- <literal>unalias</literal> [ * | <emphasis>key</emphasis> <emphasis>
- ...
- </emphasis>
- ]
+ <muttng-doc:cmddef name="unalias">
+ [* | key ... ]
+ </muttng-doc:cmddef>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
alias muttdude me@cs.hmc.edu (Michael Elkins)
-alias theguys manny, moe, jack</screen>
+alias theguys manny, moe, jack</muttng-doc:lstconf>
</para>
Unlike other mailers, Mutt-ng doesn't require aliases to be defined
in a special file. The <literal>alias</literal> command can appear
anywhere in
- a configuration file, as long as this file is <link linkend="source">
- source
- </link>
- .Consequently, you can have multiple alias files, or
+ a configuration file, as long as this file is <muttng-doc:cmdref name="source"/>.
+ Consequently, you can have multiple alias files, or
you can have all aliases defined in your muttrc.
</para>
<para>
- On the other hand, the <link linkend="create-alias">create-alias</link>
- function can use only one file, the one pointed to by the <link linkend="alias-file">
- alias-file
- </link>
+ On the other hand, the <muttng-doc:funcref name="create-alias"/>
+ function can use only one file, the one pointed to by the
+ <muttng-doc:varref name="alias-file"/>
variable (which is
- <literal>˜/.muttrc</literal> by default). This file is not
+ <literal>~/.muttrc</literal> by default). This file is not
special either,
in the sense that Mutt-ng will happily append aliases to any file, but
in
- order for the new aliases to take effect you need to explicitly <link linkend="source">
- source
- </link>
+ order for the new aliases to take effect you need to explicitly <muttng-doc:cmdref name="source"/>
this file too.
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
source /usr/local/share/Mutt-ng.aliases
source ~/.mail_aliases
-set alias_file=~/.mail_aliases</screen>
+set alias_file=~/.mail_aliases</muttng-doc:lstconf>
</para>
prompt. You can
also enter aliases in your editor at the appropriate headers if you
have the
- <link linkend="edit-headers">edit-headers</link> variable set.
+ <muttng-doc:varref name="editor-headers"/>
+ variable set.
</para>
<para>
</sect1>
- <sect1 id="bind">
- <title>Changing the default key bindings </title>
+ <sect1>
+ <title>Changing the default key bindings</title>
<para>
- Usage: <literal>bind</literal> <emphasis>map</emphasis> <emphasis>key</emphasis> <emphasis>
- function
- </emphasis>
+ <muttng-doc:cmddef name="bind">
+ map key function
+ </muttng-doc:cmddef>
</para>
<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>,
+ 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 <emphasis>x</emphasis> as well as
- <emphasis>\C</emphasis> is
- ignored, so that <emphasis>\CA</emphasis>, <emphasis>\Ca</emphasis>, <emphasis>
- \cA
+ ``\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
+ 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 <emphasis>
- \177
+ octal number prefixed with a ``\'' (for example <emphasis>
+ \177
</emphasis>
is
- equivalent to <emphasis>\c?</emphasis>).
+ equivalent to <emphasis>\c?</emphasis>).
</para>
<para>
<para>
- <table>
+ <table frame="none" rowsep="1" texstr="l|l">
<title>Alternative Key Names</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
</row>
</thead>
<tbody>
- <row><entry><code>\t </code></entry><entry>tab</entry></row>
- <row><entry><code><tab> </code></entry><entry>tab</entry></row>
- <row><entry><code><backtab> </code></entry><entry>backtab / shift-tab</entry></row>
- <row><entry><code>\r </code></entry><entry>carriage return</entry></row>
- <row><entry><code>\n </code></entry><entry>newline</entry></row>
- <row><entry><code>\e </code></entry><entry>escape</entry></row>
- <row><entry><code><esc> </code></entry><entry>escape</entry></row>
- <row><entry><code><up> </code></entry><entry>up arrow</entry></row>
- <row><entry><code><down> </code></entry><entry>down arrow</entry></row>
- <row><entry><code><left> </code></entry><entry>left arrow</entry></row>
- <row><entry><code><right> </code></entry><entry>right arrow</entry></row>
- <row><entry><code><pageup> </code></entry><entry>Page Up</entry></row>
- <row><entry><code><pagedown> </code></entry><entry>Page Down</entry></row>
- <row><entry><code><backspace> </code></entry><entry>Backspace</entry></row>
- <row><entry><code><delete> </code></entry><entry>Delete</entry></row>
- <row><entry><code><insert> </code></entry><entry>Insert</entry></row>
- <row><entry><code><enter> </code></entry><entry>Enter</entry></row>
- <row><entry><code><return> </code></entry><entry>Return</entry></row>
- <row><entry><code><home> </code></entry><entry>Home</entry></row>
- <row><entry><code><end> </code></entry><entry>End</entry></row>
- <row><entry><code><space> </code></entry><entry>Space bar</entry></row>
- <row><entry><code><f1> </code></entry><entry>function key 1</entry></row>
- <row><entry><code><f10> </code></entry><entry>function key 10</entry></row>
+ <row>
+ <entry><literal>\t</literal></entry>
+ <entry>tab</entry>
+ </row>
+ <row>
+ <entry><literal><tab></literal></entry>
+ <entry>tab</entry>
+ </row>
+ <row>
+ <entry><literal><backtab></literal></entry>
+ <entry>backtab / shift-tab</entry>
+ </row>
+ <row>
+ <entry><literal>\r</literal></entry>
+ <entry>carriage return</entry>
+ </row>
+ <row>
+ <entry><literal>\n</literal></entry>
+ <entry>newline</entry>
+ </row>
+ <row>
+ <entry><literal>\e</literal></entry>
+ <entry>escape</entry>
+ </row>
+ <row>
+ <entry><literal><esc></literal></entry>
+ <entry>escape</entry>
+ </row>
+ <row>
+ <entry><literal><up></literal></entry>
+ <entry>up arrow</entry>
+ </row>
+ <row>
+ <entry><literal><down></literal></entry>
+ <entry>down arrow</entry>
+ </row>
+ <row>
+ <entry><literal><left></literal></entry>
+ <entry>left arrow</entry>
+ </row>
+ <row>
+ <entry><literal><right></literal></entry>
+ <entry>right arrow</entry>
+ </row>
+ <row>
+ <entry><literal><pageup></literal></entry>
+ <entry>Page Up</entry>
+ </row>
+ <row>
+ <entry><literal><pagedown></literal></entry>
+ <entry>Page Down</entry>
+ </row>
+ <row>
+ <entry><literal><backspace></literal></entry>
+ <entry>Backspace</entry>
+ </row>
+ <row>
+ <entry><literal><delete></literal></entry>
+ <entry>Delete</entry>
+ </row>
+ <row>
+ <entry><literal><insert></literal></entry>
+ <entry>Insert</entry>
+ </row>
+ <row>
+ <entry><literal><enter></literal></entry>
+ <entry>Enter</entry>
+ </row>
+ <row>
+ <entry><literal><return></literal></entry>
+ <entry>Return</entry>
+ </row>
+ <row>
+ <entry><literal><home></literal></entry>
+ <entry>Home</entry>
+ </row>
+ <row>
+ <entry><literal><end></literal></entry>
+ <entry>End</entry>
+ </row>
+ <row>
+ <entry><literal><space></literal></entry>
+ <entry>Space bar</entry>
+ </row>
+ <row>
+ <entry><literal><f1></literal></entry>
+ <entry>function key 1</entry>
+ </row>
+ <row>
+ <entry><literal><f10></literal></entry>
+ <entry>function key 10</entry>
+ </row>
</tbody>
</tgroup>
</table>
key
</emphasis>
is pressed.
- For a complete list of functions, see the <link linkend="functions">
- functions
- </link>
- .The special function <literal>noop</literal> unbinds the specified key
+ For a complete list of functions, see the <link linkend="functions">functions</link>.
+ The special function <literal>noop</literal> unbinds the specified key
sequence.
</para>
</sect1>
<sect1 id="charset-hook">
- <title>Defining aliases for character sets </title>
-
+ <title>Defining aliases for character sets</title>
+
+ <anchor id="iconv-hook"/>
<para>
- Usage: <literal>charset-hook</literal> <emphasis>alias</emphasis> <emphasis>
- charset
- </emphasis>
-
- Usage: <literal>iconv-hook</literal> <emphasis>charset</emphasis> <emphasis>
- local-charset
- </emphasis>
+ Usage: <muttng-doc:hook name="charset"/> <emphasis>alias</emphasis> <emphasis> charset</emphasis>
+ </para>
+ <para>
+ Usage: <muttng-doc:hook name="iconv"/> <emphasis>charset</emphasis> <emphasis> local-charset </emphasis>
</para>
<para>
- The <literal>charset-hook</literal> command defines an alias for a
+ The <muttng-doc:hook name="charset"/> 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.
</para>
<para>
- The <literal>iconv-hook</literal> command defines a system-specific
+ The <muttng-doc:hook name="iconv"/> 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
</sect1>
<sect1 id="folder-hook">
- <title>Setting variables based upon mailbox </title>
+ <title>Setting variables based upon mailbox</title>
<para>
- Usage: <literal>folder-hook</literal> [!]<emphasis>regexp</emphasis> <emphasis>
- command
- </emphasis>
+ Usage: <muttng-doc:hook name="folder"/> [!]<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
+ reading. The <muttng-doc:hook name="folder"/> command provides a method by which you can
execute
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
+ matches multiple <muttng-doc:hook name="folder"/>'s, they are executed in the order given in
the
muttrc.
</para>
<para>
<emphasis role="bold">Note:</emphasis> if you use the ``!'' shortcut
- for <link linkend="spoolfile">spoolfile</link> at the beginning of the
+ for <muttng-doc:varref name="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 <emphasis>not</emphasis> operator for the expression.
<para>
- <screen>
-folder-hook mutt set sort=threads</screen>
+ <muttng-doc:lstconf>
+folder-hook mutt set sort=threads</muttng-doc:lstconf>
</para>
<para>
- <screen>
-folder-hook . set sort=date-sent</screen>
+ <muttng-doc:lstconf>
+folder-hook . set sort=date-sent</muttng-doc:lstconf>
</para>
</sect1>
- <sect1 id="macro">
- <title>Keyboard macros </title>
+ <sect1>
+ <title>Keyboard macros</title>
<para>
- Usage: <literal>macro</literal> <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>
- sequence
- </emphasis>
- [ <emphasis>description</emphasis> ]
+ <muttng-doc:cmddef name="macro">
+ menu key sequence [description]
+ </muttng-doc:cmddef>
</para>
<para>
</para>
<para>
- <emphasis>key</emphasis> and <emphasis>sequence</emphasis> are expanded
- by the same rules as the <link linkend="bind">bind</link>. 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
+ <emphasis>key</emphasis> and <emphasis>sequence</emphasis> are
+ expanded by the same rules as the <muttng-doc:cmdref
+ name="bind"/>. There are some additions however. The first
+ is that control characters in <emphasis>sequence</emphasis> can
+ also be specified as <literal>^x</literal>. In order to get a
+ caret (`^'') you need to specify it twice. Secondly,
+ to specify a certain key such as <emphasis>up</emphasis> or to
+ invoke a function directly, you can use the format
<emphasis><key name></emphasis> and <emphasis><function
- name>
- </emphasis>
- .For a listing of key
- names see the section on <link linkend="bind">bind</link>. Functions
- are listed in the <link linkend="functions">functions</link>.
+ name> </emphasis> .For a listing of key names see the
+ section on <muttng-doc:cmdref name="bind"/>. Functions are
+ listed in the <link linkend="functions">functions</link>.
</para>
<para>
</sect1>
- <sect1 id="color">
- <title>Using color and mono video attributes </title>
-
+ <sect1>
+ <title>Using color and mono video attributes</title>
+
<para>
- Usage: <literal>color</literal> <emphasis>object</emphasis> <emphasis>
- foreground
- </emphasis>
- <emphasis>background</emphasis> [ <emphasis>regexp</emphasis>
- ]
-
- Usage: <literal>color</literal> index <emphasis>foreground</emphasis> <emphasis>
- background
- </emphasis>
- <emphasis>pattern</emphasis>
-
- Usage: <literal>uncolor</literal> index <emphasis>pattern</emphasis>
- [ <emphasis>pattern</emphasis> ... ]
-
+ <muttng-doc:cmddef name="color">object foreground background [regexp]</muttng-doc:cmddef>
+ </para>
+ <para>
+ <muttng-doc:cmddef name="color" noanchor="1">index foreground pattern</muttng-doc:cmddef>
+ </para>
+ <para>
+ <muttng-doc:cmddef name="uncolor">index pattern [pattern ...]</muttng-doc:cmddef>
</para>
<para>
<listitem>
<para>
- quoted (text matching <link linkend="quote-regexp">quote-regexp</link> in the body of a message)
+ quoted (text matching <muttng-doc:varref name="quote-regexp"/> in the body of a message)
</para>
</listitem>
<listitem>
<listitem>
<para>
- tilde (the ``˜'' used to pad blank lines in the pager)
+ tilde (the ``~'' used to pad blank lines in the pager)
</para>
</listitem>
<listitem>
used as a transparent color. The value <emphasis>brightdefault</emphasis> is also valid.
If Mutt-ng is linked against the <emphasis>S-Lang</emphasis> library,
you also need to set
- the <emphasis>COLORFGBG</emphasis> environment variable to the default
+ the <muttng-doc:envvar name="COLORFGBG"/> environment variable to the default
colors of your
terminal for this to work; for example (for Bourne-like shells):
</para>
<para>
- <screen>
+ <muttng-doc:lstshell>
set COLORFGBG="green;black"
-export COLORFGBG</screen>
+export COLORFGBG</muttng-doc:lstshell>
</para>
Mutt-ng also recognizes the keywords <emphasis>color0</emphasis>, <emphasis>
color1
</emphasis>
- ,…,
+ ,...,
<emphasis>color</emphasis><emphasis role="bold">N-1</emphasis> (<emphasis role="bold">
N
</emphasis>
</para>
<para>
- Usage: <literal>mono</literal> <emphasis><object>
- <attribute>
- </emphasis>
- [ <emphasis>regexp</emphasis> ]
-
- Usage: <literal>mono</literal> index <emphasis>attribute</emphasis> <emphasis>
- pattern
- </emphasis>
-
- Usage: <literal>unmono</literal> index <emphasis>pattern</emphasis>
- [ <emphasis>pattern</emphasis> ... ]
-
+ <muttng-doc:cmddef name="mono">object attribute [regexp]</muttng-doc:cmddef>
+ </para>
+ <para>
+ <muttng-doc:cmddef name="mono" noanchor="1">index attribute pattern</muttng-doc:cmddef>
+ </para>
+ <para>
+ <muttng-doc:cmddef name="unmono">index pattern [pattern ...]</muttng-doc:cmddef>
</para>
<para>
</sect1>
- <sect1 id="ignore">
- <title>Ignoring (weeding) unwanted message headers </title>
-
+ <sect1>
+ <title>Ignoring (weeding) unwanted message headers</title>
+
<para>
- Usage: <literal>[un]ignore</literal> <emphasis>pattern</emphasis> [ <emphasis>
- pattern
- </emphasis>
- ... ]
+ <muttng-doc:cmddef name="ignore">pattern [pattern ...]</muttng-doc:cmddef>
</para>
-
+
+ <para>
+ <muttng-doc:cmddef name="unignore">pattern [pattern ...]</muttng-doc:cmddef>
+ </para>
+
<para>
Messages often have many header fields added by automatic processing
systems,
<para>
For example:
- <screen>
+ <muttng-doc:lstconf>
# 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:</screen>
+unignore posted-to:</muttng-doc:lstconf>
</para>
</sect1>
- <sect1 id="alternates">
- <title>Alternative addresses </title>
+ <sect1>
+ <title>Alternative addresses</title>
<para>
- Usage: <literal>[un]alternates</literal> <emphasis>regexp</emphasis> [ <emphasis>
- regexp
- </emphasis>
- ... ]
-
+ <muttng-doc:cmddef name="alternates">regexp [regexp ...]</muttng-doc:cmddef>
</para>
-
+
+ <para>
+ <muttng-doc:cmddef name="unalternates">regexp [regexp ...]</muttng-doc:cmddef>
+ </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 <link linkend="reply-to">
- reply-to
- </link>
- .)
+ the response to the original message's recipients--responding to
+ yourself won't make much sense in many cases.
+ (See <muttng-doc:varref name="reply-to"/>.)
</para>
<para>
</sect1>
- <sect1>
- <title>Format = Flowed </title>
+ <sect1 id="format-flowed">
+ <title>Format = Flowed</title>
- <sect2>
- <title>Introduction </title>
+ <sect2 id="format-flowed-intro">
+ <title>Introduction</title>
<para>
Mutt-ng contains support for so-called <literal>format=flowed</literal> messages.
<para>
For introductory information on <literal>format=flowed</literal>
messages, see
- <ulink URL="http://www.joeclark.org/ffaq.html"><http://www.joeclark.org/ffaq.html></ulink>.
+ <muttng-doc:web url="http://www.joeclark.org/ffaq.html"/>.
</para>
</sect2>
- <sect2>
- <title>Receiving: Display Setup </title>
+ <sect2 id="format-flowed-display">
+ <title>Receiving: Display Setup</title>
<para>
When you receive emails that are marked as <literal>format=flowed</literal>
<para>
- <screen>
-set wrapmargin = 10</screen>
+ <muttng-doc:lstconf>
+set wrapmargin = 10</muttng-doc:lstconf>
</para>
<para>
- <screen>
-set max_line_length = 120</screen>
+ <muttng-doc:lstconf>
+set max_line_length = 120</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstmail>
>Bill, can you please send last month's progress report to Mr.
>Morgan? We also urgently need the cost estimation for the new
>production server that we want to set up before our customer's
->project will go live.</screen>
+>project will go live.</muttng-doc:lstmail>
</para>
<para>
- <screen>
-set stuff_quoted</screen>
+ <muttng-doc:lstconf>
+set stuff_quoted</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstmail>
> Bill, can you please send last month's progress report to Mr.
> Morgan? We also urgently need the cost estimation for the new
> production server that we want to set up before our customer's
-> project will go live.</screen>
+> project will go live.</muttng-doc:lstmail>
</para>
</sect2>
- <sect2>
- <title>Sending </title>
+ <sect2 id="format-flowed-send">
+ <title>Sending</title>
<para>
If you want mutt-ng to send emails with <literal>format=flowed</literal> set, you
<para>
- <screen>
-set text_flowed</screen>
+ <muttng-doc:lstconf>
+set text_flowed</muttng-doc:lstconf>
</para>
<para>
Additionally, you have to use an editor which supports writing
- <literal>format=flowed</literal>-conforming emails. For vim, this is
+ <literal>format=flowed</literal>-conforming emails. For <muttng-doc:man name="vim"/>, this is
done by
adding <literal>w</literal> to the formatoptions (see <literal>:h
formatoptions
side, the first space (if any) is removed. As a consequence and in
addition to the above simple setting, please keep this in mind when
making manual formattings within the editor. Also note that mutt-ng
- currently violates the standard (RfC 3676) as it does not
+ currently violates the standard (<muttng-doc:rfc num="3676"/>) as it does not
space-stuff lines starting with:
</para>
<itemizedlist>
<listitem>
-
<para>
<literal>></literal> This is <emphasis>not</emphasis> the
quote character but a right
</para>
</listitem>
- <listitem>
-
- <para>
- <literal>From</literal> with a trailing space.
-
- </para>
- </listitem>
- <listitem>
-
- <para>
- just a space for formatting reasons
-
- </para>
- </listitem>
-
</itemizedlist>
</para>
</sect2>
- <sect2>
+ <sect2 id="format-flowed-notes">
<title>Additional Notes</title>
<para>
- For completeness, the <link linkend="delete-space">delete-space</link> variable provides the mechanism
+ For completeness, the <muttng-doc:varref name="delete-space"/> variable provides the mechanism
to generate a <literal>DelSp=yes</literal> parameter on <emphasis>
outgoing
</emphasis>
</sect1>
- <sect1 id="lists">
- <title>Mailing lists </title>
+ <sect1>
+ <title>Mailing lists</title>
<para>
- Usage: <literal>[un]lists</literal> <emphasis>regexp</emphasis> [ <emphasis>
- regexp
- </emphasis>
- ... ]
-
- Usage: <literal>[un]subscribe</literal> <emphasis>regexp</emphasis> [ <emphasis>
- regexp
- </emphasis>
- ... ]
+ <muttng-doc:cmddef name="lists">regexp [regexp ...]</muttng-doc:cmddef>
+ </para>
+ <para>
+ <muttng-doc:cmddef name="unlists">regexp [regexp ...]</muttng-doc:cmddef>
+ </para>
+ <para>
+ <muttng-doc:cmddef name="subscribe">regexp [regexp ...]</muttng-doc:cmddef>
+ </para>
+ <para>
+ <muttng-doc:cmddef name="unsubscribe">regexp [regexp ...]</muttng-doc:cmddef>
</para>
<para>
- Mutt-ng has a few nice features for <link linkend="using-lists">
- using-lists
- </link>
- .In order to take advantage of them, you must
+ Mutt-ng has a few nice features for <link linkend="using-lists">using-lists</link>.
+ 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 <link linkend="func-list-reply">
- list-reply
- </link>
+ lists you are subscribed to. Once you have done this, the
+ <link linkend="func-list-reply">list-reply</link>
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
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 <link linkend="followup-to">
- followup-to
- </link>
+ of the Mail-Followup-To header is controlled by the
+ <muttng-doc:varref name="followup-to"/>
configuration variable.
</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>
add ``subscribe mutt-users'' to your initialization file instead.
If you also happen to get mail from someone whose address is
<emphasis>mutt-users@example.com</emphasis>, you could use ``lists
- mutt-users@mutt\\.org''
- or ``subscribe mutt-users@mutt\\.org'' to
+ mutt-users@mutt\\.org''
+ or ``subscribe mutt-users@mutt\\.org'' to
match only mail from the actual list.
</para>
</sect1>
<sect1 id="mbox-hook">
- <title>Using Multiple spool mailboxes </title>
+ <title>Using Multiple spool mailboxes</title>
<para>
- Usage: <literal>mbox-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>
- mailbox
- </emphasis>
+ Usage: <muttng-doc:hook name="mbox"/> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
</para>
<para>
</sect1>
- <sect1 id="mailboxes">
- <title>Defining mailboxes which receive mail </title>
-
+ <sect1>
+ <title>Defining mailboxes which receive mail</title>
+
<para>
- Usage: <literal>[un]mailboxes</literal> [!]<emphasis>
- filename
- </emphasis>
- [ <emphasis>filename</emphasis> ... ]
+ <muttng-doc:cmddef name="mailboxes"> [!]filename [filename ... ]</muttng-doc:cmddef>
</para>
-
+ <para>
+ <muttng-doc:cmddef name="unmailboxes"> [!]filename [filename ... ]</muttng-doc:cmddef>
+ </para>
+
<para>
This command specifies folders which can receive mail and
which will be checked for new messages. By default, the
mailboxes
</literal>
command are resolved when
- the command is executed, so if these names contain <link linkend="shortcuts">
- shortcuts
- </link>
+ the command is executed, so if these names contain <link linkend="shortcuts">shortcuts</link>
(such as ``='' and ``!''), any variable
- definition that affect these characters (like <link linkend="folder">
- folder
- </link>
- and <link linkend="spoolfile">spoolfile</link>)
+ definition that affect these characters (like <muttng-doc:varref name="folder"/>
+ and <muttng-doc:varref name="spoolfile"/>)
should be executed before the <literal>mailboxes</literal> command.
</para>
</sect1>
- <sect1 id="my-hdr">
- <title>User defined headers </title>
+ <sect1>
+ <title>User defined headers</title>
<para>
- Usage:
-
- <literal>my_hdr</literal> <emphasis>string</emphasis>
-
- <literal>unmy_hdr</literal> <emphasis>field</emphasis> [ <emphasis>
- field
- </emphasis>
- ... ]
+ <muttng-doc:cmddef name="my_hdr">string</muttng-doc:cmddef>
+ </para>
+ <para>
+ <muttng-doc:cmddef name="unmy_hdr">field [field ...]</muttng-doc:cmddef>
</para>
<para>
- The ``my_hdr'' command allows you to create your own header
+ The ``my_hdr'' command allows you to create your own header
fields which will be added to every message you send.
</para>
</para>
<para>
- <screen>
-my_hdr Organization: A Really Big Company, Anytown, USA</screen>
+ <muttng-doc:lstconf>
+my_hdr Organization: A Really Big Company, Anytown, USA</muttng-doc:lstconf>
</para>
<para>
not
</emphasis>
allowed between the keyword and
- the colon (``:''). The standard for electronic mail (RFC822) says that
+ the colon (``:''). The standard for electronic mail (<muttng-doc:rfc num="822"/>) says that
space is illegal there, so Mutt-ng enforces the rule.
</para>
<para>
If you would like to add a header field to a single message, you should
- either set the <link linkend="edit-headers">edit-headers</link>
+ either set the <muttng-doc:varref name="edit-headers"/>
variable,
or use the <emphasis>edit-headers</emphasis> function (default: ``E'')
in the send-menu so
</para>
<para>
- To remove user defined header fields, use the ``unmy_hdr''
+ 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:
</para>
<para>
- <screen>
-unmy_hdr to cc</screen>
+ <muttng-doc:lstconf>
+unmy_hdr to cc</muttng-doc:lstconf>
</para>
<para>
</sect1>
- <sect1 id="hdr-order">
- <title>Defining the order of headers when viewing messages </title>
+ <sect1>
+ <title>Defining the order of headers when viewing messages</title>
<para>
- Usage: <literal>hdr_order</literal> <emphasis>header1</emphasis>
- <emphasis>header2</emphasis> <emphasis>header3</emphasis>
+ <muttng-doc:cmddef name="hdr_order">header header [header ...]</muttng-doc:cmddef>
</para>
-
+
+ <para>
+ <muttng-doc:cmddef name="unhdr_order">[ * | header header ...]</muttng-doc:cmddef>
+ </para>
+
<para>
With this command, you can specify an order in which mutt will attempt
to present headers to you when viewing messages.
</para>
<para>
- ``unhdr_order *'' will clear all previous headers from the order
+ ``unhdr_order *'' will clear all previous headers from the order
list,
thus removing the header order effects set by the system-wide startup
file.
<para>
- <screen>
-hdr_order From Date: From: To: Cc: Subject:</screen>
+ <muttng-doc:lstconf>
+hdr_order From Date: From: To: Cc: Subject:</muttng-doc:lstconf>
</para>
</sect1>
<sect1 id="save-hook">
- <title>Specify default save filename </title>
+ <title>Specify default save filename</title>
<para>
- Usage: <literal>save-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>
- filename
- </emphasis>
+ Usage: <muttng-doc:hook name="save"/> [!]<emphasis>pattern</emphasis> <emphasis>filename</emphasis>
</para>
<para>
</para>
<para>
- See <link linkend="pattern-hook">pattern-hook</link> for information on
+ See <muttng-doc:hook name="pattern"/> for information on
the exact format of <emphasis>pattern</emphasis>.
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
-save-hook aol\\.com$ +spam</screen>
+save-hook aol\\.com$ +spam</muttng-doc:lstconf>
</para>
<para>
- Also see the <link linkend="fcc-save-hook">fcc-save-hook</link>
+ Also see the <muttng-doc:hook name="fcc-save"/>
command.
</para>
</sect1>
<sect1 id="fcc-hook">
- <title>Specify default Fcc: mailbox when composing </title>
+ <title>Specify default Fcc: mailbox when composing</title>
<para>
- Usage: <literal>fcc-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>
- mailbox
- </emphasis>
+ Usage: <muttng-doc:hook name="fcc"/> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
</para>
<para>
This command is used to save outgoing mail in a mailbox other than
- <link linkend="record">record</link>. Mutt-ng searches the initial
+ <muttng-doc:varref name="record"/>. Mutt-ng 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 <link linkend="record">record</link> mailbox.
+ to <muttng-doc:varref name="record"/> mailbox.
</para>
<para>
- See <link linkend="pattern-hook">pattern-hook</link> for information on
+ See <muttng-doc:hook name="pattern"/> for information on
the exact format of <emphasis>pattern</emphasis>.
</para>
<para>
- Example: <literal>fcc-hook [@.]aol\\.com$
- +spammers
- </literal>
+ Example:
+ </para>
+
+ <para>
+ <muttng-doc:lstconf>
+fcc-hook [@.]aol\\.com$ +spammers</muttng-doc:lstconf>
</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 <link linkend="fcc-save-hook">
- fcc-save-hook
- </link>
- command.
+ The above will save a copy of all messages going to the aol.com
+ domain to the `+spammers' mailbox by default. Also see the
+ <muttng-doc:hook name="fcc-save"/> command.
</para>
<para>
</sect1>
<sect1 id="fcc-save-hook">
- <title>Specify default save filename and default Fcc: mailbox at once </title>
+ <title>Specify default save filename and default Fcc: mailbox at once</title>
<para>
- Usage: <literal>fcc-save-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>
- mailbox
- </emphasis>
+ Usage: <literal><muttng-doc:hook name="fcc-save"/></literal> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
</para>
<para>
- This command is a shortcut, equivalent to doing both a <link linkend="fcc-hook">
- fcc-hook
- </link>
- and a <link linkend="save-hook">save-hook</link> with its arguments.
+ This command is a shortcut, equivalent to doing both a <muttng-doc:hook name="fcc"/>
+ and a <muttng-doc:hook name="save"/> with its arguments.
</para>
<para>
</sect1>
<sect1 id="send-hook">
- <title>Change settings based upon message recipients </title>
-
+ <title>Change settings based upon message recipients</title>
+
+ <anchor id="reply-hook"/>
+ <anchor id="send2-hook"/>
<para>
- Usage: <literal>reply-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>
- command
- </emphasis>
-
- Usage: <literal>send-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>
- command
- </emphasis>
-
- Usage: <literal>send2-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>
- command
- </emphasis>
+ Usage: <muttng-doc:hook name="reply"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
+ </para>
+ <para>
+ Usage: <muttng-doc:hook name="send"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
+ </para>
+ <para>
+ Usage: <muttng-doc:hook name="send2"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
</para>
<para>
</para>
<para>
- <literal>reply-hook</literal> is matched against the message you are <emphasis>
+ <muttng-doc:hook name="reply"/> is matched against the message you are <emphasis>
replying
</emphasis>
<emphasis role="bold">to</emphasis>, instead of the message you are <emphasis>
sending
</emphasis>
- .<literal>send-hook</literal> is
+ .<muttng-doc:hook name="send"/> is
matched against all messages, both <emphasis>new</emphasis> and <emphasis>
replies
</emphasis>
.<emphasis role="bold">Note:</emphasis>
- <literal>reply-hook</literal>s are matched <emphasis role="bold">before</emphasis> the <literal>
- send-hook
- </literal>
- ,<emphasis role="bold">regardless</emphasis>
+ <muttng-doc:hook name="reply"/>s are matched <emphasis role="bold">before</emphasis> the
+ <muttng-doc:hook name="send"/>, <emphasis role="bold">regardless</emphasis>
of the order specified in the users's configuration file.
</para>
<para>
- <literal>send2-hook</literal> is matched every time a message is
+ <muttng-doc:hook name="send2"/> is matched every time a message is
changed, either
by editing it, or by using the compose menu to change its recipients
- or subject. <literal>send2-hook</literal> is executed after <literal>
- send-hook
- </literal>
+ or subject. <muttng-doc:hook name="send2"/> is executed after <muttng-doc:hook name="send"/>
,and
- can, e.g., be used to set parameters such as the <link linkend="sendmail">
- sendmail
- </link>
+ can, e.g., be used to set parameters such as the <muttng-doc:varref name="sendmail"/>
variable depending on the message's sender
address.
</para>
<para>
- For each type of <literal>send-hook</literal> or <literal>reply-hook</literal>, when multiple matches
+ For each type of <muttng-doc:hook name="send"/> or <muttng-doc:hook name="reply"/>, when multiple matches
occur, commands are executed in the order they are specified in the
muttrc
(for that type of hook).
</para>
<para>
- See <link linkend="pattern-hook">pattern-hook</link> for information on
+ See <muttng-doc:hook name="pattern"/> for information on
the exact format of <emphasis>pattern</emphasis>.
</para>
<para>
- Example: <literal>send-hook mutt "set mime_forward
+ Example: <literal>send-hook mutt "set mime_forward
signature=''"
</literal>
</para>
<para>
Another typical use for this command is to change the values of the
- <link linkend="attribution">attribution</link>, <link linkend="signature">
- signature
- </link>
- and <link linkend="locale">locale</link>
+ <muttng-doc:varref name="attribution"/>,
+ <muttng-doc:varref name="signature"/> and <muttng-doc:varref
+ name="locale"/>
variables in order to change the language of the attributions and
signatures based upon the recipients.
</para>
<para>
- <emphasis role="bold">Note:</emphasis> the send-hook's are only
+ <emphasis role="bold">Note:</emphasis> the <muttng-doc:hook name="send"/>'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
+ message will NOT cause any <muttng-doc:hook name="send"/> to be executed. Also note that
+ 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.
+ from a <muttng-doc:hook name="send"/>.
</para>
<para>
</sect1>
<sect1 id="message-hook">
- <title>Change settings before formatting a message </title>
+ <title>Change settings before formatting a message</title>
<para>
- Usage: <literal>message-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>
- command
- </emphasis>
+ Usage: <muttng-doc:hook name="message"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
</para>
<para>
</para>
<para>
- See <link linkend="pattern-hook">pattern-hook</link> for
+ See <muttng-doc:hook name="pattern"/> for
information on the exact format of <emphasis>pattern</emphasis>.
</para>
<para>
Example:
- <screen>
+ <muttng-doc:lstconf>
message-hook ~A 'set pager=builtin'
-message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject:.*\""'</screen>
+message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject:.*\""'</muttng-doc:lstconf>
</para>
</sect1>
<sect1 id="crypt-hook">
- <title>Choosing the cryptographic key of the recipient </title>
+ <title>Choosing the cryptographic key of the recipient</title>
<para>
- Usage: <literal>crypt-hook</literal> <emphasis>pattern</emphasis> <emphasis>
- keyid
- </emphasis>
+ Usage: <muttng-doc:hook name="crypt"/> <emphasis>pattern</emphasis> <emphasis>keyid</emphasis>
</para>
<para>
key with a given e-mail address automatically, either because the
recipient's public key can't be deduced from the destination address,
or because, for some reasons, you need to override the key Mutt-ng
- wouldnormally use. The crypt-hook command provides a method by which
+ wouldnormally use. The <muttng-doc:hook name="crypt"/> 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.
</sect1>
- <sect1 id="push">
- <title>Adding key sequences to the keyboard buffer </title>
+ <sect1>
+ <title>Adding key sequences to the keyboard buffer</title>
<para>
- Usage: <literal>push</literal> <emphasis>string</emphasis>
+ <muttng-doc:cmddef name="push">string</muttng-doc:cmddef>
</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 <link linkend="macro">macro</link> command. You may use
- it to
- automatically run a sequence of commands at startup, or when entering
- certain folders.
+
+ 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 <muttng-doc:cmdref name="macro"/> command. You may use it to
+ automatically run a sequence of commands at startup, or when
+ entering certain folders. For example, the following command
+ will automatically collapse all threads when entering a folder:
+
+ <muttng-doc:lstconf>
+folder-hook . 'push <collapse-all>'</muttng-doc:lstconf>
+
</para>
<para>
</sect1>
- <sect1 id="exec">
- <title>Executing functions </title>
+ <sect1>
+ <title>Executing functions</title>
<para>
- Usage: <literal>exec</literal> <emphasis>function</emphasis> [ <emphasis>
- function
- </emphasis>
- ... ]
+ <muttng-doc:cmddef name="exec">function [function ... ]</muttng-doc:cmddef>
</para>
<para>
</sect1>
- <sect1 id="score-command">
- <title>Message Scoring </title>
+ <sect1>
+ <title>Message Scoring</title>
<para>
- Usage: <literal>score</literal> <emphasis>pattern</emphasis> <emphasis>
- value
- </emphasis>
-
- Usage: <literal>unscore</literal> <emphasis>pattern</emphasis> [ <emphasis>
- pattern
- </emphasis>
- ... ]
+ <muttng-doc:cmddef name="score">pattern value</muttng-doc:cmddef>
+ </para>
+ <para>
+ <muttng-doc:cmddef name="unscore">pattern [pattern ... ]</muttng-doc:cmddef>
</para>
<para>
<para>
- <screen>
+ <muttng-doc:lstconf>
score "~f nion@muttng\.org" 50
-score "~f @sco\.com" -100</screen>
+score "~f @sco\.com" -100</muttng-doc:lstconf>
</para>
<para>
- <screen>
-score "~f santaclaus@northpole\.int" =666</screen>
+ <muttng-doc:lstconf>
+score "~f santaclaus@northpole\.int" =666</muttng-doc:lstconf>
</para>
</para>
<para>
- These three thresholds can be set via the variables <link linkend="score-threshold-flag">
- score-threshold-flag
- </link>
- ,<link linkend="score-threshold-read">score-threshold-read</link>, <link linkend="score-threshold-delete">
- score-threshold-delete
- </link>
- and. By
- default, <link linkend="score-threshold-read">score-threshold-read</link> and <link linkend="score-threshold-delete">
- score-threshold-delete
- </link>
- are set to
+ These three thresholds can be set via the variables
+ <muttng-doc:varref name="score-threshold-read"/>,
+ <muttng-doc:varref name="score-threshold-flag"/> and
+ <muttng-doc:varref name="score-threshold-delete"/>.
+ </para>
+ <para>
+ By default,
+ <muttng-doc:varref name="score-threshold-read"/> and
+ <muttng-doc:varref name="score-threshold-delete"/>
+ are set to
<literal>-1</literal>, which means that in the default threshold
configuration no
message will ever get marked as read or deleted.
color
</literal>
command
- and the <literal>˜n</literal> pattern:
+ and the <muttng-doc:pattern name="n"/> pattern:
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
color index black yellow "~n 10-"
-color index red yellow "~n 100-"</screen>
+color index red yellow "~n 100-"</muttng-doc:lstconf>
</para>
</sect1>
- <sect1 id="spam">
- <title>Spam detection </title>
-
+ <sect1>
+ <title>Spam detection</title>
+
<para>
- Usage: <literal>spam</literal> <emphasis>pattern</emphasis> <emphasis>
- format
- </emphasis>
-
- Usage: <literal>nospam</literal> <emphasis>pattern</emphasis>
+ <muttng-doc:cmddef name="spam">pattern format</muttng-doc:cmddef>
+ </para>
+ <para>
+ <muttng-doc:cmddef name="nospam">pattern</muttng-doc:cmddef>
</para>
<para>
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 <literal>%H</literal> selector in the <link linkend="index-format">
- index-format
- </link>
- variable. (Tip: try <literal>%?H?[%H] ?</literal>
+ display using the <literal>%H</literal> selector in the
+ <muttng-doc:varref name="index-format"/>
+ variable. (Tip: try <literal>%?H?[%H] ?</literal>
to display spam tags only when they are defined for a given message.)
</para>
pattern
</emphasis>
expression. (A regular expression ``back-reference'' refers to a
- sub-expression contained within parentheses.) <literal>%1</literal> is replaced with
- the first back-reference in the regex, <literal>%2</literal>
+ sub-expression contained within parentheses.) <literal>%1</literal> is replaced with
+ the first back-reference in the regex, <literal>%2</literal>
with the second, etc.
</para>
one spam-related header. You can define <literal>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
+ the $spam_separator variable is set to a string, then the
message's spam tag will consist of all the <emphasis>format</emphasis>
strings joined
- together, with the value of $spam_separator separating
+ together, with the value of $spam_separator separating
them.
</para>
For example, suppose I use DCC, SpamAssassin, and PureMessage. I might
define these spam settings:
- <screen>
+ <muttng-doc:lstconf>
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=", "</screen>
+set spam_separator=", "</muttng-doc:lstconf>
</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
+ 97% probability of being spam, that message's spam tag would
read<literal>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
+ If the $spam_separator variable is unset, then each
spam pattern match supersedes the previous one. Instead of getting
joined <emphasis>format</emphasis> strings, you'll get only the last
one to match.
<para>
The spam tag is what will be displayed in the index when you use
- <literal>%H</literal> in the <literal>
- $index_format
+ <literal>%H</literal> in the <literal>
+ $index_format
</literal>
variable. It's also the
- string that the <literal>˜H</literal> pattern-matching expression
+ string that the <muttng-doc:pattern name="H"/> pattern-matching expression
matches against for
<emphasis>search</emphasis> and <emphasis>limit</emphasis> functions.
And it's what sorting by spam
will be removed. This might be the default action if you use <literal>
spam
</literal>
- and <literal>nospam</literal> in conjunction with a <literal>
- folder-hook
- </literal>
- .
+ and <literal>nospam</literal> in conjunction with a <muttng-doc:hook name="folder"/>.
</para>
<para>
<para>
- <screen>
-spam "^From: .*MAILER-DAEMON" "999"</screen>
+ <muttng-doc:lstconf>
+spam "^From: .*MAILER-DAEMON" "999"</muttng-doc:lstconf>
</para>
</sect1>
- <sect1 id="set">
- <title>Setting variables </title>
-
+ <sect1>
+ <title>Setting variables</title>
+
<para>
- Usage: <literal>set</literal> [no|inv]<emphasis>
- variable
- </emphasis>
- [=<emphasis>value</emphasis>] [ <emphasis>variable</emphasis> ... ]
-
- Usage: <literal>toggle</literal> <emphasis>variable</emphasis> [<emphasis>
- variable
- </emphasis>
- ... ]
-
- Usage: <literal>unset</literal> <emphasis>variable</emphasis> [<emphasis>
- variable
- </emphasis>
- ... ]
-
- Usage: <literal>reset</literal> <emphasis>variable</emphasis> [<emphasis>
- variable
- </emphasis>
- ... ]
+ <muttng-doc:cmddef name="set">[no|inv]variable [=value] [variable...]</muttng-doc:cmddef>
+ </para>
+ <para>
+ <muttng-doc:cmddef name="toggle">variable [variable ...]</muttng-doc:cmddef>
+ </para>
+ <para>
+ <muttng-doc:cmddef name="unset">variable [variable ...]</muttng-doc:cmddef>
+ </para>
+ <para>
+ <muttng-doc:cmddef name="reset">variable [variable ...]</muttng-doc:cmddef>
</para>
<para>
- This command is used to set (and unset) <link linkend="variables">
- variables
- </link>
- .There are four basic types of variables:
+ This command is used to set (and unset) <link linkend="variables">variables</link>.
+ 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).
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 role="bold">\n</emphasis> and <emphasis role="bold">
- \t
+ may also use the ``C'' escape sequences <emphasis role="bold">\n</emphasis> and <emphasis role="bold">
+ \t
</emphasis>
for
newline and tab, respectively.
the variable name with
<literal>inv</literal> to toggle the value (on or off). This is useful
when writing
- macros. Example: <literal>set invsmart_wrap</literal>.
+ macros. Example: <literal>set invsmart_wrap</literal>.
</para>
<para>
<para>
- <screen>
-set ?allow_8bit</screen>
+ <muttng-doc:lstconf>
+set ?allow_8bit</muttng-doc:lstconf>
</para>
</sect1>
- <sect1 id="source">
- <title>Reading initialization commands from another file </title>
+ <sect1>
+ <title>Reading initialization commands from another file</title>
<para>
- Usage: <literal>source</literal> <emphasis>filename</emphasis> [ <emphasis>
- filename
- </emphasis>
- ... ]
+ <muttng-doc:cmddef name="source">filename [filename ...]</muttng-doc:cmddef>
</para>
<para>
This command allows the inclusion of initialization commands
from other files. For example, I place all of my aliases in
- <literal>˜/.mail_aliases</literal> so that I can make my
- <literal>˜/.muttrc</literal> readable and keep my aliases
+ <literal>~/.mail_aliases</literal> so that I can make my
+ <literal>~/.muttrc</literal> readable and keep my aliases
private.
</para>
<para>
- If the filename begins with a tilde (``˜''), it will be expanded
+ If the filename begins with a tilde (``~''), it will be expanded
to the
path of your home directory.
</para>
<para>
- If the filename ends with a vertical bar (|), then <emphasis>
+ 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.
- <literal>source ˜/bin/myscript|</literal>).
+ <literal>source ~/bin/myscript|</literal>).
</para>
<para>
</sect1>
- <sect1 id="unhook">
- <title>Removing hooks </title>
+ <sect1>
+ <title>Removing hooks</title>
<para>
- Usage: <literal>unhook</literal> [ * | <emphasis>hook-type</emphasis> ]
+ <muttng-doc:cmddef name="unhook">[* | hook-type]</muttng-doc:cmddef>
</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 <literal>unhook send-hook</literal>.
+ something like <literal>unhook send</literal>.
</para>
<para>
</sect1>
- <sect1 id="sect:sharingsetups">
- <title>Sharing Setups </title>
+ <sect1 id="share">
+ <title>Sharing Setups</title>
- <sect2>
- <title>Character Sets </title>
+ <sect2 id="share-charset">
+ <title>Character Sets</title>
<para>
As users may run mutt-ng on different systems, the configuration
<para>
- <screen>
-set config_charset = "..."</screen>
+ <muttng-doc:lstconf>
+set config_charset = "..."</muttng-doc:lstconf>
</para>
<para>
and replacing the dots with the actual character set. To avoid
- problems while maintaining the setup, vim user's may want to use
+ problems while maintaining the setup, <muttng-doc:man name="vim"/> user's may want to use
modelines as show in:
</para>
<para>
while, again, replacing the dots with the appropriate name. This
- tells vim as which character set to read and save the file.
+ tells <muttng-doc:man name="vim"/> as which character set to read and save the file.
</para>
<para>
</sect2>
- <sect2>
- <title>Modularization </title>
+ <sect2 id="share-modularization">
+ <title>Modularization</title>
<para>
``Modularization'' means to divide the setup into several files
</sect2>
- <sect2>
- <title>Conditional parts </title>
+ <sect2 id="share-conditional">
+ <title>Conditional parts</title>
<para>
When using a configuration on different systems, the user may not
<para>
- <screen>
+ <muttng-doc:lstconf>
ifdef <item> <command>
-ifndef <item> <command></screen>
+ifndef <item> <command></muttng-doc:lstconf>
</para>
All available functions, variables and menus are documented
elsewhere in this manual but ``features'' is specific to these
two commands. To test for one, prefix one of the following
- keywords with <literal>feature_</literal>: ncurses,
+ keywords with <literal>feature_</literal>: ncurses,
slang, iconv, idn, dotlock, standalone, pop, nntp, imap, ssl,
gnutls, sasl, sasl2, libesmtp, compressed, color, classic_pgp,
classic_smime, gpgme, header_cache
<para>
As an example, one can use the following in
- <literal>˜/.muttngrc</literal>:
+ <literal>~/.muttngrc</literal>:
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
ifdef feature_imap 'source ~/.mutt-ng/setup-imap'
ifdef feature_pop 'source ~/.mutt-ng/setup-pop'
-ifdef feature_nntp 'source ~/.mutt-ng/setup-nntp'</screen>
+ifdef feature_nntp 'source ~/.mutt-ng/setup-nntp'</muttng-doc:lstconf>
</para>
<para>
- ...to only source <literal>˜/.mutt-ng/setup-imap</literal> if
+ ...to only source <literal>~/.mutt-ng/setup-imap</literal> if
IMAP
- support is built in, only source <literal>˜/.mutt-ng/setup-pop</literal>
+ support is built in, only source <literal>~/.mutt-ng/setup-pop</literal>
if POP support is built in and only source
- <literal>˜/.mutt-ng/setup-nntp</literal> if NNTP support is
+ <literal>~/.mutt-ng/setup-nntp</literal> if NNTP support is
built in.
</para>
<para>
An example for testing for variable names can be used if users
use different revisions of mutt-ng whereby the older one may not
- have a certain variable. To test for the availability of <link linkend="imap-mail-check">
- imap-mail-check
- </link>
- ,
+ have a certain variable. To test for the availability of
+ <muttng-doc:varref name="imap-mail-check"/>
use:
</para>
<para>
- <screen>
-ifdef imap_mail_check 'set imap_mail_check = 300'</screen>
+ <muttng-doc:lstconf>
+ifdef imap_mail_check 'set imap_mail_check = 300'</muttng-doc:lstconf>
</para>
<para>
- Provided for completeness is the test for menu names. To set <link linkend="pager-index-lines">
- pager-index-lines
- </link>
+ Provided for completeness is the test for menu names. To set
+ <muttng-doc:varref name="pager-index-lines"
+ />
only if the pager
menu is available, use:
</para>
<para>
- <screen>
-ifdef pager 'set pager_index_lines = 10'</screen>
+ <muttng-doc:lstconf>
+ifdef pager 'set pager_index_lines = 10'</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
ifdef feature_ncurses 'source ~/.mutt-ng/setup-ncurses'
-ifndef feature_ncurses 'source ~/.mutt-ng/setup-slang'</screen>
+ifndef feature_ncurses 'source ~/.mutt-ng/setup-slang'</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
ifdef feature_slang 'source ~/.mutt-ng/setup-slang'
-ifndef feature_slang 'source ~/.mutt-ng/setup-ncurses'</screen>
+ifndef feature_slang 'source ~/.mutt-ng/setup-ncurses'</muttng-doc:lstconf>
</para>
</sect1>
- <sect1>
- <title>Obsolete Variables </title>
+ <sect1 id="vars-obsolete">
+ <title>Obsolete Variables</title>
<para>
In the process of ensuring and creating more consistency, many
</sect1>
</chapter>
+ <!--}}}-->
- <chapter>
- <title>Advanced Usage </title>
+ <chapter id="advanced-usage"> <!--{{{-->
+ <title>Advanced Usage</title>
- <sect1 id="regexp">
- <title>Regular Expressions </title>
+ <sect1 id="advanced-regexp">
+ <title>Regular Expressions</title>
<para>
All string patterns in Mutt-ng including those in more complex
- <link linkend="patterns">patterns</link> must be specified
+ <link linkend="tab-patterns">patterns</link> 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
<para>
The search is case sensitive if the pattern contains at least one upper
- case letter, and case insensitive otherwise. Note that ``\''
+ case letter, and case insensitive otherwise. Note that ``\''
must be quoted if used for a regular expression in an initialization
- command: ``\\''.
+ command: ``\\''.
</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 <link linkend="muttrc-syntax">muttrc-syntax</link>
+ character. See <link linkend="configuration-syntax">muttrc-syntax</link>
for more information on " and ' delimiter processing. To match a
literal " or ' you must preface it with \ (backslash).
</para>
</para>
<para>
- The period ``.'' matches any single character. The caret ``ˆ''
- andthe dollar sign ``$'' are metacharacters that respectively
+ The period ``.'' matches any single character. The caret ``^''
+ andthe 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
+ 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 <emphasis role="bold">
+ is a caret ``^'' then it matches any character <emphasis role="bold">
not
</emphasis>
in the
list. For example, the regular expression <emphasis role="bold">
- [0123456789]
+ ]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.
+ 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 ``:]''.
+ consist of ``[:'', a keyword denoting the class, and ``:]''.
The following classes are defined by the POSIX standard:
</para>
<variablelist>
<varlistentry>
- <term>[:alnum:]</term>
+ <term>[:alnum:]</term>
<listitem>
<para>
Alphanumeric characters.
</listitem>
</varlistentry>
<varlistentry>
- <term>[:alpha:]</term>
+ <term>[:alpha:]</term>
<listitem>
<para>
Alphabetic characters.
</listitem>
</varlistentry>
<varlistentry>
- <term>[:blank:]</term>
+ <term>[:blank:]</term>
<listitem>
<para>
Space or tab characters.
</listitem>
</varlistentry>
<varlistentry>
- <term>[:cntrl:]</term>
+ <term>[:cntrl:]</term>
<listitem>
<para>
Control characters.
</listitem>
</varlistentry>
<varlistentry>
- <term>[:digit:]</term>
+ <term>[:digit:]</term>
<listitem>
<para>
Numeric characters.
</listitem>
</varlistentry>
<varlistentry>
- <term>[:graph:]</term>
+ <term>[:graph:]</term>
<listitem>
<para>
Characters that are both printable and visible. (A space is
</listitem>
</varlistentry>
<varlistentry>
- <term>[:lower:]</term>
+ <term>[:lower:]</term>
<listitem>
<para>
Lower-case alphabetic characters.
</listitem>
</varlistentry>
<varlistentry>
- <term>[:print:]</term>
+ <term>[:print:]</term>
<listitem>
<para>
Printable characters (characters that are not control
</listitem>
</varlistentry>
<varlistentry>
- <term>[:punct:]</term>
+ <term>[:punct:]</term>
<listitem>
<para>
Punctuation characters (characters that are not letter, digits,
</listitem>
</varlistentry>
<varlistentry>
- <term>[:space:]</term>
+ <term>[:space:]</term>
<listitem>
<para>
Space characters (such as space, tab and formfeed, to name a
</listitem>
</varlistentry>
<varlistentry>
- <term>[:upper:]</term>
+ <term>[:upper:]</term>
<listitem>
<para>
Upper-case alphabetic characters.
</listitem>
</varlistentry>
<varlistentry>
- <term>[:xdigit:]</term>
+ <term>[:xdigit:]</term>
<listitem>
<para>
Characters that are hexadecimal digits.
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, <emphasis role="bold">[[:digit:]]</emphasis> is equivalent to
- <emphasis role="bold">[0-9]</emphasis>.
+ example, <emphasis role="bold">[[:digit:]]</emphasis> is equivalent to
+ <emphasis role="bold">[0-9]</emphasis>.
</para>
<para>
<para>
A collating symbol is a multi-character collating element
enclosed in
- ``[.'' and ``.]''. For example, if ``ch'' is a
+ ``[.'' and ``.]''. For example, if ``ch'' is a
collating
element, then <emphasis role="bold">
- [[.ch.]]
+ [[.ch.]]
</emphasis>
is a regexp that matches
this collating element, while <emphasis role="bold">
- [ch]
+ [ch]
</emphasis>
is a regexp that
matches either ``c'' or ``h''.
<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
+ ``[=''
+ and ``=]''. For example, the name ``e'' might be used to
+ represent all of ``è'' ``é'' and ``e''. In this
case,
- <emphasis role="bold">[[=e=]]</emphasis> is
+ <emphasis role="bold">[[=e=]]</emphasis> is
a regexp that matches any of
- ``è'', ``é'' and ``e''.
+ ``è'', ``é'' and ``e''.
</para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
- <term>{n}</term>
+ <term>{n}</term>
<listitem>
<para>
The preceding item is matched exactly <emphasis>n</emphasis>
</listitem>
</varlistentry>
<varlistentry>
- <term>{n,}</term>
+ <term>{n,}</term>
<listitem>
<para>
The preceding item is matched <emphasis>n</emphasis> or more
</listitem>
</varlistentry>
<varlistentry>
- <term>{,m}</term>
+ <term>{,m}</term>
<listitem>
<para>
The preceding item is matched at most <emphasis>m</emphasis>
</listitem>
</varlistentry>
<varlistentry>
- <term>{n,m}</term>
+ <term>{n,m}</term>
<listitem>
<para>
The preceding item is matched at least <emphasis>n</emphasis>
<para>
Two regular expressions may be joined by the infix operator
- ``|'';
+ ``|'';
the resulting regular expression matches any string matching either
subexpression.
</para>
<variablelist>
<varlistentry>
- <term>\\y</term>
+ <term>\\y</term>
<listitem>
<para>
Matches the empty string at either the beginning or the end of
</listitem>
</varlistentry>
<varlistentry>
- <term>\\B</term>
+ <term>\\B</term>
<listitem>
<para>
Matches the empty string within a word.
</listitem>
</varlistentry>
<varlistentry>
- <term>\\<</term>
+ <term>\\<</term>
<listitem>
<para>
Matches the empty string at the beginning of a word.
</listitem>
</varlistentry>
<varlistentry>
- <term>\\></term>
+ <term>\\></term>
<listitem>
<para>
Matches the empty string at the end of a word.
</listitem>
</varlistentry>
<varlistentry>
- <term>\\w</term>
+ <term>\\w</term>
<listitem>
<para>
Matches any word-constituent character (letter, digit, or
</listitem>
</varlistentry>
<varlistentry>
- <term>\\W</term>
+ <term>\\W</term>
<listitem>
<para>
Matches any character that is not word-constituent.
</listitem>
</varlistentry>
<varlistentry>
- <term>\\`</term>
+ <term>\\`</term>
<listitem>
<para>
Matches the empty string at the beginning of a buffer (string).
</listitem>
</varlistentry>
<varlistentry>
- <term>\\'</term>
+ <term>\\'</term>
<listitem>
<para>
Matches the empty string at the end of a buffer.
</sect1>
- <sect1>
- <title>Patterns </title>
+ <sect1 id="advanced-patterns">
+ <title>Patterns</title>
<para>
Mutt-ng's pattern language provides a simple yet effective way to
set up rules to match messages, e.g. for operations like tagging and
scoring. A pattern consists of one or more sub-pattern, which can be
logically grouped, ORed, and negated. For a complete listing of
- these patterns, please refer to table <link linkend="patterns">patterns</link> in the Reference chapter.
+ these patterns, please refer to table <link linkend="tab-patterns">patterns</link> in the Reference chapter.
</para>
<para>
It must be noted that in this table, <literal>EXPR</literal> is
a regular expression. For ranges, the forms
- <literal><[MAX]</literal>, <literal>>>[MIN]</literal>,
- <literal> [MIN]- </literal> and <literal>-[MAX]</literal> are
+ <literal><[MAX]</literal>, <literal>>>[MIN]</literal>,
+ <literal> [MIN]-</literal> and <literal>-[MAX]</literal> are
also possible.
</para>
- <sect2>
- <title>Complex Patterns </title>
+ <sect2 id="patterns-complex">
+ <title>Complex Patterns</title>
<para>
It is possible to combine several sub-patterns to a more complex
<para>
<screen>
-~s 'SPAM' ~U</screen>
+<muttng-doc:pattern name="s"/> 'SPAM' <muttng-doc:pattern name="U"/></screen>
</para>
</para>
<para>
- To logical OR patterns, simply use the <literal>|</literal>
+ To logical OR patterns, simply use the <literal>|</literal>
operator. This one
especially useful when using local groups:
</para>
<para>
<screen>
-~f ("nion@muttng\.org"|"ak@muttng\.org"|"pdmef@muttng\.org")
-(~b mutt-ng|~s Mutt-ng)
-!~x '@synflood\.at'</screen>
+<muttng-doc:pattern name="f"/> ("nion@muttng\.org"|"ak@muttng\.org"|"pdmef@muttng\.org")
+(<muttng-doc:pattern name="b"/> mutt-ng|<muttng-doc:pattern name="s"/> Mutt-ng)
+!<muttng-doc:pattern name="x"/> '@synflood\.at'</screen>
</para>
</sect2>
- <sect2>
- <title>Patterns and Dates </title>
+ <sect2 sect="patterns-dates">
+ <title>Patterns and Dates</title>
<para>
When using dates in patterns, the dates must be specified in a
<para>
<screen>
-~d 01/01/2005+1y
-~d 18/10/2004-2w
-~d 28/12/2004*1d</screen>
+<muttng-doc:pattern name="d"/> 01/01/2005+1y
+<muttng-doc:pattern name="d"/> 18/10/2004-2w
+<muttng-doc:pattern name="d"/> 28/12/2004*1d</screen>
</para>
<para>
<screen>
-~d >2w # messages older than two weeks
-~d <3d # messages newer than 3 days
-~d =1m # messages that are exactly one month old</screen>
+<muttng-doc:pattern name="d"/> >2w # messages older than two weeks
+<muttng-doc:pattern name="d"/> <3d # messages newer than 3 days
+<muttng-doc:pattern name="d"/> =1m # messages that are exactly one month old</screen>
</para>
</sect1>
- <sect1>
- <title>Format Strings </title>
+ <sect1 id="formatstrings">
+ <title>Format Strings</title>
- <sect2>
- <title>Introduction </title>
+ <sect2 id="formatstrings-intro">
+ <title>Introduction</title>
<para>
The so called <emphasis>Format Strings</emphasis> offer great
<para>
The setting for the status bar of the index is controlled via the
- <link linkend="status-format">status-format</link>
+ <muttng-doc:varref name="status-format"/>
variable. For the hostname and version string, there's an expando
- for <literal>$status_format</literal>: <literal>
- %h
+ for <literal>$status_format</literal>: <literal>
+ %h
</literal>
expands to the
- hostname and <literal>%v</literal> to the version string. When
+ hostname and <literal>%v</literal> to the version string. When
just configuring:
</para>
<para>
- <screen>
-set status_format = "%v on %h: ..."</screen>
+ <muttng-doc:lstconf>
+set status_format = "%v on %h: ..."</muttng-doc:lstconf>
</para>
<para>
- mutt-ng will replace the sequence <literal>%v</literal> with
+ mutt-ng will replace the sequence <literal>%v</literal> with
the version string
- and <literal>%h</literal> with the host's name. When you are,
+ and <literal>%h</literal> with the host's name. When you are,
for example, running
mutt-ng version <literal>1.5.9i</literal> on host <literal>mailhost</literal>, you'll see the
following when you're in the index:
<para>
- <screen>
-set status_format = "%v on %h: %B: ...</screen>
+ <muttng-doc:lstconf>
+set status_format = "%v on %h: %B: ...</muttng-doc:lstconf>
</para>
</sect2>
- <sect2>
- <title>Conditional Expansion </title>
+ <sect2 id="formatstrings-conditional">
+ <title>Conditional Expansion</title>
<para>
To only print the number of messages if there are new messages in
the current mailbox, further extend
- <literal>$status_format</literal> to:
+ <literal>$status_format</literal> to:
</para>
<para>
- <screen>
-set status_format = "%v on %h: %B %?n?%n new? ...</screen>
+ <muttng-doc:lstconf>
+set status_format = "%v on %h: %B %?n?%n new? ...</muttng-doc:lstconf>
</para>
<para>
<screen>
-%?<item>?<string if nonzero>?</screen>
+%?<item>?<string if nonzero>?</screen>
</para>
which tells mutt-ng to only look at <literal><string if
nonzero>
</literal>
- if the value of the <literal>%<item%gt;</literal>
+ if the value of the <literal>%<item%gt;</literal>
expando is different from zero. In our example, we used <literal>n</literal> as
- the expando to check for and <literal>%n new</literal> as the
+ the expando to check for and <literal>%n new</literal> as the
optional nonzero
string.
</para>
<para>
<screen>
-%?<item>?<string if nonzero>&<string if zero>?</screen>
+%?<item>?<string if nonzero>&<string if zero>?</screen>
</para>
<para>
- <screen>
-set status_format = "%v on %h: %B: %?n?%n new messages&no new messages? ...</screen>
+ <muttng-doc:lstconf>
+set status_format = "%v on %h: %B: %?n?%n new messages&no new messages? ...</muttng-doc:lstconf>
</para>
<para>
- <screen>
-set status_format = "%v on %h: %B: %?n?%n&no? new messages ...</screen>
+ <muttng-doc:lstconf>
+set status_format = "%v on %h: %B: %?n?%n&no? new messages ...</muttng-doc:lstconf>
</para>
</sect2>
- <sect2>
- <title>Modifications and Padding </title>
+ <sect2 id="formatstrings-padding">
+ <title>Modifications and Padding</title>
<para>
Besides the information given so far, there're even more features of
<listitem>
<para>
- When specifying <literal>%_<item></literal>
+ When specifying <literal>%_<item></literal>
instead of
- just <literal>%<item></literal>, mutt-ng will
+ just <literal>%<item></literal>, mutt-ng will
convert all
characters in the expansion of <literal><item></literal>
to
<listitem>
<para>
- When specifying <literal>%:<item></literal>
+ When specifying <literal>%:<item></literal>
instead of just
- <literal>%<item></literal>, mutt-ng will convert
+ <literal>%<item></literal>, mutt-ng will convert
all dots in the
expansion of <literal><item></literal> to underscores
- (<literal>_</literal>).
+ (<literal>_</literal>).
</para>
</listitem>
<para>
Also, there's a feature called <emphasis>Padding</emphasis> supplied
by the
- following two expandos: <literal>%|X</literal> and <literal>
- %>X
+ following two expandos: <literal>%|X</literal> and <literal>
+ %>X
</literal>
.
</para>
<varlistentry>
<term>
- <literal>%|X</literal>
+ <literal>%|X</literal>
</term>
<listitem>
<para>
<para>
- <screen>
-set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"</screen>
+ <muttng-doc:lstconf>
+set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"</muttng-doc:lstconf>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <literal>%>X</literal>
+ <literal>%>X</literal>
</term>
<listitem>
<para>
Since the previous expando stops at
the end of line, there must be a way to fill the gap between
- two items via the <literal>%>X</literal> expando:
+ two items via the <literal>%>X</literal> expando:
it puts as many
characters <literal>X</literal> in between two items so that
the rest of
the line will be right-justified. For example, to not put the
version string and hostname of our example on the left but on
the right and fill the gap with spaces, one might use (note
- the space after <literal>%></literal>):
+ the space after <literal>%></literal>):
</para>
<para>
- <screen>
-set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"</screen>
+ <muttng-doc:lstconf>
+set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"</muttng-doc:lstconf>
</para>
</listitem>
</sect1>
- <sect1>
- <title>Using Tags </title>
+ <sect1 id="using-tags">
+ <title>Using Tags</title>
<para>
Sometimes it is desirable to perform an operation on a group of
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 <link linkend="patterns">patterns</link> for Mutt-ng's
+ default. See <link linkend="tab-patterns">patterns</link> for Mutt-ng's
pattern
matching syntax.
</para>
</emphasis>
operation will
be applied to all tagged messages if that operation can be used in that
- manner. If the <link linkend="auto-tag">auto-tag</link>
+ manner. If the <muttng-doc:varref name="auto-tag"/>
variable is set, the next operation applies to the tagged messages
automatically, without requiring the ``tag-prefix''.
</para>
<para>
- In <link linkend="macro">macro</link> or <link linkend="push">push</link> commands,
+ In <muttng-doc:cmdref name="macro"/> or <muttng-doc:cmdref name="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-ng will stop "eating" the macro when it encounters the
</sect1>
<sect1 id="hooks">
- <title>Using Hooks </title>
+ <title>Using Hooks</title>
<para>
A <emphasis>hook</emphasis> is a concept borrowed from the EMACS editor
reading, or to whom you are sending mail. In the Mutt-ng world, a <emphasis>
hook
</emphasis>
- consists of a <link linkend="regexp">regexp</link> or
- <link linkend="patterns">patterns</link> along with a
+ consists of a <link linkend="advanced-regexp">regexp</link> or
+ <link linkend="tab-patterns">patterns</link> along with a
configuration option/command. See
<itemizedlist>
<listitem>
<para>
- <link linkend="folder-hook">folder-hook</link>
+ <muttng-doc:hook name="folder"/>
</para>
</listitem>
<listitem>
<para>
- <link linkend="send-hook">send-hook</link>
+ <muttng-doc:hook name="send"/>
</para>
</listitem>
<listitem>
<para>
- <link linkend="message-hook">message-hook</link>
+ <muttng-doc:hook name="message"/>
</para>
</listitem>
<listitem>
<para>
- <link linkend="save-hook">save-hook</link>
+ <muttng-doc:hook name="save"/>
</para>
</listitem>
<listitem>
<para>
- <link linkend="mbox-hook">mbox-hook</link>
+ <muttng-doc:hook name="mbox"/>
</para>
</listitem>
<listitem>
<para>
- <link linkend="fcc-hook">fcc-hook</link>
+ <muttng-doc:hook name="fcc"/>
</para>
</listitem>
<listitem>
<para>
- <link linkend="fcc-save-hook">fcc-save-hook</link>
+ <muttng-doc:hook name="fcc-save"/>
</para>
</listitem>
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
+ restore configuration defaults. Here is an example with <muttng-doc:hook name="send"/> and
the
- my_hdr directive:
+ my_hdr directive:
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
send-hook . 'unmy_hdr From:'
-send-hook ~C'^b@b\.b$' my_hdr from: c@c.c</screen>
+send-hook '~C ^b@b\.b$' my-hdr from: c@c.c</muttng-doc:lstconf>
</para>
<title>Message Matching in Hooks</title>
<para>
- Hooks that act upon messages (<literal>send-hook, save-hook,
- fcc-hook,message-hook
+ Hooks that act upon messages (<literal><muttng-doc:hook name="send"/>, <muttng-doc:hook name="save"/>,
+ <muttng-doc:hook name="fcc"/>,<muttng-doc:hook name="message"/>
</literal>
)are evaluated in a slightly different manner. For the other
- types of hooks, a <link linkend="regexp">regexp</link> is
+ types of hooks, a <link linkend="advanced-regexp">regexp</link> 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.
</para>
<para>
- Mutt-ng allows the use of the <link linkend="patterns">patterns</link>
+ Mutt-ng allows the use of the <link linkend="tab-patterns">patterns</link>
language for matching messages in hook commands. This works in
exactly the same way as it would when <emphasis>limiting</emphasis>
or<emphasis>searching</emphasis> the mailbox, except that you are
sending
mail to a specific address, you could do something like:
- <screen>
-send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt-ng User <user@host>'</screen>
+ <muttng-doc:lstconf>
+send-hook '~t ^me@cs\.hmc\.edu$' 'my-hdr From: Mutt-ng User <user@host>'</muttng-doc:lstconf>
which would execute the given command when sending mail to
<emphasis>me@cs.hmc.edu</emphasis>.
like the other hooks, in which case Mutt-ng will translate your
pattern into the full language, using the translation specified by
the
- <link linkend="default-hook">default-hook</link> variable. The
+ <muttng-doc:hook name="default"/> variable. The
pattern is translated at the time the hook is declared, so the value
of
- <link linkend="default-hook">default-hook</link> that is in effect
+ <muttng-doc:hook name="default"/> that is in effect
at that time will be used.
</para>
</sect1>
<sect1 id="sidebar">
- <title>Using the sidebar </title>
+ <title>Using the sidebar</title>
<para>
The sidebar, a feature specific to Mutt-ng, allows you to use a mailbox
and highlights the ones with new email
Use the following configuration commands:
- <screen>
+ <muttng-doc:lstconf>
set sidebar_visible="yes"
-set sidebar_width=25</screen>
+set sidebar_width=25</muttng-doc:lstconf>
</para>
<para>
If you want to specify the mailboxes you can do so with:
- <screen>
+ <muttng-doc:lstconf>
set mbox='=INBOX'
mailboxes INBOX \
MBOX1 \
MBOX2 \
-...</screen>
+...</muttng-doc:lstconf>
</para>
<para>
You can also specify the colors for mailboxes with new mails by using:
- <screen>
+ <muttng-doc:lstconf>
color sidebar_new red black
-color sidebar white black</screen>
+color sidebar white black</muttng-doc:lstconf>
</para>
- <para>
- The available functions are:
-
- <table>
- <title>Default Sidebar Function Bindings</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry>Key</entry>
- <entry>Function</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row><entry><code>none</code></entry><entry><code>sidebar-scroll-up </code></entry><entry>Scrolls the mailbox list up 1 page</entry></row>
- <row><entry><code>none</code></entry><entry><code>sidebar-scroll-down </code></entry><entry>Scrolls the mailbox list down 1 page</entry></row>
- <row><entry><code>none</code></entry><entry><code>sidebar-next </code></entry><entry>Highlights the next mailbox</entry></row>
- <row><entry><code>none</code></entry><entry><code>sidebar-next-new </code></entry><entry>Highlights the next mailbox with new mail</entry></row>
- <row><entry><code>none</code></entry><entry><code>sidebar-previous </code></entry><entry>Highlights the previous mailbox</entry></row>
- <row><entry><code>none</code></entry><entry><code>sidebar-open </code></entry><entry>Opens the currently highlighted mailbox</entry></row>
- </tbody>
- </tgroup>
- </table>
-
- </para>
-
<para>
Reasonable key bindings look e.g. like this:
- <screen>
+ <muttng-doc:lstconf>
bind index \Cp sidebar-prev
bind index \Cn sidebar-next
bind index \Cb sidebar-open
bind pager \Cb sidebar-open
macro index B ':toggle sidebar_visible^M'
-macro pager B ':toggle sidebar_visible^M'</screen>
+macro pager B ':toggle sidebar_visible^M'</muttng-doc:lstconf>
</para>
</sect1>
<sect1 id="query">
- <title>External Address Queries </title>
+ <title>External Address Queries</title>
<para>
Mutt-ng 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 <link linkend="query-command">
- query-command
- </link>
+ using a simple interface. Using the
+ <muttng-doc:varref name="query-command"/>
variable, you specify the wrapper
command to use. For example:
</para>
<para>
- <screen>
-set query_command = "mutt_ldap_query.pl '%s'"</screen>
+ <muttng-doc:lstconf>
+set query_command = "mutt_ldap_query.pl '%s'"</muttng-doc:lstconf>
</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
+ 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
</sect1>
- <sect1>
- <title>Mailbox Formats </title>
+ <sect1 id="mailbox-formats">
+ <title>Mailbox Formats</title>
<para>
Mutt-ng 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
- newmailboxes, Mutt-ng uses the default specified with the <link linkend="mbox-type">
- mbox-type
- </link>
+ newmailboxes, Mutt-ng uses the default specified with the
+ <muttng-doc:varref name="mbox-type"/>
variable.
</para>
<para>
- <screen>
-From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST</screen>
+ <muttng-doc:lstmail>
+From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST</muttng-doc:lstmail>
</para>
<para>
to denote the start of a new message (this is often referred to as the
- ``From_'' line).
+ ``From_'' line).
</para>
<para>
mbox
</emphasis>
format. Each message is
- surrounded by lines containing ``ˆAˆAˆAˆA'' (four
+ surrounded by lines containing ``^A^A^A^A'' (four
control-A's).
</para>
</emphasis>
Mutt
detects this type of mailbox by looking for either <literal>
- .mh_sequences
+ .mh_sequences
</literal>
or <literal>.xmhcache</literal> (needed to distinguish normal
directories from MH
</sect1>
<sect1 id="shortcuts">
- <title>Mailbox Shortcuts </title>
+ <title>Mailbox Shortcuts</title>
<para>
There are a number of built in shortcuts which refer to specific
<listitem>
<para>
- ! -- refers to your <link linkend="spoolfile">spoolfile</link>
+ ! -- refers to your <muttng-doc:varref name="spoolfile"/>
(incoming) mailbox
</para>
</listitem>
<listitem>
<para>
- > -- refers to your <link linkend="mbox">mbox</link> file
+ > -- refers to your <muttng-doc:varref name="mbox"/> file
</para>
</listitem>
<listitem>
<para>
- < -- refers to your <link linkend="record">record</link> file
+ < -- refers to your <muttng-doc:varref name="record"/> file
</para>
</listitem>
<listitem>
<para>
- ˆ -- refers to the current mailbox
+ ^ -- refers to the current mailbox
</para>
</listitem>
<listitem>
<listitem>
<para>
- ˜ -- refers to your home directory
+ ~ -- refers to your home directory
</para>
</listitem>
<listitem>
<para>
- = or + -- refers to your <link linkend="folder">folder</link>
+ = or + -- refers to your <muttng-doc:varref name="folder"/>
directory
</para>
</listitem>
<listitem>
<para>
- @<emphasis>alias</emphasis> -- refers to the <link linkend="save-hook">
- save-hook
- </link>
+ @<emphasis>alias</emphasis> -- refers to the <muttng-doc:hook name="save"/>
as determined by the address of the alias
</para>
</listitem>
</sect1>
<sect1 id="using-lists">
- <title>Handling Mailing Lists </title>
+ <title>Handling Mailing Lists</title>
<para>
Mutt-ng has a few configuration options that make dealing with large
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 <link linkend="lists">lists</link>
+ accomplished through the use of the <muttng-doc:cmdref name="lists"/>
commands in your muttrc.
</para>
through which you received a message (i.e., of a subscribed list) in
the <emphasis>index</emphasis> menu display. This is useful to
distinguish between
- personal and list mail in the same mailbox. In the <link linkend="index-format">
- index-format
- </link>
- variable, the escape ``%L''
+ personal and list mail in the same mailbox. In the
+ <muttng-doc:varref name="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).
Mutt-ng also supports the <literal>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 <link linkend="followup-to">
- followup-to
- </link>
+ subscribed mailing lists, and if the <muttng-doc:varref name="followup-to"/>
option is set, mutt will generate
a Mail-Followup-To header which contains all the recipients to whom
you send this message, but not your address. This indicates that
Conversely, when group-replying or list-replying to a message which
has a <literal>Mail-Followup-To</literal> header, mutt will respect
this header if
- the <link linkend="honor-followup-to">honor-followup-to</link>
+ the <muttng-doc:varref name="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
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-ng uses the <link linkend="reply-to">reply-to</link>
+ field. Mutt-ng uses the <muttng-doc:varref name="reply-to"/>
variable to help decide which address to use. If set to <emphasis>
ask-yes
</emphasis>
<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 <link linkend="index-format">index-format</link>
- variable's ``%y'' and
- ``%Y'' escapes can be used to expand ``X-Label:'' fields in the
+ individually). The <muttng-doc:varref name="index-format"/>
+ variable's ``%y'' and
+ ``%Y'' escapes can be used to expand ``X-Label:'' fields in the
index, and Mutt-ng's pattern-matcher can match regular expressions to
- ``X-Label:'' fields with the ``˜y'' selector. ``X-Label:'' is
+ ``X-Label:'' fields with the ``<muttng-doc:pattern name="y"/>'' selector. ``X-Label:'' is
not a
standard message header field, but it can easily be inserted by
procmailand other mail filtering agents.
</sect1>
- <sect1>
- <title>Editing threads </title>
+ <sect1 id="editing-threads">
+ <title>Editing threads</title>
<para>
Mutt-ng has the ability to dynamically restructure threads that are
annoyances which make it hard to follow a discussion.
</para>
- <sect2>
+ <sect2 id="editing-threads-link">
<title>Linking threads</title>
<para>
<para>
You can also connect multiple children at once, tagging them and
using the
- tag-prefix command (';') or the auto_tag option.
+ tag-prefix command (';') or the auto_tag option.
</para>
</sect2>
- <sect2>
+ <sect2 id="editing-threads-break">
<title>Breaking threads</title>
<para>
changing
the subject to a totally unrelated one.
You can fix such threads by using the ``break-thread'' function
- (boundby default to #), which will turn the subthread starting
+ (boundby default to #), which will turn the subthread starting
from the
current message into a whole different thread.
</para>
</sect1>
<sect1 id="dsn">
- <title>Delivery Status Notification (DSN) Support </title>
+ <title>Delivery Status Notification (DSN) Support</title>
<para>
- RFC1894 defines a set of MIME content types for relaying information
+ <muttng-doc:rfc num="1894"/> 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.''
<listitem>
<para>
- <link linkend="dsn-notify">dsn-notify</link> is used
+ <muttng-doc:varref name="dsn-notify"/> is used
to request receipts for different results (such as failed
message,message delivered, etc.).
<listitem>
<para>
- <link linkend="dsn-return">dsn-return</link> requests
+ <muttng-doc:varref name="dsn-return"/> requests
how much of your message should be returned with the receipt
(headers or full message).
</sect1>
- <sect1>
- <title>POP3 Support (OPTIONAL) </title>
+ <sect1 id="pop3">
+ <title>POP3 Support (OPTIONAL)</title>
<para>
If Mutt-ng was compiled with POP3 support (by running the <emphasis>
reason the frequency at which Mutt-ng will check for mail remotely can
be
controlled by the
- <link linkend="pop-mail-check">pop-mail-check</link>
+ <muttng-doc:varref name="pop-mail-check"/>
variable, which defaults to every 60 seconds.
</para>
<para>
Another way to access your POP3 mail is the <emphasis>fetch-mail</emphasis> function
- (default: G). It allows to connect to <link linkend="pop-host">
- pop-host
- </link>
+ (default: G). It allows to connect to <link
+ linkend="pop-host">pop-host</link>
,fetch all your new mail and place it in the
- local <link linkend="spoolfile">spoolfile</link>. After this
+ local <muttng-doc:varref name="spoolfile"/>. After this
point, Mutt-ng runs exactly as if the mail had always been local.
</para>
<emphasis role="bold">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>
+ <muttng-doc:man name="fetchmail"/>.
</para>
<para>
</sect1>
- <sect1>
- <title>IMAP Support (OPTIONAL) </title>
+ <sect1 id="imap">
+ <title>IMAP Support (OPTIONAL)</title>
<para>
- If Mutt-ng 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.
+ If Mutt-ng 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
- <literal>imap://imapserver/INBOX</literal>, where <literal>imapserver</literal> is the name of the
- IMAP server and <literal>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 <literal>imap://imapserver/path/to/folder</literal> where
- <literal>path/to/folder</literal> is the path of the folder you want to
- access.
+ You can access the remote inbox by selecting the folder via its
+ URL:
</para>
-
+
<para>
- You can select an alternative port by specifying it with the server,
- i.e.:
- <literal>imap://imapserver:port/INBOX</literal>.
+ <screen>
+imap://imapserver/INBOX</screen>
+ </para>
+
+ <para>
+ where <literal>imapserver</literal> is the name of the IMAP
+ server and <literal>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
+ </para>
+
+ <para>
+ <screen>
+imap://imapserver/path/to/folder</screen>
+ </para>
+
+ <para>
+ where <literal>path/to/folder</literal> is the path
+ of the folder you want to access. You can select an alternative
+ port by specifying it with the server, i.e.:
+ </para>
+
+ <para>
+ <screen>
+imap://imapserver:port/INBOX</screen>
</para>
<para>
- You can also specify different username for each folder, i.e.:
- <literal>imap://username@imapserver[:port]/INBOX</literal>.
+ You can also specify different username for each folder by
+ prenpending your username and an @ symbol to the server's name.
</para>
<para>
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 <literal>imaps://[username@]imapserver[:port]/path/to/folder</literal> as your
- folder path.
- </para>
-
- <para>
- Pine-compatible notation is also supported, i.e.
- <literal>{[username@]imapserver[:port][/ssl]}path/to/folder</literal>
+ SSL encrypted connections. To access a folder with IMAP/SSL, you only
+ need to substitute the initial <literal>imap://</literal> by
+ <literal>imaps://</literal> in the above examples.
</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
<emphasis>toggle-subscribed</emphasis> command. See also the
- <link linkend="imap-list-subscribed">imap-list-subscribed</link>
+ <muttng-doc:varref name="imap-list-subscribed"/>
variable.
</para>
Polling for new mail on an IMAP server can cause noticeable delays. So,
you'll
want to carefully tune the
- <link linkend="imap-mail-check">imap-mail-check</link>
+ <muttng-doc:varref name="imap-mail-check"/>
and
- <link linkend="timeout">timeout</link>
+ <muttng-doc:varref name="timeout"/>
variables.
</para>
selects the same folder.
</para>
- <sect2>
+ <sect2 id="imap-browser">
<title>The Folder Browser</title>
<para>
</sect2>
- <sect2>
+ <sect2 id="imap-auth">
<title>Authentication</title>
<para>
<listitem>
<para>
- <link linkend="imap-user">imap-user</link> - controls
+ <muttng-doc:varref 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 (i.e. by using a mailbox name of the form
- <literal>{user@host}</literal>).
+ <literal>{user@host}</literal>).
</para>
</listitem>
<listitem>
<para>
- <link linkend="imap-pass">imap-pass</link> - a
+ <muttng-doc:varref name="imap-pass"/> - a
password which you may preset, used by all authentication
methods where
a password is needed.
<listitem>
<para>
- <link linkend="imap-authenticators">imap-authenticators</link>
+ <muttng-doc:varref name="imap-authenticators"/>
- a colon-delimited list of IMAP
authentication methods to try, in the order you wish to try
them. If
</sect1>
- <sect1 id="reading-news">
- <title>NNTP Support (OPTIONAL) </title>
+ <sect1 id="nntp">
+ <title>NNTP Support (OPTIONAL)</title>
<para>
If compiled with ``--enable-nntp'' option, Mutt-ng can read news from
a newsserver via NNTP. You can open a newsgroup with the
``change-newsgroup'' function from the index/pager which is by default
- bound to <literal>i</literal>.
+ bound to <muttng-doc:key>i</muttng-doc:key>.
</para>
<para>
- The Default newsserver can be obtained from the
- <literal>$NNTPSERVER</literal> environment variable. Like other
+ The Default newsserver can be obtained from the <muttng-doc:envvar name="NNTPSERVER"/>
+ environment variable. Like other
news readers,
info about subscribed newsgroups is saved in a file as specified by the
- <link linkend="nntp-newsrc">nntp-newsrc</link> variable.
+ <muttng-doc:varref name="nntp-newsrc"/> variable.
Article headers are cached and can be loaded from a file when a
newsgroup is entered instead loading from newsserver; currently, this
caching mechanism still is different from the header caching for
maildir/IMAP.
</para>
- <sect2>
- <title>Again: Scoring </title>
+ <sect2 id="nntp-scoring">
+ <title>Again: Scoring</title>
<para>
Especially for Usenet, people often ask for advanced filtering
and scoring functionality. Of course, mutt-ng has scoring and
allows a killfile, too. How to use a killfile has been discussed
- in <link linkend="score-command">score-command</link>.
+ in <link linkend="command-score">Message Scoring</link>.
</para>
<para>
<para>
- <screen>
-score ~* =42</screen>
+ <muttng-doc:lstconf>
+score ~* =42</muttng-doc:lstconf>
</para>
<para>
- <screen>
-score !~* =42</screen>
+ <muttng-doc:lstconf>
+score !~* =42</muttng-doc:lstconf>
</para>
<listitem>
<para>
- Email addresses must be valid according to RFC 2822, see
- <ulink
- URL="ftp://ftp.rfc-editor.org/in-notes/rfc2822.txt"><ftp://ftp.rfc-editor.org/in-notes/rfc2822.txt>
- </ulink>
+ Email addresses must be valid according to <muttng-doc:rfc num="2822"/>
</para>
</listitem>
<listitem>
</sect1>
- <sect1>
- <title>SMTP Support (OPTIONAL) </title>
+ <sect1 id="smtp">
+ <title>SMTP Support (OPTIONAL)</title>
<para>
Mutt-ng can be built using a library called ``libESMTP'' which
provides SMTP functionality. When <literal>configure</literal> was
called with
<literal>--with-libesmtp</literal> or the output <literal>muttng -v</literal> contains
- <literal>+USE_LIBESMTP</literal>, this will be or is the case
+ <literal>+USE_LIBESMTP</literal>, this will be or is the case
already. The SMTP
- support includes support for Delivery Status Notification (see <link linkend="dsn">
- dsn
- </link>
- section) as well as
- handling the <literal>8BITMIME</literal> flag controlled via <link linkend="use-8bitmime">
- use-8bitmime
- </link>
- .
+ support includes support for Delivery Status Notification
+ (see <link linkend="dsn">dsn</link> section) as well as
+ handling the <literal>8BITMIME</literal> flag controlled via
+ <muttng-doc:varref name="use-8bitmime"/>.
</para>
<para>
To enable sending mail directly via SMTP without an MTA such as
- Postfix or SSMTP and the like, simply set the <link linkend="smtp-host">
- smtp-host
- </link>
+ Postfix or SSMTP and the like, simply set the <muttng-doc:varref name="smtp-host"/>
variable pointing to your SMTP server.
</para>
<para>
- Authentication mechanisms are available via the <link linkend="smtp-user">
- smtp-user
- </link>
- and <link linkend="smtp-pass">smtp-pass</link> variables.
+ Authentication mechanisms are available via the <muttng-doc:varref name="smtp-user"/>
+ and <muttng-doc:varref name="smtp-pass"/> variables.
</para>
<para>
Transport Encryption via the StartTLS command is also available. For
this to work, first of all Mutt-ng must be built with SSL or GNUTLS.
- Secondly, the <link linkend="smtp-use-tls">smtp-use-tls</link> variable
+ Secondly, the <muttng-doc:varref name="smtp-use-tls"/> variable
must be either set
to ``enabled'' or ``required.'' In both cases, StartTLS will be used if
the server supports it: for the second case, the connection will fail
sender, i.e. they allow for only one value which may not be what the
user wants to send as the <literal>From:</literal> header. In this
case, the variable
- <link linkend="smtp-envelope">smtp-envelope</link> may be used
+ <muttng-doc:varref name="smtp-envelope"/> may be used
to set the envelope different from the <literal>From:</literal> header.
</para>
</sect1>
<sect1 id="account-hook">
- <title>Managing multiple IMAP/POP/NNTP accounts (OPTIONAL) </title>
+ <title>Managing multiple IMAP/POP/NNTP 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
+ error-prone. The <muttng-doc:hook name="account"/> command may help. This hook works like
+ <muttng-doc:hook name="folder"/> but is invoked whenever you access a remote mailbox
(including inside the folder browser), not just when you open the
mailbox.
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
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"'</screen>
+account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'</muttng-doc:lstconf>
</para>
</sect1>
<sect1 id="urlview">
- <title>Start a WWW Browser on URLs (EXTERNAL) </title>
+ <title>Start a WWW Browser on URLs (EXTERNAL)</title>
<para>
If a message contains URLs (<emphasis>unified resource locator</emphasis> = address in the
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 <ulink URL="ftp://ftp.mutt.org/mutt/contrib/">ftp://ftp.mutt.org/mutt/contrib/</ulink>
->
+ retrieved at <muttng-doc:web url="ftp://ftp.mutt.org/mutt/contrib/"/>
and the configuration commands:
- <screen>
+ <muttng-doc:lstconf>
macro index \cb |urlview\n
-macro pager \cb |urlview\n</screen>
+macro pager \cb |urlview\n</muttng-doc:lstconf>
</para>
</sect1>
- <sect1>
- <title>Compressed folders Support (OPTIONAL) </title>
+ <sect1 id="compressed-folders">
+ <title>Compressed folders Support (OPTIONAL)</title>
<para>
If Mutt-ng was compiled with compressed folders support (by running the
</para>
<para>
- There are three hooks defined (<link linkend="open-hook">open-hook</link>,
- <link linkend="close-hook">close-hook</link> and <link linkend="append-hook">
- append-hook
- </link>
+ There are three hooks defined (<muttng-doc:hook name="open"/>,
+ <muttng-doc:hook name="close"/> and <muttng-doc:hook name="append"/>
)which define commands to uncompress and compress
a folder and to append messages to an existing compressed folder
respectively.
<para>
- <screen>
-open-hook \\.gz$ "gzip -cd %f > %t"
-close-hook \\.gz$ "gzip -c %t > %f"
-append-hook \\.gz$ "gzip -c %t >> %f" </screen>
+ <muttng-doc:lstconf>
+open-hook \\.gz$ "gzip -cd %f > %t"
+close-hook \\.gz$ "gzip -c %t > %f"
+append-hook \\.gz$ "gzip -c %t >> %f" </muttng-doc:lstconf>
</para>
<para>
- You do not have to specify all of the commands. If you omit <link linkend="append-hook">
- append-hook
- </link>
+ You do not have to specify all of the commands. If you omit <muttng-doc:hook name="append"/>
,the folder will be open and
- closed again each time you will add to it. If you omit <link linkend="close-hook">
- close-hook
- </link>
+ closed again each time you will add to it. If you omit <muttng-doc:hook name="close"/>
(or give empty command) , the
- folder will be open in the mode. If you specify <link linkend="append-hook">
- append-hook
- </link>
+ folder will be open in the mode. If you specify <muttng-doc:hook name="append"/>
though you'll be able to append
to the folder.
</para>
supposes it is not compressed. This is important because it allows the
use of programs that do not have well defined extensions. Just use
"." as a regexp. But this may be surprising if your
- compressing script produces empty files. In this situation, unset <link linkend="save-empty">
- save-empty
- </link>
+ compressing script produces empty files. In this situation, unset
+ <muttng-doc:varref name="save-empty"/>
,so that the compressed file
will be removed if you delete all of the messages.
</para>
<title>Open a compressed mailbox for reading</title>
<para>
- Usage: <literal>open-hook</literal> <emphasis>regexp</emphasis>
- "<emphasis>command</emphasis>"
+ Usage: <muttng-doc:hook name="open"/> <emphasis>regexp</emphasis> "<emphasis>command</emphasis>"
</para>
<para>
<para>
The <emphasis>command</emphasis> string is the printf-like format
string, and it
- should accept two parameters: %f, which is replaced with the
- (compressed) folder name, and %t which is replaced with the
+ should accept two parameters: %f, which is replaced with the
+ (compressed) folder name, and %t which is replaced with the
name of the temporary folder to which to write.
</para>
<para>
- %f and %t can be repeated any number of times in the
+ %f and %t can be repeated any number of times in the
command string, and all of the entries are replaced with the
- appropriate folder name. In addition, %% is replaced by
- %, as in printf, and any other %anything is left as is.
+ appropriate folder name. In addition, %% is replaced by
+ %, as in printf, and any other %anything is left as is.
</para>
<para>
<para>
- <screen>
-open-hook \\.gz$ "gzip -cd %f > %t"
-</screen>
+ <muttng-doc:lstconf>
+open-hook \\.gz$ "gzip -cd %f > %t"</muttng-doc:lstconf>
</para>
<title>Write a compressed mailbox</title>
<para>
- Usage: <literal>close-hook</literal> <emphasis>regexp</emphasis>
- "<emphasis>command</emphasis>"
+ Usage: <muttng-doc:hook name="close"/> <emphasis>regexp</emphasis>"<emphasis>command</emphasis>"
</para>
<para>
- This is used to close the folder that was open with the <link linkend="open-hook">
- open-hook
- </link>
+ This is used to close the folder that was open with the <muttng-doc:hook name="open"/>
command after some changes were made to it.
</para>
used for closing the
folders whose names match <emphasis>regexp</emphasis>. It has the
same format as in
- the <link linkend="open-hook">open-hook</link> command. Temporary
+ the <muttng-doc:hook name="open"/> command. Temporary
folder
- in this case is the folder previously produced by the <<link linkend="open-hook">
- open-hook
- </link>
+ in this case is the folder previously produced by the <muttng-doc:hook name="open"/>
command.
</para>
<para>
- <screen>
-close-hook \\.gz$ "gzip -c %t > %f"</screen>
+ <muttng-doc:lstconf>
+close-hook \\.gz$ "gzip -c %t > %f"</muttng-doc:lstconf>
</para>
</para>
<para>
- <link linkend="close-hook">close-hook</link> is not called when you
+ <muttng-doc:hook name="close"/> is not called when you
exit
from the folder if the folder was not changed.
</para>
<title>Append a message to a compressed mailbox</title>
<para>
- Usage: <literal>append-hook</literal> <emphasis>regexp</emphasis>
- "<emphasis>command</emphasis>"
+ Usage: <muttng-doc:hook name="append"/> <emphasis>regexp</emphasis>"<emphasis>command</emphasis>"
</para>
<para>
appending to the
folders whose names match <emphasis>regexp</emphasis>. It has the
same format as in
- the <link linkend="open-hook">open-hook</link> command.
+ the <muttng-doc:hook name="open"/> command.
The temporary folder in this case contains the messages that are
beingappended.
</para>
<para>
- <screen>
-append-hook \\.gz$ "gzip -c %t >> %f" </screen>
+ <muttng-doc:lstconf>
+append-hook \\.gz$ "gzip -c %t >> %f" </muttng-doc:lstconf>
</para>
<para>
- When <link linkend="append-hook">append-hook</link> is used, the
+ When <muttng-doc:hook name="append"/> is used, the
folder is
not opened, which saves time, but this means that we can not find out
- what the folder type is. Thus the default (<link linkend="mbox-type">
- mbox-type
- </link>
+ what the folder type is. Thus the default (<muttng-doc:varref name="mbox-type"/>
)type is always supposed (i.e.
this is the format used for the temporary folder).
</para>
<para>
- If the file does not exist when you save to it, <link linkend="close-hook">
- close-hook
- </link>
- is called, and not <link linkend="append-hook">append-hook</link>. <link linkend="append-hook">
- append-hook
- </link>
+ If the file does not exist when you save to it, <muttng-doc:hook name="close"/>
+ is called, and not <muttng-doc:hook name="append"/>. <muttng-doc:hook name="append"/>
is only
for appending to existing folders.
</para>
If the <emphasis>command</emphasis> is empty, this operation is
disabled for this file
type. In this case, the folder will be open and closed again (using
- <link linkend="open-hook">open-hook</link> and <link linkend="close-hook">
- close-hook
- </link>
+ <muttng-doc:hook name="open"/> and <muttng-doc:hook name="close"/>
respectively) each time you will add to it.
</para>
</sect2>
- <sect2>
+ <sect2 id="encrypted-folders">
<title>Encrypted folders</title>
<para>
<para>
- <screen>
-open-hook \\.pgp$ "pgp -f < %f > %t"
-close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId < %t > %f"
-</screen>
+ <muttng-doc:lstconf>
+open-hook \\.pgp$ "pgp -f < %f > %t"
+close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId < %t > %f"</muttng-doc:lstconf>
</para>
<para>
Please note, that PGP does not support appending to an encrypted
- folder, so there is no append-hook defined.
+ folder, so there is no <muttng-doc:hook name="append"/> defined.
</para>
<para>
</sect1>
</chapter>
+ <!--}}}-->
- <chapter>
- <title>Mutt-ng's MIME Support </title>
+ <chapter id="mime-support"> <!--{{{-->
+ <title>Mutt-ng's MIME Support</title>
<para>
Quite a bit of effort has been made to make Mutt-ng the premier text-mode
the external commands to use for handling specific MIME types.
</para>
- <sect1>
- <title>Using MIME in Mutt </title>
+ <sect1 id="mime">
+ <title>Using MIME in Mutt</title>
<para>
There are three areas/menus in Mutt-ng which deal with MIME, they are
menu.
</para>
- <sect2>
+ <sect2 id="mime-view">
<title>Viewing MIME messages in the pager</title>
<para>
<para>
Finally, you can apply the usual message-related functions (like
- <link linkend="resend-message">resend-message</link>, and the reply
+ <muttng-doc:funcref name="resend-message"/>, and the reply
and forward functions) to attachments of type <literal>message/rfc822</literal>.
</para>
Attachments appear as follows:
<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>
+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>
<literal>toggle-unlink</literal> command (default: u). The next
field is the MIME
content-type, and can be changed with the <literal>edit-type</literal> command
- (default: ˆT). The next field is the encoding for the
+ (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 <literal>edit-encoding</literal>
command
- (default: ˆE). The next field is the size of the attachment,
+ (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 <literal>rename-file</literal> command
(default: R).
</sect1>
- <sect1>
+ <sect1 id="mime-types">
<title>
MIME Type configuration with <literal>mime.types</literal>
</title>
<para>
When you add an attachment to your mail message, Mutt-ng searches your
- personal mime.types file at <literal>
- ${HOME}/.mime.types
- </literal>
- ,and then
+ personal mime.types file within <muttng-doc:envvar name="HOME"/> and then
the system mime.types file at <literal>/usr/local/share/mutt/mime.types</literal> or
<literal>/etc/mime.types</literal>
</para>
type that Mutt-ng assigns to an attachment by using the <literal>
edit-type
</literal>
- command from the compose menu (default: ˆT). The MIME type is
+ 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
</sect1>
- <sect1>
+ <sect1 id="mime-mailcap">
<title>
MIME Viewer configuration with <literal>mailcap</literal>
</title>
<para>
- Mutt-ng supports RFC 1524 MIME Configuration, in particular the Unix
- specific format specified in Appendix A of RFC 1524. This file format
+ Mutt-ng supports <muttng-doc:rfc num="1524"/> MIME Configuration, in particular the Unix
+ specific format specified in Appendix A of the RfC. 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
<screen>
${HOME}/.mailcap:/usr/local/share/mutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap</screen>
- where <literal>$HOME</literal> is your home directory.
+ where <muttng-doc:envvar name="HOME"/> is your home directory.
</para>
<para>
entries.
</para>
- <sect2>
+ <sect2 id="mime-mailcap-basics">
<title>The Basics of the mailcap file</title>
<para>
</para>
<para>
- A comment line consists of a # character followed by anything you
+ A comment line consists of a # character followed by anything you
want.
</para>
The content type is specified in the MIME standard type/subtype
method.
For example,
- <literal>text/plain, text/html, image/gif, </literal>
+ <literal>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
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
- this behavior by using %s as a parameter to your view command.
+ this behavior by using %s as a parameter to your view command.
This will cause Mutt-ng to save the body of the MIME message to a
temporary
- file, and then call the view command with the %s replaced by
+ file, and then call the view command with the %s replaced by
the name of the temporary file. In both cases, Mutt-ng will turn over
the
terminal to the view program until the program quits, at which time
text/html; lynx %s</screen>
In this case, lynx does not support viewing a file from stdin, so you
- must use the %s syntax.
+ must use the %s syntax.
<emphasis role="bold">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
</sect2>
- <sect2>
+ <sect2 id="mime-mailcap-security">
<title>Secure use of mailcap</title>
<para>
parameters
can lead to security problems in general. Mutt-ng tries to quote
parameters
- in expansion of %s syntaxes properly, and avoids risky
+ in expansion of %s syntaxes properly, and avoids risky
characters by
- substituting them, see the <link linkend="mailcap-sanitize">
- mailcap-sanitize
- </link>
+ substituting them, see the <muttng-doc:varref name="mailcap-sanitize"/>
variable.
</para>
</para>
<para>
- <emphasis>Keep the %-expandos away from shell quoting.</emphasis>
+ <emphasis>Keep the %-expandos away from shell quoting.</emphasis>
Don't quote them with single or double quotes. Mutt-ng 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
</para>
<para>
- If you have to use the %-expandos' values in context where you
+ 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 <literal>$charset</literal> inside the backtick
+ example (using <literal>$charset</literal> inside the backtick
expansion is safe,
since it is not itself subject to any further expansion):
</para>
</sect2>
- <sect2>
+ <sect2 id="mime-mailcap-advanced">
<title>Advanced mailcap Usage</title>
- <sect3>
+ <sect3 id="mime-mailcap-advanced-fields">
<title>Optional Fields</title>
<para>
<term>needsterminal</term>
<listitem>
<para>
- Mutt-ng uses this flag when viewing attachments with <link linkend="auto-view">
- auto-view
- </link>
- ,in order to decide whether it should honor the setting
- of the <link linkend="wait-key">wait-key</link> variable or
+ Mutt-ng uses this flag when viewing attachments with <muttng-doc:cmdref name="auto_view"/>,
+ in order to decide whether it should honor the setting
+ of the <muttng-doc:varref name="wait-key"/> variable or
not. When an attachment is viewed using an interactive
program, and the
corresponding mailcap entry has a <emphasis>needsterminal</emphasis> flag, Mutt-ng will use
- <link linkend="wait-key">wait-key</link> and the exit
+ <muttng-doc:varref name="wait-key"/> and the exit
statusof the program to decide if it will ask you to press
a key after the
external program has exited. In all other situations it
<listitem>
<para>
This field specifies the format for the file denoted by
- %s in the
+ %s in the
command fields. Certain programs will require a certain
file extension,
for instance, to correctly view a file. For instance, lynx
</sect3>
- <sect3>
+ <sect3 id="mime-mailcap-advanced-searchorder">
<title>Search Order</title>
<para>
</para>
<para>
- In addition, you can use this with <link linkend="auto-view">
- auto-view
- </link>
+ In addition, you can use this with <muttng-doc:cmdref name="auto_view"/>
to denote two commands for viewing an attachment, one to be viewed
automatically, the other to be viewed interactively from the
attachment
text/html; lynx %s; nametemplate=%s.html
text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput</screen>
- For <link linkend="auto-view">auto-view</link>, Mutt-ng will choose
+ For <muttng-doc:cmdref name="auto_view"/>, Mutt-ng will choose
the third
entry because of the copiousoutput tag. For interactive viewing,
Mutt
</sect3>
- <sect3>
+ <sect3 id="mime-mailcap-advanced-expansion">
<title>Command Expansion</title>
<para>
<variablelist>
<varlistentry>
- <term>%s</term>
+ <term>%s</term>
<listitem>
<para>
As seen in the basic mailcap section, this variable is
</listitem>
</varlistentry>
<varlistentry>
- <term>%t</term>
+ <term>%t</term>
<listitem>
<para>
- Mutt-ng will expand %t to the text representation of
+ Mutt-ng will expand %t to the text representation of
the content
type of the message in the same form as the first parameter
of the
</listitem>
</varlistentry>
<varlistentry>
- <term>%{<parameter>}</term>
+ <term>%{<parameter>}</term>
<listitem>
<para>
Mutt-ng will expand this to the value of the specified
instance, if
Your mail message contains:
- <screen>
-Content-Type: text/plain; charset=iso-8859-1</screen>
+ <muttng-doc:lstmail>
+Content-Type: text/plain; charset=iso-8859-1</muttng-doc:lstmail>
- then Mutt-ng will expand %{charset} to
+ then Mutt-ng will expand %{charset} to
iso-8859-1. The default metamail
mailcap file uses this feature to test the charset to spawn
an xterm
</listitem>
</varlistentry>
<varlistentry>
- <term>\%</term>
+ <term>\%</term>
<listitem>
<para>
- This will be replaced by a %
+ This will be replaced by a %
</para>
</listitem>
</varlistentry>
</variablelist>
- Mutt-ng does not currently support the %F and %n
+ Mutt-ng does not currently support the %F and %n
keywords
- specified in RFC 1524. The main purpose of these parameters is for
+ specified in <muttng-doc:rfc num="1524"/>. The main purpose of these parameters is for
multipart messages, which is handled internally by Mutt-ng.
</para>
</sect2>
- <sect2>
+ <sect2 id="mime-mailcap-examples">
<title>Example mailcap files</title>
<para>
<screen>>
# 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)'</screen>
<screen>
# 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
image/*;xv %s; test=RunningX; edit=xpaint %s
# Convert images to text using the netpbm tools
-image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
-pbmtoascii -1x2 ) 2>&1 ; copiousoutput
+image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | \
+pgmtopbm | pbmtoascii -1x2 ) 2>&1 ; copiousoutput
# Send excel spreadsheets to my NT box
application/ms-excel; open.pl %s</screen>
</sect1>
- <sect1 id="auto-view">
- <title>MIME Autoview </title>
-
+ <sect1>
+ <title>MIME Autoview</title>
+
+ <para>
+ <muttng-doc:cmddef name="auto_view">mime-type [mime-type ...]</muttng-doc:cmddef>
+ </para>
+
+ <para>
+ <muttng-doc:cmddef name="unauto_view">mime-type [mime-type ...]</muttng-doc:cmddef>
+ </para>
+
<para>
In addition to explicitly telling Mutt-ng to view an attachment with
theMIME viewer defined in the mailcap file, Mutt-ng has support for
</para>
<para>
- You then use the <literal>auto_view</literal> muttrc command to
+ You then use the <literal>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:
+ For instance, if you set auto_view to:
- <screen>
+ <muttng-doc:lstconf>
auto_view text/html application/x-gunzip application/postscript
-image/gif application/x-tar-gz</screen>
+image/gif application/x-tar-gz</muttng-doc:lstconf>
</para>
</para>
<para>
- ``unauto_view'' can be used to remove previous entries from the
+ ``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,
+ This can be used with <muttng-doc:hook name="message"/> to autoview messages based on size,
etc.
- ``unauto_view *'' will remove all previous entries.
+ ``unauto_view *'' will remove all previous entries.
</para>
<para>
</sect1>
- <sect1 id="alternative-order">
- <title>MIME Multipart/Alternative </title>
+ <sect1>
+ <title>MIME Multipart/Alternative</title>
+
+ <para>
+ <muttng-doc:cmddef name="alternative_order">mime-type [mime-type ...]</muttng-doc:cmddef>
+ </para>
+ <para>
+ <muttng-doc:cmddef name="unalternative_order">mime-type [mime-type ...]</muttng-doc:cmddef>
+ </para>
+
<para>
Mutt-ng 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
- typesis preferred. The alternative_order list consists of a
+ alternative_order list to determine if one of the available
+ typesis preferred. The alternative_order list consists of a
number of
MIME types in order, including support for implicit and explicit
wildcards, for example:
-
- <screen>
+
+ <muttng-doc:lstconf>
alternative_order text/enriched text/plain text
-application/postscript image/*</screen>
+application/postscript image/*</muttng-doc:lstconf>
</para>
<para>
Next, mutt will check if any of the types have a defined
- <link linkend="auto-view">auto-view</link>, and use that. Failing
+ <muttng-doc:cmdref name="auto_view"/>, and use that. Failing
that, Mutt-ng will look for any text type. As a last attempt, mutt
willlook for any type it knows how to handle.
</para>
<para>
- To remove a MIME type from the <literal>alternative_order</literal> list, use the
- <literal>unalternative_order</literal> command.
+ To remove a MIME type from the <literal>alternative_order</literal> list, use the
+ <literal>unalternative_order</literal> command.
</para>
<para>
</para>
</sect1>
-
- <sect1 id="mime-lookup">
- <title>MIME Lookup </title>
-
+
+ <sect1 id="attachments">
+ <title>Attachment Searching and Counting</title>
+
<para>
- Mutt-ng's mime_lookup list specifies a list of mime-types that
+ If you ever lose track of attachments in your mailboxes, Mutt's
+ attachment-counting and -searching support might be for you. You
+ can make your message index display the number of qualifying
+ attachments in each message, or search for messages by
+ attachment count. You also can configure what kinds of
+ attachments qualify for this feature with the attachments and
+ unattachments commands.
+ </para>
+
+<para>
+The syntax is:
+</para>
+
+<para>
+ <muttng-doc:cmddef name="attachments">
+ ( {+|-}disposition mime-type | ? )
+ </muttng-doc:cmddef>
+</para>
+<para>
+ <muttng-doc:cmddef name="unattachments">
+ {+|-}disposition mime-type
+ </muttng-doc:cmddef>
+</para>
+
+<para>
+Disposition is the attachment's Content-disposition type -- either
+"inline" or "attachment". You can abbreviate this to I or A.
+</para>
+
+<para>
+Disposition is prefixed by either a + symbolor a - symbol. If it's
+a +, you're saying that you want to allow this disposition and MIME
+type to qualify. If it's a -, you're saying that this disposition
+and MIME type is an exception to previous + rules. There are examples
+below of how this is useful.
+</para>
+
+<para>
+Mime-type is, unsurprisingly, the MIME type of the attachment you want
+to affect. A MIME type is always of the format "major/minor", where
+"major" describes the broad category of document you're looking at, and
+"minor" describes the specific type within that category. The major
+part of mim-type must be literal text (or the special token "*"), but
+the minor part may be a regular expression. (Therefore, "*/.*" matches
+any MIME type.)
+</para>
+
+<para>
+The MIME types you give to the attachments directive are a kind of
+pattern. When you use the attachments directive, the patterns you
+specify are added to a list. When you use unattachments, the pattern
+is removed from the list. The patterns are not expanded and matched
+to specific MIME types at this time -- they're just text in a list.
+They're only matched when actually evaluating a message.
+</para>
+
+<para>
+Some examples might help to illustrate. The examples that are not
+commented out define the default configuration of the lists.
+</para>
+
+<screen>
+## Removing a pattern from a list removes that pattern literally. It
+## does not remove any type matching the pattern.
+##
+## attachments +A */.*
+## attachments +A image/jpeg
+## unattachments +A */.*
+##
+## This leaves "attached" image/jpeg files on the allowed attachments
+## list. It does not remove all items, as you might expect, because the
+## second */.* is not a matching expression at this time.
+##
+## Remember: "unattachments" only undoes what "attachments" has done!
+## It does not trigger any matching on actual messages.
+
+
+## Qualify any MIME part with an "attachment" disposition, EXCEPT for
+## text/x-vcard and application/pgp parts. (PGP parts are already known
+## to mutt, and can be searched for with ~g, ~G, and ~k.)
+##
+## I've added x-pkcs7 to this, since it functions (for S/MIME)
+## analogously to PGP signature attachments. S/MIME isn't supported
+## in a stock mutt build, but we can still treat it specially here.
+##
+attachments +A */.*
+attachments -A text/x-vcard application/pgp.*
+attachments -A application/x-pkcs7-.*
+
+## Discount all MIME parts with an "inline" disposition, unless they're
+## text/plain. (Why inline a text/plain part unless it's external to the
+## message flow?)
+##
+attachments +I text/plain
+
+## These two lines make Mutt qualify MIME containers. (So, for example,
+## a message/rfc822 forward will count as an attachment.) The first
+## line is unnecessary if you already have "attach-allow */.*", of
+## course. These are off by default! The MIME elements contained
+## within a message/* or multipart/* are still examined, even if the
+## containers themseves don't qualify.
+##
+#attachments +A message/.* multipart/.*
+#attachments +I message/.* multipart/.*
+
+## You probably don't really care to know about deleted attachments.
+attachments -A message/external-body
+attachments -I message/external-body
+</screen>
+
+<para>
+"attachments ?" will list your current settings in Muttrc format, so
+that it can be pasted elsewhere.
+</para>
+
+</sect1>
+
+ <sect1>
+ <title>MIME Lookup</title>
+
+ <para>
+ <muttng-doc:cmddef name="mime_lookup">mime-type [mime-type ...]</muttng-doc:cmddef>
+ </para>
+
+ <para>
+ <muttng-doc:cmddef name="unmime_lookup">mime-type [mime-type ...]</muttng-doc:cmddef>
+ </para>
+
+ <para>
+ Mutt-ng's mime_lookup list specifies a list of mime-types that
should not
be treated according to their mailcap entry. This option is designed
todeal with binary types such as application/octet-stream. When an
attachment's
- mime-type is listed in mime_lookup, then the extension of the
+ mime-type is listed in mime_lookup, then the extension of the
filename will
be compared to the list of extensions in the mime.types file. The
mime-type
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:
+ options (such as auto_view) specified. Common usage would be:
- <screen>
-mime_lookup application/octet-stream application/X-Lotus-Manuscript</screen>
+ <muttng-doc:lstconf>
+mime_lookup application/octet-stream application/X-Lotus-Manuscript</muttng-doc:lstconf>
</para>
<para>
- In addition, the unmime_lookup command may be used to disable
+ 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
</sect1>
</chapter>
+ <!--}}}-->
- <chapter>
- <title>Security Considerations </title>
+ <chapter id="security"> <!--{{{-->
+ <title>Security Considerations</title>
<para>
First of all, mutt-ng contains no security holes included by
of setup, please read this chapter carefully.
</para>
- <sect1>
- <title>Passwords </title>
+ <sect1 id="security-passwords">
+ <title>Passwords</title>
<para>
Although mutt-ng can be told the various passwords for accounts,
</sect1>
- <sect1>
- <title>Temporary Files </title>
+ <sect1 id="security-tempfiles">
+ <title>Temporary Files</title>
<para>
Mutt-ng uses many temporary files for viewing messages, verifying
- digital signatures, etc. The <link linkend="umask">umask</link>
+ digital signatures, etc. The <muttng-doc:varref name="umask"/>
variable can be used to change the default permissions of these
files. Please only change it if you really know what you are doing.
Also, a different location for these files may be desired which can
- be changed via the <link linkend="tmpdir">tmpdir</link> variable.
+ be changed via the <muttng-doc:varref name="tmpdir"/> variable.
</para>
</sect1>
- <sect1>
- <title>Information Leaks </title>
+ <sect1 id="security-leaks">
+ <title>Information Leaks</title>
- <sect2>
- <title>Message-ID: headers </title>
+ <sect2 id="security-leaks-mid">
+ <title>Message-ID: headers</title>
<para>
In the default configuration, mutt-ng will leak some information
is increased
(and rotated) with every message sent. If you'd like to hide this
information probably telling others how many mail you sent in which
- time, you at least need to remove the <literal>%P</literal>
+ time, you at least need to remove the <literal>%P</literal>
expando from the
- default setting of the <link linkend="msgid-format">msgid-format</link> variable. Please make sure that
+ default setting of the <muttng-doc:varref name="msgid-format"/> variable. Please make sure that
you really know how local parts of these <literal>Message-ID:</literal> headers
are composed.
</para>
</sect2>
- <sect2>
- <title>mailto:-style links </title>
+ <sect2 id="security-leaks-mailto">
+ <title>mailto:-style links</title>
<para>
As mutt-ng be can be set up to be the mail client to handle
will be strict in interpreting them which means that arbitrary
header fields can be embedded in these links which could override
existing header fields or attach arbitrary files. This may be
- problematic if the <link linkend="edit-headers">edit-headers</link>
+ problematic if the <muttng-doc:varref name="edit-headers"/>
variable is <emphasis>unset</emphasis>, i.e. the
user doesn't want to see header fields while editing the message.
</para>
</para>
<para>
- When <emphasis>unsetting</emphasis> the <link linkend="strict-mailto">
- strict-mailto
- </link>
+ When <emphasis>unsetting</emphasis> the <muttng-doc:varref name="strict-mailto"/>
variable, mutt-ng will
</para>
<listitem>
<para>
- turn on the <link linkend="edit-headers">edit-headers</link>
+ turn on the <muttng-doc:varref name="edit-headers"/>
variable by
force to let the user see all the headers
(because they still may leak information.)
</sect1>
- <sect1>
- <title>External applications </title>
+ <sect1 id="security-external">
+ <title>External applications</title>
<para>
Mutt-ng in many places has to rely on external applications or
applications.
</para>
- <sect2>
- <title>mailcap </title>
+ <sect2 id="security-external-mailcap">
+ <title>mailcap</title>
<para>
One of these is the <literal>mailcap</literal> mechanism as defined
- by RfC
- 1524. Mutt-ng can be set up to <emphasis>automatically</emphasis>
+ by <muttng-doc:rfc num="1524"/>. Mutt-ng can be set up to <emphasis>automatically</emphasis>
execute any
given utility as listed in one of the mailcap files (see the
- <link linkend="mailcap-path">mailcap-path</link>
+ <muttng-doc:varref name="mailcap-path"/>
variable for details.)
</para>
<listitem>
<para>
- leave the <link linkend="mailcap-sanitize">mailcap-sanitize</link> variable in its default
+ leave the <muttng-doc:varref name="mailcap-sanitize"/> variable in its default
state to restrict mailcap expandos to a safe set of characters
</para>
</sect2>
- <sect2>
- <title>Other </title>
+ <sect2 id="security-external-other">
+ <title>Other</title>
<para>
Besides the mailcap mechanism, mutt-ng uses a number of other
</sect1>
</chapter>
+ <!--}}}-->
- <chapter>
- <title>Reference </title>
+ <chapter id="reference"> <!--{{{-->
+ <title>Reference</title>
<sect1 id="commandline">
- <title>Command line options </title>
+ <title>Command line options</title>
<para>
Running <literal>mutt</literal> with no arguments will make Mutt-ng
<para>
- <table>
- <title>Mutt-NG Command Line Options</title>
+ <table frame="none" rowsep="1" texstr="l|l">
+ <title>Reference: Command Line Options</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
<row>
</row>
</thead>
<tbody>
- <row><entry><code>-A </code></entry><entry>expand an alias</entry></row>
- <row><entry><code>-a </code></entry><entry>attach a file to a message</entry></row>
- <row><entry><code>-b </code></entry><entry>specify a blind carbon-copy (BCC) address</entry></row>
- <row><entry><code>-c </code></entry><entry>specify a carbon-copy (Cc) address</entry></row>
- <row><entry><code>-e </code></entry><entry>specify a config command to be run after initialization files are read</entry></row>
- <row><entry><code>-f </code></entry><entry>specify a mailbox to load</entry></row>
- <row><entry><code>-F </code></entry><entry>specify an alternate file to read initialization commands</entry></row>
- <row><entry><code>-h </code></entry><entry>print help on command line options</entry></row>
- <row><entry><code>-H </code></entry><entry>specify a draft file from which to read a header and body</entry></row>
- <row><entry><code>-i </code></entry><entry>specify a file to include in a message composition</entry></row>
- <row><entry><code>-m </code></entry><entry>specify a default mailbox type</entry></row>
- <row><entry><code>-n </code></entry><entry>do not read the system Muttngrc</entry></row>
- <row><entry><code>-p </code></entry><entry>recall a postponed message</entry></row>
- <row><entry><code>-Q </code></entry><entry>query a configuration variable</entry></row>
- <row><entry><code>-R </code></entry><entry>open mailbox in read-only mode</entry></row>
- <row><entry><code>-s </code></entry><entry>specify a subject (enclose in quotes if it contains spaces)</entry></row>
- <row><entry><code>-t </code></entry><entry>dump the value of all variables to stdout</entry></row>
- <row><entry><code>-T </code></entry><entry>dump the value of all changed variables to stdout</entry></row>
- <row><entry><code>-v </code></entry><entry>show version number and compile-time definitions</entry></row>
- <row><entry><code>-x </code></entry><entry>simulate the mailx(1) compose mode</entry></row>
- <row><entry><code>-y </code></entry><entry>show a menu containing the files specified by the mailboxes command</entry></row>
- <row><entry><code>-z </code></entry><entry>exit immediately if there are no messages in the mailbox</entry></row>
- <row><entry><code>-Z </code></entry><entry>open the first folder with new message,exit immediately if none</entry></row>
+ <row>
+ <entry><literal>-A</literal></entry>
+ <entry>expand an alias</entry>
+ </row>
+ <row>
+ <entry><literal>-a</literal></entry>
+ <entry>attach a file to a message</entry>
+ </row>
+ <row>
+ <entry><literal>-b</literal></entry>
+ <entry>specify a blind carbon-copy (BCC) address</entry>
+ </row>
+ <row>
+ <entry><literal>-c</literal></entry>
+ <entry>specify a carbon-copy (Cc) address</entry>
+ </row>
+ <row>
+ <entry><literal>-e</literal></entry>
+ <entry>specify a config command to be run after initialization files are read</entry>
+ </row>
+ <row>
+ <entry><literal>-f</literal></entry>
+ <entry>specify a mailbox to load</entry>
+ </row>
+ <row>
+ <entry><literal>-F</literal></entry>
+ <entry>specify an alternate file to read initialization commands</entry>
+ </row>
+ <row>
+ <entry><literal>-h</literal></entry>
+ <entry>print help on command line options</entry>
+ </row>
+ <row>
+ <entry><literal>-H</literal></entry>
+ <entry>specify a draft file from which to read a header and body</entry>
+ </row>
+ <row>
+ <entry><literal>-i</literal></entry>
+ <entry>specify a file to include in a message composition</entry>
+ </row>
+ <row>
+ <entry><literal>-m</literal></entry>
+ <entry>specify a default mailbox type</entry>
+ </row>
+ <row>
+ <entry><literal>-n</literal></entry>
+ <entry>do not read the system Muttngrc</entry>
+ </row>
+ <row>
+ <entry><literal>-p</literal></entry>
+ <entry>recall a postponed message</entry>
+ </row>
+ <row>
+ <entry><literal>-Q</literal></entry>
+ <entry>query a configuration variable</entry>
+ </row>
+ <row>
+ <entry><literal>-R</literal></entry>
+ <entry>open mailbox in read-only mode</entry>
+ </row>
+ <row>
+ <entry><literal>-s</literal></entry>
+ <entry>specify a subject (enclose in quotes if it contains spaces)</entry>
+ </row>
+ <row>
+ <entry><literal>-t</literal></entry>
+ <entry>dump the value of all variables to stdout</entry>
+ </row>
+ <row>
+ <entry><literal>-T</literal></entry>
+ <entry>dump the value of all changed variables to stdout</entry>
+ </row>
+ <row>
+ <entry><literal>-v</literal></entry>
+ <entry>show version number and compile-time definitions</entry>
+ </row>
+ <row>
+ <entry><literal>-x</literal></entry>
+ <entry>simulate the mailx(1) compose mode</entry>
+ </row>
+ <row>
+ <entry><literal>-y</literal></entry>
+ <entry>show a menu containing the files specified by the mailboxes command</entry>
+ </row>
+ <row>
+ <entry><literal>-z</literal></entry>
+ <entry>exit immediately if there are no messages in the mailbox</entry>
+ </row>
+ <row>
+ <entry><literal>-Z</literal></entry>
+ <entry>open the first folder with new message,exit immediately if none</entry>
+ </row>
</tbody>
</tgroup>
</table>
</para>
<para>
- <literal>mutt</literal> [ -nz ] [ -F <emphasis>muttrc</emphasis> ] [ -m <emphasis>
+ <literal>mutt</literal> ] -nz ] ] -F <emphasis>muttrc</emphasis> ] ] -m <emphasis>
type
</emphasis>
- ] [ -f <emphasis>mailbox</emphasis> ]
+ ] ] -f <emphasis>mailbox</emphasis> ]
</para>
<para>
</para>
<para>
- <literal>mutt</literal> [ -n ] [ -F <emphasis>muttrc</emphasis> ] [ -a <emphasis>
+ <literal>mutt</literal> ] -n ] ] -F <emphasis>muttrc</emphasis> ] ] -a <emphasis>
file
</emphasis>
- ] [ -c <emphasis>address</emphasis> ] [ -i <emphasis>
+ ] ] -c <emphasis>address</emphasis> ] ] -i <emphasis>
filename
</emphasis>
- ] [ -s <emphasis>subject</emphasis> ] <emphasis>address</emphasis> [ <emphasis>
+ ] ] -s <emphasis>subject</emphasis> ] <emphasis>address</emphasis> ] <emphasis>
address
</emphasis>
- ... ]
+ ... ]
</para>
<para>
</para>
<para>
- <literal>mutt -s "data set for run #2"
+ <literal>mutt -s "data set for run #2"
professor@bigschool.edu
- < ˜/run2.dat
+ < ~/run2.dat
</literal>
</para>
<para>
This command will send a message to ``professor@bigschool.edu'' with a
subject
- of ``data set for run #2''. In the body of the message will be the
+ of ``data set for run #2''. In the body of the message will be the
contents
- of the file ``˜/run2.dat''.
+ of the file ``~/run2.dat''.
</para>
<para>
</sect1>
<sect1 id="patterns">
- <title>Patterns </title>
+ <title>Patterns</title>
<para>
- <table>
- <title>Patterns</title>
+ <table frame="none" rowsep="1" id="tab-patterns" texstr="l|l|l">
+ <title>Reference: Patterns</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
<row>
</row>
</thead>
<tbody>
- <row><entry><code>~A </code></entry><entry><code></code></entry><entry>all messages</entry></row>
- <row><entry><code>~b </code></entry><entry><code>EXPR </code></entry><entry>messages which contain EXPR in the message body</entry></row>
- <row><entry><code>~B </code></entry><entry><code>EXPR </code></entry><entry>messages which contain EXPR in the whole message</entry></row>
- <row><entry><code>~c </code></entry><entry><code>EXPR </code></entry><entry>messages carbon-copied to EXPR</entry></row>
- <row><entry><code>~C </code></entry><entry><code>EXPR </code></entry><entry>message is either to: or cc: EXPR</entry></row>
- <row><entry><code>~D </code></entry><entry><code></code></entry><entry>deleted messages</entry></row>
- <row><entry><code>~d </code></entry><entry><code>[MIN]-[MAX] </code></entry><entry>messages with ``date-sent'' in a Date range</entry></row>
- <row><entry><code>~E </code></entry><entry><code></code></entry><entry>expired messages</entry></row>
- <row><entry><code>~e </code></entry><entry><code>EXPR </code></entry><entry>message which contains EXPR in the ``Sender'' field</entry></row>
- <row><entry><code>~F </code></entry><entry><code></code></entry><entry>flagged messages</entry></row>
- <row><entry><code>~f </code></entry><entry><code>EXPR </code></entry><entry>messages originating from EXPR</entry></row>
- <row><entry><code>~g </code></entry><entry><code></code></entry><entry>cryptographically signed messages</entry></row>
- <row><entry><code>~G </code></entry><entry><code></code></entry><entry>cryptographically encrypted messages</entry></row>
- <row><entry><code>~H </code></entry><entry><code>EXPR </code></entry><entry>messages with a spam attribute matching EXPR</entry></row>
- <row><entry><code>~h </code></entry><entry><code>EXPR </code></entry><entry>messages which contain EXPR in the message header</entry></row>
- <row><entry><code>~k </code></entry><entry><code></code></entry><entry>message contains PGP key material</entry></row>
- <row><entry><code>~i </code></entry><entry><code>EXPR </code></entry><entry>message which match ID in the ``Message-ID'' field</entry></row>
- <row><entry><code>~L </code></entry><entry><code>EXPR </code></entry><entry>message is either originated or received by EXPR</entry></row>
- <row><entry><code>~l </code></entry><entry><code></code></entry><entry>message is addressed to a known mailing list</entry></row>
- <row><entry><code>~m </code></entry><entry><code>[MIN]-[MAX] </code></entry><entry>message in the range MIN to MAX *)</entry></row>
- <row><entry><code>~M </code></entry><entry><code></code></entry><entry>multipart messages</entry></row>
- <row><entry><code>~n </code></entry><entry><code>[MIN]-[MAX] </code></entry><entry>messages with a score in the range MIN to MAX *)</entry></row>
- <row><entry><code>~N </code></entry><entry><code></code></entry><entry>new messages</entry></row>
- <row><entry><code>~O </code></entry><entry><code></code></entry><entry>old messages</entry></row>
- <row><entry><code>~p </code></entry><entry><code></code></entry><entry>message is addressed to you (consults alternates)</entry></row>
- <row><entry><code>~P </code></entry><entry><code></code></entry><entry>message is from you (consults alternates)</entry></row>
- <row><entry><code>~Q </code></entry><entry><code></code></entry><entry>messages which have been replied to</entry></row>
- <row><entry><code>~R </code></entry><entry><code></code></entry><entry>read messages</entry></row>
- <row><entry><code>~r </code></entry><entry><code>[MIN]-[MAX] </code></entry><entry>messages with ``date-received'' in a Date range</entry></row>
- <row><entry><code>~S </code></entry><entry><code></code></entry><entry>superseded messages</entry></row>
- <row><entry><code>~s </code></entry><entry><code>EXPR </code></entry><entry>messages having EXPR in the ``Subject'' field.</entry></row>
- <row><entry><code>~T </code></entry><entry><code></code></entry><entry>tagged messages</entry></row>
- <row><entry><code>~t </code></entry><entry><code>EXPR </code></entry><entry>messages addressed to EXPR</entry></row>
- <row><entry><code>~U </code></entry><entry><code></code></entry><entry>unread messages</entry></row>
- <row><entry><code>~u </code></entry><entry><code></code></entry><entry>message is addressed to a subscribed mailing list</entry></row>
- <row><entry><code>~v </code></entry><entry><code></code></entry><entry>message is part of a collapsed thread.</entry></row>
- <row><entry><code>~V </code></entry><entry><code></code></entry><entry>cryptographically verified messages</entry></row>
- <row><entry><code>~w </code></entry><entry><code>EXPR </code></entry><entry>messages which contain EXPR in the `Newsgroups' field (if compiled with NNTP support)</entry></row>
- <row><entry><code>~x </code></entry><entry><code>EXPR </code></entry><entry>messages which contain EXPR in the `References' field</entry></row>
- <row><entry><code>~y </code></entry><entry><code>EXPR </code></entry><entry>messages which contain EXPR in the `X-Label' field</entry></row>
- <row><entry><code>~z </code></entry><entry><code>[MIN]-[MAX] </code></entry><entry>messages with a size in the range MIN to MAX *)</entry></row>
- <row><entry><code>~= </code></entry><entry><code></code></entry><entry>duplicated messages (see $duplicate_threads)</entry></row>
- <row><entry><code>~$ </code></entry><entry><code></code></entry><entry>unreferenced messages (requires threaded view)</entry></row>
- <row><entry><code>~* </code></entry><entry><code></code></entry><entry>``From'' contains realname and (syntactically) valid address (excluded are addresses matching against alternates or any alias)</entry></row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="A"/></entry>
+ <entry><literal></literal></entry>
+ <entry>all messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="b"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages which contain EXPR in the message body</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="B"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages which contain EXPR in the whole message</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="c"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages carbon-copied to EXPR</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="C"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>message is either to: or cc: EXPR</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="D"/></entry>
+ <entry><literal></literal></entry>
+ <entry>deleted messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="d"/></entry>
+ <entry><literal>[MIN]-[MAX]</literal></entry>
+ <entry>messages with ``date-sent'' in a Date range</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="E"/></entry>
+ <entry><literal></literal></entry>
+ <entry>expired messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="e"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>message which contains EXPR in the ``Sender'' field</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="F"/></entry>
+ <entry><literal></literal></entry>
+ <entry>flagged messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="f"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages originating from EXPR</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="g"/></entry>
+ <entry><literal></literal></entry>
+ <entry>cryptographically signed messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="G"/></entry>
+ <entry><literal></literal></entry>
+ <entry>cryptographically encrypted messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="H"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages with a spam attribute matching EXPR</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="h"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages which contain EXPR in the message header</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="k"/></entry>
+ <entry><literal></literal></entry>
+ <entry>message contains PGP key material</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="i"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>message which match ID in the ``Message-ID'' field</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="L"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>message is either originated or received by EXPR</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="l"/></entry>
+ <entry><literal></literal></entry>
+ <entry>message is addressed to a known mailing list</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="m"/></entry>
+ <entry><literal>[MIN]-[MAX]</literal></entry>
+ <entry>message in the range MIN to MAX *)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="M"/></entry>
+ <entry><literal></literal></entry>
+ <entry>multipart messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="n"/></entry>
+ <entry><literal>[MIN]-[MAX]</literal></entry>
+ <entry>messages with a score in the range MIN to MAX *)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="N"/></entry>
+ <entry><literal></literal></entry>
+ <entry>new messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="O"/></entry>
+ <entry><literal></literal></entry>
+ <entry>old messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="p"/></entry>
+ <entry><literal></literal></entry>
+ <entry>message is addressed to you (consults alternates)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="P"/></entry>
+ <entry><literal></literal></entry>
+ <entry>message is from you (consults alternates)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="Q"/></entry>
+ <entry><literal></literal></entry>
+ <entry>messages which have been replied to</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="R"/></entry>
+ <entry><literal></literal></entry>
+ <entry>read messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="r"/></entry>
+ <entry><literal>[MIN]-[MAX]</literal></entry>
+ <entry>messages with ``date-received'' in a Date range</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="S"/></entry>
+ <entry><literal></literal></entry>
+ <entry>superseded messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="s"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages having EXPR in the ``Subject'' field.</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="T"/></entry>
+ <entry><literal></literal></entry>
+ <entry>tagged messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="t"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages addressed to EXPR</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="U"/></entry>
+ <entry><literal></literal></entry>
+ <entry>unread messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="u"/></entry>
+ <entry><literal></literal></entry>
+ <entry>message is addressed to a subscribed mailing list</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="v"/></entry>
+ <entry><literal></literal></entry>
+ <entry>message is part of a collapsed thread.</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="V"/></entry>
+ <entry><literal></literal></entry>
+ <entry>cryptographically verified messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="w"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages which contain EXPR in the `Newsgroups' field (if compiled with NNTP support)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="x"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages which contain EXPR in the `References' field</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="X"/></entry>
+ <entry><literal>[MIN]-[MAX]</literal></entry>
+ <entry>messages with MIN to MAX attachments *)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="y"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages which contain EXPR in the `X-Label' field</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="z"/></entry>
+ <entry><literal>[MIN]-[MAX]</literal></entry>
+ <entry>messages with a size in the range MIN to MAX *)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="="/></entry>
+ <entry><literal></literal></entry>
+ <entry>duplicated messages (see $duplicate_threads)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="$"/></entry>
+ <entry><literal></literal></entry>
+ <entry>unreferenced messages (requires threaded view)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="*"/></entry>
+ <entry><literal></literal></entry>
+ <entry>``From'' contains realname and (syntactically) valid address
+ (excluded are addresses matching against alternates or any alias)</entry>
+ </row>
</tbody>
</tgroup>
</table>
<para>
Where EXPR are
- <link linkend="regexp">regexp</link>. Special attention has to be
+ <link linkend="advanced-regexp">regexp</link>. Special attention has to be
made when using regular expressions inside of patterns. Specifically,
Mutt-ng's parser for these patterns will strip one level of backslash
(\),
</para>
<para>
- *) The forms <literal><[MAX]</literal>, <literal>
- >[MIN]
- </literal>
- ,
- <literal>[MIN]-</literal> and <literal>-[MAX]</literal>
+ *) The forms <literal><[MAX]</literal>, <literal>>[MIN]</literal>,
+ <literal>[MIN]-</literal> and <literal>-[MAX]</literal>
are allowed, too.
</para>
- <para>
-
- </para>
-
</sect1>
<sect1 id="commands">
- <title>Configuration Commands </title>
+ <title>Configuration Commands</title>
<para>
The following are the commands understood by mutt.
<listitem>
<para>
- <literal>
- <link linkend="account-hook">account-hook</link>
- </literal>
- <emphasis>pattern</emphasis> <emphasis>command</emphasis>
+ <literal><muttng-doc:hook name="account"/></literal> <emphasis>pattern</emphasis> <emphasis>command</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="alias">alias</link>
- </literal>
- <emphasis>key</emphasis> <emphasis>address</emphasis> [ , <emphasis>
- address
- </emphasis>
- ,... ]
+ <literal><muttng-doc:cmdref name="alias"/></literal> <emphasis>key</emphasis> <emphasis>address</emphasis> [, <emphasis>address</emphasis>, ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="alias">alias</link>
- </literal>
- [ * | <emphasis>key</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="unalias"/></literal> [ * | <emphasis>key</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="alternates">alternates</link>
- </literal>
- <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>
- ... ]
+ <literal><muttng-doc:cmdref name="alternates"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="alternates">alternates</link>
- </literal>
- [ * | <emphasis>regexp</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="unalternates"/></literal> [ * | <emphasis>regexp</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="alternative-order">alternative-order</link>
- </literal>
- <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="alternative_order"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="alternative-order">alternative-order</link>
- </literal>
- <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="unalternative_order"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="append-hook">append-hook</link>
- </literal>
- <emphasis>regexp</emphasis> <emphasis>command</emphasis>
+ <literal><muttng-doc:hook name="append"/></literal> <emphasis>regexp</emphasis> <emphasis>command</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="auto-view">auto-view</link>
- </literal>
- <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="auto_view"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="auto-view">auto-view</link>
- </literal>
- <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="unauto_view"/></literal><emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="bind">bind</link>
- </literal>
- <emphasis>map</emphasis> <emphasis>key</emphasis> <emphasis>
- function
- </emphasis>
+ <literal><muttng-doc:cmdref name="bind"/></literal> <emphasis>map</emphasis> <emphasis>key</emphasis> <emphasis>function</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="charset-hook">charset-hook</link>
- </literal>
- <emphasis>alias</emphasis> <emphasis>charset</emphasis>
+ <literal><muttng-doc:hook name="charset"/></literal> <emphasis>alias</emphasis> <emphasis>charset</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="close-hook">close-hook</link>
- </literal>
- <emphasis>regexp</emphasis> <emphasis>command</emphasis>
+ <literal><muttng-doc:hook name="close"/></literal> <emphasis>regexp</emphasis> <emphasis>command</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="color">color</link>
- </literal>
- <emphasis>object</emphasis> <emphasis>foreground</emphasis> <emphasis>
- background
- </emphasis>
- [ <emphasis>regexp</emphasis> ]
+ <literal><muttng-doc:cmdref name="color"/></literal> <emphasis>object</emphasis> <emphasis>foreground</emphasis> <emphasis>background</emphasis> [ <emphasis>regexp</emphasis> ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="color">color</link>
- </literal>
- <emphasis>index</emphasis> <emphasis>pattern</emphasis> [ <emphasis>
- pattern
- </emphasis>
- ... ]
+ <literal><muttng-doc:cmdref name="uncolor"/></literal> <emphasis>index</emphasis> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="exec">exec</link>
- </literal>
- <emphasis>function</emphasis> [ <emphasis>function</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="exec"/></literal> <emphasis>function</emphasis> [ <emphasis>function</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="fcc-hook">fcc-hook</link>
- </literal>
- <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
+ <literal><muttng-doc:hook name="fcc"/></literal> <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="fcc-save-hook">fcc-save-hook</link>
- </literal>
- <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
+ <literal><muttng-doc:hook name="fcc-save"/></literal> <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="folder-hook">folder-hook</link>
- </literal>
- <emphasis>pattern</emphasis> <emphasis>command</emphasis>
+ <literal><muttng-doc:hook name="folder"/></literal> <emphasis>pattern</emphasis> <emphasis>command</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="hdr-order">hdr-order</link>
- </literal>
- <emphasis>header</emphasis> [ <emphasis>header</emphasis>
- ... ]
+ <literal><muttng-doc:cmdref name="hdr_order"/></literal> <emphasis>header</emphasis> [ <emphasis>header</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="hdr-order">hdr-order</link>
- </literal>
- <emphasis>header</emphasis> [ <emphasis>header</emphasis>
- ... ]
+ <literal><muttng-doc:cmdref name="unhdr_order"/></literal> <emphasis>header</emphasis> [ <emphasis>header</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="charset-hook">charset-hook</link>
- </literal>
- <emphasis>charset</emphasis> <emphasis>local-charset</emphasis>
+ <literal><muttng-doc:hook name="charset"/></literal> <emphasis>charset</emphasis> <emphasis>local-charset</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="ignore">ignore</link>
- </literal>
- <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis>
- ... ]
+ <literal><muttng-doc:cmdref name="ignore"/></literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="ignore">ignore</link>
- </literal>
- <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis>
- ... ]
+ <literal><muttng-doc:cmdref name="unignore"/></literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="lists">lists</link>
- </literal>
- <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>
- ... ]
+ <literal><muttng-doc:cmdref name="lists"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="lists">lists</link>
- </literal>
- <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>
- ... ]
+ <literal><muttng-doc:cmdref name="unlists"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="macro">macro</link>
- </literal>
- <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>
- sequence
- </emphasis>
- [ <emphasis>description</emphasis> ]
+ <literal><muttng-doc:cmdref name="macro"/></literal> <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>sequence</emphasis> [ <emphasis>description</emphasis> ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="mailboxes">mailboxes</link>
- </literal>
- <emphasis>filename</emphasis> [ <emphasis>filename</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="mailboxes"/></literal> <emphasis>filename</emphasis> [ <emphasis>filename</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="mbox-hook">mbox-hook</link>
- </literal>
- <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
+ <literal><muttng-doc:hook name="mbox"/></literal> <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="message-hook">message-hook</link>
- </literal>
- <emphasis>pattern</emphasis> <emphasis>command</emphasis>
+ <literal><muttng-doc:hook name="message"/></literal> <emphasis>pattern</emphasis> <emphasis>command</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="mime-lookup">mime-lookup</link>
- </literal>
- <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="mime_lookup"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
<literal>
- <link linkend="mime-lookup">mime-lookup</link>
- </literal>
- <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <muttng-doc:cmdref name="unmime_lookup"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="color">color</link>
- </literal>
- <emphasis>object attribute</emphasis> [ <emphasis>regexp</emphasis> ]
+ <literal><muttng-doc:cmdref name="mono"/></literal> <emphasis>object attribute</emphasis> [ <emphasis>regexp</emphasis> ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="color">color</link>
- </literal>
- <emphasis>index</emphasis> <emphasis>pattern</emphasis> [ <emphasis>
- pattern
- </emphasis>
- ... ]
+ <literal><muttng-doc:cmdref name="unmono"/></literal> <emphasis>index</emphasis> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="my-hdr">my-hdr</link>
- </literal>
- <emphasis>string</emphasis>
+ <literal><muttng-doc:cmdref name="my_hdr"/></literal> <emphasis>string</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="my-hdr">my-hdr</link>
- </literal>
- <emphasis>field</emphasis> [ <emphasis>field</emphasis> ...
- ]
+ <literal><muttng-doc:cmdref name="unmy_hdr"/></literal> <emphasis>field</emphasis> [ <emphasis>field</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="open-hook">open-hook</link>
- </literal>
- <emphasis>regexp</emphasis> <emphasis>command</emphasis>
+ <literal><muttng-doc:hook name="open"/></literal> <emphasis>regexp</emphasis> <emphasis>command</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="crypt-hook">crypt-hook</link>
- </literal>
- <emphasis>pattern</emphasis> <emphasis>key-id</emphasis>
+ <literal><muttng-doc:hook name="crypt"/></literal> <emphasis>pattern</emphasis> <emphasis>key-id</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="push">push</link>
- </literal>
- <emphasis>string</emphasis>
+ <literal><muttng-doc:cmdref name="push"/></literal> <emphasis>string</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="set">set</link>
- </literal>
- <emphasis>variable</emphasis> [<emphasis>variable</emphasis>
- ... ]
+ <literal><muttng-doc:cmdref name="reset"/> </literal><emphasis>variable</emphasis> [ <emphasis>variable</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="save-hook">save-hook</link>
- </literal>
- <emphasis>regexp</emphasis> <emphasis>filename</emphasis>
+ <literal><muttng-doc:hook name="save"/></literal> <emphasis>regexp</emphasis> <emphasis>filename</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="score-command">score-command</link>
- </literal>
- <emphasis>pattern</emphasis> <emphasis>value</emphasis>
+ <literal><muttng-doc:cmdref name="score"/> </literal> <emphasis>pattern</emphasis> <emphasis>value</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="score-command">score-command</link>
- </literal>
- <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis>
- ... ]
+ <literal><muttng-doc:cmdref name="unscore"/></literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="send-hook">send-hook</link>
- </literal>
- <emphasis>regexp</emphasis> <emphasis>command</emphasis>
+ <literal><muttng-doc:hook name="send"/></literal> <emphasis>regexp</emphasis> <emphasis>command</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="reply-hook">reply-hook</link>
- </literal>
- <emphasis>regexp</emphasis> <emphasis>command</emphasis>
+ <literal><muttng-doc:hook name="reply"/></literal> <emphasis>regexp</emphasis> <emphasis>command</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="set">set</link>
- </literal>
- [no|inv]<emphasis>variable</emphasis>[=<emphasis>
- value
- </emphasis>
- ] [ <emphasis>variable</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="set"/></literal> [no|inv]<emphasis>variable</emphasis>[ =<emphasis>value</emphasis> ] [ <emphasis>variable</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="set">set</link>
- </literal>
- <emphasis>variable</emphasis> [<emphasis>variable</emphasis>
- ... ]
+ <literal><muttng-doc:cmdref name="unset"/></literal> <emphasis>variable</emphasis> [ <emphasis>variable</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="source">source</link>
- </literal>
- <emphasis>filename</emphasis>
+ <literal><muttng-doc:cmdref name="source"/></literal> <emphasis>filename</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="spam">spam</link>
- </literal>
- <emphasis>pattern</emphasis> <emphasis>format</emphasis>
+ <literal><muttng-doc:cmdref name="spam"/></literal> <emphasis>pattern</emphasis> <emphasis>format</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="spam">spam</link>
- </literal>
- <emphasis>pattern</emphasis>
+ <literal><muttng-doc:cmdref name="nospam"/></literal> <emphasis>pattern</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="lists">lists</link>
- </literal>
- <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>
- ... ]
+ <literal><muttng-doc:cmdref name="subscribe"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="lists">lists</link>
- </literal>
- <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>
- ... ]
+ <literal><muttng-doc:cmdref name="unsubscribe"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="set">set</link>
- </literal>
- <emphasis>variable</emphasis> [<emphasis>variable</emphasis>
- ... ]
+ <literal><muttng-doc:cmdref name="toggle"/></literal> <emphasis>variable</emphasis> [ <emphasis>variable</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal>
- <link linkend="unhook">unhook</link>
- </literal>
- <emphasis>hook-type</emphasis>
+ <literal><muttng-doc:cmdref name="unhook"/></literal> <emphasis>hook-type</emphasis>
</para>
</listitem>
<para>
<anchor id="sect-obsolete"/>
- <table>
- <title>Obsolete Variables</title>
+ <table frame="none" rowsep="1" texstr="l|l">
+ <title>Reference: Obsolete Variables</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
<row>
</row>
</thead>
<tbody>
- <row><entry><code>edit_hdrs</code></entry><entry><code>edit_headers</code></entry></row>
- <row><entry><code>forw_decode</code></entry><entry><code>forward_decode</code></entry></row>
- <row><entry><code>forw_format</code></entry><entry><code>forward_format</code></entry></row>
- <row><entry><code>forw_quote</code></entry><entry><code>forward_quote</code></entry></row>
- <row><entry><code>hdr_format</code></entry><entry><code>index_format</code></entry></row>
- <row><entry><code>indent_str</code></entry><entry><code>indent_string</code></entry></row>
- <row><entry><code>mime_fwd</code></entry><entry><code>mime_forward</code></entry></row>
- <row><entry><code>msg_format</code></entry><entry><code>message_format</code></entry></row>
- <row><entry><code>pgp_autosign</code></entry><entry><code>crypt_autosign</code></entry></row>
- <row><entry><code>pgp_autoencrypt</code></entry><entry><code>crypt_autoencrypt</code></entry></row>
- <row><entry><code>pgp_replyencrypt</code></entry><entry><code>crypt_replyencrypt</code></entry></row>
- <row><entry><code>pgp_replysign</code></entry><entry><code>crypt_replysign</code></entry></row>
- <row><entry><code>pgp_replysignencrypted</code></entry><entry><code>crypt_replysignencrypted</code></entry></row>
- <row><entry><code>pgp_verify_sig</code></entry><entry><code>crypt_verify_sig</code></entry></row>
- <row><entry><code>pgp_create_traditional</code></entry><entry><code>pgp_autoinline</code></entry></row>
- <row><entry><code>pgp_auto_traditional</code></entry><entry><code>pgp_replyinline</code></entry></row>
- <row><entry><code>forw_decrypt</code></entry><entry><code>forward_decrypt</code></entry></row>
- <row><entry><code>smime_sign_as</code></entry><entry><code>smime_default_key</code></entry></row>
- <row><entry><code>post_indent_str</code></entry><entry><code>post_indent_string</code></entry></row>
- <row><entry><code>print_cmd</code></entry><entry><code>print_command</code></entry></row>
- <row><entry><code>shorten_hierarchy</code></entry><entry><code>sidebar_shorten_hierarchy</code></entry></row>
- <row><entry><code>ask_followup_to</code></entry><entry><code>nntp_ask_followup_to</code></entry></row>
- <row><entry><code>ask_x_comment_to</code></entry><entry><code>nntp_ask_x_comment_to</code></entry></row>
- <row><entry><code>catchup_newsgroup</code></entry><entry><code>nntp_catchup</code></entry></row>
- <row><entry><code>followup_to_poster</code></entry><entry><code>nntp_followup_to_poster</code></entry></row>
- <row><entry><code>group_index_format</code></entry><entry><code>nntp_group_index_format</code></entry></row>
- <row><entry><code>inews</code></entry><entry><code>nntp_inews</code></entry></row>
- <row><entry><code>mime_subject</code></entry><entry><code>nntp_mime_subject</code></entry></row>
- <row><entry><code>news_cache_dir</code></entry><entry><code>nntp_cache_dir</code></entry></row>
- <row><entry><code>news_server</code></entry><entry><code>nntp_host</code></entry></row>
- <row><entry><code>newsrc</code></entry><entry><code>nntp_newsrc</code></entry></row>
- <row><entry><code>nntp_poll</code></entry><entry><code>nntp_mail_check</code></entry></row>
- <row><entry><code>pop_checkinterval</code></entry><entry><code>pop_mail_check</code></entry></row>
- <row><entry><code>post_moderated</code></entry><entry><code>nntp_post_moderated</code></entry></row>
- <row><entry><code>save_unsubscribed</code></entry><entry><code>nntp_save_unsubscribed</code></entry></row>
- <row><entry><code>show_new_news</code></entry><entry><code>nntp_show_new_news</code></entry></row>
- <row><entry><code>show_only_unread</code></entry><entry><code>nntp_show_only_unread</code></entry></row>
- <row><entry><code>x_comment_to</code></entry><entry><code>nntp_x_comment_to</code></entry></row>
- <row><entry><code>smtp_auth_username</code></entry><entry><code>smtp_user</code></entry></row>
- <row><entry><code>smtp_auth_password</code></entry><entry><code>smtp_pass</code></entry></row>
- <row><entry><code>user_agent</code></entry><entry><code>agent_string</code></entry></row>
+ <row>
+ <entry><literal>edit_hdrs</literal></entry>
+ <entry><muttng-doc:varref name="edit-headers"/></entry>
+ </row>
+ <row>
+ <entry><literal>forw_decode</literal></entry>
+ <entry><muttng-doc:varref name="forward-decode"/></entry>
+ </row>
+ <row>
+ <entry><literal>forw_format</literal></entry>
+ <entry><muttng-doc:varref name="forward-format"/></entry>
+ </row>
+ <row>
+ <entry><literal>forw_quote</literal></entry>
+ <entry><muttng-doc:varref name="forward-quote"/></entry>
+ </row>
+ <row>
+ <entry><literal>hdr_format</literal></entry>
+ <entry><muttng-doc:varref name="index-format"/></entry>
+ </row>
+ <row>
+ <entry><literal>indent_str</literal></entry>
+ <entry><muttng-doc:varref name="indent-string"/></entry>
+ </row>
+ <row>
+ <entry><literal>mime_fwd</literal></entry>
+ <entry><muttng-doc:varref name="mime-forward"/></entry>
+ </row>
+ <row>
+ <entry><literal>msg_format</literal></entry>
+ <entry><muttng-doc:varref name="message-format"/></entry>
+ </row>
+ <row>
+ <entry><literal>pgp_autosign</literal></entry>
+ <entry><muttng-doc:varref name="crypt-autosign"/></entry>
+ </row>
+ <row>
+ <entry><literal>pgp_autoencrypt</literal></entry>
+ <entry><muttng-doc:varref name="crypt-autoencrypt"/></entry>
+ </row>
+ <row>
+ <entry><literal>pgp_replyencrypt</literal></entry>
+ <entry><muttng-doc:varref name="crypt-replyencrypt"/></entry>
+ </row>
+ <row>
+ <entry><literal>pgp_replysign</literal></entry>
+ <entry><muttng-doc:varref name="crypt-replysign"/></entry>
+ </row>
+ <row>
+ <entry><literal>pgp_replysignencrypted</literal></entry>
+ <entry><muttng-doc:varref name="crypt-replysignencrypted"/></entry>
+ </row>
+ <row>
+ <entry><literal>pgp_verify_sig</literal></entry>
+ <entry><muttng-doc:varref name="crypt-verify-sig"/></entry>
+ </row>
+ <row>
+ <entry><literal>pgp_create_traditional</literal></entry>
+ <entry><muttng-doc:varref name="pgp-autoinline"/></entry>
+ </row>
+ <row>
+ <entry><literal>pgp_auto_traditional</literal></entry>
+ <entry><muttng-doc:varref name="pgp-replyinline"/></entry>
+ </row>
+ <row>
+ <entry><literal>forw_decrypt</literal></entry>
+ <entry><muttng-doc:varref name="forward-decrypt"/></entry>
+ </row>
+ <row>
+ <entry><literal>smime_sign_as</literal></entry>
+ <entry><muttng-doc:varref name="smime-default-key"/></entry>
+ </row>
+ <row>
+ <entry><literal>post_indent_str</literal></entry>
+ <entry><muttng-doc:varref name="post-indent-string"/></entry>
+ </row>
+ <row>
+ <entry><literal>print_cmd</literal></entry>
+ <entry><muttng-doc:varref name="print-command"/></entry>
+ </row>
+ <row>
+ <entry><literal>shorten_hierarchy</literal></entry>
+ <entry><muttng-doc:varref name="sidebar-shorten-hierarchy"/></entry>
+ </row>
+ <row>
+ <entry><literal>ask_followup_to</literal></entry>
+ <entry><muttng-doc:varref name="nntp-ask-followup-to"/></entry>
+ </row>
+ <row>
+ <entry><literal>ask_x_comment_to</literal></entry>
+ <entry><muttng-doc:varref name="nntp-ask-x-comment-to"/></entry>
+ </row>
+ <row>
+ <entry><literal>catchup_newsgroup</literal></entry>
+ <entry><muttng-doc:varref name="nntp-catchup"/></entry>
+ </row>
+ <row>
+ <entry><literal>followup_to_poster</literal></entry>
+ <entry><muttng-doc:varref name="nntp-followup-to-poster"/></entry>
+ </row>
+ <row>
+ <entry><literal>group_index_format</literal></entry>
+ <entry><muttng-doc:varref name="nntp-group-index-format"/></entry>
+ </row>
+ <row>
+ <entry><literal>inews</literal></entry>
+ <entry><muttng-doc:varref name="nntp-inews"/></entry>
+ </row>
+ <row>
+ <entry><literal>mime_subject</literal></entry>
+ <entry><muttng-doc:varref name="nntp-mime-subject"/></entry>
+ </row>
+ <row>
+ <entry><literal>news_cache_dir</literal></entry>
+ <entry><muttng-doc:varref name="nntp-cache-dir"/></entry>
+ </row>
+ <row>
+ <entry><literal>news_server</literal></entry>
+ <entry><muttng-doc:varref name="nntp-host"/></entry>
+ </row>
+ <row>
+ <entry><literal>newsrc</literal></entry>
+ <entry><muttng-doc:varref name="nntp-newsrc"/></entry>
+ </row>
+ <row>
+ <entry><literal>nntp_poll</literal></entry>
+ <entry><muttng-doc:varref name="nntp-mail-check"/></entry>
+ </row>
+ <row>
+ <entry><literal>pop_checkinterval</literal></entry>
+ <entry><muttng-doc:varref name="pop-mail-check"/></entry>
+ </row>
+ <row>
+ <entry><literal>post_moderated</literal></entry>
+ <entry><muttng-doc:varref name="nntp-post-moderated"/></entry>
+ </row>
+ <row>
+ <entry><literal>save_unsubscribed</literal></entry>
+ <entry><muttng-doc:varref name="nntp-save-unsubscribed"/></entry>
+ </row>
+ <row>
+ <entry><literal>show_new_news</literal></entry>
+ <entry><muttng-doc:varref name="nntp-show-new-news"/></entry>
+ </row>
+ <row>
+ <entry><literal>show_only_unread</literal></entry>
+ <entry><muttng-doc:varref name="nntp-show-only-unread"/></entry>
+ </row>
+ <row>
+ <entry><literal>x_comment_to</literal></entry>
+ <entry><muttng-doc:varref name="nntp-x-comment-to"/></entry>
+ </row>
+ <row>
+ <entry><literal>smtp_auth_username</literal></entry>
+ <entry><muttng-doc:varref name="smtp-user"/></entry>
+ </row>
+ <row>
+ <entry><literal>smtp_auth_password</literal></entry>
+ <entry><muttng-doc:varref name="smtp-pass"/></entry>
+ </row>
+ <row>
+ <entry><literal>user_agent</literal></entry>
+ <entry><muttng-doc:varref name="agent-string"/></entry>
+ </row>
</tbody>
</tgroup>
</table>
projects / apps / madmutt.git / blobdiff