-<!-- vim:ft=sgml
--->
-<!doctype linuxdoc system>
+<?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">
<book>
-<title>The Mutt Next Generation E-Mail Client
-<author>by Andreas Krennmair <htmlurl url="mailto:ak@synflood.at" name="<ak@synflood.at>"> and others
- originally based on <em>mutt</em> by Michael Elkins <htmlurl url="mailto:me@cs.hmc.edu" name="<me@cs.hmc.edu>"> and others
-<date>version @VERSION@
+<bookinfo>
+
+<title>The Mutt Next Generation E-Mail Client</title>
+<author>
+<firstname>by Andreas Krennmair and others
+ originally based on <emphasis>mutt</emphasis> by Michael Elkins and others</firstname>
+
+<authorblurb>
+
+<para>
+<ulink URL="mailto:ak@synflood.at"><ak@synflood.at>
+</ulink>
+
+<ulink URL="mailto:me@cs.hmc.edu"><me@cs.hmc.edu>
+</ulink>
+</para>
+
+</authorblurb>
+</author>
+
+<pubdate>version devel-r473</pubdate>
+
<abstract>
-Michael Elinks on mutt, circa 1995: ``All mail clients suck.
-This one just sucks less.'' - Sven Guckes on mutt, ca. 2003: ``But it still sucks!''
+
+<para>
+Michael Elinks on mutt, circa 1995: ``All mail clients suck. This one just sucks less.'' - Sven Guckes on mutt, ca. 2003: ``But it still sucks!''
+</para>
+
</abstract>
-<toc>
+</bookinfo>
+
+<chapter> <!--{{{-->
+<title>Introduction </title>
-<chapt>Introduction <!--{{{-->
+<sect1>
+<title>Overview </title>
-<sect>Overview <!--{{{-->
-<p>
-<bf/Mutt-ng/ is a small but very powerful text-based MIME mail client. Mutt-ng is
+<para>
+<emphasis role="bold">Mutt-ng</emphasis> is a small but very powerful text-based MIME mail client. Mutt-ng is
highly configurable, and is well suited to the mail power user with advanced
features like key bindings, keyboard macros, mail threading, regular
expression searches and a powerful pattern matching language for selecting
groups of messages.
+</para>
-<p>This documentation additionally contains documentation to <bf/Mutt-NG/, a
+<para>
+This documentation additionally contains documentation to <emphasis role="bold">Mutt-NG</emphasis>, a
fork from Mutt with the goal to fix all the little annoyances of Mutt, to
integrate all the Mutt patches that are floating around in the web, and to
add other new features. Features specific to Mutt-ng will be discussed in
an extra section. Don't be confused when most of the documentation talk about
Mutt and not Mutt-ng, Mutt-ng contains all Mutt features, plus many more.
+</para>
+
+<para>
+
+</para>
+
+</sect1>
+
+<sect1>
+<title>Mutt-ng Home Page </title>
+
+<para>
+<ulink
+URL="http://www.muttng.org/"
+>http://www.muttng.org</ulink
+>
+</para>
+
+<para>
+
+</para>
+
+</sect1>
+
+<sect1>
+<title>Mailing Lists </title>
+
+<para>
-<!--}}}-->
+<itemizedlist>
+<listitem>
-<sect>Mutt-ng Home Page <!--{{{-->
-<p>
-<htmlurl url="http://www.muttng.org/"
-name="http://www.muttng.org">
+<para>
+<ulink
+URL="https://lists.berlios.de/mailman/listinfo/mutt-ng-users"
+>mutt-ng-users@lists.berlios.de</ulink
+> -- This is where the mutt-ng user support happens.
+</para>
+</listitem>
+<listitem>
-<!--}}}-->
+<para>
+<ulink
+URL="https://lists.berlios.de/mailman/listinfo/mutt-ng-devel"
+>mutt-ng-devel@lists.berlios.de</ulink
+> -- The development mailing list for mutt-ng
+</para>
+</listitem>
-<sect>Mailing Lists <!--{{{-->
-<p>
+</itemizedlist>
-<itemize>
-<item><htmlurl url="https://lists.berlios.de/mailman/listinfo/mutt-ng-users"
-name="mutt-ng-users@lists.berlios.de"> -- This is where the mutt-ng user support happens.
-<item><htmlurl url="https://lists.berlios.de/mailman/listinfo/mutt-ng-devel" name="mutt-ng-devel@lists.berlios.de"> -- The development mailing list for mutt-ng
-</itemize>
+</para>
-<!--}}}-->
+<para>
+
+</para>
+
+</sect1>
-<sect>Software Distribution Sites <!--{{{-->
-<p>
+<sect1>
+<title>Software Distribution Sites </title>
+
+<para>
So far, there are no official releases of Mutt-ng, but you can download
-daily snapshots from <htmlurl url="http://mutt-ng.berlios.de/snapshots/" name="http://mutt-ng.berlios.de/snapshots/">
+daily snapshots from <ulink
+URL="http://mutt-ng.berlios.de/snapshots/"
+>http://mutt-ng.berlios.de/snapshots/</ulink
+>
+</para>
+
+<para>
+
+</para>
+
+</sect1>
+
+<sect1>
+<title>IRC </title>
+
+<para>
+Visit channel <emphasis>#muttng</emphasis> on <ulink
+URL="http://www.freenode.net/"
+>irc.freenode.net (www.freenode.net)</ulink
+> to chat with other people interested in Mutt-ng.
+</para>
-<!--}}}-->
+<para>
+
+</para>
-<sect>IRC <!--{{{-->
-<p>
-Visit channel <em/#muttng/ on <htmlurl
-url="http://www.freenode.net/" name="irc.freenode.net
-(www.freenode.net)"> to chat with other people interested in Mutt-ng.
+</sect1>
-<!--}}}-->
+<sect1>
+<title>Weblog </title>
-<sect>Weblog <!--{{{-->
-<p>
+<para>
If you want to read fresh news about the latest development in Mutt-ng, and get informed
about stuff like interesting, Mutt-ng-related articles and packages for your favorite
distribution, you can read and/or subscribe to our
-<htmlurl url="http://mutt-ng.supersized.org/" name="Mutt-ng development weblog">.
+<ulink
+URL="http://mutt-ng.supersized.org/"
+>Mutt-ng development weblog</ulink
+>.
+</para>
+
+<para>
+
+</para>
+
+</sect1>
-<!--}}}-->
+<sect1>
+<title>Copyright </title>
-<sect>Copyright <!--{{{-->
-<p>
+<para>
Mutt is Copyright (C) 1996-2000 Michael R. Elkins
<me@cs.hmc.edu> and others
+</para>
+<para>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
+</para>
+<para>
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
+</para>
+<para>
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+</para>
-<!--}}}-->
+<para>
+
+</para>
-<!--}}}-->
+<para>
+
+</para>
-<chapt>Getting Started <!--{{{-->
+</sect1>
- <sect>Basic Concepts <!--{{{-->
+</chapter> <!--}}}-->
- <sect1>Screens and Menus <!--{{{-->
+<chapter>
+<title>Getting Started </title>
- <p>mutt-ng offers different screens of which every has its special
- purpose:
+<sect1> <!--{{{-->
+<title>Basic Concepts </title>
- <itemize>
+<sect2> <!--{{{-->
+<title>Screens and Menus </title>
- <item>The <em/index/ displays the contents of the currently opened
- mailbox.
+<para>
+mutt-ng offers different screens of which every has its special
+purpose:
+</para>
- <item>The <em/pager/ is responsible for displaying messages, that
- is, the header, the body and all attached parts.
+<para>
- <item>The <em/file browser/ offers operations on and displays
- information of all folders mutt-ng should watch for mail.
+<itemizedlist>
+<listitem>
- <item>The <em/sidebar/ offers a permanent view of which mailboxes
- contain how many total, new and/or flagged mails.
+<para>
+The <emphasis>index</emphasis> displays the contents of the currently opened
+mailbox.
- <item>The <em/help screen/ lists for all currently available
- commands how to invoke them as well as a short description.
+</para>
+</listitem>
+<listitem>
- <item>The <em/compose/ menu is a comfortable interface take last
- actions before sending mail: change subjects, attach files, remove
- attachements, etc.
+<para>
+The <emphasis>pager</emphasis> is responsible for displaying messages, that
+is, the header, the body and all attached parts.
- <item>The <em/attachement/ menu gives a summary and the tree
- structure of the attachements of the current message.
+</para>
+</listitem>
+<listitem>
- <item>The <em/alias/ menu lists all or a fraction of the aliases
- a user has defined.
+<para>
+The <emphasis>file browser</emphasis> offers operations on and displays
+information of all folders mutt-ng should watch for mail.
- <item>The <em/key/ menu used in connection with encryption lets
- users choose the right key to encrypt with.
+</para>
+</listitem>
+<listitem>
- </itemize>
+<para>
+The <emphasis>sidebar</emphasis> offers a permanent view of which mailboxes
+contain how many total, new and/or flagged mails.
- <p>When mutt-ng is started without any further options, it'll open
- the users default mailbox and display the index.
+</para>
+</listitem>
+<listitem>
- <!--}}}-->
+<para>
+The <emphasis>help screen</emphasis> lists for all currently available
+commands how to invoke them as well as a short description.
- <sect1>Configuration <!--{{{-->
+</para>
+</listitem>
+<listitem>
- <p>Mutt-ng does <em/not/ feature an internal configuration
- interface or menu due to the simple fact that this would be too
- complex to handle (currently there are several <em/hundred/
- variables which fine-tune the behaviour.)
+<para>
+The <emphasis>compose</emphasis> menu is a comfortable interface take last
+actions before sending mail: change subjects, attach files, remove
+attachements, etc.
- <p>Mutt-ng is configured using configuration files which allow
- users to add comments or manage them via version control systems
- to ease maintenance.
+</para>
+</listitem>
+<listitem>
- <p>Also, mutt-ng comes with a shell script named <tt/grml-muttng/
- kindly contributed by users which really helps and eases the
- creation of a user's configuration file. When downloading the
- source code via a snapshot or via subversion, it can be found in
- the <tt/contrib/ directory.
+<para>
+The <emphasis>attachement</emphasis> menu gives a summary and the tree
+structure of the attachements of the current message.
- <!--}}}-->
+</para>
+</listitem>
+<listitem>
- <sect1>Functions <!--{{{-->
+<para>
+The <emphasis>alias</emphasis> menu lists all or a fraction of the aliases
+a user has defined.
- <p>Mutt-ng offers great flexibility due to the use of functions:
- internally, every action a user can make mutt-ng perform is named
- ``function.'' Those functions are assigned to keys (or even key
- sequences) and may be completely adjusted to user's needs. The
- basic idea is that the impatient users get a very intuitive
- interface to start off with and advanced users virtually get no
- limits to adjustments.
+</para>
+</listitem>
+<listitem>
- <!--}}}-->
+<para>
+The <emphasis>key</emphasis> menu used in connection with encryption lets
+users choose the right key to encrypt with.
- <sect1>Interaction <!--{{{-->
+</para>
+</listitem>
- <p>Mutt-ng has two basic concepts of user interaction:
+</itemizedlist>
- <enum>
+</para>
- <item>There is one dedicated line on the screen used to query
- the user for input, issue any command, query variables and
- display error and informational messages. As for every type of
- user input, this requires manual action leading to the need of
- input.
+<para>
+When mutt-ng is started without any further options, it'll open
+the users default mailbox and display the index.
+</para>
- <item>The automatized interface for interaction are the so
- called <em/hooks/. Hooks specify actions the user wants to be
- performed at well-defined situations: what to do when entering
- which folder, what to do when displaying or replying to what
- kind of message, etc. These are optional, i.e. a user doesn't
- need to specify them but can do so.
+<para>
+
+</para>
+
+</sect2> <!--}}}-->
+
+<sect2> <!--{{{-->
+<title>Configuration </title>
+
+<para>
+Mutt-ng does <emphasis>not</emphasis> feature an internal configuration
+interface or menu due to the simple fact that this would be too
+complex to handle (currently there are several <emphasis>hundred</emphasis>
+variables which fine-tune the behaviour.)
+</para>
+
+<para>
+Mutt-ng is configured using configuration files which allow
+users to add comments or manage them via version control systems
+to ease maintenance.
+</para>
+
+<para>
+Also, mutt-ng comes with a shell script named <literal>grml-muttng</literal>
+kindly contributed by users which really helps and eases the
+creation of a user's configuration file. When downloading the
+source code via a snapshot or via subversion, it can be found in
+the <literal>contrib</literal> directory.
+</para>
+
+<para>
+
+</para>
- </enum>
+</sect2> <!--}}}-->
- <!--}}}-->
+<sect2> <!--{{{-->
+<title>Functions </title>
- <sect1>Modularization <!--{{{-->
+<para>
+Mutt-ng offers great flexibility due to the use of functions:
+internally, every action a user can make mutt-ng perform is named
+``function.'' Those functions are assigned to keys (or even key
+sequences) and may be completely adjusted to user's needs. The
+basic idea is that the impatient users get a very intuitive
+interface to start off with and advanced users virtually get no
+limits to adjustments.
+</para>
- <p>Although mutt-ng has many functionality built-in, many
- features can be delegated to external tools to increase
- flexibility: users can define programs to filter a message through
- before displaying, users can use any program they want for
- displaying a message, message types (such as PDF or PostScript)
- for which mutt-ng doesn't have a built-in filter can be rendered
- by arbitrary tools and so forth. Although mutt-ng has an alias
- mechanism built-in, it features using external tools to query for
- nearly every type of addresses from sources like LDAP, databases
- or just the list of locally known users.
+<para>
+
+</para>
- <!--}}}-->
+</sect2> <!--}}}-->
- <sect1>Patterns <!--{{{-->
+<sect2> <!--{{{-->
+<title>Interaction </title>
- <p>Mutt-ng has a built-in pattern matching ``language'' which is
- as widely used as possible to present a consistent interface to
- users. The same ``pattern terms'' can be used for searching,
- scoring, message selection and much more.
+<para>
+Mutt-ng has two basic concepts of user interaction:
+</para>
- <!--}}}-->
+<para>
- <!--}}}-->
+<orderedlist>
+<listitem>
- <sect>Screens and Menus <!--{{{-->
+<para>
+There is one dedicated line on the screen used to query
+the user for input, issue any command, query variables and
+display error and informational messages. As for every type of
+user input, this requires manual action leading to the need of
+input.
- <sect1>Index <!--{{{-->
+</para>
+</listitem>
+<listitem>
- <p>The index is the screen that you usually see first when you
- start mutt-ng. It gives an overview over your emails in the
- currently opened mailbox. By default, this is your system mailbox.
- The information you see in the index is a list of emails, each with
- its number on the left, its flags (new email, important email,
- email that has been forwarded or replied to, tagged email, ...),
- the date when email was sent, its sender, the email size, and the
- subject. Additionally, the index also shows thread hierarchies:
- when you reply to an email, and the other person replies back, you
- can see the other's person email in a "sub-tree" below. This is
- especially useful for personal email between a group of people or
- when you've subscribed to mailing lists.
+<para>
+The automatized interface for interaction are the so
+called <emphasis>hooks</emphasis>. Hooks specify actions the user wants to be
+performed at well-defined situations: what to do when entering
+which folder, what to do when displaying or replying to what
+kind of message, etc. These are optional, i.e. a user doesn't
+need to specify them but can do so.
- <!--}}}-->
+</para>
+</listitem>
- <sect1>Pager <!--{{{-->
+</orderedlist>
- <p>The pager is responsible for showing the email content. On the
- top of the pager you have an overview over the most important email
- headers like the sender, the recipient, the subject, and much more
- information. How much information you actually see depends on your
- configuration, which we'll describe below.
+</para>
- <p>Below the headers, you see the email body which usually contains
- the message. If the email contains any attachments, you will see
- more information about them below the email body, or, if the
- attachments are text files, you can view them directly in the
- pager.
+<para>
+
+</para>
+
+</sect2> <!--}}}-->
+
+<sect2> <!--{{{-->
+<title>Modularization </title>
+
+<para>
+Although mutt-ng has many functionality built-in, many
+features can be delegated to external tools to increase
+flexibility: users can define programs to filter a message through
+before displaying, users can use any program they want for
+displaying a message, message types (such as PDF or PostScript)
+for which mutt-ng doesn't have a built-in filter can be rendered
+by arbitrary tools and so forth. Although mutt-ng has an alias
+mechanism built-in, it features using external tools to query for
+nearly every type of addresses from sources like LDAP, databases
+or just the list of locally known users.
+</para>
+
+<para>
+
+</para>
- <p>To give the user a good overview, it is possible to configure
- mutt-ng to show different things in the pager with different
- colors. Virtually everything that can be described with a regular
- expression can be colored, e.g. URLs, email addresses or smileys.
+</sect2> <!--}}}-->
- <!--}}}-->
+<sect2> <!--{{{-->
+<title>Patterns </title>
- <sect1>File Browser <!--{{{-->
+<para>
+Mutt-ng has a built-in pattern matching ``language'' which is
+as widely used as possible to present a consistent interface to
+users. The same ``pattern terms'' can be used for searching,
+scoring, message selection and much more.
+</para>
- <p>The file browser is the interface to the local or remote
- file system. When selecting a mailbox to open, the browser allows
- custom sorting of items, limiting the items shown by a regular
- expression and a freely adjustable format of what to display in
- which way. It also allows for easy navigation through the
- file system when selecting file(s) to attach to a message, select
- multiple files to attach and many more.
+<para>
+
+</para>
- <!--}}}-->
+<para>
+
+</para>
- <sect1>Sidebar <!--{{{-->
+</sect2> <!--}}}-->
- <p>The sidebar comes in handy to manage mails which are spread
- over different folders. All folders users setup mutt-ng to watch
- for new mail will be listed. The listing includes not only the
- name but also the number of total messages, the number of new and
- flagged messages. Items with new mail may be colored different
- from those with flagged mail, items may be shortened or compress
- if they're they to long to be printed in full form so that by
- abbreviated names, user still now what the name stands for.
+</sect1>
- <!--}}}-->
+<!--}}}-->
- <sect1>Help <!--{{{-->
+<sect1> <!--{{{-->
+<title>Screens and Menus </title>
+
+<sect2>
+<title>Index </title>
+
+<para>
+The index is the screen that you usually see first when you
+start mutt-ng. It gives an overview over your emails in the
+currently opened mailbox. By default, this is your system mailbox.
+The information you see in the index is a list of emails, each with
+its number on the left, its flags (new email, important email,
+email that has been forwarded or replied to, tagged email, ...),
+the date when email was sent, its sender, the email size, and the
+subject. Additionally, the index also shows thread hierarchies:
+when you reply to an email, and the other person replies back, you
+can see the other's person email in a "sub-tree" below. This is
+especially useful for personal email between a group of people or
+when you've subscribed to mailing lists.
+</para>
+
+<para>
+
+</para>
+
+</sect2>
+
+<sect2>
+<title>Pager </title>
+
+<para>
+The pager is responsible for showing the email content. On the
+top of the pager you have an overview over the most important email
+headers like the sender, the recipient, the subject, and much more
+information. How much information you actually see depends on your
+configuration, which we'll describe below.
+</para>
+
+<para>
+Below the headers, you see the email body which usually contains
+the message. If the email contains any attachments, you will see
+more information about them below the email body, or, if the
+attachments are text files, you can view them directly in the
+pager.
+</para>
+
+<para>
+To give the user a good overview, it is possible to configure
+mutt-ng to show different things in the pager with different
+colors. Virtually everything that can be described with a regular
+expression can be colored, e.g. URLs, email addresses or smileys.
+</para>
+
+<para>
+
+</para>
- <p>The help screen is meant to offer a quick help to the user. It
- lists the current configuration of key bindings and their
- associated commands including a short description, and currently
- unbound functions that still need to be associated with a key
- binding (or alternatively, they can be called via the mutt-ng
- command prompt).
+</sect2>
- <!--}}}-->
+<sect2>
+<title>File Browser </title>
- <sect1>Compose Menu <!--{{{-->
+<para>
+The file browser is the interface to the local or remote
+file system. When selecting a mailbox to open, the browser allows
+custom sorting of items, limiting the items shown by a regular
+expression and a freely adjustable format of what to display in
+which way. It also allows for easy navigation through the
+file system when selecting file(s) to attach to a message, select
+multiple files to attach and many more.
+</para>
- <p>The compose menu features a split screen containing the
- information which really matter before actually sending a
- message by mail or posting an article to a newsgroup: who gets
- the message as what (recipient, newsgroup, who gets what kind of
- copy). Additionally, users may set security options like
- deciding whether to sign, encrypt or sign and encrypt a message
- with/for what keys.
+<para>
+
+</para>
- <p>Also, it's used to attach messages, news articles or files to
- a message, to re-edit any attachment including the message
- itself.
+</sect2>
- <!--}}}-->
+<sect2>
+<title>Sidebar </title>
- <sect1>Alias Menu <!--{{{-->
+<para>
+The sidebar comes in handy to manage mails which are spread
+over different folders. All folders users setup mutt-ng to watch
+for new mail will be listed. The listing includes not only the
+name but also the number of total messages, the number of new and
+flagged messages. Items with new mail may be colored different
+from those with flagged mail, items may be shortened or compress
+if they're they to long to be printed in full form so that by
+abbreviated names, user still now what the name stands for.
+</para>
- <p>The alias menu is used to help users finding the recipients
- of messages. For users who need to contact many people, there's
- no need to remember addresses or names completely because it
- allows for searching, too. The alias mechanism and thus the
- alias menu also features grouping several addresses by a shorter
- nickname, the actual alias, so that users don't have to select
- each single recipient manually.
+<para>
+
+</para>
- <!--}}}-->
+</sect2>
- <sect1>Attachment Menu <!--{{{-->
+<sect2>
+<title>Help </title>
- <p>As will be later discussed in detail, mutt-ng features a good
- and stable MIME implementation, that is, is greatly supports
- sending and receiving messages of arbitrary type. The
- attachment menu displays a message's structure in detail: what
- content parts are attached to which parent part (which gives a
- true tree structure), which type is of what type and what size.
- Single parts may saved, deleted or modified to offer great and
- easy access to message's internals.
+<para>
+The help screen is meant to offer a quick help to the user. It
+lists the current configuration of key bindings and their
+associated commands including a short description, and currently
+unbound functions that still need to be associated with a key
+binding (or alternatively, they can be called via the mutt-ng
+command prompt).
+</para>
- <!--}}}-->
+<para>
+
+</para>
+
+</sect2>
+
+<sect2>
+<title>Compose Menu </title>
+
+<para>
+The compose menu features a split screen containing the
+information which really matter before actually sending a
+message by mail or posting an article to a newsgroup: who gets
+the message as what (recipient, newsgroup, who gets what kind of
+copy). Additionally, users may set security options like
+deciding whether to sign, encrypt or sign and encrypt a message
+with/for what keys.
+</para>
+
+<para>
+Also, it's used to attach messages, news articles or files to
+a message, to re-edit any attachment including the message
+itself.
+</para>
+
+<para>
+
+</para>
+
+</sect2>
+
+<sect2>
+<title>Alias Menu </title>
+
+<para>
+The alias menu is used to help users finding the recipients
+of messages. For users who need to contact many people, there's
+no need to remember addresses or names completely because it
+allows for searching, too. The alias mechanism and thus the
+alias menu also features grouping several addresses by a shorter
+nickname, the actual alias, so that users don't have to select
+each single recipient manually.
+</para>
- <sect1>Key Menu <!--{{{-->
+<para>
+
+</para>
+
+</sect2>
- <p><tt/FIXME/
+<sect2>
+<title>Attachment Menu </title>
- <!--}}}-->
+<para>
+As will be later discussed in detail, mutt-ng features a good
+and stable MIME implementation, that is, is greatly supports
+sending and receiving messages of arbitrary type. The
+attachment menu displays a message's structure in detail: what
+content parts are attached to which parent part (which gives a
+true tree structure), which type is of what type and what size.
+Single parts may saved, deleted or modified to offer great and
+easy access to message's internals.
+</para>
+
+<para>
+
+</para>
+
+</sect2>
+
+<sect2>
+<title>Key Menu </title>
+
+<para>
+<literal>FIXME</literal>
+</para>
+
+<para>
+
+</para>
+
+<para>
+
+</para>
- <!--}}}-->
+</sect2>
-<sect>Moving Around in Menus <!--{{{-->
-<p>
+</sect1> <!--}}}-->
+<sect1> <!--{{{-->
+<title>Moving Around in Menus </title>
+
+<para>
Information is presented in menus, very similar to ELM. Here is a table
showing the common keys used to navigate menus in Mutt-ng.
+</para>
+
+<para>
-<tscreen><verb>
+<screen>
j or Down next-entry move to the next entry
k or Up previous-entry move to the previous entry
z or PageDn page-down go to the next page
* or End last-entry jump to the last entry
q quit exit the current menu
? help list all key bindings for the current menu
-</verb></tscreen>
+</screen>
+
+</para>
+
+<para>
+
+</para>
+
+</sect1> <!--}}}-->
-<!--}}}-->
+<sect1 id="editing"> <!--{{{-->
+<title>Editing Input Fields </title>
-<sect>Editing Input Fields<label id="editing"> <!--{{{-->
-<p>
+<para>
Mutt-ng has a builtin line editor which is used as the primary way to input
textual data such as email addresses or filenames. The keys used to move
around while editing are very similar to those of Emacs.
+</para>
-<tscreen><verb>
-^A or <Home> bol move to the start of the line
-^B or <Left> backward-char move back one char
+<para>
+
+<screen>
+^A or <Home> bol move to the start of the line
+^B or <Left> backward-char move back one char
Esc B backward-word move back one word
-^D or <Delete> delete-char delete the char under the cursor
-^E or <End> eol move to the end of the line
-^F or <Right> forward-char move forward one char
+^D or <Delete> delete-char delete the char under the cursor
+^E or <End> eol move to the end of the line
+^F or <Right> forward-char move forward one char
Esc F forward-word move forward one word
-<Tab> complete complete filename or alias
+<Tab> complete complete filename or alias
^T complete-query complete address with query
^K kill-eol delete to the end of the line
ESC d kill-eow delete to the end of the word
^W kill-word kill the word in front of the cursor
^U kill-line delete entire line
^V quote-char quote the next typed key
-<Up> history-up recall previous string from history
-<Down> history-down recall next string from history
-<BackSpace> backspace kill the char in front of the cursor
+<Up> history-up recall previous string from history
+<Down> history-down recall next string from history
+<BackSpace> backspace kill the char in front of the cursor
Esc u upcase-word convert word to upper case
Esc l downcase-word convert word to lower case
Esc c capitalize-word capitalize the word
^G n/a abort
-<Return> n/a finish editing
-</verb></tscreen>
+<Return> n/a finish editing
+</screen>
+
+</para>
-You can remap the <em/editor/ functions using the <ref id="bind" name="bind">
-command. For example, to make the <em/Delete/ key delete the character in
+<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
+</para>
-<tt/bind editor <delete> backspace/
+<para>
+<literal>bind editor <delete> backspace</literal>
+</para>
-<!--}}}-->
+<para>
+
+</para>
+
+</sect1> <!--}}}-->
-<sect>Reading Mail - The Index and Pager <!--{{{-->
-<p>
+<sect1>
+<title>Reading Mail - The Index and Pager </title> <!--{{{-->
+<para>
Similar to many other mail clients, there are two modes in which mail is
read in Mutt-ng. The first is the index of messages in the mailbox, which is
called the ``index'' in Mutt-ng. The second mode is the display of the
message contents. This is called the ``pager.''
+</para>
+<para>
The next few sections describe the functions provided in each of these
modes.
+</para>
-<sect1>The Message Index
-<p>
+<sect2>
+<title>The Message Index</title> <!--{{{-->
-<tscreen><verb>
+<para>
+
+<screen>
c change to a different mailbox
ESC c change to a folder in read-only mode
C copy the current message to another mailbox
u undelete-message
v view-attachments
x abort changes and exit
-<Return> display-message
-<Tab> jump to the next new message
+<Return> display-message
+<Tab> jump to the next new message
@ show the author's full e-mail address
$ save changes to mailbox
/ search
ESC / search-reverse
^L clear and redraw the screen
^T untag messages matching a pattern
-</verb></tscreen>
+</screen>
+
+</para>
-<sect2>Status Flags
-<p>
+<sect3>
+<title>Status Flags</title> <!--{{{-->
+<para>
In addition to who sent the message and the subject, a short summary of
the disposition of each message is printed beside the message number.
Zero or more of the following ``flags'' may appear, which mean:
+</para>
+
+<para>
+<variablelist>
+
+<varlistentry>
+<term>D</term>
+<listitem>
+<para>
+message is deleted (is marked for deletion)
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>d</term>
+<listitem>
+<para>
+message have attachments marked for deletion
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>K</term>
+<listitem>
+<para>
+contains a PGP public key
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>N</term>
+<listitem>
+<para>
+message is new
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>O</term>
+<listitem>
+<para>
+message is old
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>P</term>
+<listitem>
+<para>
+message is PGP encrypted
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>r</term>
+<listitem>
+<para>
+message has been replied to
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>S</term>
+<listitem>
+<para>
+message is signed, and the signature is succesfully verified
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>s</term>
+<listitem>
+<para>
+message is signed
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>!</term>
+<listitem>
+<para>
+message is flagged
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>*</term>
+<listitem>
+<para>
+message is tagged
+</para>
+</listitem></varlistentry>
+</variablelist>
+</para>
+
+<para>
+Some of the status flags can be turned on or off using
-<p>
-<descrip>
-<tag/D/ message is deleted (is marked for deletion)
-<tag/d/ message have attachments marked for deletion
-<tag/K/ contains a PGP public key
-<tag/N/ message is new
-<tag/O/ message is old
-<tag/P/ message is PGP encrypted
-<tag/r/ message has been replied to
-<tag/S/ message is signed, and the signature is succesfully verified
-<tag/s/ message is signed
-<tag/!/ message is flagged
-<tag/*/ message is tagged
-</descrip>
+<itemizedlist>
+<listitem>
-Some of the status flags can be turned on or off using
-<itemize>
-<item><bf/set-flag/ (default: w)
-<item><bf/clear-flag/ (default: W)
-</itemize>
+<para>
+<emphasis role="bold">set-flag</emphasis> (default: w)
+</para>
+</listitem>
+<listitem>
+
+<para>
+<emphasis role="bold">clear-flag</emphasis> (default: W)
+</para>
+</listitem>
+
+</itemizedlist>
-<p>
+</para>
+
+<para>
Furthermore, the following flags reflect who the message is addressed
to. They can be customized with the
-<ref id="to_chars" name="$to_chars"> variable.
+<link linkend="to-chars">$to_chars</link> variable.
+</para>
+
+<para>
+<variablelist>
+
+<varlistentry>
+<term>+</term>
+<listitem>
+<para>
+message is to you and you only
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>T</term>
+<listitem>
+<para>
+message is to you, but also to or cc'ed to others
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>C</term>
+<listitem>
+<para>
+message is cc'ed to you
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>F</term>
+<listitem>
+<para>
+message is from you
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>L</term>
+<listitem>
+<para>
+message is sent to a subscribed mailing list
+</para>
+</listitem></varlistentry>
+</variablelist>
+</para>
+
+<!--}}}-->
+</sect3>
-<p>
-<descrip>
-<tag/+/ message is to you and you only
-<tag/T/ message is to you, but also to or cc'ed to others
-<tag/C/ message is cc'ed to you
-<tag/F/ message is from you
-<tag/L/ message is sent to a subscribed mailing list
-</descrip>
+<!--}}}-->
+</sect2>
-<sect1>The Pager
-<p>
+<sect2>
+<title>The Pager</title> <!--{{{-->
+<para>
By default, Mutt-ng uses its builtin pager to display the body of messages.
-The pager is very similar to the Unix program <em/less/ though not nearly as
+The pager is very similar to the Unix program <emphasis>less</emphasis> though not nearly as
featureful.
+</para>
-<tscreen><verb>
-<Return> go down one line
-<Space> display the next page (or next message if at the end of a message)
+<para>
+
+<screen>
+<Return> go down one line
+<Space> display the next page (or next message if at the end of a message)
- go back to the previous page
n search for next match
S skip beyond quoted text
ESC / search backwards for a regular expression
\ toggle search pattern coloring
^ jump to the top of the message
-</verb></tscreen>
+</screen>
+
+</para>
-In addition, many of the functions from the <em/index/ are available in
-the pager, such as <em/delete-message/ or <em/copy-message/ (this is one
+<para>
+In addition, many of the functions from the <emphasis>index</emphasis> are available in
+the pager, such as <emphasis>delete-message</emphasis> or <emphasis>copy-message</emphasis> (this is one
advantage over using an external pager to view messages).
+</para>
+<para>
Also, the internal pager supports a couple other advanced features. For
one, it will accept and translate the ``standard'' nroff sequences for
bold and underline. These sequences are a series of either the letter,
-backspace (^H), the letter again for bold or the letter, backspace,
+backspace (ˆH), the letter again for bold or the letter, backspace,
``_'' for denoting underline. Mutt-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 <ref id="color" name="color">
+not, you can use the bold and underline <link
+ linkend="color">color</link>
objects to specify a color or mono attribute for them.
+</para>
+<para>
Additionally, the internal pager supports the ANSI escape sequences for
character attributes. Mutt-ng translates them into the correct color and
character settings. The sequences Mutt-ng supports are:
+</para>
-<p>
-<tscreen><verb>
+<para>
+
+<screen>
ESC [ Ps;Ps;Ps;...;Ps m
where Ps =
0 All Attributes Off
5 magenta
6 cyan
7 white
-</verb></tscreen>
+</screen>
+
+</para>
+<para>
Mutt-ng uses these attributes for handling text/enriched messages, and they
-can also be used by an external <ref id="auto_view" name="autoview">
-script for highlighting purposes. <bf/Note:/ If you change the colors for your
+can also be used by an external <link
+ linkend="auto-view">autoview</link>
+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>
-<sect1>Threaded Mode<label id="threads">
-<p>
-When the mailbox is <ref id="sort" name="sorted"> by <em/threads/, there are
-a few additional functions available in the <em/index/ and <em/pager/ modes.
+<!--}}}-->
+</sect2>
+
+<sect2 id="threads">
+<title>Threaded Mode</title> <!--{{{-->
+
+<para>
+ When the mailbox is <link linkend="sort">sorted</link> by <emphasis>threads</emphasis>, there are
+a few additional functions available in the <emphasis>index</emphasis> and <emphasis>pager</emphasis> modes.
+</para>
+
+<para>
-<tscreen><verb>
+<screen>
^D delete-thread delete all messages in the current thread
^U undelete-thread undelete all messages in the current thread
^N next-thread jump to the start of the next thread
ESC v collapse-thread toggle collapse for the current thread
ESC V collapse-all toggle collapse for all threads
P parent-message jump to parent message in thread
-</verb></tscreen>
+</screen>
-<bf/Note:/ Collapsing a thread displays only the first message
+</para>
+
+<para>
+<emphasis role="bold">Note:</emphasis> Collapsing a thread displays only the first message
in the thread and hides the others. This is useful when threads
contain so many messages that you can only see a handful of threads on
-the screen. See %M in <ref id="index_format"name="$index_format">.
-For example, you could use "%?M?(#%03M)&(%4l)?" in <ref
-id="index_format"name="$index_format"> to optionally
+the screen. See %M in <link
+ linkend="index-format">index-format</link>.
+For example, you could use "%?M?(#%03M)&(%4l)?" in <link linkend="index-format">index-format</link> to optionally
display the number of hidden messages if the thread is collapsed.
+</para>
+
+<para>
+ See also: <link linkend="strict-threads">strict-threads</link>.
+</para>
+
+<!--}}}-->
+</sect2>
+
+<sect2>
+<title>Miscellaneous Functions</title> <!--{{{-->
-See also: <ref id="strict_threads" name="$strict_threads">.
+<para>
+<emphasis role="bold">create-alias</emphasis><anchor id="create-alias"/> (default: a)
-<sect1>Miscellaneous Functions
-<p><bf/create-alias/<label id="create-alias"> (default: a)<newline>
+</para>
+<para>
Creates a new alias based upon the current message (or prompts for a
-new one). Once editing is complete, an <ref id="alias" name="alias">
-command is added to the file specified by the <ref id="alias_file"
-name="$alias_file"> variable for future use. <bf/Note:/
-Specifying an <ref id="alias_file" name="$alias_file">
-does not add the aliases specified there-in, you must also <ref
-id="source" name="source"> the file.
+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> 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> the file.
+</para>
-<p><bf/check-traditional-pgp/<label id="check-traditional-pgp"> (default: ESC P)<newline>
+<para>
+<emphasis role="bold">check-traditional-pgp</emphasis><anchor id="check-traditional-pgp"/> (default: ESC P)
+</para>
+
+<para>
This function will search the current message for content signed or
encrypted with PGP the "traditional" way, that is, without proper
MIME tagging. Technically, this function will temporarily change
the MIME content types of the body parts containing PGP data; this
-is similar to the <ref id="edit-type" name="edit-type"> function's
+is similar to the <link linkend="edit-type">edit-type</link> function's
effect.
+</para>
+
+<para>
+<emphasis role="bold">display-toggle-weed</emphasis><anchor id="display-toggle-weed"/> (default: h)
+</para>
-<p><bf/display-toggle-weed/<label id="display-toggle-weed"> (default: h)<newline>
+<para>
+Toggles the weeding of message header fields specified by <link linkend="ignore">ignore</link> commands.
+</para>
-Toggles the weeding of message header fields specified by <ref id="ignore"
-name="ignore"> commands.
+<para>
+<emphasis role="bold">edit</emphasis><anchor id="edit"/> (default: e)
-<p><bf/edit/<label id="edit"> (default: e)<newline>
+</para>
+<para>
This command (available in the ``index'' and ``pager'') allows you to
edit the raw current message as it's present in the mail folder.
After you have finished editing, the changed message will be
appended to the current folder, and the original message will be
marked for deletion.
+</para>
-<p><bf/edit-type/<label id="edit-type"><newline>
-(default: ^E on the attachment menu, and in the pager and index menus; ^T on the
+<para>
+<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)
+</para>
+<para>
This command is used to temporarily edit an attachment's content
type to fix, for instance, bogus character set parameters. When
invoked from the index or from the pager, you'll have the
opportunity to edit the top-level attachment's content type. On the
-<ref id="attach_menu" name="attachment menu">, you can change any
+<link linkend="attach-menu">attach-menu</link>, you can change any
attachment's content type. These changes are not persistent, and get
lost upon changing folders.
+</para>
-Note that this command is also available on the <ref
-id="compose_menu" name="compose menu">. There, it's used to
+<para>
+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: ``:'')
-<p><bf/enter-command/<label id="enter-command"> (default: ``:'')<newline>
+</para>
+<para>
This command is used to execute any command you would normally put in a
configuration file. A common use is to check the settings of variables, or
-in conjunction with <ref id="macro" name="macros"> to change settings on the
+in conjunction with <link linkend="macro">macro</link> to change settings on the
fly.
+</para>
-<p><bf/extract-keys/<label id="extract-keys"> (default: ^K)<newline>
+<para>
+<emphasis role="bold">extract-keys</emphasis><anchor id="extract-keys"/> (default: ˆK)
+</para>
+
+<para>
This command extracts PGP public keys from the current or tagged
message(s) and adds them to your PGP public key ring.
+</para>
-<p><bf/forget-passphrase/<label id="forget-passphrase"> (default:
-^F)<newline>
+<para>
+<emphasis role="bold">forget-passphrase</emphasis><anchor id="forget-passphrase"/> (default:
+ˆF)
+
+</para>
+<para>
This command wipes the passphrase(s) from memory. It is useful, if
you misspelled the passphrase.
+</para>
-<p><bf/list-reply/<label id="list-reply"> (default: L)<newline>
+<para>
+<emphasis role="bold">list-reply</emphasis><anchor id="func-list-reply"/> (default: L)
+</para>
+
+<para>
Reply to the current or tagged message(s) by extracting any addresses which
-match the regular expressions given by the <ref id="lists" name="lists or subscribe">
-commands, but also honor any <tt/Mail-Followup-To/ header(s) if the
-<ref id="honor_followup_to" name="$honor_followup_to">
+match the regular expressions given by the <link linkend="lists">lists</link>
+commands, but also honor any <literal>Mail-Followup-To</literal> header(s) if the
+<link linkend="honor-followup-to">honor-followup-to</link>
configuration variable is set. Using this when replying to messages posted
to mailing lists helps avoid duplicate copies being sent to the author of
the message you are replying to.
+</para>
+
+<para>
+<emphasis role="bold">pipe-message</emphasis><anchor id="pipe-message"/> (default: |)
-<bf/pipe-message/<label id="pipe-message"> (default: |)<newline>
+</para>
+<para>
Asks for an external Unix command and pipes the current or
-tagged message(s) to it. The variables <ref id="pipe_decode"
-name="$pipe_decode">, <ref id="pipe_split"
-name="$pipe_split">, <ref id="pipe_sep"
-name="$pipe_sep"> and <ref id="wait_key"
-name="$wait_key"> control the exact behavior of this
+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.
+</para>
-<bf/resend-message/<label id="resend-message"> (default: ESC e)<newline>
+<para>
+<emphasis role="bold">resend-message</emphasis><anchor id="resend-message"/> (default: ESC e)
+</para>
+
+<para>
With resend-message, mutt takes the current message as a template for a
new message. This function is best described as "recall from arbitrary
folders". It can conveniently be used to forward MIME messages while
preserving the original mail structure. Note that the amount of headers
-included here depends on the value of the <ref id="weed" name="$weed">
+included here depends on the value of the <link linkend="weed">weed</link>
variable.
+</para>
+<para>
This function is also available from the attachment menu. You can use this
to easily resend a message which was included with a bounce message
as a message/rfc822 body part.
+</para>
+
+<para>
+<emphasis role="bold">shell-escape</emphasis><anchor id="shell-escape"/> (default: !)
-<bf/shell-escape/<label id="shell-escape"> (default: !)<newline>
+</para>
-Asks for an external Unix command and executes it. The <ref
-id="wait_key" name="$wait_key"> can be used to control
+<para>
+Asks for an external Unix command and executes it. The <link linkend="wait-key">wait-key</link> can be used to control
whether Mutt-ng will wait for a key to be pressed when the command returns
(presumably to let the user read the output of the command), based on
the return status of the named command.
+</para>
-<bf/toggle-quoted/<label id="toggle-quoted"> (default: T)<newline>
+<para>
+<emphasis role="bold">toggle-quoted</emphasis><anchor id="toggle-quoted"/> (default: T)
-The <em/pager/ uses the <ref id="quote_regexp"
-name="$quote_regexp"> variable to detect quoted text when
+</para>
+
+<para>
+The <emphasis>pager</emphasis> uses the <link linkend="quote-regexp">quote-regexp</link> variable to detect quoted text when
displaying the body of the message. This function toggles the display
of the quoted material in the message. It is particularly useful when
are interested in just the response and there is a large amount of
quoted text in the way.
+</para>
+
+<para>
+<emphasis role="bold">skip-quoted</emphasis><anchor id="skip-quoted"/> (default: S)
-<bf/skip-quoted/<label id="skip-quoted"> (default: S)<newline>
+</para>
+<para>
This function will go to the next line of non-quoted text which come
after a line of quoted text in the internal pager.
+</para>
-<!--}}}-->
+<para>
+
+</para>
-<sect>Sending Mail <!--{{{-->
-<p>
+<!--}}}-->
+</sect2>
-The following bindings are available in the <em/index/ for sending
+<!--}}}-->
+</sect1>
+
+<sect1>
+<title>Sending Mail </title> <!--{{{-->
+
+<para>
+The following bindings are available in the <emphasis>index</emphasis> for sending
messages.
+</para>
+
+<para>
-<tscreen><verb>
+<screen>
m compose compose a new message
r reply reply to sender
g group-reply reply to all recipients
f forward forward message
b bounce bounce (remail) message
ESC k mail-key mail a PGP public key to someone
-</verb></tscreen>
+</screen>
+</para>
+
+<para>
Bouncing a message sends the message as is to the recipient you
specify. Forwarding a message allows you to add comments or
modify the message you are forwarding. These items are discussed
-in greater detail in the next chapter <ref id="forwarding_mail"
-name="``Forwarding and Bouncing Mail''">.
+in greater detail in the next chapter <link linkend="forwarding-mail">forwarding-mail</link>.
+</para>
-<sect1>Composing new messages <!--{{{-->
+<sect2>
+<title>Composing new messages </title> <!--{{{-->
-<p>When you want to send an email using mutt-ng, simply press <tt/m/ on
+<para>
+When you want to send an email using mutt-ng, simply press <literal>m</literal> on
your keyboard. Then, mutt-ng asks for the recipient via a prompt in
the last line:
+</para>
+
+<para>
-<verb>
+<screen>
To:
-</verb>
+</screen>
-<p>After you've finished entering the recipient(s), press return. If you
+</para>
+
+<para>
+After you've finished entering the recipient(s), press return. If you
want to send an email to more than one recipient, separate the email
-addresses using the comma "<tt/,/". Mutt-ng then asks you for the email
+addresses using the comma "<literal>,</literal>". Mutt-ng then asks you for the email
subject. Again, press return after you've entered it. After that, mutt-ng
got the most important information from you, and starts up an editor
where you can then enter your email.
+</para>
-<p>The editor that is called is selected in the following way: you
+<para>
+The editor that is called is selected in the following way: you
can e.g. set it in the mutt-ng configuration:
+</para>
+
+<para>
-<verb>
+<screen>
set editor = "vim +/^$/ -c ':set tw=72'"
set editor = "nano"
set editor = "emacs"
-</verb>
+</screen>
-<p>If you don't set your preferred editor in your configuration, mutt-ng
-first looks whether the environment variable <tt/$VISUAL/ is set, and if
+</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
so, it takes its value as editor command. Otherwise, it has a look
-at <tt/$EDITOR/ and takes its value if it is set. If no editor command
-can be found, mutt-ng simply assumes <tt/vi/ to be the default editor,
+at <literal>$EDITOR</literal> 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 default editor,
since it's the most widespread editor in the Unix world and it's pretty
safe to assume that it is installed and available.
+</para>
-<p>When you've finished entering your message, save it and quit your
+<para>
+When you've finished entering your message, save it and quit your
editor. Mutt-ng will then present you with a summary screen, the compose menu.
On the top, you see a summary of the most important available key commands.
Below that, you see the sender, the recipient(s), Cc and/or Bcc
recipient(s), the subject, the reply-to address, and optionally
information where the sent email will be stored and whether it should
be digitally signed and/or encrypted.
+</para>
-<p>Below that, you see a list of "attachments". The mail you've just
+<para>
+Below that, you see a list of "attachments". The mail you've just
entered before is also an attachment, but due to its special type
(it's plain text), it will be displayed as the normal message on
the receiver's side.
-
-<p>At this point, you can add more attachments, pressing <tt/a/, you
-can edit the recipient addresses, pressing <tt/t/ for the "To:" field,
-<tt/c/ for the "Cc:" field, and <tt/b/ for the "Bcc: field. You can
-also edit the subject the subject by simply pressing <tt/s/ or the
-email message that you've entered before by pressing <tt/e/. You will
+</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 the "To:" field,
+<literal>c</literal> for the "Cc:" field, and <literal>b</literal> 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
then again return to the editor. You can even edit the sender, by pressing
-<tt/<esc>f/, but this shall only be used with caution.
+<literal><esc>f</literal>, but this shall only be used with caution.
+</para>
-<p>Alternatively, you can configure mutt-ng in a way that most of the
+<para>
+Alternatively, you can configure mutt-ng in a way that most of the
above settings can be edited using the editor. Therefore, you only
need to add the following to your configuration:
+</para>
-<verb>
+<para>
+
+<screen>
set edit_headers
-</verb>
+</screen>
+
+</para>
-<p>Once you have finished editing the body of your mail message, you are
-returned to the <em/compose/ menu. The following options are available:
+<para>
+Once you have finished editing the body of your mail message, you are
+returned to the <emphasis>compose</emphasis> menu. The following options are available:
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
a attach-file attach a file
A attach-message attach message(s) to the message
ESC k attach-key attach a PGP public key
w write-fcc write the message to a folder
i ispell check spelling (if available on your system)
^F forget-passphrase wipe passphrase(s) from memory
-</verb></tscreen>
+</screen>
+
+</para>
-<bf/Note:/ The attach-message function will prompt you for a folder to
+<para>
+<emphasis role="bold">Note:</emphasis> The attach-message function will prompt you for a folder to
attach messages from. You can now tag messages in that folder and they
will be attached to the message you are sending. Note that certain
operations like composing a new mail, replying, forwarding, etc. are
-not permitted when you are in that folder. The %r in <ref
-id="status_format" name="$status_format"> will change to
+not permitted when you are in that folder. The %r in <link linkend="status-format">status-format</link> will change to
a 'A' to indicate that you are in attach-message mode.
+</para>
-<!--}}}-->
+<para>
+
+</para>
-<sect1>Replying <!--{{{-->
+<!--}}}-->
+</sect2>
+
+<sect2>
+<title>Replying </title> <!--{{{-->
- <sect2>Simple Replies <!--{{{-->
+<sect3>
+<title>Simple Replies </title> <!--{{{-->
- <p>When you want to reply to an email message, select it in the index
- menu and then press <tt/r/. 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
- the editor with the quote attribution and the quoted message. This
- can e.g. look like the example below.
+<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 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
+the editor with the quote attribution and the quoted message. This
+can e.g. look like the example below.
+</para>
- <verb>
+<para>
+
+<screen>
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.
- </verb>
+
+</screen>
- <p>You can start editing the email message. It is strongly
- recommended to put your answer <em/below/ the quoted text and to
- only quote what is really necessary and that you refer to. Putting
- your answer on top of the quoted message, is, although very
- widespread, very often not considered to be a polite way to answer
- emails.
+</para>
- <p>The quote attribution is configurable, by default it is set to
- <verb>
+<para>
+You can start editing the email message. It is strongly
+recommended to put your answer <emphasis>below</emphasis> the quoted text and to
+only quote what is really necessary and that you refer to. Putting
+your answer on top of the quoted message, is, although very
+widespread, very often not considered to be a polite way to answer
+emails.
+</para>
+
+<para>
+The quote attribution is configurable, by default it is set to
+
+<screen>
set attribution = "On %d, %n wrote:"
- </verb>
+
+</screen>
+
+</para>
- <p>It can also be set to something more compact, e.g.
- <verb>
+<para>
+It can also be set to something more compact, e.g.
+
+<screen>
set attribution = "attribution="* %n <%a> [%(%y-%m-%d %H:%M)]:"
- </verb>
+
+</screen>
+
+</para>
+
+<para>
+The example above results in the following attribution:
- <p>The example above results in the following attribution:
- <verb>
+<screen>
* 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.
- </verb>
+
+</screen>
- <p>Generally, try to keep your attribution short yet
- information-rich. It is <em/not/ the right place for witty quotes,
- long "attribution" novels or anything like that: the right place
- for such things is - if at all - the email signature at the very
- bottom of the message.
+</para>
- <p>When you're done with writing your message, save and quit the
- editor. As before, you will return to the compose menu, which is
- used in the same way as before.
+<para>
+Generally, try to keep your attribution short yet
+information-rich. It is <emphasis>not</emphasis> the right place for witty quotes,
+long "attribution" novels or anything like that: the right place
+for such things is - if at all - the email signature at the very
+bottom of the message.
+</para>
- <!--}}}-->
+<para>
+When you're done with writing your message, save and quit the
+editor. As before, you will return to the compose menu, which is
+used in the same way as before.
+</para>
- <sect2>Group Replies <!--{{{-->
+<para>
+
+</para>
- <p>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 functionality
- ensures that when you press <tt/g/ instead of <tt/r/ 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.
+<!--}}}-->
+</sect3>
+
+<sect3>
+<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 functionality
+ensures that when you press <literal>g</literal> instead of <literal>r</literal> 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>
+
+<para>
+
+</para>
- <!--}}}-->
+<!--}}}-->
+</sect3>
+
+<sect3>
+<title>List Replies </title> <!--{{{-->
+
+<para>
+When you use mailing lists, it's generally better to send your
+reply to a message only to the list instead of the list and the
+original author. To make this easy to use, mutt-ng features list
+replies.
+</para>
+
+<para>
+To do a list reply, simply press <literal>L</literal>. If the email contains
+a <literal>Mail-Followup-To:</literal> header, its value will be used as reply
+address. Otherwise, mutt-ng searches through all mail addresses in
+the original message and tries to match them a list of regular
+expressions which can be specified using the <literal>lists</literal> command.
+If any of the regular expression matches, a mailing
+list address has been found, and it will be used as reply address.
+</para>
+
+<para>
+
+<screen>
+lists linuxevent@luga\.at vuln-dev@ mutt-ng-users@
+
+</screen>
- <sect2>List Replies <!--{{{-->
+</para>
- <p>When you use mailing lists, it's generally better to send your
- reply to a message only to the list instead of the list and the
- original author. To make this easy to use, mutt-ng features list
- replies.
+<para>
+Nowadays, most mailing list software like GNU Mailman adds a
+<literal>Mail-Followup-To:</literal> header to their emails anyway, so setting
+<literal>lists</literal> is hardly ever necessary in practice.
+</para>
- <p>To do a list reply, simply press <tt/L/. If the email contains
- a <tt/Mail-Followup-To:/ header, its value will be used as reply
- address. Otherwise, mutt-ng searches through all mail addresses in
- the original message and tries to match them a list of regular
- expressions which can be specified using the <tt/lists/ command.
- If any of the regular expression matches, a mailing
- list address has been found, and it will be used as reply address.
+<para>
+
+</para>
- <verb>
-lists linuxevent@luga\.at vuln-dev@ mutt-ng-users@
- </verb>
+<para>
+
+</para>
- <p>Nowadays, most mailing list software like GNU Mailman adds a
- <tt/Mail-Followup-To:/ header to their emails anyway, so setting
- <tt/lists/ is hardly ever necessary in practice.
+<!--}}}-->
+</sect3>
- <!--}}}-->
+<!--}}}-->
+</sect2>
-<!--}}}-->
+<sect2>
+<title>Editing the message header </title>
-<sect1>Editing the message header <!--{{{-->
-<p>
+<para>
When editing the header of your outgoing message, there are a couple of
special features available.
+</para>
-If you specify<newline>
-<tt/Fcc:/ <em/filename/<newline>
-Mutt-ng will pick up <em/filename/
-just as if you had used the <em/edit-fcc/ function in the <em/compose/ menu.
+<para>
+If you specify
-You can also attach files to your message by specifying<newline>
-<tt/Attach:/ <em/filename/ [ <em/description/ ]<newline>
-where <em/filename/ is the file to attach and <em/description/ is an
+<literal>Fcc:</literal> <emphasis>filename</emphasis>
+
+Mutt-ng will pick up <emphasis>filename</emphasis>
+just as if you had used the <emphasis>edit-fcc</emphasis> function in the <emphasis>compose</emphasis> menu.
+</para>
+
+<para>
+You can also attach files to your message by specifying
+
+<literal>Attach:</literal> <emphasis>filename</emphasis> [ <emphasis>description</emphasis> ]
+
+where <emphasis>filename</emphasis> is the file to attach and <emphasis>description</emphasis> is an
optional string to use as the description of the attached file.
+</para>
-When replying to messages, if you remove the <em/In-Reply-To:/ field from
-the header field, Mutt-ng will not generate a <em/References:/ field, which
+<para>
+When replying to messages, if you remove the <emphasis>In-Reply-To:</emphasis> field from
+the header field, Mutt-ng will not generate a <emphasis>References:</emphasis> field, which
allows you to create a new message thread.
+</para>
-Also see <ref id="edit_headers" name="edit_headers">.
+<para>
+Also see <link linkend="edit-headers">edit-headers</link>.
+</para>
-<!--}}}-->
+<para>
+
+</para>
+
+</sect2>
-<sect1>Using Mutt-ng with PGP <!--{{{-->
+<sect2>
+<title>Using Mutt-ng with PGP </title>
-<p>
+<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> ]
-<tt/Pgp:/ [ <tt/E/ | <tt/S/ | <tt/S/<em/<id>/ ] <newline>
+</para>
+<para>
``E'' encrypts, ``S'' signs and
-``S<id>'' signs with the given key, setting <ref
-id="pgp_sign_as" name="$pgp_sign_as"> permanently.
+``S<id>'' signs with the given key, setting <link linkend="pgp-sign-as">pgp-sign-as</link> permanently.
+</para>
+<para>
If you have told mutt to PGP encrypt a message, it will guide you
through a key selection process when you try to send the message.
Mutt-ng will not ask you any questions about keys which have a
addresses. However, there may be situations in which there are
several keys, weakly certified user ID fields, or where no matching
keys can be found.
+</para>
+<para>
In these cases, you are dropped into a menu with a list of keys from
which you can select one. When you quit this menu, or mutt can't
find any matching keys, you are prompted for a user ID. You can, as
-usually, abort this prompt using <tt/^G/. When you do so, mutt will
+usually, abort this prompt using <literal>ˆG</literal>. When you do so, mutt will
return to the compose screen.
+</para>
+<para>
Once you have successfully finished the key selection, the message
will be encrypted using the selected public keys, and sent out.
+</para>
-Most fields of the entries in the key selection menu (see also <ref
-id="pgp_entry_format" name="$pgp_entry_format">)
+<para>
+Most fields of the entries in the key selection menu (see also <link linkend="pgp-entry-format">pgp-entry-format</link>)
have obvious meanings. But some explanations on the capabilities, flags,
and validity fields are in order.
+</para>
+<para>
The flags sequence (%f) will expand to one of the following flags:
-<tscreen><verb>
+
+<screen>
R The key has been revoked and can't be used.
X The key is expired and can't be used.
d You have marked the key as disabled.
c There are unknown critical self-signature
packets.
-</verb></tscreen>
+</screen>
+
+</para>
+<para>
The capabilities field (%c) expands to a two-character sequence
representing a key's capabilities. The first character gives
-the key's encryption capabilities: A minus sign (<bf/-/) means
-that the key cannot be used for encryption. A dot (<bf/./) means that
+the key's encryption capabilities: A minus sign (<emphasis role="bold">-</emphasis>) means
+that the key cannot be used for encryption. A dot (<emphasis role="bold">.</emphasis>) means that
it's marked as a signature key in one of the user IDs, but may
-also be used for encryption. The letter <bf/e/ indicates that
+also be used for encryption. The letter <emphasis role="bold">e</emphasis> indicates that
this key can be used for encryption.
-
+</para>
+
+<para>
The second character indicates the key's signing capabilities. Once
-again, a ``<bf/-/'' implies ``not for signing'', ``<bf/./'' implies
+again, a ``<emphasis role="bold">-</emphasis>'' implies ``not for signing'', ``<emphasis role="bold">.</emphasis>'' implies
that the key is marked as an encryption key in one of the user-ids, and
-``<bf/s/'' denotes a key which can be used for signing.
-
-Finally, the validity field (%t) indicates how well-certified a user-id
-is. A question mark (<bf/?/) indicates undefined validity, a minus
-character (<bf/-/) marks an untrusted association, a space character
-means a partially trusted association, and a plus character (<bf/+/)
+``<emphasis role="bold">s</emphasis>'' denotes a key which can be used for signing.
+</para>
+
+<para>
+Finally, the validity field (%t) indicates how well-certified a user-id
+is. A question mark (<emphasis role="bold">?</emphasis>) indicates undefined validity, a minus
+character (<emphasis role="bold">-</emphasis>) marks an untrusted association, a space character
+means a partially trusted association, and a plus character (<emphasis role="bold">+</emphasis>)
indicates complete validity.
+</para>
+
+<para>
+
+</para>
-<!--}}}-->
+</sect2>
-<sect1>Sending anonymous messages via mixmaster <!--{{{-->
+<sect2>
+<title>Sending anonymous messages via mixmaster </title>
-<p>
+<para>
You may also have configured mutt to co-operate with Mixmaster, an
anonymous remailer. Mixmaster permits you to send your messages
anonymously using a chain of remailers. Mixmaster support in mutt is for
mixmaster version 2.04 (beta 45 appears to be the latest) and 2.03.
It does not support earlier versions or the later so-called version 3 betas,
of which the latest appears to be called 2.9b23.
+</para>
+<para>
To use it, you'll have to obey certain restrictions. Most
-important, you cannot use the <tt/Cc/ and <tt/Bcc/ headers. To tell
+important, you cannot use the <literal>Cc</literal> and <literal>Bcc</literal> headers. To tell
Mutt-ng to use mixmaster, you have to select a remailer chain, using
the mix function on the compose menu.
+</para>
+<para>
The chain selection screen is divided into two parts. In the
(larger) upper part, you get a list of remailers you may use. In
the lower part, you see the currently selected chain of remailers.
+</para>
-You can navigate in the chain using the <tt/chain-prev/ and
-<tt/chain-next/ functions, which are by default bound to the left
-and right arrows and to the <tt/h/ and <tt/l/ keys (think vi
+<para>
+You can navigate in the chain using the <literal>chain-prev</literal> 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
keyboard bindings). To insert a remailer at the current chain
-position, use the <tt/insert/ function. To append a remailer behind
-the current chain position, use <tt/select-entry/ or <tt/append/.
+position, use the <literal>insert</literal> function. To append a remailer behind
+the current chain position, use <literal>select-entry</literal> or <literal>append</literal>.
You can also delete entries from the chain, using the corresponding
function. Finally, to abandon your changes, leave the menu, or
-<tt/accept/ them pressing (by default) the <tt/Return/ key.
+<literal>accept</literal> them pressing (by default) the <literal>Return</literal> key.
+</para>
+<para>
Note that different remailers do have different capabilities,
indicated in the %c entry of the remailer menu lines (see
-<ref id="mix_entry_format"
-name="$mix_entry_format">). Most important is
+<link linkend="mix-entry-format">mix-entry-format</link>). Most important is
the ``middleman'' capability, indicated by a capital ``M'': This
means that the remailer in question cannot be used as the final
element of a chain, but will only forward messages to other
mixmaster remailers. For details on the other capabilities, please
have a look at the mixmaster documentation.
+</para>
+
+<para>
+
+</para>
+
+<para>
+
+</para>
-<!--}}}-->
+</sect2>
-<!--}}}-->
+</sect1>
-<sect>Forwarding and Bouncing Mail<label id="forwarding_mail"> <!--{{{-->
+<sect1 id="forwarding-mail">
+<title>Forwarding and Bouncing Mail </title>
-<p>Often, it is necessary to forward mails to other people.
+<para>
+Often, it is necessary to forward mails to other people.
Therefore, mutt-ng supports forwarding messages in two different
ways.
+</para>
-<p>The first one is regular forwarding, as you probably know it from
-other mail clients. You simply press <tt/f/, enter the recipient
+<para>
+The first one is regular forwarding, as you probably know it from
+other mail clients. You simply press <literal>f</literal>, 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
message is separated from the rest of the message via the two
following markers:
+</para>
+
+<para>
-<verb>
------ Forwarded message from Lucas User <luser@example.com> -----
+<screen>
+----- 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 -----</verb>
+----- End forwarded message -----
+</screen>
-<p>When you're done with editing the mail, save and quit the editor,
+</para>
+
+<para>
+When you're done with editing the mail, save and quit the editor,
and you will return to the compose menu, the same menu you also
encounter when composing or replying to mails.
+</para>
-<p>The second mode of forwarding emails with mutt-ng is the
-so-called <em/bouncing/: when you bounce an email to another
+<para>
+The second mode of forwarding emails with mutt-ng is the
+so-called <emphasis>bouncing</emphasis>: when you bounce an email to 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 <tt/b/ and enter the recipient
+message). To bounce a message, press <literal>b</literal> 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
with yes, the message will then be bounced.
+</para>
-<p>To the recipient, the bounced email will look as if he got it
-like a regular email where he was <tt/Bcc:/ recipient. The only
+<para>
+To the recipient, the bounced email will look as if he got it
+like a regular email where he was <literal>Bcc:</literal> recipient. The only
possibility to find out whether it was a bounced email is to
carefully study the email headers and to find out which host really
sent the email.
+</para>
+
+<para>
+
+</para>
-<!--}}}-->
+</sect1>
-<sect>Postponing Mail<label id="postponing_mail"> <!--{{{-->
-<p>
+<sect1 id="postponing-mail">
+<title>Postponing Mail </title>
+<para>
At times it is desirable to delay sending a message that you have
-already begun to compose. When the <em/postpone-message/ function is
-used in the <em/compose/ menu, the body of your message and attachments
-are stored in the mailbox specified by the <ref id="postponed"
-name="$postponed"> variable. This means that you can recall the
+already begun to compose. When the <emphasis>postpone-message</emphasis> function is
+used in the <emphasis>compose</emphasis> menu, the body of your message and attachments
+are stored in the mailbox specified by the <link linkend="postponed">postponed</link> 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>
Once a message is postponed, there are several ways to resume it. From the
-command line you can use the ``-p'' option, or if you <em/compose/ a new
-message from the <em/index/ or <em/pager/ you will be prompted if postponed
+command line you can use the ``-p'' option, or if you <emphasis>compose</emphasis> a new
+message from the <emphasis>index</emphasis> or <emphasis>pager</emphasis> you will be prompted if postponed
messages exist. If multiple messages are currently postponed, the
-<em/postponed/ menu will pop up and you can select which message you would
+<emphasis>postponed</emphasis> menu will pop up and you can select which message you would
like to resume.
+</para>
-<bf/Note:/ If you postpone a reply to a message, the reply setting of
+<para>
+<emphasis role="bold">Note:</emphasis> If you postpone a reply to a message, the reply setting of
the message is only updated when you actually finish the message and
send it. Also, you must be in the same folder with the message you
replied to for the status of the message to be updated.
+</para>
-See also the <ref id="postpone" name="$postpone"> quad-option.
+<para>
+See also the <link linkend="postpone">postpone</link> quad-option.
+</para>
-<!--}}}-->
+<para>
+
+</para>
-<!--}}}-->
+<para>
+
+</para>
+
+</sect1>
+
+</chapter>
+
+<chapter>
+<title>Configuration </title>
-<chapt>Configuration <!--{{{-->
+<sect1>
+<title>Locations of Configuration Files </title>
-<sect>Locations of Configuration Files <!--{{{-->
-<p>While the default configuration (or ``preferences'') make Mutt-ng usable right out
+<para>
+While the default configuration (or ``preferences'') make Mutt-ng usable right out
of the box, it is often desirable to tailor Mutt-ng to suit your own tastes. When
Mutt-ng is first invoked, it will attempt to read the ``system'' configuration
-file (defaults set by your local system administrator), unless the ``-n'' <ref
-id="commandline" name="command line"> option is specified. This file is
-typically <tt>/usr/local/share/muttng/Muttngrc</tt> or <tt>/etc/Muttngrc</tt>,
-Mutt-ng users will find this file in <tt>/usr/local/share/muttng/Muttrc</tt> or
-<tt>/etc/Muttngrc</tt>. Mutt will next look for a file named <tt>.muttrc</tt>
-in your home directory, Mutt-ng will look for <tt>.muttngrc</tt>. If this file
-does not exist and your home directory has a subdirectory named <tt/.mutt/,
-mutt try to load a file named <tt>.muttng/muttngrc</tt>.
-
-<tt>.muttrc</tt> (or <tt>.muttngrc</tt> for Mutt-ng) is the file where you will
-usually place your <ref id="commands" name="commands"> to configure Mutt-ng.
+file (defaults set by your local system administrator), unless the ``-n'' <link linkend="commandline">commandline</link> option is specified. This file is
+typically <literal>/usr/local/share/muttng/Muttngrc</literal> or <literal>/etc/Muttngrc</literal>,
+Mutt-ng users will find this file in <literal>/usr/local/share/muttng/Muttrc</literal> or
+<literal>/etc/Muttngrc</literal>. Mutt will next look for a file named <literal>.muttrc</literal>
+in your home directory, Mutt-ng will look for <literal>.muttngrc</literal>. If this file
+does not exist and your home directory has a subdirectory named <literal>.mutt</literal>,
+mutt try to load a file named <literal>.muttng/muttngrc</literal>.
+</para>
+
+<para>
+<literal>.muttrc</literal> (or <literal>.muttngrc</literal> for Mutt-ng) is the file where you will
+usually place your <link linkend="commands">commands</link> to configure Mutt-ng.
+</para>
+
+<para>
+
+</para>
-<!--}}}-->
+</sect1>
-<sect>Basic Syntax of Initialization Files<label id="muttrc-syntax"> <!--{{{-->
-<p>
+<sect1 id="muttrc-syntax">
+<title>Basic Syntax of Initialization Files </title>
-An initialization file consists of a series of <ref id="commands"
-name="commands">. Each line of the file may contain one or more commands.
+<para>
+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 (;).
-<tscreen><verb>
+
+<screen>
set realname='Mutt-ng user' ; ignore x-
-</verb></tscreen>
+</screen>
+
The hash mark, or pound sign
(``#''), is used as a ``comment'' character. You can use it to
annotate your initialization file. All text after the comment character
to the end of the line is ignored. For example,
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
my_hdr X-Disclaimer: Why are you listening to me? # This is a comment
-</verb></tscreen>
+</screen>
+
+</para>
-Single quotes (') and double quotes (&dquot;) can be used to quote strings
+<para>
+Single quotes (') and double quotes (") can be used to quote strings
which contain spaces or other special characters. The difference between
the two types of quotes is similar to that of many popular shell programs,
namely that a single quote is used to specify a literal string (one that is
not interpreted for shell variables or quoting with a backslash [see
next paragraph]), while double quotes indicate a string for which
should be evaluated. For example, backtics are evaluated inside of double
-quotes, but <bf/not/ for single quotes.
+quotes, but <emphasis role="bold">not</emphasis> for single quotes.
+</para>
+<para>
\ quotes the next character, just as in shells such as bash and zsh.
-For example, if want to put quotes ``&dquot;'' inside of a string, you can use
+For example, if want to put quotes ``"'' inside of a string, you can use
``\'' to force the next character to be a literal instead of interpreted
character.
-<tscreen><verb>
+
+<screen>
set realname="Michael \"MuttDude\" Elkins"
-</verb></tscreen>
+</screen>
+
+</para>
+<para>
``\\'' means to insert a literal ``\'' into the line.
``\n'' and ``\r'' have their usual C meanings of linefeed and
carriage-return, respectively.
+</para>
+<para>
A \ at the end of a line can be used to split commands over
multiple lines, provided that the split points don't appear in the
middle of command names.
+</para>
+<para>
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 ``#''.
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
# folder-hook . \
set realname="Michael \"MuttDude\" Elkins"
-</verb></tscreen>
+</screen>
+
+</para>
+<para>
When testing your config files, beware the following caveat. The backslash
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
part of a comment and therefore are ignored, too. So take care of comments
when continuation lines are involved within your setup files!
+</para>
+<para>
Abstract example:
-
-<tscreen><verb>
+</para>
+
+<para>
+
+<screen>
line1\
line2a # line2b\
line3\
line4
line5
-</verb></tscreen>
+</screen>
+</para>
+
+<para>
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.
+</para>
+<para>
The commands understood by mutt are explained in the next paragraphs.
-For a complete list, see the <ref id="commands" name="command reference">.
+For a complete list, see the <link linkend="commands">commands</link>.
+</para>
+
+<para>
+
+</para>
+
+</sect1>
-<!--}}}-->
+<sect1>
+<title>Expansion within variables </title>
-<sect>Expansion within variables <!--{{{-->
+<para>
+Besides just assign static content to variables, there's plenty of
+ways of adding external and more or less dynamic content.
+</para>
- <p>Besides just assign static content to variables, there's plenty of
- ways of adding external and more or less dynamic content.
+<sect2>
+<title>Commands' Output </title>
- <sect1>Commands' Output
+<para>
+It is possible to substitute the output of a Unix command in an
+initialization file. This is accomplished by enclosing the command
+in backquotes (``) as in, for example:
+</para>
- <p>It is possible to substitute the output of a Unix command in an
- initialization file. This is accomplished by enclosing the command
- in backquotes (``) as in, for example:
+<para>
-<tscreen><verb>
+<screen>
my_hdr X-Operating-System: `uname -a`
-</verb></tscreen>
+</screen>
- <p>The output of the Unix command ``uname -a'' will be substituted
- before the line is parsed. Note that since initialization files are
- line oriented, only the first line of output from the Unix command
- will be substituted.
+</para>
- <sect1>Environment Variables
+<para>
+The output of the Unix command ``uname -a'' will be substituted
+before the line is parsed. Note that since initialization files are
+line oriented, only the first line of output from the Unix command
+will be substituted.
+</para>
- <p>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,
+</sect2>
-<tscreen><verb>
-set record=+sent_on_$HOSTNAME
-</verb></tscreen>
+<sect2>
+<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,
+</para>
- <p>sets the <ref id="record" name="$record"> variable to the
- string <em/+sent_on_/ and appends the value of the evironment
- variable <tt>$HOSTNAME</tt>.
+<para>
- <p><bf/Note:/ There will be no warning if an environment variable
- is not defined. The result will of the expansion will then be empty.
+<screen>
+set record=+sent_on_$HOSTNAME
+</screen>
- <sect1>Configuration Variables
+</para>
- <p>As for environment variables, the values of all configuration
- variables as string can be used in the same way, too. For example,
+<para>
+sets the <link linkend="record">record</link> variable to the
+string <emphasis>+sent_on_</emphasis> and appends the value of the evironment
+variable <literal>$HOSTNAME</literal>.
+</para>
-<tscreen><verb>
-set imap_home_namespace = $folder
-</verb></tscreen>
+<para>
+<emphasis role="bold">Note:</emphasis> There will be no warning if an environment variable
+is not defined. The result will of the expansion will then be empty.
+</para>
- <p>would set the value of <ref id="imap_home_namespace"
- name="$imap_home_namespace"> to the value to
- which <ref id="folder" name="$folder"> is <em/currently/ set
- to.
+</sect2>
- <p><bf/Note:/ There're no logical links established in such cases so
- that the the value for <ref id="imap_home_namespace"
- name="$imap_home_namespace"> won't change even
- if <ref id="folder" name="$folder"> gets changed.
+<sect2>
+<title>Configuration Variables </title>
- <p><bf/Note:/ There will be no warning if a configuration variable
- is not defined or is empty. The result will of the expansion will
- then be empty.
+<para>
+As for environment variables, the values of all configuration
+variables as string can be used in the same way, too. For example,
+</para>
- <sect1>Self-Defined Variables
+<para>
+
+<screen>
+set imap_home_namespace = $folder
+</screen>
+
+</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.
+</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> won't change even
+if <link linkend="folder">folder</link> gets changed.
+</para>
+
+<para>
+<emphasis role="bold">Note:</emphasis> There will be no warning if a configuration variable
+is not defined or is empty. The result will of the expansion will
+then be empty.
+</para>
+
+</sect2>
+
+<sect2>
+<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
+used just like any ordinary configuration or environment
+variable.
+</para>
- <p>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 <tt/user_/ and can be
- used just like any ordinary configuration or environment
- variable.
+<para>
+For example, to view the manual, users can either define two
+macros like the following
+</para>
- <p>For example, to view the manual, users can either define two
- macros like the following
+<para>
-<tscreen><verb>
+<screen>
macro generic <F1> "!less -r /path/to/manual" "Show manual"
macro pager <F1> "!less -r /path/to/manual" "Show manual"
-</verb></tscreen>
+</screen>
+
+</para>
- <p>for <tt/generic/, <tt/pager/ and <tt/index/. The alternative is to
- define a custom variable like so:
+<para>
+for <literal>generic</literal>, <literal>pager</literal> and <literal>index</literal>. The alternative is to
+define a custom variable like so:
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
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"
-</verb></tscreen>
+</screen>
+
+</para>
- <p>to re-use the command sequence as in:
+<para>
+to re-use the command sequence as in:
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
macro index <F2> "$user_manualcmd | grep '\^[ ]\\+~. '" "Show Patterns"
-</verb></tscreen>
+</screen>
+
+</para>
- <p>Using this feature, arbitrary sequences can be defined once and
- recalled and reused where necessary. More advanced scenarios could
- include to save a variable's value at the beginning of macro
- sequence and restore it at end.
+<para>
+Using this feature, arbitrary sequences can be defined once and
+recalled and reused where necessary. More advanced scenarios could
+include to save a variable's value at the beginning of macro
+sequence and restore it at end.
+</para>
- <p>When the variable is first defined, the first value it gets
- assigned is also the initial value to which it can be reset using
- the <tt/reset/ command.
+<para>
+When the variable is first defined, the first value it gets
+assigned is also the initial value to which it can be reset using
+the <literal>reset</literal> command.
+</para>
- <p>The complete removal is done via the <tt/unset/ keyword.
+<para>
+The complete removal is done via the <literal>unset</literal> keyword.
+</para>
- <p>After the following sequence:
+<para>
+After the following sequence:
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
set user_foo = 42
set user_foo = 666
-</verb></tscreen>
+</screen>
+
+</para>
- <p>the variable <tt>$user_foo</tt> has a current value of 666 and an
- initial of 42. The query
+<para>
+the variable <literal>$user_foo</literal> has a current value of 666 and an
+initial of 42. The query
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
set ?user_foo
-</verb></tscreen>
+</screen>
+
+</para>
- <p>will show 666. After doing the reset via
+<para>
+will show 666. After doing the reset via
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
reset user_foo
-</verb></tscreen>
+</screen>
+
+</para>
- <p>a following query will give 42 as the result. After unsetting it
- via
+<para>
+a following query will give 42 as the result. After unsetting it
+via
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
unset user_foo
-</verb></tscreen>
+</screen>
+
+</para>
+
+<para>
+any query or operation (except the noted expansion within other
+statements) will lead to an error message.
+</para>
+
+</sect2>
- <p>any query or operation (except the noted expansion within other
- statements) will lead to an error message.
+<sect2>
+<title>Pre-Defined Variables </title>
- <sect1>Pre-Defined Variables
+<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 be set, unset or
+reset. The reference chapter lists all available variables.
+</para>
- <p>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
- <tt/muttng_/ and are read-only, i.e. they cannot be set, unset or
- reset. The reference chapter lists all available variables.
+<para>
+<emphasis> Please consult the local copy of your manual for their
+values as they may differ from different manual sources.</emphasis> Where
+the manual is installed in can be queried (already using such a
+variable) by running:
+</para>
- <p><em> Please consult the local copy of your manual for their
- values as they may differ from different manual sources.</em> Where
- the manual is installed in can be queried (already using such a
- variable) by running:
+<para>
-<tscreen><verb>
+<screen>
muttng -Q muttng_docdir
-</verb></tscreen>
+</screen>
- <p>To extend the example for viewing the manual via self-defined
- variables, it can be made more readable and more portable by
- changing the real path in:
+</para>
-<tscreen><verb>
+<para>
+To extend the example for viewing the manual via self-defined
+variables, it can be made more readable and more portable by
+changing the real path in:
+</para>
+
+<para>
+
+<screen>
set user_manualcmd = '!less -r /path/to_manual'
-</verb></tscreen>
+</screen>
+
+</para>
- <p>to:
+<para>
+to:
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
set user_manualcmd = "!less -r $muttng_docdir/manual.txt"
-</verb></tscreen>
+</screen>
+
+</para>
- <p>which works everywhere if a manual is installed.
+<para>
+which works everywhere if a manual is installed.
+</para>
- <p>Please note that by the type of quoting, muttng determines when
- to expand these values: when it finds double quotes, the value will
- be expanded during reading the setup files but when it finds single
- quotes, it'll expand it at runtime as needed.
+<para>
+Please note that by the type of quoting, muttng determines when
+to expand these values: when it finds double quotes, the value will
+be expanded during reading the setup files but when it finds single
+quotes, it'll expand it at runtime as needed.
+</para>
- <p>For example, the statement
+<para>
+For example, the statement
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
folder-hook . "set user_current_folder = $muttng_folder_name"
-</verb></tscreen>
+</screen>
+
+</para>
- <p>will be already be translated to the following when reading the
- startup files:
+<para>
+will be already be translated to the following when reading the
+startup files:
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
folder-hook . "set user_current_folder = some_folder"
-</verb></tscreen>
+</screen>
+
+</para>
- <p>with <tt/some_folder/ being the name of the first folder muttng
- opens. On the contrary,
+<para>
+with <literal>some_folder</literal> being the name of the first folder muttng
+opens. On the contrary,
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
folder-hook . 'set user_current_folder = $muttng_folder_name'
-</verb></tscreen>
+</screen>
+
+</para>
- <p>will be executed at runtime because of the single quotes so that
- <tt/user_current_folder/ will always have the value of the currently
- opened folder.
+<para>
+will be executed at runtime because of the single quotes so that
+<literal>user_current_folder</literal> will always have the value of the currently
+opened folder.
+</para>
- <p>A more practical example is:
+<para>
+A more practical example is:
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
folder-hook . 'source ~/.mutt/score-$muttng_folder_name'
-</verb></tscreen>
+</screen>
+
+</para>
+
+<para>
+which can be used to source files containing score commands
+depending on the folder the user enters.
+</para>
+
+</sect2>
- <p>which can be used to source files containing score commands
- depending on the folder the user enters.
+<sect2>
+<title>Type Conversions </title>
- <sect1>Type Conversions
+<para>
+A note about variable's types during conversion: internally
+values are stored in internal types but for any dump/query or set
+operation they're converted to and from string. That means that
+there's no need to worry about types when referencing any variable.
+As an example, the following can be used without harm (besides
+makeing muttng very likely behave strange):
+</para>
- <p>A note about variable's types during conversion: internally
- values are stored in internal types but for any dump/query or set
- operation they're converted to and from string. That means that
- there's no need to worry about types when referencing any variable.
- As an example, the following can be used without harm (besides
- makeing muttng very likely behave strange):
+<para>
-<tscreen><verb>
+<screen>
set read_inc = 100
set folder = $read_inc
set read_inc = $folder
set user_magic_number = 42
set folder = $user_magic_number
-</verb></tscreen>
+</screen>
-<!--}}}-->
+</para>
+
+</sect2>
-<sect>Defining/Using aliases<label id="alias"> <!--{{{-->
-<p>
+</sect1>
-Usage: <tt/alias/ <em/key/ <em/address/ [ , <em/address/, ... ]
+<sect1 id="alias">
+<title>Defining/Using aliases </title>
+<para>
+Usage: <literal>alias</literal> <emphasis>key</emphasis> <emphasis>address</emphasis> [ , <emphasis>address</emphasis>, ... ]
+</para>
+
+<para>
It's usually very cumbersome to remember or type out the address of someone
you are communicating with. Mutt-ng allows you to create ``aliases'' which map
a short string to a full address.
+</para>
-<bf/Note:/ if you want to create an alias for a group (by specifying more than
-one address), you <bf/must/ separate the addresses with a comma (``,'').
+<para>
+<emphasis role="bold">Note:</emphasis> if you want to create an alias for a group (by specifying more than
+one address), you <emphasis role="bold">must</emphasis> separate the addresses with a comma (``,'').
+</para>
+<para>
To remove an alias or aliases (``*'' means all aliases):
+</para>
+
+<para>
+<literal>unalias</literal> [ * | <emphasis>key</emphasis> <emphasis>...</emphasis> ]
+</para>
-<tt/unalias/ [ * | <em/key/ <em/.../ ]
+<para>
-<tscreen><verb>
+<screen>
alias muttdude me@cs.hmc.edu (Michael Elkins)
alias theguys manny, moe, jack
-</verb></tscreen>
+</screen>
+</para>
+
+<para>
Unlike other mailers, Mutt-ng doesn't require aliases to be defined
-in a special file. The <tt/alias/ command can appear anywhere in
-a configuration file, as long as this file is <ref id="source"
-name="sourced">. Consequently, you can have multiple alias files, or
+in a special file. The <literal>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
you can have all aliases defined in your muttrc.
+</para>
-On the other hand, the <ref id="create-alias" name="create-alias">
-function can use only one file, the one pointed to by the <ref
-id="alias_file" name="$alias_file"> variable (which is
-<tt>˜/.muttrc</tt> by default). This file is not special either,
+<para>
+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> variable (which is
+<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 <ref
-id="source" name="source"> this file too.
+order for the new aliases to take effect you need to explicitly <link linkend="source">source</link> this file too.
+</para>
+<para>
For example:
+</para>
+
+<para>
-<tscreen><verb>
+<screen>
source /usr/local/share/Mutt-ng.aliases
source ~/.mail_aliases
set alias_file=~/.mail_aliases
-</verb></tscreen>
+</screen>
+</para>
+
+<para>
To use aliases, you merely use the alias at any place in mutt where mutt
-prompts for addresses, such as the <em/To:/ or <em/Cc:/ prompt. You can
+prompts for addresses, such as the <emphasis>To:</emphasis> or <emphasis>Cc:</emphasis> prompt. You can
also enter aliases in your editor at the appropriate headers if you have the
-<ref id="edit_headers" name="$edit_headers"> variable set.
+<link linkend="edit-headers">edit-headers</link> variable set.
+</para>
+<para>
In addition, at the various address prompts, you can use the tab character
to expand a partial alias to the full alias. If there are multiple matches,
mutt will bring up a menu with the matching aliases. In order to be
presented with the full list of aliases, you must hit tab with out a partial
alias, such as at the beginning of the prompt or after a comma denoting
multiple addresses.
+</para>
+<para>
In the alias menu, you can select as many aliases as you want with the
-<em/select-entry/ key (default: RET), and use the <em/exit/ key
+<emphasis>select-entry</emphasis> key (default: RET), and use the <emphasis>exit</emphasis> key
(default: q) to return to the address prompt.
+</para>
+
+<para>
+
+</para>
+
+</sect1>
-<!--}}}-->
+<sect1 id="bind">
+<title>Changing the default key bindings </title>
-<sect>Changing the default key bindings<label id="bind"> <!--{{{-->
-<p>
-Usage: <tt/bind/ <em/map/ <em/key/ <em/function/
+<para>
+Usage: <literal>bind</literal> <emphasis>map</emphasis> <emphasis>key</emphasis> <emphasis>function</emphasis>
+</para>
+<para>
This command allows you to change the default key bindings (operation
invoked when pressing a key).
+</para>
-<em/map/ specifies in which menu the binding belongs. Multiple maps may
+<para>
+<emphasis>map</emphasis> specifies in which menu the binding belongs. Multiple maps may
be specified by separating them with commas (no additional whitespace is
allowed). The currently defined maps are:
+</para>
-<label id="maps">
-<descrip>
-<tag/generic/
+<para>
+<anchor id="maps"/>
+<variablelist>
+
+<varlistentry>
+<term>generic</term>
+<listitem>
+<para>
This is not a real menu, but is used as a fallback for all of the other
menus except for the pager and editor modes. If a key is not defined in
another menu, Mutt-ng will look for a binding to use in this menu. This allows
you to bind a key to a certain function in multiple menus instead of having
multiple bind statements to accomplish the same task.
-<tag/alias/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>alias</term>
+<listitem>
+<para>
The alias menu is the list of your personal aliases as defined in your
muttrc. It is the mapping from a short alias name to the full email
address(es) of the recipient(s).
-<tag/attach/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>attach</term>
+<listitem>
+<para>
The attachment menu is used to access the attachments on received messages.
-<tag/browser/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>browser</term>
+<listitem>
+<para>
The browser is used for both browsing the local directory structure, and for
listing all of your incoming mailboxes.
-<tag/editor/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>editor</term>
+<listitem>
+<para>
The editor is the line-based editor the user enters text data.
-<tag/index/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>index</term>
+<listitem>
+<para>
The index is the list of messages contained in a mailbox.
-<tag/compose/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>compose</term>
+<listitem>
+<para>
The compose menu is the screen used when sending a new message.
-<tag/pager/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>pager</term>
+<listitem>
+<para>
The pager is the mode used to display message/attachment data, and help
listings.
-<tag/pgp/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>pgp</term>
+<listitem>
+<para>
The pgp menu is used to select the OpenPGP keys used for encrypting outgoing
messages.
-<tag/postpone/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>postpone</term>
+<listitem>
+<para>
The postpone menu is similar to the index menu, except is used when
recalling a message the user was composing, but saved until later.
-</descrip>
-
-<em/key/ is the key (or key sequence) you wish to bind. To specify a
-control character, use the sequence <em/\Cx/, where <em/x/ is the
+</para>
+</listitem></varlistentry>
+</variablelist>
+</para>
+
+<para>
+<emphasis>key</emphasis> is the key (or key sequence) you wish to bind. To specify a
+control character, use the sequence <emphasis>\Cx</emphasis>, where <emphasis>x</emphasis> is the
letter of the control character (for example, to specify control-A use
-``\Ca''). Note that the case of <em/x/ as well as <em/\C/ is
-ignored, so that <em/\CA/, <em/\Ca/, <em/\cA/ and <em/\ca/ are all
+``\Ca''). Note that the case of <emphasis>x</emphasis> as well as <emphasis>\C</emphasis> is
+ignored, so that <emphasis>\CA</emphasis>, <emphasis>\Ca</emphasis>, <emphasis>\cA</emphasis> and <emphasis>\ca</emphasis> are all
equivalent. An alternative form is to specify the key as a three digit
-octal number prefixed with a ``\'' (for example <em/\177/ is
-equivalent to <em/\c?/).
+octal number prefixed with a ``\'' (for example <emphasis>\177</emphasis> is
+equivalent to <emphasis>\c?</emphasis>).
+</para>
-In addition, <em/key/ may consist of:
+<para>
+In addition, <emphasis>key</emphasis> may consist of:
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
\t tab
-<tab> tab
-<backtab> backtab / shift-tab
+<tab> tab
+<backtab> backtab / shift-tab
\r carriage return
\n newline
\e escape
-<esc> escape
-<up> up arrow
-<down> down arrow
-<left> left arrow
-<right> right arrow
-<pageup> Page Up
-<pagedown> Page Down
-<backspace> Backspace
-<delete> Delete
-<insert> Insert
-<enter> Enter
-<return> Return
-<home> Home
-<end> End
-<space> Space bar
-<f1> function key 1
-<f10> function key 10
-</verb></tscreen>
-
-<em/key/ does not need to be enclosed in quotes unless it contains a
+<esc> escape
+<up> up arrow
+<down> down arrow
+<left> left arrow
+<right> right arrow
+<pageup> Page Up
+<pagedown> Page Down
+<backspace> Backspace
+<delete> Delete
+<insert> Insert
+<enter> Enter
+<return> Return
+<home> Home
+<end> End
+<space> Space bar
+<f1> function key 1
+<f10> function key 10
+</screen>
+
+</para>
+
+<para>
+<emphasis>key</emphasis> does not need to be enclosed in quotes unless it contains a
space (`` '').
+</para>
-<em/function/ specifies which action to take when <em/key/ is pressed.
-For a complete list of functions, see the <ref id="functions"
-name="reference">. The special function <tt/noop/ unbinds the specified key
+<para>
+<emphasis>function</emphasis> specifies which action to take when <emphasis>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
sequence.
+</para>
+
+<para>
+
+</para>
+
+</sect1>
-<!--}}}-->
+<sect1 id="charset-hook">
+<title>Defining aliases for character sets </title>
-<sect>Defining aliases for character sets <label id="charset-hook"> <!--{{{-->
-<p>
-Usage: <tt/charset-hook/ <em/alias/ <em/charset/<newline>
-Usage: <tt/iconv-hook/ <em/charset/ <em/local-charset/
+<para>
+Usage: <literal>charset-hook</literal> <emphasis>alias</emphasis> <emphasis>charset</emphasis>
-The <tt/charset-hook/ command defines an alias for a character set.
+Usage: <literal>iconv-hook</literal> <emphasis>charset</emphasis> <emphasis>local-charset</emphasis>
+</para>
+
+<para>
+The <literal>charset-hook</literal> command defines an alias for a character set.
This is useful to properly display messages which are tagged with a
character set name not known to mutt.
+</para>
-The <tt/iconv-hook/ command defines a system-specific name for a
+<para>
+The <literal>iconv-hook</literal> command defines a system-specific name for a
character set. This is helpful when your systems character
conversion library insists on using strange, system-specific names
for character sets.
+</para>
+
+<para>
+
+</para>
-<!--}}}-->
+</sect1>
-<sect>Setting variables based upon mailbox<label id="folder-hook"> <!--{{{-->
-<p>
-Usage: <tt/folder-hook/ [!]<em/regexp/ <em/command/
+<sect1 id="folder-hook">
+<title>Setting variables based upon mailbox </title>
+<para>
+Usage: <literal>folder-hook</literal> [!]<emphasis>regexp</emphasis> <emphasis>command</emphasis>
+</para>
+
+<para>
It is often desirable to change settings based on which mailbox you are
reading. The folder-hook command provides a method by which you can execute
-any configuration command. <em/regexp/ is a regular expression specifying
-in which mailboxes to execute <em/command/ before loading. If a mailbox
+any configuration command. <emphasis>regexp</emphasis> is a regular expression specifying
+in which mailboxes to execute <emphasis>command</emphasis> before loading. If a mailbox
matches multiple folder-hook's, they are executed in the order given in the
muttrc.
+</para>
-<bf/Note:/ if you use the ``!'' shortcut for <ref id="spoolfile"
-name="$spoolfile"> at the beginning of the pattern, you must place it
+<para>
+<emphasis role="bold">Note:</emphasis> if you use the ``!'' shortcut for <link linkend="spoolfile">spoolfile</link> at the beginning of the pattern, you must place it
inside of double or single quotes in order to distinguish it from the
-logical <em/not/ operator for the expression.
+logical <emphasis>not</emphasis> operator for the expression.
+</para>
-Note that the settings are <em/not/ restored when you leave the mailbox.
+<para>
+Note that the settings are <emphasis>not</emphasis> restored when you leave the mailbox.
For example, a command action to perform is to change the sorting method
based upon the mailbox being read:
+</para>
+
+<para>
-<tscreen><verb>
+<screen>
folder-hook mutt set sort=threads
-</verb></tscreen>
+</screen>
+</para>
+
+<para>
However, the sorting method is not restored to its previous value when
-reading a different mailbox. To specify a <em/default/ command, use the
+reading a different mailbox. To specify a <emphasis>default</emphasis> command, use the
pattern ``.'':
+</para>
+
+<para>
-<p>
-<tscreen><verb>
+<screen>
folder-hook . set sort=date-sent
-</verb></tscreen>
+</screen>
+
+</para>
+
+<para>
+
+</para>
+
+</sect1>
-<!--}}}-->
+<sect1 id="macro">
+<title>Keyboard macros </title>
-<sect>Keyboard macros<label id="macro"> <!--{{{-->
-<p>
-Usage: <tt/macro/ <em/menu/ <em/key/ <em/sequence/ [ <em/description/ ]
+<para>
+Usage: <literal>macro</literal> <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>sequence</emphasis> [ <emphasis>description</emphasis> ]
+</para>
+<para>
Macros are useful when you would like a single key to perform a series of
-actions. When you press <em/key/ in menu <em/menu/, Mutt-ng will behave as if
-you had typed <em/sequence/. So if you have a common sequence of commands
+actions. When you press <emphasis>key</emphasis> in menu <emphasis>menu</emphasis>, Mutt-ng will behave as if
+you had typed <emphasis>sequence</emphasis>. So if you have a common sequence of commands
you type, you can create a macro to execute those commands with a single
key.
+</para>
-<em/menu/ is the <ref id="maps" name="map"> which the macro will be bound.
+<para>
+<emphasis>menu</emphasis> is the <link linkend="maps">maps</link> which the macro will be bound.
Multiple maps may be specified by separating multiple menu arguments by
commas. Whitespace may not be used in between the menu arguments and the
commas separating them.
+</para>
-<em/key/ and <em/sequence/ are expanded by the same rules as the <ref
-id="bind" name="key bindings">. There are some additions however. The
-first is that control characters in <em/sequence/ can also be specified
-as <em/ˆx/. In order to get a caret (`ˆ'') you need to use
-<em/ˆˆ/. Secondly, to specify a certain key such as <em/up/
+<para>
+<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
-<em/<key name>/ and <em/<function name>/. For a listing of key
-names see the section on <ref id="bind" name="key bindings">. Functions
-are listed in the <ref id="functions" name="function reference">.
+<emphasis><key name></emphasis> and <emphasis><function name></emphasis>. For a listing of key
+names see the section on <link linkend="bind">bind</link>. Functions
+are listed in the <link linkend="functions">functions</link>.
+</para>
+<para>
The advantage with using function names directly is that the macros will
work regardless of the current key bindings, so they are not dependent on
the user having particular key definitions. This makes them more robust
and portable, and also facilitates defining of macros in files used by more
than one user (eg. the system Muttngrc).
+</para>
-Optionally you can specify a descriptive text after <em/sequence/,
+<para>
+Optionally you can specify a descriptive text after <emphasis>sequence</emphasis>,
which is shown in the help screens.
+</para>
-<bf/Note:/ Macro definitions (if any) listed in the help screen(s), are
+<para>
+<emphasis role="bold">Note:</emphasis> Macro definitions (if any) listed in the help screen(s), are
silently truncated at the screen width, and are not wrapped.
+</para>
-<!--}}}-->
+<para>
+
+</para>
+
+</sect1>
+
+<sect1 id="color">
+<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> ]
-<sect>Using color and mono video attributes<label id="color"> <!--{{{-->
-<p>
-Usage: <tt/color/ <em/object/ <em/foreground/ <em/background/ [ <em/regexp/ ]<newline>
-Usage: <tt/color/ index <em/foreground/ <em/background/ <em/pattern/<newline>
-Usage: <tt/uncolor/ index <em/pattern/ [ <em/pattern/ ... ]<newline>
+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> ... ]
+
+</para>
+
+<para>
If your terminal supports color, you can spice up Mutt-ng by creating your own
color scheme. To define the color of an object (type of information), you
-must specify both a foreground color <bf/and/ a background color (it is not
+must specify both a foreground color <emphasis role="bold">and</emphasis> a background color (it is not
possible to only specify one or the other).
-
-<em/object/ can be one of:
-
-<itemize>
-<item>attachment
-<item>body (match <em/regexp/ in the body of messages)
-<item>bold (highlighting bold patterns in the body of messages)
-<item>error (error messages printed by Mutt-ng)
-<item>header (match <em/regexp/ in the message header)
-<item>hdrdefault (default color of the message header in the pager)
-<item>index (match <em/pattern/ in the message index)
-<item>indicator (arrow or bar used to indicate the current item in a menu)
-<item>markers (the ``+'' markers at the beginning of wrapped lines in the pager)
-<item>message (informational messages)
-<item>normal
-<item>quoted (text matching <ref id="quote_regexp"
-name="$quote_regexp"> in the body of a message)
-<item>quoted1, quoted2, ..., quoted<bf/N/ (higher levels of quoting)
-<item>search (highlighting of words in the pager)
-<item>signature
-<item>status (mode lines used to display info about the mailbox or message)
-<item>tilde (the ``˜'' used to pad blank lines in the pager)
-<item>tree (thread tree drawn in the message index and attachment menu)
-<item>underline (highlighting underlined patterns in the body of messages)
-</itemize>
-
-<em/foreground/ and <em/background/ can be one of the following:
-
-<itemize>
-<item>white
-<item>black
-<item>green
-<item>magenta
-<item>blue
-<item>cyan
-<item>yellow
-<item>red
-<item>default
-<item>color<em/x/
-</itemize>
-
-<em/foreground/ can optionally be prefixed with the keyword <tt/bright/ to make
-the foreground color boldfaced (e.g., <tt/brightred/).
-
-If your terminal supports it, the special keyword <em/default/ can be
-used as a transparent color. The value <em/brightdefault/ is also valid.
-If Mutt-ng is linked against the <em/S-Lang/ library, you also need to set
-the <em/COLORFGBG/ environment variable to the default colors of your
+</para>
+
+<para>
+<emphasis>object</emphasis> can be one of:
+</para>
+
+<para>
+
+<itemizedlist>
+<listitem>
+
+<para>
+attachment
+</para>
+</listitem>
+<listitem>
+
+<para>
+body (match <emphasis>regexp</emphasis> in the body of messages)
+</para>
+</listitem>
+<listitem>
+
+<para>
+bold (highlighting bold patterns in the body of messages)
+</para>
+</listitem>
+<listitem>
+
+<para>
+error (error messages printed by Mutt-ng)
+</para>
+</listitem>
+<listitem>
+
+<para>
+header (match <emphasis>regexp</emphasis> in the message header)
+</para>
+</listitem>
+<listitem>
+
+<para>
+hdrdefault (default color of the message header in the pager)
+</para>
+</listitem>
+<listitem>
+
+<para>
+index (match <emphasis>pattern</emphasis> in the message index)
+</para>
+</listitem>
+<listitem>
+
+<para>
+indicator (arrow or bar used to indicate the current item in a menu)
+</para>
+</listitem>
+<listitem>
+
+<para>
+markers (the ``+'' markers at the beginning of wrapped lines in the pager)
+</para>
+</listitem>
+<listitem>
+
+<para>
+message (informational messages)
+</para>
+</listitem>
+<listitem>
+
+<para>
+normal
+</para>
+</listitem>
+<listitem>
+
+<para>
+quoted (text matching <link linkend="quote-regexp">quote-regexp</link> in the body of a message)
+</para>
+</listitem>
+<listitem>
+
+<para>
+quoted1, quoted2, ..., quoted<emphasis role="bold">N</emphasis> (higher levels of quoting)
+</para>
+</listitem>
+<listitem>
+
+<para>
+search (highlighting of words in the pager)
+</para>
+</listitem>
+<listitem>
+
+<para>
+signature
+</para>
+</listitem>
+<listitem>
+
+<para>
+status (mode lines used to display info about the mailbox or message)
+</para>
+</listitem>
+<listitem>
+
+<para>
+tilde (the ``˜'' used to pad blank lines in the pager)
+</para>
+</listitem>
+<listitem>
+
+<para>
+tree (thread tree drawn in the message index and attachment menu)
+</para>
+</listitem>
+<listitem>
+
+<para>
+underline (highlighting underlined patterns in the body of messages)
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+<para>
+<emphasis>foreground</emphasis> and <emphasis>background</emphasis> can be one of the following:
+</para>
+
+<para>
+
+<itemizedlist>
+<listitem>
+
+<para>
+white
+</para>
+</listitem>
+<listitem>
+
+<para>
+black
+</para>
+</listitem>
+<listitem>
+
+<para>
+green
+</para>
+</listitem>
+<listitem>
+
+<para>
+magenta
+</para>
+</listitem>
+<listitem>
+
+<para>
+blue
+</para>
+</listitem>
+<listitem>
+
+<para>
+cyan
+</para>
+</listitem>
+<listitem>
+
+<para>
+yellow
+</para>
+</listitem>
+<listitem>
+
+<para>
+red
+</para>
+</listitem>
+<listitem>
+
+<para>
+default
+</para>
+</listitem>
+<listitem>
+
+<para>
+color<emphasis>x</emphasis>
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+<para>
+<emphasis>foreground</emphasis> can optionally be prefixed with the keyword <literal>bright</literal> to make
+the foreground color boldfaced (e.g., <literal>brightred</literal>).
+</para>
+
+<para>
+If your terminal supports it, the special keyword <emphasis>default</emphasis> can be
+used as a transparent color. The value <emphasis>brightdefault</emphasis> is also valid.
+If Mutt-ng is linked against the <emphasis>S-Lang</emphasis> library, you also need to set
+the <emphasis>COLORFGBG</emphasis> environment variable to the default colors of your
terminal for this to work; for example (for Bourne-like shells):
+</para>
+
+<para>
-<tscreen><verb>
+<screen>
set COLORFGBG="green;black"
export COLORFGBG
-</verb></tscreen>
+</screen>
-<bf/Note:/ The <em/S-Lang/ library requires you to use the <em/lightgray/
-and <em/brown/ keywords instead of <em/white/ and <em/yellow/ when
+</para>
+
+<para>
+<emphasis role="bold">Note:</emphasis> The <emphasis>S-Lang</emphasis> library requires you to use the <emphasis>lightgray</emphasis>
+and <emphasis>brown</emphasis> keywords instead of <emphasis>white</emphasis> and <emphasis>yellow</emphasis> when
setting this variable.
+</para>
-<bf/Note:/ The uncolor command can be applied to the index object only. It
-removes entries from the list. You <bf/must/ specify the same pattern
+<para>
+<emphasis role="bold">Note:</emphasis> The uncolor command can be applied to the index object only. It
+removes entries from the list. You <emphasis role="bold">must</emphasis> specify the same pattern
specified in the color command for it to be removed. The pattern ``*'' is
a special token which means to clear the color index list of all entries.
+</para>
-Mutt-ng also recognizes the keywords <em/color0/, <em/color1/, …,
-<em/color/<bf/N-1/ (<bf/N/ being the number of colors supported
+<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> being the number of colors supported
by your terminal). This is useful when you remap the colors for your
-display (for example by changing the color associated with <em/color2/
+display (for example by changing the color associated with <emphasis>color2</emphasis>
for your xterm), since color names may then lose their normal meaning.
+</para>
+<para>
If your terminal does not support color, it is still possible change the video
attributes through the use of the ``mono'' command:
+</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> ... ]
+
+</para>
+
+<para>
+where <emphasis>attribute</emphasis> is one of the following:
+</para>
+
+<para>
+
+<itemizedlist>
+<listitem>
-Usage: <tt/mono/ <em/<object> <attribute>/ [ <em/regexp/ ]<newline>
-Usage: <tt/mono/ index <em/attribute/ <em/pattern/<newline>
-Usage: <tt/unmono/ index <em/pattern/ [ <em/pattern/ ... ]<newline>
+<para>
+none
+</para>
+</listitem>
+<listitem>
-where <em/attribute/ is one of the following:
+<para>
+bold
+</para>
+</listitem>
+<listitem>
-<itemize>
-<item>none
-<item>bold
-<item>underline
-<item>reverse
-<item>standout
-</itemize>
+<para>
+underline
+</para>
+</listitem>
+<listitem>
-<!--}}}-->
+<para>
+reverse
+</para>
+</listitem>
+<listitem>
-<sect>Ignoring (weeding) unwanted message headers<label id="ignore"> <!--{{{-->
-<p>
-Usage: <tt/[un]ignore/ <em/pattern/ [ <em/pattern/ ... ]
+<para>
+standout
+</para>
+</listitem>
+</itemizedlist>
+
+</para>
+
+<para>
+
+</para>
+
+</sect1>
+
+<sect1 id="ignore">
+<title>Ignoring (weeding) unwanted message headers </title>
+
+<para>
+Usage: <literal>[un]ignore</literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
+</para>
+
+<para>
Messages often have many header fields added by automatic processing systems,
or which may not seem useful to display on the screen. This command allows
you to specify header fields which you don't normally want to see.
+</para>
+<para>
You do not need to specify the full header field name. For example,
``ignore content-'' will ignore all header fields that begin with the pattern
``content-''. ``ignore *'' will ignore all headers.
+</para>
+<para>
To remove a previously added token from the list, use the ``unignore'' command.
The ``unignore'' command will make Mutt-ng display headers with the given pattern.
For example, if you do ``ignore x-'' it is possible to ``unignore x-mailer''.
+</para>
+<para>
``unignore *'' will remove all tokens from the ignore list.
+</para>
+<para>
For example:
-<tscreen><verb>
+
+<screen>
# Sven's draconian header weeding
ignore *
unignore from date subject to cc
unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
unignore posted-to:
-</verb></tscreen>
+</screen>
-<!--}}}-->
+</para>
-<sect>Alternative addresses<label id="alternates"> <!--{{{-->
-<p>
-Usage: <tt/[un]alternates/ <em/regexp/ [ <em/regexp/ ... ]<newline>
+<para>
+
+</para>
+
+</sect1>
+
+<sect1 id="alternates">
+<title>Alternative addresses </title>
+
+<para>
+Usage: <literal>[un]alternates</literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+</para>
+
+<para>
With various functions, mutt will treat messages differently,
depending on whether you sent them or whether you received them from
someone else. For instance, when replying to a message that you
sent to a different party, mutt will automatically suggest to send
the response to the original message's recipients -- responding to
-yourself won't make much sense in many cases. (See <ref
-id="reply_to" name="$reply_to">.)
+yourself won't make much sense in many cases. (See <link linkend="reply-to">reply-to</link>.)
+</para>
+<para>
Many users receive e-mail under a number of different addresses. To
fully use mutt's features here, the program must be able to
recognize what e-mail addresses you receive mail under. That's the
-purpose of the <tt/alternates/ command: It takes a list of regular
+purpose of the <literal>alternates</literal> command: It takes a list of regular
expressions, each of which can identify an address under which you
receive e-mail.
+</para>
-The <tt/unalternates/ command can be used to write exceptions to
-<tt/alternates/ patterns. If an address matches something in an
-<tt/alternates/ command, but you nonetheless do not think it is
-from you, you can list a more precise pattern under an <tt/unalternates/
+<para>
+The <literal>unalternates</literal> command can be used to write exceptions to
+<literal>alternates</literal> patterns. If an address matches something in an
+<literal>alternates</literal> command, but you nonetheless do not think it is
+from you, you can list a more precise pattern under an <literal>unalternates</literal>
command.
+</para>
+
+<para>
+To remove a regular expression from the <literal>alternates</literal> list, use the
+<literal>unalternates</literal> command with exactly the same <emphasis>regexp</emphasis>.
+Likewise, if the <emphasis>regexp</emphasis> for a <literal>alternates</literal> command matches
+an entry on the <literal>unalternates</literal> list, that <literal>unalternates</literal>
+entry will be removed. If the <emphasis>regexp</emphasis> for <literal>unalternates</literal>
+is ``*'', <emphasis>all entries</emphasis> on <literal>alternates</literal> will be removed.
+</para>
+
+<para>
+
+</para>
+
+</sect1>
+
+<sect1>
+<title>Format = Flowed </title>
+
+<sect2>
+<title>Introduction </title>
+
+<para>
+Mutt-ng contains support for so-called <literal>format=flowed</literal> messages.
+In the beginning of email, each message had a fixed line width, and
+it was enough for displaying them on fixed-size terminals. But times
+changed, and nowadays hardly anybody still uses fixed-size terminals:
+more people nowaydays use graphical user interfaces, with dynamically
+resizable windows. This led to the demand of a new email format that
+makes it possible for the email client to make the email look nice
+in a resizable window without breaking quoting levels and creating
+an incompatible email format that can also be displayed nicely on
+old fixed-size terminals.
+</para>
+
+<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
+>.
+</para>
+
+</sect2>
+
+<sect2>
+<title>Receiving: Display Setup </title>
+
+<para>
+When you receive emails that are marked as <literal>format=flowed</literal>
+messages, and is formatted correctly, mutt-ng will try to reformat
+the message to optimally fit on your terminal. If you want a fixed
+margin on the right side of your terminal, you can set the
+following:
+</para>
+
+<para>
+
+<screen>
+ set wrapmargin = 10
+
+</screen>
-To remove a regular expression from the <tt/alternates/ list, use the
-<tt/unalternates/ command with exactly the same <em/regexp/.
-Likewise, if the <em/regexp/ for a <tt/alternates/ command matches
-an entry on the <tt/unalternates/ list, that <tt/unalternates/
-entry will be removed. If the <em/regexp/ for <tt/unalternates/
-is ``*'', <em/all entries/ on <tt/alternates/ will be removed.
-
-<!--}}}-->
-
-<sect>Format = Flowed <!--{{{-->
-
- <sect1>Introduction <!--{{{-->
-
- <p>Mutt-ng contains support for so-called <tt/format=flowed/ messages.
- In the beginning of email, each message had a fixed line width, and
- it was enough for displaying them on fixed-size terminals. But times
- changed, and nowadays hardly anybody still uses fixed-size terminals:
- more people nowaydays use graphical user interfaces, with dynamically
- resizable windows. This led to the demand of a new email format that
- makes it possible for the email client to make the email look nice
- in a resizable window without breaking quoting levels and creating
- an incompatible email format that can also be displayed nicely on
- old fixed-size terminals.
-
- <p>For introductory information on <tt/format=flowed/ messages, see
- <htmlurl url="http://www.joeclark.org/ffaq.html"
- name="<http://www.joeclark.org/ffaq.html>">.
-
- <!--}}}-->
+</para>
- <sect1>Receiving: Display Setup <!--{{{-->
+<para>
+The code above makes the line break 10 columns before the right
+side of the terminal.
+</para>
- <p>When you receive emails that are marked as <tt/format=flowed/
- messages, and is formatted correctly, mutt-ng will try to reformat
- the message to optimally fit on your terminal. If you want a fixed
- margin on the right side of your terminal, you can set the
- following:
+<para>
+If your terminal is so wide that the lines are embarrassingly long,
+you can also set a maximum line length:
+</para>
- <verb>
- set wrapmargin = 10
- </verb>
+<para>
- <p>The code above makes the line break 10 columns before the right
- side of the terminal.
+<screen>
+ set max_line_length = 120
+
+</screen>
- <p>If your terminal is so wide that the lines are embarrassingly long,
- you can also set a maximum line length:
+</para>
- <verb>
- set max_line_length = 120
- </verb>
+<para>
+The example above will give you lines not longer than 120
+characters.
+</para>
- <p>The example above will give you lines not longer than 120
- characters.
+<para>
+When you view at <literal>format=flowed</literal> messages, you will often see
+the quoting hierarchy like in the following example:
+</para>
- <p>When you view at <tt/format=flowed/ messages, you will often see
- the quoting hierarchy like in the following example:
+<para>
- <verb>
+<screen>
>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.
- </verb>
+
+</screen>
+
+</para>
- <p>This obviously doesn't look very nice, and it makes it very
- hard to differentiate between text and quoting character. The
- solution is to configure mutt-ng to "stuff" the quoting:
+<para>
+This obviously doesn't look very nice, and it makes it very
+hard to differentiate between text and quoting character. The
+solution is to configure mutt-ng to "stuff" the quoting:
+</para>
- <verb>
+<para>
+
+<screen>
set stuff_quoted
- </verb>
+
+</screen>
+
+</para>
+
+<para>
+This will lead to a nicer result that is easier to read:
+</para>
- <p>This will lead to a nicer result that is easier to read:
+<para>
- <verb>
+<screen>
> 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.
- </verb>
+
+</screen>
+
+</para>
- <!--}}}-->
+</sect2>
- <sect1>Sending <!--{{{-->
+<sect2>
+<title>Sending </title>
- <p>If you want mutt-ng to send emails with <tt/format=flowed/ set, you
- need to explicitly set it:
+<para>
+If you want mutt-ng to send emails with <literal>format=flowed</literal> set, you
+need to explicitly set it:
+</para>
- <verb>
+<para>
+
+<screen>
set text_flowed
- </verb>
+
+</screen>
+
+</para>
+
+<para>
+Additionally, you have to use an editor which supports writing
+<literal>format=flowed</literal>-conforming emails. For vim, this is done by
+adding <literal>w</literal> to the formatoptions (see <literal>:h formatoptions</literal> and
+<literal>:h fo-table</literal>) when writing emails.
+</para>
+
+<para>
+Also note that <emphasis>format=flowed</emphasis> knows about ``space-stuffing'',
+that is, when sending messages, some kinds of lines have to be
+indented with a single space on the sending side. On the receiving
+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
+space-stuff lines starting with:
+</para>
- <p>Additionally, you have to use an editor which supports writing
- <tt/format=flowed/-conforming emails. For vim, this is done by
- adding <tt/w/ to the formatoptions (see <tt/:h formatoptions/ and
- <tt/:h fo-table/) when writing emails.
+<para>
- <p>Also note that <em/format=flowed/ knows about ``space-stuffing'',
- that is, when sending messages, some kinds of lines have to be
- indented with a single space on the sending side. On the receiving
- 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
- space-stuff lines starting with:
+<itemizedlist>
+<listitem>
- <itemize>
+<para>
+<literal>></literal> This is <emphasis>not</emphasis> the quote character but a right
+angle used for other reasons
- <item><tt/>/ This is <em/not/ the quote character but a right
- angle used for other reasons
+</para>
+</listitem>
+<listitem>
- <item><tt/From/ with a trailing space.
+<para>
+<literal>From</literal> with a trailing space.
- <item>just a space for formatting reasons
+</para>
+</listitem>
+<listitem>
- </itemize>
+<para>
+just a space for formatting reasons
- Please make sure that you manually prepend a space to each of them.
+</para>
+</listitem>
- <!--}}}-->
+</itemizedlist>
- <sect1>Additional Notes <!--{{{-->
+</para>
- <p> For completeness, the <ref id="delete_space"
- name="$delete_space"> variable provides the mechanism
- to generate a <tt/DelSp=yes/ parameter on <em/outgoing/ messages.
- According to the standard, clients receiving a <tt/format=flowed/
- messages should delete the last space of a flowed line but still
- interpret the line as flowed. Because flowed lines usually contain
- only one space at the end, this parameter would make the receiving
- client concatenate the last word of the previous with the first of
- the current line <em/without/ a space. This makes ordinary text
- unreadable and is intended for languages rarely using spaces. So
- please use this setting only if you're sure what you're doing.
+<para>
+Please make sure that you manually prepend a space to each of them.
+</para>
- <!--}}}-->
+</sect2>
-<!--}}}-->
+<sect2>
+<title>Additional Notes</title>
-<sect>Mailing lists<label id="lists"> <!--{{{-->
-<p>
-Usage: <tt/[un]lists/ <em/regexp/ [ <em/regexp/ ... ]<newline>
-Usage: <tt/[un]subscribe/ <em/regexp/ [ <em/regexp/ ... ]
+<para>
+ For completeness, the <link linkend="delete-space">delete-space</link> variable provides the mechanism
+to generate a <literal>DelSp=yes</literal> parameter on <emphasis>outgoing</emphasis> messages.
+According to the standard, clients receiving a <literal>format=flowed</literal>
+messages should delete the last space of a flowed line but still
+interpret the line as flowed. Because flowed lines usually contain
+only one space at the end, this parameter would make the receiving
+client concatenate the last word of the previous with the first of
+the current line <emphasis>without</emphasis> a space. This makes ordinary text
+unreadable and is intended for languages rarely using spaces. So
+please use this setting only if you're sure what you're doing.
+</para>
-Mutt-ng has a few nice features for <ref id="using_lists" name="handling
-mailing lists">. In order to take advantage of them, you must
+<para>
+
+</para>
+
+</sect2>
+
+</sect1>
+
+<sect1 id="lists">
+<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> ... ]
+</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
specify which addresses belong to mailing lists, and which mailing
-lists you are subscribed to. Once you have done this, the <ref
-id="list-reply" name="list-reply"> function will work for all known lists.
+lists you are subscribed to. Once you have done this, the <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
not to send copies of replies to your personal address. Note that
the Mail-Followup-To header is a non-standard extension which is not
supported by all mail user agents. Adding it is not bullet-proof against
receiving personal CCs of list messages. Also note that the generation
-of the Mail-Followup-To header is controlled by the <ref id="followup_to"
-name="$followup_to"> configuration variable.
+of the Mail-Followup-To header is controlled by the <link linkend="followup-to">followup-to</link> configuration variable.
+</para>
+<para>
More precisely, Mutt-ng maintains lists of patterns for the addresses
of known and subscribed mailing lists. Every subscribed mailing
list is known. To mark a mailing list as known, use the ``lists''
command. To mark it as subscribed, use ``subscribe''.
+</para>
+<para>
You can use regular expressions with both commands. To mark all
messages sent to a specific bug report's address on mutt's bug
tracking system as list mail, for instance, you could say
-``subscribe [0-9]*@bugs.guug.de''. Often, it's sufficient to just
+``subscribe [0-9]*@bugs.guug.de''. Often, it's sufficient to just
give a portion of the list's e-mail address.
+</para>
+<para>
Specify as much of the address as you need to to remove ambiguity. For
example, if you've subscribed to the Mutt-ng mailing list, you will receive mail
-addressed to <em/mutt-users@mutt.org/. So, to tell Mutt-ng that this is a
+addressed to <emphasis>mutt-users@mutt.org</emphasis>. So, to tell Mutt-ng that this is a
mailing list, you could add ``lists mutt-users'' to your
initialization file. To tell mutt that you are subscribed to it,
add ``subscribe mutt-users'' to your initialization file instead.
If you also happen to get mail from someone whose address is
-<em/mutt-users@example.com/, you could use ``lists mutt-users@mutt\\.org''
+<emphasis>mutt-users@example.com</emphasis>, you could use ``lists mutt-users@mutt\\.org''
or ``subscribe mutt-users@mutt\\.org'' to
match only mail from the actual list.
+</para>
+<para>
The ``unlists'' command is used to remove a token from the list of
known and subscribed mailing-lists. Use ``unlists *'' to remove all
tokens.
+</para>
+<para>
To remove a mailing list from the list of subscribed mailing lists,
but keep it on the list of known mailing lists, use ``unsubscribe''.
+</para>
+
+<para>
+
+</para>
+
+</sect1>
-<!--}}}-->
+<sect1 id="mbox-hook">
+<title>Using Multiple spool mailboxes </title>
-<sect>Using Multiple spool mailboxes<label id="mbox-hook"> <!--{{{-->
-<p>
-Usage: <tt/mbox-hook/ [!]<em/pattern/ <em/mailbox/
+<para>
+Usage: <literal>mbox-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
+</para>
+<para>
This command is used to move read messages from a specified mailbox to a
different mailbox automatically when you quit or change folders.
-<em/pattern/ is a regular expression specifying the mailbox to treat as a
-``spool'' mailbox and <em/mailbox/ specifies where mail should be saved when
+<emphasis>pattern</emphasis> is a regular expression specifying the mailbox to treat as a
+``spool'' mailbox and <emphasis>mailbox</emphasis> specifies where mail should be saved when
read.
+</para>
-Unlike some of the other <em/hook/ commands, only the <em/first/ matching
+<para>
+Unlike some of the other <emphasis>hook</emphasis> commands, only the <emphasis>first</emphasis> matching
pattern is used (it is not possible to save read mail in more than a single
mailbox).
+</para>
+
+<para>
+
+</para>
-<!--}}}-->
+</sect1>
-<sect>Defining mailboxes which receive mail<label id="mailboxes"> <!--{{{-->
-<p>
-Usage: <tt/[un]mailboxes/ [!]<em/filename/ [ <em/filename/ ... ]
+<sect1 id="mailboxes">
+<title>Defining mailboxes which receive mail </title>
+<para>
+Usage: <literal>[un]mailboxes</literal> [!]<emphasis>filename</emphasis> [ <emphasis>filename</emphasis> ... ]
+</para>
+
+<para>
This command specifies folders which can receive mail and
which will be checked for new messages. By default, the
main menu status bar displays how many of these folders have
new messages.
-<p>
-When changing folders, pressing <em/space/ will cycle
+</para>
+
+<para>
+When changing folders, pressing <emphasis>space</emphasis> will cycle
through folders with new mail.
-<p>
+</para>
+
+<para>
Pressing TAB in the directory browser will bring up a menu showing the files
-specified by the <tt/mailboxes/ command, and indicate which contain new
+specified by the <literal>mailboxes</literal> command, and indicate which contain new
messages. Mutt-ng will automatically enter this mode when invoked from the
-command line with the <tt/-y/ option.
+command line with the <literal>-y</literal> option.
+</para>
+<para>
The ``unmailboxes'' command is used to remove a token from the list
of folders which receive mail. Use ``unmailboxes *'' to remove all
tokens.
+</para>
-<p>
-<bf/Note:/ new mail is detected by comparing the last modification time to
-the last access time. Utilities like <tt/biff/ or <tt/frm/ or any other
+<para>
+<emphasis role="bold">Note:</emphasis> new mail is detected by comparing the last modification time to
+the last access time. Utilities like <literal>biff</literal> or <literal>frm</literal> or any other
program which accesses the mailbox might cause Mutt-ng to never detect new mail
for that mailbox if they do not properly reset the access time. Backup
tools are another common reason for updated access times.
-<p>
+</para>
-<bf/Note:/ the filenames in the <tt/mailboxes/ command are resolved when
-the command is executed, so if these names contain <ref id="shortcuts"
-name="shortcut characters"> (such as ``='' and ``!''), any variable
-definition that affect these characters (like <ref id="folder"
-name="$folder"> and <ref id="spoolfile" name="$spoolfile">)
-should be executed before the <tt/mailboxes/ command.
+<para>
+<emphasis role="bold">Note:</emphasis> the filenames in the <literal>mailboxes</literal> command are resolved when
+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>)
+should be executed before the <literal>mailboxes</literal> command.
+</para>
-<!--}}}-->
+<para>
+
+</para>
-<sect>User defined headers<label id="my_hdr"> <!--{{{-->
-<p>
-Usage:<newline>
-<tt/my_hdr/ <em/string/<newline>
-<tt/unmy_hdr/ <em/field/ [ <em/field/ ... ]
+</sect1>
+<sect1 id="my-hdr">
+<title>User defined headers </title>
+
+<para>
+Usage:
+
+<literal>my_hdr</literal> <emphasis>string</emphasis>
+
+<literal>unmy_hdr</literal> <emphasis>field</emphasis> [ <emphasis>field</emphasis> ... ]
+</para>
+
+<para>
The ``my_hdr'' command allows you to create your own header
fields which will be added to every message you send.
+</para>
+<para>
For example, if you would like to add an ``Organization:'' header field to
all of your outgoing messages, you can put the command
+</para>
-<quote>
-my_hdr Organization: A Really Big Company, Anytown, USA
-</quote>
+<para>
+<screen>
+my_hdr Organization: A Really Big Company, Anytown, USA
+</screen>
+</para>
-in your <tt/.muttrc/.
+<para>
+in your <literal>.muttrc</literal>.
+</para>
-<bf/Note:/ space characters are <em/not/ allowed between the keyword and
+<para>
+<emphasis role="bold">Note:</emphasis> space characters are <emphasis>not</emphasis> allowed between the keyword and
the colon (``:''). The standard for electronic mail (RFC822) says that
space is illegal there, so Mutt-ng enforces the rule.
+</para>
+<para>
If you would like to add a header field to a single message, you should
-either set the <ref id="edit_headers" name="edit_headers"> variable,
-or use the <em/edit-headers/ function (default: ``E'') in the send-menu so
+either set the <link linkend="edit-headers">edit-headers</link> variable,
+or use the <emphasis>edit-headers</emphasis> function (default: ``E'') in the send-menu so
that you can edit the header of your message along with the body.
+</para>
+<para>
To remove user defined header fields, use the ``unmy_hdr''
command. You may specify an asterisk (``*'') to remove all header
fields, or the fields to remove. For example, to remove all ``To'' and
``Cc'' header fields, you could use:
+</para>
-<quote>
-unmy_hdr to cc
-</quote>
+<para>
+<screen>
+unmy_hdr to cc
+</screen>
+</para>
-<!--}}}-->
+<para>
+
+</para>
+
+</sect1>
-<sect>Defining the order of headers when viewing messages<label id="hdr_order"> <!--{{{-->
-<p>
-Usage: <tt/hdr_order/ <em/header1/ <em/header2/ <em/header3/
+<sect1 id="hdr-order">
+<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>
+</para>
+
+<para>
With this command, you can specify an order in which mutt will attempt
to present headers to you when viewing messages.
+</para>
-``unhdr_order *'' will clear all previous headers from the order list,
+<para>
+``unhdr_order *'' will clear all previous headers from the order list,
thus removing the header order effects set by the system-wide startup
file.
+</para>
+
+<para>
-<tscreen><verb>
+<screen>
hdr_order From Date: From: To: Cc: Subject:
-</verb></tscreen>
+</screen>
-<!--}}}-->
+</para>
-<sect>Specify default save filename<label id="save-hook"> <!--{{{-->
-<p>
-Usage: <tt/save-hook/ [!]<em/pattern/ <em/filename/
+<para>
+
+</para>
+
+</sect1>
+
+<sect1 id="save-hook">
+<title>Specify default save filename </title>
+
+<para>
+Usage: <literal>save-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>filename</emphasis>
+</para>
+<para>
This command is used to override the default filename used when saving
-messages. <em/filename/ will be used as the default filename if the message is
-<em/From:/ an address matching <em/regexp/ or if you are the author and the
-message is addressed <em/to:/ something matching <em/regexp/.
+messages. <emphasis>filename</emphasis> will be used as the default filename if the message is
+<emphasis>From:</emphasis> an address matching <emphasis>regexp</emphasis> or if you are the author and the
+message is addressed <emphasis>to:</emphasis> something matching <emphasis>regexp</emphasis>.
+</para>
-See <ref id="pattern_hook" name="Message Matching in Hooks"> for information on the exact format of <em/pattern/.
+<para>
+See <link linkend="pattern-hook">pattern-hook</link> for information on the exact format of <emphasis>pattern</emphasis>.
+</para>
+<para>
Examples:
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
save-hook aol\\.com$ +spam
-</verb></tscreen>
+</screen>
+
+</para>
+
+<para>
+Also see the <link linkend="fcc-save-hook">fcc-save-hook</link> command.
+</para>
-Also see the <ref id="fcc-save-hook" name="fcc-save-hook"> command.
+<para>
+
+</para>
+
+</sect1>
-<!--}}}-->
+<sect1 id="fcc-hook">
+<title>Specify default Fcc: mailbox when composing </title>
-<sect>Specify default Fcc: mailbox when composing<label id="fcc-hook"> <!--{{{-->
-<p>
-Usage: <tt/fcc-hook/ [!]<em/pattern/ <em/mailbox/
+<para>
+Usage: <literal>fcc-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
+</para>
+<para>
This command is used to save outgoing mail in a mailbox other than
-<ref id="record" name="$record">. Mutt-ng searches the initial list of
-message recipients for the first matching <em/regexp/ and uses <em/mailbox/
+<link linkend="record">record</link>. 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 <ref id="record" name="$record"> mailbox.
+to <link linkend="record">record</link> mailbox.
+</para>
-See <ref id="pattern_hook" name="Message Matching in Hooks"> for information on the exact format of <em/pattern/.
+<para>
+See <link linkend="pattern-hook">pattern-hook</link> for information on the exact format of <emphasis>pattern</emphasis>.
+</para>
-Example: <tt/fcc-hook [@.]aol\\.com$ +spammers/
+<para>
+Example: <literal>fcc-hook [@.]aol\\.com$ +spammers</literal>
+</para>
+<para>
The above will save a copy of all messages going to the aol.com domain to
-the `+spammers' mailbox by default. Also see the <ref id="fcc-save-hook"
-name="fcc-save-hook"> command.
+the `+spammers' mailbox by default. Also see the <link linkend="fcc-save-hook">fcc-save-hook</link> command.
+</para>
+
+<para>
+
+</para>
+
+</sect1>
+
+<sect1 id="fcc-save-hook">
+<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>
+</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.
+</para>
-<!--}}}-->
+<para>
+
+</para>
+
+</sect1>
-<sect>Specify default save filename and default Fcc: mailbox at once<label id="fcc-save-hook"> <!--{{{-->
-<p>
-Usage: <tt/fcc-save-hook/ [!]<em/pattern/ <em/mailbox/
+<sect1 id="send-hook">
+<title>Change settings based upon message recipients </title>
-This command is a shortcut, equivalent to doing both a <ref id="fcc-hook" name="fcc-hook">
-and a <ref id="save-hook" name="save-hook"> with its arguments.
+<para>
+Usage: <literal>reply-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
-<!--}}}-->
+Usage: <literal>send-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
-<sect>Change settings based upon message recipients<label id="send-hook"><label id="reply-hook"><label id="send2-hook"> <!--{{{-->
-<p>
-Usage: <tt/reply-hook/ [!]<em/pattern/ <em/command/<newline>
-Usage: <tt/send-hook/ [!]<em/pattern/ <em/command/<newline>
-Usage: <tt/send2-hook/ [!]<em/pattern/ <em/command/
+Usage: <literal>send2-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
+</para>
+<para>
These commands can be used to execute arbitrary configuration commands based
-upon recipients of the message. <em/pattern/ is a regular expression
-matching the desired address. <em/command/ is executed when <em/regexp/
+upon recipients of the message. <emphasis>pattern</emphasis> is a regular expression
+matching the desired address. <emphasis>command</emphasis> is executed when <emphasis>regexp</emphasis>
matches recipients of the message.
+</para>
-<tt/reply-hook/ is matched against the message you are <em/replying/
-<bf/to/, instead of the message you are <em/sending/. <tt/send-hook/ is
-matched against all messages, both <em/new/ and <em/replies/. <bf/Note:/
-<tt/reply-hook/s are matched <bf/before/ the <tt/send-hook/, <bf/regardless/
+<para>
+<literal>reply-hook</literal> 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
+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>
of the order specified in the users's configuration file.
+</para>
-<tt/send2-hook/ is matched every time a message is changed, either
+<para>
+<literal>send2-hook</literal> is matched every time a message is changed, either
by editing it, or by using the compose menu to change its recipients
-or subject. <tt/send2-hook/ is executed after <tt/send-hook/, and
-can, e.g., be used to set parameters such as the <ref id="sendmail"
-name="$sendmail"> variable depending on the message's sender
+or subject. <literal>send2-hook</literal> is executed after <literal>send-hook</literal>, and
+can, e.g., be used to set parameters such as the <link linkend="sendmail">sendmail</link> variable depending on the message's sender
address.
+</para>
-For each type of <tt/send-hook/ or <tt/reply-hook/, when multiple matches
+<para>
+For each type of <literal>send-hook</literal> or <literal>reply-hook</literal>, when multiple matches
occur, commands are executed in the order they are specified in the muttrc
(for that type of hook).
+</para>
-See <ref id="pattern_hook" name="Message Matching in Hooks"> for information on the exact format of <em/pattern/.
+<para>
+See <link linkend="pattern-hook">pattern-hook</link> for information on the exact format of <emphasis>pattern</emphasis>.
+</para>
-Example: <tt/send-hook mutt &dquot;set mime_forward signature=''&dquot;/
+<para>
+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
-<ref id="attribution" name="$attribution">, <ref id="signature"
-name="$signature"> and <ref id="locale" name="$locale">
+<link linkend="attribution">attribution</link>, <link linkend="signature">signature</link> and <link linkend="locale">locale</link>
variables in order to change the language of the attributions and
signatures based upon the recipients.
+</para>
-<bf/Note:/ the send-hook's are only executed ONCE after getting the initial
+<para>
+<emphasis role="bold">Note:</emphasis> the send-hook's are only executed ONCE after getting the initial
list of recipients. Adding a recipient after replying or editing the
message will NOT cause any send-hook to be executed. Also note that
-my_hdr commands which modify recipient headers, or the message's
+my_hdr commands which modify recipient headers, or the message's
subject, don't have any effect on the current message when executed
from a send-hook.
+</para>
+
+<para>
+
+</para>
-<!--}}}-->
+</sect1>
-<sect>Change settings before formatting a message<label id="message-hook"> <!--{{{-->
-<p>
-Usage: <tt/message-hook/ [!]<em/pattern/ <em/command/
+<sect1 id="message-hook">
+<title>Change settings before formatting a message </title>
+<para>
+Usage: <literal>message-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
+</para>
+
+<para>
This command can be used to execute arbitrary configuration commands
before viewing or formatting a message based upon information about the message.
-<em/command/ is executed if the <em/pattern/ matches the message to be
+<emphasis>command</emphasis> is executed if the <emphasis>pattern</emphasis> matches the message to be
displayed. When multiple matches occur, commands are executed in the order
they are specified in the muttrc.
+</para>
-See <ref id="pattern_hook" name="Message Matching in Hooks"> for
-information on the exact format of <em/pattern/.
+<para>
+See <link linkend="pattern-hook">pattern-hook</link> for
+information on the exact format of <emphasis>pattern</emphasis>.
+</para>
+<para>
Example:
-<tscreen><verb>
+
+<screen>
message-hook ~A 'set pager=builtin'
message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""'
-</verb></tscreen>
+</screen>
-<!--}}}-->
+</para>
+
+<para>
+
+</para>
-<sect>Choosing the cryptographic key of the recipient<label id="crypt-hook"> <!--{{{-->
-<p>
-Usage: <tt/crypt-hook/ <em/pattern/ <em/keyid/
+</sect1>
+<sect1 id="crypt-hook">
+<title>Choosing the cryptographic key of the recipient </title>
+
+<para>
+Usage: <literal>crypt-hook</literal> <emphasis>pattern</emphasis> <emphasis>keyid</emphasis>
+</para>
+
+<para>
When encrypting messages with PGP or OpenSSL, you may want to associate a certain
key with a given e-mail address automatically, either because the
recipient's public key can't be deduced from the destination address,
normally use. The crypt-hook command provides a method by which you can
specify the ID of the public key to be used when encrypting messages to
a certain recipient.
+</para>
+<para>
The meaning of "key id" is to be taken broadly in this context: You
can either put a numerical key ID here, an e-mail address, or even
just a real name.
+</para>
+
+<para>
+
+</para>
-<!--}}}-->
+</sect1>
-<sect>Adding key sequences to the keyboard buffer<label id="push"> <!--{{{-->
-<p>
-Usage: <tt/push/ <em/string/
+<sect1 id="push">
+<title>Adding key sequences to the keyboard buffer </title>
+<para>
+Usage: <literal>push</literal> <emphasis>string</emphasis>
+</para>
+
+<para>
This command adds the named string to the keyboard buffer. The string may
contain control characters, key names and function names like the sequence
-string in the <ref id="macro" name="macro"> command. You may use it to
+string in the <link linkend="macro">macro</link> command. You may use it to
automatically run a sequence of commands at startup, or when entering
certain folders.
+</para>
+
+<para>
+
+</para>
+
+</sect1>
-<!--}}}-->
+<sect1 id="exec">
+<title>Executing functions </title>
-<sect>Executing functions<label id="exec"> <!--{{{-->
-<p>
-Usage: <tt/exec/ <em/function/ [ <em/function/ ... ]
+<para>
+Usage: <literal>exec</literal> <emphasis>function</emphasis> [ <emphasis>function</emphasis> ... ]
+</para>
+<para>
This command can be used to execute any function. Functions are
-listed in the <ref id="functions" name="function reference">.
+listed in the <link linkend="functions">functions</link>.
``exec function'' is equivalent to ``push <function>''.
+</para>
-<!--}}}-->
+<para>
+
+</para>
+
+</sect1>
-<sect>Message Scoring<label id="score-command"> <!--{{{-->
+<sect1 id="score-command">
+<title>Message Scoring </title>
-<p>
-Usage: <tt/score/ <em/pattern/ <em/value/<newline>
-Usage: <tt/unscore/ <em/pattern/ [ <em/pattern/ ... ]
+<para>
+Usage: <literal>score</literal> <emphasis>pattern</emphasis> <emphasis>value</emphasis>
-<p>
+Usage: <literal>unscore</literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
+</para>
+
+<para>
In situations where you have to cope with a lot of emails, e.g.
when you read many different mailing lists, and take part in
discussions, it is always useful to have the important messages
marked and the annoying messages or the ones that you aren't
interested in deleted. For this purpose, mutt-ng features a
mechanism called ``scoring''.
+</para>
-<p>
+<para>
When you use scoring, every message has a base score of 0. You
-can then use the <tt/score/ command to define patterns and a
+can then use the <literal>score</literal> command to define patterns and a
positive or negative value associated with it. When a pattern
matches a message, the message's score will be raised or lowered by
the amount of the value associated with the pattern.
+</para>
+
+<para>
-<verb>
+<screen>
score "~f nion@muttng\.org" 50
-score "~f @sco\.com" -100</verb>
+score "~f @sco\.com" -100
+</screen>
-<p>If the pattern matches, it is also possible to set the score
+</para>
+
+<para>
+If the pattern matches, it is also possible to set the score
value of the current message to a certain value and then stop
evaluation:
+</para>
+
+<para>
+
+<screen>
+score "~f santaclaus@northpole\.int" =666
+</screen>
-<verb>
-score "~f santaclaus@northpole\.int" =666</verb>
+</para>
-<p>What is important to note is that negative score values will be
+<para>
+What is important to note is that negative score values will be
rounded up to 0.
+</para>
-<p>To make scoring actually useful, the score must be applied in
-some way. That's what the <em/score thresholds/ are for. Currently,
+<para>
+To make scoring actually useful, the score must be applied in
+some way. That's what the <emphasis>score thresholds</emphasis> are for. Currently,
there are three score thresholds:
+</para>
-<itemize>
+<para>
- <item>flag threshold: when a message has a score value equal or higher
- than the flag threshold, it will be flagged.
+<itemizedlist>
+<listitem>
- <item>read threshold: when a message has a score value equal or lower
- than the read threshold, it will be marked as read.
+<para>
+flag threshold: when a message has a score value equal or higher
+than the flag threshold, it will be flagged.
- <item>delete threshold: when a message has a score value equal or
- lower than the delete threshold, it will be marked as deleted.
+</para>
+</listitem>
+<listitem>
-</itemize>
+<para>
+read threshold: when a message has a score value equal or lower
+than the read threshold, it will be marked as read.
-<p>These three thresholds can be set via the variables <ref
-id="score_threshold_flag"
-name="$score_threshold_flag">, <ref
-id="score_threshold_read"
-name="$score_threshold_read">, <ref
-id="score_threshold_delete"
-name="$score_threshold_delete"> and. By
-default, <ref id="score_threshold_read"
-name="$score_threshold_read"> and <ref
-id="score_threshold_delete"
-name="$score_threshold_delete"> are set to
-<tt/-1/, which means that in the default threshold configuration no
+</para>
+</listitem>
+<listitem>
+
+<para>
+delete threshold: when a message has a score value equal or
+lower than the delete threshold, it will be marked as deleted.
+
+</para>
+</listitem>
+
+</itemizedlist>
+
+</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
+<literal>-1</literal>, which means that in the default threshold configuration no
message will ever get marked as read or deleted.
+</para>
+
+<para>
+Scoring gets especially interesting when combined with the <literal>color</literal> command
+and the <literal>˜n</literal> pattern:
+</para>
-<p>Scoring gets especially interesting when combined with the <tt/color/ command
-and the <tt>˜n</tt> pattern:
+<para>
-<verb>
+<screen>
color index black yellow "~n 10-"
-color index red yellow "~n 100-"</verb>
+color index red yellow "~n 100-"
+</screen>
-<p>The rules above mark all messages with a score between 10 and 99
+</para>
+
+<para>
+The rules above mark all messages with a score between 10 and 99
with black and yellow, and messages with a score greater or equal
100 with red and yellow. This might be unusual to you if you're used
to e.g. slrn's scoring mechanism, but it is more flexible, as it
visually marks different scores.
+</para>
+
+<para>
+
+</para>
+
+</sect1>
-<!--}}}-->
+<sect1 id="spam">
+<title>Spam detection </title>
-<sect>Spam detection<label id="spam"> <!--{{{-->
-<p>
-Usage: <tt/spam/ <em/pattern/ <em/format/<newline>
-Usage: <tt/nospam/ <em/pattern/
+<para>
+Usage: <literal>spam</literal> <emphasis>pattern</emphasis> <emphasis>format</emphasis>
+Usage: <literal>nospam</literal> <emphasis>pattern</emphasis>
+</para>
+
+<para>
Mutt-ng has generalized support for external spam-scoring filters.
-By defining your spam patterns with the <tt/spam/ and <tt/nospam/
-commands, you can <em/limit/, <em/search/, and <em/sort/ your
+By defining your spam patterns with the <literal>spam</literal> and <literal>nospam</literal>
+commands, you can <emphasis>limit</emphasis>, <emphasis>search</emphasis>, and <emphasis>sort</emphasis> your
mail based on its spam attributes, as determined by the external
filter. You also can display the spam attributes in your index
-display using the <tt/%H/ selector in the <ref id="index_format"
-name="$index_format"> variable. (Tip: try <tt/%?H?[%H] ?/
+display using the <literal>%H</literal> selector in the <link linkend="index-format">index-format</link> variable. (Tip: try <literal>%?H?[%H] ?</literal>
to display spam tags only when they are defined for a given message.)
+</para>
+<para>
Your first step is to define your external filter's spam patterns using
-the <tt/spam/ command. <em/pattern/ should be a regular expression
+the <literal>spam</literal> command. <emphasis>pattern</emphasis> should be a regular expression
that matches a header in a mail message. If any message in the mailbox
matches this regular expression, it will receive a ``spam tag'' or
-``spam attribute'' (unless it also matches a <tt/nospam/ pattern -- see
+``spam attribute'' (unless it also matches a <literal>nospam</literal> pattern -- see
below.) The appearance of this attribute is entirely up to you, and is
-governed by the <em/format/ parameter. <em/format/ can be any static
-text, but it also can include back-references from the <em/pattern/
+governed by the <emphasis>format</emphasis> parameter. <emphasis>format</emphasis> can be any static
+text, but it also can include back-references from the <emphasis>pattern</emphasis>
expression. (A regular expression ``back-reference'' refers to a
-sub-expression contained within parentheses.) <tt/%1/ is replaced with
-the first back-reference in the regex, <tt/%2/ with the second, etc.
+sub-expression contained within parentheses.) <literal>%1</literal> is replaced with
+the first back-reference in the regex, <literal>%2</literal> with the second, etc.
+</para>
+<para>
If you're using multiple spam filters, a message can have more than
-one spam-related header. You can define <tt/spam/ patterns for each
+one spam-related header. You can define <literal>spam</literal> patterns for each
filter you use. If a message matches two or more of these patterns, and
the $spam_separator variable is set to a string, then the
-message's spam tag will consist of all the <em/format/ strings joined
+message's spam tag will consist of all the <emphasis>format</emphasis> strings joined
together, with the value of $spam_separator separating
them.
+</para>
+<para>
For example, suppose I use DCC, SpamAssassin, and PureMessage. I might
define these spam settings:
-<tscreen><verb>
+
+<screen>
spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1"
spam "X-Spam-Status: Yes" "90+/SA"
spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
set spam_separator=", "
-</verb></tscreen>
+</screen>
+</para>
+
+<para>
If I then received a message that DCC registered with ``many'' hits
under the ``Fuz2'' checksum, and that PureMessage registered with a
-97% probability of being spam, that message's spam tag would read
-<tt>90+/DCC-Fuz2, 97/PM</tt>. (The four characters before ``=many'' in a
+97% probability of being spam, that message's spam tag would read
+<literal>90+/DCC-Fuz2, 97/PM</literal>. (The four characters before ``=many'' in a
DCC report indicate the checksum used -- in this case, ``Fuz2''.)
+</para>
+<para>
If the $spam_separator variable is unset, then each
spam pattern match supersedes the previous one. Instead of getting
-joined <em/format/ strings, you'll get only the last one to match.
+joined <emphasis>format</emphasis> strings, you'll get only the last one to match.
+</para>
+<para>
The spam tag is what will be displayed in the index when you use
-<tt/%H/ in the <tt/$index_format/ variable. It's also the
-string that the <tt/~H/ pattern-matching expression matches against for
-<em/search/ and <em/limit/ functions. And it's what sorting by spam
+<literal>%H</literal> in the <literal>$index_format</literal> variable. It's also the
+string that the <literal>˜H</literal> pattern-matching expression matches against for
+<emphasis>search</emphasis> and <emphasis>limit</emphasis> functions. And it's what sorting by spam
attribute will use as a sort key.
+</para>
+<para>
That's a pretty complicated example, and most people's actual
environments will have only one spam filter. The simpler your
configuration, the more effective mutt can be, especially when it comes
to sorting.
+</para>
-Generally, when you sort by spam tag, mutt will sort <em/lexically/ --
+<para>
+Generally, when you sort by spam tag, mutt will sort <emphasis>lexically</emphasis> --
that is, by ordering strings alphnumerically. However, if a spam tag
begins with a number, mutt will sort numerically first, and lexically
only when two numbers are equal in value. (This is like UNIX's
-<tt/sort -n/.) A message with no spam attributes at all -- that is, one
-that didn't match <em/any/ of your <tt/spam/ patterns -- is sorted at
+<literal>sort -n</literal>.) A message with no spam attributes at all -- that is, one
+that didn't match <emphasis>any</emphasis> of your <literal>spam</literal> patterns -- is sorted at
lowest priority. Numbers are sorted next, beginning with 0 and ranging
upward. Finally, non-numeric strings are sorted, with ``a'' taking lower
priority than ``z''. Clearly, in general, sorting by spam tags is most
effective when you can coerce your filter to give you a raw number. But
in case you can't, mutt can still do something useful.
+</para>
-The <tt/nospam/ command can be used to write exceptions to <tt/spam/
-patterns. If a header pattern matches something in a <tt/spam/ command,
+<para>
+The <literal>nospam</literal> command can be used to write exceptions to <literal>spam</literal>
+patterns. If a header pattern matches something in a <literal>spam</literal> command,
but you nonetheless do not want it to receive a spam tag, you can list a
-more precise pattern under a <tt/nospam/ command.
+more precise pattern under a <literal>nospam</literal> command.
+</para>
-If the <em/pattern/ given to <tt/nospam/ is exactly the same as the
-<em/pattern/ on an existing <tt/spam/ list entry, the effect will be to
+<para>
+If the <emphasis>pattern</emphasis> given to <literal>nospam</literal> is exactly the same as the
+<emphasis>pattern</emphasis> on an existing <literal>spam</literal> list entry, the effect will be to
remove the entry from the spam list, instead of adding an exception.
-Likewise, if the <em/pattern/ for a <tt/spam/ command matches an entry
-on the <tt/nospam/ list, that <tt/nospam/ entry will be removed. If the
-<em/pattern/ for <tt/nospam/ is ``*'', <em/all entries on both lists/
-will be removed. This might be the default action if you use <tt/spam/
-and <tt/nospam/ in conjunction with a <tt/folder-hook/.
-
-You can have as many <tt/spam/ or <tt/nospam/ commands as you like.
+Likewise, if the <emphasis>pattern</emphasis> for a <literal>spam</literal> command matches an entry
+on the <literal>nospam</literal> list, that <literal>nospam</literal> entry will be removed. If the
+<emphasis>pattern</emphasis> for <literal>nospam</literal> is ``*'', <emphasis>all entries on both lists</emphasis>
+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>.
+</para>
+
+<para>
+You can have as many <literal>spam</literal> or <literal>nospam</literal> commands as you like.
You can even do your own primitive spam detection within mutt -- for
-example, if you consider all mail from <tt/MAILER-DAEMON/ to be spam,
-you can use a <tt/spam/ command like this:
+example, if you consider all mail from <literal>MAILER-DAEMON</literal> to be spam,
+you can use a <literal>spam</literal> command like this:
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
spam "^From: .*MAILER-DAEMON" "999"
-</verb></tscreen>
+</screen>
-<!--}}}-->
+</para>
-<sect>Setting variables<label id="set"> <!--{{{-->
-<p>
-Usage: <tt/set/ [no|inv]<em/variable/[=<em/value/] [ <em/variable/ ... ]<newline>
-Usage: <tt/toggle/ <em/variable/ [<em/variable/ ... ]<newline>
-Usage: <tt/unset/ <em/variable/ [<em/variable/ ... ]<newline>
-Usage: <tt/reset/ <em/variable/ [<em/variable/ ... ]
+<para>
+
+</para>
-This command is used to set (and unset) <ref id="variables"
-name="configuration variables">. There are four basic types of variables:
-boolean, number, string and quadoption. <em/boolean/ variables can be
-<em/set/ (true) or <em/unset/ (false). <em/number/ variables can be
+</sect1>
+
+<sect1 id="set">
+<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> ... ]
+</para>
+
+<para>
+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). <emphasis>number</emphasis> variables can be
assigned a positive integer value.
+</para>
-<em/string/ variables consist of any number of printable characters.
-<em/strings/ must be enclosed in quotes if they contain spaces or tabs. You
-may also use the ``C'' escape sequences <bf/\n/ and <bf/\t/ for
+<para>
+<emphasis>string</emphasis> variables consist of any number of printable characters.
+<emphasis>strings</emphasis> must be enclosed in quotes if they contain spaces or tabs. You
+may also use the ``C'' escape sequences <emphasis role="bold">\n</emphasis> and <emphasis role="bold">\t</emphasis> for
newline and tab, respectively.
+</para>
-<em/quadoption/ variables are used to control whether or not to be prompted
-for certain actions, or to specify a default action. A value of <em/yes/
+<para>
+<emphasis>quadoption</emphasis> variables are used to control whether or not to be prompted
+for certain actions, or to specify a default action. A value of <emphasis>yes</emphasis>
will cause the action to be carried out automatically as if you had answered
-yes to the question. Similarly, a value of <em/no/ will cause the the
+yes to the question. Similarly, a value of <emphasis>no</emphasis> will cause the the
action to be carried out as if you had answered ``no.'' A value of
-<em/ask-yes/ will cause a prompt with a default answer of ``yes'' and
-<em/ask-no/ will provide a default answer of ``no.''
-
-Prefixing a variable with ``no'' will unset it. Example: <tt/set noaskbcc/.
-
-For <em/boolean/ variables, you may optionally prefix the variable name with
-<tt/inv/ to toggle the value (on or off). This is useful when writing
-macros. Example: <tt/set invsmart_wrap/.
-
-The <tt/toggle/ command automatically prepends the <tt/inv/ prefix to all
+<emphasis>ask-yes</emphasis> will cause a prompt with a default answer of ``yes'' and
+<emphasis>ask-no</emphasis> will provide a default answer of ``no.''
+</para>
+
+<para>
+Prefixing a variable with ``no'' will unset it. Example: <literal>set noaskbcc</literal>.
+</para>
+
+<para>
+For <emphasis>boolean</emphasis> variables, you may optionally prefix 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>.
+</para>
+
+<para>
+The <literal>toggle</literal> command automatically prepends the <literal>inv</literal> prefix to all
specified variables.
+</para>
-The <tt/unset/ command automatically prepends the <tt/no/ prefix to all
+<para>
+The <literal>unset</literal> command automatically prepends the <literal>no</literal> prefix to all
specified variables.
+</para>
-Using the enter-command function in the <em/index/ menu, you can query the
+<para>
+Using the enter-command function in the <emphasis>index</emphasis> menu, you can query the
value of a variable by prefixing the name of the variable with a question
mark:
+</para>
+
+<para>
-<tscreen><verb>
+<screen>
set ?allow_8bit
-</verb></tscreen>
+</screen>
+</para>
+
+<para>
The question mark is actually only required for boolean and quadoption
variables.
+</para>
-The <tt/reset/ command resets all given variables to the compile time
+<para>
+The <literal>reset</literal> command resets all given variables to the compile time
defaults (hopefully mentioned in this manual). If you use the command
-<tt/set/ and prefix the variable with ``&'' this has the same
+<literal>set</literal> and prefix the variable with ``&'' this has the same
behavior as the reset command.
+</para>
-With the <tt/reset/ command there exists the special variable ``all'',
+<para>
+With the <literal>reset</literal> command there exists the special variable ``all'',
which allows you to reset all variables to their system defaults.
+</para>
-<!--}}}-->
+<para>
+
+</para>
-<sect>Reading initialization commands from another file<label id="source"> <!--{{{-->
-<p>
-Usage: <tt/source/ <em/filename/ [ <em/filename/ ... ]
+</sect1>
+<sect1 id="source">
+<title>Reading initialization commands from another file </title>
+
+<para>
+Usage: <literal>source</literal> <emphasis>filename</emphasis> [ <emphasis>filename</emphasis> ... ]
+</para>
+
+<para>
This command allows the inclusion of initialization commands
from other files. For example, I place all of my aliases in
-<tt>˜/.mail_aliases</tt> so that I can make my
-<tt>˜/.muttrc</tt> readable and keep my aliases private.
+<literal>˜/.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 to the
path of your home directory.
+</para>
-If the filename ends with a vertical bar (|), then <em/filename/ is
+<para>
+If the filename ends with a vertical bar (|), then <emphasis>filename</emphasis> is
considered to be an executable program from which to read input (eg.
-<tt>source ~/bin/myscript|</tt>).
+<literal>source ˜/bin/myscript|</literal>).
+</para>
+
+<para>
+
+</para>
+
+</sect1>
-<!--}}}-->
+<sect1 id="unhook">
+<title>Removing hooks </title>
-<sect>Removing hooks<label id="unhook"> <!--{{{-->
-<p>
-Usage: <tt/unhook/ [ * | <em/hook-type/ ]
+<para>
+Usage: <literal>unhook</literal> [ * | <emphasis>hook-type</emphasis> ]
+</para>
+<para>
This command permits you to flush hooks you have previously defined.
You can either remove all hooks by giving the ``*'' character as an
argument, or you can remove all hooks of a specific type by saying
-something like <tt/unhook send-hook/.
+something like <literal>unhook send-hook</literal>.
+</para>
+
+<para>
+
+</para>
+
+</sect1>
+
+<sect1 id="sect:sharingsetups">
+<title>Sharing Setups </title>
+
+<sect2>
+<title>Character Sets </title>
+
+<para>
+As users may run mutt-ng on different systems, the configuration
+must be maintained because it's likely that people want to use the
+setup everywhere they use mutt-ng. And mutt-ng tries to help where it
+can.
+</para>
-<!--}}}-->
+<para>
+To not produce conflicts with different character sets, mutt-ng
+allows users to specify in which character set their configuration
+files are encoded. Please note that while reading the configuration
+files, this is only respected after the corresponding declaration
+appears. It's advised to put the following at the very beginning of a
+users muttngrc:
+</para>
- <sect>Sharing Setups<label id="sect:sharingsetups"> <!--{{{-->
+<para>
- <sect1>Character Sets <!--{{{-->
+<screen>
+set config_charset = "..."
+</screen>
- <p>As users may run mutt-ng on different systems, the configuration
- must be maintained because it's likely that people want to use the
- setup everywhere they use mutt-ng. And mutt-ng tries to help where it
- can.
+</para>
- <p>To not produce conflicts with different character sets, mutt-ng
- allows users to specify in which character set their configuration
- files are encoded. Please note that while reading the configuration
- files, this is only respected after the corresponding declaration
- appears. It's advised to put the following at the very beginning of a
- users muttngrc:
+<para>
+and replacing the dots with the actual character set. To avoid
+problems while maintaining the setup, vim user's may want to use
+modelines as show in:
+</para>
- <verb>
-set config_charset = "..."</verb>
+<para>
- <p>and replacing the dots with the actual character set. To avoid
- problems while maintaining the setup, vim user's may want to use
- modelines as show in:
+<screen>
+# vim:fileencoding=...:
+</screen>
- <verb>
-# vim:fileencoding=...:</verb>
+</para>
- <p>while, again, replacing the dots with the appropriate name. This
- tells vim as which character set to read and save the file.
+<para>
+while, again, replacing the dots with the appropriate name. This
+tells vim as which character set to read and save the file.
+</para>
- <!--}}}-->
+<para>
+
+</para>
+
+</sect2>
+
+<sect2>
+<title>Modularization </title>
+
+<para>
+``Modularization'' means to divide the setup into several files
+while sorting the options or commands by topic. Especially for
+longer setups (e.g. with many hooks), this helps maintaining it
+and solving trouble.
+</para>
- <sect1>Modularization <!--{{{-->
+<para>
+When using separation, setups may be, as a whole or in
+fractions, shared over different systems.
+</para>
- <p>``Modularization'' means to divide the setup into several files
- while sorting the options or commands by topic. Especially for
- longer setups (e.g. with many hooks), this helps maintaining it
- and solving trouble.
+<para>
+
+</para>
- <p>When using separation, setups may be, as a whole or in
- fractions, shared over different systems.
+</sect2>
- <!--}}}-->
+<sect2>
+<title>Conditional parts </title>
- <sect1>Conditional parts <!--{{{-->
+<para>
+When using a configuration on different systems, the user may not
+always have influence on how mutt-ng is installed and which features
+it includes.
+</para>
- <p>When using a configuration on different systems, the user may not
- always have influence on how mutt-ng is installed and which features
- it includes.
+<para>
+To solve this, mutt-ng contain a feature based on the ``ifdef''
+patch written for mutt. Its basic syntax is:
+</para>
- <p>To solve this, mutt-ng contain a feature based on the ``ifdef''
- patch written for mutt. Its basic syntax is:
+<para>
- <verb>
+<screen>
ifdef <item> <command>
-ifndef <item> <command></verb>
+ifndef <item> <command>
+</screen>
+
+</para>
+
+<para>
+...whereby <literal><item></literal> can be one of:
+</para>
+
+<para>
- <p>...whereby <tt/<item>/ can be one of:
+<itemizedlist>
+<listitem>
- <itemize>
+<para>
+a function name
- <item>a function name
+</para>
+</listitem>
+<listitem>
- <item>a variable name
+<para>
+a variable name
- <item>a menu name
+</para>
+</listitem>
+<listitem>
- <item>a feature name
+<para>
+a menu name
- </itemize>
+</para>
+</listitem>
+<listitem>
- <p>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
- <tt/feature_/:
+<para>
+a feature name
- <verb>
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+<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>:
+</para>
+
+<para>
+
+<screen>
ncurses, slang, iconv, idn, dotlock, standalone, pop, nntp, imap, ssl,
gnutls, sasl, sasl2, libesmtp, compressed, color, classic_pgp,
-classic_smime, gpgme, header_cache</verb>
+classic_smime, gpgme, header_cache
+</screen>
+
+</para>
- <p>As an example, one can use the following in
- <tt>˜/.muttngrc</tt>:
+<para>
+As an example, one can use the following in
+<literal>˜/.muttngrc</literal>:
+</para>
- <verb>
+<para>
+
+<screen>
ifdef feature_imap 'source ~/.mutt-ng/setup-imap'
ifdef feature_pop 'source ~/.mutt-ng/setup-pop'
-ifdef feature_nntp 'source ~/.mutt-ng/setup-nntp'</verb>
+ifdef feature_nntp 'source ~/.mutt-ng/setup-nntp'
+</screen>
+
+</para>
+
+<para>
+...to only source <literal>˜/.mutt-ng/setup-imap</literal> if IMAP
+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 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>,
+use:
+</para>
- <p>...to only source <tt>˜/.mutt-ng/setup-imap</tt> if IMAP
- support is built in, only source <tt>˜/.mutt-ng/setup-pop</tt>
- if POP support is built in and only source
- <tt>˜/.mutt-ng/setup-nntp</tt> if NNTP support is built in.
+<para>
- <p>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 <ref
- id="imap_mail_check" name="$imap_mail_check">,
- use:
+<screen>
+ifdef imap_mail_check 'set imap_mail_check = 300'
+</screen>
- <verb>
-ifdef imap_mail_check 'set imap_mail_check = 300'</verb>
+</para>
- <p>Provided for completeness is the test for menu names. To set <ref
- id="pager_index_lines"
- name="$pager_index_lines"> only if the pager
- menu is available, use:
+<para>
+Provided for completeness is the test for menu names. To set <link linkend="pager-index-lines">pager-index-lines</link> only if the pager
+menu is available, use:
+</para>
- <verb>
-ifdef pager 'set pager_index_lines = 10'</verb>
+<para>
- <p>For completeness, too, the opposite of <tt/ifdef/ is provided:
- <tt/ifndef/ which only executes the command if the test fails. For
- example, the following two examples are equivalent:
+<screen>
+ifdef pager 'set pager_index_lines = 10'
+</screen>
- <verb>
+</para>
+
+<para>
+For completeness, too, the opposite of <literal>ifdef</literal> is provided:
+<literal>ifndef</literal> which only executes the command if the test fails. For
+example, the following two examples are equivalent:
+</para>
+
+<para>
+
+<screen>
ifdef feature_ncurses 'source ~/.mutt-ng/setup-ncurses'
-ifndef feature_ncurses 'source ~/.mutt-ng/setup-slang'</verb>
+ifndef feature_ncurses 'source ~/.mutt-ng/setup-slang'
+</screen>
+
+</para>
- <p>...and...
+<para>
+...and...
+</para>
- <verb>
+<para>
+
+<screen>
ifdef feature_slang 'source ~/.mutt-ng/setup-slang'
-ifndef feature_slang 'source ~/.mutt-ng/setup-ncurses'</verb>
+ifndef feature_slang 'source ~/.mutt-ng/setup-ncurses'
+</screen>
+
+</para>
+
+<para>
+
+</para>
- <!--}}}-->
+<para>
+
+</para>
+</sect2>
- <!--}}}-->
+</sect1>
-<sect>Obsolete Variables <!--{{{-->
+<sect1>
+<title>Obsolete Variables </title>
-<p>In the process of ensuring and creating more consistency, many
+<para>
+In the process of ensuring and creating more consistency, many
variables have been renamed and some of the old names were already
-removed. Please see <ref id="sect_obsolete" name="Obsolete Variables">
+removed. Please see <link linkend="sect-obsolete">sect-obsolete</link>
for a complete list.
+</para>
+
+<para>
+
+</para>
-<!--}}}-->
+<para>
+
+</para>
+
+</sect1>
-<!--}}}-->
+</chapter>
-<chapt>Advanced Usage <!--{{{-->
+<chapter>
+<title>Advanced Usage </title>
-<sect>Regular Expressions<label id="regexp"> <!--{{{-->
-<p>
+<sect1 id="regexp">
+<title>Regular Expressions </title>
+
+<para>
All string patterns in Mutt-ng including those in more complex
-<ref id="patterns" name="patterns"> must be specified
+<link linkend="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
convenience, we have included below a brief description of this syntax.
+</para>
+<para>
The search is case sensitive if the pattern contains at least one upper
case letter, and case insensitive otherwise. Note that ``\''
must be quoted if used for a regular expression in an initialization
command: ``\\''.
+</para>
+<para>
A regular expression is a pattern that describes a set of strings.
Regular expressions are constructed analogously to arithmetic
expressions, by using various operators to combine smaller expressions.
+</para>
-Note that the regular expression can be enclosed/delimited by either &dquot;
+<para>
+Note that the regular expression can be enclosed/delimited by either "
or ' which is useful if the regular expression includes a white-space
-character. See <ref id="muttrc-syntax" name="Syntax of Initialization Files">
-for more information on &dquot; and ' delimiter processing. To match a
-literal &dquot; or ' you must preface it with \ (backslash).
+character. See <link linkend="muttrc-syntax">muttrc-syntax</link>
+for more information on " and ' delimiter processing. To match a
+literal " or ' you must preface it with \ (backslash).
+</para>
+<para>
The fundamental building blocks are the regular expressions that match
a single character. Most characters, including all letters and digits,
are regular expressions that match themselves. Any metacharacter with
special meaning may be quoted by preceding it with a backslash.
+</para>
+<para>
The period ``.'' matches any single character. The caret ``ˆ'' and
-the dollar sign ``&dollar'' are metacharacters that respectively match
+the dollar sign ``$'' are metacharacters that respectively match
the empty string at the beginning and end of a line.
+</para>
+<para>
A list of characters enclosed by ``['' and ``]'' matches any
single character in that list; if the first character of the list
-is a caret ``ˆ'' then it matches any character <bf/not/ in the
-list. For example, the regular expression <bf/[0123456789]/
+is a caret ``ˆ'' then it matches any character <emphasis role="bold">not</emphasis> in the
+list. For example, the regular expression <emphasis role="bold">[0123456789]</emphasis>
matches any single digit. A range of ASCII characters may be specified
by giving the first and last characters, separated by a hyphen
``-''. Most metacharacters lose their special meaning inside
lists. To include a literal ``]'' place it first in the list.
Similarly, to include a literal ``ˆ'' place it anywhere but first.
Finally, to include a literal hyphen ``-'' place it last.
+</para>
+<para>
Certain named classes of characters are predefined. Character classes
consist of ``[:'', a keyword denoting the class, and ``:]''.
The following classes are defined by the POSIX standard:
+</para>
+
+<para>
+<variablelist>
-<descrip>
-<tag/[:alnum:]/
+<varlistentry>
+<term>[:alnum:]</term>
+<listitem>
+<para>
Alphanumeric characters.
-<tag/[:alpha:]/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>[:alpha:]</term>
+<listitem>
+<para>
Alphabetic characters.
-<tag/[:blank:]/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>[:blank:]</term>
+<listitem>
+<para>
Space or tab characters.
-<tag/[:cntrl:]/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>[:cntrl:]</term>
+<listitem>
+<para>
Control characters.
-<tag/[:digit:]/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>[:digit:]</term>
+<listitem>
+<para>
Numeric characters.
-<tag/[:graph:]/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>[:graph:]</term>
+<listitem>
+<para>
Characters that are both printable and visible. (A space is printable,
but not visible, while an ``a'' is both.)
-<tag/[:lower:]/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>[:lower:]</term>
+<listitem>
+<para>
Lower-case alphabetic characters.
-<tag/[:print:]/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>[:print:]</term>
+<listitem>
+<para>
Printable characters (characters that are not control characters.)
-<tag/[:punct:]/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>[:punct:]</term>
+<listitem>
+<para>
Punctuation characters (characters that are not letter, digits, control
characters, or space characters).
-<tag/[:space:]/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>[:space:]</term>
+<listitem>
+<para>
Space characters (such as space, tab and formfeed, to name a few).
-<tag/[:upper:]/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>[:upper:]</term>
+<listitem>
+<para>
Upper-case alphabetic characters.
-<tag/[:xdigit:]/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>[:xdigit:]</term>
+<listitem>
+<para>
Characters that are hexadecimal digits.
-</descrip>
+</para>
+</listitem></varlistentry>
+</variablelist>
+</para>
+<para>
A character class is only valid in a regular expression inside the
brackets of a character list. Note that the brackets in these
class names are part of the symbolic names, and must be included
in addition to the brackets delimiting the bracket list. For
-example, <bf/[[:digit:]]/ is equivalent to
-<bf/[0-9]/.
+example, <emphasis role="bold">[[:digit:]]</emphasis> is equivalent to
+<emphasis role="bold">[0-9]</emphasis>.
+</para>
+<para>
Two additional special sequences can appear in character lists. These
apply to non-ASCII character sets, which can have single symbols (called
collating elements) that are represented with more than one character,
as well as several characters that are equivalent for collating or
sorting purposes:
+</para>
-<descrip>
-<tag/Collating Symbols/
+<para>
+<variablelist>
+
+<varlistentry>
+<term>Collating Symbols</term>
+<listitem>
+<para>
A collating symbol is a multi-character collating element enclosed in
``[.'' and ``.]''. For example, if ``ch'' is a collating
-element, then <bf/[[.ch.]]/ is a regexp that matches
-this collating element, while <bf/[ch]/ is a regexp that
+element, then <emphasis role="bold">[[.ch.]]</emphasis> is a regexp that matches
+this collating element, while <emphasis role="bold">[ch]</emphasis> is a regexp that
matches either ``c'' or ``h''.
-<tag/Equivalence Classes/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>Equivalence Classes</term>
+<listitem>
+<para>
An equivalence class is a locale-specific name for a list of
characters that are equivalent. The name is enclosed in ``[=''
and ``=]''. For example, the name ``e'' might be used to
represent all of ``è'' ``é'' and ``e''. In this case,
-<bf/[[=e=]]/ is a regexp that matches any of
+<emphasis role="bold">[[=e=]]</emphasis> is a regexp that matches any of
``è'', ``é'' and ``e''.
-</descrip>
+</para>
+</listitem></varlistentry>
+</variablelist>
+</para>
+<para>
A regular expression matching a single character may be followed by one
of several repetition operators:
+</para>
+
+<para>
+<variablelist>
-<descrip>
-<tag/?/
+<varlistentry>
+<term>?</term>
+<listitem>
+<para>
The preceding item is optional and matched at most once.
-<tag/*/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>*</term>
+<listitem>
+<para>
The preceding item will be matched zero or more times.
-<tag/+/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>+</term>
+<listitem>
+<para>
The preceding item will be matched one or more times.
-<tag/{n}/
-The preceding item is matched exactly <em/n/ times.
-<tag/{n,}/
-The preceding item is matched <em/n/ or more times.
-<tag/{,m}/
-The preceding item is matched at most <em/m/ times.
-<tag/{n,m}/
-The preceding item is matched at least <em/n/ times, but no more than
-<em/m/ times.
-</descrip>
-
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>{n}</term>
+<listitem>
+<para>
+The preceding item is matched exactly <emphasis>n</emphasis> times.
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>{n,}</term>
+<listitem>
+<para>
+The preceding item is matched <emphasis>n</emphasis> or more times.
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>{,m}</term>
+<listitem>
+<para>
+The preceding item is matched at most <emphasis>m</emphasis> times.
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>{n,m}</term>
+<listitem>
+<para>
+The preceding item is matched at least <emphasis>n</emphasis> times, but no more than
+<emphasis>m</emphasis> times.
+</para>
+</listitem></varlistentry>
+</variablelist>
+</para>
+
+<para>
Two regular expressions may be concatenated; the resulting regular
expression matches any string formed by concatenating two substrings
that respectively match the concatenated subexpressions.
+</para>
-Two regular expressions may be joined by the infix operator ``|'';
+<para>
+Two regular expressions may be joined by the infix operator ``|'';
the resulting regular expression matches any string matching either
subexpression.
+</para>
+<para>
Repetition takes precedence over concatenation, which in turn takes
precedence over alternation. A whole subexpression may be enclosed in
parentheses to override these precedence rules.
+</para>
-<bf/Note:/ If you compile Mutt-ng with the GNU <em/rx/ package, the
+<para>
+<emphasis role="bold">Note:</emphasis> If you compile Mutt-ng with the GNU <emphasis>rx</emphasis> package, the
following operators may also be used in regular expressions:
+</para>
+
+<para>
+<variablelist>
-<descrip>
-<tag/\\y/
+<varlistentry>
+<term>\\y</term>
+<listitem>
+<para>
Matches the empty string at either the beginning or the end of a word.
-<tag/\\B/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>\\B</term>
+<listitem>
+<para>
Matches the empty string within a word.
-<tag/\\</
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>\\<</term>
+<listitem>
+<para>
Matches the empty string at the beginning of a word.
-<tag/\\>/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>\\></term>
+<listitem>
+<para>
Matches the empty string at the end of a word.
-<tag/\\w/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>\\w</term>
+<listitem>
+<para>
Matches any word-constituent character (letter, digit, or underscore).
-<tag/\\W/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>\\W</term>
+<listitem>
+<para>
Matches any character that is not word-constituent.
-<tag/\\`/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>\\`</term>
+<listitem>
+<para>
Matches the empty string at the beginning of a buffer (string).
-<tag/\\'/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>\\'</term>
+<listitem>
+<para>
Matches the empty string at the end of a buffer.
-</descrip>
+</para>
+</listitem></varlistentry>
+</variablelist>
+</para>
+<para>
Please note however that these operators are not defined by POSIX, so
they may or may not be available in stock libraries on various systems.
+</para>
-<!--}}}-->
+<para>
+
+</para>
+
+</sect1>
-<sect>Patterns <!--{{{-->
+<sect1>
+<title>Patterns </title>
-<p>Mutt-ng's pattern language provides a simple yet effective way to
+<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 <ref id="patterns"
-name="Patterns"> in the Reference chapter.
+these patterns, please refer to table <link linkend="patterns">patterns</link> in the Reference chapter.
+</para>
-<p>It must be noted that in this table, <tt/EXPR/, <tt/USER/,
-<tt/ID/ and <tt/SUBJECT/ are regular expressions. For ranges, the
-forms <tt/<[MAX]/, <tt/>>[MIN]/, <tt/[MIN]-/ and <tt/-[MAX]/
+<para>
+It must be noted that in this table, <literal>EXPR</literal>, <literal>USER</literal>,
+<literal>ID</literal> and <literal>SUBJECT</literal> are regular expressions. For ranges, the
+forms <literal><[MAX]</literal>, <literal>>>[MIN]</literal>, <literal>[MIN]-</literal> and <literal>-[MAX]</literal>
are also possible.
+</para>
-<sect1>Complex Patterns
+<sect2>
+<title>Complex Patterns </title>
-<p>It is possible to combine several sub-patterns to a more complex
+<para>
+It is possible to combine several sub-patterns to a more complex
pattern. The most simple possibility is to logically AND several
patterns by stringing them together:
+</para>
+
+<para>
+
+<screen>
+~s 'SPAM' ~U
+</screen>
-<verb>
-~s 'SPAM' ~U</verb>
+</para>
-<p>The pattern above matches all messages that contain ``SPAM'' in
+<para>
+The pattern above matches all messages that contain ``SPAM'' in
the subject and are unread.
+</para>
-<p>To logical OR patterns, simply use the <tt/|/ operator. This one
+<para>
+To logical OR patterns, simply use the <literal>|</literal> operator. This one
especially useful when using local groups:
+</para>
-<verb>
+<para>
+
+<screen>
~f ("nion@muttng\.org"|"ak@muttng\.org"|"pdmef@muttng\.org")
(~b mutt-ng|~s Mutt-ng)
-!~x '@synflood\.at'</verb>
+!~x '@synflood\.at'
+</screen>
+
+</para>
-<p>The first pattern matches all messages that were sent by one of
+<para>
+The first pattern matches all messages that were sent by one of
the mutt-ng maintainers, while the seconds pattern matches all
messages that contain ``mutt-ng'' in the message body or ``Mutt-ng''
in the subject. The third pattern matches all messages that do not
-contain ``@synflood\.at'' in the <tt/References:/ header, i.e.
+contain ``@synflood\.at'' in the <literal>References:</literal> header, i.e.
messages that are not an (indirect) reply to one of my messages. A
-pattern can be logicall negated using the <tt/!/ operator.
+pattern can be logicall negated using the <literal>!</literal> operator.
+</para>
-<sect1>Patterns and Dates
+</sect2>
-<p>When using dates in patterns, the dates must be specified in a
-special format, i.e. <tt>DD/MM/YYYY</tt>. If you don't specify
+<sect2>
+<title>Patterns and Dates </title>
+
+<para>
+When using dates in patterns, the dates must be specified in a
+special format, i.e. <literal>DD/MM/YYYY</literal>. If you don't specify
month or year, they default to the current month or year. When using
date ranges, and you specify only the minimum or the maximum, the
-specified date will be excluded, e.g. <tt>01/06/2005-</tt> matches
-against all messages <em/after/ Juni 1st, 2005.
+specified date will be excluded, e.g. <literal>01/06/2005-</literal> matches
+against all messages <emphasis>after</emphasis> Juni 1st, 2005.
+</para>
+
+<para>
+It is also possible to use so-called ``error margins'' when
+specifying date ranges. You simply specify a date, and then the
+error margin. This margin needs to contain the information whether
+it goes ``forth'' or ``back'' in time, by using <literal>+</literal> and <literal>-</literal>.
+Then follows a number and a unit, i.e. <literal>y</literal> for years, <literal>m</literal> for
+months, <literal>w</literal> for weeks and <literal>d</literal> for days. If you use the special
+<literal>*</literal> sign, it means that the error margin goes to both
+``directions'' in time.
+</para>
+
+<para>
+
+<screen>
+~d 01/01/2005+1y
+~d 18/10/2004-2w
+~d 28/12/2004*1d
+</screen>
+
+</para>
+
+<para>
+The first pattern matches all dates between January 1st, 2005 and
+January 1st 2006. The second pattern matches all dates between
+October 18th, 2004 and October 4th 2004 (2 weeks before 18/10/2004),
+while the third pattern matches all dates 1 day around December
+28th, 2004 (i.e. Dec 27th, 28th and 29th).
+</para>
+
+<para>
+Relative dates are also very important, as they make it possible
+to specify date ranges between a fixed number of units and the
+current date. How this works can be seen in the following example:
+</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>
+
+</para>
+
+<para>
+
+</para>
+
+</sect2>
+
+</sect1>
+
+<sect1>
+<title>Format Strings </title>
+
+<sect2>
+<title>Introduction </title>
+
+<para>
+The so called <emphasis>Format Strings</emphasis> offer great flexibility when
+configuring mutt-ng. In short, they describe what items to print
+out how in menus and status messages.
+</para>
+
+<para>
+Basically, they work as this: for different menus and bars,
+there's a variable specifying the layout. For every item
+available, there is a so called <emphasis>expando</emphasis>.
+</para>
+
+<para>
+For example, when running mutt-ng on different machines or
+different versions for testing purposes, it may be interesting to
+have the following information always printed on screen when one
+is in the index:
+</para>
+
+<para>
+
+<itemizedlist>
+<listitem>
+
+<para>
+the current hostname
+
+</para>
+</listitem>
+<listitem>
+
+<para>
+the current mutt-ng version number
+
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+<para>
+The setting for the status bar of the index is controlled via the
+<link linkend="status-format">status-format</link>
+variable. For the hostname and version string, there's an expando
+for <literal>$status_format</literal>: <literal>%h</literal> expands to the
+hostname and <literal>%v</literal> to the version string. When just configuring:
+</para>
+
+<para>
+
+<screen>
+set status_format = "%v on %h: ..."
+</screen>
+
+</para>
-<p>It is also possible to use so-called ``error margins'' when
-specifying date ranges. You simply specify a date, and then the
-error margin. This margin needs to contain the information whether
-it goes ``forth'' or ``back'' in time, by using <tt/+/ and <tt/-/.
-Then follows a number and a unit, i.e. <tt/y/ for years, <tt/m/ for
-months, <tt/w/ for weeks and <tt/d/ for days. If you use the special
-<tt/*/ sign, it means that the error margin goes to both
-``directions'' in time.
+<para>
+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, 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>
-<verb>
-~d 01/01/2005+1y
-~d 18/10/2004-2w
-~d 28/12/2004*1d</verb>
+<para>
-<p>The first pattern matches all dates between January 1st, 2005 and
-January 1st 2006. The second pattern matches all dates between
-October 18th, 2004 and October 4th 2004 (2 weeks before 18/10/2004),
-while the third pattern matches all dates 1 day around December
-28th, 2004 (i.e. Dec 27th, 28th and 29th).
+<screen>
+Mutt-ng 1.5.9i on mailhost: ...
+</screen>
-<p>Relative dates are also very important, as they make it possible
-to specify date ranges between a fixed number of units and the
-current date. How this works can be seen in the following example:
+</para>
-<verb>
-~d >2w # messages older than two weeks
-~d <3d # messages newer than 3 days
-~d =1m # messages that are exactly one month old</verb>
+<para>
+In the index, there're more useful information one could want to
+see:
+</para>
-<!--}}}-->
+<para>
- <sect>Format Strings <!--{{{-->
+<itemizedlist>
+<listitem>
- <sect1>Introduction <!--{{{-->
-
- <p>The so called <em/Format Strings/ offer great flexibility when
- configuring mutt-ng. In short, they describe what items to print
- out how in menus and status messages.
+<para>
+which mailbox is open
- <p>Basically, they work as this: for different menus and bars,
- there's a variable specifying the layout. For every item
- available, there is a so called <em/expando/.
-
- <p>For example, when running mutt-ng on different machines or
- different versions for testing purposes, it may be interesting to
- have the following information always printed on screen when one
- is in the index:
+</para>
+</listitem>
+<listitem>
- <itemize>
+<para>
+how man new, flagged or postponed messages
- <item>the current hostname
+</para>
+</listitem>
+<listitem>
- <item>the current mutt-ng version number
+<para>
+...
- </itemize>
+</para>
+</listitem>
- <p>The setting for the status bar of the index is controlled via the
- <ref id="status_format" name="$status_format">
- variable. For the hostname and version string, there's an expando
- for <tt>$status_format</tt>: <tt/%h/ expands to the
- hostname and <tt/%v/ to the version string. When just configuring:
+</itemizedlist>
- <verb>
-set status_format = "%v on %h: ..."</verb>
+</para>
- <p>mutt-ng will replace the sequence <tt/%v/ with the version string
- and <tt/%h/ with the host's name. When you are, for example, running
- mutt-ng version <tt/1.5.9i/ on host <tt/mailhost/, you'll see the
- following when you're in the index:
+<para>
+To include the mailbox' name is as easy as:
+</para>
- <verb>
-Mutt-ng 1.5.9i on mailhost: ...</verb>
+<para>
- <p>In the index, there're more useful information one could want to
- see:
+<screen>
+set status_format = "%v on %h: %B: ...
+</screen>
- <itemize>
+</para>
- <item>which mailbox is open
+<para>
+When the currently opened mailbox is <literal>Inbox</literal>, this will be expanded
+to:
+</para>
- <item>how man new, flagged or postponed messages
+<para>
- <item>...
+<screen>
+Mutt-ng 1.5.9i on mailhost: Inbox: ...
+</screen>
- </itemize>
+</para>
- <p>To include the mailbox' name is as easy as:
+<para>
+For the number of certain types of messages, one more feature of the format
+strings is extremely useful. If there aren't messages of a certain type, it
+may not be desired to print just that there aren't any but instead only
+print something if there are any.
+</para>
- <verb>
-set status_format = "%v on %h: %B: ...</verb>
+<para>
+
+</para>
- <p>When the currently opened mailbox is <tt/Inbox/, this will be expanded
- to:
+</sect2>
- <verb>
-Mutt-ng 1.5.9i on mailhost: Inbox: ...</verb>
-
- <p>For the number of certain types of messages, one more feature of the format
- strings is extremely useful. If there aren't messages of a certain type, it
- may not be desired to print just that there aren't any but instead only
- print something if there are any.
+<sect2>
+<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:
+</para>
- <sect1>Conditional Expansion <!--{{{-->
-
- <p>To only print the number of messages if there are new messages in
- the current mailbox, further extend
- <tt/$status_format/ to:
+<para>
- <verb>
-set status_format = "%v on %h: %B %?n?%n new? ...</verb>
+<screen>
+set status_format = "%v on %h: %B %?n?%n new? ...
+</screen>
- <p>This feature is called <em/nonzero-printing/ and works as this:
- some expandos may be optionally printed nonzero, i.e. a portion
- of the format string is only evaluated if the value of the expando
- is different from zero. The basic syntax is:
+</para>
- <verb>
-%?<item>?<string if nonzero>?</verb>
+<para>
+This feature is called <emphasis>nonzero-printing</emphasis> and works as this:
+some expandos may be optionally printed nonzero, i.e. a portion
+of the format string is only evaluated if the value of the expando
+is different from zero. The basic syntax is:
+</para>
- <p>which tells mutt-ng to only look at <tt><string if
- nonzero></tt> if the value of the <tt>%<item%gt;</tt>
- expando is different from zero. In our example, we used <tt/n/ as
- the expando to check for and <tt/%n new/ as the optional nonzero
- string.
+<para>
- <p>But this is not all: this feature only offers one alternative:
- ``print something if not zero.'' Mutt-ng does, as you might guess,
- also provide a logically complete version: ``if zero, print
- something and else print something else.'' This is achieved by the
- following syntax for those expandos which may be printed nonzero:
+<screen>
+%?<item>?<string if nonzero>?
+</screen>
- <verb>
-%?<item>?<string if nonzero>&<string if zero>?</verb>
+</para>
- <p>Using this we can make mutt-ng to do the following:
+<para>
+which tells mutt-ng to only look at <literal><string if
+nonzero></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 optional nonzero
+string.
+</para>
- <itemize>
+<para>
+But this is not all: this feature only offers one alternative:
+``print something if not zero.'' Mutt-ng does, as you might guess,
+also provide a logically complete version: ``if zero, print
+something and else print something else.'' This is achieved by the
+following syntax for those expandos which may be printed nonzero:
+</para>
- <item> make it print ``<em/n/ new messages'' whereby <em/n/ is the
- count but only if there new ones
+<para>
- <item> and make it print ``no new messages'' if there aren't any
+<screen>
+%?<item>?<string if nonzero>&<string if zero>?
+</screen>
- </itemize>
+</para>
- <p>The corresponding configuration is:
+<para>
+Using this we can make mutt-ng to do the following:
+</para>
- <verb>
-set status_format = "%v on %h: %B: %?n?%n new messages&no new messages? ...</verb>
+<para>
- <p>This doubles the use of the ``new messages'' string because it'll get
- always printed. Thus, it can be shortened to:
+<itemizedlist>
+<listitem>
- <verb>
-set status_format = "%v on %h: %B: %?n?%n&no? new messages ...</verb>
+<para>
+ make it print ``<emphasis>n</emphasis> new messages'' whereby <emphasis>n</emphasis> is the
+count but only if there new ones
- <p>As you might see from this rather simple example, one can create
- very complex but fancy status messages. Please see the reference
- chapter for expandos and those which may be printed nonzero.
+</para>
+</listitem>
+<listitem>
- <!--}}}-->
-
- <sect1>Modifications and Padding <!--{{{-->
+<para>
+ and make it print ``no new messages'' if there aren't any
- <p>Besides the information given so far, there're even more features of
- format strings:
+</para>
+</listitem>
- <itemize>
+</itemizedlist>
- <item>When specifying <tt>%_<item></tt> instead of
- just <tt>%<item></tt>, mutt-ng will convert all
- characters in the expansion of <tt><item></tt> to
- lowercase.
+</para>
- <item>When specifying <tt>%:<item></tt> instead of just
- <tt>%<item></tt>, mutt-ng will convert all dots in the
- expansion of <tt><item></tt> to underscores
- (<tt>_</tt>).
+<para>
+The corresponding configuration is:
+</para>
- </itemize>
-
- <p>Also, there's a feature called <em/Padding/ supplied by the
- following two expandos: <tt/%|X/ and <tt/%>X/.
+<para>
+
+<screen>
+set status_format = "%v on %h: %B: %?n?%n new messages&no new messages? ...
+</screen>
- <descrip>
+</para>
- <tag><tt>%|X</tt></tag> When this occurs, mutt-ng will fill the
- rest of the line with the character <tt/X/. In our example,
- filling the rest of the line with dashes is done by setting:
+<para>
+This doubles the use of the ``new messages'' string because it'll get
+always printed. Thus, it can be shortened to:
+</para>
- <verb>
-set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"</verb>
+<para>
- <tag><tt>%>X</tt></tag> Since the previous expando stops at
- the end of line, there must be a way to fill the gap between
- two items via the <tt>%>X</tt> expando: it puts as many
- characters <tt>X</tt> 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 <tt>%></tt>):
+<screen>
+set status_format = "%v on %h: %B: %?n?%n&no? new messages ...
+</screen>
- <verb>
-set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"</verb>
+</para>
- </descrip>
+<para>
+As you might see from this rather simple example, one can create
+very complex but fancy status messages. Please see the reference
+chapter for expandos and those which may be printed nonzero.
+</para>
- <!--}}}-->
+<para>
- <!--}}}-->
+</para>
+
+</sect2>
+
+<sect2>
+<title>Modifications and Padding </title>
+
+<para>
+Besides the information given so far, there're even more features of
+format strings:
+</para>
+
+<para>
+
+<itemizedlist>
+<listitem>
+
+<para>
+When specifying <literal>%_<item></literal> instead of
+just <literal>%<item></literal>, mutt-ng will convert all
+characters in the expansion of <literal><item></literal> to
+lowercase.
+
+</para>
+</listitem>
+<listitem>
+
+<para>
+When specifying <literal>%:<item></literal> instead of just
+<literal>%<item></literal>, mutt-ng will convert all dots in the
+expansion of <literal><item></literal> to underscores
+(<literal>_</literal>).
+
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+<para>
+Also, there's a feature called <emphasis>Padding</emphasis> supplied by the
+following two expandos: <literal>%|X</literal> and <literal>%>X</literal>.
+</para>
+
+<para>
+<variablelist>
+
+<varlistentry>
+<term><literal>%|X</literal></term>
+<listitem>
+<para>
+When this occurs, mutt-ng will fill the
+rest of the line with the character <literal>X</literal>. In our example,
+filling the rest of the line with dashes is done by setting:
+</para>
+
+<para>
+
+<screen>
+set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"
+</screen>
+
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term><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: 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>):
+</para>
+
+<para>
+
+<screen>
+set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"
+</screen>
+
+</para>
+</listitem></varlistentry>
+</variablelist>
+</para>
+
+<para>
+
+</para>
+
+<para>
-<sect>Using Tags <!--{{{-->
-<p>
+</para>
+</sect2>
+
+</sect1>
+
+<sect1>
+<title>Using Tags </title>
+
+<para>
Sometimes it is desirable to perform an operation on a group of
messages all at once rather than one at a time. An example might be
to save messages to a mailing list to a separate folder, or to
matching a pattern, use the tag-pattern function, which is bound to
``shift-T'' by default. Or you can select individual messages by
hand using the ``tag-message'' function, which is bound to ``t'' by
-default. See <ref id="patterns" name="patterns"> for Mutt-ng's pattern
+default. See <link linkend="patterns">patterns</link> for Mutt-ng's pattern
matching syntax.
+</para>
+<para>
Once you have tagged the desired messages, you can use the
``tag-prefix'' operator, which is the ``;'' (semicolon) key by default.
-When the ``tag-prefix'' operator is used, the <bf/next/ operation will
+When the ``tag-prefix'' operator is used, the <emphasis role="bold">next</emphasis> operation will
be applied to all tagged messages if that operation can be used in that
-manner. If the <ref id="auto_tag" name="$auto_tag">
+manner. If the <link linkend="auto-tag">auto-tag</link>
variable is set, the next operation applies to the tagged messages
automatically, without requiring the ``tag-prefix''.
+</para>
-In <ref id="macro" name="macros"> or <ref id="push" name="push"> commands,
+<para>
+In <link linkend="macro">macro</link> or <link linkend="push">push</link> 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 ``end-cond''
operator; after this operator the rest of the macro will be executed as
normal.
+</para>
+
+<para>
+
+</para>
+
+</sect1>
-<!--}}}-->
+<sect1 id="hooks">
+<title>Using Hooks </title>
-<sect>Using Hooks<label id="hooks"> <!--{{{-->
-<p>
-A <em/hook/ is a concept borrowed from the EMACS editor which allows you to
+<para>
+A <emphasis>hook</emphasis> is a concept borrowed from the EMACS editor which allows you to
execute arbitrary commands before performing some operation. For example,
you may wish to tailor your configuration based upon which mailbox you are
-reading, or to whom you are sending mail. In the Mutt-ng world, a <em/hook/
-consists of a <ref id="regexp" name="regular expression"> or
-<ref id="patterns" name="pattern"> along with a
+reading, or to whom you are sending mail. In the Mutt-ng world, a <emphasis>hook</emphasis>
+consists of a <link linkend="regexp">regexp</link> or
+<link linkend="patterns">patterns</link> along with a
configuration option/command. See
-<itemize>
-<item><ref id="folder-hook" name="folder-hook">
-<item><ref id="send-hook" name="send-hook">
-<item><ref id="message-hook" name="message-hook">
-<item><ref id="save-hook" name="save-hook">
-<item><ref id="mbox-hook" name="mbox-hook">
-<item><ref id="fcc-hook" name="fcc-hook">
-<item><ref id="fcc-save-hook" name="fcc-save-hook">
-</itemize>
-for specific details on each type of <em/hook/ available.
-
-<bf/Note:/ if a hook changes configuration settings, these changes remain
+
+<itemizedlist>
+<listitem>
+
+<para>
+<link linkend="folder-hook">folder-hook</link>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<link linkend="send-hook">send-hook</link>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<link linkend="message-hook">message-hook</link>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<link linkend="save-hook">save-hook</link>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<link linkend="mbox-hook">mbox-hook</link>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<link linkend="fcc-hook">fcc-hook</link>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<link linkend="fcc-save-hook">fcc-save-hook</link>
+</para>
+</listitem>
+
+</itemizedlist>
+
+for specific details on each type of <emphasis>hook</emphasis> available.
+</para>
+
+<para>
+<emphasis role="bold">Note:</emphasis> if a hook changes configuration settings, these changes remain
effective until the end of the current mutt session. As this is generally
not desired, a default hook needs to be added before all other hooks to
restore configuration defaults. Here is an example with send-hook and the
-my_hdr directive:
+my_hdr directive:
+</para>
+
+<para>
-<tscreen><verb>
+<screen>
send-hook . 'unmy_hdr From:'
send-hook ~C'^b@b\.b$' my_hdr from: c@c.c
-</verb></tscreen>
+</screen>
-<sect1>Message Matching in Hooks<label id="pattern_hook">
-<p>
-Hooks that act upon messages (<tt/send-hook, save-hook, fcc-hook,
-message-hook/) are evaluated in a slightly different manner. For the other
-types of hooks, a <ref id="regexp" name="regular expression"> is
+</para>
+
+<sect2 id="pattern-hook">
+<title>Message Matching in Hooks</title>
+
+<para>
+Hooks that act upon messages (<literal>send-hook, save-hook, fcc-hook,
+message-hook</literal>) are evaluated in a slightly different manner. For the other
+types of hooks, a <link linkend="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>
-Mutt-ng allows the use of the <ref id="patterns" name="search pattern">
+<para>
+Mutt-ng allows the use of the <link linkend="patterns">patterns</link>
language for matching messages in hook commands. This works in
-exactly the same way as it would when <em/limiting/ or
-<em/searching/ the mailbox, except that you are restricted to those
+exactly the same way as it would when <emphasis>limiting</emphasis> or
+<emphasis>searching</emphasis> the mailbox, except that you are restricted to those
operators which match information mutt extracts from the header of
the message (i.e. from, to, cc, date, subject, etc.).
+</para>
+<para>
For example, if you wanted to set your return address based upon sending
mail to a specific address, you could do something like:
-<tscreen><verb>
-send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt-ng User <user@host>'
-</verb></tscreen>
+
+<screen>
+send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt-ng User <user@host>'
+</screen>
+
which would execute the given command when sending mail to
-<em/me@cs.hmc.edu/.
+<emphasis>me@cs.hmc.edu</emphasis>.
+</para>
+<para>
However, it is not required that you write the pattern to match using the
-full searching language. You can still specify a simple <em/regular
-expression/ like the other hooks, in which case Mutt-ng will translate your
+full searching language. You can still specify a simple <emphasis>regular
+expression</emphasis> like the other hooks, in which case Mutt-ng will translate your
pattern into the full language, using the translation specified by the
-<ref id="default_hook" name="$default_hook"> variable. The
+<link linkend="default-hook">default-hook</link> variable. The
pattern is translated at the time the hook is declared, so the value of
-<ref id="default_hook" name="$default_hook"> that is in effect
+<link linkend="default-hook">default-hook</link> that is in effect
at that time will be used.
+</para>
-<!--}}}-->
+<para>
+
+</para>
+
+</sect2>
+
+</sect1>
+
+<sect1 id="sidebar">
+<title>Using the sidebar </title>
-<sect>Using the sidebar<label id="sidebar"> <!--{{{-->
-<p>
+<para>
The sidebar, a feature specific to Mutt-ng, allows you to use a mailbox listing
which looks very similar to the ones you probably know from GUI mail clients.
The sidebar lists all specified mailboxes, shows the number in each
and highlights the ones with new email
Use the following configuration commands:
-<tscreen><verb>
+
+<screen>
set sidebar_visible="yes"
set sidebar_width=25
-</verb></tscreen>
+</screen>
+
+</para>
+<para>
If you want to specify the mailboxes you can do so with:
-<tscreen><verb>
+
+<screen>
set mbox='=INBOX'
mailboxes INBOX \
MBOX1 \
MBOX2 \
...
-</verb></tscreen>
+</screen>
+
+</para>
+<para>
You can also specify the colors for mailboxes with new mails by using:
-<tscreen><verb>
+
+<screen>
color sidebar_new red black
color sidebar white black
-</verb></tscreen>
+</screen>
+
+</para>
+<para>
The available functions are:
-<tscreen><verb>
+
+<screen>
sidebar-scroll-up Scrolls the mailbox list up 1 page
sidebar-scroll-down Scrolls the mailbox list down 1 page
sidebar-next Highlights the next mailbox
sidebar-next-new Highlights the next mailbox with new mail
sidebar-previous Highlights the previous mailbox
sidebar-open Opens the currently highlighted mailbox
-</verb></tscreen>
+</screen>
+
+</para>
+<para>
Reasonable key bindings look e.g. like this:
-<tscreen><verb>
+
+<screen>
bind index \Cp sidebar-prev
bind index \Cn sidebar-next
bind index \Cb sidebar-open
macro index B ':toggle sidebar_visible^M'
macro pager B ':toggle sidebar_visible^M'
-</verb></tscreen>
+</screen>
+
+</para>
+<para>
You can then go up and down by pressing Ctrl-P and Ctrl-N, and
switch on and off the sidebar simply by pressing 'B'.
+</para>
+
+<para>
+
+</para>
-<!--}}}-->
+</sect1>
-<sect>External Address Queries<label id="query"> <!--{{{-->
-<p>
+<sect1 id="query">
+<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 <ref id="query_command"
-name="$query_command"> variable, you specify the wrapper
+using a simple interface. Using the <link linkend="query-command">query-command</link> variable, you specify the wrapper
command to use. For example:
+</para>
+
+<para>
-<tscreen><verb>
+<screen>
set query_command = "mutt_ldap_query.pl '%s'"
-</verb></tscreen>
+</screen>
+</para>
+
+<para>
The wrapper script should accept the query on the command-line. It
should return a one line message, then each matching response on a
single line, each line containing a tab separated address then name then
some other optional information. On error, or if there are no matching
addresses, return a non-zero exit code and a one line error message.
+</para>
+<para>
An example multiple response output:
-<tscreen><verb>
+
+<screen>
Searching database ... 20 entries ... 3 matching:
me@cs.hmc.edu Michael Elkins mutt dude
blong@fiction.net Brandon Long mutt and more
roessler@guug.de Thomas Roessler mutt pgp
-</verb></tscreen>
+</screen>
+</para>
+
+<para>
There are two mechanisms for accessing the query function of mutt. One
is to do a query from the index menu using the query function (default: Q).
This will prompt for a query, then bring up the query menu which will
addresses to create aliases, or to mail. You can tag multiple addresses
to mail, start a new query, or have a new query appended to the current
responses.
+</para>
+<para>
The other mechanism for accessing the query function is for address
completion, similar to the alias completion. In any prompt for address
-entry, you can use the complete-query function (default: ^T) to run a
+entry, you can use the complete-query function (default: ˆT) to run a
query based on the current address you have typed. Like aliases, mutt
will look for what you have typed back to the last space or comma. If
there is a single response for that query, mutt will expand the address
in place. If there are multiple responses, mutt will activate the query
menu. At the query menu, you can select one or more addresses to be
added to the prompt.
+</para>
+
+<para>
+
+</para>
+
+</sect1>
-<!--}}}-->
+<sect1>
+<title>Mailbox Formats </title>
-<sect>Mailbox Formats <!--{{{-->
-<p>
+<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 new
-mailboxes, Mutt-ng uses the default specified with the <ref id="mbox_type"
-name="$mbox_type"> variable.
+mailboxes, Mutt-ng uses the default specified with the <link linkend="mbox-type">mbox-type</link> variable.
+</para>
-<bf/mbox/. This is the most widely used mailbox format for UNIX. All
+<para>
+<emphasis role="bold">mbox</emphasis>. This is the most widely used mailbox format for UNIX. All
messages are stored in a single file. Each message has a line of the form:
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST
-</verb></tscreen>
+</screen>
+
+</para>
+<para>
to denote the start of a new message (this is often referred to as the
``From_'' line).
+</para>
-<bf/MMDF/. This is a variant of the <em/mbox/ format. Each message is
-surrounded by lines containing ``^A^A^A^A'' (four control-A's).
+<para>
+<emphasis role="bold">MMDF</emphasis>. This is a variant of the <emphasis>mbox</emphasis> format. Each message is
+surrounded by lines containing ``ˆAˆAˆAˆA'' (four control-A's).
+</para>
-<bf/MH/. A radical departure from <em/mbox/ and <em/MMDF/, a mailbox
+<para>
+<emphasis role="bold">MH</emphasis>. A radical departure from <emphasis>mbox</emphasis> and <emphasis>MMDF</emphasis>, a mailbox
consists of a directory and each message is stored in a separate file.
The filename indicates the message number (however, this is may not
correspond to the message number Mutt-ng displays). Deleted messages are
-renamed with a comma (,) prepended to the filename. <bf/Note:/ Mutt
-detects this type of mailbox by looking for either <tt/.mh_sequences/
-or <tt/.xmhcache/ (needed to distinguish normal directories from MH
+renamed with a comma (,) prepended to the filename. <emphasis role="bold">Note:</emphasis> Mutt
+detects this type of mailbox by looking for either <literal>.mh_sequences</literal>
+or <literal>.xmhcache</literal> (needed to distinguish normal directories from MH
mailboxes).
+</para>
-<bf/Maildir/. The newest of the mailbox formats, used by the Qmail MTA (a
-replacement for sendmail). Similar to <em/MH/, except that it adds three
-subdirectories of the mailbox: <em/tmp/, <em/new/ and <em/cur/. Filenames
+<para>
+<emphasis role="bold">Maildir</emphasis>. The newest of the mailbox formats, used by the Qmail MTA (a
+replacement for sendmail). Similar to <emphasis>MH</emphasis>, except that it adds three
+subdirectories of the mailbox: <emphasis>tmp</emphasis>, <emphasis>new</emphasis> and <emphasis>cur</emphasis>. Filenames
for the messages are chosen in such a way they are unique, even when two
programs are writing the mailbox over NFS, which means that no file locking
is needed.
+</para>
+
+<para>
+
+</para>
-<!--}}}-->
+</sect1>
-<sect>Mailbox Shortcuts<label id="shortcuts"> <!--{{{-->
-<p>
+<sect1 id="shortcuts">
+<title>Mailbox Shortcuts </title>
+
+<para>
There are a number of built in shortcuts which refer to specific mailboxes.
These shortcuts can be used anywhere you are prompted for a file or mailbox
path.
+</para>
+
+<para>
+
+<itemizedlist>
+<listitem>
+
+<para>
+! -- refers to your <link linkend="spoolfile">spoolfile</link> (incoming) mailbox
+</para>
+</listitem>
+<listitem>
+
+<para>
+> -- refers to your <link linkend="mbox">mbox</link> file
+</para>
+</listitem>
+<listitem>
+
+<para>
+< -- refers to your <link linkend="record">record</link> file
+</para>
+</listitem>
+<listitem>
+
+<para>
+ˆ -- refers to the current mailbox
+</para>
+</listitem>
+<listitem>
+
+<para>
+- or !! -- refers to the file you've last visited
+</para>
+</listitem>
+<listitem>
+
+<para>
+˜ -- refers to your home directory
+</para>
+</listitem>
+<listitem>
+
+<para>
+= or + -- refers to your <link linkend="folder">folder</link> directory
+</para>
+</listitem>
+<listitem>
+
+<para>
+@<emphasis>alias</emphasis> -- refers to the <link linkend="save-hook">save-hook</link> as determined by the address of the alias
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+<para>
+
+</para>
-<itemize>
-<item>! -- refers to your <ref id="spoolfile" name="$spoolfile"> (incoming) mailbox
-<item>> -- refers to your <ref id="mbox" name="$mbox"> file
-<item>< -- refers to your <ref id="record" name="$record"> file
-<item>^ -- refers to the current mailbox
-<item>- or !! -- refers to the file you've last visited
-<item>˜ -- refers to your home directory
-<item>= or + -- refers to your <ref id="folder" name="$folder"> directory
-<item>@<em/alias/ -- refers to the <ref id="save-hook"
-name="default save folder"> as determined by the address of the alias
-</itemize>
-
-<!--}}}-->
+</sect1>
-<sect>Handling Mailing Lists<label id="using_lists"> <!--{{{-->
-<p>
+<sect1 id="using-lists">
+<title>Handling Mailing Lists </title>
+<para>
Mutt-ng has a few configuration options that make dealing with large
amounts of mail easier. The first thing you must do is to let Mutt
know what addresses you consider to be mailing lists (technically
this does not have to be a mailing list, but that is what it is most
often used for), and what lists you are subscribed to. This is
-accomplished through the use of the <ref id="lists"
-name="lists and subscribe"> commands in your muttrc.
+accomplished through the use of the <link linkend="lists">lists</link> commands in your muttrc.
+</para>
+<para>
Now that Mutt-ng knows what your mailing lists are, it can do several
things, the first of which is the ability to show the name of a list
through which you received a message (i.e., of a subscribed list) in
-the <em/index/ menu display. This is useful to distinguish between
-personal and list mail in the same mailbox. In the <ref id="index_format"
-name="$index_format"> variable, the escape ``%L''
+the <emphasis>index</emphasis> menu display. This is useful to distinguish between
+personal and list mail in the same mailbox. In the <link linkend="index-format">index-format</link> variable, the escape ``%L''
will return the string ``To <list>'' when ``list'' appears in the
``To'' field, and ``Cc <list>'' when it appears in the ``Cc''
field (otherwise it returns the name of the author).
+</para>
+<para>
Often times the ``To'' and ``Cc'' fields in mailing list messages
tend to get quite large. Most people do not bother to remove the
author of the message they are reply to from the list, resulting in
two or more copies being sent to that person. The ``list-reply''
-function, which by default is bound to ``L'' in the <em/index/ menu
-and <em/pager/, helps reduce the clutter by only replying to the
+function, which by default is bound to ``L'' in the <emphasis>index</emphasis> menu
+and <emphasis>pager</emphasis>, helps reduce the clutter by only replying to the
known mailing list addresses instead of all recipients (except as
-specified by <tt/Mail-Followup-To/, see below).
+specified by <literal>Mail-Followup-To</literal>, see below).
+</para>
-Mutt-ng also supports the <tt/Mail-Followup-To/ header. When you send
+<para>
+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 <ref id="followup_to"
-name="$followup_to"> option is set, mutt will generate
+subscribed mailing lists, and if the <link linkend="followup-to">followup-to</link> option is set, mutt will generate
a Mail-Followup-To header which contains all the recipients to whom
you send this message, but not your address. This indicates that
group-replies or list-replies (also known as ``followups'') to this
message should only be sent to the original recipients of the
message, and not separately to you - you'll receive your copy through
one of the mailing lists you are subscribed to.
+</para>
+<para>
Conversely, when group-replying or list-replying to a message which
-has a <tt/Mail-Followup-To/ header, mutt will respect this header if
-the <ref id="honor_followup_to"
-name="$honor_followup_to"> configuration
+has a <literal>Mail-Followup-To</literal> header, mutt will respect this header if
+the <link linkend="honor-followup-to">honor-followup-to</link> configuration
variable is set. Using list-reply will in this case also make sure
that the reply goes to the mailing list, even if it's not specified
-in the list of recipients in the <tt/Mail-Followup-To/.
+in the list of recipients in the <literal>Mail-Followup-To</literal>.
+</para>
+<para>
Note that, when header editing is enabled, you can create a
-<tt/Mail-Followup-To/ header manually. Mutt-ng will only auto-generate
+<literal>Mail-Followup-To</literal> header manually. Mutt-ng will only auto-generate
this header if it doesn't exist when you send the message.
+</para>
-
+<para>
The other method some mailing list admins use is to generate a
``Reply-To'' field which points back to the mailing list address rather
than the author of the message. This can create problems when trying
to reply directly to the author in private, since most mail clients
will automatically reply to the address given in the ``Reply-To''
-field. Mutt-ng uses the <ref id="reply_to" name="$reply_to">
-variable to help decide which address to use. If set to <em/ask-yes/ or
-<em/ask-no/, you will be
+field. Mutt-ng uses the <link linkend="reply-to">reply-to</link>
+variable to help decide which address to use. If set to <emphasis>ask-yes</emphasis> or
+<emphasis>ask-no</emphasis>, you will be
prompted as to whether or not you would like to use the address given in
the ``Reply-To'' field, or reply directly to the address given in the
-``From'' field. When set to <em/yes/, the ``Reply-To'' field will be used when
+``From'' field. When set to <emphasis>yes</emphasis>, the ``Reply-To'' field will be used when
present.
+</para>
+<para>
The ``X-Label:'' header field can be used to further identify mailing
lists or list subject matter (or just to annotate messages
-individually). The <ref id="index_format"
-name="$index_format"> variable's ``%y'' and
+individually). The <link linkend="index-format">index-format</link> 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 not a
standard message header field, but it can easily be inserted by procmail
and other mail filtering agents.
+</para>
-Lastly, Mutt-ng has the ability to <ref id="sort" name="sort"> the mailbox into
-<ref id="threads" name="threads">. A thread is a group of messages which all relate to the same
+<para>
+Lastly, Mutt-ng has the ability to <link linkend="sort">sort</link> the mailbox into
+<link linkend="threads">threads</link>. A thread is a group of messages which all relate to the same
subject. This is usually organized into a tree-like structure where a
message and all of its replies are represented graphically. If you've ever
used a threaded news client, this is the same concept. It makes dealing
with large volume mailing lists easier because you can easily delete
uninteresting threads and quickly find topics of value.
+</para>
-<!--}}}-->
+<para>
+
+</para>
+
+</sect1>
-<sect>Editing threads <!--{{{-->
-<p>
+<sect1>
+<title>Editing threads </title>
+
+<para>
Mutt-ng has the ability to dynamically restructure threads that are broken
either by misconfigured software or bad behavior from some
correspondents. This allows to clean your mailboxes formats) from these
annoyances which make it hard to follow a discussion.
+</para>
-<sect1>Linking threads
-<p>
+<sect2>
+<title>Linking threads</title>
+<para>
Some mailers tend to "forget" to correctly set the "In-Reply-To:" and
"References:" headers when replying to a message. This results in broken
discussions because Mutt-ng has not enough information to guess the correct
threading.
You can fix this by tagging the reply, then moving to the parent message
-and using the ``link-threads'' function (bound to & by default). The
+and using the ``link-threads'' function (bound to & by default). The
reply will then be connected to this "parent" message.
+</para>
+<para>
You can also connect multiple 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>
-<sect1>Breaking threads
-<p>
+<sect2>
+<title>Breaking threads</title>
+<para>
On mailing lists, some people are in the bad habit of starting a new
discussion by hitting "reply" to any message from the list and changing
the subject to a totally unrelated one.
You can fix such threads by using the ``break-thread'' function (bound
-by default to #), which will turn the subthread starting from the
+by default to #), which will turn the subthread starting from the
current message into a whole different thread.
+</para>
-<!--}}}-->
+<para>
+
+</para>
+
+</sect2>
-<sect>Delivery Status Notification (DSN) Support<label id="dsn"> <!--{{{-->
-<p>
+</sect1>
+<sect1 id="dsn">
+<title>Delivery Status Notification (DSN) Support </title>
+
+<para>
RFC1894 defines a set of MIME content types for relaying information
about the status of electronic mail messages. These can be thought of as
``return receipts.''
+</para>
+<para>
Users can make use of it in one of the following two ways:
+</para>
+
+<para>
-<itemize>
- <item>Berkeley sendmail 8.8.x currently has some command line options
- in which the mail client can make requests as to what type of status
- messages should be returned.
- <item>The SMTP support via libESMTP supports it, too.
-</itemize>
+<itemizedlist>
+<listitem>
+<para>
+Berkeley sendmail 8.8.x currently has some command line options
+in which the mail client can make requests as to what type of status
+messages should be returned.
+</para>
+</listitem>
+<listitem>
+
+<para>
+The SMTP support via libESMTP supports it, too.
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+<para>
To support this, there are two variables:
+</para>
+
+<para>
+
+<itemizedlist>
+<listitem>
+
+<para>
+<link linkend="dsn-notify">dsn-notify</link> is used
+to request receipts for different results (such as failed message,
+message delivered, etc.).
+
+</para>
+</listitem>
+<listitem>
-<itemize>
+<para>
+<link linkend="dsn-return">dsn-return</link> requests
+how much of your message should be returned with the receipt
+(headers or full message).
- <item><ref id="dsn_notify" name="$dsn_notify"> is used
- to request receipts for different results (such as failed message,
- message delivered, etc.).
+</para>
+</listitem>
- <item><ref id="dsn_return" name="$dsn_return"> requests
- how much of your message should be returned with the receipt
- (headers or full message).
+</itemizedlist>
-</itemize>
+</para>
+<para>
Please see the reference chapter for possible values.
+</para>
-<!--}}}-->
+<para>
+
+</para>
+
+</sect1>
-<sect>POP3 Support (OPTIONAL) <!--{{{-->
-<p>
+<sect1>
+<title>POP3 Support (OPTIONAL) </title>
-If Mutt-ng was compiled with POP3 support (by running the <em/configure/
-script with the <em/--enable-pop/ flag), it has the ability to work
+<para>
+If Mutt-ng was compiled with POP3 support (by running the <emphasis>configure</emphasis>
+script with the <emphasis>--enable-pop</emphasis> flag), it has the ability to work
with mailboxes located on a remote POP3 server and fetch mail for local
browsing.
+</para>
+<para>
You can access the remote POP3 mailbox by selecting the folder
-<tt>pop://popserver/</tt>.
+<literal>pop://popserver/</literal>.
+</para>
+<para>
You can select an alternative port by specifying it with the server, i.e.:
-<tt>pop://popserver:port/</tt>.
+<literal>pop://popserver:port/</literal>.
+</para>
+<para>
You can also specify different username for each folder, i.e.:
-<tt>pop://username@popserver[:port]/</tt>.
+<literal>pop://username@popserver[:port]/</literal>.
+</para>
+<para>
Polling for new mail is more expensive over POP3 than locally. For this
reason the frequency at which Mutt-ng will check for mail remotely can be
controlled by the
-<ref id="pop_mail_check" name="$pop_mail_check">
+<link linkend="pop-mail-check">pop-mail-check</link>
variable, which defaults to every 60 seconds.
+</para>
-If Mutt-ng was compiled with SSL support (by running the <em/configure/
-script with the <em/--with-ssl/ flag), connections to POP3 servers
+<para>
+If Mutt-ng was compiled with SSL support (by running the <emphasis>configure</emphasis>
+script with the <emphasis>--with-ssl</emphasis> flag), connections to POP3 servers
can be encrypted. This naturally requires that the server supports
SSL encrypted connections. To access a folder with POP3/SSL, you should
use pops: prefix, ie:
-<tt>pops://[username@]popserver[:port]/</tt>.
+<literal>pops://[username@]popserver[:port]/</literal>.
+</para>
-Another way to access your POP3 mail is the <em/fetch-mail/ function
-(default: G). It allows to connect to <ref id="pop_host"
-name="pop_host">, fetch all your new mail and place it in the
-local <ref id="spoolfile" name="spoolfile">. After this
+<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>, fetch all your new mail and place it in the
+local <link linkend="spoolfile">spoolfile</link>. After this
point, Mutt-ng runs exactly as if the mail had always been local.
+</para>
-<bf/Note:/ If you only need to fetch all messages to local mailbox
-you should consider using a specialized program, such as <htmlurl
-url="http://www.ccil.org/~esr/fetchmail" name="fetchmail">
+<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
+>
+</para>
+
+<para>
+
+</para>
-<!--}}}-->
+</sect1>
-<sect>IMAP Support (OPTIONAL) <!--{{{-->
-<p>
+<sect1>
+<title>IMAP Support (OPTIONAL) </title>
-If Mutt-ng was compiled with IMAP support (by running the <em/configure/
-script with the <em/--enable-imap/ flag), it has the ability to work
+<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.
+</para>
+<para>
You can access the remote inbox by selecting the folder
-<tt>imap://imapserver/INBOX</tt>, where <tt/imapserver/ is the name of the
-IMAP server and <tt/INBOX/ is the special name for your spool mailbox on
+<literal>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 <tt>imap://imapserver/path/to/folder</tt> where
-<tt>path/to/folder</tt> is the path of the folder you want to access.
+server, you should use <literal>imap://imapserver/path/to/folder</literal> where
+<literal>path/to/folder</literal> is the path of the folder you want to access.
+</para>
+<para>
You can select an alternative port by specifying it with the server, i.e.:
-<tt>imap://imapserver:port/INBOX</tt>.
+<literal>imap://imapserver:port/INBOX</literal>.
+</para>
+<para>
You can also specify different username for each folder, i.e.:
-<tt>imap://username@imapserver[:port]/INBOX</tt>.
+<literal>imap://username@imapserver[:port]/INBOX</literal>.
+</para>
-If Mutt-ng was compiled with SSL support (by running the <em/configure/
-script with the <em/--with-ssl/ flag), connections to IMAP servers
+<para>
+If Mutt-ng was compiled with SSL support (by running the <emphasis>configure</emphasis>
+script with the <emphasis>--with-ssl</emphasis> flag), connections to IMAP servers
can be encrypted. This naturally requires that the server supports
SSL encrypted connections. To access a folder with IMAP/SSL, you should
-use <tt>imaps://[username@]imapserver[:port]/path/to/folder</tt> as your
+use <literal>imaps://[username@]imapserver[:port]/path/to/folder</literal> as your
folder path.
+</para>
+<para>
Pine-compatible notation is also supported, i.e.
-<tt>{[username@]imapserver[:port][/ssl]}path/to/folder</tt>
+<literal>{[username@]imapserver[:port][/ssl]}path/to/folder</literal>
+</para>
+<para>
Note that not all servers use / as the hierarchy separator. Mutt-ng should
correctly notice which separator is being used by the server and convert
paths accordingly.
+</para>
+<para>
When browsing folders on an IMAP server, you can toggle whether to look
at only the folders you are subscribed to, or all folders with the
-<em/toggle-subscribed/ command. See also the
-<ref id="imap_list_subscribed"
-name="$imap_list_subscribed"> variable.
+<emphasis>toggle-subscribed</emphasis> command. See also the
+<link linkend="imap-list-subscribed">imap-list-subscribed</link> variable.
+</para>
+<para>
Polling for new mail on an IMAP server can cause noticeable delays. So, you'll
want to carefully tune the
-<ref id="imap_mail_check" name="$imap_mail_check">
+<link linkend="imap-mail-check">imap-mail-check</link>
and
-<ref id="timeout" name="$timeout">
+<link linkend="timeout">timeout</link>
variables.
+</para>
+<para>
Note that if you are using mbox as the mail store on UW servers prior to
v12.250, the server has been reported to disconnect a client if another client
selects the same folder.
+</para>
-<sect1>The Folder Browser
-<p>
+<sect2>
+<title>The Folder Browser</title>
+<para>
As of version 1.2, mutt supports browsing mailboxes on an IMAP
server. This is mostly the same as the local file browser, with the
following differences:
-<itemize>
-<item>Instead of file permissions, mutt displays the string "IMAP",
- possibly followed by the symbol "+", indicating
- that the entry contains both messages and subfolders. On
- Cyrus-like servers folders will often contain both messages and
- subfolders.
-<item>For the case where an entry can contain both messages and
- subfolders, the selection key (bound to <tt>enter</tt> by default)
- will choose to descend into the subfolder view. If you wish to view
- the messages in that folder, you must use <tt>view-file</tt> instead
- (bound to <tt>space</tt> by default).
-<item>You can create, delete and rename mailboxes with the
- <tt>create-mailbox</tt>, <tt>delete-mailbox</tt>, and
- <tt>rename-mailbox</tt> commands (default bindings: <tt>C</tt>,
- <tt>d</tt> and <tt>r</tt>, respectively). You may also
- <tt>subscribe</tt> and <tt>unsubscribe</tt> to mailboxes (normally
- these are bound to <tt>s</tt> and <tt>u</tt>, respectively).
-</itemize>
-
-<sect1>Authentication
-<p>
+<itemizedlist>
+<listitem>
+
+<para>
+Instead of file permissions, mutt displays the string "IMAP",
+possibly followed by the symbol "+", indicating
+that the entry contains both messages and subfolders. On
+Cyrus-like servers folders will often contain both messages and
+subfolders.
+</para>
+</listitem>
+<listitem>
+
+<para>
+For the case where an entry can contain both messages and
+subfolders, the selection key (bound to <literal>enter</literal> by default)
+will choose to descend into the subfolder view. If you wish to view
+the messages in that folder, you must use <literal>view-file</literal> instead
+(bound to <literal>space</literal> by default).
+</para>
+</listitem>
+<listitem>
+
+<para>
+You can create, delete and rename mailboxes with the
+<literal>create-mailbox</literal>, <literal>delete-mailbox</literal>, and
+<literal>rename-mailbox</literal> commands (default bindings: <literal>C</literal>,
+<literal>d</literal> and <literal>r</literal>, respectively). You may also
+<literal>subscribe</literal> and <literal>unsubscribe</literal> to mailboxes (normally
+these are bound to <literal>s</literal> and <literal>u</literal>, respectively).
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+</sect2>
+
+<sect2>
+<title>Authentication</title>
+
+<para>
Mutt-ng supports four authentication methods with IMAP servers: SASL,
GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add
NTLM authentication for you poor exchange users out there, but it has
the pseudo-protocol ANONYMOUS, which allows you to log in to a public
IMAP server without having an account. To use ANONYMOUS, simply make
your username blank or "anonymous".
-<p>
+</para>
+
+<para>
SASL is a special super-authenticator, which selects among several protocols
(including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most secure
method available on your host and the server. Using some of these methods
(including DIGEST-MD5 and possibly GSSAPI), your entire session will be
encrypted and invisible to those teeming network snoops. It is the best
option if you have it. To use it, you must have the Cyrus SASL library
-installed on your system and compile mutt with the <em/--with-sasl/ flag.
-<p>
+installed on your system and compile mutt with the <emphasis>--with-sasl</emphasis> flag.
+</para>
+
+<para>
Mutt-ng will try whichever methods are compiled in and available on the server,
in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN.
+</para>
+<para>
There are a few variables which control authentication:
-<itemize>
-<item><ref id="imap_user" name="$imap_user"> - controls
- the username under which you request authentication on the IMAP server,
- for all authenticators. This is overridden by an explicit username in
- the mailbox path (i.e. by using a mailbox name of the form
- <tt/{user@host}/).
-<item><ref id="imap_pass" name="$imap_pass"> - a
- password which you may preset, used by all authentication methods where
- a password is needed.
-<item><ref id="imap_authenticators"
- name="$imap_authenticators"> - a colon-delimited list of IMAP
- authentication methods to try, in the order you wish to try them. If
- specified, this overrides mutt's default (attempt everything, in the order
- listed above).
-</itemize>
-
-<!--}}}-->
-
-<sect>NNTP Support (OPTIONAL)<label id="reading_news"> <!--{{{-->
-
-<p>If compiled with ``--enable-nntp'' option, Mutt-ng can read news from
+
+<itemizedlist>
+<listitem>
+
+<para>
+<link linkend="imap-user">imap-user</link> - 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>).
+</para>
+</listitem>
+<listitem>
+
+<para>
+<link linkend="imap-pass">imap-pass</link> - a
+password which you may preset, used by all authentication methods where
+a password is needed.
+</para>
+</listitem>
+<listitem>
+
+<para>
+<link linkend="imap-authenticators">imap-authenticators</link> - a colon-delimited list of IMAP
+authentication methods to try, in the order you wish to try them. If
+specified, this overrides mutt's default (attempt everything, in the order
+listed above).
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+<para>
+
+</para>
+
+</sect2>
+
+</sect1>
+
+<sect1 id="reading-news">
+<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 <tt/i/.
+bound to <literal>i</literal>.
+</para>
-<p>The Default newsserver can be obtained from the
-<tt/$NNTPSERVER/ environment variable. Like other news readers,
+<para>
+The Default newsserver can be obtained from the
+<literal>$NNTPSERVER</literal> environment variable. Like other news readers,
info about subscribed newsgroups is saved in a file as specified by the
-<ref id="nntp_newsrc" name="$nntp_newsrc"> variable.
+<link linkend="nntp-newsrc">nntp-newsrc</link> 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>
-<sect1>Again: Scoring <!--{{{-->
+<sect2>
+<title>Again: Scoring </title>
- <p>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 <ref id="score-command" name="Message scoring">.
+<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>.
+</para>
- <p>What has not been discusses in detail is mutt-ng's built-in
- realname filter. For may newsreaders including those for
- ``advanced users'' like <em/slrn/ or <em/tin/, there are frequent
- request for such functionality. The solutions offered often are
- complicated regular expressions.
+<para>
+What has not been discusses in detail is mutt-ng's built-in
+realname filter. For may newsreaders including those for
+``advanced users'' like <emphasis>slrn</emphasis> or <emphasis>tin</emphasis>, there are frequent
+request for such functionality. The solutions offered often are
+complicated regular expressions.
+</para>
- <p>In mutt-ng this is as easy as
+<para>
+In mutt-ng this is as easy as
+</para>
- <verb>
+<para>
+
+<screen>
score ~* =42
- </verb>
+
+</screen>
+
+</para>
+
+<para>
+This tells mutt-ng to apply a score of 42 to all messages whose
+sender specified a valid realname and a valid email address. Using
+</para>
- <p>This tells mutt-ng to apply a score of 42 to all messages whose
- sender specified a valid realname and a valid email address. Using
+<para>
- <verb>
+<screen>
score !~* =42
- </verb>
+
+</screen>
+
+</para>
+
+<para>
+on the contrary applies a score of 42 to all messages <emphasis>not</emphasis>
+matching those criteria which are very strict:
+</para>
+
+<para>
+
+<itemizedlist>
+<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
+>
+
+</para>
+</listitem>
+<listitem>
+
+<para>
+the name must consist of at least 2 fields whereby a field
+must not end in a dot. This means that ``Joe User'' and ``Joe A.
+User'' are valid while ``J. User'' and ``J. A. User'' aren't.
- <p>on the contrary applies a score of 42 to all messages <em/not/
- matching those criteria which are very strict:
+</para>
+</listitem>
+<listitem>
- <itemize>
+<para>
+it's assumed that users are interested in reading their
+own mail and mail from people who they have defined an alias for
+so that those 2 groups of messages are excluded from the strict
+rules.
- <item>Email addresses must be valid according to RFC 2822, see
- <htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc2822.txt"
- name="<ftp://ftp.rfc-editor.org/in-notes/rfc2822.txt>">
+</para>
+</listitem>
- <item>the name must consist of at least 2 fields whereby a field
- must not end in a dot. This means that ``Joe User'' and ``Joe A.
- User'' are valid while ``J. User'' and ``J. A. User'' aren't.
+</itemizedlist>
- <item>it's assumed that users are interested in reading their
- own mail and mail from people who they have defined an alias for
- so that those 2 groups of messages are excluded from the strict
- rules.
+</para>
- </itemize>
+<para>
+
+</para>
+
+<para>
+
+</para>
- <!--}}}-->
+</sect2>
-<!--}}}-->
+</sect1>
-<sect>SMTP Support (OPTIONAL) <!--{{{-->
+<sect1>
+<title>SMTP Support (OPTIONAL) </title>
-<p>Mutt-ng can be built using a library called ``libESMTP'' which
-provides SMTP functionality. When <tt/configure/ was called with
-<tt/--with-libesmtp/ or the output <tt>muttng -v</tt> contains
-<tt>+USE_LIBESMTP</tt>, this will be or is the case already. The SMTP
-support includes support for Delivery Status Notification (see <ref
-id="dsn" name="Delivery Status Notification"> section) as well as
-handling the <tt/8BITMIME/ flag controlled via <ref id="use_8bitmime"
-name="$use_8bitmime">.
+<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 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>.
+</para>
-<p>To enable sending mail directly via SMTP without an MTA such as
-Postfix or SSMTP and the like, simply set the <ref id="smtp_host"
-name="$smtp_host"> variable pointing to your SMTP server.
+<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> variable pointing to your SMTP server.
+</para>
-<p>Authentication mechanisms are available via the <ref id="smtp_user"
-name="$smtp_user"> and <ref id="smtp_pass"
-name="$smtp_pass"> variables.
+<para>
+Authentication mechanisms are available via the <link linkend="smtp-user">smtp-user</link> and <link linkend="smtp-pass">smtp-pass</link> variables.
+</para>
-<p>Transport Encryption via the StartTLS command is also available. For
+<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 <ref id="smtp_use_tls"
-name="$smtp_use_tls"> variable must be either set
+Secondly, the <link linkend="smtp-use-tls">smtp-use-tls</link> 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 if
it doesn't while switching back to unencrypted communication for the
first one.
+</para>
-<p>Some mail providers require user's to set a particular envelope
+<para>
+Some mail providers require user's to set a particular envelope
sender, i.e. they allow for only one value which may not be what the
-user wants to send as the <tt/From:/ header. In this case, the variable
-<ref id="smtp_envelope" name="$smtp_envelope"> may be used
-to set the envelope different from the <tt/From:/ header.
+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
+to set the envelope different from the <literal>From:</literal> header.
+</para>
-<!-- }}} -->
+</sect1>
-<sect>Managing multiple IMAP/POP/NNTP accounts (OPTIONAL)<label id="account-hook"> <!--{{{-->
-<p>
+<sect1 id="account-hook">
+<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
(including inside the folder browser), not just when you open the
mailbox.
-<p>
+</para>
+
+<para>
Some examples:
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'
-</verb></tscreen>
+</screen>
+
+</para>
+
+<para>
+
+</para>
-<!--}}}-->
+</sect1>
-<sect>Start a WWW Browser on URLs (EXTERNAL)<label id="urlview"> <!--{{{-->
-<p>
-If a message contains URLs (<em/unified resource locator/ = address in the
-WWW space like <em>http://www.mutt.org/</em>), it is efficient to get
+<sect1 id="urlview">
+<title>Start a WWW Browser on URLs (EXTERNAL) </title>
+
+<para>
+If a message contains URLs (<emphasis>unified resource locator</emphasis> = address in the
+WWW space like <emphasis>http://www.mutt.org/</emphasis>), it is efficient to get
a menu with all the URLs and start a WWW browser on one of them. This
functionality is provided by the external urlview program which can be
-retrieved at <htmlurl url="ftp://ftp.mutt.org/mutt/contrib/"
-name="ftp://ftp.mutt.org/mutt/contrib/"> and the configuration commands:
-<tscreen><verb>
+retrieved at <ulink
+URL="ftp://ftp.mutt.org/mutt/contrib/"
+>ftp://ftp.mutt.org/mutt/contrib/</ulink
+> and the configuration commands:
+
+<screen>
macro index \cb |urlview\n
macro pager \cb |urlview\n
-</verb></tscreen>
+</screen>
+
+</para>
+
+<para>
+
+</para>
-<!--}}}-->
+</sect1>
-<sect>Compressed folders Support (OPTIONAL) <!--{{{-->
-<p>
+<sect1>
+<title>Compressed folders Support (OPTIONAL) </title>
+<para>
If Mutt-ng was compiled with compressed folders support (by running the
-<em/configure/ script with the <em/--enable-compressed/ flag), Mutt
+<emphasis>configure</emphasis> script with the <emphasis>--enable-compressed</emphasis> flag), Mutt
can open folders stored in an arbitrary format, provided that the user
has a script to convert from/to this format to one of the accepted.
+</para>
+<para>
The most common use is to open compressed archived folders e.g. with
gzip.
+</para>
+<para>
In addition, the user can provide a script that gets a folder in an
accepted format and appends its context to the folder in the
user-defined format, which may be faster than converting the entire
folder to the accepted format, appending to it and converting back to
the user-defined format.
+</para>
-There are three hooks defined (<ref id="open-hook" name="open-hook">,
-<ref id="close-hook" name="close-hook"> and <ref id="append-hook"
-name="append-hook">) which define commands to uncompress and compress
+<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>) which define commands to uncompress and compress
a folder and to append messages to an existing compressed folder
respectively.
+</para>
+<para>
For example:
+</para>
+
+<para>
+
+<screen>
+open-hook \\.gz$ "gzip -cd %f > %t"
+close-hook \\.gz$ "gzip -c %t > %f"
+append-hook \\.gz$ "gzip -c %t >> %f"
+</screen>
+
+</para>
-<tscreen><verb>
-open-hook \\.gz$ "gzip -cd %f > %t"
-close-hook \\.gz$ "gzip -c %t > %f"
-append-hook \\.gz$ "gzip -c %t >> %f"
-</verb></tscreen>
-
-You do not have to specify all of the commands. If you omit <ref
-id="append-hook" name="append-hook">, the folder will be open and
-closed again each time you will add to it. If you omit <ref
-id="close-hook" name="close-hook"> (or give empty command) , the
-folder will be open in the mode. If you specify <ref
-id="append-hook" name="append-hook"> though you'll be able to append
+<para>
+You do not have to specify all of the commands. If you omit <link linkend="append-hook">append-hook</link>, 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> (or give empty command) , the
+folder will be open in the mode. If you specify <link linkend="append-hook">append-hook</link> though you'll be able to append
to the folder.
+</para>
+<para>
Note that Mutt-ng will only try to use hooks if the file is not in one of
the accepted formats. In particular, if the file is empty, mutt
supposes it is not compressed. This is important because it allows the
use of programs that do not have well defined extensions. Just use
-&dquot;.&dquot; as a regexp. But this may be surprising if your
-compressing script produces empty files. In this situation, unset <ref
-id="save_empty" name="$save_empty">, so that the compressed file
+"." 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>, so that the compressed file
will be removed if you delete all of the messages.
+</para>
-<sect1>Open a compressed mailbox for reading<label id="open-hook">
-<p>
-Usage: <tt/open-hook/ <em/regexp/ &dquot;<em/command/&dquot;
+<sect2 id="open-hook">
+<title>Open a compressed mailbox for reading</title>
-The <em/command/ is the command that can be used for opening the
-folders whose names match <em/regexp/.
+<para>
+Usage: <literal>open-hook</literal> <emphasis>regexp</emphasis> "<emphasis>command</emphasis>"
+</para>
-The <em/command/ string is the printf-like format string, and it
+<para>
+The <emphasis>command</emphasis> is the command that can be used for opening the
+folders whose names match <emphasis>regexp</emphasis>.
+</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
name of the temporary folder to which to write.
+</para>
+<para>
%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.
+</para>
-The <em/command/ should <bf/not/ remove the original compressed file.
-The <em/command/ should return non-zero exit status if it fails, so
+<para>
+The <emphasis>command</emphasis> should <emphasis role="bold">not</emphasis> remove the original compressed file.
+The <emphasis>command</emphasis> should return non-zero exit status if it fails, so
mutt knows something's wrong.
+</para>
+<para>
Example:
+</para>
+
+<para>
-<tscreen><verb>
-open-hook \\.gz$ "gzip -cd %f > %t"
-</verb></tscreen>
+<screen>
+open-hook \\.gz$ "gzip -cd %f > %t"
+</screen>
-If the <em/command/ is empty, this operation is disabled for this file
+</para>
+
+<para>
+If the <emphasis>command</emphasis> is empty, this operation is disabled for this file
type.
+</para>
+
+</sect2>
-<sect1>Write a compressed mailbox<label id="close-hook">
-<p>
-Usage: <tt/close-hook/ <em/regexp/ &dquot;<em/command/&dquot;
+<sect2 id="close-hook">
+<title>Write a compressed mailbox</title>
-This is used to close the folder that was open with the <ref id="open-hook"
-name="open-hook"> command after some changes were made to it.
+<para>
+Usage: <literal>close-hook</literal> <emphasis>regexp</emphasis> "<emphasis>command</emphasis>"
+</para>
-The <em/command/ string is the command that can be used for closing the
-folders whose names match <em/regexp/. It has the same format as in
-the <ref id="open-hook" name="open-hook"> command. Temporary folder
-in this case is the folder previously produced by the <<ref id="open-hook"
-name="open-hook"> command.
+<para>
+This is used to close the folder that was open with the <link linkend="open-hook">open-hook</link> command after some changes were made to it.
+</para>
-The <em/command/ should <bf/not/ remove the decompressed file. The
-<em/command/ should return non-zero exit status if it fails, so mutt
+<para>
+The <emphasis>command</emphasis> string is the command that can be 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 folder
+in this case is the folder previously produced by the <<link linkend="open-hook">open-hook</link> command.
+</para>
+
+<para>
+The <emphasis>command</emphasis> should <emphasis role="bold">not</emphasis> remove the decompressed file. The
+<emphasis>command</emphasis> should return non-zero exit status if it fails, so mutt
knows something's wrong.
+</para>
+<para>
Example:
+</para>
+
+<para>
-<tscreen><verb>
-close-hook \\.gz$ "gzip -c %t > %f"
-</verb></tscreen>
+<screen>
+close-hook \\.gz$ "gzip -c %t > %f"
+</screen>
-If the <em/command/ is empty, this operation is disabled for this file
+</para>
+
+<para>
+If the <emphasis>command</emphasis> is empty, this operation is disabled for this file
type, and the file can only be open in the readonly mode.
+</para>
-<ref id="close-hook" name ="close-hook"> is not called when you exit
+<para>
+<link linkend="close-hook">close-hook</link> is not called when you exit
from the folder if the folder was not changed.
+</para>
+
+</sect2>
-<sect1>Append a message to a compressed mailbox<label id="append-hook">
-<p>
-Usage: <tt/append-hook/ <em/regexp/ &dquot;<em/command/&dquot;
+<sect2 id="append-hook">
+<title>Append a message to a compressed mailbox</title>
+<para>
+Usage: <literal>append-hook</literal> <emphasis>regexp</emphasis> "<emphasis>command</emphasis>"
+</para>
+
+<para>
This command is used for saving to an existing compressed folder.
-The <em/command/ is the command that can be used for appending to the
-folders whose names match <em/regexp/. It has the same format as in
- the <ref id="open-hook" name="open-hook"> command.
+The <emphasis>command</emphasis> is the command that can be used for 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 temporary folder in this case contains the messages that are being
appended.
+</para>
-The <em/command/ should <bf/not/ remove the decompressed file. The
-<em/command/ should return non-zero exit status if it fails, so mutt
+<para>
+The <emphasis>command</emphasis> should <emphasis role="bold">not</emphasis> remove the decompressed file. The
+<emphasis>command</emphasis> should return non-zero exit status if it fails, so mutt
knows something's wrong.
+</para>
+<para>
Example:
+</para>
+
+<para>
-<tscreen><verb>
-append-hook \\.gz$ "gzip -c %t >> %f"
-</verb></tscreen>
+<screen>
+append-hook \\.gz$ "gzip -c %t >> %f"
+</screen>
-When <ref id="append-hook" name="append-hook"> is used, the folder is
+</para>
+
+<para>
+When <link linkend="append-hook">append-hook</link> 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 (<ref id="mbox_type"
-name="$mbox_type">) type is always supposed (i.e.
+what the folder type is. Thus the default (<link linkend="mbox-type">mbox-type</link>) type is always supposed (i.e.
this is the format used for the temporary folder).
+</para>
-If the file does not exist when you save to it, <ref id="close-hook"
-name="close-hook"> is called, and not <ref id="append-hook"
-name="append-hook">. <ref id="append-hook" name="append-hook"> is only
+<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> is only
for appending to existing folders.
+</para>
-If the <em/command/ is empty, this operation is disabled for this file
+<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
-<ref id="open-hook" name="open-hook"> and <ref id="close-hook"
-name="close-hook">respectively) each time you will add to it.
+<link linkend="open-hook">open-hook</link> and <link linkend="close-hook">close-hook</link>respectively) each time you will add to it.
+</para>
+
+</sect2>
-<sect1>Encrypted folders
-<p>
+<sect2>
+<title>Encrypted folders</title>
+
+<para>
The compressed folders support can also be used to handle encrypted
folders. If you want to encrypt a folder with PGP, you may want to use
the following hooks:
+</para>
+
+<para>
-<tscreen><verb>
-open-hook \\.pgp$ "pgp -f < %f > %t"
-close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId < %t > %f"
-</verb></tscreen>
+<screen>
+open-hook \\.pgp$ "pgp -f < %f > %t"
+close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId < %t > %f"
+</screen>
+</para>
+
+<para>
Please note, that PGP does not support appending to an encrypted
folder, so there is no append-hook defined.
+</para>
-<bf/Note:/ the folder is temporary stored decrypted in the /tmp
+<para>
+<emphasis role="bold">Note:</emphasis> the folder is temporary stored decrypted in the /tmp
directory, where it can be read by your system administrator. So think
about the security aspects of this.
+</para>
+
+<para>
+
+</para>
+
+<para>
+
+</para>
+
+</sect2>
-<!--}}}-->
+</sect1>
-<!--}}}-->
+</chapter>
-<chapt>Mutt-ng's MIME Support <!--{{{-->
-<p>
+<chapter>
+<title>Mutt-ng's MIME Support </title>
+
+<para>
Quite a bit of effort has been made to make Mutt-ng the premier text-mode
MIME MUA. Every effort has been made to provide the functionality that
the discerning MIME user requires, and the conformance to the standards
wherever possible. When configuring Mutt-ng for MIME, there are two extra
types of configuration files which Mutt-ng uses. One is the
-<tt/mime.types/ file, which contains the mapping of file extensions to
-IANA MIME types. The other is the <tt/mailcap/ file, which specifies
+<literal>mime.types</literal> file, which contains the mapping of file extensions to
+IANA MIME types. The other is the <literal>mailcap</literal> file, which specifies
the external commands to use for handling specific MIME types.
+</para>
+
+<sect1>
+<title>Using MIME in Mutt </title>
-<sect>Using MIME in Mutt <!--{{{-->
-<p>
+<para>
There are three areas/menus in Mutt-ng which deal with MIME, they are the
pager (while viewing a message), the attachment menu and the compose
menu.
+</para>
-<sect1>Viewing MIME messages in the pager
-<p>
+<sect2>
+<title>Viewing MIME messages in the pager</title>
+
+<para>
When you select a message from the index and view it in the pager, Mutt
decodes the message to a text representation. Mutt-ng internally supports
-a number of MIME types, including <tt>text/plain, text/enriched,
-message/rfc822, and message/news</tt>. In addition, the export
+a number of MIME types, including <literal>text/plain, text/enriched,
+message/rfc822, and message/news</literal>. In addition, the export
controlled version of Mutt-ng recognizes a variety of PGP MIME types,
including PGP/MIME and application/pgp.
+</para>
+<para>
Mutt-ng will denote attachments with a couple lines describing them.
These lines are of the form:
-<tscreen><verb>
+
+<screen>
[-- Attachment #1: Description --]
[-- Type: text/plain, Encoding: 7bit, Size: 10000 --]
-</verb></tscreen>
-Where the <tt/Description/ is the description or filename given for the
-attachment, and the <tt/Encoding/ is one of
-<tt>7bit/8bit/quoted-printable/base64/binary</tt>.
+</screen>
+Where the <literal>Description</literal> is the description or filename given for the
+attachment, and the <literal>Encoding</literal> is one of
+<literal>7bit/8bit/quoted-printable/base64/binary</literal>.
+</para>
+
+<para>
If Mutt-ng cannot deal with a MIME type, it will display a message like:
-<tscreen><verb>
+
+<screen>
[-- image/gif is unsupported (use 'v' to view this part) --]
-</verb></tscreen>
+</screen>
+
+</para>
+
+</sect2>
-<sect1>The Attachment Menu<label id="attach_menu">
-<p>
-The default binding for <tt/view-attachments/ is `v', which displays the
+<sect2 id="attach-menu">
+<title>The Attachment Menu</title>
+
+<para>
+The default binding for <literal>view-attachments</literal> is `v', which displays the
attachment menu for a message. The attachment menu displays a list of
the attachments in a message. From the attachment menu, you can save,
print, pipe, delete, and view attachments. You can apply these
current message from this menu, and only the current attachment (or the
attachments tagged) will be quoted in your reply. You can view
attachments as text, or view them using the mailcap viewer definition.
+</para>
+<para>
Finally, you can apply the usual message-related functions (like
-<ref id="resend-message" name="resend-message">, and the reply
-and forward functions) to attachments of type <tt>message/rfc822</tt>.
+<link linkend="resend-message">resend-message</link>, and the reply
+and forward functions) to attachments of type <literal>message/rfc822</literal>.
+</para>
+<para>
See the help on the attachment menu for more information.
+</para>
+
+</sect2>
-<sect1>The Compose Menu<label id="compose_menu">
-<p>
+<sect2 id="compose-menu">
+<title>The Compose Menu</title>
+
+<para>
The compose menu is the menu you see before you send a message. It
allows you to edit the recipient list, the subject, and other aspects
of your message. It also contains a list of the attachments of your
filter, pipe, edit, compose, review, and rename an attachment or a
list of tagged attachments. You can also modifying the attachment
information, notably the type, encoding and description.
+</para>
+<para>
Attachments appear as follows:
-<verb>
-- 1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no description>
- 2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no description>
-</verb>
+<screen>
+- 1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no description>
+ 2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no description>
+</screen>
+
+</para>
+
+<para>
The '-' denotes that Mutt-ng will delete the file after sending (or
postponing, or canceling) the message. It can be toggled with the
-<tt/toggle-unlink/ command (default: u). The next field is the MIME
-content-type, and can be changed with the <tt/edit-type/ command
-(default: ^T). The next field is the encoding for the attachment,
+<literal>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 attachment,
which allows a binary message to be encoded for transmission on 7bit
-links. It can be changed with the <tt/edit-encoding/ command
-(default: ^E). The next field is the size of the attachment,
+links. It can be changed with the <literal>edit-encoding</literal> command
+(default: ˆE). The next field is the size of the attachment,
rounded to kilobytes or megabytes. The next field is the filename,
-which can be changed with the <tt/rename-file/ command (default: R).
+which can be changed with the <literal>rename-file</literal> command (default: R).
The final field is the description of the attachment, and can be
-changed with the <tt/edit-description/ command (default: d).
+changed with the <literal>edit-description</literal> command (default: d).
+</para>
+
+<para>
+
+</para>
+
+</sect2>
-<!--}}}-->
+</sect1>
-<sect>MIME Type configuration with <tt/mime.types/ <!--{{{-->
-<p>
+<sect1>
+<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 <tt>${HOME}/.mime.types</tt>, and then
-the system mime.types file at <tt>/usr/local/share/mutt/mime.types</tt> or
-<tt>/etc/mime.types</tt>
+personal mime.types file at <literal>${HOME}/.mime.types</literal>, and then
+the system mime.types file at <literal>/usr/local/share/mutt/mime.types</literal> or
+<literal>/etc/mime.types</literal>
+</para>
+<para>
The mime.types file consist of lines containing a MIME type and a space
separated list of extensions. For example:
-<tscreen><verb>
+
+<screen>
application/postscript ps eps
application/pgp pgp
audio/x-aiff aif aifc aiff
-</verb></tscreen>
-A sample <tt/mime.types/ file comes with the Mutt-ng distribution, and
+</screen>
+
+A sample <literal>mime.types</literal> file comes with the Mutt-ng distribution, and
should contain most of the MIME types you are likely to use.
+</para>
+<para>
If Mutt-ng can not determine the mime type by the extension of the file you
attach, it will look at the file. If the file is free of binary
information, Mutt-ng will assume that the file is plain text, and mark it
-as <tt>text/plain</tt>. If the file contains binary information, then Mutt-ng will
-mark it as <tt>application/octet-stream</tt>. You can change the MIME
-type that Mutt-ng assigns to an attachment by using the <tt/edit-type/
-command from the compose menu (default: ^T). The MIME type is actually a
+as <literal>text/plain</literal>. If the file contains binary information, then Mutt-ng will
+mark it as <literal>application/octet-stream</literal>. You can change the MIME
+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 actually a
major mime type followed by the sub-type, separated by a '/'. 6 major
types: application, text, image, video, audio, and model have been approved
after various internet discussions. Mutt-ng recognises all of these if the
molecular modelling community to pass molecular data in various forms to
various molecular viewers. Non-recognised mime types should only be used
if the recipient of the message is likely to be expecting such attachments.
+</para>
+
+<para>
+
+</para>
+
+</sect1>
-<!--}}}-->
+<sect1>
+<title>MIME Viewer configuration with <literal>mailcap</literal> </title>
-<sect>MIME Viewer configuration with <tt/mailcap/ <!--{{{-->
-<p>
+<para>
Mutt-ng supports RFC 1524 MIME Configuration, in particular the Unix
specific format specified in Appendix A of RFC 1524. This file format
is commonly referred to as the mailcap format. Many MIME compliant
programs utilize the mailcap format, allowing you to specify handling
for all MIME types in one place for all programs. Programs known to
use this format include Netscape, XMosaic, lynx and metamail.
+</para>
+<para>
In order to handle various MIME types that Mutt-ng can not handle
internally, Mutt-ng parses a series of external configuration files to
find an external handler. The default search string for these files
is a colon delimited list set to
-<tscreen><verb>
+
+<screen>
${HOME}/.mailcap:/usr/local/share/mutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap
-</verb></tscreen>
-where <tt/$HOME/ is your home directory.
+</screen>
+
+where <literal>$HOME</literal> is your home directory.
+</para>
+<para>
In particular, the metamail distribution will install a mailcap file,
-usually as <tt>/usr/local/etc/mailcap</tt>, which contains some baseline
+usually as <literal>/usr/local/etc/mailcap</literal>, which contains some baseline
entries.
+</para>
-<sect1>The Basics of the mailcap file
-<p>
+<sect2>
+<title>The Basics of the mailcap file</title>
+
+<para>
A mailcap file consists of a series of lines which are comments, blank,
or definitions.
+</para>
+<para>
A comment line consists of a # character followed by anything you want.
+</para>
+<para>
A blank line is blank.
+</para>
+<para>
A definition line consists of a content type, a view command, and any
number of optional fields. Each field of a definition line is divided
by a semicolon ';' character.
+</para>
+<para>
The content type is specified in the MIME standard type/subtype method.
For example,
-<tt>text/plain, text/html, image/gif, </tt>
+<literal>text/plain, text/html, image/gif, </literal>
etc. In addition, the mailcap format includes two formats for
wildcards, one using the special '*' subtype, the other is the implicit
-wild, where you only include the major type. For example, <tt>image/*</tt>, or
-<tt>video,</tt> will match all image types and video types,
+wild, where you only include the major type. For example, <literal>image/*</literal>, or
+<literal>video,</literal> will match all image types and video types,
respectively.
+</para>
+<para>
The view command is a Unix command for viewing the type specified. There
are two different types of commands supported. The default is to send
the body of the MIME message to the command on stdin. You can change
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 Mutt
will remove the temporary file if it exists.
+</para>
+<para>
So, in the simplest form, you can send a text/plain message to the
external pager more on stdin:
-<tscreen><verb>
+
+<screen>
text/plain; more
-</verb></tscreen>
+</screen>
+
Or, you could send the message as a file:
-<tscreen><verb>
+
+<screen>
text/plain; more %s
-</verb></tscreen>
+</screen>
+
Perhaps you would like to use lynx to interactively view a text/html
message:
-<tscreen><verb>
+
+<screen>
text/html; lynx %s
-</verb></tscreen>
+</screen>
+
In this case, lynx does not support viewing a file from stdin, so you
must use the %s syntax.
-<bf/Note:/ <em>Some older versions of lynx contain a bug where they
+<emphasis 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 find
the line which calls lynx, and run it. This causes lynx to continuously
-spawn itself to view the object.</em>
+spawn itself to view the object.</emphasis>
+</para>
+<para>
On the other hand, maybe you don't want to use lynx interactively, you
just want to have it convert the text/html to text/plain, then you can
use:
-<tscreen><verb>
+
+<screen>
text/html; lynx -dump %s | more
-</verb></tscreen>
+</screen>
+</para>
+
+<para>
Perhaps you wish to use lynx to view text/html files, and a pager on
all other text formats, then you would use the following:
-<tscreen><verb>
+
+<screen>
text/html; lynx %s
text/*; more
-</verb></tscreen>
+</screen>
+
This is the simplest form of a mailcap file.
+</para>
+
+</sect2>
-<sect1>Secure use of mailcap
-<p>
+<sect2>
+<title>Secure use of mailcap</title>
+
+<para>
The interpretation of shell meta-characters embedded in MIME parameters
can lead to security problems in general. Mutt-ng tries to quote parameters
-in expansion of %s syntaxes properly, and avoids risky characters by
-substituting them, see the <ref id="mailcap_sanitize"
-name="mailcap_sanitize"> variable.
+in expansion of %s syntaxes properly, and avoids risky characters by
+substituting them, see the <link linkend="mailcap-sanitize">mailcap-sanitize</link> variable.
+</para>
+<para>
Although mutt's procedures to invoke programs with mailcap seem to be
safe, there are other applications parsing mailcap, maybe taking less care
of it. Therefore you should pay attention to the following rules:
+</para>
-<em/Keep the %-expandos away from shell quoting./
+<para>
+<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
with eval statements, and avoid them if possible at all. Trying to fix
broken behaviour with quotes introduces new leaks - there is no
alternative to correct quoting in the first place.
+</para>
-If you have to use the %-expandos' values in context where you need
+<para>
+If you have to use the %-expandos' values in context where you need
quoting or backtick expansions, put that value into a shell variable
and reference the shell variable where necessary, as in the following
-example (using <tt/$charset/ inside the backtick expansion is safe,
+example (using <literal>$charset</literal> inside the backtick expansion is safe,
since it is not itself subject to any further expansion):
+</para>
+
+<para>
-<tscreen><verb>
+<screen>
text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \
- && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1
-</verb></tscreen>
+ && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1
+</screen>
+
+</para>
+
+</sect2>
-<sect1>Advanced mailcap Usage
-<p>
+<sect2>
+<title>Advanced mailcap Usage</title>
-<sect2>Optional Fields
-<p>
+<sect3>
+<title>Optional Fields</title>
+
+<para>
In addition to the required content-type and view command fields, you
can add semi-colon ';' separated fields to set flags and other options.
Mutt-ng recognizes the following optional fields:
-<descrip>
-<tag/copiousoutput/
+<variablelist>
+
+<varlistentry>
+<term>copiousoutput</term>
+<listitem>
+<para>
This flag tells Mutt-ng that the command passes possibly large amounts of
text on stdout. This causes Mutt-ng to invoke a pager (either the internal
pager or the external pager defined by the pager variable) on the output
of the view command. Without this flag, Mutt-ng assumes that the command
-is interactive. One could use this to replace the pipe to <tt>more</tt>
-in the <tt>lynx -dump</tt> example in the Basic section:
-<tscreen><verb>
+is interactive. One could use this to replace the pipe to <literal>more</literal>
+in the <literal>lynx -dump</literal> example in the Basic section:
+
+<screen>
text/html; lynx -dump %s ; copiousoutput
-</verb></tscreen>
+</screen>
+
This will cause lynx to format the text/html output as text/plain
and Mutt-ng will use your standard pager to display the results.
-<tag/needsterminal/
-Mutt-ng uses this flag when viewing attachments with <ref id="auto_view"
-name="autoview">, in order to decide whether it should honor the setting
-of the <ref id="wait_key" name="$wait_key"> variable or
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>needsterminal</term>
+<listitem>
+<para>
+Mutt-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
not. When an attachment is viewed using an interactive program, and the
-corresponding mailcap entry has a <em/needsterminal/ flag, Mutt-ng will use
-<ref id="wait_key" name="$wait_key"> and the exit status
+corresponding mailcap entry has a <emphasis>needsterminal</emphasis> flag, Mutt-ng will use
+<link linkend="wait-key">wait-key</link> and the exit status
of the program to decide if it will ask you to press a key after the
external program has exited. In all other situations it will not prompt
you for a key.
-<tag>compose=<command></tag>
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>compose=<command></term>
+<listitem>
+<para>
This flag specifies the command to use to create a new attachment of a
specific MIME type. Mutt-ng supports this from the compose menu.
-<tag>composetyped=<command></tag>
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>composetyped=<command></term>
+<listitem>
+<para>
This flag specifies the command to use to create a new attachment of a
specific MIME type. This command differs from the compose command in
that mutt will expect standard MIME headers on the data. This can be
used to specify parameters, filename, description, etc. for a new
attachment. Mutt-ng supports this from the compose menu.
-<tag>print=<command></tag>
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>print=<command></term>
+<listitem>
+<para>
This flag specifies the command to use to print a specific MIME type.
Mutt-ng supports this from the attachment and compose menus.
-<tag>edit=<command></tag>
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>edit=<command></term>
+<listitem>
+<para>
This flag specifies the command to use to edit a specific MIME type.
Mutt-ng supports this from the compose menu, and also uses it to compose
new attachments. Mutt-ng will default to the defined editor for text
attachments.
-<tag>nametemplate=<template></tag>
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>nametemplate=<template></term>
+<listitem>
+<para>
This field specifies the format for the file denoted by %s in the
command fields. Certain programs will require a certain file extension,
for instance, to correctly view a file. For instance, lynx will only
-interpret a file as <tt>text/html</tt> if the file ends in <tt/.html/.
-So, you would specify lynx as a <tt>text/html</tt> viewer with a line in
+interpret a file as <literal>text/html</literal> if the file ends in <literal>.html</literal>.
+So, you would specify lynx as a <literal>text/html</literal> viewer with a line in
the mailcap file like:
-<tscreen><verb>
+
+<screen>
text/html; lynx %s; nametemplate=%s.html
-</verb></tscreen>
-<tag>test=<command></tag>
+</screen>
+
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>test=<command></term>
+<listitem>
+<para>
This field specifies a command to run to test whether this mailcap
entry should be used. The command is defined with the command expansion
rules defined in the next section. If the command returns 0, then the
test passed, and Mutt-ng uses this entry. If the command returns non-zero,
then the test failed, and Mutt-ng continues searching for the right entry.
-<bf/Note:/ <em>the content-type must match before Mutt-ng performs the test.</em>
+<emphasis role="bold">Note:</emphasis> <emphasis>the content-type must match before Mutt-ng performs the test.</emphasis>
For example:
-<tscreen><verb>
+
+<screen>
text/html; netscape -remote 'openURL(%s)' ; test=RunningX
text/html; lynx %s
-</verb></tscreen>
+</screen>
+
In this example, Mutt-ng will run the program RunningX which will return 0
if the X Window manager is running, and non-zero if it isn't. If
RunningX returns 0, then Mutt-ng will call netscape to display the
text/html object. If RunningX doesn't return 0, then Mutt-ng will go on
to the next entry and use lynx to display the text/html object.
-</descrip>
+</para>
+</listitem></varlistentry>
+</variablelist>
+</para>
+
+</sect3>
-<sect2>Search Order
-<p>
+<sect3>
+<title>Search Order</title>
+
+<para>
When searching for an entry in the mailcap file, Mutt-ng will search for
the most useful entry for its purpose. For instance, if you are
-attempting to print an <tt>image/gif</tt>, and you have the following
+attempting to print an <literal>image/gif</literal>, and you have the following
entries in your mailcap file, Mutt-ng will search for an entry with the
print command:
-<tscreen><verb>
+
+<screen>
image/*; xv %s
image/gif; ; print= anytopnm %s | pnmtops | lpr; \
nametemplate=%s.gif
-</verb></tscreen>
-Mutt-ng will skip the <tt>image/*</tt> entry and use the <tt>image/gif</tt>
+</screen>
+
+Mutt-ng will skip the <literal>image/*</literal> entry and use the <literal>image/gif</literal>
entry with the print command.
+</para>
-In addition, you can use this with <ref id="auto_view" name="Autoview">
+<para>
+In addition, you can use this with <link linkend="auto-view">auto-view</link>
to denote two commands for viewing an attachment, one to be viewed
automatically, the other to be viewed interactively from the attachment
menu. In addition, you can then use the test feature to determine which
viewer to use interactively depending on your environment.
-<tscreen><verb>
+
+<screen>
text/html; netscape -remote 'openURL(%s)' ; test=RunningX
text/html; lynx %s; nametemplate=%s.html
text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput
-</verb></tscreen>
-For <ref id="auto_view" name="Autoview">, Mutt-ng will choose the third
+</screen>
+
+For <link linkend="auto-view">auto-view</link>, Mutt-ng will choose the third
entry because of the copiousoutput tag. For interactive viewing, Mutt
will run the program RunningX to determine if it should use the first
entry. If the program returns non-zero, Mutt-ng will use the second entry
for interactive viewing.
+</para>
+
+</sect3>
-<sect2>Command Expansion
-<p>
+<sect3>
+<title>Command Expansion</title>
+
+<para>
The various commands defined in the mailcap files are passed to the
-<tt>/bin/sh</tt> shell using the system() function. Before the
-command is passed to <tt>/bin/sh -c</tt>, it is parsed to expand
+<literal>/bin/sh</literal> shell using the system() function. Before the
+command is passed to <literal>/bin/sh -c</literal>, it is parsed to expand
various special parameters with information from Mutt-ng. The keywords
Mutt-ng expands are:
-<descrip>
-<tag/%s/
+<variablelist>
+
+<varlistentry>
+<term>%s</term>
+<listitem>
+<para>
As seen in the basic mailcap section, this variable is expanded
to a filename specified by the calling program. This file contains
the body of the message to view/print/edit or where the composing
program should place the results of composition. In addition, the
use of this keyword causes Mutt-ng to not pass the body of the message
to the view/print/edit program on stdin.
-<tag/%t/
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>%t</term>
+<listitem>
+<para>
Mutt-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
-mailcap definition line, ie <tt>text/html</tt> or
-<tt>image/gif</tt>.
-<tag>%{<parameter>}</tag>
+mailcap definition line, ie <literal>text/html</literal> or
+<literal>image/gif</literal>.
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>%{<parameter>}</term>
+<listitem>
+<para>
Mutt-ng will expand this to the value of the specified parameter
from the Content-Type: line of the mail message. For instance, if
Your mail message contains:
-<tscreen><verb>
+
+<screen>
Content-Type: text/plain; charset=iso-8859-1
-</verb></tscreen>
-then Mutt-ng will expand %{charset} to iso-8859-1. The default metamail
+</screen>
+
+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
using the right charset to view the message.
-<tag>\%</tag>
+</para>
+</listitem></varlistentry>
+<varlistentry>
+<term>\%</term>
+<listitem>
+<para>
This will be replaced by a %
-</descrip>
+</para>
+</listitem></varlistentry>
+</variablelist>
Mutt-ng does not currently support the %F and %n keywords
specified in RFC 1524. The main purpose of these parameters is for
multipart messages, which is handled internally by Mutt-ng.
+</para>
+
+</sect3>
+
+</sect2>
-<sect1>Example mailcap files
-<p>
+<sect2>
+<title>Example mailcap files</title>
+
+<para>
This mailcap file is fairly simple and standard:
-<code>
+
+<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)'
-</code>
+</screen>
+</para>
+
+<para>
This mailcap file shows quite a number of examples:
+</para>
+
+<para>
-<code>
+<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
# Convert images to text using the netpbm tools
image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
-pbmtoascii -1x2 ) 2>&1 ; copiousoutput
+pbmtoascii -1x2 ) 2>&1 ; copiousoutput
# Send excel spreadsheets to my NT box
application/ms-excel; open.pl %s
-</code>
+</screen>
+
+</para>
+
+<para>
+
+</para>
+
+</sect2>
-<!--}}}-->
+</sect1>
-<sect>MIME Autoview<label id="auto_view"> <!--{{{-->
-<p>
+<sect1 id="auto-view">
+<title>MIME Autoview </title>
+
+<para>
In addition to explicitly telling Mutt-ng to view an attachment with the
MIME viewer defined in the mailcap file, Mutt-ng has support for
automatically viewing MIME attachments while in the pager.
+</para>
+<para>
To work, you must define a viewer in the mailcap file which uses the
-<tt/copiousoutput/ option to denote that it is non-interactive.
+<literal>copiousoutput</literal> option to denote that it is non-interactive.
Usually, you also use the entry to convert the attachment to a text
representation which you can view in the pager.
+</para>
-You then use the <tt/auto_view/ muttrc command to list the
+<para>
+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:
-<tscreen><verb>
+
+<screen>
auto_view text/html application/x-gunzip application/postscript image/gif application/x-tar-gz
-</verb></tscreen>
+</screen>
+</para>
+
+<para>
Mutt-ng could use the following mailcap entries to automatically view
attachments of these types.
-<tscreen><verb>
+
+<screen>
text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html
image/*; anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm | pgmtopbm | pbmtoascii ; copiousoutput
application/x-gunzip; gzcat; copiousoutput
application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
application/postscript; ps2ascii %s; copiousoutput
-</verb></tscreen>
+</screen>
-``unauto_view'' can be used to remove previous entries from the autoview list.
+</para>
+
+<para>
+``unauto_view'' can be used to remove previous entries from the autoview list.
This can be used with message-hook to autoview messages based on size, etc.
-``unauto_view *'' will remove all previous entries.
+``unauto_view *'' will remove all previous entries.
+</para>
+
+<para>
+
+</para>
+
+</sect1>
-<!--}}}-->
+<sect1 id="alternative-order">
+<title>MIME Multipart/Alternative </title>
-<sect>MIME Multipart/Alternative<label id="alternative_order"> <!--{{{-->
-<p>
+<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 types
is preferred. The alternative_order list consists of a number of
MIME types in order, including support for implicit and explicit
wildcards, for example:
-<tscreen><verb>
+
+<screen>
alternative_order text/enriched text/plain text application/postscript image/*
-</verb></tscreen>
+</screen>
+
+</para>
+<para>
Next, mutt will check if any of the types have a defined
-<ref id="auto_view" name="auto_view">, and use that. Failing
+<link linkend="auto-view">auto-view</link>, and use that. Failing
that, Mutt-ng will look for any text type. As a last attempt, mutt will
look 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.
+</para>
+
+<para>
+
+</para>
-To remove a MIME type from the <tt/alternative_order/ list, use the
-<tt/unalternative_order/ command.
+</sect1>
-<!--}}}-->
+<sect1 id="mime-lookup">
+<title>MIME Lookup </title>
-<sect>MIME Lookup<label id="mime_lookup"> <!--{{{-->
-<p>
+<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 to
deal with binary types such as application/octet-stream. When an attachment's
associated with this extension will then be used to process the attachment
according to the rules in the mailcap file and according to any other configuration
options (such as auto_view) specified. Common usage would be:
-<tscreen><verb>
+
+<screen>
mime_lookup application/octet-stream application/X-Lotus-Manuscript
-</verb></tscreen>
+</screen>
+</para>
+
+<para>
In addition, the unmime_lookup command may be used to disable this feature
for any particular mime-type if it had been set, for example, in a global
muttrc.
+</para>
-<!--}}}-->
-
-<!--}}}-->
-
-<chapt>Security Considerations <!--{{{-->
-
- <p>First of all, mutt-ng contains no security holes included by
- intention but may contain unknown security holes. As a consequence,
- please run mutt-ng only with as few permissions as possible.
-
- <p>Please do not run mutt-ng as the super user.
-
- <p>When configuring mutt-ng, there're some points to note about secure
- setups.
-
- <p>In practice, mutt-ng can be easily made as vulnerable as even the
- most insecure mail user agents (in their default configuration) just
- by changing mutt-ng's configuration files: it then can execute
- arbitrary programs and scripts attached to messages, send out private
- data on its own, etc. Although this is not believed to the common type
- of setup, please read this chapter carefully.
-
- <sect>Passwords <!--{{{-->
-
- <p>Although mutt-ng can be told the various passwords for accounts,
- please never store passwords in configuration files. Besides the
- fact that the system's operator can always read them, you could
- forget to replace the actual password with asterisks when reporting
- a bug or asking for help via, for example, a mailing list so that
- your mail including your password could be archived by internet
- search engines, etc. Please never store passwords on disk.
-
- <!--}}}-->
-
- <sect>Temporary Files <!--{{{-->
-
- <p>Mutt-ng uses many temporary files for viewing messages, verifying
- digital signatures, etc. The <ref id="umask" 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 <ref id="tmpdir" name="$tmpdir"> variable.
-
- <!--}}}-->
-
- <sect>Information Leaks <!--{{{-->
-
- <sect1>Message-ID: headers <!--{{{-->
-
- <p>In the default configuration, mutt-ng will leak some information
- to the outside world when sending messages: the generation of
- <tt/Message-ID:/ headers includes a step counter which 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 <tt/%P/ expando from the
- default setting of the <ref id="msgid_format"
- name="$msgid_format"> variable. Please make sure that
- you really know how local parts of these <tt/Message-ID:/ headers
- are composed.
-
- <!--}}}-->
+<para>
+
+</para>
- <sect1>mailto:-style links <!--{{{-->
+<para>
+
+</para>
+
+</sect1>
+
+</chapter>
+
+<chapter>
+<title>Security Considerations </title>
+
+<para>
+First of all, mutt-ng contains no security holes included by
+intention but may contain unknown security holes. As a consequence,
+please run mutt-ng only with as few permissions as possible.
+</para>
+
+<para>
+Please do not run mutt-ng as the super user.
+</para>
+
+<para>
+When configuring mutt-ng, there're some points to note about secure
+setups.
+</para>
+
+<para>
+In practice, mutt-ng can be easily made as vulnerable as even the
+most insecure mail user agents (in their default configuration) just
+by changing mutt-ng's configuration files: it then can execute
+arbitrary programs and scripts attached to messages, send out private
+data on its own, etc. Although this is not believed to the common type
+of setup, please read this chapter carefully.
+</para>
+
+<sect1>
+<title>Passwords </title>
+
+<para>
+Although mutt-ng can be told the various passwords for accounts,
+please never store passwords in configuration files. Besides the
+fact that the system's operator can always read them, you could
+forget to replace the actual password with asterisks when reporting
+a bug or asking for help via, for example, a mailing list so that
+your mail including your password could be archived by internet
+search engines, etc. Please never store passwords on disk.
+</para>
+
+</sect1>
+
+<sect1>
+<title>Temporary Files </title>
- <p>As mutt-ng be can be set up to be the mail client to handle
- <tt/mailto:/ style links in websites, there're security
- considerations, too. To keep the old behavior by default, mutt-ng
- 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 <ref id="edit_headers"
- name="$edit_headers"> variable is <em/unset/, i.e. the
- user doesn't want to see header fields while editing the message.
+<para>
+Mutt-ng uses many temporary files for viewing messages, verifying
+digital signatures, etc. The <link linkend="umask">umask</link>
+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.
+</para>
+
+</sect1>
+
+<sect1>
+<title>Information Leaks </title>
+
+<sect2>
+<title>Message-ID: headers </title>
+
+<para>
+In the default configuration, mutt-ng will leak some information
+to the outside world when sending messages: the generation of
+<literal>Message-ID:</literal> headers includes a step counter which 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> expando from the
+default setting of the <link linkend="msgid-format">msgid-format</link> 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>
+
+<para>
+As mutt-ng be can be set up to be the mail client to handle
+<literal>mailto:</literal> style links in websites, there're security
+considerations, too. To keep the old behavior by default, mutt-ng
+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> variable is <emphasis>unset</emphasis>, i.e. the
+user doesn't want to see header fields while editing the message.
+</para>
+
+<para>
+For example, following a link like
+</para>
+
+<para>
+
+<screen>
+mailto:joe@host?Attach=~/.gnupg/secring.gpg
+</screen>
+
+</para>
+
+<para>
+will send out the user's private gnupg keyring to <literal>joe@host</literal> if
+the user doesn't follow the information on screen carefully
+enough.
+</para>
+
+<para>
+When <emphasis>unsetting</emphasis> the <link linkend="strict-mailto">strict-mailto</link> variable, mutt-ng will
+</para>
+
+<para>
+
+<itemizedlist>
+<listitem>
+
+<para>
+be less strict when interpreting these links by
+prepending a <literal>X-Mailto-</literal> string to all header fields
+embedded in such a link <emphasis>and</emphasis>
+
+</para>
+</listitem>
+<listitem>
+
+<para>
+turn on the <link linkend="edit-headers">edit-headers</link> variable by
+force to let the user see all the headers
+(because they still may leak information.)
+
+</para>
+</listitem>
+
+</itemizedlist>
- <p>For example, following a link like
+</para>
- <verb>
-mailto:joe@host?Attach=~/.gnupg/secring.gpg</verb>
+</sect2>
- will send out the user's private gnupg keyring to <tt/joe@host/ if
- the user doesn't follow the information on screen carefully
- enough.
+</sect1>
- <p>When <em/unsetting/ the <ref id="strict_mailto"
- name="$strict_mailto"> variable, mutt-ng will
+<sect1>
+<title>External applications </title>
- <itemize>
+<para>
+Mutt-ng in many places has to rely on external applications or
+for convenience supports mechanisms involving external
+applications.
+</para>
- <item>be less strict when interpreting these links by
- prepending a <tt/X-Mailto-/ string to all header fields
- embedded in such a link <em/and/
+<sect2>
+<title>mailcap </title>
- <item>turn on the <ref id="edit_headers"
- name="$edit_headers"> variable by
- force to let the user see all the headers
- (because they still may leak information.)
+<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> execute any
+given utility as listed in one of the mailcap files (see the
+<link linkend="mailcap-path">mailcap-path</link>
+variable for details.)
+</para>
- </itemize>
+<para>
+These utilities may have a variety of security vulnerabilities,
+including overwriting of arbitrary files, information leaks or
+other exploitable bugs. These vulnerabilities may go unnoticed by
+the user, especially when they are called automatically (and
+without interactive prompting) from the mailcap file(s). When
+using mutt-ng's autoview mechanism in combination with mailcap
+files, please be sure to...
+</para>
- <!--}}}-->
+<para>
- <!--}}}-->
+<itemizedlist>
+<listitem>
- <sect>External applications <!--{{{-->
+<para>
+manually select trustworth applications with a reasonable
+calling sequence
- <p>Mutt-ng in many places has to rely on external applications or
- for convenience supports mechanisms involving external
- applications.
+</para>
+</listitem>
+<listitem>
- <sect1>mailcap <!--{{{-->
+<para>
+periodically check the contents of mailcap files,
+especially after software installations or upgrades
- <p>One of these is the <tt/mailcap/ mechanism as defined by RfC
- 1524. Mutt-ng can be set up to <em/automatically/ execute any
- given utility as listed in one of the mailcap files (see the
- <ref id="mailcap_path" name="$mailcap_path">
- variable for details.)
+</para>
+</listitem>
+<listitem>
- These utilities may have a variety of security vulnerabilities,
- including overwriting of arbitrary files, information leaks or
- other exploitable bugs. These vulnerabilities may go unnoticed by
- the user, especially when they are called automatically (and
- without interactive prompting) from the mailcap file(s). When
- using mutt-ng's autoview mechanism in combination with mailcap
- files, please be sure to...
+<para>
+keep the software packages referenced in the mailcap file up to date
- <itemize>
+</para>
+</listitem>
+<listitem>
- <item>manually select trustworth applications with a reasonable
- calling sequence
+<para>
+leave the <link linkend="mailcap-sanitize">mailcap-sanitize</link> variable in its default
+state to restrict mailcap expandos to a safe set of characters
- <item>periodically check the contents of mailcap files,
- especially after software installations or upgrades
+</para>
+</listitem>
- <item>keep the software packages referenced in the mailcap file up to date
+</itemizedlist>
- <item>leave the <ref id="mailcap_sanitize"
- name="$mailcap_sanitize"> variable in its default
- state to restrict mailcap expandos to a safe set of characters
+</para>
- </itemize>
+</sect2>
- <!--}}}-->
+<sect2>
+<title>Other </title>
- <sect1>Other <!--{{{-->
+<para>
+Besides the mailcap mechanism, mutt-ng uses a number of other
+external utilities for operation.
+</para>
- <p>Besides the mailcap mechanism, mutt-ng uses a number of other
- external utilities for operation.
+<para>
+The same security considerations apply for these as for tools
+involved via mailcap (for example, mutt-ng is vulnerable to Denial
+of Service Attacks with compressed folders support if the
+uncompressed mailbox is too large for the disk it is saved to.)
+</para>
- <p>The same security considerations apply for these as for tools
- involved via mailcap (for example, mutt-ng is vulnerable to Denial
- of Service Attacks with compressed folders support if the
- uncompressed mailbox is too large for the disk it is saved to.)
+<para>
+As already noted, most of these problems are not built in but
+caused by wrong configuration, so please check your configuration.
+</para>
- <p>As already noted, most of these problems are not built in but
- caused by wrong configuration, so please check your configuration.
+</sect2>
- <!--}}}-->
+</sect1>
- <!--}}}-->
+</chapter>
-<!--}}}-->
+<chapter>
+<title>Reference </title>
-<chapt>Reference <!--{{{-->
+<sect1 id="commandline">
+<title>Command line options </title>
-<sect>Command line options<label id="commandline"> <!--{{{-->
-<p>
-Running <tt/mutt/ with no arguments will make Mutt-ng attempt to read your spool
+<para>
+Running <literal>mutt</literal> with no arguments will make Mutt-ng attempt to read your spool
mailbox. However, it is possible to read other mailboxes and
to send messages from the command line as well.
+</para>
-<tscreen><verb>
+<para>
+
+<screen>
-A expand an alias
-a attach a file to a message
-b specify a blind carbon-copy (BCC) address
-y show a menu containing the files specified by the mailboxes command
-z exit immediately if there are no messages in the mailbox
-Z open the first folder with new message,exit immediately if none
-</verb></tscreen>
+</screen>
+
+</para>
+<para>
To read messages in a mailbox
+</para>
-<tt/mutt/ [ -nz ] [ -F <em/muttrc/ ] [ -m <em/type/ ] [ -f <em/mailbox/ ]
+<para>
+<literal>mutt</literal> [ -nz ] [ -F <emphasis>muttrc</emphasis> ] [ -m <emphasis>type</emphasis> ] [ -f <emphasis>mailbox</emphasis> ]
+</para>
+<para>
To compose a new message
+</para>
-<tt/mutt/ [ -n ] [ -F <em/muttrc/ ] [ -a <em/file/ ] [ -c <em/address/ ] [ -i <em/filename/ ] [ -s <em/subject/ ] <em/address/ [ <em/address/ ... ]
+<para>
+<literal>mutt</literal> [ -n ] [ -F <emphasis>muttrc</emphasis> ] [ -a <emphasis>file</emphasis> ] [ -c <emphasis>address</emphasis> ] [ -i <emphasis>filename</emphasis> ] [ -s <emphasis>subject</emphasis> ] <emphasis>address</emphasis> [ <emphasis>address</emphasis> ... ]
+</para>
+<para>
Mutt-ng also supports a ``batch'' mode to send prepared messages. Simply redirect
input from the file you wish to send. For example,
+</para>
-<tt>mutt -s &dquot;data set for run #2&dquot; professor@bigschool.edu
-< ˜/run2.dat</tt>
+<para>
+<literal>mutt -s "data set for run #2" professor@bigschool.edu
+< ˜/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 contents
of the file ``˜/run2.dat''.
+</para>
-<!--}}}-->
+<para>
+
+</para>
+
+</sect1>
-<sect>Patterns<label id="patterns"> <!--{{{-->
+<sect1 id="patterns">
+<title>Patterns </title>
-<p>
-<tscreen><verb>
+<para>
+
+<screen>
~A all messages
~b EXPR messages which contain EXPR in the message body
~B EXPR messages which contain EXPR in the whole message
~* ``From'' contains realname and (syntactically) valid
address (excluded are addresses matching against
alternates or any alias)
-</verb></tscreen>
+</screen>
+
+</para>
+<para>
Where EXPR, USER, ID, and SUBJECT are
-<ref id="regexp" name="regular expressions">. Special attention has to be
+<link linkend="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 (\),
which is normally used for quoting. If it is your intention to use a
backslash in the regular expression, you will need to use two backslashes
instead (\\).
+</para>
-*) The forms <tt/<[MAX]/, <tt/>[MIN]/,
-<tt/[MIN]-/ and <tt/-[MAX]/
+<para>
+*) The forms <literal><[MAX]</literal>, <literal>>[MIN]</literal>,
+<literal>[MIN]-</literal> and <literal>-[MAX]</literal>
are allowed, too.
+</para>
-<!--}}}-->
+<para>
+
+</para>
-<sect>Configuration Commands<label id="commands"> <!--{{{-->
-<p>
-The following are the commands understood by mutt.
+</sect1>
-<itemize>
-<item>
-<tt><ref id="account-hook" name="account-hook"></tt> <em/pattern/ <em/command/
-<item>
-<tt><ref id="alias" name="alias"></tt> <em/key/ <em/address/ [ , <em/address/, ... ]
-<item>
-<tt><ref id="alias" name="unalias"></tt> [ * | <em/key/ ... ]
-<item>
-<tt><ref id="alternates" name="alternates"></tt> <em/regexp/ [ <em/regexp/ ... ]
-<item>
-<tt><ref id="alternates" name="unalternates"></tt> [ * | <em/regexp/ ... ]
-<item>
-<tt><ref id="alternative_order" name="alternative_order"></tt> <em/mimetype/ [ <em/mimetype/ ... ]
-<item>
-<tt><ref id="alternative_order" name="unalternative_order"></tt> <em/mimetype/ [ <em/mimetype/ ... ]
-<item>
-<tt><ref id="append-hook" name="append-hook"></tt> <em/regexp/ <em/command/
-<item>
-<tt><ref id="auto_view" name="auto_view"></tt> <em/mimetype/ [ <em/mimetype/ ... ]
-<item>
-<tt><ref id="auto_view" name="unauto_view"></tt> <em/mimetype/ [ <em/mimetype/ ... ]
-<item>
-<tt><ref id="bind" name="bind"></tt> <em/map/ <em/key/ <em/function/
-<item>
-<tt><ref id="charset-hook" name="charset-hook"></tt> <em/alias/ <em/charset/
-<item>
-<tt><ref id="close-hook" name="close-hook"></tt> <em/regexp/ <em/command/
-<item>
-<tt><ref id="color" name="color"></tt> <em/object/ <em/foreground/ <em/background/ [ <em/regexp/ ]
-<item>
-<tt><ref id="color" name="uncolor"></tt> <em/index/ <em/pattern/ [ <em/pattern/ ... ]
-<item>
-<tt><ref id="exec" name="exec"></tt> <em/function/ [ <em/function/ ... ]
-<item>
-<tt><ref id="fcc-hook" name="fcc-hook"></tt> <em/pattern/ <em/mailbox/
-<item>
-<tt><ref id="fcc-save-hook" name="fcc-save-hook"></tt> <em/pattern/ <em/mailbox/
-<item>
-<tt><ref id="folder-hook" name="folder-hook"></tt> <em/pattern/ <em/command/
-<item>
-<tt><ref id="hdr_order" name="hdr_order"></tt> <em/header/ [ <em/header/ ... ]
-<item>
-<tt><ref id="hdr_order" name="unhdr_order"></tt> <em/header/ [ <em/header/ ... ]
-<item>
-<tt><ref id="charset-hook" name="iconv-hook"></tt> <em/charset/ <em/local-charset/
-<item>
-<tt><ref id="ignore" name="ignore"></tt> <em/pattern/ [ <em/pattern/ ... ]
-<item>
-<tt><ref id="ignore" name="unignore"></tt> <em/pattern/ [ <em/pattern/ ... ]
-<item>
-<tt><ref id="lists" name="lists"></tt> <em/regexp/ [ <em/regexp/ ... ]
-<item>
-<tt><ref id="lists" name="unlists"></tt> <em/regexp/ [ <em/regexp/ ... ]
-<item>
-<tt><ref id="macro" name="macro"></tt> <em/menu/ <em/key/ <em/sequence/ [ <em/description/ ]
-<item>
-<tt><ref id="mailboxes" name="mailboxes"></tt> <em/filename/ [ <em/filename/ ... ]
-<item>
-<tt><ref id="mbox-hook" name="mbox-hook"></tt> <em/pattern/ <em/mailbox/
-<item>
-<tt><ref id="message-hook" name="message-hook"></tt> <em/pattern/ <em/command/
-<item>
-<tt><ref id="mime_lookup" name="mime_lookup"></tt> <em/mimetype/ [ <em/mimetype/ ... ]
-<item>
-<tt><ref id="mime_lookup" name="unmime_lookup"></tt> <em/mimetype/ [ <em/mimetype/ ... ]
-<item>
-<tt><ref id="color" name="mono"></tt> <em/object attribute/ [ <em/regexp/ ]
-<item>
-<tt><ref id="color" name="unmono"></tt> <em/index/ <em/pattern/ [ <em/pattern/ ... ]
-<item>
-<tt><ref id="my_hdr" name="my_hdr"></tt> <em/string/
-<item>
-<tt><ref id="my_hdr" name="unmy_hdr"></tt> <em/field/ [ <em/field/ ... ]
-<item>
-<tt><ref id="open-hook" name="open-hook"></tt> <em/regexp/ <em/command/
-<item>
-<tt><ref id="crypt-hook" name="crypt-hook"></tt> <em/pattern/ <em/key-id/
-<item>
-<tt><ref id="push" name="push"></tt> <em/string/
-<item>
-<tt><ref id="set" name="reset"></tt> <em/variable/ [<em/variable/ ... ]
-<item>
-<tt><ref id="save-hook" name="save-hook"></tt> <em/regexp/ <em/filename/
-<item>
-<tt><ref id="score-command" name="score"></tt> <em/pattern/ <em/value/
-<item>
-<tt><ref id="score-command" name="unscore"></tt> <em/pattern/ [ <em/pattern/ ... ]
-<item>
-<tt><ref id="send-hook" name="send-hook"></tt> <em/regexp/ <em/command/
-<item>
-<tt><ref id="reply-hook" name="reply-hook"></tt> <em/regexp/ <em/command/
-<item>
-<tt><ref id="set" name="set"></tt> [no|inv]<em/variable/[=<em/value/] [ <em/variable/ ... ]
-<item>
-<tt><ref id="set" name="unset"></tt> <em/variable/ [<em/variable/ ... ]
-<item>
-<tt><ref id="source" name="source"></tt> <em/filename/
-<item>
-<tt><ref id="spam" name="spam"></tt> <em/pattern/ <em/format/
-<item>
-<tt><ref id="spam" name="nospam"></tt> <em/pattern/
-<item>
-<tt><ref id="lists" name="subscribe"></tt> <em/regexp/ [ <em/regexp/ ... ]
-<item>
-<tt><ref id="lists" name="unsubscribe"></tt> <em/regexp/ [ <em/regexp/ ... ]
-<item>
-<tt><ref id="set" name="toggle"></tt> <em/variable/ [<em/variable/ ... ]
-<item>
-<tt><ref id="unhook" name="unhook"></tt> <em/hook-type/
-</itemize>
-
-<sect>Configuration variables<label id="variables">
-
-<p>The following list contains all variables which, in the process of
+<sect1 id="commands">
+<title>Configuration Commands </title>
+
+<para>
+The following are the commands understood by mutt.
+</para>
+
+<para>
+
+<itemizedlist>
+<listitem>
+
+<para>
+<literal><link linkend="account-hook">account-hook</link></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>, ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="alias">alias</link></literal> [ * | <emphasis>key</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="alternates">alternates</link></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="alternates">alternates</link></literal> [ * | <emphasis>regexp</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="alternative-order">alternative-order</link></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> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="append-hook">append-hook</link></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> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="auto-view">auto-view</link></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>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="charset-hook">charset-hook</link></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>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="color">color</link></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> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="exec">exec</link></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>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="fcc-save-hook">fcc-save-hook</link></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>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="hdr-order">hdr-order</link></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> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="charset-hook">charset-hook</link></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> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="ignore">ignore</link></literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="lists">lists</link></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="lists">lists</link></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> ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="mailboxes">mailboxes</link></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>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="message-hook">message-hook</link></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> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="mime-lookup">mime-lookup</link></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> ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="color">color</link></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>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="my-hdr">my-hdr</link></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>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="crypt-hook">crypt-hook</link></literal> <emphasis>pattern</emphasis> <emphasis>key-id</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="push">push</link></literal> <emphasis>string</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="set">set</link></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>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="score-command">score-command</link></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> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="send-hook">send-hook</link></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>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="set">set</link></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> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="source">source</link></literal> <emphasis>filename</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="spam">spam</link></literal> <emphasis>pattern</emphasis> <emphasis>format</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="spam">spam</link></literal> <emphasis>pattern</emphasis>
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="lists">lists</link></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="lists">lists</link></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="set">set</link></literal> <emphasis>variable</emphasis> [<emphasis>variable</emphasis> ... ]
+</para>
+</listitem>
+<listitem>
+
+<para>
+<literal><link linkend="unhook">unhook</link></literal> <emphasis>hook-type</emphasis>
+</para>
+</listitem>
+
+</itemizedlist>
+
+</para>
+
+</sect1>
+
+<sect1 id="variables">
+<title>Configuration variables</title>
+
+<para>
+The following list contains all variables which, in the process of
providing more consistency, have been renamed and are partially even
removed already. The left column contains the old synonym variables,
the right column the full/new name:
+</para>
-<label id="sect_obsolete">
-<tscreen><verb>
+<para>
+<anchor id="sect-obsolete"/>
+
+<screen>
edit_hdrs edit_headers
forw_decode forward_decode
forw_format forward_format
x_comment_to nntp_x_comment_to
smtp_auth_username smtp_user
smtp_auth_password smtp_pass
-</verb></tscreen>
-
-The <tt/contrib/ subdirectory contains a script named
-<tt/update-config.pl/ which eases migration.
+</screen>
-A complete list of current variables follows.
+</para>
-<p>
+<para>
+The <literal>contrib</literal> subdirectory contains a script named
+<literal>update-config.pl</literal> which eases migration.
+</para>
+<para>
+A complete list of current variables follows.
+</para>
- T\bTh\bhe\be M\bMu\but\btt\bt N\bNe\bex\bxt\bt G\bGe\ben\bne\ber\bra\bat\bti\bio\bon\bn E\bE-\b-M\bMa\bai\bil\bl C\bCl\bli\bie\ben\bnt\bt
+The Mutt Next Generation E-Mail Client
+
+by Andreas Krennmair and others originally based on mutt by Michael Elkins and others
+
+ version devel-r473
+
+ Abstract
+
+ Michael Elinks on mutt, circa 1995: ``All mail clients suck. This one just sucks less.'' - Sven Guckes on mutt, ca. 2003: ``But it still sucks!''
+ _________________________________________________________________
+
+ Table of Contents
+
+ 1. Introduction
+
+ 1. Overview
+ 2. Mutt-ng Home Page
+ 3. Mailing Lists
+ 4. Software Distribution Sites
+ 5. IRC
+ 6. Weblog
+ 7. Copyright
+
+ 2. Getting Started
+
+ 1. Basic Concepts
+
+ 1.1. Screens and Menus
+ 1.2. Configuration
+ 1.3. Functions
+ 1.4. Interaction
+ 1.5. Modularization
+ 1.6. Patterns
+
+ 2. Screens and Menus
+
+ 2.1. Index
+ 2.2. Pager
+ 2.3. File Browser
+ 2.4. Sidebar
+ 2.5. Help
+ 2.6. Compose Menu
+ 2.7. Alias Menu
+ 2.8. Attachment Menu
+ 2.9. Key Menu
+
+ 3. Moving Around in Menus
+ 4. Editing Input Fields
+ 5. Reading Mail - The Index and Pager
+
+ 5.1. The Message Index
+ 5.2. The Pager
+ 5.3. Threaded Mode
+ 5.4. Miscellaneous Functions
+
+ 6. Sending Mail
+
+ 6.1. Composing new messages
+ 6.2. Replying
+ 6.3. Editing the message header
+ 6.4. Using Mutt-ng with PGP
+ 6.5. Sending anonymous messages via mixmaster
+
+ 7. Forwarding and Bouncing Mail
+ 8. Postponing Mail
+
+ 3. Configuration
+
+ 1. Locations of Configuration Files
+ 2. Basic Syntax of Initialization Files
+ 3. Expansion within variables
+
+ 3.1. Commands' Output
+ 3.2. Environment Variables
+ 3.3. Configuration Variables
+ 3.4. Self-Defined Variables
+ 3.5. Pre-Defined Variables
+ 3.6. Type Conversions
- by Andreas Krennmair <ak@synflood.at> and others
- originally based on _\bm_\bu_\bt_\bt by Michael Elkins <me@cs.hmc.edu> and others
+ 4. Defining/Using aliases
+ 5. Changing the default key bindings
+ 6. Defining aliases for character sets
+ 7. Setting variables based upon mailbox
+ 8. Keyboard macros
+ 9. Using color and mono video attributes
+ 10. Ignoring (weeding) unwanted message headers
+ 11. Alternative addresses
+ 12. Format = Flowed
+
+ 12.1. Introduction
+ 12.2. Receiving: Display Setup
+ 12.3. Sending
+ 12.4. Additional Notes
- version devel-r471
+ 13. Mailing lists
+ 14. Using Multiple spool mailboxes
+ 15. Defining mailboxes which receive mail
+ 16. User defined headers
+ 17. Defining the order of headers when viewing messages
+ 18. Specify default save filename
+ 19. Specify default Fcc: mailbox when composing
+ 20. Specify default save filename and default Fcc: mailbox at once
+ 21. Change settings based upon message recipients
+ 22. Change settings before formatting a message
+ 23. Choosing the cryptographic key of the recipient
+ 24. Adding key sequences to the keyboard buffer
+ 25. Executing functions
+ 26. Message Scoring
+ 27. Spam detection
+ 28. Setting variables
+ 29. Reading initialization commands from another file
+ 30. Removing hooks
+ 31. Sharing Setups
+
+ 31.1. Character Sets
+ 31.2. Modularization
+ 31.3. Conditional parts
+
+ 32. Obsolete Variables
+
+ 4. Advanced Usage
+
+ 1. Regular Expressions
+ 2. Patterns
+
+ 2.1. Complex Patterns
+ 2.2. Patterns and Dates
+
+ 3. Format Strings
+
+ 3.1. Introduction
+ 3.2. Conditional Expansion
+ 3.3. Modifications and Padding
+
+ 4. Using Tags
+ 5. Using Hooks
+
+ 5.1. Message Matching in Hooks
+
+ 6. Using the sidebar
+ 7. External Address Queries
+ 8. Mailbox Formats
+ 9. Mailbox Shortcuts
+ 10. Handling Mailing Lists
+ 11. Editing threads
- A\bAb\bbs\bst\btr\bra\bac\bct\bt
+ 11.1. Linking threads
+ 11.2. Breaking threads
- Michael Elinks on mutt, circa 1995: ``All mail clients suck. This one just
- sucks less.'' - Sven Guckes on mutt, ca. 2003: ``But it still sucks!''
+ 12. Delivery Status Notification (DSN) Support
+ 13. POP3 Support (OPTIONAL)
+ 14. IMAP Support (OPTIONAL)
- _\b1_\b. _\bI_\bn_\bt_\br_\bo_\bd_\bu_\bc_\bt_\bi_\bo_\bn
+ 14.1. The Folder Browser
+ 14.2. Authentication
- _\b1_\b._\b1 _\bO_\bv_\be_\br_\bv_\bi_\be_\bw
+ 15. NNTP Support (OPTIONAL)
- M\bMu\but\btt\bt-\b-n\bng\bg is a small but very powerful text-based MIME mail client. Mutt-ng is
- highly configurable, and is well suited to the mail power user with advanced
- features like key bindings, keyboard macros, mail threading, regular expression
- searches and a powerful pattern matching language for selecting groups of mes-
- sages.
+ 15.1. Again: Scoring
- This documentation additionally contains documentation to M\bMu\but\btt\bt-\b-N\bNG\bG, a fork from
- Mutt with the goal to fix all the little annoyances of Mutt, to integrate all
- the Mutt patches that are floating around in the web, and to add other new fea-
- tures. Features specific to Mutt-ng will be discussed in an extra section.
- Don't be confused when most of the documentation talk about Mutt and not Mutt-
- ng, Mutt-ng contains all Mutt features, plus many more.
+ 16. SMTP Support (OPTIONAL)
+ 17. Managing multiple IMAP/POP/NNTP accounts (OPTIONAL)
+ 18. Start a WWW Browser on URLs (EXTERNAL)
+ 19. Compressed folders Support (OPTIONAL)
- _\b1_\b._\b2 _\bM_\bu_\bt_\bt_\b-_\bn_\bg _\bH_\bo_\bm_\be _\bP_\ba_\bg_\be
+ 19.1. Open a compressed mailbox for reading
+ 19.2. Write a compressed mailbox
+ 19.3. Append a message to a compressed mailbox
+ 19.4. Encrypted folders
- http://www.muttng.org
+ 5. Mutt-ng's MIME Support
- _\b1_\b._\b3 _\bM_\ba_\bi_\bl_\bi_\bn_\bg _\bL_\bi_\bs_\bt_\bs
+ 1. Using MIME in Mutt
- +\bo mutt-ng-users@lists.berlios.de -- This is where the mutt-ng user support
- happens.
+ 1.1. Viewing MIME messages in the pager
+ 1.2. The Attachment Menu
+ 1.3. The Compose Menu
- The Mutt Next Generation E-Mail Client 1
+ 2. MIME Type configuration with mime.types
+ 3. MIME Viewer configuration with mailcap
- The Mutt Next Generation E-Mail Client 2
+ 3.1. The Basics of the mailcap file
+ 3.2. Secure use of mailcap
+ 3.3. Advanced mailcap Usage
+ 3.4. Example mailcap files
- +\bo mutt-ng-devel@lists.berlios.de -- The development mailing list for mutt-ng
+ 4. MIME Autoview
+ 5. MIME Multipart/Alternative
+ 6. MIME Lookup
- _\b1_\b._\b4 _\bS_\bo_\bf_\bt_\bw_\ba_\br_\be _\bD_\bi_\bs_\bt_\br_\bi_\bb_\bu_\bt_\bi_\bo_\bn _\bS_\bi_\bt_\be_\bs
+ 6. Security Considerations
- So far, there are no official releases of Mutt-ng, but you can download daily
- snapshots from http://mutt-ng.berlios.de/snapshots/
+ 1. Passwords
+ 2. Temporary Files
+ 3. Information Leaks
- _\b1_\b._\b5 _\bI_\bR_\bC
+ 3.1. Message-ID: headers
+ 3.2. mailto:-style links
- Visit channel _\b#_\bm_\bu_\bt_\bt_\bn_\bg on irc.freenode.net (www.freenode.net) to chat with other
- people interested in Mutt-ng.
+ 4. External applications
- _\b1_\b._\b6 _\bW_\be_\bb_\bl_\bo_\bg
+ 4.1. mailcap
+ 4.2. Other
- If you want to read fresh news about the latest development in Mutt-ng, and get
- informed about stuff like interesting, Mutt-ng-related articles and packages
- for your favorite distribution, you can read and/or subscribe to our Mutt-ng
- development weblog.
+ 7. Reference
- _\b1_\b._\b7 _\bC_\bo_\bp_\by_\br_\bi_\bg_\bh_\bt
+ 1. Command line options
+ 2. Patterns
+ 3. Configuration Commands
+ 4. Configuration variables
+ 5. Functions
- Mutt is Copyright (C) 1996-2000 Michael R. Elkins <me@cs.hmc.edu> and others
+ 5.1. generic
+ 5.2. index
+ 5.3. pager
+ 5.4. alias
+ 5.5. query
+ 5.6. attach
+ 5.7. compose
+ 5.8. postpone
+ 5.9. browser
+ 5.10. pgp
+ 5.11. editor
- This program is free software; you can redistribute it and/or modify it under
- the terms of the GNU General Public License as published by the Free Software
- Foundation; either version 2 of the License, or (at your option) any later ver-
- sion.
+ 8. Miscellany
- This program is distributed in the hope that it will be useful, but WITHOUT ANY
- WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
- PARTICULAR PURPOSE. See the GNU General Public License for more details.
+ 1. Acknowledgments
- 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.
+Chapter 1. Introduction
- _\b2_\b. _\bG_\be_\bt_\bt_\bi_\bn_\bg _\bS_\bt_\ba_\br_\bt_\be_\bd
+ Table of Contents
- _\b2_\b._\b1 _\bB_\ba_\bs_\bi_\bc _\bC_\bo_\bn_\bc_\be_\bp_\bt_\bs
+ 1. Overview
+ 2. Mutt-ng Home Page
+ 3. Mailing Lists
+ 4. Software Distribution Sites
+ 5. IRC
+ 6. Weblog
+ 7. Copyright
- The Mutt Next Generation E-Mail Client 3
+1. Overview
- _\b2_\b._\b1_\b._\b1 _\bS_\bc_\br_\be_\be_\bn_\bs _\ba_\bn_\bd _\bM_\be_\bn_\bu_\bs
+ Mutt-ng is a small but very powerful text-based MIME mail client. Mutt-ng is highly configurable, and is well suited to the mail power user with advanced features like key bindings, keyboard macros, mail threading, regular expression searches and a powerful pattern matching language for selecting groups of messages.
- mutt-ng offers different screens of which every has its special purpose:
+ This documentation additionally contains documentation to Mutt-NG, a fork from Mutt with the goal to fix all the little annoyances of Mutt, to integrate all the Mutt patches that are floating around in the web, and to add other new features. Features specific to Mutt-ng will be discussed in an extra section. Don't be confused when most of the documentation talk about Mutt and not Mutt-ng, Mutt-ng contains all Mutt features, plus many more.
- +\bo The _\bi_\bn_\bd_\be_\bx displays the contents of the currently opened mailbox.
+2. Mutt-ng Home Page
- +\bo The _\bp_\ba_\bg_\be_\br is responsible for displaying messages, that is, the header, the
- body and all attached parts.
+ http://www.muttng.org
- +\bo The _\bf_\bi_\bl_\be _\bb_\br_\bo_\bw_\bs_\be_\br offers operations on and displays information of all
- folders mutt-ng should watch for mail.
+3. Mailing Lists
- +\bo The _\bs_\bi_\bd_\be_\bb_\ba_\br offers a permanent view of which mailboxes contain how many
- total, new and/or flagged mails.
+ * mutt-ng-users@lists.berlios.de -- This is where the mutt-ng user support happens.
+ * mutt-ng-devel@lists.berlios.de -- The development mailing list for mutt-ng
- +\bo The _\bh_\be_\bl_\bp _\bs_\bc_\br_\be_\be_\bn lists for all currently available commands how to invoke
- them as well as a short description.
+4. Software Distribution Sites
- +\bo The _\bc_\bo_\bm_\bp_\bo_\bs_\be menu is a comfortable interface take last actions before send-
- ing mail: change subjects, attach files, remove attachements, etc.
+ So far, there are no official releases of Mutt-ng, but you can download daily snapshots from http://mutt-ng.berlios.de/snapshots/
- +\bo The _\ba_\bt_\bt_\ba_\bc_\bh_\be_\bm_\be_\bn_\bt menu gives a summary and the tree structure of the
- attachements of the current message.
+5. IRC
- +\bo The _\ba_\bl_\bi_\ba_\bs menu lists all or a fraction of the aliases a user has defined.
+ Visit channel #muttng on irc.freenode.net (www.freenode.net) to chat with other people interested in Mutt-ng.
- +\bo The _\bk_\be_\by menu used in connection with encryption lets users choose the
- right key to encrypt with.
+6. Weblog
- When mutt-ng is started without any further options, it'll open the users
- default mailbox and display the index.
+ If you want to read fresh news about the latest development in Mutt-ng, and get informed about stuff like interesting, Mutt-ng-related articles and packages for your favorite distribution, you can read and/or subscribe to our Mutt-ng development weblog.
- _\b2_\b._\b1_\b._\b2 _\bC_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn
+7. Copyright
- Mutt-ng does _\bn_\bo_\bt feature an internal configuration interface or menu due to the
- simple fact that this would be too complex to handle (currently there are sev-
- eral _\bh_\bu_\bn_\bd_\br_\be_\bd variables which fine-tune the behaviour.)
+ Mutt is Copyright (C) 1996-2000 Michael R. Elkins <me@cs.hmc.edu> and others
- Mutt-ng is configured using configuration files which allow users to add com-
- ments or manage them via version control systems to ease maintenance.
+ This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
- Also, mutt-ng comes with a shell script named grml-muttng kindly contributed by
- users which really helps and eases the creation of a user's configuration file.
- When downloading the source code via a snapshot or via subversion, it can be
- found in the contrib directory.
+ This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
- _\b2_\b._\b1_\b._\b3 _\bF_\bu_\bn_\bc_\bt_\bi_\bo_\bn_\bs
+ 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.
- Mutt-ng offers great flexibility due to the use of functions: internally, every
- action a user can make mutt-ng perform is named ``function.'' Those functions
+Chapter 2. Getting Started
- The Mutt Next Generation E-Mail Client 4
+ Table of Contents
- are assigned to keys (or even key sequences) and may be completely adjusted to
- user's needs. The basic idea is that the impatient users get a very intuitive
- interface to start off with and advanced users virtually get no limits to
- adjustments.
+ 1. Basic Concepts
- _\b2_\b._\b1_\b._\b4 _\bI_\bn_\bt_\be_\br_\ba_\bc_\bt_\bi_\bo_\bn
+ 1.1. Screens and Menus
+ 1.2. Configuration
+ 1.3. Functions
+ 1.4. Interaction
+ 1.5. Modularization
+ 1.6. Patterns
- Mutt-ng has two basic concepts of user interaction:
+ 2. Screens and Menus
- 1. There is one dedicated line on the screen used to query the user for
- input, issue any command, query variables and display error and informa-
- tional messages. As for every type of user input, this requires manual
- action leading to the need of input.
+ 2.1. Index
+ 2.2. Pager
+ 2.3. File Browser
+ 2.4. Sidebar
+ 2.5. Help
+ 2.6. Compose Menu
+ 2.7. Alias Menu
+ 2.8. Attachment Menu
+ 2.9. Key Menu
- 2. The automatized interface for interaction are the so called _\bh_\bo_\bo_\bk_\bs. Hooks
- specify actions the user wants to be performed at well-defined situa-
- tions: what to do when entering which folder, what to do when displaying
- or replying to what kind of message, etc. These are optional, i.e. a user
- doesn't need to specify them but can do so.
+ 3. Moving Around in Menus
+ 4. Editing Input Fields
+ 5. Reading Mail - The Index and Pager
- _\b2_\b._\b1_\b._\b5 _\bM_\bo_\bd_\bu_\bl_\ba_\br_\bi_\bz_\ba_\bt_\bi_\bo_\bn
+ 5.1. The Message Index
+ 5.2. The Pager
+ 5.3. Threaded Mode
+ 5.4. Miscellaneous Functions
- Although mutt-ng has many functionality built-in, many features can be dele-
- gated to external tools to increase flexibility: users can define programs to
- filter a message through before displaying, users can use any program they want
- for displaying a message, message types (such as PDF or PostScript) for which
- mutt-ng doesn't have a built-in filter can be rendered by arbitrary tools and
- so forth. Although mutt-ng has an alias mechanism built-in, it features using
- external tools to query for nearly every type of addresses from sources like
- LDAP, databases or just the list of locally known users.
+ 6. Sending Mail
- _\b2_\b._\b1_\b._\b6 _\bP_\ba_\bt_\bt_\be_\br_\bn_\bs
+ 6.1. Composing new messages
+ 6.2. Replying
+ 6.3. Editing the message header
+ 6.4. Using Mutt-ng with PGP
+ 6.5. Sending anonymous messages via mixmaster
- Mutt-ng has a built-in pattern matching ``language'' which is as widely used as
- possible to present a consistent interface to users. The same ``pattern terms''
- can be used for searching, scoring, message selection and much more.
+ 7. Forwarding and Bouncing Mail
+ 8. Postponing Mail
- _\b2_\b._\b2 _\bS_\bc_\br_\be_\be_\bn_\bs _\ba_\bn_\bd _\bM_\be_\bn_\bu_\bs
+1. Basic Concepts
- _\b2_\b._\b2_\b._\b1 _\bI_\bn_\bd_\be_\bx
+1.1. Screens and Menus
- The index is the screen that you usually see first when you start mutt-ng. It
- gives an overview over your emails in the currently opened mailbox. By default,
- this is your system mailbox. The information you see in the index is a list of
+ mutt-ng offers different screens of which every has its special purpose:
+ * The index displays the contents of the currently opened mailbox.
+ * The pager is responsible for displaying messages, that is, the header, the body and all attached parts.
+ * The file browser offers operations on and displays information of all folders mutt-ng should watch for mail.
+ * The sidebar offers a permanent view of which mailboxes contain how many total, new and/or flagged mails.
+ * The help screen lists for all currently available commands how to invoke them as well as a short description.
+ * The compose menu is a comfortable interface take last actions before sending mail: change subjects, attach files, remove attachements, etc.
+ * The attachement menu gives a summary and the tree structure of the attachements of the current message.
+ * The alias menu lists all or a fraction of the aliases a user has defined.
+ * The key menu used in connection with encryption lets users choose the right key to encrypt with.
- The Mutt Next Generation E-Mail Client 5
+ When mutt-ng is started without any further options, it'll open the users default mailbox and display the index.
- emails, each with its number on the left, its flags (new email, important
- email, email that has been forwarded or replied to, tagged email, ...), the
- date when email was sent, its sender, the email size, and the subject. Addi-
- tionally, the index also shows thread hierarchies: when you reply to an email,
- and the other person replies back, you can see the other's person email in a
- "sub-tree" below. This is especially useful for personal email between a group
- of people or when you've subscribed to mailing lists.
+1.2. Configuration
- _\b2_\b._\b2_\b._\b2 _\bP_\ba_\bg_\be_\br
+ Mutt-ng does not feature an internal configuration interface or menu due to the simple fact that this would be too complex to handle (currently there are several hundred variables which fine-tune the behaviour.)
- The pager is responsible for showing the email content. On the top of the pager
- you have an overview over the most important email headers like the sender, the
- recipient, the subject, and much more information. How much information you
- actually see depends on your configuration, which we'll describe below.
+ Mutt-ng is configured using configuration files which allow users to add comments or manage them via version control systems to ease maintenance.
- Below the headers, you see the email body which usually contains the message.
- If the email contains any attachments, you will see more information about them
- below the email body, or, if the attachments are text files, you can view them
- directly in the pager.
+ Also, mutt-ng comes with a shell script named grml-muttng kindly contributed by users which really helps and eases the creation of a user's configuration file. When downloading the source code via a snapshot or via subversion, it can be found in the contrib directory.
- To give the user a good overview, it is possible to configure mutt-ng to show
- different things in the pager with different colors. Virtually everything that
- can be described with a regular expression can be colored, e.g. URLs, email
- addresses or smileys.
+1.3. Functions
- _\b2_\b._\b2_\b._\b3 _\bF_\bi_\bl_\be _\bB_\br_\bo_\bw_\bs_\be_\br
+ Mutt-ng offers great flexibility due to the use of functions: internally, every action a user can make mutt-ng perform is named ``function.'' Those functions are assigned to keys (or even key sequences) and may be completely adjusted to user's needs. The basic idea is that the impatient users get a very intuitive interface to start off with and advanced users virtually get no limits to adjustments.
- The file browser is the interface to the local or remote file system. When
- selecting a mailbox to open, the browser allows custom sorting of items, limit-
- ing the items shown by a regular expression and a freely adjustable format of
- what to display in which way. It also allows for easy navigation through the
- file system when selecting file(s) to attach to a message, select multiple
- files to attach and many more.
-
- _\b2_\b._\b2_\b._\b4 _\bS_\bi_\bd_\be_\bb_\ba_\br
-
- The sidebar comes in handy to manage mails which are spread over different
- folders. All folders users setup mutt-ng to watch for new mail will be listed.
- The listing includes not only the name but also the number of total messages,
- the number of new and flagged messages. Items with new mail may be colored dif-
- ferent from those with flagged mail, items may be shortened or compress if
- they're they to long to be printed in full form so that by abbreviated names,
- user still now what the name stands for.
+1.4. Interaction
- _\b2_\b._\b2_\b._\b5 _\bH_\be_\bl_\bp
+ Mutt-ng has two basic concepts of user interaction:
+ 1. There is one dedicated line on the screen used to query the user for input, issue any command, query variables and display error and informational messages. As for every type of user input, this requires manual action leading to the need of input.
+ 2. The automatized interface for interaction are the so called hooks. Hooks specify actions the user wants to be performed at well-defined situations: what to do when entering which folder, what to do when displaying or replying to what kind of message, etc. These are optional, i.e. a user doesn't need to specify them but can do so.
- The Mutt Next Generation E-Mail Client 6
+1.5. Modularization
- The help screen is meant to offer a quick help to the user. It lists the cur-
- rent configuration of key bindings and their associated commands including a
- short description, and currently unbound functions that still need to be asso-
- ciated with a key binding (or alternatively, they can be called via the mutt-ng
- command prompt).
-
- _\b2_\b._\b2_\b._\b6 _\bC_\bo_\bm_\bp_\bo_\bs_\be _\bM_\be_\bn_\bu
-
- The compose menu features a split screen containing the information which
- really matter before actually sending a message by mail or posting an article
- to a newsgroup: who gets the message as what (recipient, newsgroup, who gets
- what kind of copy). Additionally, users may set security options like deciding
- whether to sign, encrypt or sign and encrypt a message with/for what keys.
-
- Also, it's used to attach messages, news articles or files to a message, to re-
- edit any attachment including the message itself.
-
- _\b2_\b._\b2_\b._\b7 _\bA_\bl_\bi_\ba_\bs _\bM_\be_\bn_\bu
-
- The alias menu is used to help users finding the recipients of messages. For
- users who need to contact many people, there's no need to remember addresses or
- names completely because it allows for searching, too. The alias mechanism and
- thus the alias menu also features grouping several addresses by a shorter nick-
- name, the actual alias, so that users don't have to select each single recipi-
- ent manually.
-
- _\b2_\b._\b2_\b._\b8 _\bA_\bt_\bt_\ba_\bc_\bh_\bm_\be_\bn_\bt _\bM_\be_\bn_\bu
-
- As will be later discussed in detail, mutt-ng features a good and stable MIME
- implementation, that is, is greatly supports sending and receiving messages of
- arbitrary type. The attachment menu displays a message's structure in detail:
- what content parts are attached to which parent part (which gives a true tree
- structure), which type is of what type and what size. Single parts may saved,
- deleted or modified to offer great and easy access to message's internals.
-
- _\b2_\b._\b2_\b._\b9 _\bK_\be_\by _\bM_\be_\bn_\bu
-
- FIXME
-
- _\b2_\b._\b3 _\bM_\bo_\bv_\bi_\bn_\bg _\bA_\br_\bo_\bu_\bn_\bd _\bi_\bn _\bM_\be_\bn_\bu_\bs
-
- Information is presented in menus, very similar to ELM. Here is a table
-
- The Mutt Next Generation E-Mail Client 7
-
- showing the common keys used to navigate menus in Mutt-ng.
-
- j or Down next-entry move to the next entry
- k or Up previous-entry move to the previous entry
- z or PageDn page-down go to the next page
- Z or PageUp page-up go to the previous page
- = or Home first-entry jump to the first entry
- * or End last-entry jump to the last entry
- q quit exit the current menu
- ? help list all key bindings for the current menu
-
- _\b2_\b._\b4 _\bE_\bd_\bi_\bt_\bi_\bn_\bg _\bI_\bn_\bp_\bu_\bt _\bF_\bi_\be_\bl_\bd_\bs
-
- Mutt-ng has a builtin line editor which is used as the primary way to input
- textual data such as email addresses or filenames. The keys used to move
- around while editing are very similar to those of Emacs.
-
- ^A or <Home> bol move to the start of the line
- ^B or <Left> backward-char move back one char
- Esc B backward-word move back one word
- ^D or <Delete> delete-char delete the char under the cursor
- ^E or <End> eol move to the end of the line
- ^F or <Right> forward-char move forward one char
- Esc F forward-word move forward one word
- <Tab> complete complete filename or alias
- ^T complete-query complete address with query
- ^K kill-eol delete to the end of the line
- ESC d kill-eow delete to the end of the word
- ^W kill-word kill the word in front of the cursor
- ^U kill-line delete entire line
- ^V quote-char quote the next typed key
- <Up> history-up recall previous string from history
- <Down> history-down recall next string from history
- <BackSpace> backspace kill the char in front of the cursor
- Esc u upcase-word convert word to upper case
- Esc l downcase-word convert word to lower case
- Esc c capitalize-word capitalize the word
- ^G n/a abort
- <Return> n/a finish editing
-
- You can remap the _\be_\bd_\bi_\bt_\bo_\br functions using the _\bb_\bi_\bn_\bd (section 3.5 , page 27) com-
- mand. For example, to make the _\bD_\be_\bl_\be_\bt_\be key delete the character in front of the
- cursor rather than under, you could use
-
- bind editor <delete> backspace
-
- The Mutt Next Generation E-Mail Client 8
+ Although mutt-ng has many functionality built-in, many features can be delegated to external tools to increase flexibility: users can define programs to filter a message through before displaying, users can use any program they want for displaying a message, message types (such as PDF or PostScript) for which mutt-ng doesn't have a built-in filter can be rendered by arbitrary tools and so forth. Although mutt-ng has an alias mechanism built-in, it features using external tools to query for nearly every type of addresses from sources like LDAP, databases or just the list of locally known users.
- _\b2_\b._\b5 _\bR_\be_\ba_\bd_\bi_\bn_\bg _\bM_\ba_\bi_\bl _\b- _\bT_\bh_\be _\bI_\bn_\bd_\be_\bx _\ba_\bn_\bd _\bP_\ba_\bg_\be_\br
+1.6. Patterns
- Similar to many other mail clients, there are two modes in which mail is read
- in Mutt-ng. The first is the index of messages in the mailbox, which is called
- the ``index'' in Mutt-ng. The second mode is the display of the message con-
- tents. This is called the ``pager.''
+ Mutt-ng has a built-in pattern matching ``language'' which is as widely used as possible to present a consistent interface to users. The same ``pattern terms'' can be used for searching, scoring, message selection and much more.
- The next few sections describe the functions provided in each of these modes.
+2. Screens and Menus
- _\b2_\b._\b5_\b._\b1 _\bT_\bh_\be _\bM_\be_\bs_\bs_\ba_\bg_\be _\bI_\bn_\bd_\be_\bx
+2.1. Index
- c change to a different mailbox
- ESC c change to a folder in read-only mode
- C copy the current message to another mailbox
- ESC C decode a message and copy it to a folder
- ESC s decode a message and save it to a folder
- D delete messages matching a pattern
- d delete the current message
- F mark as important
- l show messages matching a pattern
- N mark message as new
- o change the current sort method
- O reverse sort the mailbox
- q save changes and exit
- s save-message
- T tag messages matching a pattern
- t toggle the tag on a message
- ESC t toggle tag on entire message thread
- U undelete messages matching a pattern
- u undelete-message
- v view-attachments
- x abort changes and exit
- <Return> display-message
- <Tab> jump to the next new message
- @ show the author's full e-mail address
- $ save changes to mailbox
- / search
- ESC / search-reverse
- ^L clear and redraw the screen
- ^T untag messages matching a pattern
-
- _\b2_\b._\b5_\b._\b1_\b._\b1 _\bS_\bt_\ba_\bt_\bu_\bs _\bF_\bl_\ba_\bg_\bs
-
- In addition to who sent the message and the subject, a short summary of the
- disposition of each message is printed beside the message number. Zero or more
- of the following ``flags'' may appear, which mean:
-
- D
- message is deleted (is marked for deletion)
-
- d
- message have attachments marked for deletion
-
- The Mutt Next Generation E-Mail Client 9
-
- K
- contains a PGP public key
-
- N
- message is new
-
- O
- message is old
-
- P
- message is PGP encrypted
-
- r
- message has been replied to
-
- S
- message is signed, and the signature is succesfully verified
-
- s
- message is signed
-
- !
- message is flagged
-
- *
- message is tagged
-
- Some of the status flags can be turned on or off using
-
- +\bo s\bse\bet\bt-\b-f\bfl\bla\bag\bg (default: w)
-
- +\bo c\bcl\ble\bea\bar\br-\b-f\bfl\bla\bag\bg (default: W)
-
- Furthermore, the following flags reflect who the message is addressed to. They
- can be customized with the _\b$_\bt_\bo_\b__\bc_\bh_\ba_\br_\bs (section 7.4.339 , page 172) variable.
-
- +
- message is to you and you only
-
- T
- message is to you, but also to or cc'ed to others
-
- C
- message is cc'ed to you
-
- F
- message is from you
-
- L
- message is sent to a subscribed mailing list
-
- _\b2_\b._\b5_\b._\b2 _\bT_\bh_\be _\bP_\ba_\bg_\be_\br
-
- By default, Mutt-ng uses its builtin pager to display the body of messages.
-
- The Mutt Next Generation E-Mail Client 10
-
- The pager is very similar to the Unix program _\bl_\be_\bs_\bs though not nearly as fea-
- tureful.
-
- <Return> go down one line
- <Space> display the next page (or next message if at the end of a message)
- - go back to the previous page
- n search for next match
- S skip beyond quoted text
- T toggle display of quoted text
- ? show key bindings
- / search for a regular expression (pattern)
- ESC / search backwards for a regular expression
- \ toggle search pattern coloring
- ^ jump to the top of the message
-
- In addition, many of the functions from the _\bi_\bn_\bd_\be_\bx are available in the pager,
- such as _\bd_\be_\bl_\be_\bt_\be_\b-_\bm_\be_\bs_\bs_\ba_\bg_\be or _\bc_\bo_\bp_\by_\b-_\bm_\be_\bs_\bs_\ba_\bg_\be (this is one advantage over using an
- external pager to view messages).
+ The index is the screen that you usually see first when you start mutt-ng. It gives an overview over your emails in the currently opened mailbox. By default, this is your system mailbox. The information you see in the index is a list of emails, each with its number on the left, its flags (new email, important email, email that has been forwarded or replied to, tagged email, ...), the date when email was sent, its sender, the email size, and the subject. Additionally, the index also shows thread hierarchies: when you reply to an email, and the other person replies back, you can see the other's person email in a "sub-tree" below. This is especially useful for personal email between a group of people or when you've subscribed to mailing lists.
- Also, the internal pager supports a couple other advanced features. For one, it
- will accept and translate the ``standard'' nroff sequences for bold and under-
- line. 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 _\bc_\bo_\bl_\bo_\br
- (section 3.9 , page 31) objects to specify a color or mono attribute for them.
+2.2. Pager
- Additionally, the internal pager supports the ANSI escape sequences for charac-
- ter attributes. Mutt-ng translates them into the correct color and character
- settings. The sequences Mutt-ng supports are:
+ The pager is responsible for showing the email content. On the top of the pager you have an overview over the most important email headers like the sender, the recipient, the subject, and much more information. How much information you actually see depends on your configuration, which we'll describe below.
- ESC [ Ps;Ps;Ps;...;Ps m
- where Ps =
- 0 All Attributes Off
- 1 Bold on
- 4 Underline on
- 5 Blink on
- 7 Reverse video on
- 3x Foreground color is x
- 4x Background color is x
+ Below the headers, you see the email body which usually contains the message. If the email contains any attachments, you will see more information about them below the email body, or, if the attachments are text files, you can view them directly in the pager.
- Colors are
- 0 black
- 1 red
- 2 green
- 3 yellow
- 4 blue
- 5 magenta
- 6 cyan
- 7 white
+ To give the user a good overview, it is possible to configure mutt-ng to show different things in the pager with different colors. Virtually everything that can be described with a regular expression can be colored, e.g. URLs, email addresses or smileys.
- The Mutt Next Generation E-Mail Client 11
+2.3. File Browser
- Mutt-ng uses these attributes for handling text/enriched messages, and they can
- also be used by an external _\ba_\bu_\bt_\bo_\bv_\bi_\be_\bw (section 5.4 , page 79) script for high-
- lighting purposes. N\bNo\bot\bte\be:\b: If you change the colors for your display, for exam-
- ple by changing the color associated with color2 for your xterm, then that
- color will be used instead of green.
+ The file browser is the interface to the local or remote file system. When selecting a mailbox to open, the browser allows custom sorting of items, limiting the items shown by a regular expression and a freely adjustable format of what to display in which way. It also allows for easy navigation through the file system when selecting file(s) to attach to a message, select multiple files to attach and many more.
- _\b2_\b._\b5_\b._\b3 _\bT_\bh_\br_\be_\ba_\bd_\be_\bd _\bM_\bo_\bd_\be
+2.4. Sidebar
- When the mailbox is _\bs_\bo_\br_\bt_\be_\bd (section 7.4.307 , page 163) by _\bt_\bh_\br_\be_\ba_\bd_\bs, there are
- a few additional functions available in the _\bi_\bn_\bd_\be_\bx and _\bp_\ba_\bg_\be_\br modes.
+ The sidebar comes in handy to manage mails which are spread over different folders. All folders users setup mutt-ng to watch for new mail will be listed. The listing includes not only the name but also the number of total messages, the number of new and flagged messages. Items with new mail may be colored different from those with flagged mail, items may be shortened or compress if they're they to long to be printed in full form so that by abbreviated names, user still now what the name stands for.
- ^D delete-thread delete all messages in the current thread
- ^U undelete-thread undelete all messages in the current thread
- ^N next-thread jump to the start of the next thread
- ^P previous-thread jump to the start of the previous thread
- ^R read-thread mark the current thread as read
- ESC d delete-subthread delete all messages in the current subthread
- ESC u undelete-subthread undelete all messages in the current subthread
- ESC n next-subthread jump to the start of the next subthread
- ESC p previous-subthread jump to the start of the previous subthread
- ESC r read-subthread mark the current subthread as read
- ESC t tag-thread toggle the tag on the current thread
- ESC v collapse-thread toggle collapse for the current thread
- ESC V collapse-all toggle collapse for all threads
- P parent-message jump to parent message in thread
-
- N\bNo\bot\bte\be:\b: Collapsing a thread displays only the first message in the thread and
- hides the others. This is useful when threads contain so many messages that you
- can only see a handful of threads on the screen. See %M in _\b$_\bi_\bn_\bd_\be_\bx_\b__\bf_\bo_\br_\bm_\ba_\bt (sec-
- tion 7.4.116 , page 116). For example, you could use "%?M?(#%03M)&(%4l)?" in
- _\b$_\bi_\bn_\bd_\be_\bx_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.116 , page 116) to optionally display the number of
- hidden messages if the thread is collapsed.
-
- See also: _\b$_\bs_\bt_\br_\bi_\bc_\bt_\b__\bt_\bh_\br_\be_\ba_\bd_\bs (section 7.4.328 , page 170).
-
- _\b2_\b._\b5_\b._\b4 _\bM_\bi_\bs_\bc_\be_\bl_\bl_\ba_\bn_\be_\bo_\bu_\bs _\bF_\bu_\bn_\bc_\bt_\bi_\bo_\bn_\bs
-
- c\bcr\bre\bea\bat\bte\be-\b-a\bal\bli\bia\bas\bs
- (default: a)
-
- Creates a new alias based upon the current message (or prompts for a new one).
- Once editing is complete, an _\ba_\bl_\bi_\ba_\bs (section 3.4 , page 26) command is added to
- the file specified by the _\b$_\ba_\bl_\bi_\ba_\bs_\b__\bf_\bi_\bl_\be (section 7.4.5 , page 90) variable for
- future use. N\bNo\bot\bte\be:\b: Specifying an _\b$_\ba_\bl_\bi_\ba_\bs_\b__\bf_\bi_\bl_\be (section 7.4.5 , page 90) does not
- add the aliases specified there-in, you must also _\bs_\bo_\bu_\br_\bc_\be (section 3.29 , page
- 46) the file.
-
- c\bch\bhe\bec\bck\bk-\b-t\btr\bra\bad\bdi\bit\bti\bio\bon\bna\bal\bl-\b-p\bpg\bgp\bp
- (default: ESC P)
-
- This function will search the current message for content signed or encrypted
- with PGP the "traditional" way, that is, without proper MIME tagging.
-
- The Mutt Next Generation E-Mail Client 12
-
- Technically, this function will temporarily change the MIME content types of
- the body parts containing PGP data; this is similar to the _\be_\bd_\bi_\bt_\b-_\bt_\by_\bp_\be (section
- 2.5.4 , page 12) function's effect.
-
- d\bdi\bis\bsp\bpl\bla\bay\by-\b-t\bto\bog\bgg\bgl\ble\be-\b-w\bwe\bee\bed\bd
- (default: h)
-
- Toggles the weeding of message header fields specified by _\bi_\bg_\bn_\bo_\br_\be (section
- 3.10 , page 33) commands.
-
- e\bed\bdi\bit\bt
- (default: e)
-
- This command (available in the ``index'' and ``pager'') allows you to edit the
- raw current message as it's present in the mail folder. After you have fin-
- ished editing, the changed message will be appended to the current folder, and
- the original message will be marked for deletion.
-
- e\bed\bdi\bit\bt-\b-t\bty\byp\bpe\be
-
- (default: ^E on the attachment menu, and in the pager and index menus; ^T on
- the compose menu)
-
- This command is used to temporarily edit an attachment's content type to fix,
- for instance, bogus character set parameters. When invoked from the index or
- from the pager, you'll have the opportunity to edit the top-level attachment's
- content type. On the _\ba_\bt_\bt_\ba_\bc_\bh_\bm_\be_\bn_\bt _\bm_\be_\bn_\bu (section 5.1.2 , page 71), you can
- change any attachment's content type. These changes are not persistent, and get
- lost upon changing folders.
-
- Note that this command is also available on the _\bc_\bo_\bm_\bp_\bo_\bs_\be _\bm_\be_\bn_\bu (section 5.1.3 ,
- page 72). There, it's used to fine-tune the properties of attachments you are
- going to send.
+2.5. Help
- e\ben\bnt\bte\ber\br-\b-c\bco\bom\bmm\bma\ban\bnd\bd
- (default: ``:'')
+ The help screen is meant to offer a quick help to the user. It lists the current configuration of key bindings and their associated commands including a short description, and currently unbound functions that still need to be associated with a key binding (or alternatively, they can be called via the mutt-ng command prompt).
- This command is used to execute any command you would normally put in a config-
- uration file. A common use is to check the settings of variables, or in con-
- junction with _\bm_\ba_\bc_\br_\bo_\bs (section 3.8 , page 30) to change settings on the fly.
+2.6. Compose Menu
- e\bex\bxt\btr\bra\bac\bct\bt-\b-k\bke\bey\bys\bs
- (default: ^K)
+ The compose menu features a split screen containing the information which really matter before actually sending a message by mail or posting an article to a newsgroup: who gets the message as what (recipient, newsgroup, who gets what kind of copy). Additionally, users may set security options like deciding whether to sign, encrypt or sign and encrypt a message with/for what keys.
- This command extracts PGP public keys from the current or tagged message(s) and
- adds them to your PGP public key ring.
+ Also, it's used to attach messages, news articles or files to a message, to re-edit any attachment including the message itself.
- f\bfo\bor\brg\bge\bet\bt-\b-p\bpa\bas\bss\bsp\bph\bhr\bra\bas\bse\be
- (default: ^F)
+2.7. Alias Menu
- This command wipes the passphrase(s) from memory. It is useful, if you mis-
- spelled the passphrase.
+ The alias menu is used to help users finding the recipients of messages. For users who need to contact many people, there's no need to remember addresses or names completely because it allows for searching, too. The alias mechanism and thus the alias menu also features grouping several addresses by a shorter nickname, the actual alias, so that users don't have to select each single recipient manually.
- The Mutt Next Generation E-Mail Client 13
+2.8. Attachment Menu
- l\bli\bis\bst\bt-\b-r\bre\bep\bpl\bly\by
- (default: L)
+ As will be later discussed in detail, mutt-ng features a good and stable MIME implementation, that is, is greatly supports sending and receiving messages of arbitrary type. The attachment menu displays a message's structure in detail: what content parts are attached to which parent part (which gives a true tree structure), which type is of what type and what size. Single parts may saved, deleted or modified to offer great and easy access to message's internals.
- Reply to the current or tagged message(s) by extracting any addresses which
- match the regular expressions given by the _\bl_\bi_\bs_\bt_\bs _\bo_\br _\bs_\bu_\bb_\bs_\bc_\br_\bi_\bb_\be (section 3.13 ,
- page 36) commands, but also honor any Mail-Followup-To header(s) if the
- _\b$_\bh_\bo_\bn_\bo_\br_\b__\bf_\bo_\bl_\bl_\bo_\bw_\bu_\bp_\b__\bt_\bo (section 7.4.94 , page 111) configuration variable is set.
- Using this when replying to messages posted to mailing lists helps avoid dupli-
- cate copies being sent to the author of the message you are replying to.
+2.9. Key Menu
- p\bpi\bip\bpe\be-\b-m\bme\bes\bss\bsa\bag\bge\be
- (default: |)
+ FIXME
- Asks for an external Unix command and pipes the current or tagged message(s) to
- it. The variables _\b$_\bp_\bi_\bp_\be_\b__\bd_\be_\bc_\bo_\bd_\be (section 7.4.216 , page 142), _\b$_\bp_\bi_\bp_\be_\b__\bs_\bp_\bl_\bi_\bt
- (section 7.4.218 , page 142), _\b$_\bp_\bi_\bp_\be_\b__\bs_\be_\bp (section 7.4.217 , page 142) and
- _\b$_\bw_\ba_\bi_\bt_\b__\bk_\be_\by (section 7.4.350 , page 174) control the exact behavior of this
- function.
+3. Moving Around in Menus
- r\bre\bes\bse\ben\bnd\bd-\b-m\bme\bes\bss\bsa\bag\bge\be
- (default: ESC e)
+ Information is presented in menus, very similar to ELM. Here is a table showing the common keys used to navigate menus in Mutt-ng.
+j or Down next-entry move to the next entry
+k or Up previous-entry move to the previous entry
+z or PageDn page-down go to the next page
+Z or PageUp page-up go to the previous page
+= or Home first-entry jump to the first entry
+* or End last-entry jump to the last entry
+q quit exit the current menu
+? help list all key bindings for the current menu
- With resend-message, mutt takes the current message as a template for a new
- message. This function is best described as "recall from arbitrary folders".
- It can conveniently be used to forward MIME messages while preserving the orig-
- inal mail structure. Note that the amount of headers included here depends on
- the value of the _\b$_\bw_\be_\be_\bd (section 7.4.351 , page 175) variable.
+4. Editing Input Fields
- This function is also available from the attachment menu. You can use this to
- easily resend a message which was included with a bounce message as a mes-
- sage/rfc822 body part.
+ Mutt-ng has a builtin line editor which is used as the primary way to input textual data such as email addresses or filenames. The keys used to move around while editing are very similar to those of Emacs.
+^A or <Home> bol move to the start of the line
+^B or <Left> backward-char move back one char
+Esc B backward-word move back one word
+^D or <Delete> delete-char delete the char under the cursor
+^E or <End> eol move to the end of the line
+^F or <Right> forward-char move forward one char
+Esc F forward-word move forward one word
+<Tab> complete complete filename or alias
+^T complete-query complete address with query
+^K kill-eol delete to the end of the line
+ESC d kill-eow delete to the end of the word
+^W kill-word kill the word in front of the cursor
+^U kill-line delete entire line
+^V quote-char quote the next typed key
+<Up> history-up recall previous string from history
+<Down> history-down recall next string from history
+<BackSpace> backspace kill the char in front of the cursor
+Esc u upcase-word convert word to upper case
+Esc l downcase-word convert word to lower case
+Esc c capitalize-word capitalize the word
+^G n/a abort
+<Return> n/a finish editing
- s\bsh\bhe\bel\bll\bl-\b-e\bes\bsc\bca\bap\bpe\be
- (default: !)
+ You can remap the editor functions using the bind command. For example, to make the Delete key delete the character in front of the cursor rather than under, you could use
- Asks for an external Unix command and executes it. The _\b$_\bw_\ba_\bi_\bt_\b__\bk_\be_\by (section
- 7.4.350 , page 174) can be used to control whether Mutt-ng will wait for a key
- to be pressed when the command returns (presumably to let the user read the
- output of the command), based on the return status of the named command.
+ bind editor <delete> backspace
- t\bto\bog\bgg\bgl\ble\be-\b-q\bqu\buo\bot\bte\bed\bd
- (default: T)
+5. Reading Mail - The Index and Pager
- The _\bp_\ba_\bg_\be_\br uses the _\b$_\bq_\bu_\bo_\bt_\be_\b__\br_\be_\bg_\be_\bx_\bp (section 7.4.241 , page 147) variable to
- detect quoted text when displaying the body of the message. This function tog-
- gles the display of the quoted material in the message. It is particularly
- useful when are interested in just the response and there is a large amount of
- quoted text in the way.
-
- s\bsk\bki\bip\bp-\b-q\bqu\buo\bot\bte\bed\bd
- (default: S)
-
- This function will go to the next line of non-quoted text which come after a
- line of quoted text in the internal pager.
-
- The Mutt Next Generation E-Mail Client 14
-
- _\b2_\b._\b6 _\bS_\be_\bn_\bd_\bi_\bn_\bg _\bM_\ba_\bi_\bl
-
- The following bindings are available in the _\bi_\bn_\bd_\be_\bx for sending messages.
-
- m compose compose a new message
- r reply reply to sender
- g group-reply reply to all recipients
- L list-reply reply to mailing list address
- f forward forward message
- b bounce bounce (remail) message
- ESC k mail-key mail a PGP public key to someone
-
- Bouncing a message sends the message as is to the recipient you specify. For-
- warding a message allows you to add comments or modify the message you are for-
- warding. These items are discussed in greater detail in the next chapter
- _\b`_\b`_\bF_\bo_\br_\bw_\ba_\br_\bd_\bi_\bn_\bg _\ba_\bn_\bd _\bB_\bo_\bu_\bn_\bc_\bi_\bn_\bg _\bM_\ba_\bi_\bl_\b'_\b' (section 2.7 , page 20).
-
- _\b2_\b._\b6_\b._\b1 _\bC_\bo_\bm_\bp_\bo_\bs_\bi_\bn_\bg _\bn_\be_\bw _\bm_\be_\bs_\bs_\ba_\bg_\be_\bs
-
- When you want to send an email using mutt-ng, simply press m on your keyboard.
- Then, mutt-ng asks for the recipient via a prompt in the last line:
-
- To:
-
- After you've finished entering the recipient(s), press return. If you want to
- send an email to more than one recipient, separate the email addresses using
- the comma ",". Mutt-ng then asks you for the email subject. Again, press return
- after you've entered it. After that, mutt-ng got the most important information
- from you, and starts up an editor where you can then enter your email.
-
- The editor that is called is selected in the following way: you can e.g. set it
- in the mutt-ng configuration:
-
- set editor = "vim +/^$/ -c ':set tw=72'"
- set editor = "nano"
- set editor = "emacs"
-
- If you don't set your preferred editor in your configuration, mutt-ng first
- looks whether the environment variable $VISUAL is set, and if so, it takes its
- value as editor command. Otherwise, it has a look at $EDITOR and takes its
- value if it is set. If no editor command can be found, mutt-ng simply assumes
- vi to be the default editor, since it's the most widespread editor in the Unix
- world and it's pretty safe to assume that it is installed and available.
-
- When you've finished entering your message, save it and quit your editor. Mutt-
- ng will then present you with a summary screen, the compose menu. On the top,
- you see a summary of the most important available key commands. Below that,
- you see the sender, the recipient(s), Cc and/or Bcc recipient(s), the subject,
-
- The Mutt Next Generation E-Mail Client 15
-
- the reply-to address, and optionally information where the sent email will be
- stored and whether it should be digitally signed and/or encrypted.
-
- Below that, you see a list of "attachments". The mail you've just entered
- before is also an attachment, but due to its special type (it's plain text), it
- will be displayed as the normal message on the receiver's side.
-
- At this point, you can add more attachments, pressing a, you can edit the
- recipient addresses, pressing t for the "To:" field, c for the "Cc:" field, and
- b for the "Bcc: field. You can also edit the subject the subject by simply
- pressing s or the email message that you've entered before by pressing e. You
- will then again return to the editor. You can even edit the sender, by pressing
- <esc>f, but this shall only be used with caution.
+ Similar to many other mail clients, there are two modes in which mail is read in Mutt-ng. The first is the index of messages in the mailbox, which is called the ``index'' in Mutt-ng. The second mode is the display of the message contents. This is called the ``pager.''
- Alternatively, you can configure mutt-ng in a way that most of the above set-
- tings can be edited using the editor. Therefore, you only need to add the fol-
- lowing to your configuration:
+ The next few sections describe the functions provided in each of these modes.
- set edit_headers
+5.1. The Message Index
- Once you have finished editing the body of your mail message, you are returned
- to the _\bc_\bo_\bm_\bp_\bo_\bs_\be menu. The following options are available:
-
- a attach-file attach a file
- A attach-message attach message(s) to the message
- ESC k attach-key attach a PGP public key
- d edit-description edit description on attachment
- D detach-file detach a file
- t edit-to edit the To field
- ESC f edit-from edit the From field
- r edit-reply-to edit the Reply-To field
- c edit-cc edit the Cc field
- b edit-bcc edit the Bcc field
- y send-message send the message
- s edit-subject edit the Subject
- S smime-menu select S/MIME options
- f edit-fcc specify an ``Fcc'' mailbox
- p pgp-menu select PGP options
- P postpone-message postpone this message until later
- q quit quit (abort) sending the message
- w write-fcc write the message to a folder
- i ispell check spelling (if available on your system)
- ^F forget-passphrase wipe passphrase(s) from memory
+c change to a different mailbox
+ESC c change to a folder in read-only mode
+C copy the current message to another mailbox
+ESC C decode a message and copy it to a folder
+ESC s decode a message and save it to a folder
+D delete messages matching a pattern
+d delete the current message
+F mark as important
+l show messages matching a pattern
+N mark message as new
+o change the current sort method
+O reverse sort the mailbox
+q save changes and exit
+s save-message
+T tag messages matching a pattern
+t toggle the tag on a message
+ESC t toggle tag on entire message thread
+U undelete messages matching a pattern
+u undelete-message
+v view-attachments
+x abort changes and exit
+<Return> display-message
+<Tab> jump to the next new message
+@ show the author's full e-mail address
+$ save changes to mailbox
+/ search
+ESC / search-reverse
+^L clear and redraw the screen
+^T untag messages matching a pattern
+
+5.1.1. Status Flags
+
+ In addition to who sent the message and the subject, a short summary of the disposition of each message is printed beside the message number. Zero or more of the following ``flags'' may appear, which mean:
+
+ D
+ message is deleted (is marked for deletion)
+
+ d
+ message have attachments marked for deletion
+
+ K
+ contains a PGP public key
+
+ N
+ message is new
+
+ O
+ message is old
+
+ P
+ message is PGP encrypted
+
+ r
+ message has been replied to
+
+ S
+ message is signed, and the signature is succesfully verified
+
+ s
+ message is signed
+
+ !
+ message is flagged
+
+ *
+ message is tagged
+
+ Some of the status flags can be turned on or off using
+ * set-flag (default: w)
+ * clear-flag (default: W)
+
+ Furthermore, the following flags reflect who the message is addressed to. They can be customized with the $to_chars variable.
+
+ +
+ message is to you and you only
- N\bNo\bot\bte\be:\b: The attach-message function will prompt you for a folder to attach mes-
- sages from. You can now tag messages in that folder and they will be attached
- to the message you are sending. Note that certain operations like composing a
- new mail, replying, forwarding, etc. are not permitted when you are in that
- folder. The %r in _\b$_\bs_\bt_\ba_\bt_\bu_\bs_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.324 , page 167) will change to a
- 'A' to indicate that you are in attach-message mode.
+ T
+ message is to you, but also to or cc'ed to others
- The Mutt Next Generation E-Mail Client 16
+ C
+ message is cc'ed to you
- _\b2_\b._\b6_\b._\b2 _\bR_\be_\bp_\bl_\by_\bi_\bn_\bg
+ F
+ message is from you
- _\b2_\b._\b6_\b._\b2_\b._\b1 _\bS_\bi_\bm_\bp_\bl_\be _\bR_\be_\bp_\bl_\bi_\be_\bs
+ L
+ message is sent to a subscribed mailing list
- When you want to reply to an email message, select it in the index menu and
- then press r. 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 the editor with the quote attribution and
- the quoted message. This can e.g. look like the example below.
+5.2. The Pager
- 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.
+ By default, Mutt-ng uses its builtin pager to display the body of messages. The pager is very similar to the Unix program less though not nearly as featureful.
+<Return> go down one line
+<Space> display the next page (or next message if at the end of a message)
+- go back to the previous page
+n search for next match
+S skip beyond quoted text
+T toggle display of quoted text
+? show key bindings
+/ search for a regular expression (pattern)
+ESC / search backwards for a regular expression
+\ toggle search pattern coloring
+^ jump to the top of the message
- You can start editing the email message. It is strongly recommended to put your
- answer _\bb_\be_\bl_\bo_\bw the quoted text and to only quote what is really necessary and
- that you refer to. Putting your answer on top of the quoted message, is,
- although very widespread, very often not considered to be a polite way to
- answer emails.
+ In addition, many of the functions from the index are available in the pager, such as delete-message or copy-message (this is one advantage over using an external pager to view messages).
- The quote attribution is configurable, by default it is set to
+ Also, the internal pager supports a couple other advanced features. For one, it will accept and translate the ``standard'' nroff sequences for bold and underline. These sequences are a series of either the letter, backspace (^H), the letter again for bold or the letter, backspace, ``_'' 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 color objects to specify a color or mono attribute for them.
- set attribution = "On %d, %n wrote:"
+ Additionally, the internal pager supports the ANSI escape sequences for character attributes. Mutt-ng translates them into the correct color and character settings. The sequences Mutt-ng supports are:
+ESC [ Ps;Ps;Ps;...;Ps m
+where Ps =
+0 All Attributes Off
+1 Bold on
+4 Underline on
+5 Blink on
+7 Reverse video on
+3x Foreground color is x
+4x Background color is x
- It can also be set to something more compact, e.g.
+Colors are
+0 black
+1 red
+2 green
+3 yellow
+4 blue
+5 magenta
+6 cyan
+7 white
- set attribution = "attribution="* %n <%a> [%(%y-%m-%d %H:%M)]:"
+ Mutt-ng uses these attributes for handling text/enriched messages, and they can also be used by an external autoview script for highlighting purposes. Note: 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.
- The example above results in the following attribution:
+5.3. Threaded Mode
- * 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.
+ When the mailbox is sorted by threads, there are a few additional functions available in the index and pager modes.
+^D delete-thread delete all messages in the current thread
+^U undelete-thread undelete all messages in the current thread
+^N next-thread jump to the start of the next thread
+^P previous-thread jump to the start of the previous thread
+^R read-thread mark the current thread as read
+ESC d delete-subthread delete all messages in the current subthread
+ESC u undelete-subthread undelete all messages in the current subthread
+ESC n next-subthread jump to the start of the next subthread
+ESC p previous-subthread jump to the start of the previous subthread
+ESC r read-subthread mark the current subthread as read
+ESC t tag-thread toggle the tag on the current thread
+ESC v collapse-thread toggle collapse for the current thread
+ESC V collapse-all toggle collapse for all threads
+P parent-message jump to parent message in thread
- Generally, try to keep your attribution short yet information-rich. It is _\bn_\bo_\bt
- the right place for witty quotes, long "attribution" novels or anything like
- that: the right place for such things is - if at all - the email signature at
- the very bottom of the message.
+ Note: Collapsing a thread displays only the first message in the thread and hides the others. This is useful when threads contain so many messages that you can only see a handful of threads on the screen. See %M in index-format. For example, you could use "%?M?(#%03M)&(%4l)?" in index-format to optionally display the number of hidden messages if the thread is collapsed.
- When you're done with writing your message, save and quit the editor. As
- before, you will return to the compose menu, which is used in the same way as
+ See also: strict-threads.
- The Mutt Next Generation E-Mail Client 17
+5.4. Miscellaneous Functions
- before.
+ create-alias (default: a)
- _\b2_\b._\b6_\b._\b2_\b._\b2 _\bG_\br_\bo_\bu_\bp _\bR_\be_\bp_\bl_\bi_\be_\bs
+ Creates a new alias based upon the current message (or prompts for a new one). Once editing is complete, an alias command is added to the file specified by the alias-file variable for future use. Note: Specifying an alias-file does not add the aliases specified there-in, you must also source the file.
- 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:" recipi-
- ents. The group reply functionality ensures that when you press g instead of r
- to do a reply, each and every recipient that is contained in the original mes-
- sage will receive a copy of the message, either as normal recipient or as "Cc:"
- recipient.
+ check-traditional-pgp (default: ESC P)
- _\b2_\b._\b6_\b._\b2_\b._\b3 _\bL_\bi_\bs_\bt _\bR_\be_\bp_\bl_\bi_\be_\bs
+ This function will search the current message for content signed or encrypted with PGP the "traditional" way, that is, without proper MIME tagging. Technically, this function will temporarily change the MIME content types of the body parts containing PGP data; this is similar to the edit-type function's effect.
- When you use mailing lists, it's generally better to send your reply to a mes-
- sage only to the list instead of the list and the original author. To make this
- easy to use, mutt-ng features list replies.
+ display-toggle-weed (default: h)
- To do a list reply, simply press L. If the email contains a Mail-Followup-To:
- header, its value will be used as reply address. Otherwise, mutt-ng searches
- through all mail addresses in the original message and tries to match them a
- list of regular expressions which can be specified using the lists command. If
- any of the regular expression matches, a mailing list address has been found,
- and it will be used as reply address.
+ Toggles the weeding of message header fields specified by ignore commands.
- lists linuxevent@luga\.at vuln-dev@ mutt-ng-users@
+ edit (default: e)
- Nowadays, most mailing list software like GNU Mailman adds a Mail-Followup-To:
- header to their emails anyway, so setting lists is hardly ever necessary in
- practice.
+ This command (available in the ``index'' and ``pager'') allows you to edit the raw current message as it's present in the mail folder. After you have finished editing, the changed message will be appended to the current folder, and the original message will be marked for deletion.
- _\b2_\b._\b6_\b._\b3 _\bE_\bd_\bi_\bt_\bi_\bn_\bg _\bt_\bh_\be _\bm_\be_\bs_\bs_\ba_\bg_\be _\bh_\be_\ba_\bd_\be_\br
+ edit-type (default: ^E on the attachment menu, and in the pager and index menus; ^T on the compose menu)
- When editing the header of your outgoing message, there are a couple of special
- features available.
+ This command is used to temporarily edit an attachment's content type to fix, for instance, bogus character set parameters. When invoked from the index or from the pager, you'll have the opportunity to edit the top-level attachment's content type. On the attach-menu, you can change any attachment's content type. These changes are not persistent, and get lost upon changing folders.
- If you specify
+ Note that this command is also available on the compose-menu. There, it's used to fine-tune the properties of attachments you are going to send.
- Fcc: _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
+ enter-command (default: ``:'')
- Mutt-ng will pick up _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be just as if you had used the _\be_\bd_\bi_\bt_\b-_\bf_\bc_\bc function in
- the _\bc_\bo_\bm_\bp_\bo_\bs_\be menu.
+ This command is used to execute any command you would normally put in a configuration file. A common use is to check the settings of variables, or in conjunction with macro to change settings on the fly.
- You can also attach files to your message by specifying
+ extract-keys (default: ^K)
- The Mutt Next Generation E-Mail Client 18
+ This command extracts PGP public keys from the current or tagged message(s) and adds them to your PGP public key ring.
- Attach: _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be [ _\bd_\be_\bs_\bc_\br_\bi_\bp_\bt_\bi_\bo_\bn ]
+ forget-passphrase (default: ^F)
- where _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be is the file to attach and _\bd_\be_\bs_\bc_\br_\bi_\bp_\bt_\bi_\bo_\bn is an optional string to
- use as the description of the attached file.
+ This command wipes the passphrase(s) from memory. It is useful, if you misspelled the passphrase.
- When replying to messages, if you remove the _\bI_\bn_\b-_\bR_\be_\bp_\bl_\by_\b-_\bT_\bo_\b: field from the header
- field, Mutt-ng will not generate a _\bR_\be_\bf_\be_\br_\be_\bn_\bc_\be_\bs_\b: field, which allows you to cre-
- ate a new message thread.
+ list-reply (default: L)
- Also see _\be_\bd_\bi_\bt_\b__\bh_\be_\ba_\bd_\be_\br_\bs (section 7.4.59 , page 103).
+ Reply to the current or tagged message(s) by extracting any addresses which match the regular expressions given by the lists commands, but also honor any Mail-Followup-To header(s) if the honor-followup-to configuration variable is set. Using this when replying to messages posted to mailing lists helps avoid duplicate copies being sent to the author of the message you are replying to.
- _\b2_\b._\b6_\b._\b4 _\bU_\bs_\bi_\bn_\bg _\bM_\bu_\bt_\bt_\b-_\bn_\bg _\bw_\bi_\bt_\bh _\bP_\bG_\bP
+ pipe-message (default: |)
- If you want to use PGP, you can specify
+ Asks for an external Unix command and pipes the current or tagged message(s) to it. The variables pipe-decode, pipe-split, pipe-sep and wait-key control the exact behavior of this function.
- Pgp: [ E | S | S_\b<_\bi_\bd_\b> ]
+ resend-message (default: ESC e)
- ``E'' encrypts, ``S'' signs and ``S<id>'' signs with the given key, setting
- _\b$_\bp_\bg_\bp_\b__\bs_\bi_\bg_\bn_\b__\ba_\bs (section 7.4.208 , page 140) permanently.
+ With resend-message, mutt takes the current message as a template for a new message. This function is best described as "recall from arbitrary folders". It can conveniently be used to forward MIME messages while preserving the original mail structure. Note that the amount of headers included here depends on the value of the weed variable.
- If you have told mutt to PGP encrypt a message, it will guide you through a key
- selection process when you try to send the message. Mutt-ng will not ask you
- any questions about keys which have a certified user ID matching one of the
- message recipients' mail addresses. However, there may be situations in which
- there are several keys, weakly certified user ID fields, or where no matching
- keys can be found.
+ This function is also available from the attachment menu. You can use this to easily resend a message which was included with a bounce message as a message/rfc822 body part.
- 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
- ^G. When you do so, mutt will return to the compose screen.
+ shell-escape (default: !)
- Once you have successfully finished the key selection, the message will be
- encrypted using the selected public keys, and sent out.
+ Asks for an external Unix command and executes it. The wait-key can be used to control whether Mutt-ng will wait for a key to be pressed when the command returns (presumably to let the user read the output of the command), based on the return status of the named command.
- Most fields of the entries in the key selection menu (see also _\b$_\bp_\bg_\bp_\b__\be_\bn_\bt_\br_\by_\b__\bf_\bo_\br_\b-
- _\bm_\ba_\bt (section 7.4.195 , page 137)) have obvious meanings. But some explana-
- tions on the capabilities, flags, and validity fields are in order.
+ toggle-quoted (default: T)
- The flags sequence (%f) will expand to one of the following flags:
+ The pager uses the quote-regexp variable to detect quoted text when displaying the body of the message. This function toggles the display of the quoted material in the message. It is particularly useful when are interested in just the response and there is a large amount of quoted text in the way.
- R The key has been revoked and can't be used.
- X The key is expired and can't be used.
- d You have marked the key as disabled.
- c There are unknown critical self-signature
- packets.
+ skip-quoted (default: S)
- The capabilities field (%c) expands to a two-character sequence representing a
- key's capabilities. The first character gives the key's encryption capabili-
- ties: A minus sign (-\b-) means that the key cannot be used for encryption. A dot
- (.\b.) means that it's marked as a signature key in one of the user IDs, but may
+ This function will go to the next line of non-quoted text which come after a line of quoted text in the internal pager.
- The Mutt Next Generation E-Mail Client 19
+6. Sending Mail
- also be used for encryption. The letter e\be indicates that this key can be used
- for encryption.
+ The following bindings are available in the index for sending messages.
+m compose compose a new message
+r reply reply to sender
+g group-reply reply to all recipients
+L list-reply reply to mailing list address
+f forward forward message
+b bounce bounce (remail) message
+ESC k mail-key mail a PGP public key to someone
- The second character indicates the key's signing capabilities. Once again, a
- ``-\b-'' implies ``not for signing'', ``.\b.'' implies that the key is marked as an
- encryption key in one of the user-ids, and ``s\bs'' denotes a key which can be
- used for signing.
+ 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 forwarding-mail.
- Finally, the validity field (%t) indicates how well-certified a user-id is. A
- question mark (?\b?) indicates undefined validity, a minus character (-\b-) marks an
- untrusted association, a space character means a partially trusted association,
- and a plus character (+\b+) indicates complete validity.
+6.1. Composing new messages
- _\b2_\b._\b6_\b._\b5 _\bS_\be_\bn_\bd_\bi_\bn_\bg _\ba_\bn_\bo_\bn_\by_\bm_\bo_\bu_\bs _\bm_\be_\bs_\bs_\ba_\bg_\be_\bs _\bv_\bi_\ba _\bm_\bi_\bx_\bm_\ba_\bs_\bt_\be_\br
+ When you want to send an email using mutt-ng, simply press m on your keyboard. Then, mutt-ng asks for the recipient via a prompt in the last line:
+To:
- You may also have configured mutt to co-operate with Mixmaster, an anonymous
- remailer. Mixmaster permits you to send your messages anonymously using a
- chain of remailers. Mixmaster support in mutt is for mixmaster version 2.04
- (beta 45 appears to be the latest) and 2.03. It does not support earlier ver-
- sions or the later so-called version 3 betas, of which the latest appears to be
- called 2.9b23.
+ After you've finished entering the recipient(s), press return. If you want to send an email to more than one recipient, separate the email addresses using the comma ",". Mutt-ng then asks you for the email subject. Again, press return after you've entered it. After that, mutt-ng got the most important information from you, and starts up an editor where you can then enter your email.
- To use it, you'll have to obey certain restrictions. Most important, you can-
- not use the Cc and Bcc headers. To tell Mutt-ng to use mixmaster, you have to
- select a remailer chain, using the mix function on the compose menu.
+ The editor that is called is selected in the following way: you can e.g. set it in the mutt-ng configuration:
+set editor = "vim +/^$/ -c ':set tw=72'"
+set editor = "nano"
+set editor = "emacs"
- The chain selection screen is divided into two parts. In the (larger) upper
- part, you get a list of remailers you may use. In the lower part, you see the
- currently selected chain of remailers.
+ If you don't set your preferred editor in your configuration, mutt-ng first looks whether the environment variable $VISUAL is set, and if so, it takes its value as editor command. Otherwise, it has a look at $EDITOR and takes its value if it is set. If no editor command can be found, mutt-ng simply assumes vi to be the default editor, since it's the most widespread editor in the Unix world and it's pretty safe to assume that it is installed and available.
- You can navigate in the chain using the chain-prev and chain-next functions,
- which are by default bound to the left and right arrows and to the h and l keys
- (think vi keyboard bindings). To insert a remailer at the current chain posi-
- tion, use the insert function. To append a remailer behind the current chain
- position, use select-entry or append. You can also delete entries from the
- chain, using the corresponding function. Finally, to abandon your changes,
- leave the menu, or accept them pressing (by default) the Return key.
+ When you've finished entering your message, save it and quit your editor. Mutt-ng will then present you with a summary screen, the compose menu. On the top, you see a summary of the most important available key commands. Below that, you see the sender, the recipient(s), Cc and/or Bcc recipient(s), the subject, the reply-to address, and optionally information where the sent email will be stored and whether it should be digitally signed and/or encrypted.
- Note that different remailers do have different capabilities, indicated in the
- %c entry of the remailer menu lines (see _\b$_\bm_\bi_\bx_\b__\be_\bn_\bt_\br_\by_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.146 ,
- page 125)). Most important is the ``middleman'' capability, indicated by a
- capital ``M'': This means that the remailer in question cannot be used as the
- final element of a chain, but will only forward messages to other mixmaster
- remailers. For details on the other capabilities, please have a look at the
- mixmaster documentation.
+ Below that, you see a list of "attachments". The mail you've just entered before is also an attachment, but due to its special type (it's plain text), it will be displayed as the normal message on the receiver's side.
- _\b2_\b._\b7 _\bF_\bo_\br_\bw_\ba_\br_\bd_\bi_\bn_\bg _\ba_\bn_\bd _\bB_\bo_\bu_\bn_\bc_\bi_\bn_\bg _\bM_\ba_\bi_\bl
+ At this point, you can add more attachments, pressing a, you can edit the recipient addresses, pressing t for the "To:" field, c for the "Cc:" field, and b for the "Bcc: field. You can also edit the subject the subject by simply pressing s or the email message that you've entered before by pressing e. You will then again return to the editor. You can even edit the sender, by pressing <esc>f, but this shall only be used with caution.
- The Mutt Next Generation E-Mail Client 20
+ Alternatively, you can configure mutt-ng in a way that most of the above settings can be edited using the editor. Therefore, you only need to add the following to your configuration:
+set edit_headers
- Often, it is necessary to forward mails to other people. Therefore, mutt-ng
- supports forwarding messages in two different ways.
+ Once you have finished editing the body of your mail message, you are returned to the compose menu. The following options are available:
+a attach-file attach a file
+A attach-message attach message(s) to the message
+ESC k attach-key attach a PGP public key
+d edit-description edit description on attachment
+D detach-file detach a file
+t edit-to edit the To field
+ESC f edit-from edit the From field
+r edit-reply-to edit the Reply-To field
+c edit-cc edit the Cc field
+b edit-bcc edit the Bcc field
+y send-message send the message
+s edit-subject edit the Subject
+S smime-menu select S/MIME options
+f edit-fcc specify an ``Fcc'' mailbox
+p pgp-menu select PGP options
+P postpone-message postpone this message until later
+q quit quit (abort) sending the message
+w write-fcc write the message to a folder
+i ispell check spelling (if available on your system)
+^F forget-passphrase wipe passphrase(s) from memory
- The first one is regular forwarding, as you probably know it from other mail
- clients. You simply press f, 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 message is separated from the rest of the message via the
- two following markers:
+ Note: The attach-message function will prompt you for a folder to attach messages from. You can now tag messages in that folder and they will be attached to the message you are sending. Note that certain operations like composing a new mail, replying, forwarding, etc. are not permitted when you are in that folder. The %r in status-format will change to a 'A' to indicate that you are in attach-message mode.
- ----- Forwarded message from Lucas User <luser@example.com> -----
+6.2. Replying
- From: Lucas User <luser@example.com>
- Date: Thu, 02 Dec 2004 03:08:34 +0100
- To: Michael Random <mrandom@example.com>
- Subject: Re: blackmail
+6.2.1. Simple Replies
- Pay me EUR 50,000.- cash or your favorite stuffed animal will die
- a horrible death.
+ When you want to reply to an email message, select it in the index menu and then press r. 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 the editor with the quote attribution and the quoted message. This can e.g. look like the example below.
+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.
- ----- End forwarded message -----
+ You can start editing the email message. It is strongly recommended to put your answer below the quoted text and to only quote what is really necessary and that you refer to. Putting your answer on top of the quoted message, is, although very widespread, very often not considered to be a polite way to answer emails.
- When you're done with editing the mail, save and quit the editor, and you will
- return to the compose menu, the same menu you also encounter when composing or
- replying to mails.
+ The quote attribution is configurable, by default it is set to
+set attribution = "On %d, %n wrote:"
- The second mode of forwarding emails with mutt-ng is the so-called _\bb_\bo_\bu_\bn_\bc_\bi_\bn_\bg:
- when you bounce an email to another address, it will be sent in practically the
- same format you send it (except for headers that are created during transport-
- ing the message). To bounce a message, press b 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 with yes, the message will
- then be bounced.
+ It can also be set to something more compact, e.g.
+set attribution = "attribution="* %n <%a> [%(%y-%m-%d %H:%M)]:"
- To the recipient, the bounced email will look as if he got it like a regular
- email where he was Bcc: recipient. The only possibility to find out whether it
- was a bounced email is to carefully study the email headers and to find out
- which host really sent the email.
+ The example above results in the following attribution:
+* 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.
- _\b2_\b._\b8 _\bP_\bo_\bs_\bt_\bp_\bo_\bn_\bi_\bn_\bg _\bM_\ba_\bi_\bl
+ Generally, try to keep your attribution short yet information-rich. It is not the right place for witty quotes, long "attribution" novels or anything like that: the right place for such things is - if at all - the email signature at the very bottom of the message.
- At times it is desirable to delay sending a message that you have already begun
- to compose. When the _\bp_\bo_\bs_\bt_\bp_\bo_\bn_\be_\b-_\bm_\be_\bs_\bs_\ba_\bg_\be function is used in the _\bc_\bo_\bm_\bp_\bo_\bs_\be menu,
- the body of your message and attachments are stored in the mailbox specified by
- the _\b$_\bp_\bo_\bs_\bt_\bp_\bo_\bn_\be_\bd (section 7.4.230 , page 145) variable. This means that you can
- recall the message even if you exit Mutt-ng and then restart it at a later
- time.
+ When you're done with writing your message, save and quit the editor. As before, you will return to the compose menu, which is used in the same way as before.
- Once a message is postponed, there are several ways to resume it. From the
- command line you can use the ``-p'' option, or if you _\bc_\bo_\bm_\bp_\bo_\bs_\be a new message
+6.2.2. Group Replies
- The Mutt Next Generation E-Mail Client 21
+ 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 functionality ensures that when you press g instead of r 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.
- from the _\bi_\bn_\bd_\be_\bx or _\bp_\ba_\bg_\be_\br you will be prompted if postponed messages exist. If
- multiple messages are currently postponed, the _\bp_\bo_\bs_\bt_\bp_\bo_\bn_\be_\bd menu will pop up and
- you can select which message you would like to resume.
+6.2.3. List Replies
- N\bNo\bot\bte\be:\b: If you postpone a reply to a message, the reply setting of the message is
- only updated when you actually finish the message and send it. Also, you must
- be in the same folder with the message you replied to for the status of the
- message to be updated.
+ When you use mailing lists, it's generally better to send your reply to a message only to the list instead of the list and the original author. To make this easy to use, mutt-ng features list replies.
- See also the _\b$_\bp_\bo_\bs_\bt_\bp_\bo_\bn_\be (section 7.4.229 , page 145) quad-option.
+ To do a list reply, simply press L. If the email contains a Mail-Followup-To: header, its value will be used as reply address. Otherwise, mutt-ng searches through all mail addresses in the original message and tries to match them a list of regular expressions which can be specified using the lists command. If any of the regular expression matches, a mailing list address has been found, and it will be used as reply address.
+lists linuxevent@luga\.at vuln-dev@ mutt-ng-users@
- _\b3_\b. _\bC_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn
+ Nowadays, most mailing list software like GNU Mailman adds a Mail-Followup-To: header to their emails anyway, so setting lists is hardly ever necessary in practice.
- _\b3_\b._\b1 _\bL_\bo_\bc_\ba_\bt_\bi_\bo_\bn_\bs _\bo_\bf _\bC_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn _\bF_\bi_\bl_\be_\bs
+6.3. Editing the message header
- While the default configuration (or ``preferences'') make Mutt-ng usable right
- out of the box, it is often desirable to tailor Mutt-ng to suit your own
- tastes. When Mutt-ng is first invoked, it will attempt to read the ``system''
- configuration file (defaults set by your local system administrator), unless
- the ``-n'' _\bc_\bo_\bm_\bm_\ba_\bn_\bd _\bl_\bi_\bn_\be (section 7.1 , page 83) option is specified. This
- file is typically /usr/local/share/muttng/Muttngrc or /etc/Muttngrc, Mutt-ng
- users will find this file in /usr/local/share/muttng/Muttrc or /etc/Muttngrc.
- Mutt will next look for a file named .muttrc in your home directory, Mutt-ng
- will look for .muttngrc. If this file does not exist and your home directory
- has a subdirectory named .mutt, mutt try to load a file named .muttng/muttngrc.
+ When editing the header of your outgoing message, there are a couple of special features available.
- .muttrc (or .muttngrc for Mutt-ng) is the file where you will usually place
- your _\bc_\bo_\bm_\bm_\ba_\bn_\bd_\bs (section 7.3 , page 86) to configure Mutt-ng.
+ If you specify Fcc: filename Mutt-ng will pick up filename just as if you had used the edit-fcc function in the compose menu.
- _\b3_\b._\b2 _\bB_\ba_\bs_\bi_\bc _\bS_\by_\bn_\bt_\ba_\bx _\bo_\bf _\bI_\bn_\bi_\bt_\bi_\ba_\bl_\bi_\bz_\ba_\bt_\bi_\bo_\bn _\bF_\bi_\bl_\be_\bs
+ You can also attach files to your message by specifying Attach: filename [ description ] where filename is the file to attach and description is an optional string to use as the description of the attached file.
- An initialization file consists of a series of _\bc_\bo_\bm_\bm_\ba_\bn_\bd_\bs (section 7.3 , page
- 86). Each line of the file may contain one or more commands. When multiple
- commands are used, they must be separated by a semicolon (;).
+ When replying to messages, if you remove the In-Reply-To: field from the header field, Mutt-ng will not generate a References: field, which allows you to create a new message thread.
- set realname='Mutt-ng user' ; ignore x-
+ Also see edit-headers.
- The hash mark, or pound sign (``#''), is used as a ``comment'' character. You
- can use it to annotate your initialization file. All text after the comment
- character to the end of the line is ignored. For example,
+6.4. Using Mutt-ng with PGP
- my_hdr X-Disclaimer: Why are you listening to me? # This is a comment
+ If you want to use PGP, you can specify
- Single quotes (') and double quotes (') can be used to quote strings which
+ Pgp: [ E | S | S<id> ]
- The Mutt Next Generation E-Mail Client 22
+ ``E'' encrypts, ``S'' signs and ``S<id>'' signs with the given key, setting pgp-sign-as permanently.
- contain spaces or other special characters. The difference between the two
- types of quotes is similar to that of many popular shell programs, namely that
- a single quote is used to specify a literal string (one that is not interpreted
- for shell variables or quoting with a backslash [see next paragraph]), while
- double quotes indicate a string for which should be evaluated. For example,
- backtics are evaluated inside of double quotes, but n\bno\bot\bt for single quotes.
+ If you have told mutt to PGP encrypt a message, it will guide you through a key selection process when you try to send the message. Mutt-ng will not ask you any questions about keys which have a certified user ID matching one of the message recipients' mail addresses. However, there may be situations in which there are several keys, weakly certified user ID fields, or where no matching keys can be found.
- \ quotes the next character, just as in shells such as bash and zsh. For exam-
- ple, if want to put quotes ``''' inside of a string, you can use ``\'' to force
- the next character to be a literal instead of interpreted character.
+ 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 ^G. When you do so, mutt will return to the compose screen.
- set realname="Michael \"MuttDude\" Elkins"
+ Once you have successfully finished the key selection, the message will be encrypted using the selected public keys, and sent out.
- ``\\'' means to insert a literal ``\'' into the line. ``\n'' and ``\r'' have
- their usual C meanings of linefeed and carriage-return, respectively.
+ Most fields of the entries in the key selection menu (see also pgp-entry-format) have obvious meanings. But some explanations on the capabilities, flags, and validity fields are in order.
- 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.
+ The flags sequence (%f) will expand to one of the following flags:
+R The key has been revoked and can't be used.
+X The key is expired and can't be used.
+d You have marked the key as disabled.
+c There are unknown critical self-signature
+ packets.
- 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 ``#''.
+ The capabilities field (%c) expands to a two-character sequence representing a key's capabilities. The first character gives the key's encryption capabilities: A minus sign (-) means that the key cannot be used for encryption. A dot (.) means that it's marked as a signature key in one of the user IDs, but may also be used for encryption. The letter e indicates that this key can be used for encryption.
- # folder-hook . \
- set realname="Michael \"MuttDude\" Elkins"
+ The second character indicates the key's signing capabilities. Once again, a ``-'' implies ``not for signing'', ``.'' implies that the key is marked as an encryption key in one of the user-ids, and ``s'' denotes a key which can be used for signing.
- When testing your config files, beware the following caveat. The backslash 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 part of a comment and
- therefore are ignored, too. So take care of comments when continuation lines
- are involved within your setup files!
+ Finally, the validity field (%t) indicates how well-certified a user-id is. A question mark (?) indicates undefined validity, a minus character (-) marks an untrusted association, a space character means a partially trusted association, and a plus character (+) indicates complete validity.
- Abstract example:
+6.5. Sending anonymous messages via mixmaster
- line1\
- line2a # line2b\
- line3\
- line4
- line5
+ You may also have configured mutt to co-operate with Mixmaster, an anonymous remailer. Mixmaster permits you to send your messages anonymously using a chain of remailers. Mixmaster support in mutt is for mixmaster version 2.04 (beta 45 appears to be the latest) and 2.03. It does not support earlier versions or the later so-called version 3 betas, of which the latest appears to be called 2.9b23.
- 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.
+ To use it, you'll have to obey certain restrictions. Most important, you cannot use the Cc and Bcc headers. To tell Mutt-ng to use mixmaster, you have to select a remailer chain, using the mix function on the compose menu.
- The commands understood by mutt are explained in the next paragraphs. For a
- complete list, see the _\bc_\bo_\bm_\bm_\ba_\bn_\bd _\br_\be_\bf_\be_\br_\be_\bn_\bc_\be (section 7.3 , page 86).
+ The chain selection screen is divided into two parts. In the (larger) upper part, you get a list of remailers you may use. In the lower part, you see the currently selected chain of remailers.
- The Mutt Next Generation E-Mail Client 23
+ You can navigate in the chain using the chain-prev and chain-next functions, which are by default bound to the left and right arrows and to the h and l keys (think vi keyboard bindings). To insert a remailer at the current chain position, use the insert function. To append a remailer behind the current chain position, use select-entry or append. You can also delete entries from the chain, using the corresponding function. Finally, to abandon your changes, leave the menu, or accept them pressing (by default) the Return key.
- _\b3_\b._\b3 _\bE_\bx_\bp_\ba_\bn_\bs_\bi_\bo_\bn _\bw_\bi_\bt_\bh_\bi_\bn _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be_\bs
+ Note that different remailers do have different capabilities, indicated in the %c entry of the remailer menu lines (see mix-entry-format). Most important is the ``middleman'' capability, indicated by a capital ``M'': This means that the remailer in question cannot be used as the final element of a chain, but will only forward messages to other mixmaster remailers. For details on the other capabilities, please have a look at the mixmaster documentation.
- Besides just assign static content to variables, there's plenty of ways of
- adding external and more or less dynamic content.
+7. Forwarding and Bouncing Mail
- _\b3_\b._\b3_\b._\b1 _\bC_\bo_\bm_\bm_\ba_\bn_\bd_\bs_\b' _\bO_\bu_\bt_\bp_\bu_\bt
+ Often, it is necessary to forward mails to other people. Therefore, mutt-ng supports forwarding messages in two different ways.
- It is possible to substitute the output of a Unix command in an initialization
- file. This is accomplished by enclosing the command in backquotes (``) as in,
- for example:
+ The first one is regular forwarding, as you probably know it from other mail clients. You simply press f, 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 message is separated from the rest of the message via the two following markers:
+----- Forwarded message from Lucas User <luser@example.com> -----
- my_hdr X-Operating-System: `uname -a`
+From: Lucas User <luser@example.com>
+Date: Thu, 02 Dec 2004 03:08:34 +0100
+To: Michael Random <mrandom@example.com>
+Subject: Re: blackmail
- The output of the Unix command ``uname -a'' will be substituted before the line
- is parsed. Note that since initialization files are line oriented, only the
- first line of output from the Unix command will be substituted.
+Pay me EUR 50,000.- cash or your favorite stuffed animal will die
+a horrible death.
- _\b3_\b._\b3_\b._\b2 _\bE_\bn_\bv_\bi_\br_\bo_\bn_\bm_\be_\bn_\bt _\bV_\ba_\br_\bi_\ba_\bb_\bl_\be_\bs
- 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,
+----- End forwarded message -----
- set record=+sent_on_$HOSTNAME
+ When you're done with editing the mail, save and quit the editor, and you will return to the compose menu, the same menu you also encounter when composing or replying to mails.
- sets the _\b$_\br_\be_\bc_\bo_\br_\bd (section 7.4.246 , page 148) variable to the string _\b+_\bs_\be_\bn_\bt_\b__\bo_\bn_\b_
- and appends the value of the evironment variable $HOSTNAME.
+ The second mode of forwarding emails with mutt-ng is the so-called bouncing: when you bounce an email to 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 b 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 with yes, the message will then be bounced.
- N\bNo\bot\bte\be:\b: There will be no warning if an environment variable is not defined. The
- result will of the expansion will then be empty.
+ To the recipient, the bounced email will look as if he got it like a regular email where he was Bcc: recipient. The only possibility to find out whether it was a bounced email is to carefully study the email headers and to find out which host really sent the email.
- _\b3_\b._\b3_\b._\b3 _\bC_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn _\bV_\ba_\br_\bi_\ba_\bb_\bl_\be_\bs
+8. Postponing Mail
- As for environment variables, the values of all configuration variables as
- string can be used in the same way, too. For example,
+ At times it is desirable to delay sending a message that you have already begun to compose. When the postpone-message function is used in the compose menu, the body of your message and attachments are stored in the mailbox specified by the postponed variable. This means that you can recall the message even if you exit Mutt-ng and then restart it at a later time.
- set imap_home_namespace = $folder
+ Once a message is postponed, there are several ways to resume it. From the command line you can use the ``-p'' option, or if you compose a new message from the index or pager you will be prompted if postponed messages exist. If multiple messages are currently postponed, the postponed menu will pop up and you can select which message you would like to resume.
- would set the value of _\b$_\bi_\bm_\ba_\bp_\b__\bh_\bo_\bm_\be_\b__\bn_\ba_\bm_\be_\bs_\bp_\ba_\bc_\be (section 7.4.101 , page 113) to
- the value to which _\b$_\bf_\bo_\bl_\bd_\be_\br (section 7.4.70 , page 105) is _\bc_\bu_\br_\br_\be_\bn_\bt_\bl_\by set to.
+ Note: If you postpone a reply to a message, the reply setting of the message is only updated when you actually finish the message and send it. Also, you must be in the same folder with the message you replied to for the status of the message to be updated.
- N\bNo\bot\bte\be:\b: There're no logical links established in such cases so that the the value
- for _\b$_\bi_\bm_\ba_\bp_\b__\bh_\bo_\bm_\be_\b__\bn_\ba_\bm_\be_\bs_\bp_\ba_\bc_\be (section 7.4.101 , page 113) won't change even if
- _\b$_\bf_\bo_\bl_\bd_\be_\br (section 7.4.70 , page 105) gets changed.
+ See also the postpone quad-option.
- N\bNo\bot\bte\be:\b: There will be no warning if a configuration variable is not defined or is
- empty. The result will of the expansion will then be empty.
+Chapter 3. Configuration
- The Mutt Next Generation E-Mail Client 24
+ Table of Contents
- _\b3_\b._\b3_\b._\b4 _\bS_\be_\bl_\bf_\b-_\bD_\be_\bf_\bi_\bn_\be_\bd _\bV_\ba_\br_\bi_\ba_\bb_\bl_\be_\bs
+ 1. Locations of Configuration Files
+ 2. Basic Syntax of Initialization Files
+ 3. Expansion within variables
- 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
- user_ and can be used just like any ordinary configuration or environment vari-
- able.
+ 3.1. Commands' Output
+ 3.2. Environment Variables
+ 3.3. Configuration Variables
+ 3.4. Self-Defined Variables
+ 3.5. Pre-Defined Variables
+ 3.6. Type Conversions
- For example, to view the manual, users can either define two macros like the
- following
+ 4. Defining/Using aliases
+ 5. Changing the default key bindings
+ 6. Defining aliases for character sets
+ 7. Setting variables based upon mailbox
+ 8. Keyboard macros
+ 9. Using color and mono video attributes
+ 10. Ignoring (weeding) unwanted message headers
+ 11. Alternative addresses
+ 12. Format = Flowed
- macro generic <F1> "!less -r /path/to/manual" "Show manual"
- macro pager <F1> "!less -r /path/to/manual" "Show manual"
+ 12.1. Introduction
+ 12.2. Receiving: Display Setup
+ 12.3. Sending
+ 12.4. Additional Notes
- for generic, pager and index. The alternative is to define a custom variable
- like so:
+ 13. Mailing lists
+ 14. Using Multiple spool mailboxes
+ 15. Defining mailboxes which receive mail
+ 16. User defined headers
+ 17. Defining the order of headers when viewing messages
+ 18. Specify default save filename
+ 19. Specify default Fcc: mailbox when composing
+ 20. Specify default save filename and default Fcc: mailbox at once
+ 21. Change settings based upon message recipients
+ 22. Change settings before formatting a message
+ 23. Choosing the cryptographic key of the recipient
+ 24. Adding key sequences to the keyboard buffer
+ 25. Executing functions
+ 26. Message Scoring
+ 27. Spam detection
+ 28. Setting variables
+ 29. Reading initialization commands from another file
+ 30. Removing hooks
+ 31. Sharing Setups
- 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"
+ 31.1. Character Sets
+ 31.2. Modularization
+ 31.3. Conditional parts
- to re-use the command sequence as in:
+ 32. Obsolete Variables
- macro index <F2> "$user_manualcmd | grep '\^[ ]\\+~. '" "Show Patterns"
+1. Locations of Configuration Files
- Using this feature, arbitrary sequences can be defined once and recalled and
- reused where necessary. More advanced scenarios could include to save a vari-
- able's value at the beginning of macro sequence and restore it at end.
+ While the default configuration (or ``preferences'') make Mutt-ng usable right out of the box, it is often desirable to tailor Mutt-ng to suit your own tastes. When Mutt-ng is first invoked, it will attempt to read the ``system'' configuration file (defaults set by your local system administrator), unless the ``-n'' commandline option is specified. This file is typically /usr/local/share/muttng/Muttngrc or /etc/Muttngrc, Mutt-ng users will find this file in /usr/local/share/muttng/Muttrc or /etc/Muttngrc. Mutt will next look for a file named .muttrc in your home directory, Mutt-ng will look for .muttngrc. If this file does not exist and your home directory has a subdirectory named .mutt, mutt try to load a file named .muttng/muttngrc.
- When the variable is first defined, the first value it gets assigned is also
- the initial value to which it can be reset using the reset command.
+ .muttrc (or .muttngrc for Mutt-ng) is the file where you will usually place your commands to configure Mutt-ng.
- The complete removal is done via the unset keyword.
+2. Basic Syntax of Initialization Files
- After the following sequence:
+ An initialization file consists of a series of commands. Each line of the file may contain one or more commands. When multiple commands are used, they must be separated by a semicolon (;).
+set realname='Mutt-ng user' ; ignore x-
- set user_foo = 42
- set user_foo = 666
+ The hash mark, or pound sign (``#''), is used as a ``comment'' character. You can use it to annotate your initialization file. All text after the comment character to the end of the line is ignored. For example,
+my_hdr X-Disclaimer: Why are you listening to me? # This is a comment
- the variable $user_foo has a current value of 666 and an initial of 42. The
- query
+ Single quotes (') and double quotes (") can be used to quote strings which contain spaces or other special characters. The difference between the two types of quotes is similar to that of many popular shell programs, namely that a single quote is used to specify a literal string (one that is not interpreted for shell variables or quoting with a backslash [see next paragraph]), while double quotes indicate a string for which should be evaluated. For example, backtics are evaluated inside of double quotes, but not for single quotes.
- set ?user_foo
+ \ 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 interpreted character.
+set realname="Michael \"MuttDude\" Elkins"
- The Mutt Next Generation E-Mail Client 25
+ ``\\'' means to insert a literal ``\'' into the line. ``\n'' and ``\r'' have their usual C meanings of linefeed and carriage-return, respectively.
- will show 666. After doing the reset via
+ 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.
- reset user_foo
+ 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 ``#''.
+# folder-hook . \
+ set realname="Michael \"MuttDude\" Elkins"
- a following query will give 42 as the result. After unsetting it via
+ When testing your config files, beware the following caveat. The backslash 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 part of a comment and therefore are ignored, too. So take care of comments when continuation lines are involved within your setup files!
- unset user_foo
+ Abstract example:
+line1\
+line2a # line2b\
+line3\
+line4
+line5
- any query or operation (except the noted expansion within other statements)
- will lead to an error message.
+ 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.
- _\b3_\b._\b3_\b._\b5 _\bP_\br_\be_\b-_\bD_\be_\bf_\bi_\bn_\be_\bd _\bV_\ba_\br_\bi_\ba_\bb_\bl_\be_\bs
+ The commands understood by mutt are explained in the next paragraphs. For a complete list, see the commands.
- 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 vari-
- ables. These are prefixed with muttng_ and are read-only, i.e. they cannot be
- set, unset or reset. The reference chapter lists all available variables.
+3. Expansion within variables
- _\bP_\bl_\be_\ba_\bs_\be _\bc_\bo_\bn_\bs_\bu_\bl_\bt _\bt_\bh_\be _\bl_\bo_\bc_\ba_\bl _\bc_\bo_\bp_\by _\bo_\bf _\by_\bo_\bu_\br _\bm_\ba_\bn_\bu_\ba_\bl _\bf_\bo_\br _\bt_\bh_\be_\bi_\br _\bv_\ba_\bl_\bu_\be_\bs _\ba_\bs _\bt_\bh_\be_\by _\bm_\ba_\by _\bd_\bi_\bf_\b-
- _\bf_\be_\br _\bf_\br_\bo_\bm _\bd_\bi_\bf_\bf_\be_\br_\be_\bn_\bt _\bm_\ba_\bn_\bu_\ba_\bl _\bs_\bo_\bu_\br_\bc_\be_\bs_\b. Where the manual is installed in can be
- queried (already using such a variable) by running:
+ Besides just assign static content to variables, there's plenty of ways of adding external and more or less dynamic content.
- muttng -Q muttng_docdir
+3.1. Commands' Output
- To extend the example for viewing the manual via self-defined variables, it can
- be made more readable and more portable by changing the real path in:
+ It is possible to substitute the output of a Unix command in an initialization file. This is accomplished by enclosing the command in backquotes (``) as in, for example:
+my_hdr X-Operating-System: `uname -a`
- set user_manualcmd = '!less -r /path/to_manual'
+ The output of the Unix command ``uname -a'' will be substituted before the line is parsed. Note that since initialization files are line oriented, only the first line of output from the Unix command will be substituted.
- to:
+3.2. Environment Variables
- set user_manualcmd = "!less -r $muttng_docdir/manual.txt"
+ 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,
+set record=+sent_on_$HOSTNAME
- which works everywhere if a manual is installed.
+ sets the record variable to the string +sent_on_ and appends the value of the evironment variable $HOSTNAME.
- Please note that by the type of quoting, muttng determines when to expand these
- values: when it finds double quotes, the value will be expanded during reading
- the setup files but when it finds single quotes, it'll expand it at runtime as
- needed.
+ Note: There will be no warning if an environment variable is not defined. The result will of the expansion will then be empty.
- For example, the statement
+3.3. Configuration Variables
- folder-hook . "set user_current_folder = $muttng_folder_name"
+ As for environment variables, the values of all configuration variables as string can be used in the same way, too. For example,
+set imap_home_namespace = $folder
- The Mutt Next Generation E-Mail Client 26
+ would set the value of imap-home-namespace to the value to which folder is currently set to.
- will be already be translated to the following when reading the startup files:
+ Note: There're no logical links established in such cases so that the the value for imap-home-namespace won't change even if folder gets changed.
- folder-hook . "set user_current_folder = some_folder"
+ Note: There will be no warning if a configuration variable is not defined or is empty. The result will of the expansion will then be empty.
- with some_folder being the name of the first folder muttng opens. On the con-
- trary,
+3.4. Self-Defined Variables
- folder-hook . 'set user_current_folder = $muttng_folder_name'
+ 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 user_ and can be used just like any ordinary configuration or environment variable.
- will be executed at runtime because of the single quotes so that user_cur-
- rent_folder will always have the value of the currently opened folder.
+ For example, to view the manual, users can either define two macros like the following
+macro generic <F1> "!less -r /path/to/manual" "Show manual"
+macro pager <F1> "!less -r /path/to/manual" "Show manual"
- A more practical example is:
+ for generic, pager and index. The alternative is to define a custom variable like so:
+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"
- folder-hook . 'source ~/.mutt/score-$muttng_folder_name'
+ to re-use the command sequence as in:
+macro index <F2> "$user_manualcmd | grep '\^[ ]\\+~. '" "Show Patterns"
- which can be used to source files containing score commands depending on the
- folder the user enters.
+ Using this feature, arbitrary sequences can be defined once and recalled and reused where necessary. More advanced scenarios could include to save a variable's value at the beginning of macro sequence and restore it at end.
- _\b3_\b._\b3_\b._\b6 _\bT_\by_\bp_\be _\bC_\bo_\bn_\bv_\be_\br_\bs_\bi_\bo_\bn_\bs
+ When the variable is first defined, the first value it gets assigned is also the initial value to which it can be reset using the reset command.
- A note about variable's types during conversion: internally values are stored
- in internal types but for any dump/query or set operation they're converted to
- and from string. That means that there's no need to worry about types when ref-
- erencing any variable. As an example, the following can be used without harm
- (besides makeing muttng very likely behave strange):
+ The complete removal is done via the unset keyword.
- set read_inc = 100
- set folder = $read_inc
- set read_inc = $folder
- set user_magic_number = 42
- set folder = $user_magic_number
+ After the following sequence:
+set user_foo = 42
+set user_foo = 666
- _\b3_\b._\b4 _\bD_\be_\bf_\bi_\bn_\bi_\bn_\bg_\b/_\bU_\bs_\bi_\bn_\bg _\ba_\bl_\bi_\ba_\bs_\be_\bs
+ the variable $user_foo has a current value of 666 and an initial of 42. The query
+set ?user_foo
- Usage: alias _\bk_\be_\by _\ba_\bd_\bd_\br_\be_\bs_\bs [ , _\ba_\bd_\bd_\br_\be_\bs_\bs, ... ]
+ will show 666. After doing the reset via
+reset user_foo
- It's usually very cumbersome to remember or type out the address of someone you
- are communicating with. Mutt-ng allows you to create ``aliases'' which map a
- short string to a full address.
+ a following query will give 42 as the result. After unsetting it via
+unset user_foo
- N\bNo\bot\bte\be:\b: if you want to create an alias for a group (by specifying more than one
- address), you m\bmu\bus\bst\bt separate the addresses with a comma (``,'').
+ any query or operation (except the noted expansion within other statements) will lead to an error message.
- To remove an alias or aliases (``*'' means all aliases):
+3.5. Pre-Defined Variables
- The Mutt Next Generation E-Mail Client 27
+ 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 muttng_ and are read-only, i.e. they cannot be set, unset or reset. The reference chapter lists all available variables.
- unalias [ * | _\bk_\be_\by _\b._\b._\b. ]
+ Please consult the local copy of your manual for their values as they may differ from different manual sources. Where the manual is installed in can be queried (already using such a variable) by running:
+muttng -Q muttng_docdir
- alias muttdude me@cs.hmc.edu (Michael Elkins)
- alias theguys manny, moe, jack
+ To extend the example for viewing the manual via self-defined variables, it can be made more readable and more portable by changing the real path in:
+set user_manualcmd = '!less -r /path/to_manual'
- Unlike other mailers, Mutt-ng doesn't require aliases to be defined in a spe-
- cial file. The alias command can appear anywhere in a configuration file, as
- long as this file is _\bs_\bo_\bu_\br_\bc_\be_\bd (section 3.29 , page 46). Consequently, you can
- have multiple alias files, or you can have all aliases defined in your muttrc.
+ to:
+set user_manualcmd = "!less -r $muttng_docdir/manual.txt"
- On the other hand, the _\bc_\br_\be_\ba_\bt_\be_\b-_\ba_\bl_\bi_\ba_\bs (section 2.5.4 , page 11) function can use
- only one file, the one pointed to by the _\b$_\ba_\bl_\bi_\ba_\bs_\b__\bf_\bi_\bl_\be (section 7.4.5 , page 90)
- variable (which is ~/.muttrc 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 _\bs_\bo_\bu_\br_\bc_\be (section
- 3.29 , page 46) this file too.
+ which works everywhere if a manual is installed.
- For example:
+ Please note that by the type of quoting, muttng determines when to expand these values: when it finds double quotes, the value will be expanded during reading the setup files but when it finds single quotes, it'll expand it at runtime as needed.
- source /usr/local/share/Mutt-ng.aliases
- source ~/.mail_aliases
- set alias_file=~/.mail_aliases
+ For example, the statement
+folder-hook . "set user_current_folder = $muttng_folder_name"
- To use aliases, you merely use the alias at any place in mutt where mutt
- prompts for addresses, such as the _\bT_\bo_\b: or _\bC_\bc_\b: prompt. You can also enter
- aliases in your editor at the appropriate headers if you have the _\b$_\be_\bd_\bi_\bt_\b__\bh_\be_\ba_\bd_\be_\br_\bs
- (section 7.4.59 , page 103) variable set.
+ will be already be translated to the following when reading the startup files:
+folder-hook . "set user_current_folder = some_folder"
- In addition, at the various address prompts, you can use the tab character to
- expand a partial alias to the full alias. If there are multiple matches, mutt
- will bring up a menu with the matching aliases. In order to be presented with
- the full list of aliases, you must hit tab with out a partial alias, such as at
- the beginning of the prompt or after a comma denoting multiple addresses.
+ with some_folder being the name of the first folder muttng opens. On the contrary,
+folder-hook . 'set user_current_folder = $muttng_folder_name'
- In the alias menu, you can select as many aliases as you want with the _\bs_\be_\bl_\be_\bc_\bt_\b-
- _\be_\bn_\bt_\br_\by key (default: RET), and use the _\be_\bx_\bi_\bt key (default: q) to return to the
- address prompt.
+ will be executed at runtime because of the single quotes so that user_current_folder will always have the value of the currently opened folder.
- _\b3_\b._\b5 _\bC_\bh_\ba_\bn_\bg_\bi_\bn_\bg _\bt_\bh_\be _\bd_\be_\bf_\ba_\bu_\bl_\bt _\bk_\be_\by _\bb_\bi_\bn_\bd_\bi_\bn_\bg_\bs
+ A more practical example is:
+folder-hook . 'source ~/.mutt/score-$muttng_folder_name'
- Usage: bind _\bm_\ba_\bp _\bk_\be_\by _\bf_\bu_\bn_\bc_\bt_\bi_\bo_\bn
+ which can be used to source files containing score commands depending on the folder the user enters.
- This command allows you to change the default key bindings (operation invoked
- when pressing a key).
+3.6. Type Conversions
- _\bm_\ba_\bp specifies in which menu the binding belongs. Multiple maps may be speci-
- fied by separating them with commas (no additional whitespace is allowed). The
- currently defined maps are:
+ A note about variable's types during conversion: internally values are stored in internal types but for any dump/query or set operation they're converted to and from string. That means that there's no need to worry about types when referencing any variable. As an example, the following can be used without harm (besides makeing muttng very likely behave strange):
+set read_inc = 100
+set folder = $read_inc
+set read_inc = $folder
+set user_magic_number = 42
+set folder = $user_magic_number
- The Mutt Next Generation E-Mail Client 28
+4. Defining/Using aliases
- generic
- This is not a real menu, but is used as a fallback for all of the
- other menus except for the pager and editor modes. If a key is not
- defined in another menu, Mutt-ng will look for a binding to use in
- this menu. This allows you to bind a key to a certain function in
- multiple menus instead of having multiple bind statements to accom-
- plish the same task.
+ Usage: alias key address [ , address, ... ]
- alias
- The alias menu is the list of your personal aliases as defined in
- your muttrc. It is the mapping from a short alias name to the full
- email address(es) of the recipient(s).
+ It's usually very cumbersome to remember or type out the address of someone you are communicating with. Mutt-ng allows you to create ``aliases'' which map a short string to a full address.
- attach
- The attachment menu is used to access the attachments on received
- messages.
+ Note: if you want to create an alias for a group (by specifying more than one address), you must separate the addresses with a comma (``,'').
- browser
- The browser is used for both browsing the local directory struc-
- ture, and for listing all of your incoming mailboxes.
+ To remove an alias or aliases (``*'' means all aliases):
- editor
- The editor is the line-based editor the user enters text data.
+ unalias [ * | key ... ]
+alias muttdude me@cs.hmc.edu (Michael Elkins)
+alias theguys manny, moe, jack
- index
- The index is the list of messages contained in a mailbox.
+ Unlike other mailers, Mutt-ng doesn't require aliases to be defined in a special file. The alias command can appear anywhere in a configuration file, as long as this file is source. Consequently, you can have multiple alias files, or you can have all aliases defined in your muttrc.
- compose
- The compose menu is the screen used when sending a new message.
+ On the other hand, the create-alias function can use only one file, the one pointed to by the alias-file variable (which is ˜/.muttrc 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 source this file too.
- pager
- The pager is the mode used to display message/attachment data, and
- help listings.
+ For example:
+source /usr/local/share/Mutt-ng.aliases
+source ~/.mail_aliases
+set alias_file=~/.mail_aliases
- pgp
- The pgp menu is used to select the OpenPGP keys used for encrypting
- outgoing messages.
+ To use aliases, you merely use the alias at any place in mutt where mutt prompts for addresses, such as the To: or Cc: prompt. You can also enter aliases in your editor at the appropriate headers if you have the edit-headers variable set.
- postpone
- The postpone menu is similar to the index menu, except is used when
- recalling a message the user was composing, but saved until later.
+ In addition, at the various address prompts, you can use the tab character to expand a partial alias to the full alias. If there are multiple matches, mutt will bring up a menu with the matching aliases. In order to be presented with the full list of aliases, you must hit tab with out a partial alias, such as at the beginning of the prompt or after a comma denoting multiple addresses.
- _\bk_\be_\by is the key (or key sequence) you wish to bind. To specify a control char-
- acter, use the sequence _\b\_\bC_\bx, where _\bx is the letter of the control character
- (for example, to specify control-A use ``\Ca''). Note that the case of _\bx as
- well as _\b\_\bC is ignored, so that _\b\_\bC_\bA, _\b\_\bC_\ba, _\b\_\bc_\bA and _\b\_\bc_\ba are all equivalent. An
- alternative form is to specify the key as a three digit octal number prefixed
- with a ``\'' (for example _\b\_\b1_\b7_\b7 is equivalent to _\b\_\bc_\b?).
+ In the alias menu, you can select as many aliases as you want with the select-entry key (default: RET), and use the exit key (default: q) to return to the address prompt.
- In addition, _\bk_\be_\by may consist of:
+5. Changing the default key bindings
- The Mutt Next Generation E-Mail Client 29
-
- \t tab
- <tab> tab
- <backtab> backtab / shift-tab
- \r carriage return
- \n newline
- \e escape
- <esc> escape
- <up> up arrow
- <down> down arrow
- <left> left arrow
- <right> right arrow
- <pageup> Page Up
- <pagedown> Page Down
- <backspace> Backspace
- <delete> Delete
- <insert> Insert
- <enter> Enter
- <return> Return
- <home> Home
- <end> End
- <space> Space bar
- <f1> function key 1
- <f10> function key 10
+ Usage: bind map key function
- _\bk_\be_\by does not need to be enclosed in quotes unless it contains a space (`` '').
+ This command allows you to change the default key bindings (operation invoked when pressing a key).
- _\bf_\bu_\bn_\bc_\bt_\bi_\bo_\bn specifies which action to take when _\bk_\be_\by is pressed. For a complete
- list of functions, see the _\br_\be_\bf_\be_\br_\be_\bn_\bc_\be (section 7.5 , page 177). The special
- function noop unbinds the specified key sequence.
+ map specifies in which menu the binding belongs. Multiple maps may be specified by separating them with commas (no additional whitespace is allowed). The currently defined maps are:
- _\b3_\b._\b6 _\bD_\be_\bf_\bi_\bn_\bi_\bn_\bg _\ba_\bl_\bi_\ba_\bs_\be_\bs _\bf_\bo_\br _\bc_\bh_\ba_\br_\ba_\bc_\bt_\be_\br _\bs_\be_\bt_\bs
+ generic
+ This is not a real menu, but is used as a fallback for all of the other menus except for the pager and editor modes. If a key is not defined in another menu, Mutt-ng will look for a binding to use in this menu. This allows you to bind a key to a certain function in multiple menus instead of having multiple bind statements to accomplish the same task.
- Usage: charset-hook _\ba_\bl_\bi_\ba_\bs _\bc_\bh_\ba_\br_\bs_\be_\bt
+ alias
+ The alias menu is the list of your personal aliases as defined in your muttrc. It is the mapping from a short alias name to the full email address(es) of the recipient(s).
- Usage: iconv-hook _\bc_\bh_\ba_\br_\bs_\be_\bt _\bl_\bo_\bc_\ba_\bl_\b-_\bc_\bh_\ba_\br_\bs_\be_\bt
+ attach
+ The attachment menu is used to access the attachments on received messages.
- The charset-hook 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.
+ browser
+ The browser is used for both browsing the local directory structure, and for listing all of your incoming mailboxes.
- The iconv-hook command defines a system-specific name for a character set.
- This is helpful when your systems character conversion library insists on using
- strange, system-specific names for character sets.
+ editor
+ The editor is the line-based editor the user enters text data.
- _\b3_\b._\b7 _\bS_\be_\bt_\bt_\bi_\bn_\bg _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be_\bs _\bb_\ba_\bs_\be_\bd _\bu_\bp_\bo_\bn _\bm_\ba_\bi_\bl_\bb_\bo_\bx
+ index
+ The index is the list of messages contained in a mailbox.
- Usage: folder-hook [!]_\br_\be_\bg_\be_\bx_\bp _\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ compose
+ The compose menu is the screen used when sending a new message.
- It is often desirable to change settings based on which mailbox you are
+ pager
+ The pager is the mode used to display message/attachment data, and help listings.
- The Mutt Next Generation E-Mail Client 30
+ pgp
+ The pgp menu is used to select the OpenPGP keys used for encrypting outgoing messages.
- reading. The folder-hook command provides a method by which you can execute
- any configuration command. _\br_\be_\bg_\be_\bx_\bp is a regular expression specifying in which
- mailboxes to execute _\bc_\bo_\bm_\bm_\ba_\bn_\bd before loading. If a mailbox matches multiple
- folder-hook's, they are executed in the order given in the muttrc.
+ postpone
+ The postpone menu is similar to the index menu, except is used when recalling a message the user was composing, but saved until later.
- N\bNo\bot\bte\be:\b: if you use the ``!'' shortcut for _\b$_\bs_\bp_\bo_\bo_\bl_\bf_\bi_\bl_\be (section 7.4.313 , page
- 165) at the beginning of the pattern, you must place it inside of double or
- single quotes in order to distinguish it from the logical _\bn_\bo_\bt operator for the
- expression.
+ key is the key (or key sequence) you wish to bind. To specify a control character, use the sequence \Cx, where x is the letter of the control character (for example, to specify control-A use ``\Ca''). Note that the case of x as well as \C is ignored, so that \CA, \Ca, \cA and \ca are all equivalent. An alternative form is to specify the key as a three digit octal number prefixed with a ``\'' (for example \177 is equivalent to \c?).
- Note that the settings are _\bn_\bo_\bt restored when you leave the mailbox. For exam-
- ple, a command action to perform is to change the sorting method based upon the
- mailbox being read:
+ In addition, key may consist of:
+\t tab
+<tab> tab
+<backtab> backtab / shift-tab
+\r carriage return
+\n newline
+\e escape
+<esc> escape
+<up> up arrow
+<down> down arrow
+<left> left arrow
+<right> right arrow
+<pageup> Page Up
+<pagedown> Page Down
+<backspace> Backspace
+<delete> Delete
+<insert> Insert
+<enter> Enter
+<return> Return
+<home> Home
+<end> End
+<space> Space bar
+<f1> function key 1
+<f10> function key 10
- folder-hook mutt set sort=threads
+ key does not need to be enclosed in quotes unless it contains a space (`` '').
- However, the sorting method is not restored to its previous value when reading
- a different mailbox. To specify a _\bd_\be_\bf_\ba_\bu_\bl_\bt command, use the pattern ``.'':
+ function specifies which action to take when key is pressed. For a complete list of functions, see the functions. The special function noop unbinds the specified key sequence.
- folder-hook . set sort=date-sent
+6. Defining aliases for character sets
- _\b3_\b._\b8 _\bK_\be_\by_\bb_\bo_\ba_\br_\bd _\bm_\ba_\bc_\br_\bo_\bs
+ Usage: charset-hook alias charset Usage: iconv-hook charset local-charset
- Usage: macro _\bm_\be_\bn_\bu _\bk_\be_\by _\bs_\be_\bq_\bu_\be_\bn_\bc_\be [ _\bd_\be_\bs_\bc_\br_\bi_\bp_\bt_\bi_\bo_\bn ]
+ The charset-hook 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.
- Macros are useful when you would like a single key to perform a series of
- actions. When you press _\bk_\be_\by in menu _\bm_\be_\bn_\bu, Mutt-ng will behave as if you had
- typed _\bs_\be_\bq_\bu_\be_\bn_\bc_\be. So if you have a common sequence of commands you type, you can
- create a macro to execute those commands with a single key.
+ The iconv-hook command defines a system-specific name for a character set. This is helpful when your systems character conversion library insists on using strange, system-specific names for character sets.
- _\bm_\be_\bn_\bu is the _\bm_\ba_\bp (section 3.5 , page 28) which the macro will be bound. Multi-
- ple maps may be specified by separating multiple menu arguments by commas.
- Whitespace may not be used in between the menu arguments and the commas sepa-
- rating them.
+7. Setting variables based upon mailbox
- _\bk_\be_\by and _\bs_\be_\bq_\bu_\be_\bn_\bc_\be are expanded by the same rules as the _\bk_\be_\by _\bb_\bi_\bn_\bd_\bi_\bn_\bg_\bs (section
- 3.5 , page 27). There are some additions however. The first is that control
- characters in _\bs_\be_\bq_\bu_\be_\bn_\bc_\be can also be specified as _\b^_\bx. In order to get a caret
- (`^'') you need to use _\b^_\b^. Secondly, to specify a certain key such as _\bu_\bp or to
- invoke a function directly, you can use the format _\b<_\bk_\be_\by _\bn_\ba_\bm_\be_\b> and _\b<_\bf_\bu_\bn_\bc_\bt_\bi_\bo_\bn
- _\bn_\ba_\bm_\be_\b>. For a listing of key names see the section on _\bk_\be_\by _\bb_\bi_\bn_\bd_\bi_\bn_\bg_\bs (section
- 3.5 , page 27). Functions are listed in the _\bf_\bu_\bn_\bc_\bt_\bi_\bo_\bn _\br_\be_\bf_\be_\br_\be_\bn_\bc_\be (section
- 7.5 , page 177).
+ Usage: folder-hook [!]regexp command
- The advantage with using function names directly is that the macros will work
- regardless of the current key bindings, so they are not dependent on the user
- having particular key definitions. This makes them more robust and portable,
- and also facilitates defining of macros in files used by more than one user
+ It is often desirable to change settings based on which mailbox you are reading. The folder-hook command provides a method by which you can execute any configuration command. regexp is a regular expression specifying in which mailboxes to execute command before loading. If a mailbox matches multiple folder-hook's, they are executed in the order given in the muttrc.
- The Mutt Next Generation E-Mail Client 31
+ Note: if you use the ``!'' shortcut for 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 not operator for the expression.
- (eg. the system Muttngrc).
+ Note that the settings are not restored when you leave the mailbox. For example, a command action to perform is to change the sorting method based upon the mailbox being read:
+folder-hook mutt set sort=threads
- Optionally you can specify a descriptive text after _\bs_\be_\bq_\bu_\be_\bn_\bc_\be, which is shown in
- the help screens.
+ However, the sorting method is not restored to its previous value when reading a different mailbox. To specify a default command, use the pattern ``.'':
+folder-hook . set sort=date-sent
- N\bNo\bot\bte\be:\b: Macro definitions (if any) listed in the help screen(s), are silently
- truncated at the screen width, and are not wrapped.
+8. Keyboard macros
- _\b3_\b._\b9 _\bU_\bs_\bi_\bn_\bg _\bc_\bo_\bl_\bo_\br _\ba_\bn_\bd _\bm_\bo_\bn_\bo _\bv_\bi_\bd_\be_\bo _\ba_\bt_\bt_\br_\bi_\bb_\bu_\bt_\be_\bs
+ Usage: macro menu key sequence [ description ]
- Usage: color _\bo_\bb_\bj_\be_\bc_\bt _\bf_\bo_\br_\be_\bg_\br_\bo_\bu_\bn_\bd _\bb_\ba_\bc_\bk_\bg_\br_\bo_\bu_\bn_\bd [ _\br_\be_\bg_\be_\bx_\bp ]
+ Macros are useful when you would like a single key to perform a series of actions. When you press key in menu menu, Mutt-ng will behave as if you had typed sequence. So if you have a common sequence of commands you type, you can create a macro to execute those commands with a single key.
- Usage: color index _\bf_\bo_\br_\be_\bg_\br_\bo_\bu_\bn_\bd _\bb_\ba_\bc_\bk_\bg_\br_\bo_\bu_\bn_\bd _\bp_\ba_\bt_\bt_\be_\br_\bn
+ menu is the maps which the macro will be bound. Multiple maps may be specified by separating multiple menu arguments by commas. Whitespace may not be used in between the menu arguments and the commas separating them.
- Usage: uncolor index _\bp_\ba_\bt_\bt_\be_\br_\bn [ _\bp_\ba_\bt_\bt_\be_\br_\bn ... ]
+ key and sequence are expanded by the same rules as the bind. There are some additions however. The first is that control characters in sequence can also be specified as ^x. In order to get a caret (`^'') you need to use ^^. Secondly, to specify a certain key such as up or to invoke a function directly, you can use the format <key name> and <function name>. For a listing of key names see the section on bind. Functions are listed in the functions.
- If your terminal supports color, you can spice up Mutt-ng by creating your own
- color scheme. To define the color of an object (type of information), you must
- specify both a foreground color a\ban\bnd\bd a background color (it is not possible to
- only specify one or the other).
+ The advantage with using function names directly is that the macros will work regardless of the current key bindings, so they are not dependent on the user having particular key definitions. This makes them more robust and portable, and also facilitates defining of macros in files used by more than one user (eg. the system Muttngrc).
- _\bo_\bb_\bj_\be_\bc_\bt can be one of:
+ Optionally you can specify a descriptive text after sequence, which is shown in the help screens.
- +\bo attachment
+ Note: Macro definitions (if any) listed in the help screen(s), are silently truncated at the screen width, and are not wrapped.
- +\bo body (match _\br_\be_\bg_\be_\bx_\bp in the body of messages)
+9. Using color and mono video attributes
- +\bo bold (highlighting bold patterns in the body of messages)
+ Usage: color object foreground background [ regexp ] Usage: color index foreground background pattern Usage: uncolor index pattern [ pattern ... ]
- +\bo error (error messages printed by Mutt-ng)
+ If your terminal supports color, you can spice up Mutt-ng by creating your own color scheme. To define the color of an object (type of information), you must specify both a foreground color and a background color (it is not possible to only specify one or the other).
- +\bo header (match _\br_\be_\bg_\be_\bx_\bp in the message header)
+ object can be one of:
+ * attachment
+ * body (match regexp in the body of messages)
+ * bold (highlighting bold patterns in the body of messages)
+ * error (error messages printed by Mutt-ng)
+ * header (match regexp in the message header)
+ * hdrdefault (default color of the message header in the pager)
+ * index (match pattern in the message index)
+ * indicator (arrow or bar used to indicate the current item in a menu)
+ * markers (the ``+'' markers at the beginning of wrapped lines in the pager)
+ * message (informational messages)
+ * normal
+ * quoted (text matching quote-regexp in the body of a message)
+ * quoted1, quoted2, ..., quotedN (higher levels of quoting)
+ * search (highlighting of words in the pager)
+ * signature
+ * status (mode lines used to display info about the mailbox or message)
+ * tilde (the ``˜'' used to pad blank lines in the pager)
+ * tree (thread tree drawn in the message index and attachment menu)
+ * underline (highlighting underlined patterns in the body of messages)
- +\bo hdrdefault (default color of the message header in the pager)
+ foreground and background can be one of the following:
+ * white
+ * black
+ * green
+ * magenta
+ * blue
+ * cyan
+ * yellow
+ * red
+ * default
+ * colorx
- +\bo index (match _\bp_\ba_\bt_\bt_\be_\br_\bn in the message index)
+ foreground can optionally be prefixed with the keyword bright to make the foreground color boldfaced (e.g., brightred).
- +\bo indicator (arrow or bar used to indicate the current item in a menu)
+ If your terminal supports it, the special keyword default can be used as a transparent color. The value brightdefault is also valid. If Mutt-ng is linked against the S-Lang library, you also need to set the COLORFGBG environment variable to the default colors of your terminal for this to work; for example (for Bourne-like shells):
+set COLORFGBG="green;black"
+export COLORFGBG
- +\bo markers (the ``+'' markers at the beginning of wrapped lines in the pager)
+ Note: The S-Lang library requires you to use the lightgray and brown keywords instead of white and yellow when setting this variable.
- +\bo message (informational messages)
+ Note: The uncolor command can be applied to the index object only. It removes entries from the list. You must specify the same pattern specified in the color command for it to be removed. The pattern ``*'' is a special token which means to clear the color index list of all entries.
- +\bo normal
+ Mutt-ng also recognizes the keywords color0, color1, …, colorN-1 (N being the number of colors supported by your terminal). This is useful when you remap the colors for your display (for example by changing the color associated with color2 for your xterm), since color names may then lose their normal meaning.
- +\bo quoted (text matching _\b$_\bq_\bu_\bo_\bt_\be_\b__\br_\be_\bg_\be_\bx_\bp (section 7.4.241 , page 147) in the
- body of a message)
+ If your terminal does not support color, it is still possible change the video attributes through the use of the ``mono'' command:
- +\bo quoted1, quoted2, ..., quotedN\bN (higher levels of quoting)
+ Usage: mono <object> <attribute> [ regexp ] Usage: mono index attribute pattern Usage: unmono index pattern [ pattern ... ]
- +\bo search (highlighting of words in the pager)
+ where attribute is one of the following:
+ * none
+ * bold
+ * underline
+ * reverse
+ * standout
- The Mutt Next Generation E-Mail Client 32
+10. Ignoring (weeding) unwanted message headers
- +\bo signature
+ Usage: [un]ignore pattern [ pattern ... ]
- +\bo status (mode lines used to display info about the mailbox or message)
+ Messages often have many header fields added by automatic processing systems, or which may not seem useful to display on the screen. This command allows you to specify header fields which you don't normally want to see.
- +\bo tilde (the ``~'' used to pad blank lines in the pager)
+ You do not need to specify the full header field name. For example, ``ignore content-'' will ignore all header fields that begin with the pattern ``content-''. ``ignore *'' will ignore all headers.
- +\bo tree (thread tree drawn in the message index and attachment menu)
+ To remove a previously added token from the list, use the ``unignore'' command. The ``unignore'' command will make Mutt-ng display headers with the given pattern. For example, if you do ``ignore x-'' it is possible to ``unignore x-mailer''.
- +\bo underline (highlighting underlined patterns in the body of messages)
+ ``unignore *'' will remove all tokens from the ignore list.
- _\bf_\bo_\br_\be_\bg_\br_\bo_\bu_\bn_\bd and _\bb_\ba_\bc_\bk_\bg_\br_\bo_\bu_\bn_\bd can be one of the following:
+ For example:
+# 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:
- +\bo white
+11. Alternative addresses
- +\bo black
+ Usage: [un]alternates regexp [ regexp ... ]
- +\bo green
+ 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 reply-to.)
- +\bo magenta
+ Many users receive e-mail under a number of different addresses. To fully use mutt's features here, the program must be able to recognize what e-mail addresses you receive mail under. That's the purpose of the alternates command: It takes a list of regular expressions, each of which can identify an address under which you receive e-mail.
- +\bo blue
+ The unalternates command can be used to write exceptions to alternates patterns. If an address matches something in an alternates command, but you nonetheless do not think it is from you, you can list a more precise pattern under an unalternates command.
- +\bo cyan
+ To remove a regular expression from the alternates list, use the unalternates command with exactly the same regexp. Likewise, if the regexp for a alternates command matches an entry on the unalternates list, that unalternates entry will be removed. If the regexp for unalternates is ``*'', all entries on alternates will be removed.
- +\bo yellow
+12. Format = Flowed
- +\bo red
+12.1. Introduction
- +\bo default
+ Mutt-ng contains support for so-called format=flowed messages. In the beginning of email, each message had a fixed line width, and it was enough for displaying them on fixed-size terminals. But times changed, and nowadays hardly anybody still uses fixed-size terminals: more people nowaydays use graphical user interfaces, with dynamically resizable windows. This led to the demand of a new email format that makes it possible for the email client to make the email look nice in a resizable window without breaking quoting levels and creating an incompatible email format that can also be displayed nicely on old fixed-size terminals.
- +\bo color_\bx
+ For introductory information on format=flowed messages, see <http://www.joeclark.org/ffaq.html>.
- _\bf_\bo_\br_\be_\bg_\br_\bo_\bu_\bn_\bd can optionally be prefixed with the keyword bright to make the fore-
- ground color boldfaced (e.g., brightred).
+12.2. Receiving: Display Setup
- If your terminal supports it, the special keyword _\bd_\be_\bf_\ba_\bu_\bl_\bt can be used as a
- transparent color. The value _\bb_\br_\bi_\bg_\bh_\bt_\bd_\be_\bf_\ba_\bu_\bl_\bt is also valid. If Mutt-ng is
- linked against the _\bS_\b-_\bL_\ba_\bn_\bg library, you also need to set the _\bC_\bO_\bL_\bO_\bR_\bF_\bG_\bB_\bG environ-
- ment variable to the default colors of your terminal for this to work; for
- example (for Bourne-like shells):
+ When you receive emails that are marked as format=flowed messages, and is formatted correctly, mutt-ng will try to reformat the message to optimally fit on your terminal. If you want a fixed margin on the right side of your terminal, you can set the following:
+ set wrapmargin = 10
- set COLORFGBG="green;black"
- export COLORFGBG
+ The code above makes the line break 10 columns before the right side of the terminal.
- N\bNo\bot\bte\be:\b: The _\bS_\b-_\bL_\ba_\bn_\bg library requires you to use the _\bl_\bi_\bg_\bh_\bt_\bg_\br_\ba_\by and _\bb_\br_\bo_\bw_\bn keywords
- instead of _\bw_\bh_\bi_\bt_\be and _\by_\be_\bl_\bl_\bo_\bw when setting this variable.
+ If your terminal is so wide that the lines are embarrassingly long, you can also set a maximum line length:
+ set max_line_length = 120
- N\bNo\bot\bte\be:\b: The uncolor command can be applied to the index object only. It removes
- entries from the list. You m\bmu\bus\bst\bt specify the same pattern specified in the color
- command for it to be removed. The pattern ``*'' is a special token which means
- to clear the color index list of all entries.
+ The example above will give you lines not longer than 120 characters.
- The Mutt Next Generation E-Mail Client 33
+ When you view at format=flowed messages, you will often see the quoting hierarchy like in the following example:
+ >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.
- Mutt-ng also recognizes the keywords _\bc_\bo_\bl_\bo_\br_\b0, _\bc_\bo_\bl_\bo_\br_\b1, ..., _\bc_\bo_\bl_\bo_\brN\bN-\b-1\b1 (N\bN being the
- number of colors supported by your terminal). This is useful when you remap
- the colors for your display (for example by changing the color associated with
- _\bc_\bo_\bl_\bo_\br_\b2 for your xterm), since color names may then lose their normal meaning.
+ This obviously doesn't look very nice, and it makes it very hard to differentiate between text and quoting character. The solution is to configure mutt-ng to "stuff" the quoting:
+ set stuff_quoted
- If your terminal does not support color, it is still possible change the video
- attributes through the use of the ``mono'' command:
+ This will lead to a nicer result that is easier to read:
+ > 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.
- Usage: mono _\b<_\bo_\bb_\bj_\be_\bc_\bt_\b> _\b<_\ba_\bt_\bt_\br_\bi_\bb_\bu_\bt_\be_\b> [ _\br_\be_\bg_\be_\bx_\bp ]
+12.3. Sending
- Usage: mono index _\ba_\bt_\bt_\br_\bi_\bb_\bu_\bt_\be _\bp_\ba_\bt_\bt_\be_\br_\bn
+ If you want mutt-ng to send emails with format=flowed set, you need to explicitly set it:
+ set text_flowed
- Usage: unmono index _\bp_\ba_\bt_\bt_\be_\br_\bn [ _\bp_\ba_\bt_\bt_\be_\br_\bn ... ]
+ Additionally, you have to use an editor which supports writing format=flowed-conforming emails. For vim, this is done by adding w to the formatoptions (see :h formatoptions and :h fo-table) when writing emails.
- where _\ba_\bt_\bt_\br_\bi_\bb_\bu_\bt_\be is one of the following:
+ Also note that format=flowed knows about ``space-stuffing'', that is, when sending messages, some kinds of lines have to be indented with a single space on the sending side. On the receiving 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 space-stuff lines starting with:
+ * > This is not the quote character but a right angle used for other reasons
+ * From with a trailing space.
+ * just a space for formatting reasons
- +\bo none
+ Please make sure that you manually prepend a space to each of them.
- +\bo bold
+12.4. Additional Notes
- +\bo underline
+ For completeness, the delete-space variable provides the mechanism to generate a DelSp=yes parameter on outgoing messages. According to the standard, clients receiving a format=flowed messages should delete the last space of a flowed line but still interpret the line as flowed. Because flowed lines usually contain only one space at the end, this parameter would make the receiving client concatenate the last word of the previous with the first of the current line without a space. This makes ordinary text unreadable and is intended for languages rarely using spaces. So please use this setting only if you're sure what you're doing.
- +\bo reverse
+13. Mailing lists
- +\bo standout
+ Usage: [un]lists regexp [ regexp ... ] Usage: [un]subscribe regexp [ regexp ... ]
- _\b3_\b._\b1_\b0 _\bI_\bg_\bn_\bo_\br_\bi_\bn_\bg _\b(_\bw_\be_\be_\bd_\bi_\bn_\bg_\b) _\bu_\bn_\bw_\ba_\bn_\bt_\be_\bd _\bm_\be_\bs_\bs_\ba_\bg_\be _\bh_\be_\ba_\bd_\be_\br_\bs
+ Mutt-ng has a few nice features for using-lists. In order to take advantage of them, you must specify which addresses belong to mailing lists, and which mailing lists you are subscribed to. Once you have done this, the list-reply function will work for all known lists. Additionally, when you send a message to a subscribed list, mutt will add a Mail-Followup-To header to tell other users' mail user agents not to send copies of replies to your personal address. Note that the Mail-Followup-To header is a non-standard extension which is not supported by all mail user agents. Adding it is not bullet-proof against receiving personal CCs of list messages. Also note that the generation of the Mail-Followup-To header is controlled by the followup-to configuration variable.
- Usage: [un]ignore _\bp_\ba_\bt_\bt_\be_\br_\bn [ _\bp_\ba_\bt_\bt_\be_\br_\bn ... ]
+ More precisely, Mutt-ng maintains lists of patterns for the addresses of known and subscribed mailing lists. Every subscribed mailing list is known. To mark a mailing list as known, use the ``lists'' command. To mark it as subscribed, use ``subscribe''.
- Messages often have many header fields added by automatic processing systems,
- or which may not seem useful to display on the screen. This command allows you
- to specify header fields which you don't normally want to see.
+ 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 give a portion of the list's e-mail address.
- You do not need to specify the full header field name. For example, ``ignore
- content-'' will ignore all header fields that begin with the pattern ``con-
- tent-''. ``ignore *'' will ignore all headers.
+ Specify as much of the address as you need to to remove ambiguity. For example, if you've subscribed to the Mutt-ng mailing list, you will receive mail addressed to mutt-users@mutt.org. So, to tell Mutt-ng that this is a mailing list, you could add ``lists mutt-users'' to your initialization file. To tell mutt that you are subscribed to it, add ``subscribe mutt-users'' to your initialization file instead. If you also happen to get mail from someone whose address is mutt-users@example.com, you could use ``lists mutt-users@mutt\\.org'' or ``subscribe mutt-users@mutt\\.org'' to match only mail from the actual list.
- To remove a previously added token from the list, use the ``unignore'' command.
- The ``unignore'' command will make Mutt-ng display headers with the given pat-
- tern. For example, if you do ``ignore x-'' it is possible to ``unignore x-
- mailer''.
+ The ``unlists'' command is used to remove a token from the list of known and subscribed mailing-lists. Use ``unlists *'' to remove all tokens.
- ``unignore *'' will remove all tokens from the ignore list.
+ To remove a mailing list from the list of subscribed mailing lists, but keep it on the list of known mailing lists, use ``unsubscribe''.
- For example:
+14. Using Multiple spool mailboxes
- # 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:
+ Usage: mbox-hook [!]pattern mailbox
- The Mutt Next Generation E-Mail Client 34
+ This command is used to move read messages from a specified mailbox to a different mailbox automatically when you quit or change folders. pattern is a regular expression specifying the mailbox to treat as a ``spool'' mailbox and mailbox specifies where mail should be saved when read.
- _\b3_\b._\b1_\b1 _\bA_\bl_\bt_\be_\br_\bn_\ba_\bt_\bi_\bv_\be _\ba_\bd_\bd_\br_\be_\bs_\bs_\be_\bs
+ Unlike some of the other hook commands, only the first matching pattern is used (it is not possible to save read mail in more than a single mailbox).
- Usage: [un]alternates _\br_\be_\bg_\be_\bx_\bp [ _\br_\be_\bg_\be_\bx_\bp ... ]
+15. Defining mailboxes which receive mail
- 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
- _\b$_\br_\be_\bp_\bl_\by_\b__\bt_\bo (section 7.4.249 , page 149).)
+ Usage: [un]mailboxes [!]filename [ filename ... ]
- Many users receive e-mail under a number of different addresses. To fully use
- mutt's features here, the program must be able to recognize what e-mail
- addresses you receive mail under. That's the purpose of the alternates command:
- It takes a list of regular expressions, each of which can identify an address
- under which you receive e-mail.
+ This command specifies folders which can receive mail and which will be checked for new messages. By default, the main menu status bar displays how many of these folders have new messages.
- The unalternates command can be used to write exceptions to alternates pat-
- terns. If an address matches something in an alternates command, but you none-
- theless do not think it is from you, you can list a more precise pattern under
- an unalternates command.
+ When changing folders, pressing space will cycle through folders with new mail.
- To remove a regular expression from the alternates list, use the unalternates
- command with exactly the same _\br_\be_\bg_\be_\bx_\bp. Likewise, if the _\br_\be_\bg_\be_\bx_\bp for a alternates
- command matches an entry on the unalternates list, that unalternates entry will
- be removed. If the _\br_\be_\bg_\be_\bx_\bp for unalternates is ``*'', _\ba_\bl_\bl _\be_\bn_\bt_\br_\bi_\be_\bs on alternates
- will be removed.
+ Pressing TAB in the directory browser will bring up a menu showing the files specified by the mailboxes command, and indicate which contain new messages. Mutt-ng will automatically enter this mode when invoked from the command line with the -y option.
- _\b3_\b._\b1_\b2 _\bF_\bo_\br_\bm_\ba_\bt _\b= _\bF_\bl_\bo_\bw_\be_\bd
+ The ``unmailboxes'' command is used to remove a token from the list of folders which receive mail. Use ``unmailboxes *'' to remove all tokens.
- _\b3_\b._\b1_\b2_\b._\b1 _\bI_\bn_\bt_\br_\bo_\bd_\bu_\bc_\bt_\bi_\bo_\bn
+ Note: new mail is detected by comparing the last modification time to the last access time. Utilities like biff or frm or any other program which accesses the mailbox might cause Mutt-ng to never detect new mail for that mailbox if they do not properly reset the access time. Backup tools are another common reason for updated access times.
- Mutt-ng contains support for so-called format=flowed messages. In the begin-
- ning of email, each message had a fixed line width, and it was enough for dis-
- playing them on fixed-size terminals. But times changed, and nowadays hardly
- anybody still uses fixed-size terminals: more people nowaydays use graphical
- user interfaces, with dynamically resizable windows. This led to the demand of
- a new email format that makes it possible for the email client to make the
- email look nice in a resizable window without breaking quoting levels and cre-
- ating an incompatible email format that can also be displayed nicely on old
- fixed-size terminals.
+ Note: the filenames in the mailboxes command are resolved when the command is executed, so if these names contain shortcuts (such as ``='' and ``!''), any variable definition that affect these characters (like folder and spoolfile) should be executed before the mailboxes command.
- For introductory information on format=flowed messages, see
- <http://www.joeclark.org/ffaq.html>.
+16. User defined headers
- _\b3_\b._\b1_\b2_\b._\b2 _\bR_\be_\bc_\be_\bi_\bv_\bi_\bn_\bg_\b: _\bD_\bi_\bs_\bp_\bl_\ba_\by _\bS_\be_\bt_\bu_\bp
+ Usage: my_hdr string unmy_hdr field [ field ... ]
- When you receive emails that are marked as format=flowed messages, and is for-
- matted correctly, mutt-ng will try to reformat the message to optimally fit on
- your terminal. If you want a fixed margin on the right side of your terminal,
- you can set the following:
+ The ``my_hdr'' command allows you to create your own header fields which will be added to every message you send.
- The Mutt Next Generation E-Mail Client 35
+ For example, if you would like to add an ``Organization:'' header field to all of your outgoing messages, you can put the command
+my_hdr Organization: A Really Big Company, Anytown, USA
- set wrapmargin = 10
+ in your .muttrc.
- The code above makes the line break 10 columns before the right side of the
- terminal.
+ Note: space characters are not allowed between the keyword and the colon (``:''). The standard for electronic mail (RFC822) says that space is illegal there, so Mutt-ng enforces the rule.
- If your terminal is so wide that the lines are embarrassingly long, you can
- also set a maximum line length:
+ If you would like to add a header field to a single message, you should either set the edit-headers variable, or use the edit-headers function (default: ``E'') in the send-menu so that you can edit the header of your message along with the body.
- set max_line_length = 120
+ 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:
+unmy_hdr to cc
- The example above will give you lines not longer than 120 characters.
+17. Defining the order of headers when viewing messages
- When you view at format=flowed messages, you will often see the quoting hierar-
- chy like in the following example:
+ Usage: hdr_order header1 header2 header3
- >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.
+ With this command, you can specify an order in which mutt will attempt to present headers to you when viewing messages.
- This obviously doesn't look very nice, and it makes it very hard to differenti-
- ate between text and quoting character. The solution is to configure mutt-ng to
- "stuff" the quoting:
+ ``unhdr_order *'' will clear all previous headers from the order list, thus removing the header order effects set by the system-wide startup file.
+hdr_order From Date: From: To: Cc: Subject:
- set stuff_quoted
+18. Specify default save filename
- This will lead to a nicer result that is easier to read:
+ Usage: save-hook [!]pattern filename
- > 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.
+ This command is used to override the default filename used when saving messages. filename will be used as the default filename if the message is From: an address matching regexp or if you are the author and the message is addressed to: something matching regexp.
- _\b3_\b._\b1_\b2_\b._\b3 _\bS_\be_\bn_\bd_\bi_\bn_\bg
+ See pattern-hook for information on the exact format of pattern.
- If you want mutt-ng to send emails with format=flowed set, you need to explic-
- itly set it:
+ Examples:
+save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
+save-hook aol\\.com$ +spam
- set text_flowed
+ Also see the fcc-save-hook command.
- The Mutt Next Generation E-Mail Client 36
+19. Specify default Fcc: mailbox when composing
- Additionally, you have to use an editor which supports writing format=flowed-
- conforming emails. For vim, this is done by adding w to the formatoptions (see
- :h formatoptions and :h fo-table) when writing emails.
+ Usage: fcc-hook [!]pattern mailbox
- Also note that _\bf_\bo_\br_\bm_\ba_\bt_\b=_\bf_\bl_\bo_\bw_\be_\bd knows about ``space-stuffing'', that is, when
- sending messages, some kinds of lines have to be indented with a single space
- on the sending side. On the receiving 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 space-
- stuff lines starting with:
+ This command is used to save outgoing mail in a mailbox other than record. Mutt-ng searches the initial list of message recipients for the first matching regexp and uses mailbox as the default Fcc: mailbox. If no match is found the message will be saved to record mailbox.
- +\bo > This is _\bn_\bo_\bt the quote character but a right angle used for other reasons
+ See pattern-hook for information on the exact format of pattern.
- +\bo From with a trailing space.
+ Example: fcc-hook [@.]aol\\.com$ +spammers
- +\bo just a space for formatting reasons
+ The above will save a copy of all messages going to the aol.com domain to the `+spammers' mailbox by default. Also see the fcc-save-hook command.
- Please make sure that you manually prepend a space to each of them.
+20. Specify default save filename and default Fcc: mailbox at once
- _\b3_\b._\b1_\b2_\b._\b4 _\bA_\bd_\bd_\bi_\bt_\bi_\bo_\bn_\ba_\bl _\bN_\bo_\bt_\be_\bs
+ Usage: fcc-save-hook [!]pattern mailbox
- "
+ This command is a shortcut, equivalent to doing both a fcc-hook and a save-hook with its arguments.
- For completeness, the _\b$_\bd_\be_\bl_\be_\bt_\be_\b__\bs_\bp_\ba_\bc_\be (section 7.4.51 , page 101) variable pro-
- vides the mechanism to generate a DelSp=yes parameter on _\bo_\bu_\bt_\bg_\bo_\bi_\bn_\bg messages.
- According to the standard, clients receiving a format=flowed messages should
- delete the last space of a flowed line but still interpret the line as flowed.
- Because flowed lines usually contain only one space at the end, this parameter
- would make the receiving client concatenate the last word of the previous with
- the first of the current line _\bw_\bi_\bt_\bh_\bo_\bu_\bt a space. This makes ordinary text unread-
- able and is intended for languages rarely using spaces. So please use this set-
- ting only if you're sure what you're doing.
+21. Change settings based upon message recipients
- _\b3_\b._\b1_\b3 _\bM_\ba_\bi_\bl_\bi_\bn_\bg _\bl_\bi_\bs_\bt_\bs
+ Usage: reply-hook [!]pattern command Usage: send-hook [!]pattern command Usage: send2-hook [!]pattern command
- Usage: [un]lists _\br_\be_\bg_\be_\bx_\bp [ _\br_\be_\bg_\be_\bx_\bp ... ]
+ These commands can be used to execute arbitrary configuration commands based upon recipients of the message. pattern is a regular expression matching the desired address. command is executed when regexp matches recipients of the message.
- Usage: [un]subscribe _\br_\be_\bg_\be_\bx_\bp [ _\br_\be_\bg_\be_\bx_\bp ... ]
+ reply-hook is matched against the message you are replying to, instead of the message you are sending. send-hook is matched against all messages, both new and replies. Note: reply-hooks are matched before the send-hook, regardless of the order specified in the users's configuration file.
- Mutt-ng has a few nice features for _\bh_\ba_\bn_\bd_\bl_\bi_\bn_\bg _\bm_\ba_\bi_\bl_\bi_\bn_\bg _\bl_\bi_\bs_\bt_\bs (section 4.10 ,
- page 61). 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 _\bl_\bi_\bs_\bt_\b-_\br_\be_\bp_\bl_\by (section 2.5.4 , page 12) function will
- work for all known lists. Additionally, when you send a message to a sub-
- scribed list, mutt will add a Mail-Followup-To header to tell other users' mail
- user agents not to send copies of replies to your personal address. Note that
- the Mail-Followup-To header is a non-standard extension which is not supported
- by all mail user agents. Adding it is not bullet-proof against receiving per-
- sonal CCs of list messages. Also note that the generation of the Mail-Fol-
- lowup-To header is controlled by the _\b$_\bf_\bo_\bl_\bl_\bo_\bw_\bu_\bp_\b__\bt_\bo (section 7.4.72 , page 106)
- configuration variable.
+ send2-hook is matched every time a message is changed, either by editing it, or by using the compose menu to change its recipients or subject. send2-hook is executed after send-hook, and can, e.g., be used to set parameters such as the sendmail variable depending on the message's sender address.
- The Mutt Next Generation E-Mail Client 37
+ For each type of send-hook or reply-hook, when multiple matches occur, commands are executed in the order they are specified in the muttrc (for that type of hook).
- More precisely, Mutt-ng maintains lists of patterns for the addresses of known
- and subscribed mailing lists. Every subscribed mailing list is known. To mark
- a mailing list as known, use the ``lists'' command. To mark it as subscribed,
- use ``subscribe''.
+ See pattern-hook for information on the exact format of pattern.
- 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 give a portion of the list's e-mail address.
+ Example: send-hook mutt "set mime_forward signature=''"
- Specify as much of the address as you need to to remove ambiguity. For exam-
- ple, if you've subscribed to the Mutt-ng mailing list, you will receive mail
- addressed to _\bm_\bu_\bt_\bt_\b-_\bu_\bs_\be_\br_\bs_\b@_\bm_\bu_\bt_\bt_\b._\bo_\br_\bg. So, to tell Mutt-ng that this is a mailing
- list, you could add ``lists mutt-users'' to your initialization file. To tell
- mutt that you are subscribed to it, add ``subscribe mutt-users'' to your ini-
- tialization file instead. If you also happen to get mail from someone whose
- address is _\bm_\bu_\bt_\bt_\b-_\bu_\bs_\be_\br_\bs_\b@_\be_\bx_\ba_\bm_\bp_\bl_\be_\b._\bc_\bo_\bm, you could use ``lists mutt-
- users@mutt\\.org'' or ``subscribe mutt-users@mutt\\.org'' to match only mail
- from the actual list.
+ Another typical use for this command is to change the values of the attribution, signature and locale variables in order to change the language of the attributions and signatures based upon the recipients.
- The ``unlists'' command is used to remove a token from the list of known and
- subscribed mailing-lists. Use ``unlists *'' to remove all tokens.
+ Note: the send-hook's are only executed ONCE after getting the initial list of recipients. Adding a recipient after replying or editing the message will NOT cause any send-hook to be executed. Also note that my_hdr commands which modify recipient headers, or the message's subject, don't have any effect on the current message when executed from a send-hook.
- To remove a mailing list from the list of subscribed mailing lists, but keep it
- on the list of known mailing lists, use ``unsubscribe''.
+22. Change settings before formatting a message
- _\b3_\b._\b1_\b4 _\bU_\bs_\bi_\bn_\bg _\bM_\bu_\bl_\bt_\bi_\bp_\bl_\be _\bs_\bp_\bo_\bo_\bl _\bm_\ba_\bi_\bl_\bb_\bo_\bx_\be_\bs
+ Usage: message-hook [!]pattern command
- Usage: mbox-hook [!]_\bp_\ba_\bt_\bt_\be_\br_\bn _\bm_\ba_\bi_\bl_\bb_\bo_\bx
+ This command can be used to execute arbitrary configuration commands before viewing or formatting a message based upon information about the message. command is executed if the pattern matches the message to be displayed. When multiple matches occur, commands are executed in the order they are specified in the muttrc.
- This command is used to move read messages from a specified mailbox to a dif-
- ferent mailbox automatically when you quit or change folders. _\bp_\ba_\bt_\bt_\be_\br_\bn is a
- regular expression specifying the mailbox to treat as a ``spool'' mailbox and
- _\bm_\ba_\bi_\bl_\bb_\bo_\bx specifies where mail should be saved when read.
+ See pattern-hook for information on the exact format of pattern.
- Unlike some of the other _\bh_\bo_\bo_\bk commands, only the _\bf_\bi_\br_\bs_\bt matching pattern is used
- (it is not possible to save read mail in more than a single mailbox).
+ Example:
+message-hook ~A 'set pager=builtin'
+message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""'
- _\b3_\b._\b1_\b5 _\bD_\be_\bf_\bi_\bn_\bi_\bn_\bg _\bm_\ba_\bi_\bl_\bb_\bo_\bx_\be_\bs _\bw_\bh_\bi_\bc_\bh _\br_\be_\bc_\be_\bi_\bv_\be _\bm_\ba_\bi_\bl
+23. Choosing the cryptographic key of the recipient
- Usage: [un]mailboxes [!]_\bf_\bi_\bl_\be_\bn_\ba_\bm_\be [ _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be ... ]
+ Usage: crypt-hook pattern keyid
- This command specifies folders which can receive mail and which will be checked
- for new messages. By default, the main menu status bar displays how many of
- these folders have new messages.
+ When encrypting messages with PGP or OpenSSL, you may want to associate a certain key with a given e-mail address automatically, either because the recipient's public key can't be deduced from the destination address, or because, for some reasons, you need to override the key Mutt-ng would normally use. The crypt-hook command provides a method by which you can specify the ID of the public key to be used when encrypting messages to a certain recipient.
- When changing folders, pressing _\bs_\bp_\ba_\bc_\be will cycle through folders with new mail.
+ The meaning of "key id" is to be taken broadly in this context: You can either put a numerical key ID here, an e-mail address, or even just a real name.
- Pressing TAB in the directory browser will bring up a menu showing the files
- specified by the mailboxes command, and indicate which contain new messages.
+24. Adding key sequences to the keyboard buffer
- The Mutt Next Generation E-Mail Client 38
+ Usage: push string
- Mutt-ng will automatically enter this mode when invoked from the command line
- with the -y option.
+ 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 macro command. You may use it to automatically run a sequence of commands at startup, or when entering certain folders.
- The ``unmailboxes'' command is used to remove a token from the list of folders
- which receive mail. Use ``unmailboxes *'' to remove all tokens.
+25. Executing functions
- N\bNo\bot\bte\be:\b: new mail is detected by comparing the last modification time to the last
- access time. Utilities like biff or frm or any other program which accesses
- the mailbox might cause Mutt-ng to never detect new mail for that mailbox if
- they do not properly reset the access time. Backup tools are another common
- reason for updated access times.
+ Usage: exec function [ function ... ]
- N\bNo\bot\bte\be:\b: the filenames in the mailboxes command are resolved when the command is
- executed, so if these names contain _\bs_\bh_\bo_\br_\bt_\bc_\bu_\bt _\bc_\bh_\ba_\br_\ba_\bc_\bt_\be_\br_\bs (section 4.9 , page
- 61) (such as ``='' and ``!''), any variable definition that affect these char-
- acters (like _\b$_\bf_\bo_\bl_\bd_\be_\br (section 7.4.70 , page 105) and _\b$_\bs_\bp_\bo_\bo_\bl_\bf_\bi_\bl_\be (section
- 7.4.313 , page 165)) should be executed before the mailboxes command.
+ This command can be used to execute any function. Functions are listed in the functions. ``exec function'' is equivalent to ``push <function>''.
- _\b3_\b._\b1_\b6 _\bU_\bs_\be_\br _\bd_\be_\bf_\bi_\bn_\be_\bd _\bh_\be_\ba_\bd_\be_\br_\bs
+26. Message Scoring
- Usage:
+ Usage: score pattern value Usage: unscore pattern [ pattern ... ]
- my_hdr _\bs_\bt_\br_\bi_\bn_\bg
+ In situations where you have to cope with a lot of emails, e.g. when you read many different mailing lists, and take part in discussions, it is always useful to have the important messages marked and the annoying messages or the ones that you aren't interested in deleted. For this purpose, mutt-ng features a mechanism called ``scoring''.
- unmy_hdr _\bf_\bi_\be_\bl_\bd [ _\bf_\bi_\be_\bl_\bd ... ]
+ When you use scoring, every message has a base score of 0. You can then use the score command to define patterns and a positive or negative value associated with it. When a pattern matches a message, the message's score will be raised or lowered by the amount of the value associated with the pattern.
+score "~f nion@muttng\.org" 50
+score "~f @sco\.com" -100
- The ``my_hdr'' command allows you to create your own header fields which will
- be added to every message you send.
+ If the pattern matches, it is also possible to set the score value of the current message to a certain value and then stop evaluation:
+score "~f santaclaus@northpole\.int" =666
- For example, if you would like to add an ``Organization:'' header field to all
- of your outgoing messages, you can put the command
+ What is important to note is that negative score values will be rounded up to 0.
- my_hdr Organization: A Really Big Company, Anytown, USA
+ To make scoring actually useful, the score must be applied in some way. That's what the score thresholds are for. Currently, there are three score thresholds:
+ * flag threshold: when a message has a score value equal or higher than the flag threshold, it will be flagged.
+ * read threshold: when a message has a score value equal or lower than the read threshold, it will be marked as read.
+ * delete threshold: when a message has a score value equal or lower than the delete threshold, it will be marked as deleted.
- in your .muttrc.
+ These three thresholds can be set via the variables score-threshold-flag, score-threshold-read, score-threshold-delete and. By default, score-threshold-read and score-threshold-delete are set to -1, which means that in the default threshold configuration no message will ever get marked as read or deleted.
- N\bNo\bot\bte\be:\b: space characters are _\bn_\bo_\bt allowed between the keyword and the colon
- (``:''). The standard for electronic mail (RFC822) says that space is illegal
- there, so Mutt-ng enforces the rule.
+ Scoring gets especially interesting when combined with the color command and the ˜n pattern:
+color index black yellow "~n 10-"
+color index red yellow "~n 100-"
- If you would like to add a header field to a single message, you should either
- set the _\be_\bd_\bi_\bt_\b__\bh_\be_\ba_\bd_\be_\br_\bs (section 7.4.59 , page 103) variable, or use the _\be_\bd_\bi_\bt_\b-
- _\bh_\be_\ba_\bd_\be_\br_\bs function (default: ``E'') in the send-menu so that you can edit the
- header of your message along with the body.
+ The rules above mark all messages with a score between 10 and 99 with black and yellow, and messages with a score greater or equal 100 with red and yellow. This might be unusual to you if you're used to e.g. slrn's scoring mechanism, but it is more flexible, as it visually marks different scores.
- 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:
+27. Spam detection
- The Mutt Next Generation E-Mail Client 39
+ Usage: spam pattern format Usage: nospam pattern
- unmy_hdr to cc
+ Mutt-ng has generalized support for external spam-scoring filters. By defining your spam patterns with the spam and nospam commands, you can limit, search, and sort 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 %H selector in the index-format variable. (Tip: try %?H?[%H] ? to display spam tags only when they are defined for a given message.)
- _\b3_\b._\b1_\b7 _\bD_\be_\bf_\bi_\bn_\bi_\bn_\bg _\bt_\bh_\be _\bo_\br_\bd_\be_\br _\bo_\bf _\bh_\be_\ba_\bd_\be_\br_\bs _\bw_\bh_\be_\bn _\bv_\bi_\be_\bw_\bi_\bn_\bg _\bm_\be_\bs_\bs_\ba_\bg_\be_\bs
+ Your first step is to define your external filter's spam patterns using the spam command. pattern should be a regular expression that matches a header in a mail message. If any message in the mailbox matches this regular expression, it will receive a ``spam tag'' or ``spam attribute'' (unless it also matches a nospam pattern -- see below.) The appearance of this attribute is entirely up to you, and is governed by the format parameter. format can be any static text, but it also can include back-references from the pattern expression. (A regular expression ``back-reference'' refers to a sub-expression contained within parentheses.) %1 is replaced with the first back-reference in the regex, %2 with the second, etc.
- Usage: hdr_order _\bh_\be_\ba_\bd_\be_\br_\b1 _\bh_\be_\ba_\bd_\be_\br_\b2 _\bh_\be_\ba_\bd_\be_\br_\b3
+ If you're using multiple spam filters, a message can have more than one spam-related header. You can define spam patterns for each filter you use. If a message matches two or more of these patterns, and the $spam_separator variable is set to a string, then the message's spam tag will consist of all the format strings joined together, with the value of $spam_separator separating them.
- With this command, you can specify an order in which mutt will attempt to
- present headers to you when viewing messages.
+ For example, suppose I use DCC, SpamAssassin, and PureMessage. I might define these spam settings:
+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=", "
- ``unhdr_order *'' will clear all previous headers from the order list, thus
- removing the header order effects set by the system-wide startup file.
+ If I then received a message that DCC registered with ``many'' hits under the ``Fuz2'' checksum, and that PureMessage registered with a 97% probability of being spam, that message's spam tag would read 90+/DCC-Fuz2, 97/PM. (The four characters before ``=many'' in a DCC report indicate the checksum used -- in this case, ``Fuz2''.)
- hdr_order From Date: From: To: Cc: Subject:
+ If the $spam_separator variable is unset, then each spam pattern match supersedes the previous one. Instead of getting joined format strings, you'll get only the last one to match.
- _\b3_\b._\b1_\b8 _\bS_\bp_\be_\bc_\bi_\bf_\by _\bd_\be_\bf_\ba_\bu_\bl_\bt _\bs_\ba_\bv_\be _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
+ The spam tag is what will be displayed in the index when you use %H in the $index_format variable. It's also the string that the ˜H pattern-matching expression matches against for search and limit functions. And it's what sorting by spam attribute will use as a sort key.
- Usage: save-hook [!]_\bp_\ba_\bt_\bt_\be_\br_\bn _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
+ That's a pretty complicated example, and most people's actual environments will have only one spam filter. The simpler your configuration, the more effective mutt can be, especially when it comes to sorting.
- This command is used to override the default filename used when saving mes-
- sages. _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be will be used as the default filename if the message is _\bF_\br_\bo_\bm_\b:
- an address matching _\br_\be_\bg_\be_\bx_\bp or if you are the author and the message is
- addressed _\bt_\bo_\b: something matching _\br_\be_\bg_\be_\bx_\bp.
+ Generally, when you sort by spam tag, mutt will sort lexically -- that is, by ordering strings alphnumerically. However, if a spam tag begins with a number, mutt will sort numerically first, and lexically only when two numbers are equal in value. (This is like UNIX's sort -n.) A message with no spam attributes at all -- that is, one that didn't match any of your spam patterns -- is sorted at lowest priority. Numbers are sorted next, beginning with 0 and ranging upward. Finally, non-numeric strings are sorted, with ``a'' taking lower priority than ``z''. Clearly, in general, sorting by spam tags is most effective when you can coerce your filter to give you a raw number. But in case you can't, mutt can still do something useful.
- See _\bM_\be_\bs_\bs_\ba_\bg_\be _\bM_\ba_\bt_\bc_\bh_\bi_\bn_\bg _\bi_\bn _\bH_\bo_\bo_\bk_\bs (section 4.5.1 , page 58) for information on the
- exact format of _\bp_\ba_\bt_\bt_\be_\br_\bn.
+ The nospam command can be used to write exceptions to spam patterns. If a header pattern matches something in a spam command, but you nonetheless do not want it to receive a spam tag, you can list a more precise pattern under a nospam command.
- Examples:
+ If the pattern given to nospam is exactly the same as the pattern on an existing spam list entry, the effect will be to remove the entry from the spam list, instead of adding an exception. Likewise, if the pattern for a spam command matches an entry on the nospam list, that nospam entry will be removed. If the pattern for nospam is ``*'', all entries on both lists will be removed. This might be the default action if you use spam and nospam in conjunction with a folder-hook.
- save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
- save-hook aol\\.com$ +spam
+ You can have as many spam or nospam commands as you like. You can even do your own primitive spam detection within mutt -- for example, if you consider all mail from MAILER-DAEMON to be spam, you can use a spam command like this:
+spam "^From: .*MAILER-DAEMON" "999"
- Also see the _\bf_\bc_\bc_\b-_\bs_\ba_\bv_\be_\b-_\bh_\bo_\bo_\bk (section 3.20 , page 40) command.
+28. Setting variables
- _\b3_\b._\b1_\b9 _\bS_\bp_\be_\bc_\bi_\bf_\by _\bd_\be_\bf_\ba_\bu_\bl_\bt _\bF_\bc_\bc_\b: _\bm_\ba_\bi_\bl_\bb_\bo_\bx _\bw_\bh_\be_\bn _\bc_\bo_\bm_\bp_\bo_\bs_\bi_\bn_\bg
+ Usage: set [no|inv]variable[=value] [ variable ... ] Usage: toggle variable [variable ... ] Usage: unset variable [variable ... ] Usage: reset variable [variable ... ]
- Usage: fcc-hook [!]_\bp_\ba_\bt_\bt_\be_\br_\bn _\bm_\ba_\bi_\bl_\bb_\bo_\bx
+ This command is used to set (and unset) variables. There are four basic types of variables: boolean, number, string and quadoption. boolean variables can be set (true) or unset (false). number variables can be assigned a positive integer value.
- This command is used to save outgoing mail in a mailbox other than _\b$_\br_\be_\bc_\bo_\br_\bd
- (section 7.4.246 , page 148). Mutt-ng searches the initial list of message
- recipients for the first matching _\br_\be_\bg_\be_\bx_\bp and uses _\bm_\ba_\bi_\bl_\bb_\bo_\bx as the default Fcc:
- mailbox. If no match is found the message will be saved to _\b$_\br_\be_\bc_\bo_\br_\bd (section
- 7.4.246 , page 148) mailbox.
+ string variables consist of any number of printable characters. strings must be enclosed in quotes if they contain spaces or tabs. You may also use the ``C'' escape sequences \n and \t for newline and tab, respectively.
- The Mutt Next Generation E-Mail Client 40
+ quadoption variables are used to control whether or not to be prompted for certain actions, or to specify a default action. A value of yes will cause the action to be carried out automatically as if you had answered yes to the question. Similarly, a value of no will cause the the action to be carried out as if you had answered ``no.'' A value of ask-yes will cause a prompt with a default answer of ``yes'' and ask-no will provide a default answer of ``no.''
- See _\bM_\be_\bs_\bs_\ba_\bg_\be _\bM_\ba_\bt_\bc_\bh_\bi_\bn_\bg _\bi_\bn _\bH_\bo_\bo_\bk_\bs (section 4.5.1 , page 58) for information on the
- exact format of _\bp_\ba_\bt_\bt_\be_\br_\bn.
+ Prefixing a variable with ``no'' will unset it. Example: set noaskbcc.
- Example: fcc-hook [@.]aol\\.com$ +spammers
+ For boolean variables, you may optionally prefix the variable name with inv to toggle the value (on or off). This is useful when writing macros. Example: set invsmart_wrap.
- The above will save a copy of all messages going to the aol.com domain to the
- `+spammers' mailbox by default. Also see the _\bf_\bc_\bc_\b-_\bs_\ba_\bv_\be_\b-_\bh_\bo_\bo_\bk (section 3.20 ,
- page 40) command.
+ The toggle command automatically prepends the inv prefix to all specified variables.
- _\b3_\b._\b2_\b0 _\bS_\bp_\be_\bc_\bi_\bf_\by _\bd_\be_\bf_\ba_\bu_\bl_\bt _\bs_\ba_\bv_\be _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be _\ba_\bn_\bd _\bd_\be_\bf_\ba_\bu_\bl_\bt _\bF_\bc_\bc_\b: _\bm_\ba_\bi_\bl_\bb_\bo_\bx _\ba_\bt _\bo_\bn_\bc_\be
+ The unset command automatically prepends the no prefix to all specified variables.
- Usage: fcc-save-hook [!]_\bp_\ba_\bt_\bt_\be_\br_\bn _\bm_\ba_\bi_\bl_\bb_\bo_\bx
+ Using the enter-command function in the index menu, you can query the value of a variable by prefixing the name of the variable with a question mark:
+set ?allow_8bit
- This command is a shortcut, equivalent to doing both a _\bf_\bc_\bc_\b-_\bh_\bo_\bo_\bk (section
- 3.19 , page 39) and a _\bs_\ba_\bv_\be_\b-_\bh_\bo_\bo_\bk (section 3.18 , page 39) with its arguments.
+ The question mark is actually only required for boolean and quadoption variables.
- _\b3_\b._\b2_\b1 _\bC_\bh_\ba_\bn_\bg_\be _\bs_\be_\bt_\bt_\bi_\bn_\bg_\bs _\bb_\ba_\bs_\be_\bd _\bu_\bp_\bo_\bn _\bm_\be_\bs_\bs_\ba_\bg_\be _\br_\be_\bc_\bi_\bp_\bi_\be_\bn_\bt_\bs
+ The reset command resets all given variables to the compile time defaults (hopefully mentioned in this manual). If you use the command set and prefix the variable with ``&'' this has the same behavior as the reset command.
- Usage: reply-hook [!]_\bp_\ba_\bt_\bt_\be_\br_\bn _\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ With the reset command there exists the special variable ``all'', which allows you to reset all variables to their system defaults.
- Usage: send-hook [!]_\bp_\ba_\bt_\bt_\be_\br_\bn _\bc_\bo_\bm_\bm_\ba_\bn_\bd
+29. Reading initialization commands from another file
- Usage: send2-hook [!]_\bp_\ba_\bt_\bt_\be_\br_\bn _\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Usage: source filename [ filename ... ]
- These commands can be used to execute arbitrary configuration commands based
- upon recipients of the message. _\bp_\ba_\bt_\bt_\be_\br_\bn is a regular expression matching the
- desired address. _\bc_\bo_\bm_\bm_\ba_\bn_\bd is executed when _\br_\be_\bg_\be_\bx_\bp matches recipients of the
- message.
+ This command allows the inclusion of initialization commands from other files. For example, I place all of my aliases in ˜/.mail_aliases so that I can make my ˜/.muttrc readable and keep my aliases private.
- reply-hook is matched against the message you are _\br_\be_\bp_\bl_\by_\bi_\bn_\bg t\bto\bo, instead of the
- message you are _\bs_\be_\bn_\bd_\bi_\bn_\bg. send-hook is matched against all messages, both _\bn_\be_\bw
- and _\br_\be_\bp_\bl_\bi_\be_\bs. N\bNo\bot\bte\be:\b: reply-hooks are matched b\bbe\bef\bfo\bor\bre\be the send-hook, r\bre\beg\bga\bar\brd\bdl\ble\bes\bss\bs of
- the order specified in the users's configuration file.
+ If the filename begins with a tilde (``˜''), it will be expanded to the path of your home directory.
- send2-hook is matched every time a message is changed, either by editing it, or
- by using the compose menu to change its recipients or subject. send2-hook is
- executed after send-hook, and can, e.g., be used to set parameters such as the
- _\b$_\bs_\be_\bn_\bd_\bm_\ba_\bi_\bl (section 7.4.263 , page 152) variable depending on the message's
- sender address.
+ If the filename ends with a vertical bar (|), then filename is considered to be an executable program from which to read input (eg. source ˜/bin/myscript|).
- For each type of send-hook or reply-hook, when multiple matches occur, commands
- are executed in the order they are specified in the muttrc (for that type of
- hook).
+30. Removing hooks
- See _\bM_\be_\bs_\bs_\ba_\bg_\be _\bM_\ba_\bt_\bc_\bh_\bi_\bn_\bg _\bi_\bn _\bH_\bo_\bo_\bk_\bs (section 4.5.1 , page 58) for information on the
- exact format of _\bp_\ba_\bt_\bt_\be_\br_\bn.
+ Usage: unhook [ * | hook-type ]
- Example: send-hook mutt 'set mime_forward signature='''
+ 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 unhook send-hook.
- Another typical use for this command is to change the values of the
+31. Sharing Setups
- The Mutt Next Generation E-Mail Client 41
+31.1. Character Sets
- _\b$_\ba_\bt_\bt_\br_\bi_\bb_\bu_\bt_\bi_\bo_\bn (section 7.4.18 , page 94), _\b$_\bs_\bi_\bg_\bn_\ba_\bt_\bu_\br_\be (section 7.4.275 , page
- 155) and _\b$_\bl_\bo_\bc_\ba_\bl_\be (section 7.4.120 , page 120) variables in order to change the
- language of the attributions and signatures based upon the recipients.
+ As users may run mutt-ng on different systems, the configuration must be maintained because it's likely that people want to use the setup everywhere they use mutt-ng. And mutt-ng tries to help where it can.
- N\bNo\bot\bte\be:\b: the send-hook's are only executed ONCE after getting the initial list of
- recipients. Adding a recipient after replying or editing the message will NOT
- cause any send-hook to be executed. Also note that my_hdr commands which mod-
- ify recipient headers, or the message's subject, don't have any effect on the
- current message when executed from a send-hook.
+ To not produce conflicts with different character sets, mutt-ng allows users to specify in which character set their configuration files are encoded. Please note that while reading the configuration files, this is only respected after the corresponding declaration appears. It's advised to put the following at the very beginning of a users muttngrc:
+set config_charset = "..."
- _\b3_\b._\b2_\b2 _\bC_\bh_\ba_\bn_\bg_\be _\bs_\be_\bt_\bt_\bi_\bn_\bg_\bs _\bb_\be_\bf_\bo_\br_\be _\bf_\bo_\br_\bm_\ba_\bt_\bt_\bi_\bn_\bg _\ba _\bm_\be_\bs_\bs_\ba_\bg_\be
+ and replacing the dots with the actual character set. To avoid problems while maintaining the setup, vim user's may want to use modelines as show in:
+# vim:fileencoding=...:
- Usage: message-hook [!]_\bp_\ba_\bt_\bt_\be_\br_\bn _\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ while, again, replacing the dots with the appropriate name. This tells vim as which character set to read and save the file.
- This command can be used to execute arbitrary configuration commands before
- viewing or formatting a message based upon information about the message. _\bc_\bo_\bm_\b-
- _\bm_\ba_\bn_\bd is executed if the _\bp_\ba_\bt_\bt_\be_\br_\bn matches the message to be displayed. When mul-
- tiple matches occur, commands are executed in the order they are specified in
- the muttrc.
+31.2. Modularization
- See _\bM_\be_\bs_\bs_\ba_\bg_\be _\bM_\ba_\bt_\bc_\bh_\bi_\bn_\bg _\bi_\bn _\bH_\bo_\bo_\bk_\bs (section 4.5.1 , page 58) for information on the
- exact format of _\bp_\ba_\bt_\bt_\be_\br_\bn.
+ ``Modularization'' means to divide the setup into several files while sorting the options or commands by topic. Especially for longer setups (e.g. with many hooks), this helps maintaining it and solving trouble.
- Example:
+ When using separation, setups may be, as a whole or in fractions, shared over different systems.
- message-hook ~A 'set pager=builtin'
- message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""'
+31.3. Conditional parts
- _\b3_\b._\b2_\b3 _\bC_\bh_\bo_\bo_\bs_\bi_\bn_\bg _\bt_\bh_\be _\bc_\br_\by_\bp_\bt_\bo_\bg_\br_\ba_\bp_\bh_\bi_\bc _\bk_\be_\by _\bo_\bf _\bt_\bh_\be _\br_\be_\bc_\bi_\bp_\bi_\be_\bn_\bt
+ When using a configuration on different systems, the user may not always have influence on how mutt-ng is installed and which features it includes.
- Usage: crypt-hook _\bp_\ba_\bt_\bt_\be_\br_\bn _\bk_\be_\by_\bi_\bd
+ To solve this, mutt-ng contain a feature based on the ``ifdef'' patch written for mutt. Its basic syntax is:
+ifdef <item> <command>
+ifndef <item> <command>
- When encrypting messages with PGP or OpenSSL, you may want to associate a cer-
- tain key with a given e-mail address automatically, either because the recipi-
- ent's public key can't be deduced from the destination address, or because, for
- some reasons, you need to override the key Mutt-ng would normally use. The
- crypt-hook command provides a method by which you can specify the ID of the
- public key to be used when encrypting messages to a certain recipient.
+ ...whereby <item> can be one of:
+ * a function name
+ * a variable name
+ * a menu name
+ * a feature name
- The meaning of "key id" is to be taken broadly in this context: You can either
- put a numerical key ID here, an e-mail address, or even just a real name.
+ 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 feature_:
+ncurses, slang, iconv, idn, dotlock, standalone, pop, nntp, imap, ssl,
+gnutls, sasl, sasl2, libesmtp, compressed, color, classic_pgp,
+classic_smime, gpgme, header_cache
- _\b3_\b._\b2_\b4 _\bA_\bd_\bd_\bi_\bn_\bg _\bk_\be_\by _\bs_\be_\bq_\bu_\be_\bn_\bc_\be_\bs _\bt_\bo _\bt_\bh_\be _\bk_\be_\by_\bb_\bo_\ba_\br_\bd _\bb_\bu_\bf_\bf_\be_\br
+ As an example, one can use the following in ˜/.muttngrc:
+ifdef feature_imap 'source ~/.mutt-ng/setup-imap'
+ifdef feature_pop 'source ~/.mutt-ng/setup-pop'
+ifdef feature_nntp 'source ~/.mutt-ng/setup-nntp'
- Usage: push _\bs_\bt_\br_\bi_\bn_\bg
+ ...to only source ˜/.mutt-ng/setup-imap if IMAP support is built in, only source ˜/.mutt-ng/setup-pop if POP support is built in and only source ˜/.mutt-ng/setup-nntp if NNTP support is built in.
- This command adds the named string to the keyboard buffer. The string may
+ 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 imap-mail-check, use:
+ifdef imap_mail_check 'set imap_mail_check = 300'
- The Mutt Next Generation E-Mail Client 42
+ Provided for completeness is the test for menu names. To set pager-index-lines only if the pager menu is available, use:
+ifdef pager 'set pager_index_lines = 10'
- contain control characters, key names and function names like the sequence
- string in the _\bm_\ba_\bc_\br_\bo (section 3.8 , page 30) command. You may use it to auto-
- matically run a sequence of commands at startup, or when entering certain fold-
- ers.
+ For completeness, too, the opposite of ifdef is provided: ifndef which only executes the command if the test fails. For example, the following two examples are equivalent:
+ifdef feature_ncurses 'source ~/.mutt-ng/setup-ncurses'
+ifndef feature_ncurses 'source ~/.mutt-ng/setup-slang'
- _\b3_\b._\b2_\b5 _\bE_\bx_\be_\bc_\bu_\bt_\bi_\bn_\bg _\bf_\bu_\bn_\bc_\bt_\bi_\bo_\bn_\bs
+ ...and...
+ifdef feature_slang 'source ~/.mutt-ng/setup-slang'
+ifndef feature_slang 'source ~/.mutt-ng/setup-ncurses'
- Usage: exec _\bf_\bu_\bn_\bc_\bt_\bi_\bo_\bn [ _\bf_\bu_\bn_\bc_\bt_\bi_\bo_\bn ... ]
+32. Obsolete Variables
- This command can be used to execute any function. Functions are listed in the
- _\bf_\bu_\bn_\bc_\bt_\bi_\bo_\bn _\br_\be_\bf_\be_\br_\be_\bn_\bc_\be (section 7.5 , page 177). ``exec function'' is equivalent
- to ``push <function>''.
+ In the process of ensuring and creating more consistency, many variables have been renamed and some of the old names were already removed. Please see sect-obsolete for a complete list.
- _\b3_\b._\b2_\b6 _\bM_\be_\bs_\bs_\ba_\bg_\be _\bS_\bc_\bo_\br_\bi_\bn_\bg
+Chapter 4. Advanced Usage
- Usage: score _\bp_\ba_\bt_\bt_\be_\br_\bn _\bv_\ba_\bl_\bu_\be
+ Table of Contents
- Usage: unscore _\bp_\ba_\bt_\bt_\be_\br_\bn [ _\bp_\ba_\bt_\bt_\be_\br_\bn ... ]
+ 1. Regular Expressions
+ 2. Patterns
- In situations where you have to cope with a lot of emails, e.g. when you read
- many different mailing lists, and take part in discussions, it is always useful
- to have the important messages marked and the annoying messages or the ones
- that you aren't interested in deleted. For this purpose, mutt-ng features a
- mechanism called ``scoring''.
+ 2.1. Complex Patterns
+ 2.2. Patterns and Dates
- When you use scoring, every message has a base score of 0. You can then use the
- score command to define patterns and a positive or negative value associated
- with it. When a pattern matches a message, the message's score will be raised
- or lowered by the amount of the value associated with the pattern.
+ 3. Format Strings
- score "~f nion@muttng\.org" 50
- score "~f @sco\.com" -100
+ 3.1. Introduction
+ 3.2. Conditional Expansion
+ 3.3. Modifications and Padding
- If the pattern matches, it is also possible to set the score value of the cur-
- rent message to a certain value and then stop evaluation:
+ 4. Using Tags
+ 5. Using Hooks
- score "~f santaclaus@northpole\.int" =666
+ 5.1. Message Matching in Hooks
- What is important to note is that negative score values will be rounded up to
- 0.
+ 6. Using the sidebar
+ 7. External Address Queries
+ 8. Mailbox Formats
+ 9. Mailbox Shortcuts
+ 10. Handling Mailing Lists
+ 11. Editing threads
- To make scoring actually useful, the score must be applied in some way. That's
- what the _\bs_\bc_\bo_\br_\be _\bt_\bh_\br_\be_\bs_\bh_\bo_\bl_\bd_\bs are for. Currently, there are three score thresholds:
+ 11.1. Linking threads
+ 11.2. Breaking threads
- +\bo flag threshold: when a message has a score value equal or higher than the
- flag threshold, it will be flagged.
+ 12. Delivery Status Notification (DSN) Support
+ 13. POP3 Support (OPTIONAL)
+ 14. IMAP Support (OPTIONAL)
- The Mutt Next Generation E-Mail Client 43
+ 14.1. The Folder Browser
+ 14.2. Authentication
- +\bo read threshold: when a message has a score value equal or lower than the
- read threshold, it will be marked as read.
+ 15. NNTP Support (OPTIONAL)
- +\bo delete threshold: when a message has a score value equal or lower than the
- delete threshold, it will be marked as deleted.
+ 15.1. Again: Scoring
- These three thresholds can be set via the variables _\b$_\bs_\bc_\bo_\br_\be_\b__\bt_\bh_\br_\be_\bs_\bh_\bo_\bl_\bd_\b__\bf_\bl_\ba_\bg (sec-
- tion 7.4.260 , page 152), _\b$_\bs_\bc_\bo_\br_\be_\b__\bt_\bh_\br_\be_\bs_\bh_\bo_\bl_\bd_\b__\br_\be_\ba_\bd (section 7.4.261 , page 152),
- _\b$_\bs_\bc_\bo_\br_\be_\b__\bt_\bh_\br_\be_\bs_\bh_\bo_\bl_\bd_\b__\bd_\be_\bl_\be_\bt_\be (section 7.4.259 , page 152) and. By default,
- _\b$_\bs_\bc_\bo_\br_\be_\b__\bt_\bh_\br_\be_\bs_\bh_\bo_\bl_\bd_\b__\br_\be_\ba_\bd (section 7.4.261 , page 152) and _\b$_\bs_\bc_\bo_\br_\be_\b__\bt_\bh_\br_\be_\bs_\bh_\bo_\bl_\bd_\b__\bd_\be_\bl_\be_\bt_\be
- (section 7.4.259 , page 152) are set to -1, which means that in the default
- threshold configuration no message will ever get marked as read or deleted.
+ 16. SMTP Support (OPTIONAL)
+ 17. Managing multiple IMAP/POP/NNTP accounts (OPTIONAL)
+ 18. Start a WWW Browser on URLs (EXTERNAL)
+ 19. Compressed folders Support (OPTIONAL)
- Scoring gets especially interesting when combined with the color command and
- the ~n pattern:
+ 19.1. Open a compressed mailbox for reading
+ 19.2. Write a compressed mailbox
+ 19.3. Append a message to a compressed mailbox
+ 19.4. Encrypted folders
- color index black yellow "~n 10-"
- color index red yellow "~n 100-"
+1. Regular Expressions
- The rules above mark all messages with a score between 10 and 99 with black and
- yellow, and messages with a score greater or equal 100 with red and yellow.
- This might be unusual to you if you're used to e.g. slrn's scoring mechanism,
- but it is more flexible, as it visually marks different scores.
+ All string patterns in Mutt-ng including those in more complex patterns must be specified using regular expressions (regexp) in the ``POSIX extended'' syntax (which is more or less the syntax used by egrep and GNU awk). For your convenience, we have included below a brief description of this syntax.
- _\b3_\b._\b2_\b7 _\bS_\bp_\ba_\bm _\bd_\be_\bt_\be_\bc_\bt_\bi_\bo_\bn
+ The search is case sensitive if the pattern contains at least one upper case letter, and case insensitive otherwise. Note that ``\'' must be quoted if used for a regular expression in an initialization command: ``\\''.
- Usage: spam _\bp_\ba_\bt_\bt_\be_\br_\bn _\bf_\bo_\br_\bm_\ba_\bt
+ A regular expression is a pattern that describes a set of strings. Regular expressions are constructed analogously to arithmetic expressions, by using various operators to combine smaller expressions.
- Usage: nospam _\bp_\ba_\bt_\bt_\be_\br_\bn
+ 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 muttrc-syntax for more information on " and ' delimiter processing. To match a literal " or ' you must preface it with \ (backslash).
- Mutt-ng has generalized support for external spam-scoring filters. By defining
- your spam patterns with the spam and nospam commands, you can _\bl_\bi_\bm_\bi_\bt, _\bs_\be_\ba_\br_\bc_\bh,
- and _\bs_\bo_\br_\bt 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 %H selector in the _\b$_\bi_\bn_\bd_\be_\bx_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.116 , page 116) variable.
- (Tip: try %?H?[%H] ? to display spam tags only when they are defined for a
- given message.)
+ The fundamental building blocks are the regular expressions that match a single character. Most characters, including all letters and digits, are regular expressions that match themselves. Any metacharacter with special meaning may be quoted by preceding it with a backslash.
- Your first step is to define your external filter's spam patterns using the
- spam command. _\bp_\ba_\bt_\bt_\be_\br_\bn should be a regular expression that matches a header in a
- mail message. If any message in the mailbox matches this regular expression, it
- will receive a ``spam tag'' or ``spam attribute'' (unless it also matches a
- nospam pattern -- see below.) The appearance of this attribute is entirely up
- to you, and is governed by the _\bf_\bo_\br_\bm_\ba_\bt parameter. _\bf_\bo_\br_\bm_\ba_\bt can be any static text,
- but it also can include back-references from the _\bp_\ba_\bt_\bt_\be_\br_\bn expression. (A regular
- expression ``back-reference'' refers to a sub-expression contained within
- parentheses.) %1 is replaced with the first back-reference in the regex, %2
- with the second, etc.
+ The period ``.'' matches any single character. The caret ``^'' and the dollar sign ``$'' are metacharacters that respectively match the empty string at the beginning and end of a line.
- If you're using multiple spam filters, a message can have more than one spam-
+ 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 not in the list. For example, the regular expression [0123456789] matches any single digit. A range of ASCII characters may be specified by giving the first and last characters, separated by a hyphen ``-''. Most metacharacters lose their special meaning inside lists. To include a literal ``]'' place it first in the list. Similarly, to include a literal ``^'' place it anywhere but first. Finally, to include a literal hyphen ``-'' place it last.
- The Mutt Next Generation E-Mail Client 44
+ Certain named classes of characters are predefined. Character classes consist of ``[:'', a keyword denoting the class, and ``:]''. The following classes are defined by the POSIX standard:
- related header. You can define spam patterns for each filter you use. If a mes-
- sage matches two or more of these patterns, and the $spam_separator variable is
- set to a string, then the message's spam tag will consist of all the _\bf_\bo_\br_\bm_\ba_\bt
- strings joined together, with the value of $spam_separator separating them.
+ [:alnum:]
+ Alphanumeric characters.
- For example, suppose I use DCC, SpamAssassin, and PureMessage. I might define
- these spam settings:
+ [:alpha:]
+ Alphabetic characters.
- 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=", "
+ [:blank:]
+ Space or tab characters.
- If I then received a message that DCC registered with ``many'' hits under the
- ``Fuz2'' checksum, and that PureMessage registered with a 97% probability of
- being spam, that message's spam tag would read 90+/DCC-Fuz2, 97/PM. (The four
- characters before ``=many'' in a DCC report indicate the checksum used -- in
- this case, ``Fuz2''.)
+ [:cntrl:]
+ Control characters.
- If the $spam_separator variable is unset, then each spam pattern match super-
- sedes the previous one. Instead of getting joined _\bf_\bo_\br_\bm_\ba_\bt strings, you'll get
- only the last one to match.
+ [:digit:]
+ Numeric characters.
- The spam tag is what will be displayed in the index when you use %H in the
- $index_format variable. It's also the string that the ~H pattern-matching
- expression matches against for _\bs_\be_\ba_\br_\bc_\bh and _\bl_\bi_\bm_\bi_\bt functions. And it's what sort-
- ing by spam attribute will use as a sort key.
+ [:graph:]
+ Characters that are both printable and visible. (A space is printable, but not visible, while an ``a'' is both.)
- That's a pretty complicated example, and most people's actual environments will
- have only one spam filter. The simpler your configuration, the more effective
- mutt can be, especially when it comes to sorting.
+ [:lower:]
+ Lower-case alphabetic characters.
- Generally, when you sort by spam tag, mutt will sort _\bl_\be_\bx_\bi_\bc_\ba_\bl_\bl_\by -- that is, by
- ordering strings alphnumerically. However, if a spam tag begins with a number,
- mutt will sort numerically first, and lexically only when two numbers are equal
- in value. (This is like UNIX's sort -n.) A message with no spam attributes at
- all -- that is, one that didn't match _\ba_\bn_\by of your spam patterns -- is sorted at
- lowest priority. Numbers are sorted next, beginning with 0 and ranging upward.
- Finally, non-numeric strings are sorted, with ``a'' taking lower priority than
- ``z''. Clearly, in general, sorting by spam tags is most effective when you can
- coerce your filter to give you a raw number. But in case you can't, mutt can
- still do something useful.
+ [:print:]
+ Printable characters (characters that are not control characters.)
- The nospam command can be used to write exceptions to spam patterns. If a
- header pattern matches something in a spam command, but you nonetheless do not
- want it to receive a spam tag, you can list a more precise pattern under a
- nospam command.
+ [:punct:]
+ Punctuation characters (characters that are not letter, digits, control characters, or space characters).
- If the _\bp_\ba_\bt_\bt_\be_\br_\bn given to nospam is exactly the same as the _\bp_\ba_\bt_\bt_\be_\br_\bn on an exist-
- ing spam list entry, the effect will be to remove the entry from the spam list,
- instead of adding an exception. Likewise, if the _\bp_\ba_\bt_\bt_\be_\br_\bn for a spam command
- matches an entry on the nospam list, that nospam entry will be removed. If the
- _\bp_\ba_\bt_\bt_\be_\br_\bn for nospam is ``*'', _\ba_\bl_\bl _\be_\bn_\bt_\br_\bi_\be_\bs _\bo_\bn _\bb_\bo_\bt_\bh _\bl_\bi_\bs_\bt_\bs will be removed. This
+ [:space:]
+ Space characters (such as space, tab and formfeed, to name a few).
- The Mutt Next Generation E-Mail Client 45
+ [:upper:]
+ Upper-case alphabetic characters.
- might be the default action if you use spam and nospam in conjunction with a
- folder-hook.
+ [:xdigit:]
+ Characters that are hexadecimal digits.
- You can have as many spam or nospam commands as you like. You can even do your
- own primitive spam detection within mutt -- for example, if you consider all
- mail from MAILER-DAEMON to be spam, you can use a spam command like this:
+ A character class is only valid in a regular expression inside the brackets of a character list. Note that the brackets in these class names are part of the symbolic names, and must be included in addition to the brackets delimiting the bracket list. For example, [[:digit:]] is equivalent to [0-9].
- spam "^From: .*MAILER-DAEMON" "999"
+ Two additional special sequences can appear in character lists. These apply to non-ASCII character sets, which can have single symbols (called collating elements) that are represented with more than one character, as well as several characters that are equivalent for collating or sorting purposes:
- _\b3_\b._\b2_\b8 _\bS_\be_\bt_\bt_\bi_\bn_\bg _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be_\bs
+ Collating Symbols
+ A collating symbol is a multi-character collating element enclosed in ``[.'' and ``.]''. For example, if ``ch'' is a collating element, then [[.ch.]] is a regexp that matches this collating element, while [ch] is a regexp that matches either ``c'' or ``h''.
- Usage: set [no|inv]_\bv_\ba_\br_\bi_\ba_\bb_\bl_\be[=_\bv_\ba_\bl_\bu_\be] [ _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be ... ]
+ Equivalence Classes
+ An equivalence class is a locale-specific name for a list of characters that are equivalent. The name is enclosed in ``[='' and ``=]''. For example, the name ``e'' might be used to represent all of ``è'' ``é'' and ``e''. In this case, [[=e=]] is a regexp that matches any of ``è'', ``é'' and ``e''.
- Usage: toggle _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be [_\bv_\ba_\br_\bi_\ba_\bb_\bl_\be ... ]
+ A regular expression matching a single character may be followed by one of several repetition operators:
- Usage: unset _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be [_\bv_\ba_\br_\bi_\ba_\bb_\bl_\be ... ]
+ ?
+ The preceding item is optional and matched at most once.
- Usage: reset _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be [_\bv_\ba_\br_\bi_\ba_\bb_\bl_\be ... ]
+ *
+ The preceding item will be matched zero or more times.
- This command is used to set (and unset) _\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be_\bs (section 7.4 ,
- page 88). There are four basic types of variables: boolean, number, string and
- quadoption. _\bb_\bo_\bo_\bl_\be_\ba_\bn variables can be _\bs_\be_\bt (true) or _\bu_\bn_\bs_\be_\bt (false). _\bn_\bu_\bm_\bb_\be_\br
- variables can be assigned a positive integer value.
+ +
+ The preceding item will be matched one or more times.
- _\bs_\bt_\br_\bi_\bn_\bg variables consist of any number of printable characters. _\bs_\bt_\br_\bi_\bn_\bg_\bs must
- be enclosed in quotes if they contain spaces or tabs. You may also use the
- ``C'' escape sequences \\b\n\bn and \\b\t\bt for newline and tab, respectively.
+ {n}
+ The preceding item is matched exactly n times.
- _\bq_\bu_\ba_\bd_\bo_\bp_\bt_\bi_\bo_\bn variables are used to control whether or not to be prompted for cer-
- tain actions, or to specify a default action. A value of _\by_\be_\bs will cause the
- action to be carried out automatically as if you had answered yes to the ques-
- tion. Similarly, a value of _\bn_\bo will cause the the action to be carried out as
- if you had answered ``no.'' A value of _\ba_\bs_\bk_\b-_\by_\be_\bs will cause a prompt with a
- default answer of ``yes'' and _\ba_\bs_\bk_\b-_\bn_\bo will provide a default answer of ``no.''
+ {n,}
+ The preceding item is matched n or more times.
- Prefixing a variable with ``no'' will unset it. Example: set noaskbcc.
+ {,m}
+ The preceding item is matched at most m times.
- For _\bb_\bo_\bo_\bl_\be_\ba_\bn variables, you may optionally prefix the variable name with inv to
- toggle the value (on or off). This is useful when writing macros. Example:
- set invsmart_wrap.
+ {n,m}
+ The preceding item is matched at least n times, but no more than m times.
- The toggle command automatically prepends the inv prefix to all specified vari-
- ables.
+ Two regular expressions may be concatenated; the resulting regular expression matches any string formed by concatenating two substrings that respectively match the concatenated subexpressions.
- The unset command automatically prepends the no prefix to all specified vari-
- ables.
+ Two regular expressions may be joined by the infix operator ``|''; the resulting regular expression matches any string matching either subexpression.
- Using the enter-command function in the _\bi_\bn_\bd_\be_\bx menu, you can query the value of
- a variable by prefixing the name of the variable with a question mark:
+ Repetition takes precedence over concatenation, which in turn takes precedence over alternation. A whole subexpression may be enclosed in parentheses to override these precedence rules.
- The Mutt Next Generation E-Mail Client 46
+ Note: If you compile Mutt-ng with the GNU rx package, the following operators may also be used in regular expressions:
- set ?allow_8bit
+ \\y
+ Matches the empty string at either the beginning or the end of a word.
- The question mark is actually only required for boolean and quadoption vari-
- ables.
+ \\B
+ Matches the empty string within a word.
- The reset command resets all given variables to the compile time defaults
- (hopefully mentioned in this manual). If you use the command set and prefix the
- variable with ``&'' this has the same behavior as the reset command.
+ \\<
+ Matches the empty string at the beginning of a word.
- With the reset command there exists the special variable ``all'', which allows
- you to reset all variables to their system defaults.
+ \\>
+ Matches the empty string at the end of a word.
- _\b3_\b._\b2_\b9 _\bR_\be_\ba_\bd_\bi_\bn_\bg _\bi_\bn_\bi_\bt_\bi_\ba_\bl_\bi_\bz_\ba_\bt_\bi_\bo_\bn _\bc_\bo_\bm_\bm_\ba_\bn_\bd_\bs _\bf_\br_\bo_\bm _\ba_\bn_\bo_\bt_\bh_\be_\br _\bf_\bi_\bl_\be
+ \\w
+ Matches any word-constituent character (letter, digit, or underscore).
- Usage: source _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be [ _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be ... ]
+ \\W
+ Matches any character that is not word-constituent.
- This command allows the inclusion of initialization commands from other files.
- For example, I place all of my aliases in ~/.mail_aliases so that I can make my
- ~/.muttrc readable and keep my aliases private.
+ \\`
+ Matches the empty string at the beginning of a buffer (string).
- If the filename begins with a tilde (``~''), it will be expanded to the path of
- your home directory.
+ \\'
+ Matches the empty string at the end of a buffer.
- If the filename ends with a vertical bar (|), then _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be is considered to be
- an executable program from which to read input (eg. source ~/bin/myscript|).
+ Please note however that these operators are not defined by POSIX, so they may or may not be available in stock libraries on various systems.
- _\b3_\b._\b3_\b0 _\bR_\be_\bm_\bo_\bv_\bi_\bn_\bg _\bh_\bo_\bo_\bk_\bs
+2. Patterns
- Usage: unhook [ * | _\bh_\bo_\bo_\bk_\b-_\bt_\by_\bp_\be ]
+ 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 patterns in the Reference chapter.
- 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 unhook send-
- hook.
+ It must be noted that in this table, EXPR, USER, ID and SUBJECT are regular expressions. For ranges, the forms <[MAX], >>[MIN], [MIN]- and -[MAX] are also possible.
- _\b3_\b._\b3_\b1 _\bS_\bh_\ba_\br_\bi_\bn_\bg _\bS_\be_\bt_\bu_\bp_\bs
+2.1. Complex Patterns
- _\b3_\b._\b3_\b1_\b._\b1 _\bC_\bh_\ba_\br_\ba_\bc_\bt_\be_\br _\bS_\be_\bt_\bs
+ It is possible to combine several sub-patterns to a more complex pattern. The most simple possibility is to logically AND several patterns by stringing them together:
+~s 'SPAM' ~U
- As users may run mutt-ng on different systems, the configuration must be main-
- tained because it's likely that people want to use the setup everywhere they
- use mutt-ng. And mutt-ng tries to help where it can.
+ The pattern above matches all messages that contain ``SPAM'' in the subject and are unread.
- To not produce conflicts with different character sets, mutt-ng allows users to
- specify in which character set their configuration files are encoded. Please
- note that while reading the configuration files, this is only respected after
- the corresponding declaration appears. It's advised to put the following at the
+ To logical OR patterns, simply use the | operator. This one especially useful when using local groups:
+~f ("nion@muttng\.org"|"ak@muttng\.org"|"pdmef@muttng\.org")
+(~b mutt-ng|~s Mutt-ng)
+!~x '@synflood\.at'
- The Mutt Next Generation E-Mail Client 47
+ The first pattern matches all messages that were sent by one of the mutt-ng maintainers, while the seconds pattern matches all messages that contain ``mutt-ng'' in the message body or ``Mutt-ng'' in the subject. The third pattern matches all messages that do not contain ``@synflood\.at'' in the References: header, i.e. messages that are not an (indirect) reply to one of my messages. A pattern can be logicall negated using the ! operator.
- very beginning of a users muttngrc:
+2.2. Patterns and Dates
- set config_charset = "..."
+ When using dates in patterns, the dates must be specified in a special format, i.e. DD/MM/YYYY. If you don't specify month or year, they default to the current month or year. When using date ranges, and you specify only the minimum or the maximum, the specified date will be excluded, e.g. 01/06/2005- matches against all messages after Juni 1st, 2005.
- and replacing the dots with the actual character set. To avoid problems while
- maintaining the setup, vim user's may want to use modelines as show in:
+ It is also possible to use so-called ``error margins'' when specifying date ranges. You simply specify a date, and then the error margin. This margin needs to contain the information whether it goes ``forth'' or ``back'' in time, by using + and -. Then follows a number and a unit, i.e. y for years, m for months, w for weeks and d for days. If you use the special * sign, it means that the error margin goes to both ``directions'' in time.
+~d 01/01/2005+1y
+~d 18/10/2004-2w
+~d 28/12/2004*1d
- # vim:fileencoding=...:
+ The first pattern matches all dates between January 1st, 2005 and January 1st 2006. The second pattern matches all dates between October 18th, 2004 and October 4th 2004 (2 weeks before 18/10/2004), while the third pattern matches all dates 1 day around December 28th, 2004 (i.e. Dec 27th, 28th and 29th).
- while, again, replacing the dots with the appropriate name. This tells vim as
- which character set to read and save the file.
+ Relative dates are also very important, as they make it possible to specify date ranges between a fixed number of units and the current date. How this works can be seen in the following example:
+~d >2w # messages older than two weeks
+~d <3d # messages newer than 3 days
+~d =1m # messages that are exactly one month old
- _\b3_\b._\b3_\b1_\b._\b2 _\bM_\bo_\bd_\bu_\bl_\ba_\br_\bi_\bz_\ba_\bt_\bi_\bo_\bn
+3. Format Strings
- ``Modularization'' means to divide the setup into several files while sorting
- the options or commands by topic. Especially for longer setups (e.g. with many
- hooks), this helps maintaining it and solving trouble.
+3.1. Introduction
- When using separation, setups may be, as a whole or in fractions, shared over
- different systems.
+ The so called Format Strings offer great flexibility when configuring mutt-ng. In short, they describe what items to print out how in menus and status messages.
- _\b3_\b._\b3_\b1_\b._\b3 _\bC_\bo_\bn_\bd_\bi_\bt_\bi_\bo_\bn_\ba_\bl _\bp_\ba_\br_\bt_\bs
+ Basically, they work as this: for different menus and bars, there's a variable specifying the layout. For every item available, there is a so called expando.
- When using a configuration on different systems, the user may not always have
- influence on how mutt-ng is installed and which features it includes.
+ For example, when running mutt-ng on different machines or different versions for testing purposes, it may be interesting to have the following information always printed on screen when one is in the index:
+ * the current hostname
+ * the current mutt-ng version number
- To solve this, mutt-ng contain a feature based on the ``ifdef'' patch written
- for mutt. Its basic syntax is:
+ The setting for the status bar of the index is controlled via the status-format variable. For the hostname and version string, there's an expando for $status_format: %h expands to the hostname and %v to the version string. When just configuring:
+set status_format = "%v on %h: ..."
- ifdef <item> <command>
- ifndef <item> <command>
+ mutt-ng will replace the sequence %v with the version string and %h with the host's name. When you are, for example, running mutt-ng version 1.5.9i on host mailhost, you'll see the following when you're in the index:
+Mutt-ng 1.5.9i on mailhost: ...
- ...whereby <item> can be one of:
+ In the index, there're more useful information one could want to see:
+ * which mailbox is open
+ * how man new, flagged or postponed messages
+ * ...
- +\bo a function name
+ To include the mailbox' name is as easy as:
+set status_format = "%v on %h: %B: ...
- +\bo a variable name
+ When the currently opened mailbox is Inbox, this will be expanded to:
+Mutt-ng 1.5.9i on mailhost: Inbox: ...
- +\bo a menu name
+ For the number of certain types of messages, one more feature of the format strings is extremely useful. If there aren't messages of a certain type, it may not be desired to print just that there aren't any but instead only print something if there are any.
- +\bo a feature name
+3.2. Conditional Expansion
- All available functions, variables and menus are documented elsewhere in this
- manual but ``features'' is specific to these two commands. To test for one,
+ To only print the number of messages if there are new messages in the current mailbox, further extend $status_format to:
+set status_format = "%v on %h: %B %?n?%n new? ...
- The Mutt Next Generation E-Mail Client 48
+ This feature is called nonzero-printing and works as this: some expandos may be optionally printed nonzero, i.e. a portion of the format string is only evaluated if the value of the expando is different from zero. The basic syntax is:
+%?<item>?<string if nonzero>?
- prefix one of the following keywords with feature_:
+ which tells mutt-ng to only look at <string if nonzero> if the value of the %<item%gt; expando is different from zero. In our example, we used n as the expando to check for and %n new as the optional nonzero string.
- ncurses, slang, iconv, idn, dotlock, standalone, pop, nntp, imap, ssl,
- gnutls, sasl, sasl2, libesmtp, compressed, color, classic_pgp,
- classic_smime, gpgme, header_cache
+ But this is not all: this feature only offers one alternative: ``print something if not zero.'' Mutt-ng does, as you might guess, also provide a logically complete version: ``if zero, print something and else print something else.'' This is achieved by the following syntax for those expandos which may be printed nonzero:
+%?<item>?<string if nonzero>&<string if zero>?
- As an example, one can use the following in ~/.muttngrc:
+ Using this we can make mutt-ng to do the following:
+ * make it print ``n new messages'' whereby n is the count but only if there new ones
+ * and make it print ``no new messages'' if there aren't any
- ifdef feature_imap 'source ~/.mutt-ng/setup-imap'
- ifdef feature_pop 'source ~/.mutt-ng/setup-pop'
- ifdef feature_nntp 'source ~/.mutt-ng/setup-nntp'
+ The corresponding configuration is:
+set status_format = "%v on %h: %B: %?n?%n new messages&no new messages? ...
- ...to only source ~/.mutt-ng/setup-imap if IMAP support is built in, only
- source ~/.mutt-ng/setup-pop if POP support is built in and only source ~/.mutt-
- ng/setup-nntp if NNTP support is built in.
+ This doubles the use of the ``new messages'' string because it'll get always printed. Thus, it can be shortened to:
+set status_format = "%v on %h: %B: %?n?%n&no? new messages ...
- 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 _\b$_\bi_\bm_\ba_\bp_\b__\bm_\ba_\bi_\bl_\b__\bc_\bh_\be_\bc_\bk (section 7.4.105 , page 114),
- use:
+ As you might see from this rather simple example, one can create very complex but fancy status messages. Please see the reference chapter for expandos and those which may be printed nonzero.
- ifdef imap_mail_check 'set imap_mail_check = 300'
+3.3. Modifications and Padding
- Provided for completeness is the test for menu names. To set _\b$_\bp_\ba_\bg_\be_\br_\b__\bi_\bn_\bd_\be_\bx_\b__\bl_\bi_\bn_\be_\bs
- (section 7.4.185 , page 134) only if the pager menu is available, use:
+ Besides the information given so far, there're even more features of format strings:
+ * When specifying %_<item> instead of just %<item>, mutt-ng will convert all characters in the expansion of <item> to lowercase.
+ * When specifying %:<item> instead of just %<item>, mutt-ng will convert all dots in the expansion of <item> to underscores (_).
- ifdef pager 'set pager_index_lines = 10'
+ Also, there's a feature called Padding supplied by the following two expandos: %|X and %>X.
- For completeness, too, the opposite of ifdef is provided: ifndef which only
- executes the command if the test fails. For example, the following two examples
- are equivalent:
+ %|X
+ When this occurs, mutt-ng will fill the rest of the line with the character X. In our example, filling the rest of the line with dashes is done by setting:
- ifdef feature_ncurses 'source ~/.mutt-ng/setup-ncurses'
- ifndef feature_ncurses 'source ~/.mutt-ng/setup-slang'
+set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"
- ...and...
+ %>X
+ Since the previous expando stops at the end of line, there must be a way to fill the gap between two items via the %>X expando: it puts as many characters X 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 %>):
- ifdef feature_slang 'source ~/.mutt-ng/setup-slang'
- ifndef feature_slang 'source ~/.mutt-ng/setup-ncurses'
+set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"
- The Mutt Next Generation E-Mail Client 49
+4. Using Tags
- _\b3_\b._\b3_\b2 _\bO_\bb_\bs_\bo_\bl_\be_\bt_\be _\bV_\ba_\br_\bi_\ba_\bb_\bl_\be_\bs
+ Sometimes it is desirable to perform an operation on a group of messages all at once rather than one at a time. An example might be to save messages to a mailing list to a separate folder, or to delete all messages with a given subject. To tag all messages 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 patterns for Mutt-ng's pattern matching syntax.
- In the process of ensuring and creating more consistency, many variables have
- been renamed and some of the old names were already removed. Please see _\bO_\bb_\bs_\bo_\b-
- _\bl_\be_\bt_\be _\bV_\ba_\br_\bi_\ba_\bb_\bl_\be_\bs (section 7.4 , page 88) for a complete list.
+ Once you have tagged the desired messages, you can use the ``tag-prefix'' operator, which is the ``;'' (semicolon) key by default. When the ``tag-prefix'' operator is used, the next operation will be applied to all tagged messages if that operation can be used in that manner. If the auto-tag variable is set, the next operation applies to the tagged messages automatically, without requiring the ``tag-prefix''.
- _\b4_\b. _\bA_\bd_\bv_\ba_\bn_\bc_\be_\bd _\bU_\bs_\ba_\bg_\be
+ In macro or 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 ``end-cond'' operator; after this operator the rest of the macro will be executed as normal.
- _\b4_\b._\b1 _\bR_\be_\bg_\bu_\bl_\ba_\br _\bE_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn_\bs
+5. Using Hooks
- All string patterns in Mutt-ng including those in more complex _\bp_\ba_\bt_\bt_\be_\br_\bn_\bs (sec-
- tion 7.2 , page 84) must be specified using regular expressions (regexp) in
- the ``POSIX extended'' syntax (which is more or less the syntax used by egrep
- and GNU awk). For your convenience, we have included below a brief description
- of this syntax.
+ A hook is a concept borrowed from the EMACS editor which allows you to execute arbitrary commands before performing some operation. For example, you may wish to tailor your configuration based upon which mailbox you are reading, or to whom you are sending mail. In the Mutt-ng world, a hook consists of a regexp or patterns along with a configuration option/command. See
+ * folder-hook
+ * send-hook
+ * message-hook
+ * save-hook
+ * mbox-hook
+ * fcc-hook
+ * fcc-save-hook
- The search is case sensitive if the pattern contains at least one upper case
- letter, and case insensitive otherwise. Note that ``\'' must be quoted if used
- for a regular expression in an initialization command: ``\\''.
+ for specific details on each type of hook available.
- A regular expression is a pattern that describes a set of strings. Regular
- expressions are constructed analogously to arithmetic expressions, by using
- various operators to combine smaller expressions.
+ Note: if a hook changes configuration settings, these changes remain effective until the end of the current mutt session. As this is generally not desired, a default hook needs to be added before all other hooks to restore configuration defaults. Here is an example with send-hook and the my_hdr directive:
+send-hook . 'unmy_hdr From:'
+send-hook ~C'^b@b\.b$' my_hdr from: c@c.c
- 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 _\bS_\by_\bn_\bt_\ba_\bx _\bo_\bf _\bI_\bn_\bi_\bt_\bi_\ba_\bl_\bi_\bz_\ba_\bt_\bi_\bo_\bn _\bF_\bi_\bl_\be_\bs (section 3.2 , page 21) for more informa-
- tion on ' and ' delimiter processing. To match a literal ' or ' you must pref-
- ace it with \ (backslash).
+5.1. Message Matching in Hooks
- The fundamental building blocks are the regular expressions that match a single
- character. Most characters, including all letters and digits, are regular
- expressions that match themselves. Any metacharacter with special meaning may
- be quoted by preceding it with a backslash.
+ Hooks that act upon messages (send-hook, save-hook, fcc-hook, message-hook) are evaluated in a slightly different manner. For the other types of hooks, a regexp is sufficient. But in dealing with messages a finer grain of control is needed for matching since for different purposes you want to match different criteria.
- The period ``.'' matches any single character. The caret ``^'' and the dollar
- sign ``$'' are metacharacters that respectively match the empty string at the
- beginning and end of a line.
+ Mutt-ng allows the use of the patterns language for matching messages in hook commands. This works in exactly the same way as it would when limiting or searching the mailbox, except that you are restricted to those operators which match information mutt extracts from the header of the message (i.e. from, to, cc, date, subject, etc.).
- 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 n\bno\bot\bt in the list. For example, the regular expression
- [\b[0\b01\b12\b23\b34\b45\b56\b67\b78\b89\b9]\b] 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 lit-
- eral ``]'' 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.
+ For example, if you wanted to set your return address based upon sending mail to a specific address, you could do something like:
+send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt-ng User <user@host>'
- The Mutt Next Generation E-Mail Client 50
+ which would execute the given command when sending mail to me@cs.hmc.edu.
- Certain named classes of characters are predefined. Character classes consist
- of ``[:'', a keyword denoting the class, and ``:]''. The following classes are
- defined by the POSIX standard:
+ However, it is not required that you write the pattern to match using the full searching language. You can still specify a simple regular expression like the other hooks, in which case Mutt-ng will translate your pattern into the full language, using the translation specified by the default-hook variable. The pattern is translated at the time the hook is declared, so the value of default-hook that is in effect at that time will be used.
- [:alnum:]
- Alphanumeric characters.
+6. Using the sidebar
- [:alpha:]
- Alphabetic characters.
+ The sidebar, a feature specific to Mutt-ng, allows you to use a mailbox listing which looks very similar to the ones you probably know from GUI mail clients. The sidebar lists all specified mailboxes, shows the number in each and highlights the ones with new email Use the following configuration commands:
+set sidebar_visible="yes"
+set sidebar_width=25
- [:blank:]
- Space or tab characters.
+ If you want to specify the mailboxes you can do so with:
+set mbox='=INBOX'
+mailboxes INBOX \
+ MBOX1 \
+ MBOX2 \
+ ...
- [:cntrl:]
- Control characters.
+ You can also specify the colors for mailboxes with new mails by using:
+color sidebar_new red black
+color sidebar white black
- [:digit:]
- Numeric characters.
+ The available functions are:
+sidebar-scroll-up Scrolls the mailbox list up 1 page
+sidebar-scroll-down Scrolls the mailbox list down 1 page
+sidebar-next Highlights the next mailbox
+sidebar-next-new Highlights the next mailbox with new mail
+sidebar-previous Highlights the previous mailbox
+sidebar-open Opens the currently highlighted mailbox
- [:graph:]
- Characters that are both printable and visible. (A space is print-
- able, but not visible, while an ``a'' is both.)
+ Reasonable key bindings look e.g. like this:
+bind index \Cp sidebar-prev
+bind index \Cn sidebar-next
+bind index \Cb sidebar-open
+bind pager \Cp sidebar-prev
+bind pager \Cn sidebar-next
+bind pager \Cb sidebar-open
- [:lower:]
- Lower-case alphabetic characters.
+macro index B ':toggle sidebar_visible^M'
+macro pager B ':toggle sidebar_visible^M'
- [:print:]
- Printable characters (characters that are not control characters.)
+ You can then go up and down by pressing Ctrl-P and Ctrl-N, and switch on and off the sidebar simply by pressing 'B'.
- [:punct:]
- Punctuation characters (characters that are not letter, digits,
- control characters, or space characters).
+7. External Address Queries
- [:space:]
- Space characters (such as space, tab and formfeed, to name a few).
+ 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 query-command variable, you specify the wrapper command to use. For example:
+set query_command = "mutt_ldap_query.pl '%s'"
- [:upper:]
- Upper-case alphabetic characters.
+ The wrapper script should accept the query on the command-line. It should return a one line message, then each matching response on a single line, each line containing a tab separated address then name then some other optional information. On error, or if there are no matching addresses, return a non-zero exit code and a one line error message.
- [:xdigit:]
- Characters that are hexadecimal digits.
+ An example multiple response output:
+Searching database ... 20 entries ... 3 matching:
+me@cs.hmc.edu Michael Elkins mutt dude
+blong@fiction.net Brandon Long mutt and more
+roessler@guug.de Thomas Roessler mutt pgp
- A character class is only valid in a regular expression inside the brackets of
- a character list. Note that the brackets in these class names are part of the
- symbolic names, and must be included in addition to the brackets delimiting the
- bracket list. For example, [\b[[\b[:\b:d\bdi\big\bgi\bit\bt:\b:]\b]]\b] is equivalent to [\b[0\b0-\b-9\b9]\b].
+ There are two mechanisms for accessing the query function of mutt. One is to do a query from the index menu using the query function (default: Q). This will prompt for a query, then bring up the query menu which will list the matching responses. From the query menu, you can select addresses to create aliases, or to mail. You can tag multiple addresses to mail, start a new query, or have a new query appended to the current responses.
- Two additional special sequences can appear in character lists. These apply to
- non-ASCII character sets, which can have single symbols (called collating ele-
- ments) that are represented with more than one character, as well as several
- characters that are equivalent for collating or sorting purposes:
+ The other mechanism for accessing the query function is for address completion, similar to the alias completion. In any prompt for address entry, you can use the complete-query function (default: ^T) to run a query based on the current address you have typed. Like aliases, mutt will look for what you have typed back to the last space or comma. If there is a single response for that query, mutt will expand the address in place. If there are multiple responses, mutt will activate the query menu. At the query menu, you can select one or more addresses to be added to the prompt.
- Collating Symbols
- A collating symbol is a multi-character collating element enclosed
+8. Mailbox Formats
- The Mutt Next Generation E-Mail Client 51
+ 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 new mailboxes, Mutt-ng uses the default specified with the mbox-type variable.
- in ``[.'' and ``.]''. For example, if ``ch'' is a collating ele-
- ment, then [\b[[\b[.\b.c\bch\bh.\b.]\b]]\b] is a regexp that matches this collating ele-
- ment, while [\b[c\bch\bh]\b] is a regexp that matches either ``c'' or ``h''.
+ mbox. This is the most widely used mailbox format for UNIX. All messages are stored in a single file. Each message has a line of the form:
+From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST
- Equivalence Classes
- An equivalence class is a locale-specific name for a list of char-
- acters that are equivalent. The name is enclosed in ``[='' and
- ``=]''. For example, the name ``e'' might be used to represent all
- of ``'' ``'' and ``e''. In this case, [\b[[\b[=\b=e\be=\b=]\b]]\b] is a regexp that
- matches any of ``'', ``'' and ``e''.
+ to denote the start of a new message (this is often referred to as the ``From_'' line).
- A regular expression matching a single character may be followed by one of sev-
- eral repetition operators:
+ MMDF. This is a variant of the mbox format. Each message is surrounded by lines containing ``^A^A^A^A'' (four control-A's).
- ?
- The preceding item is optional and matched at most once.
+ MH. A radical departure from mbox and MMDF, a mailbox consists of a directory and each message is stored in a separate file. The filename indicates the message number (however, this is may not correspond to the message number Mutt-ng displays). Deleted messages are renamed with a comma (,) prepended to the filename. Note: Mutt detects this type of mailbox by looking for either .mh_sequences or .xmhcache (needed to distinguish normal directories from MH mailboxes).
- *
- The preceding item will be matched zero or more times.
+ Maildir. The newest of the mailbox formats, used by the Qmail MTA (a replacement for sendmail). Similar to MH, except that it adds three subdirectories of the mailbox: tmp, new and cur. Filenames for the messages are chosen in such a way they are unique, even when two programs are writing the mailbox over NFS, which means that no file locking is needed.
- +
- The preceding item will be matched one or more times.
+9. Mailbox Shortcuts
- {n}
- The preceding item is matched exactly _\bn times.
+ There are a number of built in shortcuts which refer to specific mailboxes. These shortcuts can be used anywhere you are prompted for a file or mailbox path.
+ * ! -- refers to your spoolfile (incoming) mailbox
+ * > -- refers to your mbox file
+ * < -- refers to your record file
+ * ^ -- refers to the current mailbox
+ * - or !! -- refers to the file you've last visited
+ * ˜ -- refers to your home directory
+ * = or + -- refers to your folder directory
+ * @alias -- refers to the save-hook as determined by the address of the alias
- {n,}
- The preceding item is matched _\bn or more times.
+10. Handling Mailing Lists
- {,m}
- The preceding item is matched at most _\bm times.
+ Mutt-ng has a few configuration options that make dealing with large amounts of mail easier. The first thing you must do is to let Mutt know what addresses you consider to be mailing lists (technically this does not have to be a mailing list, but that is what it is most often used for), and what lists you are subscribed to. This is accomplished through the use of the lists commands in your muttrc.
- {n,m}
- The preceding item is matched at least _\bn times, but no more than _\bm
- times.
+ Now that Mutt-ng knows what your mailing lists are, it can do several things, the first of which is the ability to show the name of a list through which you received a message (i.e., of a subscribed list) in the index menu display. This is useful to distinguish between personal and list mail in the same mailbox. In the 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).
- Two regular expressions may be concatenated; the resulting regular expression
- matches any string formed by concatenating two substrings that respectively
- match the concatenated subexpressions.
+ Often times the ``To'' and ``Cc'' fields in mailing list messages tend to get quite large. Most people do not bother to remove the author of the message they are reply to from the list, resulting in two or more copies being sent to that person. The ``list-reply'' function, which by default is bound to ``L'' in the index menu and pager, helps reduce the clutter by only replying to the known mailing list addresses instead of all recipients (except as specified by Mail-Followup-To, see below).
- Two regular expressions may be joined by the infix operator ``|''; the result-
- ing regular expression matches any string matching either subexpression.
+ Mutt-ng also supports the Mail-Followup-To header. When you send a message to a list of recipients which includes one or several subscribed mailing lists, and if the followup-to option is set, mutt will generate a Mail-Followup-To header which contains all the recipients to whom you send this message, but not your address. This indicates that group-replies or list-replies (also known as ``followups'') to this message should only be sent to the original recipients of the message, and not separately to you - you'll receive your copy through one of the mailing lists you are subscribed to.
- Repetition takes precedence over concatenation, which in turn takes precedence
- over alternation. A whole subexpression may be enclosed in parentheses to
- override these precedence rules.
+ Conversely, when group-replying or list-replying to a message which has a Mail-Followup-To header, mutt will respect this header if the honor-followup-to configuration variable is set. Using list-reply will in this case also make sure that the reply goes to the mailing list, even if it's not specified in the list of recipients in the Mail-Followup-To.
- N\bNo\bot\bte\be:\b: If you compile Mutt-ng with the GNU _\br_\bx package, the following operators
- may also be used in regular expressions:
+ Note that, when header editing is enabled, you can create a Mail-Followup-To header manually. Mutt-ng will only auto-generate this header if it doesn't exist when you send the message.
- \\y
- Matches the empty string at either the beginning or the end of a
- word.
+ The other method some mailing list admins use is to generate a ``Reply-To'' field which points back to the mailing list address rather than the author of the message. This can create problems when trying to reply directly to the author in private, since most mail clients will automatically reply to the address given in the ``Reply-To'' field. Mutt-ng uses the reply-to variable to help decide which address to use. If set to ask-yes or ask-no, you will be prompted as to whether or not you would like to use the address given in the ``Reply-To'' field, or reply directly to the address given in the ``From'' field. When set to yes, the ``Reply-To'' field will be used when present.
- The Mutt Next Generation E-Mail Client 52
+ The ``X-Label:'' header field can be used to further identify mailing lists or list subject matter (or just to annotate messages individually). The 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 not a standard message header field, but it can easily be inserted by procmail and other mail filtering agents.
- \\B
- Matches the empty string within a word.
+ Lastly, Mutt-ng has the ability to sort the mailbox into threads. A thread is a group of messages which all relate to the same subject. This is usually organized into a tree-like structure where a message and all of its replies are represented graphically. If you've ever used a threaded news client, this is the same concept. It makes dealing with large volume mailing lists easier because you can easily delete uninteresting threads and quickly find topics of value.
- \\<
- Matches the empty string at the beginning of a word.
+11. Editing threads
- \\>
- Matches the empty string at the end of a word.
+ Mutt-ng has the ability to dynamically restructure threads that are broken either by misconfigured software or bad behavior from some correspondents. This allows to clean your mailboxes formats) from these annoyances which make it hard to follow a discussion.
- \\w
- Matches any word-constituent character (letter, digit, or under-
- score).
+11.1. Linking threads
- \\W
- Matches any character that is not word-constituent.
+ Some mailers tend to "forget" to correctly set the "In-Reply-To:" and "References:" headers when replying to a message. This results in broken discussions because Mutt-ng has not enough information to guess the correct threading. You can fix this by tagging the reply, then moving to the parent message and using the ``link-threads'' function (bound to & by default). The reply will then be connected to this "parent" message.
- \\`
- Matches the empty string at the beginning of a buffer (string).
+ You can also connect multiple children at once, tagging them and using the tag-prefix command (';') or the auto_tag option.
- \\'
- Matches the empty string at the end of a buffer.
+11.2. Breaking threads
- Please note however that these operators are not defined by POSIX, so they may
- or may not be available in stock libraries on various systems.
+ On mailing lists, some people are in the bad habit of starting a new discussion by hitting "reply" to any message from the list and changing the subject to a totally unrelated one. You can fix such threads by using the ``break-thread'' function (bound by default to #), which will turn the subthread starting from the current message into a whole different thread.
- _\b4_\b._\b2 _\bP_\ba_\bt_\bt_\be_\br_\bn_\bs
+12. Delivery Status Notification (DSN) Support
- 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 con-
- sists 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 _\bP_\ba_\bt_\b-
- _\bt_\be_\br_\bn_\bs (section 7.2 , page 84) in the Reference chapter.
+ RFC1894 defines a set of MIME content types for relaying information about the status of electronic mail messages. These can be thought of as ``return receipts.''
- It must be noted that in this table, EXPR, USER, ID and SUBJECT are regular
- expressions. For ranges, the forms <[MAX], >>[MIN], [MIN]- and -[MAX] are also
- possible.
+ Users can make use of it in one of the following two ways:
+ * Berkeley sendmail 8.8.x currently has some command line options in which the mail client can make requests as to what type of status messages should be returned.
+ * The SMTP support via libESMTP supports it, too.
- _\b4_\b._\b2_\b._\b1 _\bC_\bo_\bm_\bp_\bl_\be_\bx _\bP_\ba_\bt_\bt_\be_\br_\bn_\bs
+ To support this, there are two variables:
+ * dsn-notify is used to request receipts for different results (such as failed message, message delivered, etc.).
+ * dsn-return requests how much of your message should be returned with the receipt (headers or full message).
- It is possible to combine several sub-patterns to a more complex pattern. The
- most simple possibility is to logically AND several patterns by stringing them
- together:
+ Please see the reference chapter for possible values.
- ~s 'SPAM' ~U
+13. POP3 Support (OPTIONAL)
- The pattern above matches all messages that contain ``SPAM'' in the subject and
- are unread.
+ If Mutt-ng was compiled with POP3 support (by running the configure script with the --enable-pop flag), it has the ability to work with mailboxes located on a remote POP3 server and fetch mail for local browsing.
- To logical OR patterns, simply use the | operator. This one especially useful
- when using local groups:
+ You can access the remote POP3 mailbox by selecting the folder pop://popserver/.
- The Mutt Next Generation E-Mail Client 53
+ You can select an alternative port by specifying it with the server, i.e.: pop://popserver:port/.
- ~f ("nion@muttng\.org"|"ak@muttng\.org"|"pdmef@muttng\.org")
- (~b mutt-ng|~s Mutt-ng)
- !~x '@synflood\.at'
+ You can also specify different username for each folder, i.e.: pop://username@popserver[:port]/.
- The first pattern matches all messages that were sent by one of the mutt-ng
- maintainers, while the seconds pattern matches all messages that contain
- ``mutt-ng'' in the message body or ``Mutt-ng'' in the subject. The third pat-
- tern matches all messages that do not contain ``@synflood\.at'' in the Refer-
- ences: header, i.e. messages that are not an (indirect) reply to one of my
- messages. A pattern can be logicall negated using the ! operator.
+ Polling for new mail is more expensive over POP3 than locally. For this reason the frequency at which Mutt-ng will check for mail remotely can be controlled by the pop-mail-check variable, which defaults to every 60 seconds.
- _\b4_\b._\b2_\b._\b2 _\bP_\ba_\bt_\bt_\be_\br_\bn_\bs _\ba_\bn_\bd _\bD_\ba_\bt_\be_\bs
+ If Mutt-ng was compiled with SSL support (by running the configure script with the --with-ssl flag), connections to POP3 servers can be encrypted. This naturally requires that the server supports SSL encrypted connections. To access a folder with POP3/SSL, you should use pops: prefix, ie: pops://[username@]popserver[:port]/.
- When using dates in patterns, the dates must be specified in a special format,
- i.e. DD/MM/YYYY. If you don't specify month or year, they default to the cur-
- rent month or year. When using date ranges, and you specify only the minimum or
- the maximum, the specified date will be excluded, e.g. 01/06/2005- matches
- against all messages _\ba_\bf_\bt_\be_\br Juni 1st, 2005.
+ Another way to access your POP3 mail is the fetch-mail function (default: G). It allows to connect to pop-host, fetch all your new mail and place it in the local spoolfile. After this point, Mutt-ng runs exactly as if the mail had always been local.
- It is also possible to use so-called ``error margins'' when specifying date
- ranges. You simply specify a date, and then the error margin. This margin
- needs to contain the information whether it goes ``forth'' or ``back'' in time,
- by using + and -. Then follows a number and a unit, i.e. y for years, m for
- months, w for weeks and d for days. If you use the special * sign, it means
- that the error margin goes to both ``directions'' in time.
+ Note: If you only need to fetch all messages to local mailbox you should consider using a specialized program, such as fetchmail
- ~d 01/01/2005+1y
- ~d 18/10/2004-2w
- ~d 28/12/2004*1d
+14. IMAP Support (OPTIONAL)
- The first pattern matches all dates between January 1st, 2005 and January 1st
- 2006. The second pattern matches all dates between October 18th, 2004 and
- October 4th 2004 (2 weeks before 18/10/2004), while the third pattern matches
- all dates 1 day around December 28th, 2004 (i.e. Dec 27th, 28th and 29th).
+ If Mutt-ng was compiled with IMAP support (by running the configure script with the --enable-imap flag), it has the ability to work with folders located on a remote IMAP server.
- Relative dates are also very important, as they make it possible to specify
- date ranges between a fixed number of units and the current date. How this
- works can be seen in the following example:
+ You can access the remote inbox by selecting the folder imap://imapserver/INBOX, where imapserver is the name of the IMAP server and INBOX 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 imap://imapserver/path/to/folder where path/to/folder is the path of the folder you want to access.
- ~d >2w # messages older than two weeks
- ~d <3d # messages newer than 3 days
- ~d =1m # messages that are exactly one month old
+ You can select an alternative port by specifying it with the server, i.e.: imap://imapserver:port/INBOX.
- _\b4_\b._\b3 _\bF_\bo_\br_\bm_\ba_\bt _\bS_\bt_\br_\bi_\bn_\bg_\bs
+ You can also specify different username for each folder, i.e.: imap://username@imapserver[:port]/INBOX.
- _\b4_\b._\b3_\b._\b1 _\bI_\bn_\bt_\br_\bo_\bd_\bu_\bc_\bt_\bi_\bo_\bn
+ If Mutt-ng was compiled with SSL support (by running the configure script with the --with-ssl 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 imaps://[username@]imapserver[:port]/path/to/folder as your folder path.
- The Mutt Next Generation E-Mail Client 54
+ Pine-compatible notation is also supported, i.e. {[username@]imapserver[:port][/ssl]}path/to/folder
- The so called _\bF_\bo_\br_\bm_\ba_\bt _\bS_\bt_\br_\bi_\bn_\bg_\bs offer great flexibility when configuring mutt-ng.
- In short, they describe what items to print out how in menus and status mes-
- sages.
+ Note that not all servers use / as the hierarchy separator. Mutt-ng should correctly notice which separator is being used by the server and convert paths accordingly.
- Basically, they work as this: for different menus and bars, there's a variable
- specifying the layout. For every item available, there is a so called _\be_\bx_\bp_\ba_\bn_\bd_\bo.
+ 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 toggle-subscribed command. See also the imap-list-subscribed variable.
- For example, when running mutt-ng on different machines or different versions
- for testing purposes, it may be interesting to have the following information
- always printed on screen when one is in the index:
+ Polling for new mail on an IMAP server can cause noticeable delays. So, you'll want to carefully tune the imap-mail-check and timeout variables.
- +\bo the current hostname
+ Note that if you are using mbox as the mail store on UW servers prior to v12.250, the server has been reported to disconnect a client if another client selects the same folder.
- +\bo the current mutt-ng version number
+14.1. The Folder Browser
- The setting for the status bar of the index is controlled via the _\b$_\bs_\bt_\ba_\bt_\bu_\bs_\b__\bf_\bo_\br_\b-
- _\bm_\ba_\bt (section 7.4.324 , page 167) variable. For the hostname and version
- string, there's an expando for $status_format: %h expands to the hostname and
- %v to the version string. When just configuring:
+ As of version 1.2, mutt supports browsing mailboxes on an IMAP server. This is mostly the same as the local file browser, with the following differences:
+ * Instead of file permissions, mutt displays the string "IMAP", possibly followed by the symbol "+", indicating that the entry contains both messages and subfolders. On Cyrus-like servers folders will often contain both messages and subfolders.
+ * For the case where an entry can contain both messages and subfolders, the selection key (bound to enter by default) will choose to descend into the subfolder view. If you wish to view the messages in that folder, you must use view-file instead (bound to space by default).
+ * You can create, delete and rename mailboxes with the create-mailbox, delete-mailbox, and rename-mailbox commands (default bindings: C, d and r, respectively). You may also subscribe and unsubscribe to mailboxes (normally these are bound to s and u, respectively).
- set status_format = "%v on %h: ..."
+14.2. Authentication
- mutt-ng will replace the sequence %v with the version string and %h with the
- host's name. When you are, for example, running mutt-ng version 1.5.9i on host
- mailhost, you'll see the following when you're in the index:
+ Mutt-ng supports four authentication methods with IMAP servers: SASL, GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add NTLM authentication for you poor exchange users out there, but it has yet to be integrated into the main tree). There is also support for the pseudo-protocol ANONYMOUS, which allows you to log in to a public IMAP server without having an account. To use ANONYMOUS, simply make your username blank or "anonymous".
- Mutt-ng 1.5.9i on mailhost: ...
+ SASL is a special super-authenticator, which selects among several protocols (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most secure method available on your host and the server. Using some of these methods (including DIGEST-MD5 and possibly GSSAPI), your entire session will be encrypted and invisible to those teeming network snoops. It is the best option if you have it. To use it, you must have the Cyrus SASL library installed on your system and compile mutt with the --with-sasl flag.
- In the index, there're more useful information one could want to see:
+ Mutt-ng will try whichever methods are compiled in and available on the server, in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN.
- +\bo which mailbox is open
+ There are a few variables which control authentication:
+ * 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 {user@host}).
+ * imap-pass - a password which you may preset, used by all authentication methods where a password is needed.
+ * imap-authenticators - a colon-delimited list of IMAP authentication methods to try, in the order you wish to try them. If specified, this overrides mutt's default (attempt everything, in the order listed above).
- +\bo how man new, flagged or postponed messages
+15. NNTP Support (OPTIONAL)
- +\bo ...
+ 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 i.
- To include the mailbox' name is as easy as:
+ The Default newsserver can be obtained from the $NNTPSERVER environment variable. Like other news readers, info about subscribed newsgroups is saved in a file as specified by the 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.
- set status_format = "%v on %h: %B: ...
+15.1. Again: Scoring
- When the currently opened mailbox is Inbox, this will be expanded to:
+ 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 score-command.
- Mutt-ng 1.5.9i on mailhost: Inbox: ...
+ What has not been discusses in detail is mutt-ng's built-in realname filter. For may newsreaders including those for ``advanced users'' like slrn or tin, there are frequent request for such functionality. The solutions offered often are complicated regular expressions.
- For the number of certain types of messages, one more feature of the format
- strings is extremely useful. If there aren't messages of a certain type, it may
+ In mutt-ng this is as easy as
+score ~* =42
- The Mutt Next Generation E-Mail Client 55
+ This tells mutt-ng to apply a score of 42 to all messages whose sender specified a valid realname and a valid email address. Using
+score !~* =42
- not be desired to print just that there aren't any but instead only print some-
- thing if there are any.
+ on the contrary applies a score of 42 to all messages not matching those criteria which are very strict:
+ * Email addresses must be valid according to RFC 2822, see <ftp://ftp.rfc-editor.org/in-notes/rfc2822.txt>
+ * the name must consist of at least 2 fields whereby a field must not end in a dot. This means that ``Joe User'' and ``Joe A. User'' are valid while ``J. User'' and ``J. A. User'' aren't.
+ * it's assumed that users are interested in reading their own mail and mail from people who they have defined an alias for so that those 2 groups of messages are excluded from the strict rules.
- _\b4_\b._\b3_\b._\b2 _\bC_\bo_\bn_\bd_\bi_\bt_\bi_\bo_\bn_\ba_\bl _\bE_\bx_\bp_\ba_\bn_\bs_\bi_\bo_\bn
+16. SMTP Support (OPTIONAL)
- To only print the number of messages if there are new messages in the current
- mailbox, further extend $status_format to:
+ Mutt-ng can be built using a library called ``libESMTP'' which provides SMTP functionality. When configure was called with --with-libesmtp or the output muttng -v contains +USE_LIBESMTP, this will be or is the case already. The SMTP support includes support for Delivery Status Notification (see dsn section) as well as handling the 8BITMIME flag controlled via use-8bitmime.
- set status_format = "%v on %h: %B %?n?%n new? ...
+ To enable sending mail directly via SMTP without an MTA such as Postfix or SSMTP and the like, simply set the smtp-host variable pointing to your SMTP server.
- This feature is called _\bn_\bo_\bn_\bz_\be_\br_\bo_\b-_\bp_\br_\bi_\bn_\bt_\bi_\bn_\bg and works as this: some expandos may be
- optionally printed nonzero, i.e. a portion of the format string is only evalu-
- ated if the value of the expando is different from zero. The basic syntax is:
+ Authentication mechanisms are available via the smtp-user and smtp-pass variables.
- %?<item>?<string if nonzero>?
+ 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 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 if it doesn't while switching back to unencrypted communication for the first one.
- which tells mutt-ng to only look at <string if nonzero> if the value of the
- %<item%gt; expando is different from zero. In our example, we used n as the
- expando to check for and %n new as the optional nonzero string.
+ Some mail providers require user's to set a particular envelope sender, i.e. they allow for only one value which may not be what the user wants to send as the From: header. In this case, the variable smtp-envelope may be used to set the envelope different from the From: header.
- But this is not all: this feature only offers one alternative: ``print some-
- thing if not zero.'' Mutt-ng does, as you might guess, also provide a logically
- complete version: ``if zero, print something and else print something else.''
- This is achieved by the following syntax for those expandos which may be
- printed nonzero:
+17. Managing multiple IMAP/POP/NNTP accounts (OPTIONAL)
- %?<item>?<string if nonzero>&<string if zero>?
+ If you happen to have accounts on multiple IMAP and/or POP servers, you may find managing all the authentication settings inconvenient and error-prone. The account-hook command may help. This hook works like folder-hook but is invoked whenever you access a remote mailbox (including inside the folder browser), not just when you open the mailbox.
- Using this we can make mutt-ng to do the following:
+ Some examples:
+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"'
- +\bo make it print ``_\bn new messages'' whereby _\bn is the count but only if there
- new ones
+18. Start a WWW Browser on URLs (EXTERNAL)
- +\bo and make it print ``no new messages'' if there aren't any
+ If a message contains URLs (unified resource locator = address in the WWW space like http://www.mutt.org/), it is efficient to get a menu with all the URLs and start a WWW browser on one of them. This functionality is provided by the external urlview program which can be retrieved at ftp://ftp.mutt.org/mutt/contrib/ and the configuration commands:
+macro index \cb |urlview\n
+macro pager \cb |urlview\n
- The corresponding configuration is:
+19. Compressed folders Support (OPTIONAL)
- set status_format = "%v on %h: %B: %?n?%n new messages&no new messages? ...
+ If Mutt-ng was compiled with compressed folders support (by running the configure script with the --enable-compressed flag), Mutt can open folders stored in an arbitrary format, provided that the user has a script to convert from/to this format to one of the accepted.
- This doubles the use of the ``new messages'' string because it'll get always
- printed. Thus, it can be shortened to:
+ The most common use is to open compressed archived folders e.g. with gzip.
- set status_format = "%v on %h: %B: %?n?%n&no? new messages ...
+ In addition, the user can provide a script that gets a folder in an accepted format and appends its context to the folder in the user-defined format, which may be faster than converting the entire folder to the accepted format, appending to it and converting back to the user-defined format.
- The Mutt Next Generation E-Mail Client 56
+ There are three hooks defined (open-hook, close-hook and append-hook) which define commands to uncompress and compress a folder and to append messages to an existing compressed folder respectively.
- As you might see from this rather simple example, one can create very complex
- but fancy status messages. Please see the reference chapter for expandos and
- those which may be printed nonzero.
+ For example:
+open-hook \\.gz$ "gzip -cd %f > %t"
+close-hook \\.gz$ "gzip -c %t > %f"
+append-hook \\.gz$ "gzip -c %t >> %f"
- _\b4_\b._\b3_\b._\b3 _\bM_\bo_\bd_\bi_\bf_\bi_\bc_\ba_\bt_\bi_\bo_\bn_\bs _\ba_\bn_\bd _\bP_\ba_\bd_\bd_\bi_\bn_\bg
+ You do not have to specify all of the commands. If you omit append-hook, the folder will be open and closed again each time you will add to it. If you omit close-hook (or give empty command) , the folder will be open in the mode. If you specify append-hook though you'll be able to append to the folder.
- Besides the information given so far, there're even more features of format
- strings:
+ Note that Mutt-ng will only try to use hooks if the file is not in one of the accepted formats. In particular, if the file is empty, mutt 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 save-empty, so that the compressed file will be removed if you delete all of the messages.
- +\bo When specifying %_<item> instead of just %<item>, mutt-ng will convert all
- characters in the expansion of <item> to lowercase.
+19.1. Open a compressed mailbox for reading
- +\bo When specifying %:<item> instead of just %<item>, mutt-ng will convert all
- dots in the expansion of <item> to underscores (_).
+ Usage: open-hook regexp "command"
- Also, there's a feature called _\bP_\ba_\bd_\bd_\bi_\bn_\bg supplied by the following two expandos:
- %|X and %>X.
+ The command is the command that can be used for opening the folders whose names match regexp.
- %|X
- When this occurs, mutt-ng will fill the rest of the line with the
- character X. In our example, filling the rest of the line with
- dashes is done by setting:
+ The command 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 name of the temporary folder to which to write.
- set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"
+ %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.
- %>X
- Since the previous expando stops at the end of line, there must be
- a way to fill the gap between two items via the %>X expando: it
- puts as many characters X in between two items so that the rest of
- the line will be right-justified. For example, to not put the ver-
- sion 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 %>):
+ The command should not remove the original compressed file. The command should return non-zero exit status if it fails, so mutt knows something's wrong.
- set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"
+ Example:
+open-hook \\.gz$ "gzip -cd %f > %t"
- _\b4_\b._\b4 _\bU_\bs_\bi_\bn_\bg _\bT_\ba_\bg_\bs
+ If the command is empty, this operation is disabled for this file type.
- Sometimes it is desirable to perform an operation on a group of messages all at
- once rather than one at a time. An example might be to save messages to a
- mailing list to a separate folder, or to delete all messages with a given sub-
- ject. To tag all messages matching a pattern, use the tag-pattern function,
- which is bound to ``shift-T'' by default. Or you can select individual mes-
- sages by hand using the ``tag-message'' function, which is bound to ``t'' by
+19.2. Write a compressed mailbox
- The Mutt Next Generation E-Mail Client 57
+ Usage: close-hook regexp "command"
- default. See _\bp_\ba_\bt_\bt_\be_\br_\bn_\bs (section 7.2 , page 84) for Mutt-ng's pattern matching
- syntax.
+ This is used to close the folder that was open with the open-hook command after some changes were made to it.
- Once you have tagged the desired messages, you can use the ``tag-prefix'' oper-
- ator, which is the ``;'' (semicolon) key by default. When the ``tag-prefix''
- operator is used, the n\bne\bex\bxt\bt operation will be applied to all tagged messages if
- that operation can be used in that manner. If the _\b$_\ba_\bu_\bt_\bo_\b__\bt_\ba_\bg (section 7.4.19 ,
- page 94) variable is set, the next operation applies to the tagged messages
- automatically, without requiring the ``tag-prefix''.
+ The command string is the command that can be used for closing the folders whose names match regexp. It has the same format as in the open-hook command. Temporary folder in this case is the folder previously produced by the <open-hook command.
- In _\bm_\ba_\bc_\br_\bo_\bs (section 3.8 , page 30) or _\bp_\bu_\bs_\bh (section 3.24 , page 41) 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 ``end-cond'' operator; after
- this operator the rest of the macro will be executed as normal.
+ The command should not remove the decompressed file. The command should return non-zero exit status if it fails, so mutt knows something's wrong.
- _\b4_\b._\b5 _\bU_\bs_\bi_\bn_\bg _\bH_\bo_\bo_\bk_\bs
+ Example:
+close-hook \\.gz$ "gzip -c %t > %f"
- A _\bh_\bo_\bo_\bk is a concept borrowed from the EMACS editor which allows you to execute
- arbitrary commands before performing some operation. For example, you may wish
- to tailor your configuration based upon which mailbox you are reading, or to
- whom you are sending mail. In the Mutt-ng world, a _\bh_\bo_\bo_\bk consists of a _\br_\be_\bg_\bu_\bl_\ba_\br
- _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn (section 4.1 , page 49) or _\bp_\ba_\bt_\bt_\be_\br_\bn (section 7.2 , page 84) along
- with a configuration option/command. See
+ If the command is empty, this operation is disabled for this file type, and the file can only be open in the readonly mode.
- +\bo _\bf_\bo_\bl_\bd_\be_\br_\b-_\bh_\bo_\bo_\bk (section 3.7 , page 29)
+ close-hook is not called when you exit from the folder if the folder was not changed.
- +\bo _\bs_\be_\bn_\bd_\b-_\bh_\bo_\bo_\bk (section 3.21 , page 40)
+19.3. Append a message to a compressed mailbox
- +\bo _\bm_\be_\bs_\bs_\ba_\bg_\be_\b-_\bh_\bo_\bo_\bk (section 3.22 , page 41)
+ Usage: append-hook regexp "command"
- +\bo _\bs_\ba_\bv_\be_\b-_\bh_\bo_\bo_\bk (section 3.18 , page 39)
+ This command is used for saving to an existing compressed folder. The command is the command that can be used for appending to the folders whose names match regexp. It has the same format as in the open-hook command. The temporary folder in this case contains the messages that are being appended.
- +\bo _\bm_\bb_\bo_\bx_\b-_\bh_\bo_\bo_\bk (section 3.14 , page 37)
+ The command should not remove the decompressed file. The command should return non-zero exit status if it fails, so mutt knows something's wrong.
- +\bo _\bf_\bc_\bc_\b-_\bh_\bo_\bo_\bk (section 3.19 , page 39)
+ Example:
+append-hook \\.gz$ "gzip -c %t >> %f"
- +\bo _\bf_\bc_\bc_\b-_\bs_\ba_\bv_\be_\b-_\bh_\bo_\bo_\bk (section 3.20 , page 40)
+ When append-hook 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 (mbox-type) type is always supposed (i.e. this is the format used for the temporary folder).
- for specific details on each type of _\bh_\bo_\bo_\bk available.
+ If the file does not exist when you save to it, close-hook is called, and not append-hook. append-hook is only for appending to existing folders.
- N\bNo\bot\bte\be:\b: if a hook changes configuration settings, these changes remain effective
- until the end of the current mutt session. As this is generally not desired, a
- default hook needs to be added before all other hooks to restore configuration
- defaults. Here is an example with send-hook and the my_hdr directive:
+ If the command is empty, this operation is disabled for this file type. In this case, the folder will be open and closed again (using open-hook and close-hookrespectively) each time you will add to it.
- send-hook . 'unmy_hdr From:'
- send-hook ~C'^b@b\.b$' my_hdr from: c@c.c
+19.4. Encrypted folders
- The Mutt Next Generation E-Mail Client 58
+ The compressed folders support can also be used to handle encrypted folders. If you want to encrypt a folder with PGP, you may want to use the following hooks:
+open-hook \\.pgp$ "pgp -f < %f > %t"
+close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId < %t > %f"
- _\b4_\b._\b5_\b._\b1 _\bM_\be_\bs_\bs_\ba_\bg_\be _\bM_\ba_\bt_\bc_\bh_\bi_\bn_\bg _\bi_\bn _\bH_\bo_\bo_\bk_\bs
+ Please note, that PGP does not support appending to an encrypted folder, so there is no append-hook defined.
- Hooks that act upon messages (send-hook, save-hook, fcc-hook, message-hook) are
- evaluated in a slightly different manner. For the other types of hooks, a _\br_\be_\bg_\b-
- _\bu_\bl_\ba_\br _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn (section 4.1 , page 49) 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.
+ Note: the folder is temporary stored decrypted in the /tmp directory, where it can be read by your system administrator. So think about the security aspects of this.
- Mutt-ng allows the use of the _\bs_\be_\ba_\br_\bc_\bh _\bp_\ba_\bt_\bt_\be_\br_\bn (section 7.2 , page 84) language
- for matching messages in hook commands. This works in exactly the same way as
- it would when _\bl_\bi_\bm_\bi_\bt_\bi_\bn_\bg or _\bs_\be_\ba_\br_\bc_\bh_\bi_\bn_\bg the mailbox, except that you are restricted
- to those operators which match information mutt extracts from the header of the
- message (i.e. from, to, cc, date, subject, etc.).
+Chapter 5. Mutt-ng's MIME Support
- For example, if you wanted to set your return address based upon sending mail
- to a specific address, you could do something like:
+ Table of Contents
- send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt-ng User <user@host>'
+ 1. Using MIME in Mutt
- which would execute the given command when sending mail to _\bm_\be_\b@_\bc_\bs_\b._\bh_\bm_\bc_\b._\be_\bd_\bu.
+ 1.1. Viewing MIME messages in the pager
+ 1.2. The Attachment Menu
+ 1.3. The Compose Menu
- However, it is not required that you write the pattern to match using the full
- searching language. You can still specify a simple _\br_\be_\bg_\bu_\bl_\ba_\br _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn like the
- other hooks, in which case Mutt-ng will translate your pattern into the full
- language, using the translation specified by the _\b$_\bd_\be_\bf_\ba_\bu_\bl_\bt_\b__\bh_\bo_\bo_\bk (section
- 7.4.49 , page 101) variable. The pattern is translated at the time the hook
- is declared, so the value of _\b$_\bd_\be_\bf_\ba_\bu_\bl_\bt_\b__\bh_\bo_\bo_\bk (section 7.4.49 , page 101) that is
- in effect at that time will be used.
+ 2. MIME Type configuration with mime.types
+ 3. MIME Viewer configuration with mailcap
- _\b4_\b._\b6 _\bU_\bs_\bi_\bn_\bg _\bt_\bh_\be _\bs_\bi_\bd_\be_\bb_\ba_\br
+ 3.1. The Basics of the mailcap file
+ 3.2. Secure use of mailcap
+ 3.3. Advanced mailcap Usage
+ 3.4. Example mailcap files
- The sidebar, a feature specific to Mutt-ng, allows you to use a mailbox listing
- which looks very similar to the ones you probably know from GUI mail clients.
- The sidebar lists all specified mailboxes, shows the number in each and high-
- lights the ones with new email Use the following configuration commands:
+ 4. MIME Autoview
+ 5. MIME Multipart/Alternative
+ 6. MIME Lookup
- set sidebar_visible="yes"
- set sidebar_width=25
+ Quite a bit of effort has been made to make Mutt-ng the premier text-mode MIME MUA. Every effort has been made to provide the functionality that the discerning MIME user requires, and the conformance to the standards wherever possible. When configuring Mutt-ng for MIME, there are two extra types of configuration files which Mutt-ng uses. One is the mime.types file, which contains the mapping of file extensions to IANA MIME types. The other is the mailcap file, which specifies the external commands to use for handling specific MIME types.
- If you want to specify the mailboxes you can do so with:
+1. Using MIME in Mutt
- set mbox='=INBOX'
- mailboxes INBOX \
- MBOX1 \
- MBOX2 \
- ...
+ There are three areas/menus in Mutt-ng which deal with MIME, they are the pager (while viewing a message), the attachment menu and the compose menu.
- You can also specify the colors for mailboxes with new mails by using:
+1.1. Viewing MIME messages in the pager
- The Mutt Next Generation E-Mail Client 59
+ When you select a message from the index and view it in the pager, Mutt decodes the message to a text representation. Mutt-ng internally supports a number of MIME types, including text/plain, text/enriched, message/rfc822, and message/news. In addition, the export controlled version of Mutt-ng recognizes a variety of PGP MIME types, including PGP/MIME and application/pgp.
- color sidebar_new red black
- color sidebar white black
+ Mutt-ng will denote attachments with a couple lines describing them. These lines are of the form:
+[-- Attachment #1: Description --]
+[-- Type: text/plain, Encoding: 7bit, Size: 10000 --]
- The available functions are:
+ Where the Description is the description or filename given for the attachment, and the Encoding is one of 7bit/8bit/quoted-printable/base64/binary.
- sidebar-scroll-up Scrolls the mailbox list up 1 page
- sidebar-scroll-down Scrolls the mailbox list down 1 page
- sidebar-next Highlights the next mailbox
- sidebar-next-new Highlights the next mailbox with new mail
- sidebar-previous Highlights the previous mailbox
- sidebar-open Opens the currently highlighted mailbox
+ If Mutt-ng cannot deal with a MIME type, it will display a message like:
+[-- image/gif is unsupported (use 'v' to view this part) --]
- Reasonable key bindings look e.g. like this:
+1.2. The Attachment Menu
- bind index \Cp sidebar-prev
- bind index \Cn sidebar-next
- bind index \Cb sidebar-open
- bind pager \Cp sidebar-prev
- bind pager \Cn sidebar-next
- bind pager \Cb sidebar-open
+ The default binding for view-attachments is `v', which displays the attachment menu for a message. The attachment menu displays a list of the attachments in a message. From the attachment menu, you can save, print, pipe, delete, and view attachments. You can apply these operations to a group of attachments at once, by tagging the attachments and by using the ``tag-prefix'' operator. You can also reply to the current message from this menu, and only the current attachment (or the attachments tagged) will be quoted in your reply. You can view attachments as text, or view them using the mailcap viewer definition.
- macro index B ':toggle sidebar_visible^M'
- macro pager B ':toggle sidebar_visible^M'
+ Finally, you can apply the usual message-related functions (like resend-message, and the reply and forward functions) to attachments of type message/rfc822.
- You can then go up and down by pressing Ctrl-P and Ctrl-N, and switch on and
- off the sidebar simply by pressing 'B'.
+ See the help on the attachment menu for more information.
- _\b4_\b._\b7 _\bE_\bx_\bt_\be_\br_\bn_\ba_\bl _\bA_\bd_\bd_\br_\be_\bs_\bs _\bQ_\bu_\be_\br_\bi_\be_\bs
+1.3. The Compose Menu
- 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 _\b$_\bq_\bu_\be_\br_\by_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd (section 7.4.237 , page 146) vari-
- able, you specify the wrapper command to use. For example:
+ The compose menu is the menu you see before you send a message. It allows you to edit the recipient list, the subject, and other aspects of your message. It also contains a list of the attachments of your message, including the main body. From this menu, you can print, copy, filter, pipe, edit, compose, review, and rename an attachment or a list of tagged attachments. You can also modifying the attachment information, notably the type, encoding and description.
- set query_command = "mutt_ldap_query.pl '%s'"
+ Attachments appear as follows:
+- 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>
- The wrapper script should accept the query on the command-line. It should
- return a one line message, then each matching response on a single line, each
- line containing a tab separated address then name then some other optional
- information. On error, or if there are no matching addresses, return a non-
- zero exit code and a one line error message.
+ The '-' denotes that Mutt-ng will delete the file after sending (or postponing, or canceling) the message. It can be toggled with the toggle-unlink command (default: u). The next field is the MIME content-type, and can be changed with the edit-type command (default: ^T). The next field is the encoding for the attachment, which allows a binary message to be encoded for transmission on 7bit links. It can be changed with the edit-encoding command (default: ^E). The next field is the size of the attachment, rounded to kilobytes or megabytes. The next field is the filename, which can be changed with the rename-file command (default: R). The final field is the description of the attachment, and can be changed with the edit-description command (default: d).
- An example multiple response output:
+2. MIME Type configuration with mime.types
- Searching database ... 20 entries ... 3 matching:
- me@cs.hmc.edu Michael Elkins mutt dude
- blong@fiction.net Brandon Long mutt and more
+ When you add an attachment to your mail message, Mutt-ng searches your personal mime.types file at ${HOME}/.mime.types, and then the system mime.types file at /usr/local/share/mutt/mime.types or /etc/mime.types
- The Mutt Next Generation E-Mail Client 60
+ The mime.types file consist of lines containing a MIME type and a space separated list of extensions. For example:
+application/postscript ps eps
+application/pgp pgp
+audio/x-aiff aif aifc aiff
- roessler@guug.de Thomas Roessler mutt pgp
+ A sample mime.types file comes with the Mutt-ng distribution, and should contain most of the MIME types you are likely to use.
- There are two mechanisms for accessing the query function of mutt. One is to
- do a query from the index menu using the query function (default: Q). This
- will prompt for a query, then bring up the query menu which will list the
- matching responses. From the query menu, you can select addresses to create
- aliases, or to mail. You can tag multiple addresses to mail, start a new
- query, or have a new query appended to the current responses.
+ If Mutt-ng can not determine the mime type by the extension of the file you attach, it will look at the file. If the file is free of binary information, Mutt-ng will assume that the file is plain text, and mark it as text/plain. If the file contains binary information, then Mutt-ng will mark it as application/octet-stream. You can change the MIME type that Mutt-ng assigns to an attachment by using the edit-type command from the compose menu (default: ^T). The MIME type is actually a major mime type followed by the sub-type, separated by a '/'. 6 major types: application, text, image, video, audio, and model have been approved after various internet discussions. Mutt-ng recognises all of these if the appropriate entry is found in the mime.types file. It also recognises other major mime types, such as the chemical type that is widely used in the molecular modelling community to pass molecular data in various forms to various molecular viewers. Non-recognised mime types should only
+ be used if the recipient of the message is likely to be expecting such attachments.
- The other mechanism for accessing the query function is for address completion,
- similar to the alias completion. In any prompt for address entry, you can use
- the complete-query function (default: ^T) to run a query based on the current
- address you have typed. Like aliases, mutt will look for what you have typed
- back to the last space or comma. If there is a single response for that query,
- mutt will expand the address in place. If there are multiple responses, mutt
- will activate the query menu. At the query menu, you can select one or more
- addresses to be added to the prompt.
+3. MIME Viewer configuration with mailcap
- _\b4_\b._\b8 _\bM_\ba_\bi_\bl_\bb_\bo_\bx _\bF_\bo_\br_\bm_\ba_\bt_\bs
+ Mutt-ng supports RFC 1524 MIME Configuration, in particular the Unix specific format specified in Appendix A of RFC 1524. This file format is commonly referred to as the mailcap format. Many MIME compliant programs utilize the mailcap format, allowing you to specify handling for all MIME types in one place for all programs. Programs known to use this format include Netscape, XMosaic, lynx and metamail.
- 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 new mailboxes, Mutt-ng
- uses the default specified with the _\b$_\bm_\bb_\bo_\bx_\b__\bt_\by_\bp_\be (section 7.4.132 , page 122)
- variable.
+ In order to handle various MIME types that Mutt-ng can not handle internally, Mutt-ng parses a series of external configuration files to find an external handler. The default search string for these files is a colon delimited list set to
+${HOME}/.mailcap:/usr/local/share/mutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap
- m\bmb\bbo\box\bx. This is the most widely used mailbox format for UNIX. All messages are
- stored in a single file. Each message has a line of the form:
+ where $HOME is your home directory.
- From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST
+ In particular, the metamail distribution will install a mailcap file, usually as /usr/local/etc/mailcap, which contains some baseline entries.
- to denote the start of a new message (this is often referred to as the
- ``From_'' line).
+3.1. The Basics of the mailcap file
- M\bMM\bMD\bDF\bF. This is a variant of the _\bm_\bb_\bo_\bx format. Each message is surrounded by
- lines containing ``^A^A^A^A'' (four control-A's).
+ A mailcap file consists of a series of lines which are comments, blank, or definitions.
- M\bMH\bH. A radical departure from _\bm_\bb_\bo_\bx and _\bM_\bM_\bD_\bF, a mailbox consists of a directory
- and each message is stored in a separate file. The filename indicates the mes-
- sage number (however, this is may not correspond to the message number Mutt-ng
- displays). Deleted messages are renamed with a comma (,) prepended to the file-
- name. N\bNo\bot\bte\be:\b: Mutt detects this type of mailbox by looking for either
- .mh_sequences or .xmhcache (needed to distinguish normal directories from MH
- mailboxes).
+ A comment line consists of a # character followed by anything you want.
- M\bMa\bai\bil\bld\bdi\bir\br. The newest of the mailbox formats, used by the Qmail MTA (a replace-
- ment for sendmail). Similar to _\bM_\bH, except that it adds three subdirectories of
- the mailbox: _\bt_\bm_\bp, _\bn_\be_\bw and _\bc_\bu_\br. Filenames for the messages are chosen in such a
- way they are unique, even when two programs are writing the mailbox over NFS,
-
- The Mutt Next Generation E-Mail Client 61
-
- which means that no file locking is needed.
-
- _\b4_\b._\b9 _\bM_\ba_\bi_\bl_\bb_\bo_\bx _\bS_\bh_\bo_\br_\bt_\bc_\bu_\bt_\bs
-
- There are a number of built in shortcuts which refer to specific mailboxes.
- These shortcuts can be used anywhere you are prompted for a file or mailbox
- path.
+ A blank line is blank.
- +\bo ! -- refers to your _\b$_\bs_\bp_\bo_\bo_\bl_\bf_\bi_\bl_\be (section 7.4.313 , page 165) (incoming)
- mailbox
-
- +\bo > -- refers to your _\b$_\bm_\bb_\bo_\bx (section 7.4.131 , page 122) file
-
- +\bo < -- refers to your _\b$_\br_\be_\bc_\bo_\br_\bd (section 7.4.246 , page 148) file
+ A definition line consists of a content type, a view command, and any number of optional fields. Each field of a definition line is divided by a semicolon ';' character.
- +\bo ^ -- refers to the current mailbox
+ The content type is specified in the MIME standard type/subtype method. For example, text/plain, text/html, image/gif, etc. In addition, the mailcap format includes two formats for wildcards, one using the special '*' subtype, the other is the implicit wild, where you only include the major type. For example, image/*, or video, will match all image types and video types, respectively.
- +\bo - or !! -- refers to the file you've last visited
+ The view command is a Unix command for viewing the type specified. There are two different types of commands supported. The default is to send the body of the MIME message to the command on stdin. You can change 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 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 Mutt will remove the temporary file if it exists.
- +\bo ~ -- refers to your home directory
+ So, in the simplest form, you can send a text/plain message to the external pager more on stdin:
+text/plain; more
- +\bo = or + -- refers to your _\b$_\bf_\bo_\bl_\bd_\be_\br (section 7.4.70 , page 105) directory
-
- +\bo @_\ba_\bl_\bi_\ba_\bs -- refers to the _\bd_\be_\bf_\ba_\bu_\bl_\bt _\bs_\ba_\bv_\be _\bf_\bo_\bl_\bd_\be_\br (section 3.18 , page 39) as
- determined by the address of the alias
+ Or, you could send the message as a file:
+text/plain; more %s
- _\b4_\b._\b1_\b0 _\bH_\ba_\bn_\bd_\bl_\bi_\bn_\bg _\bM_\ba_\bi_\bl_\bi_\bn_\bg _\bL_\bi_\bs_\bt_\bs
-
- Mutt-ng has a few configuration options that make dealing with large amounts of
- mail easier. The first thing you must do is to let Mutt know what addresses
- you consider to be mailing lists (technically this does not have to be a mail-
- ing 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 _\bl_\bi_\bs_\bt_\bs _\ba_\bn_\bd _\bs_\bu_\bb_\bs_\bc_\br_\bi_\bb_\be
- (section 3.13 , page 36) commands in your muttrc.
-
- Now that Mutt-ng knows what your mailing lists are, it can do several things,
- the first of which is the ability to show the name of a list through which you
- received a message (i.e., of a subscribed list) in the _\bi_\bn_\bd_\be_\bx menu display.
- This is useful to distinguish between personal and list mail in the same mail-
- box. In the _\b$_\bi_\bn_\bd_\be_\bx_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.116 , page 116) 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).
+ Perhaps you would like to use lynx to interactively view a text/html message:
+text/html; lynx %s
- Often times the ``To'' and ``Cc'' fields in mailing list messages tend to get
- quite large. Most people do not bother to remove the author of the message they
- are reply to from the list, resulting in two or more copies being sent to that
- person. The ``list-reply'' function, which by default is bound to ``L'' in the
- _\bi_\bn_\bd_\be_\bx menu and _\bp_\ba_\bg_\be_\br, helps reduce the clutter by only replying to the known
- mailing list addresses instead of all recipients (except as specified by Mail-
+ In this case, lynx does not support viewing a file from stdin, so you must use the %s syntax. Note: Some older versions of lynx contain a bug where they will check the mailcap file for a viewer for text/html. They will find the line which calls lynx, and run it. This causes lynx to continuously spawn itself to view the object.
- The Mutt Next Generation E-Mail Client 62
+ On the other hand, maybe you don't want to use lynx interactively, you just want to have it convert the text/html to text/plain, then you can use:
+text/html; lynx -dump %s | more
- Followup-To, see below).
+ Perhaps you wish to use lynx to view text/html files, and a pager on all other text formats, then you would use the following:
+text/html; lynx %s
+text/*; more
- Mutt-ng also supports the Mail-Followup-To header. When you send a message to
- a list of recipients which includes one or several subscribed mailing lists,
- and if the _\b$_\bf_\bo_\bl_\bl_\bo_\bw_\bu_\bp_\b__\bt_\bo (section 7.4.72 , page 106) option is set, mutt will
- generate a Mail-Followup-To header which contains all the recipients to whom
- you send this message, but not your address. This indicates that group-replies
- or list-replies (also known as ``followups'') to this message should only be
- sent to the original recipients of the message, and not separately to you -
- you'll receive your copy through one of the mailing lists you are subscribed
- to.
+ This is the simplest form of a mailcap file.
- Conversely, when group-replying or list-replying to a message which has a Mail-
- Followup-To header, mutt will respect this header if the _\b$_\bh_\bo_\bn_\bo_\br_\b__\bf_\bo_\bl_\bl_\bo_\bw_\bu_\bp_\b__\bt_\bo
- (section 7.4.94 , page 111) configuration variable is set. Using list-reply
- will in this case also make sure that the reply goes to the mailing list, even
- if it's not specified in the list of recipients in the Mail-Followup-To.
+3.2. Secure use of mailcap
- Note that, when header editing is enabled, you can create a Mail-Followup-To
- header manually. Mutt-ng will only auto-generate this header if it doesn't
- exist when you send the message.
+ The interpretation of shell meta-characters embedded in MIME parameters can lead to security problems in general. Mutt-ng tries to quote parameters in expansion of %s syntaxes properly, and avoids risky characters by substituting them, see the mailcap-sanitize variable.
- The other method some mailing list admins use is to generate a ``Reply-To''
- field which points back to the mailing list address rather than the author of
- the message. This can create problems when trying to reply directly to the
- author in private, since most mail clients will automatically reply to the
- address given in the ``Reply-To'' field. Mutt-ng uses the _\b$_\br_\be_\bp_\bl_\by_\b__\bt_\bo (section
- 7.4.249 , page 149) variable to help decide which address to use. If set to
- _\ba_\bs_\bk_\b-_\by_\be_\bs or _\ba_\bs_\bk_\b-_\bn_\bo, you will be prompted as to whether or not you would like to
- use the address given in the ``Reply-To'' field, or reply directly to the
- address given in the ``From'' field. When set to _\by_\be_\bs, the ``Reply-To'' field
- will be used when present.
+ Although mutt's procedures to invoke programs with mailcap seem to be safe, there are other applications parsing mailcap, maybe taking less care of it. Therefore you should pay attention to the following rules:
- The ``X-Label:'' header field can be used to further identify mailing lists or
- list subject matter (or just to annotate messages individually). The
- _\b$_\bi_\bn_\bd_\be_\bx_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.116 , page 116) 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 not a standard message header field, but it
- can easily be inserted by procmail and other mail filtering agents.
+ Keep the %-expandos away from shell quoting. 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 with eval statements, and avoid them if possible at all. Trying to fix broken behaviour with quotes introduces new leaks - there is no alternative to correct quoting in the first place.
- Lastly, Mutt-ng has the ability to _\bs_\bo_\br_\bt (section 7.4.307 , page 163) the mail-
- box into _\bt_\bh_\br_\be_\ba_\bd_\bs (section 2.5.3 , page 11). A thread is a group of messages
- which all relate to the same subject. This is usually organized into a tree-
- like structure where a message and all of its replies are represented graphi-
- cally. If you've ever used a threaded news client, this is the same concept.
- It makes dealing with large volume mailing lists easier because you can easily
- delete uninteresting threads and quickly find topics of value.
+ 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 $charset inside the backtick expansion is safe, since it is not itself subject to any further expansion):
+text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \
+ && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1
- _\b4_\b._\b1_\b1 _\bE_\bd_\bi_\bt_\bi_\bn_\bg _\bt_\bh_\br_\be_\ba_\bd_\bs
+3.3. Advanced mailcap Usage
- Mutt-ng has the ability to dynamically restructure threads that are broken
+3.3.1. Optional Fields
- The Mutt Next Generation E-Mail Client 63
+ In addition to the required content-type and view command fields, you can add semi-colon ';' separated fields to set flags and other options. Mutt-ng recognizes the following optional fields:
- either by misconfigured software or bad behavior from some correspondents. This
- allows to clean your mailboxes formats) from these annoyances which make it
- hard to follow a discussion.
+ copiousoutput
+ This flag tells Mutt-ng that the command passes possibly large amounts of text on stdout. This causes Mutt-ng to invoke a pager (either the internal pager or the external pager defined by the pager variable) on the output of the view command. Without this flag, Mutt-ng assumes that the command is interactive. One could use this to replace the pipe to more in the lynx -dump example in the Basic section:
- _\b4_\b._\b1_\b1_\b._\b1 _\bL_\bi_\bn_\bk_\bi_\bn_\bg _\bt_\bh_\br_\be_\ba_\bd_\bs
+text/html; lynx -dump %s ; copiousoutput
- Some mailers tend to "forget" to correctly set the "In-Reply-To:" and "Refer-
- ences:" headers when replying to a message. This results in broken discussions
- because Mutt-ng has not enough information to guess the correct threading. You
- can fix this by tagging the reply, then moving to the parent message and using
- the ``link-threads'' function (bound to & by default). The reply will then be
- connected to this "parent" message.
+ This will cause lynx to format the text/html output as text/plain and Mutt-ng will use your standard pager to display the results.
- You can also connect multiple children at once, tagging them and using the tag-
- prefix command (';') or the auto_tag option.
+ needsterminal
+ Mutt-ng uses this flag when viewing attachments with auto-view, in order to decide whether it should honor the setting of the wait-key variable or not. When an attachment is viewed using an interactive program, and the corresponding mailcap entry has a needsterminal flag, Mutt-ng will use wait-key and the exit status of the program to decide if it will ask you to press a key after the external program has exited. In all other situations it will not prompt you for a key.
- _\b4_\b._\b1_\b1_\b._\b2 _\bB_\br_\be_\ba_\bk_\bi_\bn_\bg _\bt_\bh_\br_\be_\ba_\bd_\bs
+ compose=<command>
+ This flag specifies the command to use to create a new attachment of a specific MIME type. Mutt-ng supports this from the compose menu.
- On mailing lists, some people are in the bad habit of starting a new discussion
- by hitting "reply" to any message from the list and changing the subject to a
- totally unrelated one. You can fix such threads by using the ``break-thread''
- function (bound by default to #), which will turn the subthread starting from
- the current message into a whole different thread.
+ composetyped=<command>
+ This flag specifies the command to use to create a new attachment of a specific MIME type. This command differs from the compose command in that mutt will expect standard MIME headers on the data. This can be used to specify parameters, filename, description, etc. for a new attachment. Mutt-ng supports this from the compose menu.
- _\b4_\b._\b1_\b2 _\bD_\be_\bl_\bi_\bv_\be_\br_\by _\bS_\bt_\ba_\bt_\bu_\bs _\bN_\bo_\bt_\bi_\bf_\bi_\bc_\ba_\bt_\bi_\bo_\bn _\b(_\bD_\bS_\bN_\b) _\bS_\bu_\bp_\bp_\bo_\br_\bt
+ print=<command>
+ This flag specifies the command to use to print a specific MIME type. Mutt-ng supports this from the attachment and compose menus.
- RFC1894 defines a set of MIME content types for relaying information about the
- status of electronic mail messages. These can be thought of as ``return
- receipts.''
+ edit=<command>
+ This flag specifies the command to use to edit a specific MIME type. Mutt-ng supports this from the compose menu, and also uses it to compose new attachments. Mutt-ng will default to the defined editor for text attachments.
- Users can make use of it in one of the following two ways:
+ nametemplate=<template>
+ This field specifies the format for the file denoted by %s in the command fields. Certain programs will require a certain file extension, for instance, to correctly view a file. For instance, lynx will only interpret a file as text/html if the file ends in .html. So, you would specify lynx as a text/html viewer with a line in the mailcap file like:
- +\bo Berkeley sendmail 8.8.x currently has some command line options in which
- the mail client can make requests as to what type of status messages
- should be returned.
+text/html; lynx %s; nametemplate=%s.html
- +\bo The SMTP support via libESMTP supports it, too.
+ test=<command>
+ This field specifies a command to run to test whether this mailcap entry should be used. The command is defined with the command expansion rules defined in the next section. If the command returns 0, then the test passed, and Mutt-ng uses this entry. If the command returns non-zero, then the test failed, and Mutt-ng continues searching for the right entry. Note: the content-type must match before Mutt-ng performs the test. For example:
- To support this, there are two variables:
+text/html; netscape -remote 'openURL(%s)' ; test=RunningX
+text/html; lynx %s
- +\bo _\b$_\bd_\bs_\bn_\b__\bn_\bo_\bt_\bi_\bf_\by (section 7.4.56 , page 102) is used to request receipts for
- different results (such as failed message, message delivered, etc.).
+ In this example, Mutt-ng will run the program RunningX which will return 0 if the X Window manager is running, and non-zero if it isn't. If RunningX returns 0, then Mutt-ng will call netscape to display the text/html object. If RunningX doesn't return 0, then Mutt-ng will go on to the next entry and use lynx to display the text/html object.
- +\bo _\b$_\bd_\bs_\bn_\b__\br_\be_\bt_\bu_\br_\bn (section 7.4.57 , page 103) requests how much of your message
- should be returned with the receipt (headers or full message).
+3.3.2. Search Order
- Please see the reference chapter for possible values.
+ When searching for an entry in the mailcap file, Mutt-ng will search for the most useful entry for its purpose. For instance, if you are attempting to print an image/gif, and you have the following entries in your mailcap file, Mutt-ng will search for an entry with the print command:
+image/*; xv %s
+image/gif; ; print= anytopnm %s | pnmtops | lpr; \
+ nametemplate=%s.gif
- _\b4_\b._\b1_\b3 _\bP_\bO_\bP_\b3 _\bS_\bu_\bp_\bp_\bo_\br_\bt _\b(_\bO_\bP_\bT_\bI_\bO_\bN_\bA_\bL_\b)
+ Mutt-ng will skip the image/* entry and use the image/gif entry with the print command.
- The Mutt Next Generation E-Mail Client 64
+ In addition, you can use this with auto-view to denote two commands for viewing an attachment, one to be viewed automatically, the other to be viewed interactively from the attachment menu. In addition, you can then use the test feature to determine which viewer to use interactively depending on your environment.
+text/html; netscape -remote 'openURL(%s)' ; test=RunningX
+text/html; lynx %s; nametemplate=%s.html
+text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput
- If Mutt-ng was compiled with POP3 support (by running the _\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\be script with
- the _\b-_\b-_\be_\bn_\ba_\bb_\bl_\be_\b-_\bp_\bo_\bp flag), it has the ability to work with mailboxes located on a
- remote POP3 server and fetch mail for local browsing.
+ For auto-view, Mutt-ng will choose the third entry because of the copiousoutput tag. For interactive viewing, Mutt will run the program RunningX to determine if it should use the first entry. If the program returns non-zero, Mutt-ng will use the second entry for interactive viewing.
- You can access the remote POP3 mailbox by selecting the folder
- pop://popserver/.
+3.3.3. Command Expansion
- You can select an alternative port by specifying it with the server, i.e.:
- pop://popserver:port/.
+ The various commands defined in the mailcap files are passed to the /bin/sh shell using the system() function. Before the command is passed to /bin/sh -c, it is parsed to expand various special parameters with information from Mutt-ng. The keywords Mutt-ng expands are:
- You can also specify different username for each folder, i.e.: pop://user-
- name@popserver[:port]/.
+ %s
+ As seen in the basic mailcap section, this variable is expanded to a filename specified by the calling program. This file contains the body of the message to view/print/edit or where the composing program should place the results of composition. In addition, the use of this keyword causes Mutt-ng to not pass the body of the message to the view/print/edit program on stdin.
- Polling for new mail is more expensive over POP3 than locally. For this reason
- the frequency at which Mutt-ng will check for mail remotely can be controlled
- by the _\b$_\bp_\bo_\bp_\b__\bm_\ba_\bi_\bl_\b__\bc_\bh_\be_\bc_\bk (section 7.4.224 , page 144) variable, which defaults
- to every 60 seconds.
+ %t
+ 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 mailcap definition line, ie text/html or image/gif.
- If Mutt-ng was compiled with SSL support (by running the _\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\be script with
- the _\b-_\b-_\bw_\bi_\bt_\bh_\b-_\bs_\bs_\bl flag), connections to POP3 servers can be encrypted. This natu-
- rally requires that the server supports SSL encrypted connections. To access a
- folder with POP3/SSL, you should use pops: prefix, ie: pops://[user-
- name@]popserver[:port]/.
+ %{<parameter>}
+ Mutt-ng will expand this to the value of the specified parameter from the Content-Type: line of the mail message. For instance, if Your mail message contains:
- Another way to access your POP3 mail is the _\bf_\be_\bt_\bc_\bh_\b-_\bm_\ba_\bi_\bl function (default: G).
- It allows to connect to _\bp_\bo_\bp_\b__\bh_\bo_\bs_\bt (section 7.4.222 , page 143), fetch all your
- new mail and place it in the local _\bs_\bp_\bo_\bo_\bl_\bf_\bi_\bl_\be (section 7.4.313 , page 165).
- After this point, Mutt-ng runs exactly as if the mail had always been local.
+Content-Type: text/plain; charset=iso-8859-1
- N\bNo\bot\bte\be:\b: If you only need to fetch all messages to local mailbox you should con-
- sider using a specialized program, such as fetchmail
+ 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 using the right charset to view the message.
- _\b4_\b._\b1_\b4 _\bI_\bM_\bA_\bP _\bS_\bu_\bp_\bp_\bo_\br_\bt _\b(_\bO_\bP_\bT_\bI_\bO_\bN_\bA_\bL_\b)
+ \%
+ This will be replaced by a %
- If Mutt-ng was compiled with IMAP support (by running the _\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\be script with
- the _\b-_\b-_\be_\bn_\ba_\bb_\bl_\be_\b-_\bi_\bm_\ba_\bp flag), it has the ability to work with folders located on a
- remote IMAP server.
+ Mutt-ng does not currently support the %F and %n keywords specified in RFC 1524. The main purpose of these parameters is for multipart messages, which is handled internally by Mutt-ng.
- You can access the remote inbox by selecting the folder
- imap://imapserver/INBOX, where imapserver is the name of the IMAP server and
- INBOX 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
- imap://imapserver/path/to/folder where path/to/folder is the path of the folder
- you want to access.
+3.4. Example mailcap files
- You can select an alternative port by specifying it with the server, i.e.:
- imap://imapserver:port/INBOX.
+ This mailcap file is fairly simple and standard:
+>
+# I'm always running X :)
+video/*; xanim %s > /dev/null
+image/*; xv %s > /dev/null
- You can also specify different username for each folder, i.e.: imap://user-
- name@imapserver[:port]/INBOX.
+# I'm always running netscape (if my computer had more memory, maybe)
+text/html; netscape -remote 'openURL(%s)'
- If Mutt-ng was compiled with SSL support (by running the _\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\be script with
+ This mailcap file shows quite a number of examples:
+# 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
- The Mutt Next Generation E-Mail Client 65
+# Send html to a running netscape by remote
+text/html; netscape -remote 'openURL(%s)'; test=RunningNetscape
- the _\b-_\b-_\bw_\bi_\bt_\bh_\b-_\bs_\bs_\bl flag), connections to IMAP servers can be encrypted. This natu-
- rally requires that the server supports SSL encrypted connections. To access a
- folder with IMAP/SSL, you should use imaps://[user-
- name@]imapserver[:port]/path/to/folder as your folder path.
+# If I'm not running netscape but I am running X, start netscape on the
+# object
+text/html; netscape %s; test=RunningX
- Pine-compatible notation is also supported, i.e. {[user-
- name@]imapserver[:port][/ssl]}path/to/folder
+# Else use lynx to view it as text
+text/html; lynx %s
- Note that not all servers use / as the hierarchy separator. Mutt-ng should
- correctly notice which separator is being used by the server and convert paths
- accordingly.
+# This version would convert the text/html to text/plain
+text/html; lynx -dump %s; copiousoutput
- 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 _\bt_\bo_\bg_\bg_\bl_\be_\b-_\bs_\bu_\bb_\bs_\bc_\br_\bi_\bb_\be_\bd
- command. See also the _\b$_\bi_\bm_\ba_\bp_\b__\bl_\bi_\bs_\bt_\b__\bs_\bu_\bb_\bs_\bc_\br_\bi_\bb_\be_\bd (section 7.4.103 , page 114)
- variable.
+# I use enscript to print text in two columns to a page
+text/*; more %s; print=enscript -2Gr %s
- Polling for new mail on an IMAP server can cause noticeable delays. So, you'll
- want to carefully tune the _\b$_\bi_\bm_\ba_\bp_\b__\bm_\ba_\bi_\bl_\b__\bc_\bh_\be_\bc_\bk (section 7.4.105 , page 114) and
- _\b$_\bt_\bi_\bm_\be_\bo_\bu_\bt (section 7.4.337 , page 172) variables.
+# Netscape adds a flag to tell itself to view jpegs internally
+image/jpeg;xv %s; x-mozilla-flags=internal
- Note that if you are using mbox as the mail store on UW servers prior to
- v12.250, the server has been reported to disconnect a client if another client
- selects the same folder.
+# Use xv to view images if I'm running X
+# In addition, this uses the \ to extend the line and set my editor
+# for images
+image/*;xv %s; test=RunningX; \
+ edit=xpaint %s
- _\b4_\b._\b1_\b4_\b._\b1 _\bT_\bh_\be _\bF_\bo_\bl_\bd_\be_\br _\bB_\br_\bo_\bw_\bs_\be_\br
+# Convert images to text using the netpbm tools
+image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
+pbmtoascii -1x2 ) 2>&1 ; copiousoutput
- As of version 1.2, mutt supports browsing mailboxes on an IMAP server. This is
- mostly the same as the local file browser, with the following differences:
+# Send excel spreadsheets to my NT box
+application/ms-excel; open.pl %s
- +\bo Instead of file permissions, mutt displays the string "IMAP", possibly
- followed by the symbol "+", indicating that the entry contains both mes-
- sages and subfolders. On Cyrus-like servers folders will often contain
- both messages and subfolders.
+4. MIME Autoview
- +\bo For the case where an entry can contain both messages and subfolders, the
- selection key (bound to enter by default) will choose to descend into the
- subfolder view. If you wish to view the messages in that folder, you must
- use view-file instead (bound to space by default).
+ In addition to explicitly telling Mutt-ng to view an attachment with the MIME viewer defined in the mailcap file, Mutt-ng has support for automatically viewing MIME attachments while in the pager.
- +\bo You can create, delete and rename mailboxes with the create-mailbox,
- delete-mailbox, and rename-mailbox commands (default bindings: C, d and r,
- respectively). You may also subscribe and unsubscribe to mailboxes (nor-
- mally these are bound to s and u, respectively).
+ To work, you must define a viewer in the mailcap file which uses the copiousoutput option to denote that it is non-interactive. Usually, you also use the entry to convert the attachment to a text representation which you can view in the pager.
- _\b4_\b._\b1_\b4_\b._\b2 _\bA_\bu_\bt_\bh_\be_\bn_\bt_\bi_\bc_\ba_\bt_\bi_\bo_\bn
+ You then use the auto_view muttrc command to list the content-types that you wish to view automatically.
- Mutt-ng supports four authentication methods with IMAP servers: SASL, GSSAPI,
- CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add NTLM authentica-
- tion for you poor exchange users out there, but it has yet to be integrated
- into the main tree). There is also support for the pseudo-protocol ANONYMOUS,
- which allows you to log in to a public IMAP server without having an account.
- To use ANONYMOUS, simply make your username blank or "anonymous".
+ For instance, if you set auto_view to:
+auto_view text/html application/x-gunzip application/postscript image/gif application/x-tar-gz
- The Mutt Next Generation E-Mail Client 66
+ Mutt-ng could use the following mailcap entries to automatically view attachments of these types.
+text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html
+image/*; anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm | pgmtopbm | pbmtoascii ; copiousoutput
+application/x-gunzip; gzcat; copiousoutput
+application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
+application/postscript; ps2ascii %s; copiousoutput
- SASL is a special super-authenticator, which selects among several protocols
- (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most secure method
- available on your host and the server. Using some of these methods (including
- DIGEST-MD5 and possibly GSSAPI), your entire session will be encrypted and
- invisible to those teeming network snoops. It is the best option if you have
- it. To use it, you must have the Cyrus SASL library installed on your system
- and compile mutt with the _\b-_\b-_\bw_\bi_\bt_\bh_\b-_\bs_\ba_\bs_\bl flag.
+ ``unauto_view'' can be used to remove previous entries from the autoview list. This can be used with message-hook to autoview messages based on size, etc. ``unauto_view *'' will remove all previous entries.
- Mutt-ng will try whichever methods are compiled in and available on the server,
- in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN.
+5. MIME Multipart/Alternative
- There are a few variables which control authentication:
+ 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 types is preferred. The alternative_order list consists of a number of MIME types in order, including support for implicit and explicit wildcards, for example:
+alternative_order text/enriched text/plain text application/postscript image/*
- +\bo _\b$_\bi_\bm_\ba_\bp_\b__\bu_\bs_\be_\br (section 7.4.111 , page 115) - controls the username under
- which you request authentication on the IMAP server, for all authentica-
- tors. This is overridden by an explicit username in the mailbox path (i.e.
- by using a mailbox name of the form {user@host}).
+ Next, mutt will check if any of the types have a defined auto-view, and use that. Failing that, Mutt-ng will look for any text type. As a last attempt, mutt will look for any type it knows how to handle.
- +\bo _\b$_\bi_\bm_\ba_\bp_\b__\bp_\ba_\bs_\bs (section 7.4.106 , page 114) - a password which you may pre-
- set, used by all authentication methods where a password is needed.
+ To remove a MIME type from the alternative_order list, use the unalternative_order command.
- +\bo _\b$_\bi_\bm_\ba_\bp_\b__\ba_\bu_\bt_\bh_\be_\bn_\bt_\bi_\bc_\ba_\bt_\bo_\br_\bs (section 7.4.97 , page 112) - a colon-delimited list
- of IMAP authentication methods to try, in the order you wish to try them.
- If specified, this overrides mutt's default (attempt everything, in the
- order listed above).
+6. MIME Lookup
- _\b4_\b._\b1_\b5 _\bN_\bN_\bT_\bP _\bS_\bu_\bp_\bp_\bo_\br_\bt _\b(_\bO_\bP_\bT_\bI_\bO_\bN_\bA_\bL_\b)
+ 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 to deal with binary types such as application/octet-stream. When an attachment's 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 associated with this extension will then be used to process the attachment according to the rules in the mailcap file and according to any other configuration options (such as auto_view) specified. Common usage would be:
+mime_lookup application/octet-stream application/X-Lotus-Manuscript
- 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 i.
+ In addition, the unmime_lookup command may be used to disable this feature for any particular mime-type if it had been set, for example, in a global muttrc.
- The Default newsserver can be obtained from the $NNTPSERVER environment vari-
- able. Like other news readers, info about subscribed newsgroups is saved in a
- file as specified by the _\b$_\bn_\bn_\bt_\bp_\b__\bn_\be_\bw_\bs_\br_\bc (section 7.4.172 , page 131) 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.
+Chapter 6. Security Considerations
- _\b4_\b._\b1_\b5_\b._\b1 _\bA_\bg_\ba_\bi_\bn_\b: _\bS_\bc_\bo_\br_\bi_\bn_\bg
+ Table of Contents
- 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 _\bM_\be_\bs_\bs_\ba_\bg_\be _\bs_\bc_\bo_\br_\bi_\bn_\bg (section 3.26 , page
- 42).
+ 1. Passwords
+ 2. Temporary Files
+ 3. Information Leaks
- What has not been discusses in detail is mutt-ng's built-in realname filter.
- For may newsreaders including those for ``advanced users'' like _\bs_\bl_\br_\bn or _\bt_\bi_\bn,
- there are frequent request for such functionality. The solutions offered often
- are complicated regular expressions.
+ 3.1. Message-ID: headers
+ 3.2. mailto:-style links
- In mutt-ng this is as easy as
+ 4. External applications
- The Mutt Next Generation E-Mail Client 67
+ 4.1. mailcap
+ 4.2. Other
- score ~* =42
+ First of all, mutt-ng contains no security holes included by intention but may contain unknown security holes. As a consequence, please run mutt-ng only with as few permissions as possible.
- This tells mutt-ng to apply a score of 42 to all messages whose sender speci-
- fied a valid realname and a valid email address. Using
+ Please do not run mutt-ng as the super user.
- score !~* =42
+ When configuring mutt-ng, there're some points to note about secure setups.
- on the contrary applies a score of 42 to all messages _\bn_\bo_\bt matching those crite-
- ria which are very strict:
+ In practice, mutt-ng can be easily made as vulnerable as even the most insecure mail user agents (in their default configuration) just by changing mutt-ng's configuration files: it then can execute arbitrary programs and scripts attached to messages, send out private data on its own, etc. Although this is not believed to the common type of setup, please read this chapter carefully.
- +\bo Email addresses must be valid according to RFC 2822, see <ftp://ftp.rfc-
- editor.org/in-notes/rfc2822.txt>
+1. Passwords
- +\bo the name must consist of at least 2 fields whereby a field must not end in
- a dot. This means that ``Joe User'' and ``Joe A. User'' are valid while
- ``J. User'' and ``J. A. User'' aren't.
+ Although mutt-ng can be told the various passwords for accounts, please never store passwords in configuration files. Besides the fact that the system's operator can always read them, you could forget to replace the actual password with asterisks when reporting a bug or asking for help via, for example, a mailing list so that your mail including your password could be archived by internet search engines, etc. Please never store passwords on disk.
- +\bo it's assumed that users are interested in reading their own mail and mail
- from people who they have defined an alias for so that those 2 groups of
- messages are excluded from the strict rules.
+2. Temporary Files
- _\b4_\b._\b1_\b6 _\bS_\bM_\bT_\bP _\bS_\bu_\bp_\bp_\bo_\br_\bt _\b(_\bO_\bP_\bT_\bI_\bO_\bN_\bA_\bL_\b)
+ Mutt-ng uses many temporary files for viewing messages, verifying digital signatures, etc. The 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 tmpdir variable.
- Mutt-ng can be built using a library called ``libESMTP'' which provides SMTP
- functionality. When configure was called with --with-libesmtp or the output
- muttng -v contains +USE_LIBESMTP, this will be or is the case already. The SMTP
- support includes support for Delivery Status Notification (see _\bD_\be_\bl_\bi_\bv_\be_\br_\by _\bS_\bt_\ba_\bt_\bu_\bs
- _\bN_\bo_\bt_\bi_\bf_\bi_\bc_\ba_\bt_\bi_\bo_\bn (section 4.12 , page 63) section) as well as handling the 8BIT-
- MIME flag controlled via _\b$_\bu_\bs_\be_\b__\b8_\bb_\bi_\bt_\bm_\bi_\bm_\be (section 7.4.344 , page 173).
+3. Information Leaks
- To enable sending mail directly via SMTP without an MTA such as Postfix or
- SSMTP and the like, simply set the _\b$_\bs_\bm_\bt_\bp_\b__\bh_\bo_\bs_\bt (section 7.4.302 , page 161)
- variable pointing to your SMTP server.
+3.1. Message-ID: headers
- Authentication mechanisms are available via the _\b$_\bs_\bm_\bt_\bp_\b__\bu_\bs_\be_\br (section 7.4.306 ,
- page 162) and _\b$_\bs_\bm_\bt_\bp_\b__\bp_\ba_\bs_\bs (section 7.4.303 , page 162) variables.
+ In the default configuration, mutt-ng will leak some information to the outside world when sending messages: the generation of Message-ID: headers includes a step counter which 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 %P expando from the default setting of the msgid-format variable. Please make sure that you really know how local parts of these Message-ID: headers are composed.
- 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
- _\b$_\bs_\bm_\bt_\bp_\b__\bu_\bs_\be_\b__\bt_\bl_\bs (section 7.4.305 , page 162) 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 if it doesn't while
- switching back to unencrypted communication for the first one.
+3.2. mailto:-style links
- Some mail providers require user's to set a particular envelope sender, i.e.
+ As mutt-ng be can be set up to be the mail client to handle mailto: style links in websites, there're security considerations, too. To keep the old behavior by default, mutt-ng 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 edit-headers variable is unset, i.e. the user doesn't want to see header fields while editing the message.
- The Mutt Next Generation E-Mail Client 68
+ For example, following a link like
+mailto:joe@host?Attach=~/.gnupg/secring.gpg
- they allow for only one value which may not be what the user wants to send as
- the From: header. In this case, the variable _\b$_\bs_\bm_\bt_\bp_\b__\be_\bn_\bv_\be_\bl_\bo_\bp_\be (section 7.4.301 ,
- page 161) may be used to set the envelope different from the From: header.
+ will send out the user's private gnupg keyring to joe@host if the user doesn't follow the information on screen carefully enough.
- _\b4_\b._\b1_\b7 _\bM_\ba_\bn_\ba_\bg_\bi_\bn_\bg _\bm_\bu_\bl_\bt_\bi_\bp_\bl_\be _\bI_\bM_\bA_\bP_\b/_\bP_\bO_\bP_\b/_\bN_\bN_\bT_\bP _\ba_\bc_\bc_\bo_\bu_\bn_\bt_\bs _\b(_\bO_\bP_\bT_\bI_\bO_\bN_\bA_\bL_\b)
+ When unsetting the strict-mailto variable, mutt-ng will
+ * be less strict when interpreting these links by prepending a X-Mailto- string to all header fields embedded in such a link and
+ * turn on the edit-headers variable by force to let the user see all the headers (because they still may leak information.)
- If you happen to have accounts on multiple IMAP and/or POP servers, you may
- find managing all the authentication settings inconvenient and error-prone.
- The account-hook command may help. This hook works like folder-hook but is
- invoked whenever you access a remote mailbox (including inside the folder
- browser), not just when you open the mailbox.
+4. External applications
- Some examples:
+ Mutt-ng in many places has to rely on external applications or for convenience supports mechanisms involving external applications.
- 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"'
+4.1. mailcap
- _\b4_\b._\b1_\b8 _\bS_\bt_\ba_\br_\bt _\ba _\bW_\bW_\bW _\bB_\br_\bo_\bw_\bs_\be_\br _\bo_\bn _\bU_\bR_\bL_\bs _\b(_\bE_\bX_\bT_\bE_\bR_\bN_\bA_\bL_\b)
+ One of these is the mailcap mechanism as defined by RfC 1524. Mutt-ng can be set up to automatically execute any given utility as listed in one of the mailcap files (see the mailcap-path variable for details.)
- If a message contains URLs (_\bu_\bn_\bi_\bf_\bi_\be_\bd _\br_\be_\bs_\bo_\bu_\br_\bc_\be _\bl_\bo_\bc_\ba_\bt_\bo_\br = address in the WWW space
- like _\bh_\bt_\bt_\bp_\b:_\b/_\b/_\bw_\bw_\bw_\b._\bm_\bu_\bt_\bt_\b._\bo_\br_\bg_\b/), it is efficient to get a menu with all the URLs and
- start a WWW browser on one of them. This functionality is provided by the
- external urlview program which can be retrieved at ftp://ftp.mutt.org/mutt/con-
- trib/ and the configuration commands:
+ These utilities may have a variety of security vulnerabilities, including overwriting of arbitrary files, information leaks or other exploitable bugs. These vulnerabilities may go unnoticed by the user, especially when they are called automatically (and without interactive prompting) from the mailcap file(s). When using mutt-ng's autoview mechanism in combination with mailcap files, please be sure to...
+ * manually select trustworth applications with a reasonable calling sequence
+ * periodically check the contents of mailcap files, especially after software installations or upgrades
+ * keep the software packages referenced in the mailcap file up to date
+ * leave the mailcap-sanitize variable in its default state to restrict mailcap expandos to a safe set of characters
- macro index \cb |urlview\n
- macro pager \cb |urlview\n
+4.2. Other
- _\b4_\b._\b1_\b9 _\bC_\bo_\bm_\bp_\br_\be_\bs_\bs_\be_\bd _\bf_\bo_\bl_\bd_\be_\br_\bs _\bS_\bu_\bp_\bp_\bo_\br_\bt _\b(_\bO_\bP_\bT_\bI_\bO_\bN_\bA_\bL_\b)
+ Besides the mailcap mechanism, mutt-ng uses a number of other external utilities for operation.
- If Mutt-ng was compiled with compressed folders support (by running the _\bc_\bo_\bn_\bf_\bi_\bg_\b-
- _\bu_\br_\be script with the _\b-_\b-_\be_\bn_\ba_\bb_\bl_\be_\b-_\bc_\bo_\bm_\bp_\br_\be_\bs_\bs_\be_\bd flag), Mutt can open folders stored in
- an arbitrary format, provided that the user has a script to convert from/to
- this format to one of the accepted.
+ The same security considerations apply for these as for tools involved via mailcap (for example, mutt-ng is vulnerable to Denial of Service Attacks with compressed folders support if the uncompressed mailbox is too large for the disk it is saved to.)
- The most common use is to open compressed archived folders e.g. with gzip.
+ As already noted, most of these problems are not built in but caused by wrong configuration, so please check your configuration.
- In addition, the user can provide a script that gets a folder in an accepted
- format and appends its context to the folder in the user-defined format, which
- may be faster than converting the entire folder to the accepted format, append-
- ing to it and converting back to the user-defined format.
+Chapter 7. Reference
- There are three hooks defined (_\bo_\bp_\be_\bn_\b-_\bh_\bo_\bo_\bk (section 4.19.1 , page 69), _\bc_\bl_\bo_\bs_\be_\b-
- _\bh_\bo_\bo_\bk (section 4.19.2 , page 69) and _\ba_\bp_\bp_\be_\bn_\bd_\b-_\bh_\bo_\bo_\bk (section 4.19.3 , page 70))
- which define commands to uncompress and compress a folder and to append mes-
- sages to an existing compressed folder respectively.
+ Table of Contents
- The Mutt Next Generation E-Mail Client 69
+ 1. Command line options
+ 2. Patterns
+ 3. Configuration Commands
+ 4. Configuration variables
+ 5. Functions
- For example:
+ 5.1. generic
+ 5.2. index
+ 5.3. pager
+ 5.4. alias
+ 5.5. query
+ 5.6. attach
+ 5.7. compose
+ 5.8. postpone
+ 5.9. browser
+ 5.10. pgp
+ 5.11. editor
- open-hook \\.gz$ "gzip -cd %f > %t"
- close-hook \\.gz$ "gzip -c %t > %f"
- append-hook \\.gz$ "gzip -c %t >> %f"
+1. Command line options
- You do not have to specify all of the commands. If you omit _\ba_\bp_\bp_\be_\bn_\bd_\b-_\bh_\bo_\bo_\bk (sec-
- tion 4.19.3 , page 70), the folder will be open and closed again each time you
- will add to it. If you omit _\bc_\bl_\bo_\bs_\be_\b-_\bh_\bo_\bo_\bk (section 4.19.2 , page 69) (or give
- empty command) , the folder will be open in the mode. If you specify _\ba_\bp_\bp_\be_\bn_\bd_\b-
- _\bh_\bo_\bo_\bk (section 4.19.3 , page 70) though you'll be able to append to the folder.
+ Running mutt with no arguments will make Mutt-ng attempt to read your spool mailbox. However, it is possible to read other mailboxes and to send messages from the command line as well.
+-A expand an alias
+-a attach a file to a message
+-b specify a blind carbon-copy (BCC) address
+-c specify a carbon-copy (Cc) address
+-e specify a config command to be run after initialization files are read
+-f specify a mailbox to load
+-F specify an alternate file to read initialization commands
+-h print help on command line options
+-H specify a draft file from which to read a header and body
+-i specify a file to include in a message composition
+-m specify a default mailbox type
+-n do not read the system Muttngrc
+-p recall a postponed message
+-Q query a configuration variable
+-R open mailbox in read-only mode
+-s specify a subject (enclose in quotes if it contains spaces)
+-t dump the value of all variables to stdout
+-T dump the value of all changed variables to stdout
+-v show version number and compile-time definitions
+-x simulate the mailx(1) compose mode
+-y show a menu containing the files specified by the mailboxes command
+-z exit immediately if there are no messages in the mailbox
+-Z open the first folder with new message,exit immediately if none
+
+ To read messages in a mailbox
+
+ mutt [ -nz ] [ -F muttrc ] [ -m type ] [ -f mailbox ]
+
+ To compose a new message
+
+ mutt [ -n ] [ -F muttrc ] [ -a file ] [ -c address ] [ -i filename ] [ -s subject ] address [ address ... ]
+
+ Mutt-ng also supports a ``batch'' mode to send prepared messages. Simply redirect input from the file you wish to send. For example,
+
+ mutt -s "data set for run #2" professor@bigschool.edu < ˜/run2.dat
+
+ 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 contents of the file ``˜/run2.dat''.
+
+2. Patterns
+
+~A all messages
+~b EXPR messages which contain EXPR in the message body
+~B EXPR messages which contain EXPR in the whole message
+~c USER messages carbon-copied to USER
+~C EXPR message is either to: or cc: EXPR
+~D deleted messages
+~d [MIN]-[MAX] messages with ``date-sent'' in a Date range
+~E expired messages
+~e EXPR message which contains EXPR in the ``Sender'' field
+~F flagged messages
+~f USER messages originating from USER
+~g cryptographically signed messages
+~G cryptographically encrypted messages
+~H EXPR messages with a spam attribute matching EXPR
+~h EXPR messages which contain EXPR in the message header
+~k message contains PGP key material
+~i ID message which match ID in the ``Message-ID'' field
+~L EXPR message is either originated or received by EXPR
+~l message is addressed to a known mailing list
+~m [MIN]-[MAX] message in the range MIN to MAX *)
+~M multipart messages
+~n [MIN]-[MAX] messages with a score in the range MIN to MAX *)
+~N new messages
+~O old messages
+~p message is addressed to you (consults alternates)
+~P message is from you (consults alternates)
+~Q messages which have been replied to
+~R read messages
+~r [MIN]-[MAX] messages with ``date-received'' in a Date range
+~S superseded messages
+~s SUBJECT messages having SUBJECT in the ``Subject'' field.
+~T tagged messages
+~t USER messages addressed to USER
+~U unread messages
+~v message is part of a collapsed thread.
+~V cryptographically verified messages
+~w EXPR messages which contain EXPR in the `Newsgroups' field
+ (if compiled with NNTP support)
+~x EXPR messages which contain EXPR in the `References' field
+~y EXPR messages which contain EXPR in the `X-Label' field
+~z [MIN]-[MAX] messages with a size in the range MIN to MAX *)
+~= duplicated messages (see $duplicate_threads)
+~$ unreferenced messages (requires threaded view)
+~* ``From'' contains realname and (syntactically) valid
+ address (excluded are addresses matching against
+ alternates or any alias)
+
+ Where EXPR, USER, ID, and SUBJECT are regexp. 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 (\), which is normally used for quoting. If it is your intention to use a backslash in the regular expression, you will need to use two backslashes instead (\\).
+
+ *) The forms <[MAX], >[MIN], [MIN]- and -[MAX] are allowed, too.
+
+3. Configuration Commands
+
+ The following are the commands understood by mutt.
+ * account-hook pattern command
+ * alias key address [ , address, ... ]
+ * alias [ * | key ... ]
+ * alternates regexp [ regexp ... ]
+ * alternates [ * | regexp ... ]
+ * alternative-order mimetype [ mimetype ... ]
+ * alternative-order mimetype [ mimetype ... ]
+ * append-hook regexp command
+ * auto-view mimetype [ mimetype ... ]
+ * auto-view mimetype [ mimetype ... ]
+ * bind map key function
+ * charset-hook alias charset
+ * close-hook regexp command
+ * color object foreground background [ regexp ]
+ * color index pattern [ pattern ... ]
+ * exec function [ function ... ]
+ * fcc-hook pattern mailbox
+ * fcc-save-hook pattern mailbox
+ * folder-hook pattern command
+ * hdr-order header [ header ... ]
+ * hdr-order header [ header ... ]
+ * charset-hook charset local-charset
+ * ignore pattern [ pattern ... ]
+ * ignore pattern [ pattern ... ]
+ * lists regexp [ regexp ... ]
+ * lists regexp [ regexp ... ]
+ * macro menu key sequence [ description ]
+ * mailboxes filename [ filename ... ]
+ * mbox-hook pattern mailbox
+ * message-hook pattern command
+ * mime-lookup mimetype [ mimetype ... ]
+ * mime-lookup mimetype [ mimetype ... ]
+ * color object attribute [ regexp ]
+ * color index pattern [ pattern ... ]
+ * my-hdr string
+ * my-hdr field [ field ... ]
+ * open-hook regexp command
+ * crypt-hook pattern key-id
+ * push string
+ * set variable [variable ... ]
+ * save-hook regexp filename
+ * score-command pattern value
+ * score-command pattern [ pattern ... ]
+ * send-hook regexp command
+ * reply-hook regexp command
+ * set [no|inv]variable[=value] [ variable ... ]
+ * set variable [variable ... ]
+ * source filename
+ * spam pattern format
+ * spam pattern
+ * lists regexp [ regexp ... ]
+ * lists regexp [ regexp ... ]
+ * set variable [variable ... ]
+ * unhook hook-type
+
+4. Configuration variables
+
+ The following list contains all variables which, in the process of providing more consistency, have been renamed and are partially even removed already. The left column contains the old synonym variables, the right column the full/new name:
+
+edit_hdrs edit_headers
+forw_decode forward_decode
+forw_format forward_format
+forw_quote forward_quote
+hdr_format index_format
+indent_str indent_string
+mime_fwd mime_forward
+msg_format message_format
+pgp_autosign crypt_autosign
+pgp_autoencrypt crypt_autoencrypt
+pgp_replyencrypt crypt_replyencrypt
+pgp_replysign crypt_replysign
+pgp_replysignencrypted crypt_replysignencrypted
+pgp_verify_sig crypt_verify_sig
+pgp_create_traditional pgp_autoinline
+pgp_auto_traditional pgp_replyinline
+forw_decrypt forward_decrypt
+smime_sign_as smime_default_key
+post_indent_str post_indent_string
+print_cmd print_command
+shorten_hierarchy sidebar_shorten_hierarchy
+ask_followup_to nntp_ask_followup_to
+ask_x_comment_to nntp_ask_x_comment_to
+catchup_newsgroup nntp_catchup
+followup_to_poster nntp_followup_to_poster
+group_index_format nntp_group_index_format
+inews nntp_inews
+mime_subject nntp_mime_subject
+news_cache_dir nntp_cache_dir
+news_server nntp_host
+newsrc nntp_newsrc
+nntp_poll nntp_mail_check
+pop_checkinterval pop_mail_check
+post_moderated nntp_post_moderated
+save_unsubscribed nntp_save_unsubscribed
+show_new_news nntp_show_new_news
+show_only_unread nntp_show_only_unread
+x_comment_to nntp_x_comment_to
+smtp_auth_username smtp_user
+smtp_auth_password smtp_pass
- Note that Mutt-ng will only try to use hooks if the file is not in one of the
- accepted formats. In particular, if the file is empty, mutt 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 sur-
- prising if your compressing script produces empty files. In this situation,
- unset _\b$_\bs_\ba_\bv_\be_\b__\be_\bm_\bp_\bt_\by (section 7.4.256 , page 151), so that the compressed file
- will be removed if you delete all of the messages.
+ The contrib subdirectory contains a script named update-config.pl which eases migration.
- _\b4_\b._\b1_\b9_\b._\b1 _\bO_\bp_\be_\bn _\ba _\bc_\bo_\bm_\bp_\br_\be_\bs_\bs_\be_\bd _\bm_\ba_\bi_\bl_\bb_\bo_\bx _\bf_\bo_\br _\br_\be_\ba_\bd_\bi_\bn_\bg
+ A complete list of current variables follows.
- Usage: open-hook _\br_\be_\bg_\be_\bx_\bp '_\bc_\bo_\bm_\bm_\ba_\bn_\bd'
+1. abort_noattach
- The _\bc_\bo_\bm_\bm_\ba_\bn_\bd is the command that can be used for opening the folders whose names
- match _\br_\be_\bg_\be_\bx_\bp.
+ Type: quadoption
- The _\bc_\bo_\bm_\bm_\ba_\bn_\bd 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 name of the temporary folder to which to write.
+ Default: no
- %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.
+ This variable specifies whether to abort sending if no attachment was made but the content references them, i.e. the content matches the regular expression given in $attach_remind_regexp. If a match was found and this variable is set to yes, message sending will be aborted but the mail will be send nevertheless if set to no.
- The _\bc_\bo_\bm_\bm_\ba_\bn_\bd should n\bno\bot\bt remove the original compressed file. The _\bc_\bo_\bm_\bm_\ba_\bn_\bd should
- return non-zero exit status if it fails, so mutt knows something's wrong.
+ This variable and $attach_remind_regexp are intended to remind the user to attach files if the message's text references them.
- Example:
+ See also the $attach_remind_regexp variable.
- open-hook \\.gz$ "gzip -cd %f > %t"
+2. abort_nosubject
- If the _\bc_\bo_\bm_\bm_\ba_\bn_\bd is empty, this operation is disabled for this file type.
+ Type: quadoption
- _\b4_\b._\b1_\b9_\b._\b2 _\bW_\br_\bi_\bt_\be _\ba _\bc_\bo_\bm_\bp_\br_\be_\bs_\bs_\be_\bd _\bm_\ba_\bi_\bl_\bb_\bo_\bx
+ Default: ask-yes
- Usage: close-hook _\br_\be_\bg_\be_\bx_\bp '_\bc_\bo_\bm_\bm_\ba_\bn_\bd'
+ If set to yes, when composing messages and no subject is given at the subject prompt, composition will be aborted. If set to no, composing messages with no subject given at the subject prompt will never be aborted.
- This is used to close the folder that was open with the _\bo_\bp_\be_\bn_\b-_\bh_\bo_\bo_\bk (section
- 4.19.1 , page 69) command after some changes were made to it.
+3. abort_unmodified
- The Mutt Next Generation E-Mail Client 70
+ Type: quadoption
- The _\bc_\bo_\bm_\bm_\ba_\bn_\bd string is the command that can be used for closing the folders
- whose names match _\br_\be_\bg_\be_\bx_\bp. It has the same format as in the _\bo_\bp_\be_\bn_\b-_\bh_\bo_\bo_\bk (section
- 4.19.1 , page 69) command. Temporary folder in this case is the folder previ-
- ously produced by the <_\bo_\bp_\be_\bn_\b-_\bh_\bo_\bo_\bk (section 4.19.1 , page 69) command.
+ Default: yes
- The _\bc_\bo_\bm_\bm_\ba_\bn_\bd should n\bno\bot\bt remove the decompressed file. The _\bc_\bo_\bm_\bm_\ba_\bn_\bd should return
- non-zero exit status if it fails, so mutt knows something's wrong.
+ If set to yes, composition will automatically abort after editing the message body if no changes are made to the file (this check only happens after the first edit of the file). When set to no, composition will never be aborted.
- Example:
+4. agent_string
- close-hook \\.gz$ "gzip -c %t > %f"
+ Type: boolean
- If the _\bc_\bo_\bm_\bm_\ba_\bn_\bd is empty, this operation is disabled for this file type, and the
- file can only be open in the readonly mode.
+ Default: yes
- _\bc_\bl_\bo_\bs_\be_\b-_\bh_\bo_\bo_\bk (section 4.19.2 , page 69) is not called when you exit from the
- folder if the folder was not changed.
+ When set, Mutt-ng will add a ``User-Agent:'' header to outgoing messages, indicating which version of Mutt-ng was used for composing them.
- _\b4_\b._\b1_\b9_\b._\b3 _\bA_\bp_\bp_\be_\bn_\bd _\ba _\bm_\be_\bs_\bs_\ba_\bg_\be _\bt_\bo _\ba _\bc_\bo_\bm_\bp_\br_\be_\bs_\bs_\be_\bd _\bm_\ba_\bi_\bl_\bb_\bo_\bx
+5. alias_file
- Usage: append-hook _\br_\be_\bg_\be_\bx_\bp '_\bc_\bo_\bm_\bm_\ba_\bn_\bd'
+ Type: path
- This command is used for saving to an existing compressed folder. The _\bc_\bo_\bm_\bm_\ba_\bn_\bd
- is the command that can be used for appending to the folders whose names match
- _\br_\be_\bg_\be_\bx_\bp. It has the same format as in the _\bo_\bp_\be_\bn_\b-_\bh_\bo_\bo_\bk (section 4.19.1 , page 69)
- command. The temporary folder in this case contains the messages that are
- being appended.
+ Default: "˜/.muttngrc"
- The _\bc_\bo_\bm_\bm_\ba_\bn_\bd should n\bno\bot\bt remove the decompressed file. The _\bc_\bo_\bm_\bm_\ba_\bn_\bd should return
- non-zero exit status if it fails, so mutt knows something's wrong.
+ The default file in which to save aliases created by the ``create-alias'' function.
- Example:
+ Note: Mutt-ng will not automatically source this file; you must explicitly use the `` source'' command for it to be executed.
- append-hook \\.gz$ "gzip -c %t >> %f"
+6. alias_format
- When _\ba_\bp_\bp_\be_\bn_\bd_\b-_\bh_\bo_\bo_\bk (section 4.19.3 , page 70) 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 (_\b$_\bm_\bb_\bo_\bx_\b__\bt_\by_\bp_\be (section 7.4.132 , page 122)) type is always
- supposed (i.e. this is the format used for the temporary folder).
+ Type: string
- If the file does not exist when you save to it, _\bc_\bl_\bo_\bs_\be_\b-_\bh_\bo_\bo_\bk (section 4.19.2 ,
- page 69) is called, and not _\ba_\bp_\bp_\be_\bn_\bd_\b-_\bh_\bo_\bo_\bk (section 4.19.3 , page 70). _\ba_\bp_\bp_\be_\bn_\bd_\b-
- _\bh_\bo_\bo_\bk (section 4.19.3 , page 70) is only for appending to existing folders.
+ Default: "%4n %2f %t %-10a %r"
- If the _\bc_\bo_\bm_\bm_\ba_\bn_\bd is empty, this operation is disabled for this file type. In this
- case, the folder will be open and closed again (using _\bo_\bp_\be_\bn_\b-_\bh_\bo_\bo_\bk (section
- 4.19.1 , page 69) and _\bc_\bl_\bo_\bs_\be_\b-_\bh_\bo_\bo_\bk (section 4.19.2 , page 69)respectively) each
- time you will add to it.
+ Specifies the format of the data displayed for the ``alias'' menu. The following printf(3)-style sequences are available:
- The Mutt Next Generation E-Mail Client 71
+ %a
+ alias name
- _\b4_\b._\b1_\b9_\b._\b4 _\bE_\bn_\bc_\br_\by_\bp_\bt_\be_\bd _\bf_\bo_\bl_\bd_\be_\br_\bs
+ %f
+ flags - currently, a "d" for an alias marked for deletion
- The compressed folders support can also be used to handle encrypted folders. If
- you want to encrypt a folder with PGP, you may want to use the following hooks:
+ %n
+ index number
- open-hook \\.pgp$ "pgp -f < %f > %t"
- close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId < %t > %f"
+ %r
+ address which alias expands to
- Please note, that PGP does not support appending to an encrypted folder, so
- there is no append-hook defined.
+ %t
+ character which indicates if the alias is tagged for inclusion
- N\bNo\bot\bte\be:\b: the folder is temporary stored decrypted in the /tmp directory, where it
- can be read by your system administrator. So think about the security aspects
- of this.
+7. allow_8bit
- _\b5_\b. _\bM_\bu_\bt_\bt_\b-_\bn_\bg_\b'_\bs _\bM_\bI_\bM_\bE _\bS_\bu_\bp_\bp_\bo_\br_\bt
+ Type: boolean
- Quite a bit of effort has been made to make Mutt-ng the premier text-mode MIME
- MUA. Every effort has been made to provide the functionality that the discern-
- ing MIME user requires, and the conformance to the standards wherever possible.
- When configuring Mutt-ng for MIME, there are two extra types of configuration
- files which Mutt-ng uses. One is the mime.types file, which contains the map-
- ping of file extensions to IANA MIME types. The other is the mailcap file,
- which specifies the external commands to use for handling specific MIME types.
+ Default: yes
- _\b5_\b._\b1 _\bU_\bs_\bi_\bn_\bg _\bM_\bI_\bM_\bE _\bi_\bn _\bM_\bu_\bt_\bt
+ Controls whether 8-bit data is converted to 7-bit using either quoted-printable or base64 encoding when sending mail.
- There are three areas/menus in Mutt-ng which deal with MIME, they are the pager
- (while viewing a message), the attachment menu and the compose menu.
+8. allow_ansi
- _\b5_\b._\b1_\b._\b1 _\bV_\bi_\be_\bw_\bi_\bn_\bg _\bM_\bI_\bM_\bE _\bm_\be_\bs_\bs_\ba_\bg_\be_\bs _\bi_\bn _\bt_\bh_\be _\bp_\ba_\bg_\be_\br
+ Type: boolean
- When you select a message from the index and view it in the pager, Mutt decodes
- the message to a text representation. Mutt-ng internally supports a number of
- MIME types, including text/plain, text/enriched, message/rfc822, and mes-
- sage/news. In addition, the export controlled version of Mutt-ng recognizes a
- variety of PGP MIME types, including PGP/MIME and application/pgp.
+ Default: no
- Mutt-ng will denote attachments with a couple lines describing them. These
- lines are of the form:
+ Controls whether ANSI color codes in messages (and color tags in rich text messages) are to be interpreted. Messages containing these codes are rare, but if this option is set, their text will be colored accordingly. Note that this may override your color choices, and even present a security problem, since a message could include a line like ``[-- PGP output follows ..." and give it the same color as your attachment color.
- [-- Attachment #1: Description --]
- [-- Type: text/plain, Encoding: 7bit, Size: 10000 --]
+9. arrow_cursor
- Where the Description is the description or filename given for the attachment,
- and the Encoding is one of 7bit/8bit/quoted-printable/base64/binary.
+ Type: boolean
- The Mutt Next Generation E-Mail Client 72
+ Default: no
- If Mutt-ng cannot deal with a MIME type, it will display a message like:
+ When set, an arrow (``->'') will be used to indicate the current entry in menus instead of highlighting the whole line. On slow network or modem links this will make response faster because there is less that has to be redrawn on the screen when moving to the next or previous entries in the menu.
- [-- image/gif is unsupported (use 'v' to view this part) --]
+10. ascii_chars
- _\b5_\b._\b1_\b._\b2 _\bT_\bh_\be _\bA_\bt_\bt_\ba_\bc_\bh_\bm_\be_\bn_\bt _\bM_\be_\bn_\bu
+ Type: boolean
- The default binding for view-attachments is `v', which displays the attachment
- menu for a message. The attachment menu displays a list of the attachments in
- a message. From the attachment menu, you can save, print, pipe, delete, and
- view attachments. You can apply these operations to a group of attachments at
- once, by tagging the attachments and by using the ``tag-prefix'' operator. You
- can also reply to the current message from this menu, and only the current
- attachment (or the attachments tagged) will be quoted in your reply. You can
- view attachments as text, or view them using the mailcap viewer definition.
+ Default: no
- Finally, you can apply the usual message-related functions (like _\br_\be_\bs_\be_\bn_\bd_\b-_\bm_\be_\bs_\bs_\ba_\bg_\be
- (section 2.5.4 , page 13), and the reply and forward functions) to attachments
- of type message/rfc822.
+ If set, Mutt-ng will use plain ASCII characters when displaying thread and attachment trees, instead of the default ACS characters.
- See the help on the attachment menu for more information.
+11. askbcc
- _\b5_\b._\b1_\b._\b3 _\bT_\bh_\be _\bC_\bo_\bm_\bp_\bo_\bs_\be _\bM_\be_\bn_\bu
+ Type: boolean
- The compose menu is the menu you see before you send a message. It allows you
- to edit the recipient list, the subject, and other aspects of your message. It
- also contains a list of the attachments of your message, including the main
- body. From this menu, you can print, copy, filter, pipe, edit, compose,
- review, and rename an attachment or a list of tagged attachments. You can also
- modifying the attachment information, notably the type, encoding and descrip-
- tion.
+ Default: no
- Attachments appear as follows:
+ If set, Mutt-ng will prompt you for blind-carbon-copy (Bcc) recipients before editing an outgoing message.
- - 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>
+12. askcc
- The '-' denotes that Mutt-ng will delete the file after sending (or postponing,
- or canceling) the message. It can be toggled with the toggle-unlink command
- (default: u). The next field is the MIME content-type, and can be changed with
- the edit-type command (default: ^T). The next field is the encoding for the
- attachment, which allows a binary message to be encoded for transmission on
- 7bit links. It can be changed with the edit-encoding command (default: ^E).
- The next field is the size of the attachment, rounded to kilobytes or
- megabytes. The next field is the filename, which can be changed with the
- rename-file command (default: R). The final field is the description of the
- attachment, and can be changed with the edit-description command (default: d).
+ Type: boolean
- _\b5_\b._\b2 _\bM_\bI_\bM_\bE _\bT_\by_\bp_\be _\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn _\bw_\bi_\bt_\bh _\bm_\bi_\bm_\be_\b._\bt_\by_\bp_\be_\bs
+ Default: no
- When you add an attachment to your mail message, Mutt-ng searches your personal
+ If set, Mutt-ng will prompt you for carbon-copy (Cc) recipients before editing the body of an outgoing message.
- The Mutt Next Generation E-Mail Client 73
+13. assumed_charset
- mime.types file at ${HOME}/.mime.types, and then the system mime.types file at
- /usr/local/share/mutt/mime.types or /etc/mime.types
+ Type: string
- The mime.types file consist of lines containing a MIME type and a space sepa-
- rated list of extensions. For example:
+ Default: "us-ascii"
- application/postscript ps eps
- application/pgp pgp
- audio/x-aiff aif aifc aiff
+ This variable is a colon-separated list of character encoding schemes for messages without character encoding indication. Header field values and message body content without character encoding indication would be assumed that they are written in one of this list. By default, all the header fields and message body without any charset indication are assumed to be in us-ascii.
- A sample mime.types file comes with the Mutt-ng distribution, and should con-
- tain most of the MIME types you are likely to use.
+ For example, Japanese users might prefer this:
- If Mutt-ng can not determine the mime type by the extension of the file you
- attach, it will look at the file. If the file is free of binary information,
- Mutt-ng will assume that the file is plain text, and mark it as text/plain. If
- the file contains binary information, then Mutt-ng will mark it as applica-
- tion/octet-stream. You can change the MIME type that Mutt-ng assigns to an
- attachment by using the edit-type command from the compose menu (default: ^T).
- The MIME type is actually a major mime type followed by the sub-type, separated
- by a '/'. 6 major types: application, text, image, video, audio, and model have
- been approved after various internet discussions. Mutt-ng recognises all of
- these if the appropriate entry is found in the mime.types file. It also recog-
- nises other major mime types, such as the chemical type that is widely used in
- the molecular modelling community to pass molecular data in various forms to
- various molecular viewers. Non-recognised mime types should only be used if the
- recipient of the message is likely to be expecting such attachments.
+ set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
- _\b5_\b._\b3 _\bM_\bI_\bM_\bE _\bV_\bi_\be_\bw_\be_\br _\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn _\bw_\bi_\bt_\bh _\bm_\ba_\bi_\bl_\bc_\ba_\bp
+ However, only the first content is valid for the message body. This variable is valid only if $strict_mime is unset.
- Mutt-ng supports RFC 1524 MIME Configuration, in particular the Unix specific
- format specified in Appendix A of RFC 1524. This file format is commonly
- referred to as the mailcap format. Many MIME compliant programs utilize the
- mailcap format, allowing you to specify handling for all MIME types in one
- place for all programs. Programs known to use this format include Netscape,
- XMosaic, lynx and metamail.
+14. attach_format
- In order to handle various MIME types that Mutt-ng can not handle internally,
- Mutt-ng parses a series of external configuration files to find an external
- handler. The default search string for these files is a colon delimited list
- set to
+ Type: string
- ${HOME}/.mailcap:/usr/local/share/mutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap
+ Default: "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] "
- where $HOME is your home directory.
+ This variable describes the format of the ``attachment'' menu. The following printf(3)-style sequences are understood:
- In particular, the metamail distribution will install a mailcap file, usually
- as /usr/local/etc/mailcap, which contains some baseline entries.
+ %C
+ charset
- The Mutt Next Generation E-Mail Client 74
+ %c
+ requires charset conversion (n or c)
- _\b5_\b._\b3_\b._\b1 _\bT_\bh_\be _\bB_\ba_\bs_\bi_\bc_\bs _\bo_\bf _\bt_\bh_\be _\bm_\ba_\bi_\bl_\bc_\ba_\bp _\bf_\bi_\bl_\be
+ %D
+ deleted flag
- A mailcap file consists of a series of lines which are comments, blank, or def-
- initions.
+ %d
+ description
- A comment line consists of a # character followed by anything you want.
+ %e
+ MIME Content-Transfer-Encoding: header field
- A blank line is blank.
+ %f
+ filename
- A definition line consists of a content type, a view command, and any number of
- optional fields. Each field of a definition line is divided by a semicolon ';'
- character.
+ %I
+ MIME Content-Disposition: header field (I=inline, A=attachment)
- The content type is specified in the MIME standard type/subtype method. For
- example, text/plain, text/html, image/gif, etc. In addition, the mailcap for-
- mat includes two formats for wildcards, one using the special '*' subtype, the
- other is the implicit wild, where you only include the major type. For exam-
- ple, image/*, or video, will match all image types and video types, respec-
- tively.
+ %m
+ major MIME type
- The view command is a Unix command for viewing the type specified. There are
- two different types of commands supported. The default is to send the body of
- the MIME message to the command on stdin. You can change 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 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 Mutt will remove the temporary file if it exists.
+ %M
+ MIME subtype
- So, in the simplest form, you can send a text/plain message to the external
- pager more on stdin:
+ %n
+ attachment number
- text/plain; more
+ %s
+ size
- Or, you could send the message as a file:
+ %t
+ tagged flag
- text/plain; more %s
+ %T
+ graphic tree characters
- Perhaps you would like to use lynx to interactively view a text/html message:
+ %u
+ unlink (=to delete) flag
- text/html; lynx %s
+ %>X
+ right justify the rest of the string and pad with character "X"
- In this case, lynx does not support viewing a file from stdin, so you must use
- the %s syntax. N\bNo\bot\bte\be:\b: _\bS_\bo_\bm_\be _\bo_\bl_\bd_\be_\br _\bv_\be_\br_\bs_\bi_\bo_\bn_\bs _\bo_\bf _\bl_\by_\bn_\bx _\bc_\bo_\bn_\bt_\ba_\bi_\bn _\ba _\bb_\bu_\bg _\bw_\bh_\be_\br_\be _\bt_\bh_\be_\by _\bw_\bi_\bl_\bl
- _\bc_\bh_\be_\bc_\bk _\bt_\bh_\be _\bm_\ba_\bi_\bl_\bc_\ba_\bp _\bf_\bi_\bl_\be _\bf_\bo_\br _\ba _\bv_\bi_\be_\bw_\be_\br _\bf_\bo_\br _\bt_\be_\bx_\bt_\b/_\bh_\bt_\bm_\bl_\b. _\bT_\bh_\be_\by _\bw_\bi_\bl_\bl _\bf_\bi_\bn_\bd _\bt_\bh_\be _\bl_\bi_\bn_\be
- _\bw_\bh_\bi_\bc_\bh _\bc_\ba_\bl_\bl_\bs _\bl_\by_\bn_\bx_\b, _\ba_\bn_\bd _\br_\bu_\bn _\bi_\bt_\b. _\bT_\bh_\bi_\bs _\bc_\ba_\bu_\bs_\be_\bs _\bl_\by_\bn_\bx _\bt_\bo _\bc_\bo_\bn_\bt_\bi_\bn_\bu_\bo_\bu_\bs_\bl_\by _\bs_\bp_\ba_\bw_\bn _\bi_\bt_\bs_\be_\bl_\bf _\bt_\bo
- _\bv_\bi_\be_\bw _\bt_\bh_\be _\bo_\bb_\bj_\be_\bc_\bt_\b.
+ %|X
+ pad to the end of the line with character "X"
- On the other hand, maybe you don't want to use lynx interactively, you just
- want to have it convert the text/html to text/plain, then you can use:
+15. attach_remind_regexp
- The Mutt Next Generation E-Mail Client 75
+ Type: regular expression
- text/html; lynx -dump %s | more
+ Default: "attach"
- Perhaps you wish to use lynx to view text/html files, and a pager on all other
- text formats, then you would use the following:
+ If this variable is non-empty, muttng will scan a message's contents before sending for this regular expression. If it is found, it will ask for what to do depending on the setting of $abort_noattach.
- text/html; lynx %s
- text/*; more
+ This variable and $abort_noattach are intended to remind the user to attach files if the message's text references them.
- This is the simplest form of a mailcap file.
+16. attach_sep
- _\b5_\b._\b3_\b._\b2 _\bS_\be_\bc_\bu_\br_\be _\bu_\bs_\be _\bo_\bf _\bm_\ba_\bi_\bl_\bc_\ba_\bp
+ Type: string
- The interpretation of shell meta-characters embedded in MIME parameters can
- lead to security problems in general. Mutt-ng tries to quote parameters in
- expansion of %s syntaxes properly, and avoids risky characters by substituting
- them, see the _\bm_\ba_\bi_\bl_\bc_\ba_\bp_\b__\bs_\ba_\bn_\bi_\bt_\bi_\bz_\be (section 7.4.123 , page 120) variable.
+ Default: "\n"
- Although mutt's procedures to invoke programs with mailcap seem to be safe,
- there are other applications parsing mailcap, maybe taking less care of it.
- Therefore you should pay attention to the following rules:
+ The separator to add between attachments when operating (saving, printing, piping, etc) on a list of tagged attachments.
- _\bK_\be_\be_\bp _\bt_\bh_\be _\b%_\b-_\be_\bx_\bp_\ba_\bn_\bd_\bo_\bs _\ba_\bw_\ba_\by _\bf_\br_\bo_\bm _\bs_\bh_\be_\bl_\bl _\bq_\bu_\bo_\bt_\bi_\bn_\bg_\b. 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 with eval statements, and avoid them if possible at all. Trying
- to fix broken behaviour with quotes introduces new leaks - there is no alterna-
- tive to correct quoting in the first place.
+17. attach_split
- 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 $charset
- inside the backtick expansion is safe, since it is not itself subject to any
- further expansion):
+ Type: boolean
- text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \
- && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1
+ Default: yes
- _\b5_\b._\b3_\b._\b3 _\bA_\bd_\bv_\ba_\bn_\bc_\be_\bd _\bm_\ba_\bi_\bl_\bc_\ba_\bp _\bU_\bs_\ba_\bg_\be
+ If this variable is unset, when operating (saving, printing, piping, etc) on a list of tagged attachments, Mutt-ng will concatenate the attachments and will operate on them as a single attachment. The ``$attach_sep'' separator is added after each attachment. When set, Mutt-ng will operate on the attachments one by one.
- _\b5_\b._\b3_\b._\b3_\b._\b1 _\bO_\bp_\bt_\bi_\bo_\bn_\ba_\bl _\bF_\bi_\be_\bl_\bd_\bs
+18. attribution
- In addition to the required content-type and view command fields, you can add
- semi-colon ';' separated fields to set flags and other options. Mutt-ng recog-
- nizes the following optional fields:
+ Type: string
- copiousoutput
- This flag tells Mutt-ng that the command passes possibly large
- amounts of text on stdout. This causes Mutt-ng to invoke a pager
- (either the internal pager or the external pager defined by the
- pager variable) on the output of the view command. Without this
+ Default: "On %d, %n wrote:"
- The Mutt Next Generation E-Mail Client 76
-
- flag, Mutt-ng assumes that the command is interactive. One could
- use this to replace the pipe to more in the lynx -dump example in
- the Basic section:
-
- text/html; lynx -dump %s ; copiousoutput
-
- This will cause lynx to format the text/html output as text/plain
- and Mutt-ng will use your standard pager to display the results.
+ This is the string that will precede a message which has been included in a reply. For a full listing of defined printf(3)-like sequences see the section on ``$index_format''.
- needsterminal
- Mutt-ng uses this flag when viewing attachments with _\ba_\bu_\bt_\bo_\bv_\bi_\be_\bw (sec-
- tion 5.4 , page 79), in order to decide whether it should honor
- the setting of the _\b$_\bw_\ba_\bi_\bt_\b__\bk_\be_\by (section 7.4.350 , page 174) variable
- or not. When an attachment is viewed using an interactive program,
- and the corresponding mailcap entry has a _\bn_\be_\be_\bd_\bs_\bt_\be_\br_\bm_\bi_\bn_\ba_\bl flag, Mutt-
- ng will use _\b$_\bw_\ba_\bi_\bt_\b__\bk_\be_\by (section 7.4.350 , page 174) and the exit
- status of the program to decide if it will ask you to press a key
- after the external program has exited. In all other situations it
- will not prompt you for a key.
+19. auto_tag
- compose=<command>
- This flag specifies the command to use to create a new attachment
- of a specific MIME type. Mutt-ng supports this from the compose
- menu.
+ Type: boolean
- composetyped=<command>
- This flag specifies the command to use to create a new attachment
- of a specific MIME type. This command differs from the compose
- command in that mutt will expect standard MIME headers on the data.
- This can be used to specify parameters, filename, description, etc.
- for a new attachment. Mutt-ng supports this from the compose
- menu.
-
- print=<command>
- This flag specifies the command to use to print a specific MIME
- type. Mutt-ng supports this from the attachment and compose menus.
-
- edit=<command>
- This flag specifies the command to use to edit a specific MIME
- type. Mutt-ng supports this from the compose menu, and also uses
- it to compose new attachments. Mutt-ng will default to the defined
- editor for text attachments.
-
- nametemplate=<template>
- This field specifies the format for the file denoted by %s in the
- command fields. Certain programs will require a certain file
- extension, for instance, to correctly view a file. For instance,
- lynx will only interpret a file as text/html if the file ends in
- .html. So, you would specify lynx as a text/html viewer with a
- line in the mailcap file like:
-
- text/html; lynx %s; nametemplate=%s.html
-
- The Mutt Next Generation E-Mail Client 77
-
- test=<command>
- This field specifies a command to run to test whether this mailcap
- entry should be used. The command is defined with the command
- expansion rules defined in the next section. If the command
- returns 0, then the test passed, and Mutt-ng uses this entry. If
- the command returns non-zero, then the test failed, and Mutt-ng
- continues searching for the right entry. N\bNo\bot\bte\be:\b: _\bt_\bh_\be _\bc_\bo_\bn_\bt_\be_\bn_\bt_\b-_\bt_\by_\bp_\be
- _\bm_\bu_\bs_\bt _\bm_\ba_\bt_\bc_\bh _\bb_\be_\bf_\bo_\br_\be _\bM_\bu_\bt_\bt_\b-_\bn_\bg _\bp_\be_\br_\bf_\bo_\br_\bm_\bs _\bt_\bh_\be _\bt_\be_\bs_\bt_\b. For example:
-
- text/html; netscape -remote 'openURL(%s)' ; test=RunningX
- text/html; lynx %s
-
- In this example, Mutt-ng will run the program RunningX which will
- return 0 if the X Window manager is running, and non-zero if it
- isn't. If RunningX returns 0, then Mutt-ng will call netscape to
- display the text/html object. If RunningX doesn't return 0, then
- Mutt-ng will go on to the next entry and use lynx to display the
- text/html object.
+ Default: no
- _\b5_\b._\b3_\b._\b3_\b._\b2 _\bS_\be_\ba_\br_\bc_\bh _\bO_\br_\bd_\be_\br
+ When set, functions in the index menu which affect a message will be applied to all tagged messages (if there are any). When unset, you must first use the ``tag-prefix'' function (default: ";") to make the next function apply to all tagged messages.
- When searching for an entry in the mailcap file, Mutt-ng will search for the
- most useful entry for its purpose. For instance, if you are attempting to
- print an image/gif, and you have the following entries in your mailcap file,
- Mutt-ng will search for an entry with the print command:
+20. autoedit
- image/*; xv %s
- image/gif; ; print= anytopnm %s | pnmtops | lpr; \
- nametemplate=%s.gif
+ Type: boolean
- Mutt-ng will skip the image/* entry and use the image/gif entry with the print
- command.
+ Default: no
- In addition, you can use this with _\bA_\bu_\bt_\bo_\bv_\bi_\be_\bw (section 5.4 , page 79) to denote
- two commands for viewing an attachment, one to be viewed automatically, the
- other to be viewed interactively from the attachment menu. In addition, you
- can then use the test feature to determine which viewer to use interactively
- depending on your environment.
-
- text/html; netscape -remote 'openURL(%s)' ; test=RunningX
- text/html; lynx %s; nametemplate=%s.html
- text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput
+ When set along with ``$edit_headers'', Mutt-ng will skip the initial send-menu and allow you to immediately begin editing the body of your message. The send-menu may still be accessed once you have finished editing the body of your message.
- For _\bA_\bu_\bt_\bo_\bv_\bi_\be_\bw (section 5.4 , page 79), Mutt-ng will choose the third entry
- because of the copiousoutput tag. For interactive viewing, Mutt will run the
- program RunningX to determine if it should use the first entry. If the program
- returns non-zero, Mutt-ng will use the second entry for interactive viewing.
+ Also see ``$fast_reply''.
- _\b5_\b._\b3_\b._\b3_\b._\b3 _\bC_\bo_\bm_\bm_\ba_\bn_\bd _\bE_\bx_\bp_\ba_\bn_\bs_\bi_\bo_\bn
-
- The various commands defined in the mailcap files are passed to the /bin/sh
-
- The Mutt Next Generation E-Mail Client 78
+21. beep
- shell using the system() function. Before the command is passed to /bin/sh -c,
- it is parsed to expand various special parameters with information from Mutt-
- ng. The keywords Mutt-ng expands are:
+ Type: boolean
- %s
- As seen in the basic mailcap section, this variable is expanded to
- a filename specified by the calling program. This file contains
- the body of the message to view/print/edit or where the composing
- program should place the results of composition. In addition, the
- use of this keyword causes Mutt-ng to not pass the body of the mes-
- sage to the view/print/edit program on stdin.
+ Default: yes
- %t
- 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
- mailcap definition line, ie text/html or image/gif.
+ When this variable is set, Mutt-ng will beep when an error occurs.
- %{<parameter>}
- Mutt-ng will expand this to the value of the specified parameter
- from the Content-Type: line of the mail message. For instance, if
- Your mail message contains:
+22. beep_new
- Content-Type: text/plain; charset=iso-8859-1
+ Type: boolean
- 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 using the right charset to view the message.
+ Default: no
- \%
- This will be replaced by a %
+ When this variable is set, Mutt-ng will beep whenever it prints a message notifying you of new mail. This is independent of the setting of the ``$beep'' variable.
- Mutt-ng does not currently support the %F and %n keywords specified in RFC
- 1524. The main purpose of these parameters is for multipart messages, which is
- handled internally by Mutt-ng.
+23. bounce
- _\b5_\b._\b3_\b._\b4 _\bE_\bx_\ba_\bm_\bp_\bl_\be _\bm_\ba_\bi_\bl_\bc_\ba_\bp _\bf_\bi_\bl_\be_\bs
+ Type: quadoption
- This mailcap file is fairly simple and standard:
+ Default: ask-yes
- # I'm always running X :)
- video/*; xanim %s > /dev/null
- image/*; xv %s > /dev/null
+ Controls whether you will be asked to confirm bouncing messages. If set to yes you don't get asked if you want to bounce a message. Setting this variable to no is not generally useful, and thus not recommended, because you are unable to bounce messages.
- # I'm always running netscape (if my computer had more memory, maybe)
- text/html; netscape -remote 'openURL(%s)'
+24. bounce_delivered
- This mailcap file shows quite a number of examples:
+ Type: boolean
- The Mutt Next Generation E-Mail Client 79
+ Default: yes
- # 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
+ When this variable is set, Mutt-ng will include Delivered-To: header fields when bouncing messages. Postfix users may wish to unset this variable.
- # Send html to a running netscape by remote
- text/html; netscape -remote 'openURL(%s)'; test=RunningNetscape
+25. braille_friendly
- # If I'm not running netscape but I am running X, start netscape on the
- # object
- text/html; netscape %s; test=RunningX
+ Type: boolean
- # Else use lynx to view it as text
- text/html; lynx %s
+ Default: no
- # This version would convert the text/html to text/plain
- text/html; lynx -dump %s; copiousoutput
+ When this variable is set, mutt will place the cursor at the beginning of the current line in menus, even when the arrow_cursor variable is unset, making it easier for blind persons using Braille displays to follow these menus. The option is disabled by default because many visual terminals don't permit making the cursor invisible.
- # I use enscript to print text in two columns to a page
- text/*; more %s; print=enscript -2Gr %s
+26. certificate_file
- # Netscape adds a flag to tell itself to view jpegs internally
- image/jpeg;xv %s; x-mozilla-flags=internal
+ Type: path
- # Use xv to view images if I'm running X
- # In addition, this uses the \ to extend the line and set my editor
- # for images
- image/*;xv %s; test=RunningX; \
- edit=xpaint %s
+ Default: "˜/.mutt_certificates"
- # Convert images to text using the netpbm tools
- image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
- pbmtoascii -1x2 ) 2>&1 ; copiousoutput
+ Availability: SSL or GNUTLS
- # Send excel spreadsheets to my NT box
- application/ms-excel; open.pl %s
+ This variable specifies the file where the certificates you trust are saved. When an unknown certificate is encountered, you are asked if you accept it or not. If you accept it, the certificate can also be saved in this file and further connections are automatically accepted.
- _\b5_\b._\b4 _\bM_\bI_\bM_\bE _\bA_\bu_\bt_\bo_\bv_\bi_\be_\bw
+ You can also manually add CA certificates in this file. Any server certificate that is signed with one of these CA certificates are also automatically accepted.
- In addition to explicitly telling Mutt-ng to view an attachment with the MIME
- viewer defined in the mailcap file, Mutt-ng has support for automatically view-
- ing MIME attachments while in the pager.
+ Example: set certificate_file=˜/.muttng/certificates
- To work, you must define a viewer in the mailcap file which uses the copi-
- ousoutput option to denote that it is non-interactive. Usually, you also use
- the entry to convert the attachment to a text representation which you can view
- in the pager.
+27. charset
- You then use the auto_view muttrc command to list the content-types that you
- wish to view automatically.
+ Type: string
- For instance, if you set auto_view to:
+ Default: ""
- The Mutt Next Generation E-Mail Client 80
+ Character set your terminal uses to display and enter textual data.
- auto_view text/html application/x-gunzip application/postscript image/gif application/x-tar-gz
+28. check_new
- Mutt-ng could use the following mailcap entries to automatically view attach-
- ments of these types.
+ Type: boolean
- text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html
- image/*; anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm | pgmtopbm | pbmtoascii ; copiousoutput
- application/x-gunzip; gzcat; copiousoutput
- application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
- application/postscript; ps2ascii %s; copiousoutput
+ Default: yes
- ``unauto_view'' can be used to remove previous entries from the autoview list.
- This can be used with message-hook to autoview messages based on size, etc.
- ``unauto_view *'' will remove all previous entries.
+ Note: this option only affects maildir and MH style mailboxes.
- _\b5_\b._\b5 _\bM_\bI_\bM_\bE _\bM_\bu_\bl_\bt_\bi_\bp_\ba_\br_\bt_\b/_\bA_\bl_\bt_\be_\br_\bn_\ba_\bt_\bi_\bv_\be
+ When set, Mutt-ng will check for new mail delivered while the mailbox is open. Especially with MH mailboxes, this operation can take quite some time since it involves scanning the directory and checking each file to see if it has already been looked at. If it's unset, no check for new mail is performed while the mailbox is open.
- Mutt-ng has some heuristics for determining which attachment of a multi-
- part/alternative type to display. First, mutt will check the alternative_order
- list to determine if one of the available types is preferred. The alterna-
- tive_order list consists of a number of MIME types in order, including support
- for implicit and explicit wildcards, for example:
+29. collapse_unread
- alternative_order text/enriched text/plain text application/postscript image/*
+ Type: boolean
- Next, mutt will check if any of the types have a defined _\ba_\bu_\bt_\bo_\b__\bv_\bi_\be_\bw (section
- 5.4 , page 79), and use that. Failing that, Mutt-ng will look for any text
- type. As a last attempt, mutt will look for any type it knows how to handle.
+ Default: yes
- To remove a MIME type from the alternative_order list, use the unalterna-
- tive_order command.
+ When unset, Mutt-ng will not collapse a thread if it contains any unread messages.
- _\b5_\b._\b6 _\bM_\bI_\bM_\bE _\bL_\bo_\bo_\bk_\bu_\bp
+30. compose_format
- 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 to deal with
- binary types such as application/octet-stream. When an attachment's 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 associated
- with this extension will then be used to process the attachment according to
- the rules in the mailcap file and according to any other configuration options
- (such as auto_view) specified. Common usage would be:
+ Type: string
- mime_lookup application/octet-stream application/X-Lotus-Manuscript
+ Default: "-- Mutt-ng: Compose [Approx. msg size: %l Atts: %a]%>-"
- In addition, the unmime_lookup command may be used to disable this feature for
+ Controls the format of the status line displayed in the ``compose'' menu. This string is similar to ``$status_format'', but has its own set of printf(3)-like sequences:
- The Mutt Next Generation E-Mail Client 81
+ %a
+ total number of attachments
- any particular mime-type if it had been set, for example, in a global muttrc.
+ %h
+ local hostname
- _\b6_\b. _\bS_\be_\bc_\bu_\br_\bi_\bt_\by _\bC_\bo_\bn_\bs_\bi_\bd_\be_\br_\ba_\bt_\bi_\bo_\bn_\bs
+ %l
+ approximate size (in bytes) of the current message
- First of all, mutt-ng contains no security holes included by intention but may
- contain unknown security holes. As a consequence, please run mutt-ng only with
- as few permissions as possible.
+ %v
+ Mutt-ng version string
- Please do not run mutt-ng as the super user.
+ See the text describing the ``$status_format'' option for more information on how to set ``$compose_format''.
- When configuring mutt-ng, there're some points to note about secure setups.
+31. config_charset
- In practice, mutt-ng can be easily made as vulnerable as even the most insecure
- mail user agents (in their default configuration) just by changing mutt-ng's
- configuration files: it then can execute arbitrary programs and scripts
- attached to messages, send out private data on its own, etc. Although this is
- not believed to the common type of setup, please read this chapter carefully.
+ Type: string
- _\b6_\b._\b1 _\bP_\ba_\bs_\bs_\bw_\bo_\br_\bd_\bs
+ Default: ""
- Although mutt-ng can be told the various passwords for accounts, please never
- store passwords in configuration files. Besides the fact that the system's
- operator can always read them, you could forget to replace the actual password
- with asterisks when reporting a bug or asking for help via, for example, a
- mailing list so that your mail including your password could be archived by
- internet search engines, etc. Please never store passwords on disk.
+ When defined, Mutt-ng will recode commands in rc files from this encoding.
- _\b6_\b._\b2 _\bT_\be_\bm_\bp_\bo_\br_\ba_\br_\by _\bF_\bi_\bl_\be_\bs
+32. confirmappend
- Mutt-ng uses many temporary files for viewing messages, verifying digital sig-
- natures, etc. The _\b$_\bu_\bm_\ba_\bs_\bk (section 7.4.342 , page 173) 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 _\b$_\bt_\bm_\bp_\bd_\bi_\br (section 7.4.338 , page 172)
- variable.
+ Type: boolean
- _\b6_\b._\b3 _\bI_\bn_\bf_\bo_\br_\bm_\ba_\bt_\bi_\bo_\bn _\bL_\be_\ba_\bk_\bs
+ Default: yes
- _\b6_\b._\b3_\b._\b1 _\bM_\be_\bs_\bs_\ba_\bg_\be_\b-_\bI_\bD_\b: _\bh_\be_\ba_\bd_\be_\br_\bs
+ When set, Mutt-ng will prompt for confirmation when appending messages to an existing mailbox.
- In the default configuration, mutt-ng will leak some information to the outside
- world when sending messages: the generation of Message-ID: headers includes a
- step counter which 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 %P expando from the default setting
- of the _\b$_\bm_\bs_\bg_\bi_\bd_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.149 , page 125) variable. Please make sure
- that you really know how local parts of these Message-ID: headers are composed.
+33. confirmcreate
- The Mutt Next Generation E-Mail Client 82
+ Type: boolean
- _\b6_\b._\b3_\b._\b2 _\bm_\ba_\bi_\bl_\bt_\bo_\b:_\b-_\bs_\bt_\by_\bl_\be _\bl_\bi_\bn_\bk_\bs
+ Default: yes
- As mutt-ng be can be set up to be the mail client to handle mailto: style links
- in websites, there're security considerations, too. To keep the old behavior by
- default, mutt-ng 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
- _\b$_\be_\bd_\bi_\bt_\b__\bh_\be_\ba_\bd_\be_\br_\bs (section 7.4.59 , page 103) variable is _\bu_\bn_\bs_\be_\bt, i.e. the user
- doesn't want to see header fields while editing the message.
+ When set, Mutt-ng will prompt for confirmation when saving messages to a mailbox which does not yet exist before creating it.
- For example, following a link like
+34. connect_timeout
- mailto:joe@host?Attach=~/.gnupg/secring.gpg
+ Type: number
- will send out the user's private gnupg keyring to joe@host if the user doesn't
- follow the information on screen carefully enough.
+ Default: 30
- When _\bu_\bn_\bs_\be_\bt_\bt_\bi_\bn_\bg the _\b$_\bs_\bt_\br_\bi_\bc_\bt_\b__\bm_\ba_\bi_\bl_\bt_\bo (section 7.4.326 , page 169) variable, mutt-
- ng will
+ Causes Mutt-ng to timeout a network connection (for IMAP or POP) after this many seconds if the connection is not able to be established. A negative value causes Mutt-ng to wait indefinitely for the connection to succeed.
- +\bo be less strict when interpreting these links by prepending a X-Mailto-
- string to all header fields embedded in such a link _\ba_\bn_\bd
+35. content_type
- +\bo turn on the _\b$_\be_\bd_\bi_\bt_\b__\bh_\be_\ba_\bd_\be_\br_\bs (section 7.4.59 , page 103) variable by force
- to let the user see all the headers (because they still may leak informa-
- tion.)
+ Type: string
- _\b6_\b._\b4 _\bE_\bx_\bt_\be_\br_\bn_\ba_\bl _\ba_\bp_\bp_\bl_\bi_\bc_\ba_\bt_\bi_\bo_\bn_\bs
+ Default: "text/plain"
- Mutt-ng in many places has to rely on external applications or for convenience
- supports mechanisms involving external applications.
+ Sets the default Content-Type: header field for the body of newly composed messages.
- _\b6_\b._\b4_\b._\b1 _\bm_\ba_\bi_\bl_\bc_\ba_\bp
+36. copy
- One of these is the mailcap mechanism as defined by RfC 1524. Mutt-ng can be
- set up to _\ba_\bu_\bt_\bo_\bm_\ba_\bt_\bi_\bc_\ba_\bl_\bl_\by execute any given utility as listed in one of the mail-
- cap files (see the _\b$_\bm_\ba_\bi_\bl_\bc_\ba_\bp_\b__\bp_\ba_\bt_\bh (section 7.4.122 , page 120) variable for
- details.)
+ Type: quadoption
- These utilities may have a variety of security vulnerabilities, including over-
- writing of arbitrary files, information leaks or other exploitable bugs. These
- vulnerabilities may go unnoticed by the user, especially when they are called
- automatically (and without interactive prompting) from the mailcap file(s).
- When using mutt-ng's autoview mechanism in combination with mailcap files,
- please be sure to...
+ Default: yes
- +\bo manually select trustworth applications with a reasonable calling sequence
+ This variable controls whether or not copies of your outgoing messages will be saved for later references. Also see ``$record'', ``$save_name'', ``$force_name'' and ``fcc-hook''.
- +\bo periodically check the contents of mailcap files, especially after soft-
- ware installations or upgrades
+37. crypt_autoencrypt
- The Mutt Next Generation E-Mail Client 83
-
- +\bo keep the software packages referenced in the mailcap file up to date
-
- +\bo leave the _\b$_\bm_\ba_\bi_\bl_\bc_\ba_\bp_\b__\bs_\ba_\bn_\bi_\bt_\bi_\bz_\be (section 7.4.123 , page 120) variable in its
- default state to restrict mailcap expandos to a safe set of characters
-
- _\b6_\b._\b4_\b._\b2 _\bO_\bt_\bh_\be_\br
-
- Besides the mailcap mechanism, mutt-ng uses a number of other external utili-
- ties for operation.
-
- The same security considerations apply for these as for tools involved via
- mailcap (for example, mutt-ng is vulnerable to Denial of Service Attacks with
- compressed folders support if the uncompressed mailbox is too large for the
- disk it is saved to.)
-
- As already noted, most of these problems are not built in but caused by wrong
- configuration, so please check your configuration.
-
- _\b7_\b. _\bR_\be_\bf_\be_\br_\be_\bn_\bc_\be
-
- _\b7_\b._\b1 _\bC_\bo_\bm_\bm_\ba_\bn_\bd _\bl_\bi_\bn_\be _\bo_\bp_\bt_\bi_\bo_\bn_\bs
-
- Running mutt with no arguments will make Mutt-ng attempt to read your spool
- mailbox. However, it is possible to read other mailboxes and to send messages
- from the command line as well.
-
- -A expand an alias
- -a attach a file to a message
- -b specify a blind carbon-copy (BCC) address
- -c specify a carbon-copy (Cc) address
- -e specify a config command to be run after initialization files are read
- -f specify a mailbox to load
- -F specify an alternate file to read initialization commands
- -h print help on command line options
- -H specify a draft file from which to read a header and body
- -i specify a file to include in a message composition
- -m specify a default mailbox type
- -n do not read the system Muttngrc
- -p recall a postponed message
- -Q query a configuration variable
- -R open mailbox in read-only mode
- -s specify a subject (enclose in quotes if it contains spaces)
- -t dump the value of all variables to stdout
- -T dump the value of all changed variables to stdout
- -v show version number and compile-time definitions
- -x simulate the mailx(1) compose mode
- -y show a menu containing the files specified by the mailboxes command
- -z exit immediately if there are no messages in the mailbox
- -Z open the first folder with new message,exit immediately if none
-
- To read messages in a mailbox
-
- The Mutt Next Generation E-Mail Client 84
+ Type: boolean
- mutt [ -nz ] [ -F _\bm_\bu_\bt_\bt_\br_\bc ] [ -m _\bt_\by_\bp_\be ] [ -f _\bm_\ba_\bi_\bl_\bb_\bo_\bx ]
+ Default: no
- To compose a new message
+ Setting this variable will cause Mutt-ng to always attempt to PGP encrypt outgoing messages. This is probably only useful in connection to the send-hook command. It can be overridden by use of the pgp-menu, when encryption is not required or signing is requested as well. If ``$smime_is_default'' is set, then OpenSSL is used instead to create S/MIME messages and settings can be overridden by use of the smime-menu. (Crypto only)
- mutt [ -n ] [ -F _\bm_\bu_\bt_\bt_\br_\bc ] [ -a _\bf_\bi_\bl_\be ] [ -c _\ba_\bd_\bd_\br_\be_\bs_\bs ] [ -i _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be ] [ -s _\bs_\bu_\bb_\b-
- _\bj_\be_\bc_\bt ] _\ba_\bd_\bd_\br_\be_\bs_\bs [ _\ba_\bd_\bd_\br_\be_\bs_\bs ... ]
+38. crypt_autopgp
- Mutt-ng also supports a ``batch'' mode to send prepared messages. Simply redi-
- rect input from the file you wish to send. For example,
+ Type: boolean
- mutt -s 'data set for run #2' professor@bigschool.edu < ~/run2.dat
+ Default: yes
- 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 contents of
- the file ``~/run2.dat''.
+ This variable controls whether or not Mutt-ng may automatically enable PGP encryption/signing for messages. See also ``$crypt_autoencrypt'', ``$crypt_replyencrypt'', ``$crypt_autosign'', ``$crypt_replysign'' and ``$smime_is_default''.
- _\b7_\b._\b2 _\bP_\ba_\bt_\bt_\be_\br_\bn_\bs
+39. crypt_autosign
- The Mutt Next Generation E-Mail Client 85
+ Type: boolean
- ~A all messages
- ~b EXPR messages which contain EXPR in the message body
- ~B EXPR messages which contain EXPR in the whole message
- ~c USER messages carbon-copied to USER
- ~C EXPR message is either to: or cc: EXPR
- ~D deleted messages
- ~d [MIN]-[MAX] messages with ``date-sent'' in a Date range
- ~E expired messages
- ~e EXPR message which contains EXPR in the ``Sender'' field
- ~F flagged messages
- ~f USER messages originating from USER
- ~g cryptographically signed messages
- ~G cryptographically encrypted messages
- ~H EXPR messages with a spam attribute matching EXPR
- ~h EXPR messages which contain EXPR in the message header
- ~k message contains PGP key material
- ~i ID message which match ID in the ``Message-ID'' field
- ~L EXPR message is either originated or received by EXPR
- ~l message is addressed to a known mailing list
- ~m [MIN]-[MAX] message in the range MIN to MAX *)
- ~M multipart messages
- ~n [MIN]-[MAX] messages with a score in the range MIN to MAX *)
- ~N new messages
- ~O old messages
- ~p message is addressed to you (consults alternates)
- ~P message is from you (consults alternates)
- ~Q messages which have been replied to
- ~R read messages
- ~r [MIN]-[MAX] messages with ``date-received'' in a Date range
- ~S superseded messages
- ~s SUBJECT messages having SUBJECT in the ``Subject'' field.
- ~T tagged messages
- ~t USER messages addressed to USER
- ~U unread messages
- ~v message is part of a collapsed thread.
- ~V cryptographically verified messages
- ~w EXPR messages which contain EXPR in the `Newsgroups' field
- (if compiled with NNTP support)
- ~x EXPR messages which contain EXPR in the `References' field
- ~y EXPR messages which contain EXPR in the `X-Label' field
- ~z [MIN]-[MAX] messages with a size in the range MIN to MAX *)
- ~= duplicated messages (see $duplicate_threads)
- ~$ unreferenced messages (requires threaded view)
- ~* ``From'' contains realname and (syntactically) valid
- address (excluded are addresses matching against
- alternates or any alias)
+ Default: no
- Where EXPR, USER, ID, and SUBJECT are _\br_\be_\bg_\bu_\bl_\ba_\br _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn_\bs (section 4.1 , page
- 49). 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 (\), which is normally used for quoting. If it is your
- intention to use a backslash in the regular expression, you will need to use
- two backslashes instead (\\).
+ Setting this variable will cause Mutt-ng to always attempt to cryptographically sign outgoing messages. This can be overridden by use of the pgp-menu, when signing is not required or encryption is requested as well. If ``$smime_is_default'' is set, then OpenSSL is used instead to create S/MIME messages and settings can be overridden by use of the smime-menu. (Crypto only)
- The Mutt Next Generation E-Mail Client 86
+40. crypt_autosmime
- *) The forms <[MAX], >[MIN], [MIN]- and -[MAX] are allowed, too.
+ Type: boolean
- _\b7_\b._\b3 _\bC_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn _\bC_\bo_\bm_\bm_\ba_\bn_\bd_\bs
+ Default: yes
- The following are the commands understood by mutt.
+ This variable controls whether or not Mutt-ng may automatically enable S/MIME encryption/signing for messages. See also ``$crypt_autoencrypt'', ``$crypt_replyencrypt'', ``$crypt_autosign'', ``$crypt_replysign'' and ``$smime_is_default''.
- +\bo _\ba_\bc_\bc_\bo_\bu_\bn_\bt_\b-_\bh_\bo_\bo_\bk (section 4.17 , page 67) _\bp_\ba_\bt_\bt_\be_\br_\bn _\bc_\bo_\bm_\bm_\ba_\bn_\bd
+41. crypt_replyencrypt
- +\bo _\ba_\bl_\bi_\ba_\bs (section 3.4 , page 26) _\bk_\be_\by _\ba_\bd_\bd_\br_\be_\bs_\bs [ , _\ba_\bd_\bd_\br_\be_\bs_\bs, ... ]
+ Type: boolean
- +\bo _\bu_\bn_\ba_\bl_\bi_\ba_\bs (section 3.4 , page 26) [ * | _\bk_\be_\by ... ]
+ Default: yes
- +\bo _\ba_\bl_\bt_\be_\br_\bn_\ba_\bt_\be_\bs (section 3.11 , page 34) _\br_\be_\bg_\be_\bx_\bp [ _\br_\be_\bg_\be_\bx_\bp ... ]
+ If set, automatically PGP or OpenSSL encrypt replies to messages which are encrypted. (Crypto only)
- +\bo _\bu_\bn_\ba_\bl_\bt_\be_\br_\bn_\ba_\bt_\be_\bs (section 3.11 , page 34) [ * | _\br_\be_\bg_\be_\bx_\bp ... ]
+42. crypt_replysign
- +\bo _\ba_\bl_\bt_\be_\br_\bn_\ba_\bt_\bi_\bv_\be_\b__\bo_\br_\bd_\be_\br (section 5.5 , page 80) _\bm_\bi_\bm_\be_\bt_\by_\bp_\be [ _\bm_\bi_\bm_\be_\bt_\by_\bp_\be ... ]
+ Type: boolean
- +\bo _\bu_\bn_\ba_\bl_\bt_\be_\br_\bn_\ba_\bt_\bi_\bv_\be_\b__\bo_\br_\bd_\be_\br (section 5.5 , page 80) _\bm_\bi_\bm_\be_\bt_\by_\bp_\be [ _\bm_\bi_\bm_\be_\bt_\by_\bp_\be ... ]
+ Default: no
- +\bo _\ba_\bp_\bp_\be_\bn_\bd_\b-_\bh_\bo_\bo_\bk (section 4.19.3 , page 70) _\br_\be_\bg_\be_\bx_\bp _\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ If set, automatically PGP or OpenSSL sign replies to messages which are signed.
- +\bo _\ba_\bu_\bt_\bo_\b__\bv_\bi_\be_\bw (section 5.4 , page 79) _\bm_\bi_\bm_\be_\bt_\by_\bp_\be [ _\bm_\bi_\bm_\be_\bt_\by_\bp_\be ... ]
+ Note: this does not work on messages that are encrypted and signed! (Crypto only)
- +\bo _\bu_\bn_\ba_\bu_\bt_\bo_\b__\bv_\bi_\be_\bw (section 5.4 , page 79) _\bm_\bi_\bm_\be_\bt_\by_\bp_\be [ _\bm_\bi_\bm_\be_\bt_\by_\bp_\be ... ]
+43. crypt_replysignencrypted
- +\bo _\bb_\bi_\bn_\bd (section 3.5 , page 27) _\bm_\ba_\bp _\bk_\be_\by _\bf_\bu_\bn_\bc_\bt_\bi_\bo_\bn
+ Type: boolean
- +\bo _\bc_\bh_\ba_\br_\bs_\be_\bt_\b-_\bh_\bo_\bo_\bk (section 3.6 , page 29) _\ba_\bl_\bi_\ba_\bs _\bc_\bh_\ba_\br_\bs_\be_\bt
+ Default: no
- +\bo _\bc_\bl_\bo_\bs_\be_\b-_\bh_\bo_\bo_\bk (section 4.19.2 , page 69) _\br_\be_\bg_\be_\bx_\bp _\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ If set, automatically PGP or OpenSSL sign replies to messages which are encrypted. This makes sense in combination with ``$crypt_replyencrypt'', because it allows you to sign all messages which are automatically encrypted. This works around the problem noted in ``$crypt_replysign'', that Mutt-ng is not able to find out whether an encrypted message is also signed. (Crypto only)
- +\bo _\bc_\bo_\bl_\bo_\br (section 3.9 , page 31) _\bo_\bb_\bj_\be_\bc_\bt _\bf_\bo_\br_\be_\bg_\br_\bo_\bu_\bn_\bd _\bb_\ba_\bc_\bk_\bg_\br_\bo_\bu_\bn_\bd [ _\br_\be_\bg_\be_\bx_\bp ]
+44. crypt_timestamp
- +\bo _\bu_\bn_\bc_\bo_\bl_\bo_\br (section 3.9 , page 31) _\bi_\bn_\bd_\be_\bx _\bp_\ba_\bt_\bt_\be_\br_\bn [ _\bp_\ba_\bt_\bt_\be_\br_\bn ... ]
+ Type: boolean
- +\bo _\be_\bx_\be_\bc (section 3.25 , page 42) _\bf_\bu_\bn_\bc_\bt_\bi_\bo_\bn [ _\bf_\bu_\bn_\bc_\bt_\bi_\bo_\bn ... ]
+ Default: yes
- +\bo _\bf_\bc_\bc_\b-_\bh_\bo_\bo_\bk (section 3.19 , page 39) _\bp_\ba_\bt_\bt_\be_\br_\bn _\bm_\ba_\bi_\bl_\bb_\bo_\bx
+ If set, Mutt-ng will include a time stamp in the lines surrounding PGP or S/MIME output, so spoofing such lines is more difficult. If you are using colors to mark these lines, and rely on these, you may unset this setting. (Crypto only)
- +\bo _\bf_\bc_\bc_\b-_\bs_\ba_\bv_\be_\b-_\bh_\bo_\bo_\bk (section 3.20 , page 40) _\bp_\ba_\bt_\bt_\be_\br_\bn _\bm_\ba_\bi_\bl_\bb_\bo_\bx
+45. crypt_use_gpgme
- +\bo _\bf_\bo_\bl_\bd_\be_\br_\b-_\bh_\bo_\bo_\bk (section 3.7 , page 29) _\bp_\ba_\bt_\bt_\be_\br_\bn _\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Type: boolean
- +\bo _\bh_\bd_\br_\b__\bo_\br_\bd_\be_\br (section 3.17 , page 39) _\bh_\be_\ba_\bd_\be_\br [ _\bh_\be_\ba_\bd_\be_\br ... ]
+ Default: no
- +\bo _\bu_\bn_\bh_\bd_\br_\b__\bo_\br_\bd_\be_\br (section 3.17 , page 39) _\bh_\be_\ba_\bd_\be_\br [ _\bh_\be_\ba_\bd_\be_\br ... ]
+ This variable controls the use the GPGME enabled crypto backends. If it is set and Mutt-ng was build with gpgme support, the gpgme code for S/MIME and PGP will be used instead of the classic code.
- +\bo _\bi_\bc_\bo_\bn_\bv_\b-_\bh_\bo_\bo_\bk (section 3.6 , page 29) _\bc_\bh_\ba_\br_\bs_\be_\bt _\bl_\bo_\bc_\ba_\bl_\b-_\bc_\bh_\ba_\br_\bs_\be_\bt
+ Note: You need to use this option in your .muttngrc configuration file as it won't have any effect when used interactively.
- +\bo _\bi_\bg_\bn_\bo_\br_\be (section 3.10 , page 33) _\bp_\ba_\bt_\bt_\be_\br_\bn [ _\bp_\ba_\bt_\bt_\be_\br_\bn ... ]
+46. crypt_verify_sig
- The Mutt Next Generation E-Mail Client 87
+ Type: quadoption
- +\bo _\bu_\bn_\bi_\bg_\bn_\bo_\br_\be (section 3.10 , page 33) _\bp_\ba_\bt_\bt_\be_\br_\bn [ _\bp_\ba_\bt_\bt_\be_\br_\bn ... ]
+ Default: yes
- +\bo _\bl_\bi_\bs_\bt_\bs (section 3.13 , page 36) _\br_\be_\bg_\be_\bx_\bp [ _\br_\be_\bg_\be_\bx_\bp ... ]
+ If ``yes'', always attempt to verify PGP or S/MIME signatures. If ``ask'', ask whether or not to verify the signature. If ``no'', never attempt to verify cryptographic signatures. (Crypto only)
- +\bo _\bu_\bn_\bl_\bi_\bs_\bt_\bs (section 3.13 , page 36) _\br_\be_\bg_\be_\bx_\bp [ _\br_\be_\bg_\be_\bx_\bp ... ]
+47. date_format
- +\bo _\bm_\ba_\bc_\br_\bo (section 3.8 , page 30) _\bm_\be_\bn_\bu _\bk_\be_\by _\bs_\be_\bq_\bu_\be_\bn_\bc_\be [ _\bd_\be_\bs_\bc_\br_\bi_\bp_\bt_\bi_\bo_\bn ]
+ Type: string
- +\bo _\bm_\ba_\bi_\bl_\bb_\bo_\bx_\be_\bs (section 3.15 , page 37) _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be [ _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be ... ]
+ Default: "!%a, %b %d, %Y at %I:%M:%S%p %Z"
- +\bo _\bm_\bb_\bo_\bx_\b-_\bh_\bo_\bo_\bk (section 3.14 , page 37) _\bp_\ba_\bt_\bt_\be_\br_\bn _\bm_\ba_\bi_\bl_\bb_\bo_\bx
+ This variable controls the format of the date printed by the ``%d'' sequence in ``$index_format''. This is passed to strftime(3) to process the date.
- +\bo _\bm_\be_\bs_\bs_\ba_\bg_\be_\b-_\bh_\bo_\bo_\bk (section 3.22 , page 41) _\bp_\ba_\bt_\bt_\be_\br_\bn _\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Unless the first character in the string is a bang (``!''), the month and week day names are expanded according to the locale specified in the variable ``$locale''. If the first character in the string is a bang, the bang is discarded, and the month and week day names in the rest of the string are expanded in the C locale (that is in US English).
- +\bo _\bm_\bi_\bm_\be_\b__\bl_\bo_\bo_\bk_\bu_\bp (section 5.6 , page 80) _\bm_\bi_\bm_\be_\bt_\by_\bp_\be [ _\bm_\bi_\bm_\be_\bt_\by_\bp_\be ... ]
+48. debug_level
- +\bo _\bu_\bn_\bm_\bi_\bm_\be_\b__\bl_\bo_\bo_\bk_\bu_\bp (section 5.6 , page 80) _\bm_\bi_\bm_\be_\bt_\by_\bp_\be [ _\bm_\bi_\bm_\be_\bt_\by_\bp_\be ... ]
+ Type: number
- +\bo _\bm_\bo_\bn_\bo (section 3.9 , page 31) _\bo_\bb_\bj_\be_\bc_\bt _\ba_\bt_\bt_\br_\bi_\bb_\bu_\bt_\be [ _\br_\be_\bg_\be_\bx_\bp ]
+ Default: 0
- +\bo _\bu_\bn_\bm_\bo_\bn_\bo (section 3.9 , page 31) _\bi_\bn_\bd_\be_\bx _\bp_\ba_\bt_\bt_\be_\br_\bn [ _\bp_\ba_\bt_\bt_\be_\br_\bn ... ]
+ Availability: debug
- +\bo _\bm_\by_\b__\bh_\bd_\br (section 3.16 , page 38) _\bs_\bt_\br_\bi_\bn_\bg
+ This variable specifies the current debug level and may be used to increase or decrease the verbosity level during runtime. It overrides the level given with the -d command line option.
- +\bo _\bu_\bn_\bm_\by_\b__\bh_\bd_\br (section 3.16 , page 38) _\bf_\bi_\be_\bl_\bd [ _\bf_\bi_\be_\bl_\bd ... ]
+ Currently, this number must be >= 0 and <= 5 and muttng must be started with -d to enable debugging at all; enabling at runtime is not possible.
- +\bo _\bo_\bp_\be_\bn_\b-_\bh_\bo_\bo_\bk (section 4.19.1 , page 69) _\br_\be_\bg_\be_\bx_\bp _\bc_\bo_\bm_\bm_\ba_\bn_\bd
+49. default_hook
- +\bo _\bc_\br_\by_\bp_\bt_\b-_\bh_\bo_\bo_\bk (section 3.23 , page 41) _\bp_\ba_\bt_\bt_\be_\br_\bn _\bk_\be_\by_\b-_\bi_\bd
+ Type: string
- +\bo _\bp_\bu_\bs_\bh (section 3.24 , page 41) _\bs_\bt_\br_\bi_\bn_\bg
+ Default: "˜f %s !˜P | (˜P ˜C %s)"
- +\bo _\br_\be_\bs_\be_\bt (section 3.28 , page 45) _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be [_\bv_\ba_\br_\bi_\ba_\bb_\bl_\be ... ]
+ This variable controls how send-hooks, message-hooks, save-hooks, and fcc-hooks will be interpreted if they are specified with only a simple regexp, instead of a matching pattern. The hooks are expanded when they are declared, so a hook will be interpreted according to the value of this variable at the time the hook is declared. The default value matches if the message is either from a user matching the regular expression given, or if it is from you (if the from address matches ``alternates'') and is to or cc'ed to a user matching the given regular expression.
- +\bo _\bs_\ba_\bv_\be_\b-_\bh_\bo_\bo_\bk (section 3.18 , page 39) _\br_\be_\bg_\be_\bx_\bp _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
+50. delete
- +\bo _\bs_\bc_\bo_\br_\be (section 3.26 , page 42) _\bp_\ba_\bt_\bt_\be_\br_\bn _\bv_\ba_\bl_\bu_\be
+ Type: quadoption
- +\bo _\bu_\bn_\bs_\bc_\bo_\br_\be (section 3.26 , page 42) _\bp_\ba_\bt_\bt_\be_\br_\bn [ _\bp_\ba_\bt_\bt_\be_\br_\bn ... ]
+ Default: ask-yes
- +\bo _\bs_\be_\bn_\bd_\b-_\bh_\bo_\bo_\bk (section 3.21 , page 40) _\br_\be_\bg_\be_\bx_\bp _\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Controls whether or not messages are really deleted when closing or synchronizing a mailbox. If set to yes, messages marked for deleting will automatically be purged without prompting. If set to no, messages marked for deletion will be kept in the mailbox.
- +\bo _\br_\be_\bp_\bl_\by_\b-_\bh_\bo_\bo_\bk (section , page ) _\br_\be_\bg_\be_\bx_\bp _\bc_\bo_\bm_\bm_\ba_\bn_\bd
+51. delete_space
- +\bo _\bs_\be_\bt (section 3.28 , page 45) [no|inv]_\bv_\ba_\br_\bi_\ba_\bb_\bl_\be[=_\bv_\ba_\bl_\bu_\be] [ _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be ... ]
+ Type: boolean
- +\bo _\bu_\bn_\bs_\be_\bt (section 3.28 , page 45) _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be [_\bv_\ba_\br_\bi_\ba_\bb_\bl_\be ... ]
+ Default: no
- +\bo _\bs_\bo_\bu_\br_\bc_\be (section 3.29 , page 46) _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
+ When sending messages with format=flowed by setting the $text_flowed variable, this variable specifies whether to also set the DelSp parameter to yes. If this is unset, no additional parameter will be send as a value of no already is the default behavior.
- +\bo _\bs_\bp_\ba_\bm (section 3.27 , page 43) _\bp_\ba_\bt_\bt_\be_\br_\bn _\bf_\bo_\br_\bm_\ba_\bt
+ Note: this variable only has an effect on outgoing messages (if $text_flowed is set) but not on incomming.
- +\bo _\bn_\bo_\bs_\bp_\ba_\bm (section 3.27 , page 43) _\bp_\ba_\bt_\bt_\be_\br_\bn
+52. delete_untag
- The Mutt Next Generation E-Mail Client 88
+ Type: boolean
- +\bo _\bs_\bu_\bb_\bs_\bc_\br_\bi_\bb_\be (section 3.13 , page 36) _\br_\be_\bg_\be_\bx_\bp [ _\br_\be_\bg_\be_\bx_\bp ... ]
+ Default: yes
- +\bo _\bu_\bn_\bs_\bu_\bb_\bs_\bc_\br_\bi_\bb_\be (section 3.13 , page 36) _\br_\be_\bg_\be_\bx_\bp [ _\br_\be_\bg_\be_\bx_\bp ... ]
+ If this option is set, Mutt-ng will untag messages when marking them for deletion. This applies when you either explicitly delete a message, or when you save it to another folder.
- +\bo _\bt_\bo_\bg_\bg_\bl_\be (section 3.28 , page 45) _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be [_\bv_\ba_\br_\bi_\ba_\bb_\bl_\be ... ]
+53. digest_collapse
- +\bo _\bu_\bn_\bh_\bo_\bo_\bk (section 3.30 , page 46) _\bh_\bo_\bo_\bk_\b-_\bt_\by_\bp_\be
+ Type: boolean
- _\b7_\b._\b4 _\bC_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be_\bs
+ Default: yes
- The following list contains all variables which, in the process of providing
- more consistency, have been renamed and are partially even removed already. The
- left column contains the old synonym variables, the right column the full/new
- name:
+ If this option is set, Mutt-ng's received-attachments menu will not show the subparts of individual messages in a multipart/digest. To see these subparts, press 'v' on that menu.
- The Mutt Next Generation E-Mail Client 89
+54. display_filter
- edit_hdrs edit_headers
- forw_decode forward_decode
- forw_format forward_format
- forw_quote forward_quote
- hdr_format index_format
- indent_str indent_string
- mime_fwd mime_forward
- msg_format message_format
- pgp_autosign crypt_autosign
- pgp_autoencrypt crypt_autoencrypt
- pgp_replyencrypt crypt_replyencrypt
- pgp_replysign crypt_replysign
- pgp_replysignencrypted crypt_replysignencrypted
- pgp_verify_sig crypt_verify_sig
- pgp_create_traditional pgp_autoinline
- pgp_auto_traditional pgp_replyinline
- forw_decrypt forward_decrypt
- smime_sign_as smime_default_key
- post_indent_str post_indent_string
- print_cmd print_command
- shorten_hierarchy sidebar_shorten_hierarchy
- ask_followup_to nntp_ask_followup_to
- ask_x_comment_to nntp_ask_x_comment_to
- catchup_newsgroup nntp_catchup
- followup_to_poster nntp_followup_to_poster
- group_index_format nntp_group_index_format
- inews nntp_inews
- mime_subject nntp_mime_subject
- news_cache_dir nntp_cache_dir
- news_server nntp_host
- newsrc nntp_newsrc
- nntp_poll nntp_mail_check
- pop_checkinterval pop_mail_check
- post_moderated nntp_post_moderated
- save_unsubscribed nntp_save_unsubscribed
- show_new_news nntp_show_new_news
- show_only_unread nntp_show_only_unread
- x_comment_to nntp_x_comment_to
- smtp_auth_username smtp_user
- smtp_auth_password smtp_pass
+ Type: path
- The contrib subdirectory contains a script named update-config.pl which eases
- migration.
+ Default: ""
- A complete list of current variables follows.
+ When set, specifies a command used to filter messages. When a message is viewed it is passed as standard input to $display_filter, and the filtered message is read from the standard output.
- _\b7_\b._\b4_\b._\b1 _\ba_\bb_\bo_\br_\bt_\b__\bn_\bo_\ba_\bt_\bt_\ba_\bc_\bh
+55. dotlock_program
- Type: quadoption
+ Type: path
- Default: no
+ Default: "$muttng_bindir/muttng_dotlock"
- This variable specifies whether to abort sending if no attachment was made but
+ Availability: Standalone and Dotlock
- The Mutt Next Generation E-Mail Client 90
+ Contains the path of the muttng_dotlock(1) binary to be used by Mutt-ng.
- the content references them, i.e. the content matches the regular expression
- given in _\b$_\ba_\bt_\bt_\ba_\bc_\bh_\b__\br_\be_\bm_\bi_\bn_\bd_\b__\br_\be_\bg_\be_\bx_\bp (section 7.4.15 , page 93). If a match was
- found and this variable is set to _\by_\be_\bs, message sending will be aborted but the
- mail will be send nevertheless if set to _\bn_\bo.
+56. dsn_notify
- This variable and _\b$_\ba_\bt_\bt_\ba_\bc_\bh_\b__\br_\be_\bm_\bi_\bn_\bd_\b__\br_\be_\bg_\be_\bx_\bp (section 7.4.15 , page 93) are
- intended to remind the user to attach files if the message's text references
- them.
+ Type: string
- See also the _\b$_\ba_\bt_\bt_\ba_\bc_\bh_\b__\br_\be_\bm_\bi_\bn_\bd_\b__\br_\be_\bg_\be_\bx_\bp (section 7.4.15 , page 93) variable.
+ Default: ""
- _\b7_\b._\b4_\b._\b2 _\ba_\bb_\bo_\br_\bt_\b__\bn_\bo_\bs_\bu_\bb_\bj_\be_\bc_\bt
+ Note: you should not enable this unless you are using Sendmail 8.8.x or greater or in connection with the SMTP support via libESMTP.
- Type: quadoption
+ This variable sets the request for when notification is returned. The string consists of a comma separated list (no spaces!) of one or more of the following: never, to never request notification, failure, to request notification on transmission failure, delay, to be notified of message delays, success, to be notified of successful transmission.
- Default: ask-yes
+ Example: set dsn_notify="failure,delay"
- If set to _\by_\be_\bs, when composing messages and no subject is given at the subject
- prompt, composition will be aborted. If set to _\bn_\bo, composing messages with no
- subject given at the subject prompt will never be aborted.
+57. dsn_return
- _\b7_\b._\b4_\b._\b3 _\ba_\bb_\bo_\br_\bt_\b__\bu_\bn_\bm_\bo_\bd_\bi_\bf_\bi_\be_\bd
+ Type: string
- Type: quadoption
+ Default: ""
- Default: yes
+ Note: you should not enable this unless you are using Sendmail 8.8.x or greater or in connection with the SMTP support via libESMTP.
- If set to _\by_\be_\bs, composition will automatically abort after editing the message
- body if no changes are made to the file (this check only happens after the
- _\bf_\bi_\br_\bs_\bt edit of the file). When set to _\bn_\bo, composition will never be aborted.
+ This variable controls how much of your message is returned in DSN messages. It may be set to either hdrs to return just the message header, or full to return the full message.
- _\b7_\b._\b4_\b._\b4 _\ba_\bg_\be_\bn_\bt_\b__\bs_\bt_\br_\bi_\bn_\bg
+ Example: set dsn_return=hdrs
- Type: boolean
+58. duplicate_threads
- Default: yes
+ Type: boolean
- When _\bs_\be_\bt, Mutt-ng will add a ``User-Agent:'' header to outgoing messages, indi-
- cating which version of Mutt-ng was used for composing them.
+ Default: yes
- _\b7_\b._\b4_\b._\b5 _\ba_\bl_\bi_\ba_\bs_\b__\bf_\bi_\bl_\be
+ This variable controls whether Mutt-ng, when sorting by threads, threads messages with the same Message-Id: header field together. If it is set, it will indicate that it thinks they are duplicates of each other with an equals sign in the thread diagram.
- Type: path
+59. edit_headers
- Default: '~/.muttngrc'
+ Type: boolean
- The default file in which to save aliases created by the ``_\bc_\br_\be_\ba_\bt_\be_\b-_\ba_\bl_\bi_\ba_\bs (sec-
- tion 2.5.4 , page 11)'' function.
+ Default: no
- N\bNo\bot\bte\be:\b: Mutt-ng will not automatically source this file; you must explicitly use
- the ``_\bs_\bo_\bu_\br_\bc_\be (section 3.29 , page 46)'' command for it to be executed.
+ This option allows you to edit the header of your outgoing messages along with the body of your message.
- _\b7_\b._\b4_\b._\b6 _\ba_\bl_\bi_\ba_\bs_\b__\bf_\bo_\br_\bm_\ba_\bt
+ Which empty header fields to show is controlled by the $editor_headers option.
- The Mutt Next Generation E-Mail Client 91
+60. editor
- Type: string
+ Type: path
- Default: '%4n %2f %t %-10a %r'
+ Default: ""
- Specifies the format of the data displayed for the ``alias'' menu. The follow-
- ing printf(3)-style sequences are available:
+ This variable specifies which editor is used by Mutt-ng. It defaults to the value of the $VISUAL, or $EDITOR, environment variable, or to the string "vi" if neither of those are set.
- %a
- alias name
+61. editor_headers
- %f
- flags - currently, a 'd' for an alias marked for deletion
+ Type: string
- %n
- index number
+ Default: "From: To: Cc: Bcc: Subject: Reply-To: Newsgroups: Followup-To: X-Comment-To:"
- %r
- address which alias expands to
+ If $edit_headers is set, this space-separated list specifies which non-empty header fields to edit in addition to user-defined headers.
- %t
- character which indicates if the alias is tagged for inclusion
+ Note: if $edit_headers had to be turned on by force because $strict_mailto is unset, this option has no effect.
- _\b7_\b._\b4_\b._\b7 _\ba_\bl_\bl_\bo_\bw_\b__\b8_\bb_\bi_\bt
+62. encode_from
- Type: boolean
+ Type: boolean
- Default: yes
+ Default: no
- Controls whether 8-bit data is converted to 7-bit using either quoted-printable
- or base64 encoding when sending mail.
+ When set, Mutt-ng will quoted-printable encode messages when they contain the string ``From '' (note the trailing space) in the beginning of a line. Useful to avoid the tampering certain mail delivery and transport agents tend to do with messages.
- _\b7_\b._\b4_\b._\b8 _\ba_\bl_\bl_\bo_\bw_\b__\ba_\bn_\bs_\bi
+ Note: as mutt-ng currently violates RfC3676 defining format=flowed, it's <em/strongly/ advised to set this option although discouraged by the standard. Alternatively, you must take care of space-stuffing <tt/From / lines (with a trailing space) yourself.
- Type: boolean
+63. entropy_file
- Default: no
+ Type: path
- Controls whether ANSI color codes in messages (and color tags in rich text mes-
- sages) are to be interpreted. Messages containing these codes are rare, but if
- this option is set, their text will be colored accordingly. Note that this may
- override your color choices, and even present a security problem, since a mes-
- sage could include a line like ``[-- PGP output follows ...' and give it the
- same color as your attachment color.
+ Default: ""
- _\b7_\b._\b4_\b._\b9 _\ba_\br_\br_\bo_\bw_\b__\bc_\bu_\br_\bs_\bo_\br
+ Availability: SSL
- Type: boolean
+ The file which includes random data that is used to initialize SSL library functions.
- Default: no
+64. envelope_from
- When _\bs_\be_\bt, an arrow (``->'') will be used to indicate the current entry in menus
- instead of highlighting the whole line. On slow network or modem links this
- will make response faster because there is less that has to be redrawn on the
- screen when moving to the next or previous entries in the menu.
+ Type: boolean
- The Mutt Next Generation E-Mail Client 92
+ Default: no
- _\b7_\b._\b4_\b._\b1_\b0 _\ba_\bs_\bc_\bi_\bi_\b__\bc_\bh_\ba_\br_\bs
+ When set, Mutt-ng will try to derive the message's envelope sender from the ``From:'' header field. Note that this information is passed to the sendmail command using the ``-f" command line switch, so don't set this option if you are using that switch in $sendmail yourself, or if the sendmail on your machine doesn't support that command line switch.
- Type: boolean
+65. escape
- Default: no
+ Type: string
- If _\bs_\be_\bt, Mutt-ng will use plain ASCII characters when displaying thread and
- attachment trees, instead of the default ACS characters.
+ Default: "˜"
- _\b7_\b._\b4_\b._\b1_\b1 _\ba_\bs_\bk_\bb_\bc_\bc
+ Escape character to use for functions in the builtin editor.
- Type: boolean
+66. fast_reply
- Default: no
+ Type: boolean
- If _\bs_\be_\bt, Mutt-ng will prompt you for blind-carbon-copy (Bcc) recipients before
- editing an outgoing message.
+ Default: no
- _\b7_\b._\b4_\b._\b1_\b2 _\ba_\bs_\bk_\bc_\bc
+ When set, the initial prompt for recipients and subject are skipped when replying to messages, and the initial prompt for subject is skipped when forwarding messages.
- Type: boolean
+ Note: this variable has no effect when the ``$autoedit'' variable is set.
- Default: no
+67. fcc_attach
- If _\bs_\be_\bt, Mutt-ng will prompt you for carbon-copy (Cc) recipients before editing
- the body of an outgoing message.
+ Type: boolean
- _\b7_\b._\b4_\b._\b1_\b3 _\ba_\bs_\bs_\bu_\bm_\be_\bd_\b__\bc_\bh_\ba_\br_\bs_\be_\bt
+ Default: yes
- Type: string
+ This variable controls whether or not attachments on outgoing messages are saved along with the main body of your message.
- Default: 'us-ascii'
+68. fcc_clear
- This variable is a colon-separated list of character encoding schemes for mes-
- sages without character encoding indication. Header field values and message
- body content without character encoding indication would be assumed that they
- are written in one of this list. By default, all the header fields and message
- body without any charset indication are assumed to be in us-ascii.
+ Type: boolean
- For example, Japanese users might prefer this:
+ Default: no
- set assumed_charset='iso-2022-jp:euc-jp:shift_jis:utf-8'
+ When this variable is set, FCCs will be stored unencrypted and unsigned, even when the actual message is encrypted and/or signed. (PGP only)
- However, only the first content is valid for the message body. This variable
- is valid only if _\b$_\bs_\bt_\br_\bi_\bc_\bt_\b__\bm_\bi_\bm_\be (section 7.4.327 , page 170) is unset.
+69. file_charset
- _\b7_\b._\b4_\b._\b1_\b4 _\ba_\bt_\bt_\ba_\bc_\bh_\b__\bf_\bo_\br_\bm_\ba_\bt
+ Type: string
- Type: string
+ Default: ""
- Default: '%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] '
+ This variable is a colon-separated list of character encoding schemes for text file attatchments. If unset, $charset value will be used instead. For example, the following configuration would work for Japanese text handling:
- This variable describes the format of the ``attachment'' menu. The following
- printf(3)-style sequences are understood:
+ set file_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
- The Mutt Next Generation E-Mail Client 93
+ Note: ``iso-2022-*'' must be put at the head of the value as shown above if included.
- %C
- charset
+70. folder
- %c
- requires charset conversion (n or c)
+ Type: path
- %D
- deleted flag
+ Default: "˜/Mail"
- %d
- description
+ Specifies the default location of your mailboxes. A ``+'' or ``='' at the beginning of a pathname will be expanded to the value of this variable. Note that if you change this variable from the default value you need to make sure that the assignment occurs before you use ``+'' or ``='' for any other variables since expansion takes place during the ``set'' command.
- %e
- MIME Content-Transfer-Encoding: header field
+71. folder_format
- %f
- filename
+ Type: string
- %I
- MIME Content-Disposition: header field (I=inline, A=attachment)
+ Default: "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f"
- %m
- major MIME type
+ This variable allows you to customize the file browser display to your personal taste. This string is similar to ``$index_format'', but has its own set of printf(3)-like sequences:
- %M
- MIME subtype
+ %C
+ current file number
- %n
- attachment number
+ %d
+ date/time folder was last modified
- %s
- size
+ %f
+ filename
- %t
- tagged flag
+ %F
+ file permissions
- %T
- graphic tree characters
+ %g
+ group name (or numeric gid, if missing)
- %u
- unlink (=to delete) flag
+ %l
+ number of hard links
- %>X
- right justify the rest of the string and pad with character 'X'
+ %N
+ N if folder has new mail, blank otherwise
- %|X
- pad to the end of the line with character 'X'
+ %s
+ size in bytes
- _\b7_\b._\b4_\b._\b1_\b5 _\ba_\bt_\bt_\ba_\bc_\bh_\b__\br_\be_\bm_\bi_\bn_\bd_\b__\br_\be_\bg_\be_\bx_\bp
+ %t
+ * if the file is tagged, blank otherwise
- Type: regular expression
+ %u
+ owner name (or numeric uid, if missing)
- Default: 'attach'
+ %>X
+ right justify the rest of the string and pad with character "X"
- The Mutt Next Generation E-Mail Client 94
+ %|X
+ pad to the end of the line with character "X"
- If this variable is non-empty, muttng will scan a message's contents before
- sending for this regular expression. If it is found, it will ask for what to do
- depending on the setting of _\b$_\ba_\bb_\bo_\br_\bt_\b__\bn_\bo_\ba_\bt_\bt_\ba_\bc_\bh (section 7.4.1 , page 89).
+72. followup_to
- This variable and _\b$_\ba_\bb_\bo_\br_\bt_\b__\bn_\bo_\ba_\bt_\bt_\ba_\bc_\bh (section 7.4.1 , page 89) are intended to
- remind the user to attach files if the message's text references them.
+ Type: boolean
- _\b7_\b._\b4_\b._\b1_\b6 _\ba_\bt_\bt_\ba_\bc_\bh_\b__\bs_\be_\bp
+ Default: yes
- Type: string
+ Controls whether or not the Mail-Followup-To: header field is generated when sending mail. When set, Mutt-ng will generate this field when you are replying to a known mailing list, specified with the ``subscribe'' or ``lists'' commands or detected by common mailing list headers.
- Default: '\n'
+ This field has two purposes. First, preventing you from receiving duplicate copies of replies to messages which you send to mailing lists. Second, ensuring that you do get a reply separately for any messages sent to known lists to which you are not subscribed. The header will contain only the list's address for subscribed lists, and both the list address and your own email address for unsubscribed lists. Without this header, a group reply to your message sent to a subscribed list will be sent to both the list and your address, resulting in two copies of the same email for you.
- The separator to add between attachments when operating (saving, printing, pip-
- ing, etc) on a list of tagged attachments.
+73. force_buffy_check
- _\b7_\b._\b4_\b._\b1_\b7 _\ba_\bt_\bt_\ba_\bc_\bh_\b__\bs_\bp_\bl_\bi_\bt
+ Type: boolean
- Type: boolean
+ Default: no
- Default: yes
+ When set, it causes Mutt-ng to check for new mail when the buffy-list command is invoked. When unset, buffy_list will just list all mailboxes which are already known to have new mail.
- If this variable is _\bu_\bn_\bs_\be_\bt, when operating (saving, printing, piping, etc) on a
- list of tagged attachments, Mutt-ng will concatenate the attachments and will
- operate on them as a single attachment. The ``_\b$_\ba_\bt_\bt_\ba_\bc_\bh_\b__\bs_\be_\bp (section 7.4.16 ,
- page 94)'' separator is added after each attachment. When _\bs_\be_\bt, Mutt-ng will
- operate on the attachments one by one.
+ Also see the following variables: ``$timeout'', ``$mail_check'' and ``$imap_mail_check''.
- _\b7_\b._\b4_\b._\b1_\b8 _\ba_\bt_\bt_\br_\bi_\bb_\bu_\bt_\bi_\bo_\bn
+74. force_name
- Type: string
+ Type: boolean
- Default: 'On %d, %n wrote:'
+ Default: no
- This is the string that will precede a message which has been included in a
- reply. For a full listing of defined printf(3)-like sequences see the section
- on ``_\b$_\bi_\bn_\bd_\be_\bx_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.116 , page 116)''.
+ This variable is similar to ``$save_name'', except that Mutt-ng will store a copy of your outgoing message by the username of the address you are sending to even if that mailbox does not exist.
- _\b7_\b._\b4_\b._\b1_\b9 _\ba_\bu_\bt_\bo_\b__\bt_\ba_\bg
+ Also see the ``$record'' variable.
- Type: boolean
+75. forward_decode
- Default: no
+ Type: boolean
- When _\bs_\be_\bt, functions in the _\bi_\bn_\bd_\be_\bx menu which affect a message will be applied to
- all tagged messages (if there are any). When unset, you must first use the
- ``tag-prefix'' function (default: ';') to make the next function apply to all
- tagged messages.
+ Default: yes
- _\b7_\b._\b4_\b._\b2_\b0 _\ba_\bu_\bt_\bo_\be_\bd_\bi_\bt
+ Controls the decoding of complex MIME messages into text/plain when forwarding a message. The message header is also RFC2047 decoded. This variable is only used, if ``$mime_forward'' is unset, otherwise ``$mime_forward_decode'' is used instead.
- Type: boolean
+76. forward_decrypt
- Default: no
+ Type: boolean
- The Mutt Next Generation E-Mail Client 95
+ Default: yes
- When _\bs_\be_\bt along with ``_\b$_\be_\bd_\bi_\bt_\b__\bh_\be_\ba_\bd_\be_\br_\bs (section 7.4.59 , page 103)'', Mutt-ng
- will skip the initial send-menu and allow you to immediately begin editing the
- body of your message. The send-menu may still be accessed once you have fin-
- ished editing the body of your message.
+ Controls the handling of encrypted messages when forwarding a message. When set, the outer layer of encryption is stripped off. This variable is only used if ``$mime_forward'' is set and ``$mime_forward_decode'' is unset. (PGP only)
- Also see ``_\b$_\bf_\ba_\bs_\bt_\b__\br_\be_\bp_\bl_\by (section 7.4.66 , page 105)''.
+77. forward_edit
- _\b7_\b._\b4_\b._\b2_\b1 _\bb_\be_\be_\bp
+ Type: quadoption
- Type: boolean
+ Default: yes
- Default: yes
+ This quadoption controls whether or not the user is automatically placed in the editor when forwarding messages. For those who always want to forward with no modification, use a setting of no.
- When this variable is _\bs_\be_\bt, Mutt-ng will beep when an error occurs.
+78. forward_format
- _\b7_\b._\b4_\b._\b2_\b2 _\bb_\be_\be_\bp_\b__\bn_\be_\bw
+ Type: string
- Type: boolean
+ Default: "[%a: %s]"
- Default: no
+ This variable controls the default subject when forwarding a message. It uses the same format sequences as the ``$index_format'' variable.
- When this variable is _\bs_\be_\bt, Mutt-ng will beep whenever it prints a message noti-
- fying you of new mail. This is independent of the setting of the ``_\b$_\bb_\be_\be_\bp (sec-
- tion 7.4.21 , page 95)'' variable.
+79. forward_quote
- _\b7_\b._\b4_\b._\b2_\b3 _\bb_\bo_\bu_\bn_\bc_\be
+ Type: boolean
- Type: quadoption
+ Default: no
- Default: ask-yes
+ When set forwarded messages included in the main body of the message (when ``$mime_forward'' is unset) will be quoted using ``$indent_string''.
- Controls whether you will be asked to confirm bouncing messages. If set to _\by_\be_\bs
- you don't get asked if you want to bounce a message. Setting this variable to
- _\bn_\bo is not generally useful, and thus not recommended, because you are unable to
- bounce messages.
+80. from
- _\b7_\b._\b4_\b._\b2_\b4 _\bb_\bo_\bu_\bn_\bc_\be_\b__\bd_\be_\bl_\bi_\bv_\be_\br_\be_\bd
+ Type: e-mail address
- Type: boolean
+ Default: ""
- Default: yes
+ This variable contains a default from address. It can be overridden using my_hdr (including from send-hooks) and ``$reverse_name''. This variable is ignored if ``$use_from'' is unset.
- When this variable is _\bs_\be_\bt, Mutt-ng will include Delivered-To: header fields
- when bouncing messages. Postfix users may wish to _\bu_\bn_\bs_\be_\bt this variable.
+ E.g. you can use send-hook Mutt-ng-devel@lists.berlios.de 'my_hdr From: Foo Bar <foo@bar.fb>' when replying to the mutt-ng developer's mailing list and Mutt-ng takes this email address.
- _\b7_\b._\b4_\b._\b2_\b5 _\bb_\br_\ba_\bi_\bl_\bl_\be_\b__\bf_\br_\bi_\be_\bn_\bd_\bl_\by
+ Defaults to the contents of the environment variable $EMAIL.
- Type: boolean
+81. gecos_mask
- Default: no
+ Type: regular expression
- When this variable is set, mutt will place the cursor at the beginning of the
- current line in menus, even when the arrow_cursor variable is unset, making it
- easier for blind persons using Braille displays to follow these menus. The
+ Default: "^[^,]*"
- The Mutt Next Generation E-Mail Client 96
+ A regular expression used by Mutt-ng to parse the GECOS field of a password entry when expanding the alias. By default the regular expression is set to ``^[^,]*'' which will return the string up to the first ``,'' encountered. If the GECOS field contains a string like "lastname, firstname" then you should do: set gecos_mask=".*".
- option is disabled by default because many visual terminals don't permit making
- the cursor invisible.
+ This can be useful if you see the following behavior: you address a e-mail to user ID stevef whose full name is Steve Franklin. If Mutt-ng expands stevef to ``Franklin'' stevef@foo.bar then you should set the gecos_mask to a regular expression that will match the whole name so Mutt-ng will expand ``Franklin'' to ``Franklin, Steve''.
- _\b7_\b._\b4_\b._\b2_\b6 _\bc_\be_\br_\bt_\bi_\bf_\bi_\bc_\ba_\bt_\be_\b__\bf_\bi_\bl_\be
+82. hdrs
- Type: path
+ Type: boolean
- Default: '~/.mutt_certificates'
+ Default: yes
- Availability: SSL or GNUTLS
+ When unset, the header fields normally added by the ``my_hdr'' command are not created. This variable must be unset before composing a new message or replying in order to take effect. If set, the user defined header fields are added to every new message.
- This variable specifies the file where the certificates you trust are saved.
- When an unknown certificate is encountered, you are asked if you accept it or
- not. If you accept it, the certificate can also be saved in this file and fur-
- ther connections are automatically accepted.
+83. header
- You can also manually add CA certificates in this file. Any server certificate
- that is signed with one of these CA certificates are also automatically
- accepted.
+ Type: boolean
- Example: set certificate_file=~/.muttng/certificates
+ Default: no
- _\b7_\b._\b4_\b._\b2_\b7 _\bc_\bh_\ba_\br_\bs_\be_\bt
+ When set, this variable causes Mutt-ng to include the header of the message you are replying to into the edit buffer. The ``$weed'' setting applies.
- Type: string
+84. header_cache
- Default: ''
+ Type: path
- Character set your terminal uses to display and enter textual data.
+ Default: ""
- _\b7_\b._\b4_\b._\b2_\b8 _\bc_\bh_\be_\bc_\bk_\b__\bn_\be_\bw
+ Availability: Header Cache
- Type: boolean
+ The $header_cache variable points to the header cache database.
- Default: yes
+ If $header_cache points to a directory it will contain a header cache database per folder. If $header_cache points to a file that file will be a single global header cache. By default it is unset so no header caching will be used.
- N\bNo\bot\bte\be:\b: this option only affects _\bm_\ba_\bi_\bl_\bd_\bi_\br and _\bM_\bH style mailboxes.
+85. header_cache_compress
- When _\bs_\be_\bt, Mutt-ng will check for new mail delivered while the mailbox is open.
- Especially with MH mailboxes, this operation can take quite some time since it
- involves scanning the directory and checking each file to see if it has already
- been looked at. If it's _\bu_\bn_\bs_\be_\bt, no check for new mail is performed while the
- mailbox is open.
+ Type: boolean
- _\b7_\b._\b4_\b._\b2_\b9 _\bc_\bo_\bl_\bl_\ba_\bp_\bs_\be_\b__\bu_\bn_\br_\be_\ba_\bd
+ Default: no
- Type: boolean
+ If enabled the header cache will be compressed. So only one fifth of the usual diskspace is used, but the uncompression can result in a slower open of the cached folder.
- Default: yes
+86. help
- When _\bu_\bn_\bs_\be_\bt, Mutt-ng will not collapse a thread if it contains any unread mes-
- sages.
+ Type: boolean
- The Mutt Next Generation E-Mail Client 97
+ Default: yes
- _\b7_\b._\b4_\b._\b3_\b0 _\bc_\bo_\bm_\bp_\bo_\bs_\be_\b__\bf_\bo_\br_\bm_\ba_\bt
+ When set, help lines describing the bindings for the major functions provided by each menu are displayed on the first line of the screen.
- Type: string
+ Note: The binding will not be displayed correctly if the function is bound to a sequence rather than a single keystroke. Also, the help line may not be updated if a binding is changed while Mutt-ng is running. Since this variable is primarily aimed at new users, neither of these should present a major problem.
- Default: '-- Mutt-ng: Compose [Approx. msg size: %l Atts: %a]%>-'
+87. hidden_host
- Controls the format of the status line displayed in the ``compose'' menu. This
- string is similar to ``_\b$_\bs_\bt_\ba_\bt_\bu_\bs_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.324 , page 167)'', but has
- its own set of printf(3)-like sequences:
+ Type: boolean
- %a
- total number of attachments
+ Default: no
- %h
- local hostname
+ When set, Mutt-ng will skip the host name part of ``$hostname'' variable when adding the domain part to addresses. This variable does not affect the generation of Message-ID: header fields, and it will not lead to the cut-off of first-level domains.
- %l
- approximate size (in bytes) of the current message
+88. hide_limited
- %v
- Mutt-ng version string
+ Type: boolean
- See the text describing the ``_\b$_\bs_\bt_\ba_\bt_\bu_\bs_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.324 , page 167)''
- option for more information on how to set ``_\b$_\bc_\bo_\bm_\bp_\bo_\bs_\be_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.30 ,
- page 97)''.
+ Default: no
- _\b7_\b._\b4_\b._\b3_\b1 _\bc_\bo_\bn_\bf_\bi_\bg_\b__\bc_\bh_\ba_\br_\bs_\be_\bt
+ When set, Mutt-ng will not show the presence of messages that are hidden by limiting, in the thread tree.
- Type: string
+89. hide_missing
- Default: ''
+ Type: boolean
- When defined, Mutt-ng will recode commands in rc files from this encoding.
+ Default: yes
- _\b7_\b._\b4_\b._\b3_\b2 _\bc_\bo_\bn_\bf_\bi_\br_\bm_\ba_\bp_\bp_\be_\bn_\bd
+ When set, Mutt-ng will not show the presence of missing messages in the thread tree.
- Type: boolean
+90. hide_thread_subject
- Default: yes
+ Type: boolean
- When _\bs_\be_\bt, Mutt-ng will prompt for confirmation when appending messages to an
- existing mailbox.
+ Default: yes
- _\b7_\b._\b4_\b._\b3_\b3 _\bc_\bo_\bn_\bf_\bi_\br_\bm_\bc_\br_\be_\ba_\bt_\be
+ When set, Mutt-ng will not show the subject of messages in the thread tree that have the same subject as their parent or closest previously displayed sibling.
- Type: boolean
+91. hide_top_limited
- Default: yes
+ Type: boolean
- When _\bs_\be_\bt, Mutt-ng will prompt for confirmation when saving messages to a mail-
- box which does not yet exist before creating it.
+ Default: no
- _\b7_\b._\b4_\b._\b3_\b4 _\bc_\bo_\bn_\bn_\be_\bc_\bt_\b__\bt_\bi_\bm_\be_\bo_\bu_\bt
+ When set, Mutt-ng will not show the presence of messages that are hidden by limiting, at the top of threads in the thread tree. Note that when $hide_missing is set, this option will have no effect.
- The Mutt Next Generation E-Mail Client 98
+92. hide_top_missing
- Type: number
+ Type: boolean
- Default: 30
+ Default: yes
- Causes Mutt-ng to timeout a network connection (for IMAP or POP) after this
- many seconds if the connection is not able to be established. A negative value
- causes Mutt-ng to wait indefinitely for the connection to succeed.
+ When set, Mutt-ng will not show the presence of missing messages at the top of threads in the thread tree. Note that when $hide_limited is set, this option will have no effect.
- _\b7_\b._\b4_\b._\b3_\b5 _\bc_\bo_\bn_\bt_\be_\bn_\bt_\b__\bt_\by_\bp_\be
+93. history
- Type: string
+ Type: number
- Default: 'text/plain'
+ Default: 10
- Sets the default Content-Type: header field for the body of newly composed mes-
- sages.
+ This variable controls the size (in number of strings remembered) of the string history buffer. The buffer is cleared each time the variable is changed.
- _\b7_\b._\b4_\b._\b3_\b6 _\bc_\bo_\bp_\by
+94. honor_followup_to
- Type: quadoption
+ Type: quadoption
- Default: yes
+ Default: yes
- This variable controls whether or not copies of your outgoing messages will be
- saved for later references. Also see ``_\b$_\br_\be_\bc_\bo_\br_\bd (section 7.4.246 , page
- 148)'', ``_\b$_\bs_\ba_\bv_\be_\b__\bn_\ba_\bm_\be (section 7.4.257 , page 151)'', ``_\b$_\bf_\bo_\br_\bc_\be_\b__\bn_\ba_\bm_\be (section
- 7.4.74 , page 107)'' and ``_\bf_\bc_\bc_\b-_\bh_\bo_\bo_\bk (section 3.19 , page 39)''.
+ This variable controls whether or not a Mail-Followup-To: header field is honored when group-replying to a message.
- _\b7_\b._\b4_\b._\b3_\b7 _\bc_\br_\by_\bp_\bt_\b__\ba_\bu_\bt_\bo_\be_\bn_\bc_\br_\by_\bp_\bt
+95. hostname
- Type: boolean
+ Type: string
- Default: no
+ Default: ""
- Setting this variable will cause Mutt-ng to always attempt to PGP encrypt out-
- going messages. This is probably only useful in connection to the _\bs_\be_\bn_\bd_\b-_\bh_\bo_\bo_\bk
- command. It can be overridden by use of the _\bp_\bg_\bp_\b-_\bm_\be_\bn_\bu, when encryption is not
- required or signing is requested as well. If ``_\b$_\bs_\bm_\bi_\bm_\be_\b__\bi_\bs_\b__\bd_\be_\bf_\ba_\bu_\bl_\bt (section
- 7.4.293 , page 159)'' is _\bs_\be_\bt, then OpenSSL is used instead to create S/MIME
- messages and settings can be overridden by use of the _\bs_\bm_\bi_\bm_\be_\b-_\bm_\be_\bn_\bu. (Crypto
- only)
+ Specifies the hostname to use after the ``@'' in local e-mail addresses and during generation of Message-Id: headers.
- _\b7_\b._\b4_\b._\b3_\b8 _\bc_\br_\by_\bp_\bt_\b__\ba_\bu_\bt_\bo_\bp_\bg_\bp
+ Please be sure to really know what you are doing when changing this variable to configure a custom domain part of Message-IDs.
- Type: boolean
+96. ignore_list_reply_to
- Default: yes
+ Type: boolean
- This variable controls whether or not Mutt-ng may automatically enable PGP
- encryption/signing for messages. See also ``_\b$_\bc_\br_\by_\bp_\bt_\b__\ba_\bu_\bt_\bo_\be_\bn_\bc_\br_\by_\bp_\bt (section
- 7.4.37 , page 98)'', ``_\b$_\bc_\br_\by_\bp_\bt_\b__\br_\be_\bp_\bl_\by_\be_\bn_\bc_\br_\by_\bp_\bt (section 7.4.41 , page 99)'',
- ``_\b$_\bc_\br_\by_\bp_\bt_\b__\ba_\bu_\bt_\bo_\bs_\bi_\bg_\bn (section 7.4.39 , page 98)'', ``_\b$_\bc_\br_\by_\bp_\bt_\b__\br_\be_\bp_\bl_\by_\bs_\bi_\bg_\bn (section
- 7.4.42 , page 99)'' and ``_\b$_\bs_\bm_\bi_\bm_\be_\b__\bi_\bs_\b__\bd_\be_\bf_\ba_\bu_\bl_\bt (section 7.4.293 , page 159)''.
+ Default: no
- The Mutt Next Generation E-Mail Client 99
+ Affects the behaviour of the reply function when replying to messages from mailing lists. When set, if the ``Reply-To:'' header field is set to the same value as the ``To:'' header field, Mutt-ng assumes that the ``Reply-To:'' header field was set by the mailing list to automate responses to the list, and will ignore this field. To direct a response to the mailing list when this option is set, use the list-reply function; group-reply will reply to both the sender and the list.
- _\b7_\b._\b4_\b._\b3_\b9 _\bc_\br_\by_\bp_\bt_\b__\ba_\bu_\bt_\bo_\bs_\bi_\bg_\bn
+97. imap_authenticators
- Type: boolean
+ Type: string
- Default: no
+ Default: ""
- Setting this variable will cause Mutt-ng to always attempt to cryptographically
- sign outgoing messages. This can be overridden by use of the _\bp_\bg_\bp_\b-_\bm_\be_\bn_\bu, when
- signing is not required or encryption is requested as well. If
- ``_\b$_\bs_\bm_\bi_\bm_\be_\b__\bi_\bs_\b__\bd_\be_\bf_\ba_\bu_\bl_\bt (section 7.4.293 , page 159)'' is _\bs_\be_\bt, then OpenSSL is
- used instead to create S/MIME messages and settings can be overridden by use of
- the _\bs_\bm_\bi_\bm_\be_\b-_\bm_\be_\bn_\bu. (Crypto only)
+ Availability: IMAP
- _\b7_\b._\b4_\b._\b4_\b0 _\bc_\br_\by_\bp_\bt_\b__\ba_\bu_\bt_\bo_\bs_\bm_\bi_\bm_\be
+ This is a colon-delimited list of authentication methods Mutt-ng may attempt to use to log in to an IMAP server, in the order Mutt-ng should try them. Authentication methods are either ``login'' or the right side of an IMAP ``AUTH='' capability string, e.g. ``digest-md5'', ``gssapi'' or ``cram-md5''. This parameter is case-insensitive.
- Type: boolean
+ If this parameter is unset (the default) Mutt-ng will try all available methods, in order from most-secure to least-secure.
- Default: yes
+ Example: set imap_authenticators="gssapi:cram-md5:login"
- This variable controls whether or not Mutt-ng may automatically enable S/MIME
- encryption/signing for messages. See also ``_\b$_\bc_\br_\by_\bp_\bt_\b__\ba_\bu_\bt_\bo_\be_\bn_\bc_\br_\by_\bp_\bt (section
- 7.4.37 , page 98)'', ``_\b$_\bc_\br_\by_\bp_\bt_\b__\br_\be_\bp_\bl_\by_\be_\bn_\bc_\br_\by_\bp_\bt (section 7.4.41 , page 99)'',
- ``_\b$_\bc_\br_\by_\bp_\bt_\b__\ba_\bu_\bt_\bo_\bs_\bi_\bg_\bn (section 7.4.39 , page 98)'', ``_\b$_\bc_\br_\by_\bp_\bt_\b__\br_\be_\bp_\bl_\by_\bs_\bi_\bg_\bn (section
- 7.4.42 , page 99)'' and ``_\b$_\bs_\bm_\bi_\bm_\be_\b__\bi_\bs_\b__\bd_\be_\bf_\ba_\bu_\bl_\bt (section 7.4.293 , page 159)''.
+ Note: Mutt-ng will only fall back to other authentication methods if the previous methods are unavailable. If a method is available but authentication fails, Mutt-ng will not connect to the IMAP server.
- _\b7_\b._\b4_\b._\b4_\b1 _\bc_\br_\by_\bp_\bt_\b__\br_\be_\bp_\bl_\by_\be_\bn_\bc_\br_\by_\bp_\bt
+98. imap_check_subscribed
- Type: boolean
+ Type: boolean
- Default: yes
+ Default: no
- If _\bs_\be_\bt, automatically PGP or OpenSSL encrypt replies to messages which are
- encrypted. (Crypto only)
+ When set, mutt will fetch the set of subscribed folders from your server on connection, and add them to the set of mailboxes it polls for new mail. See also the ``mailboxes'' command.
- _\b7_\b._\b4_\b._\b4_\b2 _\bc_\br_\by_\bp_\bt_\b__\br_\be_\bp_\bl_\by_\bs_\bi_\bg_\bn
+99. imap_delim_chars
- Type: boolean
+ Type: string
- Default: no
+ Default: "/."
- If _\bs_\be_\bt, automatically PGP or OpenSSL sign replies to messages which are signed.
+ Availability: IMAP
- N\bNo\bot\bte\be:\b: this does not work on messages that are encrypted a\ban\bnd\bd signed! (Crypto
- only)
+ This contains the list of characters which you would like to treat as folder separators for displaying IMAP paths. In particular it helps in using the '=' shortcut for your $folder variable.
- _\b7_\b._\b4_\b._\b4_\b3 _\bc_\br_\by_\bp_\bt_\b__\br_\be_\bp_\bl_\by_\bs_\bi_\bg_\bn_\be_\bn_\bc_\br_\by_\bp_\bt_\be_\bd
+100. imap_headers
- Type: boolean
+ Type: string
- Default: no
+ Default: ""
- If _\bs_\be_\bt, automatically PGP or OpenSSL sign replies to messages which are
- encrypted. This makes sense in combination with ``_\b$_\bc_\br_\by_\bp_\bt_\b__\br_\be_\bp_\bl_\by_\be_\bn_\bc_\br_\by_\bp_\bt (section
- 7.4.41 , page 99)'', because it allows you to sign all messages which are
+ Availability: IMAP
- The Mutt Next Generation E-Mail Client 100
+ Mutt-ng requests these header fields in addition to the default headers (``DATE FROM SUBJECT TO CC MESSAGE-ID REFERENCES CONTENT-TYPE CONTENT-DESCRIPTION IN-REPLY-TO REPLY-TO LINES X-LABEL'') from IMAP servers before displaying the ``index'' menu. You may want to add more headers for spam detection.
- automatically encrypted. This works around the problem noted in
- ``_\b$_\bc_\br_\by_\bp_\bt_\b__\br_\be_\bp_\bl_\by_\bs_\bi_\bg_\bn (section 7.4.42 , page 99)'', that Mutt-ng is not able to
- find out whether an encrypted message is also signed. (Crypto only)
+ Note: This is a space separated list.
- _\b7_\b._\b4_\b._\b4_\b4 _\bc_\br_\by_\bp_\bt_\b__\bt_\bi_\bm_\be_\bs_\bt_\ba_\bm_\bp
+101. imap_home_namespace
- Type: boolean
+ Type: string
- Default: yes
+ Default: ""
- If _\bs_\be_\bt, Mutt-ng will include a time stamp in the lines surrounding PGP or
- S/MIME output, so spoofing such lines is more difficult. If you are using col-
- ors to mark these lines, and rely on these, you may _\bu_\bn_\bs_\be_\bt this setting.
- (Crypto only)
+ Availability: IMAP
- _\b7_\b._\b4_\b._\b4_\b5 _\bc_\br_\by_\bp_\bt_\b__\bu_\bs_\be_\b__\bg_\bp_\bg_\bm_\be
+ You normally want to see your personal folders alongside your INBOX in the IMAP browser. If you see something else, you may set this variable to the IMAP path to your folders.
- Type: boolean
+102. imap_keepalive
- Default: no
+ Type: number
- This variable controls the use the GPGME enabled crypto backends. If it is _\bs_\be_\bt
- and Mutt-ng was build with gpgme support, the gpgme code for S/MIME and PGP
- will be used instead of the classic code.
+ Default: 900
- N\bNo\bot\bte\be: You need to use this option in your .muttngrc configuration file as it
- won't have any effect when used interactively.
+ Availability: IMAP
- _\b7_\b._\b4_\b._\b4_\b6 _\bc_\br_\by_\bp_\bt_\b__\bv_\be_\br_\bi_\bf_\by_\b__\bs_\bi_\bg
+ This variable specifies the maximum amount of time in seconds that Mutt-ng will wait before polling open IMAP connections, to prevent the server from closing them before Mutt-ng has finished with them.
- Type: quadoption
+ The default is well within the RFC-specified minimum amount of time (30 minutes) before a server is allowed to do this, but in practice the RFC does get violated every now and then.
- Default: yes
+ Reduce this number if you find yourself getting disconnected from your IMAP server due to inactivity.
- If ``_\by_\be_\bs'', always attempt to verify PGP or S/MIME signatures. If ``_\ba_\bs_\bk'', ask
- whether or not to verify the signature. If ``_\bn_\bo'', never attempt to verify
- cryptographic signatures. (Crypto only)
+103. imap_list_subscribed
- _\b7_\b._\b4_\b._\b4_\b7 _\bd_\ba_\bt_\be_\b__\bf_\bo_\br_\bm_\ba_\bt
+ Type: boolean
- Type: string
+ Default: no
- Default: '!%a, %b %d, %Y at %I:%M:%S%p %Z'
+ Availability: IMAP
- This variable controls the format of the date printed by the ``%d'' sequence in
- ``_\b$_\bi_\bn_\bd_\be_\bx_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.116 , page 116)''. This is passed to strftime(3)
- to process the date.
+ This variable configures whether IMAP folder browsing will look for only subscribed folders or all folders. This can be toggled in the IMAP browser with the toggle-subscribed function.
- Unless the first character in the string is a bang (``!''), the month and week
- day names are expanded according to the locale specified in the variable
- ``_\b$_\bl_\bo_\bc_\ba_\bl_\be (section 7.4.120 , page 120)''. If the first character in the string
- is a bang, the bang is discarded, and the month and week day names in the rest
- of the string are expanded in the _\bC locale (that is in US English).
+104. imap_login
- The Mutt Next Generation E-Mail Client 101
+ Type: string
- _\b7_\b._\b4_\b._\b4_\b8 _\bd_\be_\bb_\bu_\bg_\b__\bl_\be_\bv_\be_\bl
+ Default: ""
- Type: number
+ Availability: IMAP
- Default: 0
+ Your login name on the IMAP server.
- Availability: debug
+ This variable defaults to the value of ``$imap_user.''
- This variable specifies the current debug level and may be used to increase or
- decrease the verbosity level during runtime. It overrides the level given with
- the -d command line option.
+105. imap_mail_check
- Currently, this number must be >= 0 and <= 5 and muttng must be started with -d
- to enable debugging at all; enabling at runtime is not possible.
+ Type: number
- _\b7_\b._\b4_\b._\b4_\b9 _\bd_\be_\bf_\ba_\bu_\bl_\bt_\b__\bh_\bo_\bo_\bk
+ Default: 300
- Type: string
+ This variable configures how often (in seconds) Mutt-ng should look for new mail in IMAP folders. This is split from the ``mail_check'' variable to generate less traffic and get more accurate information for local folders.
- Default: '~f %s !~P | (~P ~C %s)'
+106. imap_pass
- This variable controls how send-hooks, message-hooks, save-hooks, and fcc-hooks
- will be interpreted if they are specified with only a simple regexp, instead of
- a matching pattern. The hooks are expanded when they are declared, so a hook
- will be interpreted according to the value of this variable at the time the
- hook is declared. The default value matches if the message is either from a
- user matching the regular expression given, or if it is from you (if the from
- address matches ``alternates'') and is to or cc'ed to a user matching the given
- regular expression.
+ Type: string
- _\b7_\b._\b4_\b._\b5_\b0 _\bd_\be_\bl_\be_\bt_\be
+ Default: ""
- Type: quadoption
+ Availability: IMAP
- Default: ask-yes
+ Specifies the password for your IMAP account. If unset, Mutt-ng will prompt you for your password when you invoke the fetch-mail function.
- Controls whether or not messages are really deleted when closing or synchroniz-
- ing a mailbox. If set to _\by_\be_\bs, messages marked for deleting will automatically
- be purged without prompting. If set to _\bn_\bo, messages marked for deletion will
- be kept in the mailbox.
+ Warning: you should only use this option when you are on a fairly secure machine, because the superuser can read your configuration even if you are the only one who can read the file.
- _\b7_\b._\b4_\b._\b5_\b1 _\bd_\be_\bl_\be_\bt_\be_\b__\bs_\bp_\ba_\bc_\be
+107. imap_passive
- Type: boolean
+ Type: boolean
- Default: no
+ Default: yes
- When sending messages with format=flowed by _\bs_\be_\bt_\bt_\bi_\bn_\bg the _\b$_\bt_\be_\bx_\bt_\b__\bf_\bl_\bo_\bw_\be_\bd (section
- 7.4.333 , page 171) variable, this variable specifies whether to also set the
- DelSp parameter to yes. If this is _\bu_\bn_\bs_\be_\bt, no additional parameter will be send
- as a value of no already is the default behavior.
+ Availability: IMAP
- N\bNo\bot\bte\be:\b: this variable only has an effect on _\bo_\bu_\bt_\bg_\bo_\bi_\bn_\bg messages (if _\b$_\bt_\be_\bx_\bt_\b__\bf_\bl_\bo_\bw_\be_\bd
- (section 7.4.333 , page 171) is _\bs_\be_\bt) but not on incomming.
+ When set, Mutt-ng will not open new IMAP connections to check for new mail. Mutt-ng will only check for new mail over existing IMAP connections. This is useful if you don't want to be prompted to user/password pairs on Mutt-ng invocation, or if opening the connection is slow.
- The Mutt Next Generation E-Mail Client 102
+108. imap_peek
- _\b7_\b._\b4_\b._\b5_\b2 _\bd_\be_\bl_\be_\bt_\be_\b__\bu_\bn_\bt_\ba_\bg
+ Type: boolean
- Type: boolean
+ Default: yes
- Default: yes
+ Availability: IMAP
- If this option is _\bs_\be_\bt, Mutt-ng will untag messages when marking them for dele-
- tion. This applies when you either explicitly delete a message, or when you
- save it to another folder.
+ If set, Mutt-ng will avoid implicitly marking your mail as read whenever you fetch a message from the server. This is generally a good thing, but can make closing an IMAP folder somewhat slower. This option exists to appease speed freaks.
- _\b7_\b._\b4_\b._\b5_\b3 _\bd_\bi_\bg_\be_\bs_\bt_\b__\bc_\bo_\bl_\bl_\ba_\bp_\bs_\be
+109. imap_reconnect
- Type: boolean
+ Type: quadoption
- Default: yes
+ Default: ask-yes
- If this option is _\bs_\be_\bt, Mutt-ng's received-attachments menu will not show the
- subparts of individual messages in a multipart/digest. To see these subparts,
- press 'v' on that menu.
+ Availability: IMAP
- _\b7_\b._\b4_\b._\b5_\b4 _\bd_\bi_\bs_\bp_\bl_\ba_\by_\b__\bf_\bi_\bl_\bt_\be_\br
+ Controls whether or not Mutt-ng will try to reconnect to IMAP server when the connection is lost.
- Type: path
+110. imap_servernoise
- Default: ''
+ Type: boolean
- When _\bs_\be_\bt, specifies a command used to filter messages. When a message is
- viewed it is passed as standard input to _\b$_\bd_\bi_\bs_\bp_\bl_\ba_\by_\b__\bf_\bi_\bl_\bt_\be_\br (section 7.4.54 ,
- page 102), and the filtered message is read from the standard output.
+ Default: yes
- _\b7_\b._\b4_\b._\b5_\b5 _\bd_\bo_\bt_\bl_\bo_\bc_\bk_\b__\bp_\br_\bo_\bg_\br_\ba_\bm
+ Availability: IMAP
- Type: path
+ When set, Mutt-ng will display warning messages from the IMAP server as error messages. Since these messages are often harmless, or generated due to configuration problems on the server which are out of the users' hands, you may wish to suppress them at some point.
- Default: '$muttng_bindir/muttng_dotlock'
+111. imap_user
- Availability: Standalone and Dotlock
+ Type: string
- Contains the path of the muttng_dotlock(1) binary to be used by Mutt-ng.
+ Default: ""
- _\b7_\b._\b4_\b._\b5_\b6 _\bd_\bs_\bn_\b__\bn_\bo_\bt_\bi_\bf_\by
+ Availability: IMAP
- Type: string
+ The name of the user whose mail you intend to access on the IMAP server.
- Default: ''
+ This variable defaults to your user name on the local machine.
- N\bNo\bot\bte\be:\b: you should not enable this unless you are using Sendmail 8.8.x or greater
- or in connection with the SMTP support via libESMTP.
+112. implicit_autoview
- This variable sets the request for when notification is returned. The string
- consists of a comma separated list (no spaces!) of one or more of the follow-
- ing: _\bn_\be_\bv_\be_\br, to never request notification, _\bf_\ba_\bi_\bl_\bu_\br_\be, to request notification on
- transmission failure, _\bd_\be_\bl_\ba_\by, to be notified of message delays, _\bs_\bu_\bc_\bc_\be_\bs_\bs, to be
- notified of successful transmission.
+ Type: boolean
- The Mutt Next Generation E-Mail Client 103
+ Default: no
- Example: set dsn_notify='failure,delay'
+ If set, Mutt-ng will look for a mailcap entry with the ``copiousoutput'' flag set for every MIME attachment it doesn't have an internal viewer defined for. If such an entry is found, Mutt-ng will use the viewer defined in that entry to convert the body part to text form.
- _\b7_\b._\b4_\b._\b5_\b7 _\bd_\bs_\bn_\b__\br_\be_\bt_\bu_\br_\bn
+113. include
- Type: string
+ Type: quadoption
- Default: ''
+ Default: ask-yes
- N\bNo\bot\bte\be:\b: you should not enable this unless you are using Sendmail 8.8.x or greater
- or in connection with the SMTP support via libESMTP.
+ Controls whether or not a copy of the message(s) you are replying to is included in your reply.
- This variable controls how much of your message is returned in DSN messages.
- It may be set to either _\bh_\bd_\br_\bs to return just the message header, or _\bf_\bu_\bl_\bl to
- return the full message.
+114. include_onlyfirst
- Example: set dsn_return=hdrs
+ Type: boolean
- _\b7_\b._\b4_\b._\b5_\b8 _\bd_\bu_\bp_\bl_\bi_\bc_\ba_\bt_\be_\b__\bt_\bh_\br_\be_\ba_\bd_\bs
+ Default: no
- Type: boolean
+ Controls whether or not Mutt-ng includes only the first attachment of the message you are replying.
- Default: yes
+115. indent_string
- This variable controls whether Mutt-ng, when sorting by threads, threads mes-
- sages with the same Message-Id: header field together. If it is _\bs_\be_\bt, it will
- indicate that it thinks they are duplicates of each other with an equals sign
- in the thread diagram.
+ Type: string
- _\b7_\b._\b4_\b._\b5_\b9 _\be_\bd_\bi_\bt_\b__\bh_\be_\ba_\bd_\be_\br_\bs
+ Default: "> "
- Type: boolean
+ Specifies the string to prepend to each line of text quoted in a message to which you are replying. You are strongly encouraged not to change this value, as it tends to agitate the more fanatical netizens.
- Default: no
+116. index_format
- This option allows you to edit the header of your outgoing messages along with
- the body of your message.
+ Type: string
- Which empty header fields to show is controlled by the _\b$_\be_\bd_\bi_\bt_\bo_\br_\b__\bh_\be_\ba_\bd_\be_\br_\bs (section
- 7.4.61 , page 103) option.
+ Default: "%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s"
- _\b7_\b._\b4_\b._\b6_\b0 _\be_\bd_\bi_\bt_\bo_\br
+ This variable allows you to customize the message index display to your personal taste.
- Type: path
+ ``Format strings'' are similar to the strings used in the ``C'' function printf(3) to format output (see the man page for more detail). The following sequences are defined in Mutt-ng:
- Default: ''
+ %a
+ address of the author
- This variable specifies which editor is used by Mutt-ng. It defaults to the
- value of the $VISUAL, or $EDITOR, environment variable, or to the string 'vi'
- if neither of those are set.
+ %A
+ reply-to address (if present; otherwise: address of author)
- _\b7_\b._\b4_\b._\b6_\b1 _\be_\bd_\bi_\bt_\bo_\br_\b__\bh_\be_\ba_\bd_\be_\br_\bs
+ %b
+ filename of the original message folder (think mailBox)
- Type: string
+ %B
+ the list to which the letter was sent, or else the folder name (%b).
- The Mutt Next Generation E-Mail Client 104
+ %c
+ number of characters (bytes) in the message
- Default: 'From: To: Cc: Bcc: Subject: Reply-To: Newsgroups: Followup-To: X-Com-
- ment-To:'
+ %C
+ current message number
- If _\b$_\be_\bd_\bi_\bt_\b__\bh_\be_\ba_\bd_\be_\br_\bs (section 7.4.59 , page 103) is _\bs_\be_\bt, this space-separated list
- specifies which _\bn_\bo_\bn_\b-_\be_\bm_\bp_\bt_\by header fields to edit in addition to user-defined
- headers.
+ %d
+ date and time of the message in the format specified by ``date_format'' converted to sender's time zone
- Note: if _\b$_\be_\bd_\bi_\bt_\b__\bh_\be_\ba_\bd_\be_\br_\bs (section 7.4.59 , page 103) had to be turned on by
- force because _\b$_\bs_\bt_\br_\bi_\bc_\bt_\b__\bm_\ba_\bi_\bl_\bt_\bo (section 7.4.326 , page 169) is _\bu_\bn_\bs_\be_\bt, this
- option has no effect.
+ %D
+ date and time of the message in the format specified by ``date_format'' converted to the local time zone
- _\b7_\b._\b4_\b._\b6_\b2 _\be_\bn_\bc_\bo_\bd_\be_\b__\bf_\br_\bo_\bm
+ %e
+ current message number in thread
- Type: boolean
+ %E
+ number of messages in current thread
- Default: no
+ %f
+ entire From: line (address + real name)
- When _\bs_\be_\bt, Mutt-ng will quoted-printable encode messages when they contain the
- string ``From '' (note the trailing space) in the beginning of a line. Useful
- to avoid the tampering certain mail delivery and transport agents tend to do
- with messages.
+ %F
+ author name, or recipient name if the message is from you
- N\bNo\bot\bte\be:\b: as mutt-ng currently violates RfC3676 defining format=flowed, it's
- <em/strongly/ advised to _\bs_\be_\bt this option although discouraged by the standard.
- Alternatively, you must take care of space-stuffing <tt/From / lines (with a
- trailing space) yourself.
+ %H
+ spam attribute(s) of this message
- _\b7_\b._\b4_\b._\b6_\b3 _\be_\bn_\bt_\br_\bo_\bp_\by_\b__\bf_\bi_\bl_\be
+ %g
+ newsgroup name (if compiled with nntp support)
- Type: path
+ %i
+ message-id of the current message
- Default: ''
+ %l
+ number of lines in the message (does not work with maildir, mh, and possibly IMAP folders)
- Availability: SSL
+ %L
+ If an address in the To or CC header field matches an address defined by the users ``subscribe'' command, this displays "To <list-name>", otherwise the same as %F.
- The file which includes random data that is used to initialize SSL library
- functions.
+ %m
+ total number of message in the mailbox
- _\b7_\b._\b4_\b._\b6_\b4 _\be_\bn_\bv_\be_\bl_\bo_\bp_\be_\b__\bf_\br_\bo_\bm
+ %M
+ number of hidden messages if the thread is collapsed.
- Type: boolean
+ %N
+ message score
- Default: no
+ %n
+ author's real name (or address if missing)
- When _\bs_\be_\bt, Mutt-ng will try to derive the message's _\be_\bn_\bv_\be_\bl_\bo_\bp_\be sender from the
- ``From:'' header field. Note that this information is passed to the sendmail
- command using the ``-f' command line switch, so don't set this option if you
- are using that switch in _\b$_\bs_\be_\bn_\bd_\bm_\ba_\bi_\bl (section 7.4.263 , page 152) yourself, or
- if the sendmail on your machine doesn't support that command line switch.
+ %O
+ (_O_riginal save folder) Where Mutt-ng would formerly have stashed the message: list name or recipient name if no list
- _\b7_\b._\b4_\b._\b6_\b5 _\be_\bs_\bc_\ba_\bp_\be
+ %s
+ subject of the message
- Type: string
+ %S
+ status of the message (N/D/d/!/r/*)
- The Mutt Next Generation E-Mail Client 105
+ %t
+ `to:' field (recipients)
- Default: '~'
+ %T
+ the appropriate character from the $to_chars string
- Escape character to use for functions in the builtin editor.
+ %u
+ user (login) name of the author
- _\b7_\b._\b4_\b._\b6_\b6 _\bf_\ba_\bs_\bt_\b__\br_\be_\bp_\bl_\by
+ %v
+ first name of the author, or the recipient if the message is from you
- Type: boolean
+ %W
+ name of organization of author (`organization:' field)
- Default: no
+ %y
+ `x-label:' field, if present
- When _\bs_\be_\bt, the initial prompt for recipients and subject are skipped when reply-
- ing to messages, and the initial prompt for subject is skipped when forwarding
- messages.
+ %Y
+ `x-label' field, if present, and (1) not at part of a thread tree, (2) at the top of a thread, or (3) `x-label' is different from preceding message's `x-label'.
- N\bNo\bot\bte\be:\b: this variable has no effect when the ``_\b$_\ba_\bu_\bt_\bo_\be_\bd_\bi_\bt (section 7.4.20 , page
- 94)'' variable is _\bs_\be_\bt.
+ %Z
+ message status flags
- _\b7_\b._\b4_\b._\b6_\b7 _\bf_\bc_\bc_\b__\ba_\bt_\bt_\ba_\bc_\bh
+ %{fmt}
+ the date and time of the message is converted to sender's time zone, and ``fmt'' is expanded by the library function ``strftime''; a leading bang disables locales
- Type: boolean
+ %[fmt]
+ the date and time of the message is converted to the local time zone, and ``fmt'' is expanded by the library function ``strftime''; a leading bang disables locales
- Default: yes
+ %(fmt)
+ the local date and time when the message was received. ``fmt'' is expanded by the library function ``strftime''; a leading bang disables locales
- This variable controls whether or not attachments on outgoing messages are
- saved along with the main body of your message.
+ %<fmt>
+ the current local time. ``fmt'' is expanded by the library function ``strftime''; a leading bang disables locales.
- _\b7_\b._\b4_\b._\b6_\b8 _\bf_\bc_\bc_\b__\bc_\bl_\be_\ba_\br
+ %>X
+ right justify the rest of the string and pad with character "X"
- Type: boolean
+ %|X
+ pad to the end of the line with character "X"
- Default: no
+ See also: ``$to_chars''.
- When this variable is _\bs_\be_\bt, FCCs will be stored unencrypted and unsigned, even
- when the actual message is encrypted and/or signed. (PGP only)
+117. ispell
- _\b7_\b._\b4_\b._\b6_\b9 _\bf_\bi_\bl_\be_\b__\bc_\bh_\ba_\br_\bs_\be_\bt
+ Type: path
- Type: string
+ Default: "ispell"
- Default: ''
+ How to invoke ispell (GNU's spell-checking software).
- This variable is a colon-separated list of character encoding schemes for text
- file attatchments. If _\bu_\bn_\bs_\be_\bt, _\b$_\bc_\bh_\ba_\br_\bs_\be_\bt (section 7.4.27 , page 96) value will
- be used instead. For example, the following configuration would work for
- Japanese text handling:
+118. keep_flagged
- set file_charset='iso-2022-jp:euc-jp:shift_jis:utf-8'
+ Type: boolean
- Note: ``iso-2022-*'' must be put at the head of the value as shown above if
- included.
+ Default: no
- _\b7_\b._\b4_\b._\b7_\b0 _\bf_\bo_\bl_\bd_\be_\br
+ If set, read messages marked as flagged will not be moved from your spool mailbox to your ``$mbox'' mailbox, or as a result of a ``mbox-hook'' command.
- Type: path
+119. list_reply
- The Mutt Next Generation E-Mail Client 106
+ Type: quadoption
- Default: '~/Mail'
+ Default: no
- Specifies the default location of your mailboxes. A ``+'' or ``='' at the
- beginning of a pathname will be expanded to the value of this variable. Note
- that if you change this variable from the default value you need to make sure
- that the assignment occurs _\bb_\be_\bf_\bo_\br_\be you use ``+'' or ``='' for any other vari-
- ables since expansion takes place during the ``set'' command.
+ When set, address replies to the mailing list the original message came from (instead to the author only). Setting this option to ``ask-yes'' or ``ask-no'' will ask if you really intended to reply to the author only.
- _\b7_\b._\b4_\b._\b7_\b1 _\bf_\bo_\bl_\bd_\be_\br_\b__\bf_\bo_\br_\bm_\ba_\bt
+120. locale
- Type: string
+ Type: string
- Default: '%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f'
+ Default: "C"
- This variable allows you to customize the file browser display to your personal
- taste. This string is similar to ``_\b$_\bi_\bn_\bd_\be_\bx_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.116 , page
- 116)'', but has its own set of printf(3)-like sequences:
+ The locale used by strftime(3) to format dates. Legal values are the strings your system accepts for the locale variable LC_TIME.
- %C
- current file number
+121. mail_check
- %d
- date/time folder was last modified
+ Type: number
- %f
- filename
+ Default: 5
- %F
- file permissions
+ This variable configures how often (in seconds) Mutt-ng should look for new mail.
- %g
- group name (or numeric gid, if missing)
+ Note: This does not apply to IMAP mailboxes, see $imap_mail_check.
- %l
- number of hard links
+122. mailcap_path
- %N
- N if folder has new mail, blank otherwise
+ Type: string
- %s
- size in bytes
+ Default: ""
- %t
- * if the file is tagged, blank otherwise
+ This variable specifies which files to consult when attempting to display MIME bodies not directly supported by Mutt-ng.
- %u
- owner name (or numeric uid, if missing)
+123. mailcap_sanitize
- %>X
- right justify the rest of the string and pad with character 'X'
+ Type: boolean
- %|X
- pad to the end of the line with character 'X'
+ Default: yes
- The Mutt Next Generation E-Mail Client 107
+ If set, Mutt-ng will restrict possible characters in mailcap % expandos to a well-defined set of safe characters. This is the safe setting, but we are not sure it doesn't break some more advanced MIME stuff.
- _\b7_\b._\b4_\b._\b7_\b2 _\bf_\bo_\bl_\bl_\bo_\bw_\bu_\bp_\b__\bt_\bo
+ DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE DOING!
- Type: boolean
+124. maildir_header_cache_verify
- Default: yes
+ Type: boolean
- Controls whether or not the Mail-Followup-To: header field is generated when
- sending mail. When _\bs_\be_\bt, Mutt-ng will generate this field when you are replying
- to a known mailing list, specified with the ``subscribe'' or ``_\bl_\bi_\bs_\bt_\bs (section
- 3.13 , page 36)'' commands or detected by common mailing list headers.
+ Default: yes
- This field has two purposes. First, preventing you from receiving duplicate
- copies of replies to messages which you send to mailing lists. Second, ensuring
- that you do get a reply separately for any messages sent to known lists to
- which you are not subscribed. The header will contain only the list's address
- for subscribed lists, and both the list address and your own email address for
- unsubscribed lists. Without this header, a group reply to your message sent to
- a subscribed list will be sent to both the list and your address, resulting in
- two copies of the same email for you.
+ Availability: Header Cache
- _\b7_\b._\b4_\b._\b7_\b3 _\bf_\bo_\br_\bc_\be_\b__\bb_\bu_\bf_\bf_\by_\b__\bc_\bh_\be_\bc_\bk
+ Check for Maildir unaware programs other than Mutt-ng having modified maildir files when the header cache is in use. This incurs one stat(2) per message every time the folder is opened.
- Type: boolean
+125. maildir_trash
- Default: no
+ Type: boolean
- When _\bs_\be_\bt, it causes Mutt-ng to check for new mail when the _\bb_\bu_\bf_\bf_\by_\b-_\bl_\bi_\bs_\bt command
- is invoked. When _\bu_\bn_\bs_\be_\bt, _\bb_\bu_\bf_\bf_\by_\b__\bl_\bi_\bs_\bt will just list all mailboxes which are
- already known to have new mail.
+ Default: no
- Also see the following variables: ``_\b$_\bt_\bi_\bm_\be_\bo_\bu_\bt (section 7.4.337 , page 172)'',
- ``_\b$_\bm_\ba_\bi_\bl_\b__\bc_\bh_\be_\bc_\bk (section 7.4.121 , page 120)'' and ``_\b$_\bi_\bm_\ba_\bp_\b__\bm_\ba_\bi_\bl_\b__\bc_\bh_\be_\bc_\bk (section
- 7.4.105 , page 114)''.
+ If set, messages marked as deleted will be saved with the maildir (T)rashed flag instead of physically deleted.
- _\b7_\b._\b4_\b._\b7_\b4 _\bf_\bo_\br_\bc_\be_\b__\bn_\ba_\bm_\be
+ NOTE: this only applies to maildir-style mailboxes. Setting it will have no effect on other mailbox types.
- Type: boolean
+ It is similiar to the trash option.
- Default: no
+126. mark_old
- This variable is similar to ``_\b$_\bs_\ba_\bv_\be_\b__\bn_\ba_\bm_\be (section 7.4.257 , page 151)'',
- except that Mutt-ng will store a copy of your outgoing message by the username
- of the address you are sending to even if that mailbox does not exist.
+ Type: boolean
- Also see the ``_\b$_\br_\be_\bc_\bo_\br_\bd (section 7.4.246 , page 148)'' variable.
+ Default: yes
- _\b7_\b._\b4_\b._\b7_\b5 _\bf_\bo_\br_\bw_\ba_\br_\bd_\b__\bd_\be_\bc_\bo_\bd_\be
+ Controls whether or not Mutt-ng marks new unread messages as old if you exit a mailbox without reading them.
- Type: boolean
+ With this option set, the next time you start Mutt-ng, the messages will show up with an "O" next to them in the ``index'' menu, indicating that they are old.
- Default: yes
+127. markers
- Controls the decoding of complex MIME messages into text/plain when forwarding
- a message. The message header is also RFC2047 decoded. This variable is only
+ Type: boolean
- The Mutt Next Generation E-Mail Client 108
+ Default: yes
- used, if ``_\b$_\bm_\bi_\bm_\be_\b__\bf_\bo_\br_\bw_\ba_\br_\bd (section 7.4.143 , page 124)'' is _\bu_\bn_\bs_\be_\bt, otherwise
- ``_\b$_\bm_\bi_\bm_\be_\b__\bf_\bo_\br_\bw_\ba_\br_\bd_\b__\bd_\be_\bc_\bo_\bd_\be (section 7.4.144 , page 124)'' is used instead.
+ Controls the display of wrapped lines in the internal pager. If set, a ``+'' marker is displayed at the beginning of wrapped lines. Also see the ``$smart_wrap'' variable.
- _\b7_\b._\b4_\b._\b7_\b6 _\bf_\bo_\br_\bw_\ba_\br_\bd_\b__\bd_\be_\bc_\br_\by_\bp_\bt
+128. mask
- Type: boolean
+ Type: regular expression
- Default: yes
+ Default: "!^\.[^.]"
- Controls the handling of encrypted messages when forwarding a message. When
- _\bs_\be_\bt, the outer layer of encryption is stripped off. This variable is only used
- if ``_\b$_\bm_\bi_\bm_\be_\b__\bf_\bo_\br_\bw_\ba_\br_\bd (section 7.4.143 , page 124)'' is _\bs_\be_\bt and ``_\b$_\bm_\bi_\bm_\be_\b__\bf_\bo_\br_\b-
- _\bw_\ba_\br_\bd_\b__\bd_\be_\bc_\bo_\bd_\be (section 7.4.144 , page 124)'' is _\bu_\bn_\bs_\be_\bt. (PGP only)
+ A regular expression used in the file browser, optionally preceded by the not operator ``!''. Only files whose names match this mask will be shown. The match is always case-sensitive.
- _\b7_\b._\b4_\b._\b7_\b7 _\bf_\bo_\br_\bw_\ba_\br_\bd_\b__\be_\bd_\bi_\bt
+129. max_display_recips
- Type: quadoption
+ Type: number
- Default: yes
+ Default: 0
- This quadoption controls whether or not the user is automatically placed in the
- editor when forwarding messages. For those who always want to forward with no
- modification, use a setting of _\bn_\bo.
+ When set non-zero, this specifies the maximum number of recipient header lines (To:, Cc: and Bcc:) to display in the pager if header weeding is turned on. In case the number of lines exeeds its value, the last line will have 3 dots appended.
- _\b7_\b._\b4_\b._\b7_\b8 _\bf_\bo_\br_\bw_\ba_\br_\bd_\b__\bf_\bo_\br_\bm_\ba_\bt
+130. max_line_length
- Type: string
+ Type: number
- Default: '[%a: %s]'
+ Default: 0
- This variable controls the default subject when forwarding a message. It uses
- the same format sequences as the ``_\b$_\bi_\bn_\bd_\be_\bx_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.116 , page
- 116)'' variable.
+ When set, the maximum line length for displaying ``format = flowed'' messages is limited to this length. A value of 0 (which is also the default) means that the maximum line length is determined by the terminal width and $wrapmargin.
- _\b7_\b._\b4_\b._\b7_\b9 _\bf_\bo_\br_\bw_\ba_\br_\bd_\b__\bq_\bu_\bo_\bt_\be
+131. mbox
- Type: boolean
+ Type: path
- Default: no
+ Default: "˜/mbox"
- When _\bs_\be_\bt forwarded messages included in the main body of the message (when
- ``_\b$_\bm_\bi_\bm_\be_\b__\bf_\bo_\br_\bw_\ba_\br_\bd (section 7.4.143 , page 124)'' is _\bu_\bn_\bs_\be_\bt) will be quoted using
- ``_\b$_\bi_\bn_\bd_\be_\bn_\bt_\b__\bs_\bt_\br_\bi_\bn_\bg (section 7.4.115 , page 116)''.
+ This specifies the folder into which read mail in your ``$spoolfile'' folder will be appended.
- _\b7_\b._\b4_\b._\b8_\b0 _\bf_\br_\bo_\bm
+132. mbox_type
- Type: e-mail address
+ Type: folder magic
- Default: ''
+ Default: mbox
- This variable contains a default from address. It can be overridden using
- my_hdr (including from send-hooks) and ``_\b$_\br_\be_\bv_\be_\br_\bs_\be_\b__\bn_\ba_\bm_\be (section 7.4.252 , page
- 150)''. This variable is ignored if ``_\b$_\bu_\bs_\be_\b__\bf_\br_\bo_\bm (section 7.4.346 , page
- 174)'' is unset.
+ The default mailbox type used when creating new folders. May be any of mbox, MMDF, MH and Maildir.
- The Mutt Next Generation E-Mail Client 109
+133. menu_context
- E.g. you can use send-hook Mutt-ng-devel@lists.berlios.de 'my_hdr From: Foo Bar
- <foo@bar.fb>' when replying to the mutt-ng developer's mailing list and Mutt-ng
- takes this email address.
+ Type: number
- Defaults to the contents of the environment variable $EMAIL.
+ Default: 0
- _\b7_\b._\b4_\b._\b8_\b1 _\bg_\be_\bc_\bo_\bs_\b__\bm_\ba_\bs_\bk
+ This variable controls the number of lines of context that are given when scrolling through menus. (Similar to ``$pager_context''.)
- Type: regular expression
+134. menu_move_off
- Default: '^[^,]*'
+ Type: boolean
- A regular expression used by Mutt-ng to parse the GECOS field of a password
- entry when expanding the alias. By default the regular expression is set to
- ``^[^,]*'' which will return the string up to the first ``,'' encountered. If
- the GECOS field contains a string like 'lastname, firstname' then you should
- do: set gecos_mask='.*'.
+ Default: yes
- This can be useful if you see the following behavior: you address a e-mail to
- user ID stevef whose full name is Steve Franklin. If Mutt-ng expands stevef to
- ``Franklin'' stevef@foo.bar then you should set the gecos_mask to a regular
- expression that will match the whole name so Mutt-ng will expand ``Franklin''
- to ``Franklin, Steve''.
+ When unset, the bottom entry of menus will never scroll up past the bottom of the screen, unless there are less entries than lines. When set, the bottom entry may move off the bottom.
- _\b7_\b._\b4_\b._\b8_\b2 _\bh_\bd_\br_\bs
+135. menu_scroll
- Type: boolean
+ Type: boolean
- Default: yes
+ Default: no
- When _\bu_\bn_\bs_\be_\bt, the header fields normally added by the ``_\bm_\by_\b__\bh_\bd_\br (section 3.16 ,
- page 38)'' command are not created. This variable _\bm_\bu_\bs_\bt be _\bu_\bn_\bs_\be_\bt before compos-
- ing a new message or replying in order to take effect. If _\bs_\be_\bt, the user
- defined header fields are added to every new message.
+ When set, menus will be scrolled up or down one line when you attempt to move across a screen boundary. If unset, the screen is cleared and the next or previous page of the menu is displayed (useful for slow links to avoid many redraws).
- _\b7_\b._\b4_\b._\b8_\b3 _\bh_\be_\ba_\bd_\be_\br
+136. message_format
- Type: boolean
+ Type: string
- Default: no
+ Default: "%s"
- When _\bs_\be_\bt, this variable causes Mutt-ng to include the header of the message you
- are replying to into the edit buffer. The ``_\b$_\bw_\be_\be_\bd (section 7.4.351 , page
- 175)'' setting applies.
+ This is the string displayed in the ``attachment'' menu for attachments of type message/rfc822. For a full listing of defined printf(3)-like sequences see the section on ``$index_format''.
- _\b7_\b._\b4_\b._\b8_\b4 _\bh_\be_\ba_\bd_\be_\br_\b__\bc_\ba_\bc_\bh_\be
+137. meta_key
- Type: path
+ Type: boolean
- Default: ''
+ Default: no
- Availability: Header Cache
+ If set, forces Mutt-ng to interpret keystrokes with the high bit (bit 8) set as if the user had pressed the ESC key and whatever key remains after having the high bit removed. For example, if the key pressed has an ASCII value of 0xf4, then this is treated as if the user had pressed ESC then ``x''. This is because the result of removing the high bit from ``0xf4'' is ``0x74'', which is the ASCII character ``x''.
- The _\b$_\bh_\be_\ba_\bd_\be_\br_\b__\bc_\ba_\bc_\bh_\be (section 7.4.84 , page 109) variable points to the header
+138. metoo
- The Mutt Next Generation E-Mail Client 110
+ Type: boolean
- cache database.
+ Default: no
- If _\b$_\bh_\be_\ba_\bd_\be_\br_\b__\bc_\ba_\bc_\bh_\be (section 7.4.84 , page 109) points to a directory it will
- contain a header cache database per folder. If _\b$_\bh_\be_\ba_\bd_\be_\br_\b__\bc_\ba_\bc_\bh_\be (section
- 7.4.84 , page 109) points to a file that file will be a single global header
- cache. By default it is _\bu_\bn_\bs_\be_\bt so no header caching will be used.
+ If unset, Mutt-ng will remove your address (see the ``alternates'' command) from the list of recipients when replying to a message.
- _\b7_\b._\b4_\b._\b8_\b5 _\bh_\be_\ba_\bd_\be_\br_\b__\bc_\ba_\bc_\bh_\be_\b__\bc_\bo_\bm_\bp_\br_\be_\bs_\bs
+139. mh_purge
- Type: boolean
+ Type: boolean
- Default: no
+ Default: no
- If enabled the header cache will be compressed. So only one fifth of the usual
- diskspace is used, but the uncompression can result in a slower open of the
- cached folder.
+ When unset, Mutt-ng will mimic mh's behaviour and rename deleted messages to ,<old file name> in mh folders instead of really deleting them. If the variable is set, the message files will simply be deleted.
- _\b7_\b._\b4_\b._\b8_\b6 _\bh_\be_\bl_\bp
+140. mh_seq_flagged
- Type: boolean
+ Type: string
- Default: yes
+ Default: "flagged"
- When _\bs_\be_\bt, help lines describing the bindings for the major functions provided
- by each menu are displayed on the first line of the screen.
+ The name of the MH sequence used for flagged messages.
- N\bNo\bot\bte\be:\b: The binding will not be displayed correctly if the function is bound to a
- sequence rather than a single keystroke. Also, the help line may not be
- updated if a binding is changed while Mutt-ng is running. Since this variable
- is primarily aimed at new users, neither of these should present a major prob-
- lem.
+141. mh_seq_replied
- _\b7_\b._\b4_\b._\b8_\b7 _\bh_\bi_\bd_\bd_\be_\bn_\b__\bh_\bo_\bs_\bt
+ Type: string
- Type: boolean
+ Default: "replied"
- Default: no
+ The name of the MH sequence used to tag replied messages.
- When _\bs_\be_\bt, Mutt-ng will skip the host name part of ``_\b$_\bh_\bo_\bs_\bt_\bn_\ba_\bm_\be (section
- 7.4.95 , page 111)'' variable when adding the domain part to addresses. This
- variable does not affect the generation of Message-ID: header fields, and it
- will not lead to the cut-off of first-level domains.
+142. mh_seq_unseen
- _\b7_\b._\b4_\b._\b8_\b8 _\bh_\bi_\bd_\be_\b__\bl_\bi_\bm_\bi_\bt_\be_\bd
+ Type: string
- Type: boolean
+ Default: "unseen"
- Default: no
+ The name of the MH sequence used for unseen messages.
- When _\bs_\be_\bt, Mutt-ng will not show the presence of messages that are hidden by
- limiting, in the thread tree.
+143. mime_forward
- _\b7_\b._\b4_\b._\b8_\b9 _\bh_\bi_\bd_\be_\b__\bm_\bi_\bs_\bs_\bi_\bn_\bg
+ Type: quadoption
- The Mutt Next Generation E-Mail Client 111
+ Default: no
- Type: boolean
+ When set, the message you are forwarding will be attached as a separate MIME part instead of included in the main body of the message.
- Default: yes
+ This is useful for forwarding MIME messages so the receiver can properly view the message as it was delivered to you. If you like to switch between MIME and not MIME from mail to mail, set this variable to ask-no or ask-yes.
- When _\bs_\be_\bt, Mutt-ng will not show the presence of missing messages in the thread
- tree.
+ Also see ``$forward_decode'' and ``$mime_forward_decode''.
- _\b7_\b._\b4_\b._\b9_\b0 _\bh_\bi_\bd_\be_\b__\bt_\bh_\br_\be_\ba_\bd_\b__\bs_\bu_\bb_\bj_\be_\bc_\bt
+144. mime_forward_decode
- Type: boolean
+ Type: boolean
- Default: yes
+ Default: no
- When _\bs_\be_\bt, Mutt-ng will not show the subject of messages in the thread tree that
- have the same subject as their parent or closest previously displayed sibling.
+ Controls the decoding of complex MIME messages into text/plain when forwarding a message while ``$mime_forward'' is set. Otherwise ``$forward_decode'' is used instead.
- _\b7_\b._\b4_\b._\b9_\b1 _\bh_\bi_\bd_\be_\b__\bt_\bo_\bp_\b__\bl_\bi_\bm_\bi_\bt_\be_\bd
+145. mime_forward_rest
- Type: boolean
+ Type: quadoption
- Default: no
+ Default: yes
- When _\bs_\be_\bt, Mutt-ng will not show the presence of messages that are hidden by
- limiting, at the top of threads in the thread tree. Note that when _\b$_\bh_\bi_\bd_\be_\b__\bm_\bi_\bs_\bs_\b-
- _\bi_\bn_\bg (section 7.4.89 , page 110) is set, this option will have no effect.
+ When forwarding multiple attachments of a MIME message from the recvattach menu, attachments which cannot be decoded in a reasonable manner will be attached to the newly composed message if this option is set.
- _\b7_\b._\b4_\b._\b9_\b2 _\bh_\bi_\bd_\be_\b__\bt_\bo_\bp_\b__\bm_\bi_\bs_\bs_\bi_\bn_\bg
+146. mix_entry_format
- Type: boolean
+ Type: string
- Default: yes
+ Default: "%4n %c %-16s %a"
- When _\bs_\be_\bt, Mutt-ng will not show the presence of missing messages at the top of
- threads in the thread tree. Note that when _\b$_\bh_\bi_\bd_\be_\b__\bl_\bi_\bm_\bi_\bt_\be_\bd (section 7.4.88 ,
- page 110) is _\bs_\be_\bt, this option will have no effect.
+ Availability: Mixmaster
- _\b7_\b._\b4_\b._\b9_\b3 _\bh_\bi_\bs_\bt_\bo_\br_\by
+ This variable describes the format of a remailer line on the mixmaster chain selection screen. The following printf(3)-like sequences are supported:
- Type: number
+ %n
+ The running number on the menu.
- Default: 10
+ %c
+ Remailer capabilities.
- This variable controls the size (in number of strings remembered) of the string
- history buffer. The buffer is cleared each time the variable is changed.
+ %s
+ The remailer's short name.
- _\b7_\b._\b4_\b._\b9_\b4 _\bh_\bo_\bn_\bo_\br_\b__\bf_\bo_\bl_\bl_\bo_\bw_\bu_\bp_\b__\bt_\bo
+ %a
+ The remailer's e-mail address.
- Type: quadoption
+147. mixmaster
- Default: yes
+ Type: path
- This variable controls whether or not a Mail-Followup-To: header field is hon-
- ored when group-replying to a message.
+ Default: "mixmaster"
- The Mutt Next Generation E-Mail Client 112
+ Availability: Mixmaster
- _\b7_\b._\b4_\b._\b9_\b5 _\bh_\bo_\bs_\bt_\bn_\ba_\bm_\be
+ This variable contains the path to the Mixmaster binary on your system. It is used with various sets of parameters to gather the list of known remailers, and to finally send a message through the mixmaster chain.
- Type: string
+148. move
- Default: ''
+ Type: quadoption
- Specifies the hostname to use after the ``@'' in local e-mail addresses and
- during generation of Message-Id: headers.
+ Default: ask-no
- Please be sure to really know what you are doing when changing this variable to
- configure a custom domain part of Message-IDs.
+ Controls whether or not Mutt-ng will move read messages from your spool mailbox to your ``$mbox'' mailbox, or as a result of a ``mbox-hook'' command.
- _\b7_\b._\b4_\b._\b9_\b6 _\bi_\bg_\bn_\bo_\br_\be_\b__\bl_\bi_\bs_\bt_\b__\br_\be_\bp_\bl_\by_\b__\bt_\bo
+149. msgid_format
- Type: boolean
+ Type: string
- Default: no
+ Default: "%Y%m%d%h%M%s.G%P%p"
- Affects the behaviour of the _\br_\be_\bp_\bl_\by function when replying to messages from
- mailing lists. When _\bs_\be_\bt, if the ``Reply-To:'' header field is set to the same
- value as the ``To:'' header field, Mutt-ng assumes that the ``Reply-To:''
- header field was set by the mailing list to automate responses to the list, and
- will ignore this field. To direct a response to the mailing list when this
- option is set, use the _\bl_\bi_\bs_\bt_\b-_\br_\be_\bp_\bl_\by function; _\bg_\br_\bo_\bu_\bp_\b-_\br_\be_\bp_\bl_\by will reply to both the
- sender and the list.
+ This is the format for the ``local part'' of the Message-Id: header field generated by Mutt-ng. If this variable is empty, no Message-Id: headers will be generated. The '%' character marks that certain data will be added to the string, similar to printf(3). The following characters are allowed:
- _\b7_\b._\b4_\b._\b9_\b7 _\bi_\bm_\ba_\bp_\b__\ba_\bu_\bt_\bh_\be_\bn_\bt_\bi_\bc_\ba_\bt_\bo_\br_\bs
+ %d
+ the current day of month
- Type: string
+ %h
+ the current hour
- Default: ''
+ %m
+ the current month
- Availability: IMAP
+ %M
+ the current minute
- This is a colon-delimited list of authentication methods Mutt-ng may attempt to
- use to log in to an IMAP server, in the order Mutt-ng should try them. Authen-
- tication methods are either ``login'' or the right side of an IMAP ``AUTH=''
- capability string, e.g. ``digest-md5'', ``gssapi'' or ``cram-md5''. This param-
- eter is case-insensitive.
+ %O
+ the current UNIX timestamp (octal)
- If this parameter is _\bu_\bn_\bs_\be_\bt (the default) Mutt-ng will try all available meth-
- ods, in order from most-secure to least-secure.
+ %p
+ the process ID
- Example: set imap_authenticators='gssapi:cram-md5:login'
+ %P
+ the current Message-ID prefix (a character rotating with every Message-ID being generated)
- N\bNo\bot\bte\be:\b: Mutt-ng will only fall back to other authentication methods if the previ-
- ous methods are unavailable. If a method is available but authentication fails,
- Mutt-ng will not connect to the IMAP server.
+ %r
+ a random integer value (decimal)
- _\b7_\b._\b4_\b._\b9_\b8 _\bi_\bm_\ba_\bp_\b__\bc_\bh_\be_\bc_\bk_\b__\bs_\bu_\bb_\bs_\bc_\br_\bi_\bb_\be_\bd
+ %R
+ a random integer value (hexadecimal)
- Type: boolean
+ %s
+ the current second
- Default: no
+ %T
+ the current UNIX timestamp (decimal)
- The Mutt Next Generation E-Mail Client 113
+ %X
+ the current UNIX timestamp (hexadecimal)
- When _\bs_\be_\bt, mutt will fetch the set of subscribed folders from your server on
- connection, and add them to the set of mailboxes it polls for new mail. See
- also the ``_\bm_\ba_\bi_\bl_\bb_\bo_\bx_\be_\bs (section 3.15 , page 37)'' command.
+ %Y
+ the current year (Y2K compliant)
- _\b7_\b._\b4_\b._\b9_\b9 _\bi_\bm_\ba_\bp_\b__\bd_\be_\bl_\bi_\bm_\b__\bc_\bh_\ba_\br_\bs
+ %%
+ the '%' character
- Type: string
+ Note: Please only change this setting if you know what you are doing. Also make sure to consult RFC2822 to produce technically valid strings.
- Default: '/.'
+150. muttng_bindir
- Availability: IMAP
+ Type: system property
- This contains the list of characters which you would like to treat as folder
- separators for displaying IMAP paths. In particular it helps in using the '='
- shortcut for your _\b$_\bf_\bo_\bl_\bd_\be_\br (section 7.4.70 , page 105) variable.
+ Value: /opt/freebsd4/mutt-ng/bin
- _\b7_\b._\b4_\b._\b1_\b0_\b0 _\bi_\bm_\ba_\bp_\b__\bh_\be_\ba_\bd_\be_\br_\bs
+ This is a read-only system property and specifies the directory containing the muttng binary.
- Type: string
+151. muttng_docdir
- Default: ''
+ Type: system property
- Availability: IMAP
+ Value: /opt/freebsd4/mutt-ng/doc/muttng
- Mutt-ng requests these header fields in addition to the default headers (``DATE
- FROM SUBJECT TO CC MESSAGE-ID REFERENCES CONTENT-TYPE CONTENT-DESCRIPTION IN-
- REPLY-TO REPLY-TO LINES X-LABEL'') from IMAP servers before displaying the
- ``index'' menu. You may want to add more headers for spam detection.
+ This is a read-only system property and specifies the directory containing the muttng documentation.
- N\bNo\bot\bte\be:\b: This is a space separated list.
+152. muttng_folder_name
- _\b7_\b._\b4_\b._\b1_\b0_\b1 _\bi_\bm_\ba_\bp_\b__\bh_\bo_\bm_\be_\b__\bn_\ba_\bm_\be_\bs_\bp_\ba_\bc_\be
+ Type: system property
- Type: string
+ Value:
- Default: ''
+ This is a read-only system property and, at runtime, specifies the last part of the full path or URI of the folder currently open (if any), i.e. everything after the last ``/''.
- Availability: IMAP
+153. muttng_folder_path
- You normally want to see your personal folders alongside your INBOX in the IMAP
- browser. If you see something else, you may set this variable to the IMAP path
- to your folders.
+ Type: system property
- _\b7_\b._\b4_\b._\b1_\b0_\b2 _\bi_\bm_\ba_\bp_\b__\bk_\be_\be_\bp_\ba_\bl_\bi_\bv_\be
+ Value:
- Type: number
+ This is a read-only system property and, at runtime, specifies the full path or URI of the folder currently open (if any).
- Default: 900
+154. muttng_hcache_backend
- Availability: IMAP
+ Type: system property
- This variable specifies the maximum amount of time in seconds that Mutt-ng will
- wait before polling open IMAP connections, to prevent the server from closing
- them before Mutt-ng has finished with them.
+ Value: qdbm
- The Mutt Next Generation E-Mail Client 114
+ This is a read-only system property and specifies the header chaching's database backend.
- The default is well within the RFC-specified minimum amount of time (30 min-
- utes) before a server is allowed to do this, but in practice the RFC does get
- violated every now and then.
+155. muttng_pwd
- Reduce this number if you find yourself getting disconnected from your IMAP
- server due to inactivity.
+ Type: system property
- _\b7_\b._\b4_\b._\b1_\b0_\b3 _\bi_\bm_\ba_\bp_\b__\bl_\bi_\bs_\bt_\b__\bs_\bu_\bb_\bs_\bc_\br_\bi_\bb_\be_\bd
+ Value:
- Type: boolean
+ This is a read-only system property and, at runtime, specifies the current working directory of the muttng binary.
- Default: no
+156. muttng_revision
- Availability: IMAP
+ Type: system property
- This variable configures whether IMAP folder browsing will look for only sub-
- scribed folders or all folders. This can be toggled in the IMAP browser with
- the _\bt_\bo_\bg_\bg_\bl_\be_\b-_\bs_\bu_\bb_\bs_\bc_\br_\bi_\bb_\be_\bd function.
+ Value: 473
- _\b7_\b._\b4_\b._\b1_\b0_\b4 _\bi_\bm_\ba_\bp_\b__\bl_\bo_\bg_\bi_\bn
+ This is a read-only system property and specifies muttng's subversion revision string.
- Type: string
+157. muttng_sysconfdir
- Default: ''
+ Type: system property
- Availability: IMAP
+ Value: /opt/freebsd4/mutt-ng/etc
- Your login name on the IMAP server.
+ This is a read-only system property and specifies the directory containing the muttng system-wide configuration.
- This variable defaults to the value of ``_\b$_\bi_\bm_\ba_\bp_\b__\bu_\bs_\be_\br (section 7.4.111 , page
- 115).''
+158. muttng_version
- _\b7_\b._\b4_\b._\b1_\b0_\b5 _\bi_\bm_\ba_\bp_\b__\bm_\ba_\bi_\bl_\b__\bc_\bh_\be_\bc_\bk
+ Type: system property
- Type: number
+ Value: devel
- Default: 300
+ This is a read-only system property and specifies muttng's version string.
- This variable configures how often (in seconds) Mutt-ng should look for new
- mail in IMAP folders. This is split from the ``_\bm_\ba_\bi_\bl_\b__\bc_\bh_\be_\bc_\bk (section 7.4.121 ,
- page 120)'' variable to generate less traffic and get more accurate information
- for local folders.
+159. narrow_tree
- _\b7_\b._\b4_\b._\b1_\b0_\b6 _\bi_\bm_\ba_\bp_\b__\bp_\ba_\bs_\bs
+ Type: boolean
- Type: string
+ Default: no
- Default: ''
+ This variable, when set, makes the thread tree narrower, allowing deeper threads to fit on the screen.
- Availability: IMAP
+160. nntp_ask_followup_to
- Specifies the password for your IMAP account. If _\bu_\bn_\bs_\be_\bt, Mutt-ng will prompt
- you for your password when you invoke the fetch-mail function.
+ Type: boolean
- The Mutt Next Generation E-Mail Client 115
+ Default: no
- W\bWa\bar\brn\bni\bin\bng\bg: you should only use this option when you are on a fairly secure
- machine, because the superuser can read your configuration even if you are the
- only one who can read the file.
+ Availability: NNTP
- _\b7_\b._\b4_\b._\b1_\b0_\b7 _\bi_\bm_\ba_\bp_\b__\bp_\ba_\bs_\bs_\bi_\bv_\be
+ If set, Mutt-ng will prompt you for the Followup-To: header field before editing the body of an outgoing news article.
- Type: boolean
+161. nntp_ask_x_comment_to
- Default: yes
+ Type: boolean
- Availability: IMAP
+ Default: no
- When _\bs_\be_\bt, Mutt-ng will not open new IMAP connections to check for new mail.
- Mutt-ng will only check for new mail over existing IMAP connections. This is
- useful if you don't want to be prompted to user/password pairs on Mutt-ng invo-
- cation, or if opening the connection is slow.
+ Availability: NNTP
- _\b7_\b._\b4_\b._\b1_\b0_\b8 _\bi_\bm_\ba_\bp_\b__\bp_\be_\be_\bk
+ If set, Mutt-ng will prompt you for the X-Comment-To: header field before editing the body of an outgoing news article.
- Type: boolean
+162. nntp_cache_dir
- Default: yes
+ Type: path
- Availability: IMAP
+ Default: "˜/.muttng"
- If _\bs_\be_\bt, Mutt-ng will avoid implicitly marking your mail as read whenever you
- fetch a message from the server. This is generally a good thing, but can make
- closing an IMAP folder somewhat slower. This option exists to appease speed
- freaks.
+ Availability: NNTP
- _\b7_\b._\b4_\b._\b1_\b0_\b9 _\bi_\bm_\ba_\bp_\b__\br_\be_\bc_\bo_\bn_\bn_\be_\bc_\bt
+ This variable points to directory where Mutt-ng will cache news article headers. If unset, headers will not be saved at all and will be reloaded each time when you enter a newsgroup.
- Type: quadoption
+ As for the header caching in connection with IMAP and/or Maildir, this drastically increases speed and lowers traffic.
- Default: ask-yes
+163. nntp_catchup
- Availability: IMAP
+ Type: quadoption
- Controls whether or not Mutt-ng will try to reconnect to IMAP server when the
- connection is lost.
+ Default: ask-yes
- _\b7_\b._\b4_\b._\b1_\b1_\b0 _\bi_\bm_\ba_\bp_\b__\bs_\be_\br_\bv_\be_\br_\bn_\bo_\bi_\bs_\be
+ Availability: NNTP
- Type: boolean
+ If this variable is set, Mutt-ng will mark all articles in a newsgroup as read when you leaving it.
- Default: yes
+164. nntp_context
- Availability: IMAP
+ Type: number
- When _\bs_\be_\bt, Mutt-ng will display warning messages from the IMAP server as error
- messages. Since these messages are often harmless, or generated due to configu-
- ration problems on the server which are out of the users' hands, you may wish
- to suppress them at some point.
+ Default: 1000
- The Mutt Next Generation E-Mail Client 116
+ Availability: NNTP
- _\b7_\b._\b4_\b._\b1_\b1_\b1 _\bi_\bm_\ba_\bp_\b__\bu_\bs_\be_\br
+ This variable controls how many news articles to cache per newsgroup (if caching is enabled, see $nntp_cache_dir) and how many news articles to show in the ``index'' menu.
- Type: string
+ If there're more articles than defined with $nntp_context, all older ones will be removed/not shown in the index.
- Default: ''
+165. nntp_followup_to_poster
- Availability: IMAP
+ Type: quadoption
- The name of the user whose mail you intend to access on the IMAP server.
+ Default: ask-yes
- This variable defaults to your user name on the local machine.
+ Availability: NNTP
- _\b7_\b._\b4_\b._\b1_\b1_\b2 _\bi_\bm_\bp_\bl_\bi_\bc_\bi_\bt_\b__\ba_\bu_\bt_\bo_\bv_\bi_\be_\bw
+ If this variable is set and the keyword "poster" is present in the Followup-To: header field, a follow-up to the newsgroup is not permitted. The message will be mailed to the submitter of the message via mail.
- Type: boolean
+166. nntp_group_index_format
- Default: no
+ Type: string
- If _\bs_\be_\bt, Mutt-ng will look for a mailcap entry with the ``copiousoutput'' flag
- set for _\be_\bv_\be_\br_\by MIME attachment it doesn't have an internal viewer defined for.
- If such an entry is found, Mutt-ng will use the viewer defined in that entry to
- convert the body part to text form.
+ Default: "%4C %M%N %5s %-45.45f %d"
- _\b7_\b._\b4_\b._\b1_\b1_\b3 _\bi_\bn_\bc_\bl_\bu_\bd_\be
+ Availability: NNTP
- Type: quadoption
+ This variable allows you to customize the newsgroup browser display to your personal taste. This string is similar to ``index_format'', but has its own set of printf(3)-like sequences:
+%C current newsgroup number
+%d description of newsgroup (retrieved from server)
+%f newsgroup name
+%M ``-'' if newsgroup not allowed for direct post (moderated for example)
+%N ``N'' if newsgroup is new, ``u'' if unsubscribed, blank otherwise
+%n number of new articles in newsgroup
+%s number of unread articles in newsgroup
+%>X right justify the rest of the string and pad with character "X"
+%|X pad to the end of the line with character "X"
- Default: ask-yes
+167. nntp_host
- Controls whether or not a copy of the message(s) you are replying to is
- included in your reply.
+ Type: string
- _\b7_\b._\b4_\b._\b1_\b1_\b4 _\bi_\bn_\bc_\bl_\bu_\bd_\be_\b__\bo_\bn_\bl_\by_\bf_\bi_\br_\bs_\bt
+ Default: ""
- Type: boolean
+ Availability: NNTP
- Default: no
+ This variable specifies the name (or address) of the NNTP server to be used.
- Controls whether or not Mutt-ng includes only the first attachment of the mes-
- sage you are replying.
+ It defaults to the value specified via the environment variable $NNTPSERVER or contained in the file /etc/nntpserver.
- _\b7_\b._\b4_\b._\b1_\b1_\b5 _\bi_\bn_\bd_\be_\bn_\bt_\b__\bs_\bt_\br_\bi_\bn_\bg
+ You can also specify a username and an alternative port for each newsserver, e.g.
- Type: string
+ [nntp[s]://][username[:password]@]newsserver[:port]
- Default: '> '
+ Note: Using a password as shown and stored in a configuration file presents a security risk since the superuser of your machine may read it regardless of the file's permissions.
- Specifies the string to prepend to each line of text quoted in a message to
- which you are replying. You are strongly encouraged not to change this value,
- as it tends to agitate the more fanatical netizens.
+168. nntp_inews
- _\b7_\b._\b4_\b._\b1_\b1_\b6 _\bi_\bn_\bd_\be_\bx_\b__\bf_\bo_\br_\bm_\ba_\bt
+ Type: path
- Type: string
+ Default: ""
- The Mutt Next Generation E-Mail Client 117
+ Availability: NNTP
- Default: '%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s'
+ If set, specifies the program and arguments used to deliver news posted by Mutt-ng. Otherwise, Mutt-ng posts article using current connection. The following printf(3)-style sequence is understood:
+%s newsserver name
- This variable allows you to customize the message index display to your per-
- sonal taste.
+ Example: set inews="/usr/local/bin/inews -hS"
- ``Format strings'' are similar to the strings used in the ``C'' function
- printf(3) to format output (see the man page for more detail). The following
- sequences are defined in Mutt-ng:
+169. nntp_load_description
- %a
- address of the author
+ Type: boolean
- %A
- reply-to address (if present; otherwise: address of author)
+ Default: yes
- %b
- filename of the original message folder (think mailBox)
+ Availability: NNTP
- %B
- the list to which the letter was sent, or else the folder name
- (%b).
+ This variable controls whether or not descriptions for newsgroups are to be loaded when subscribing to a newsgroup.
- %c
- number of characters (bytes) in the message
+170. nntp_mail_check
- %C
- current message number
+ Type: number
- %d
- date and time of the message in the format specified by ``date_for-
- mat'' converted to sender's time zone
+ Default: 60
- %D
- date and time of the message in the format specified by ``date_for-
- mat'' converted to the local time zone
+ Availability: NNTP
- %e
- current message number in thread
+ The time in seconds until any operations on a newsgroup except posting a new article will cause a recheck for new news. If set to 0, Mutt-ng will recheck on each operation in index (stepping, read article, etc.).
- %E
- number of messages in current thread
+171. nntp_mime_subject
- %f
- entire From: line (address + real name)
+ Type: boolean
- %F
- author name, or recipient name if the message is from you
+ Default: yes
- %H
- spam attribute(s) of this message
+ Availability: NNTP
- %g
- newsgroup name (if compiled with nntp support)
+ If unset, an 8-bit ``Subject:'' header field in a news article will not be encoded according to RFC2047.
- The Mutt Next Generation E-Mail Client 118
+ Note: Only change this setting if you know what you are doing.
- %i
- message-id of the current message
+172. nntp_newsrc
- %l
- number of lines in the message (does not work with maildir, mh, and
- possibly IMAP folders)
+ Type: path
- %L
- If an address in the To or CC header field matches an address
- defined by the users ``subscribe'' command, this displays 'To
- <list-name>', otherwise the same as %F.
+ Default: "˜/.newsrc"
- %m
- total number of message in the mailbox
+ Availability: NNTP
- %M
- number of hidden messages if the thread is collapsed.
+ This file contains information about subscribed newsgroup and articles read so far.
- %N
- message score
+ To ease the use of multiple news servers, the following printf(3)-style sequence is understood:
+%s newsserver name
- %n
- author's real name (or address if missing)
+173. nntp_pass
- %O
- (_O_riginal save folder) Where Mutt-ng would formerly have stashed
- the message: list name or recipient name if no list
+ Type: string
- %s
- subject of the message
+ Default: ""
- %S
- status of the message (N/D/d/!/r/*)
+ Availability: NNTP
- %t
- `to:' field (recipients)
+ Your password for NNTP account.
- %T
- the appropriate character from the _\b$_\bt_\bo_\b__\bc_\bh_\ba_\br_\bs (section 7.4.339 ,
- page 172) string
+ Note: Storing passwords in a configuration file presents a security risk since the superuser of your machine may read it regardless of the file's permissions.
- %u
- user (login) name of the author
+174. nntp_post_moderated
- %v
- first name of the author, or the recipient if the message is from
- you
+ Type: quadoption
- %W
- name of organization of author (`organization:' field)
+ Default: ask-yes
- %y
- `x-label:' field, if present
+ Availability: NNTP
- The Mutt Next Generation E-Mail Client 119
+ If set to yes, Mutt-ng will post articles to newsgroup that have not permissions to post (e.g. moderated).
- %Y
- `x-label' field, if present, and (1) not at part of a thread tree,
- (2) at the top of a thread, or (3) `x-label' is different from pre-
- ceding message's `x-label'.
+ Note: if the newsserver does not support posting to that newsgroup or a group is totally read-only, that posting will not have any effect.
- %Z
- message status flags
+175. nntp_reconnect
- %{fmt}
- the date and time of the message is converted to sender's time
- zone, and ``fmt'' is expanded by the library function ``strftime'';
- a leading bang disables locales
+ Type: quadoption
- %[fmt]
- the date and time of the message is converted to the local time
- zone, and ``fmt'' is expanded by the library function ``strftime'';
- a leading bang disables locales
+ Default: ask-yes
- %(fmt)
- the local date and time when the message was received. ``fmt'' is
- expanded by the library function ``strftime''; a leading bang dis-
- ables locales
+ Availability: NNTP
- %<fmt>
- the current local time. ``fmt'' is expanded by the library function
- ``strftime''; a leading bang disables locales.
+ Controls whether or not Mutt-ng will try to reconnect to a newsserver when the was connection lost.
- %>X
- right justify the rest of the string and pad with character 'X'
+176. nntp_save_unsubscribed
- %|X
- pad to the end of the line with character 'X'
+ Type: boolean
- See also: ``_\b$_\bt_\bo_\b__\bc_\bh_\ba_\br_\bs (section 7.4.339 , page 172)''.
+ Default: no
- _\b7_\b._\b4_\b._\b1_\b1_\b7 _\bi_\bs_\bp_\be_\bl_\bl
+ Availability: NNTP
- Type: path
+ When set, info about unsubscribed newsgroups will be saved into the ``newsrc'' file and into the news cache.
- Default: 'ispell'
+177. nntp_show_new_news
- How to invoke ispell (GNU's spell-checking software).
+ Type: boolean
- _\b7_\b._\b4_\b._\b1_\b1_\b8 _\bk_\be_\be_\bp_\b__\bf_\bl_\ba_\bg_\bg_\be_\bd
+ Default: yes
- Type: boolean
+ Availability: NNTP
- Default: no
+ If set, the newsserver will be asked for new newsgroups on entering the browser. Otherwise, it will be done only once for a newsserver. Also controls whether or not the number of new articles of subscribed newsgroups will be checked.
- If _\bs_\be_\bt, read messages marked as flagged will not be moved from your spool mail-
- box to your ``_\b$_\bm_\bb_\bo_\bx (section 7.4.131 , page 122)'' mailbox, or as a result of
- a ``_\bm_\bb_\bo_\bx_\b-_\bh_\bo_\bo_\bk (section 3.14 , page 37)'' command.
+178. nntp_show_only_unread
- The Mutt Next Generation E-Mail Client 120
+ Type: boolean
- _\b7_\b._\b4_\b._\b1_\b1_\b9 _\bl_\bi_\bs_\bt_\b__\br_\be_\bp_\bl_\by
+ Default: no
- Type: quadoption
+ Availability: NNTP
- Default: no
+ If set, only subscribed newsgroups that contain unread articles will be displayed in the newsgroup browser.
- When _\bs_\be_\bt, address replies to the mailing list the original message came from
- (instead to the author only). Setting this option to ``_\ba_\bs_\bk_\b-_\by_\be_\bs'' or ``_\ba_\bs_\bk_\b-_\bn_\bo''
- will ask if you really intended to reply to the author only.
+179. nntp_user
- _\b7_\b._\b4_\b._\b1_\b2_\b0 _\bl_\bo_\bc_\ba_\bl_\be
+ Type: string
- Type: string
+ Default: ""
- Default: 'C'
+ Availability: NNTP
- The locale used by strftime(3) to format dates. Legal values are the strings
- your system accepts for the locale variable LC_TIME.
+ Your login name on the NNTP server. If unset and the server requires authentification, Mutt-ng will prompt you for your account name.
- _\b7_\b._\b4_\b._\b1_\b2_\b1 _\bm_\ba_\bi_\bl_\b__\bc_\bh_\be_\bc_\bk
+180. nntp_x_comment_to
- Type: number
+ Type: boolean
- Default: 5
+ Default: no
- This variable configures how often (in seconds) Mutt-ng should look for new
- mail.
+ Availability: NNTP
- N\bNo\bot\bte\be:\b: This does not apply to IMAP mailboxes, see _\b$_\bi_\bm_\ba_\bp_\b__\bm_\ba_\bi_\bl_\b__\bc_\bh_\be_\bc_\bk (section
- 7.4.105 , page 114).
+ If set, Mutt-ng will add a ``X-Comment-To:'' header field (that contains full name of the original article author) to articles that you followup to.
- _\b7_\b._\b4_\b._\b1_\b2_\b2 _\bm_\ba_\bi_\bl_\bc_\ba_\bp_\b__\bp_\ba_\bt_\bh
+181. operating_system
- Type: string
+ Type: string
- Default: ''
+ Default: ""
- This variable specifies which files to consult when attempting to display MIME
- bodies not directly supported by Mutt-ng.
+ This specifies the operating system name for the User-Agent: header field. If this is unset, it will be set to the operating system name that uname(2) returns. If uname(2) fails, ``UNIX'' will be used.
- _\b7_\b._\b4_\b._\b1_\b2_\b3 _\bm_\ba_\bi_\bl_\bc_\ba_\bp_\b__\bs_\ba_\bn_\bi_\bt_\bi_\bz_\be
+ It may, for example, look as: ``mutt-ng 1.5.9i (Linux)''.
- Type: boolean
+182. pager
- Default: yes
+ Type: path
- If _\bs_\be_\bt, Mutt-ng will restrict possible characters in mailcap % expandos to a
- well-defined set of safe characters. This is the safe setting, but we are not
- sure it doesn't break some more advanced MIME stuff.
+ Default: "builtin"
- D\bDO\bON\bN'\b'T\bT C\bCH\bHA\bAN\bNG\bGE\bE T\bTH\bHI\bIS\bS S\bSE\bET\bTT\bTI\bIN\bNG\bG U\bUN\bNL\bLE\bES\bSS\bS Y\bYO\bOU\bU A\bAR\bRE\bE R\bRE\bEA\bAL\bLL\bLY\bY S\bSU\bUR\bRE\bE W\bWH\bHA\bAT\bT Y\bYO\bOU\bU A\bAR\bRE\bE D\bDO\bOI\bIN\bNG\bG!\b!
+ This variable specifies which pager you would like to use to view messages. ``builtin'' means to use the builtin pager, otherwise this variable should specify the pathname of the external pager you would like to use.
- _\b7_\b._\b4_\b._\b1_\b2_\b4 _\bm_\ba_\bi_\bl_\bd_\bi_\br_\b__\bh_\be_\ba_\bd_\be_\br_\b__\bc_\ba_\bc_\bh_\be_\b__\bv_\be_\br_\bi_\bf_\by
+ Using an external pager may have some disadvantages: Additional keystrokes are necessary because you can't call Mutt-ng functions directly from the pager, and screen resizes cause lines longer than the screen width to be badly formatted in the help menu.
- The Mutt Next Generation E-Mail Client 121
+183. pager_context
- Type: boolean
+ Type: number
- Default: yes
+ Default: 0
- Availability: Header Cache
+ This variable controls the number of lines of context that are given when displaying the next or previous page in the internal pager. By default, Mutt-ng will display the line after the last one on the screen at the top of the next page (0 lines of context).
- Check for Maildir unaware programs other than Mutt-ng having modified maildir
- files when the header cache is in use. This incurs one stat(2) per message
- every time the folder is opened.
+184. pager_format
- _\b7_\b._\b4_\b._\b1_\b2_\b5 _\bm_\ba_\bi_\bl_\bd_\bi_\br_\b__\bt_\br_\ba_\bs_\bh
+ Type: string
- Type: boolean
+ Default: "-%Z- %C/%m: %-20.20n %s"
- Default: no
+ This variable controls the format of the one-line message ``status'' displayed before each message in either the internal or an external pager. The valid sequences are listed in the ``$index_format'' section.
- If _\bs_\be_\bt, messages marked as deleted will be saved with the maildir (T)rashed
- flag instead of physically deleted.
+185. pager_index_lines
- N\bNO\bOT\bTE\bE:\b: this only applies to maildir-style mailboxes. Setting it will have no
- effect on other mailbox types.
+ Type: number
- It is similiar to the trash option.
+ Default: 0
- _\b7_\b._\b4_\b._\b1_\b2_\b6 _\bm_\ba_\br_\bk_\b__\bo_\bl_\bd
+ Determines the number of lines of a mini-index which is shown when in the pager. The current message, unless near the top or bottom of the folder, will be roughly one third of the way down this mini-index, giving the reader the context of a few messages before and after the message. This is useful, for example, to determine how many messages remain to be read in the current thread. One of the lines is reserved for the status bar from the index, so a pager_index_lines of 6 will only show 5 lines of the actual index. A value of 0 results in no index being shown. If the number of messages in the current folder is less than pager_index_lines, then the index will only use as many lines as it needs.
- Type: boolean
+186. pager_stop
- Default: yes
+ Type: boolean
- Controls whether or not Mutt-ng marks _\bn_\be_\bw u\bun\bnr\bre\bea\bad\bd messages as _\bo_\bl_\bd if you exit a
- mailbox without reading them.
+ Default: no
- With this option _\bs_\be_\bt, the next time you start Mutt-ng, the messages will show
- up with an 'O' next to them in the ``index'' menu, indicating that they are
- old.
+ When set, the internal-pager will not move to the next message when you are at the end of a message and invoke the next-page function.
- _\b7_\b._\b4_\b._\b1_\b2_\b7 _\bm_\ba_\br_\bk_\be_\br_\bs
+187. pgp_auto_decode
- Type: boolean
+ Type: boolean
- Default: yes
+ Default: no
- Controls the display of wrapped lines in the internal pager. If set, a ``+''
- marker is displayed at the beginning of wrapped lines. Also see the
- ``_\b$_\bs_\bm_\ba_\br_\bt_\b__\bw_\br_\ba_\bp (section 7.4.279 , page 156)'' variable.
+ If set, Mutt-ng will automatically attempt to decrypt traditional PGP messages whenever the user performs an operation which ordinarily would result in the contents of the message being operated on. For example, if the user displays a pgp-traditional message which has not been manually checked with the check-traditional-pgp function, Mutt-ng will automatically check the message for traditional pgp.
- _\b7_\b._\b4_\b._\b1_\b2_\b8 _\bm_\ba_\bs_\bk
+188. pgp_autoinline
- Type: regular expression
+ Type: boolean
- Default: '!^\.[^.]'
+ Default: no
- A regular expression used in the file browser, optionally preceded by the _\bn_\bo_\bt
+ This option controls whether Mutt-ng generates old-style inline (traditional) PGP encrypted or signed messages under certain circumstances. This can be overridden by use of the pgp-menu, when inline is not required.
- The Mutt Next Generation E-Mail Client 122
+ Note that Mutt-ng might automatically use PGP/MIME for messages which consist of more than a single MIME part. Mutt-ng can be configured to ask before sending PGP/MIME messages when inline (traditional) would not work. See also: ``$pgp_mime_auto''.
- operator ``!''. Only files whose names match this mask will be shown. The
- match is always case-sensitive.
+ Also note that using the old-style PGP message format is strongly deprecated. (PGP only)
- _\b7_\b._\b4_\b._\b1_\b2_\b9 _\bm_\ba_\bx_\b__\bd_\bi_\bs_\bp_\bl_\ba_\by_\b__\br_\be_\bc_\bi_\bp_\bs
+189. pgp_check_exit
- Type: number
+ Type: boolean
- Default: 0
+ Default: yes
- When set non-zero, this specifies the maximum number of recipient header lines
- (To:, Cc: and Bcc:) to display in the pager if header weeding is turned on. In
- case the number of lines exeeds its value, the last line will have 3 dots
- appended.
+ If set, Mutt-ng will check the exit code of the PGP subprocess when signing or encrypting. A non-zero exit code means that the subprocess failed. (PGP only)
- _\b7_\b._\b4_\b._\b1_\b3_\b0 _\bm_\ba_\bx_\b__\bl_\bi_\bn_\be_\b__\bl_\be_\bn_\bg_\bt_\bh
+190. pgp_clearsign_command
- Type: number
+ Type: string
- Default: 0
+ Default: ""
- When _\bs_\be_\bt, the maximum line length for displaying ``format = flowed'' messages
- is limited to this length. A value of 0 (which is also the default) means that
- the maximum line length is determined by the terminal width and _\b$_\bw_\br_\ba_\bp_\bm_\ba_\br_\bg_\bi_\bn
- (section 7.4.353 , page 175).
+ This format is used to create a old-style ``clearsigned'' PGP message.
- _\b7_\b._\b4_\b._\b1_\b3_\b1 _\bm_\bb_\bo_\bx
+ Note that the use of this format is strongly deprecated. (PGP only)
- Type: path
+191. pgp_decode_command
- Default: '~/mbox'
+ Type: string
- This specifies the folder into which read mail in your ``_\b$_\bs_\bp_\bo_\bo_\bl_\bf_\bi_\bl_\be (section
- 7.4.313 , page 165)'' folder will be appended.
+ Default: ""
- _\b7_\b._\b4_\b._\b1_\b3_\b2 _\bm_\bb_\bo_\bx_\b__\bt_\by_\bp_\be
+ This format strings specifies a command which is used to decode application/pgp attachments.
- Type: folder magic
+ The PGP command formats have their own set of printf(3)-like sequences:
- Default: mbox
+ %p
+ Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty string otherwise. Note: This may be used with a %? construct.
- The default mailbox type used when creating new folders. May be any of mbox,
- MMDF, MH and Maildir.
+ %f
+ Expands to the name of a file containing a message.
- _\b7_\b._\b4_\b._\b1_\b3_\b3 _\bm_\be_\bn_\bu_\b__\bc_\bo_\bn_\bt_\be_\bx_\bt
+ %s
+ Expands to the name of a file containing the signature part of a multipart/signed attachment when verifying it.
- Type: number
+ %a
+ The value of $pgp_sign_as.
- Default: 0
+ %r
+ One or more key IDs.
- This variable controls the number of lines of context that are given when
- scrolling through menus. (Similar to ``_\b$_\bp_\ba_\bg_\be_\br_\b__\bc_\bo_\bn_\bt_\be_\bx_\bt (section 7.4.183 , page
- 134)''.)
+ For examples on how to configure these formats for the various versions of PGP which are floating around, see the pgp*.rc and gpg.rc files in the samples/ subdirectory which has been installed on your system alongside the documentation. (PGP only)
- The Mutt Next Generation E-Mail Client 123
+192. pgp_decrypt_command
- _\b7_\b._\b4_\b._\b1_\b3_\b4 _\bm_\be_\bn_\bu_\b__\bm_\bo_\bv_\be_\b__\bo_\bf_\bf
+ Type: string
- Type: boolean
+ Default: ""
- Default: yes
+ This command is used to decrypt a PGP encrypted message. (PGP only)
- When _\bu_\bn_\bs_\be_\bt, the bottom entry of menus will never scroll up past the bottom of
- the screen, unless there are less entries than lines. When _\bs_\be_\bt, the bottom
- entry may move off the bottom.
+193. pgp_encrypt_only_command
- _\b7_\b._\b4_\b._\b1_\b3_\b5 _\bm_\be_\bn_\bu_\b__\bs_\bc_\br_\bo_\bl_\bl
+ Type: string
- Type: boolean
+ Default: ""
- Default: no
+ This command is used to encrypt a body part without signing it. (PGP only)
- When _\bs_\be_\bt, menus will be scrolled up or down one line when you attempt to move
- across a screen boundary. If _\bu_\bn_\bs_\be_\bt, the screen is cleared and the next or pre-
- vious page of the menu is displayed (useful for slow links to avoid many
- redraws).
+194. pgp_encrypt_sign_command
- _\b7_\b._\b4_\b._\b1_\b3_\b6 _\bm_\be_\bs_\bs_\ba_\bg_\be_\b__\bf_\bo_\br_\bm_\ba_\bt
+ Type: string
- Type: string
+ Default: ""
- Default: '%s'
+ This command is used to both sign and encrypt a body part. (PGP only)
- This is the string displayed in the ``attachment'' menu for attachments of type
- message/rfc822. For a full listing of defined printf(3)-like sequences see the
- section on ``_\b$_\bi_\bn_\bd_\be_\bx_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.116 , page 116)''.
+195. pgp_entry_format
- _\b7_\b._\b4_\b._\b1_\b3_\b7 _\bm_\be_\bt_\ba_\b__\bk_\be_\by
+ Type: string
- Type: boolean
+ Default: "%4n %t%f %4l/0x%k %-4a %2c %u"
- Default: no
+ This variable allows you to customize the PGP key selection menu to your personal taste. This string is similar to ``$index_format'', but has its own set of printf(3)-like sequences:
- If _\bs_\be_\bt, forces Mutt-ng to interpret keystrokes with the high bit (bit 8) set as
- if the user had pressed the ESC key and whatever key remains after having the
- high bit removed. For example, if the key pressed has an ASCII value of 0xf4,
- then this is treated as if the user had pressed ESC then ``x''. This is
- because the result of removing the high bit from ``0xf4'' is ``0x74'', which is
- the ASCII character ``x''.
+ %n
+ number
- _\b7_\b._\b4_\b._\b1_\b3_\b8 _\bm_\be_\bt_\bo_\bo
+ %k
+ key id
- Type: boolean
+ %u
+ user id
- Default: no
+ %a
+ algorithm
- If _\bu_\bn_\bs_\be_\bt, Mutt-ng will remove your address (see the ``alternates'' command)
- from the list of recipients when replying to a message.
+ %l
+ key length
- The Mutt Next Generation E-Mail Client 124
+ %f
+ flags
- _\b7_\b._\b4_\b._\b1_\b3_\b9 _\bm_\bh_\b__\bp_\bu_\br_\bg_\be
+ %c
+ capabilities
- Type: boolean
+ %t
+ trust/validity of the key-uid association
- Default: no
+ %[<s>]
+ date of the key where <s> is an strftime(3) expression
- When _\bu_\bn_\bs_\be_\bt, Mutt-ng will mimic mh's behaviour and rename deleted messages to
- _\b,_\b<_\bo_\bl_\bd _\bf_\bi_\bl_\be _\bn_\ba_\bm_\be_\b> in mh folders instead of really deleting them. If the vari-
- able is set, the message files will simply be deleted.
+ (PGP only)
- _\b7_\b._\b4_\b._\b1_\b4_\b0 _\bm_\bh_\b__\bs_\be_\bq_\b__\bf_\bl_\ba_\bg_\bg_\be_\bd
+196. pgp_export_command
- Type: string
+ Type: string
- Default: 'flagged'
+ Default: ""
- The name of the MH sequence used for flagged messages.
+ This command is used to export a public key from the user's key ring. (PGP only)
- _\b7_\b._\b4_\b._\b1_\b4_\b1 _\bm_\bh_\b__\bs_\be_\bq_\b__\br_\be_\bp_\bl_\bi_\be_\bd
+197. pgp_getkeys_command
- Type: string
+ Type: string
- Default: 'replied'
+ Default: ""
- The name of the MH sequence used to tag replied messages.
+ This command is invoked whenever Mutt-ng will need public key information. %r is the only printf(3)-like sequence used with this format. (PGP only)
- _\b7_\b._\b4_\b._\b1_\b4_\b2 _\bm_\bh_\b__\bs_\be_\bq_\b__\bu_\bn_\bs_\be_\be_\bn
+198. pgp_good_sign
- Type: string
+ Type: regular expression
- Default: 'unseen'
+ Default: ""
- The name of the MH sequence used for unseen messages.
+ If you assign a text to this variable, then a PGP signature is only considered verified if the output from $pgp_verify_command contains the text. Use this variable if the exit code from the command is 0 even for bad signatures. (PGP only)
- _\b7_\b._\b4_\b._\b1_\b4_\b3 _\bm_\bi_\bm_\be_\b__\bf_\bo_\br_\bw_\ba_\br_\bd
+199. pgp_ignore_subkeys
- Type: quadoption
+ Type: boolean
- Default: no
+ Default: yes
- When _\bs_\be_\bt, the message you are forwarding will be attached as a separate MIME
- part instead of included in the main body of the message.
+ Setting this variable will cause Mutt-ng to ignore OpenPGP subkeys. Instead, the principal key will inherit the subkeys' capabilities. Unset this if you want to play interesting key selection games. (PGP only)
- This is useful for forwarding MIME messages so the receiver can properly view
- the message as it was delivered to you. If you like to switch between MIME and
- not MIME from mail to mail, set this variable to ask-no or ask-yes.
+200. pgp_import_command
- Also see ``_\b$_\bf_\bo_\br_\bw_\ba_\br_\bd_\b__\bd_\be_\bc_\bo_\bd_\be (section 7.4.75 , page 107)'' and ``_\b$_\bm_\bi_\bm_\be_\b__\bf_\bo_\br_\b-
- _\bw_\ba_\br_\bd_\b__\bd_\be_\bc_\bo_\bd_\be (section 7.4.144 , page 124)''.
+ Type: string
- _\b7_\b._\b4_\b._\b1_\b4_\b4 _\bm_\bi_\bm_\be_\b__\bf_\bo_\br_\bw_\ba_\br_\bd_\b__\bd_\be_\bc_\bo_\bd_\be
+ Default: ""
- Type: boolean
+ This command is used to import a key from a message into the user's public key ring. (PGP only)
- The Mutt Next Generation E-Mail Client 125
+201. pgp_list_pubring_command
- Default: no
+ Type: string
- Controls the decoding of complex MIME messages into text/plain when forwarding
- a message while ``_\b$_\bm_\bi_\bm_\be_\b__\bf_\bo_\br_\bw_\ba_\br_\bd (section 7.4.143 , page 124)'' is _\bs_\be_\bt. Other-
- wise ``_\b$_\bf_\bo_\br_\bw_\ba_\br_\bd_\b__\bd_\be_\bc_\bo_\bd_\be (section 7.4.75 , page 107)'' is used instead.
+ Default: ""
- _\b7_\b._\b4_\b._\b1_\b4_\b5 _\bm_\bi_\bm_\be_\b__\bf_\bo_\br_\bw_\ba_\br_\bd_\b__\br_\be_\bs_\bt
+ This command is used to list the public key ring's contents. The output format must be analogous to the one used by gpg --list-keys --with-colons.
- Type: quadoption
+ This format is also generated by the pgpring utility which comes with Mutt-ng. (PGP only)
- Default: yes
+202. pgp_list_secring_command
- When forwarding multiple attachments of a MIME message from the recvattach
- menu, attachments which cannot be decoded in a reasonable manner will be
- attached to the newly composed message if this option is set.
+ Type: string
- _\b7_\b._\b4_\b._\b1_\b4_\b6 _\bm_\bi_\bx_\b__\be_\bn_\bt_\br_\by_\b__\bf_\bo_\br_\bm_\ba_\bt
+ Default: ""
- Type: string
+ This command is used to list the secret key ring's contents. The output format must be analogous to the one used by gpg --list-keys --with-colons.
- Default: '%4n %c %-16s %a'
+ This format is also generated by the pgpring utility which comes with Mutt-ng. (PGP only)
- Availability: Mixmaster
+203. pgp_long_ids
- This variable describes the format of a remailer line on the mixmaster chain
- selection screen. The following printf(3)-like sequences are supported:
+ Type: boolean
- %n
- The running number on the menu.
+ Default: no
- %c
- Remailer capabilities.
+ If set, use 64 bit PGP key IDs. Unset uses the normal 32 bit Key IDs. (PGP only)
- %s
- The remailer's short name.
+204. pgp_mime_auto
- %a
- The remailer's e-mail address.
+ Type: quadoption
- _\b7_\b._\b4_\b._\b1_\b4_\b7 _\bm_\bi_\bx_\bm_\ba_\bs_\bt_\be_\br
+ Default: ask-yes
- Type: path
+ This option controls whether Mutt-ng will prompt you for automatically sending a (signed/encrypted) message using PGP/MIME when inline (traditional) fails (for any reason).
- Default: 'mixmaster'
+ Also note that using the old-style PGP message format is strongly deprecated. (PGP only)
- Availability: Mixmaster
+205. pgp_replyinline
- This variable contains the path to the Mixmaster binary on your system. It is
- used with various sets of parameters to gather the list of known remailers, and
- to finally send a message through the mixmaster chain.
+ Type: boolean
- _\b7_\b._\b4_\b._\b1_\b4_\b8 _\bm_\bo_\bv_\be
+ Default: no
- Type: quadoption
+ Setting this variable will cause Mutt-ng to always attempt to create an inline (traditional) message when replying to a message which is PGP encrypted/signed inline. This can be overridden by use of the pgp-menu, when inline is not required. This option does not automatically detect if the (replied-to) message is inline; instead it relies on Mutt-ng internals for previously checked/flagged messages.
- The Mutt Next Generation E-Mail Client 126
+ Note that Mutt-ng might automatically use PGP/MIME for messages which consist of more than a single MIME part. Mutt-ng can be configured to ask before sending PGP/MIME messages when inline (traditional) would not work. See also: ``$pgp_mime_auto''.
- Default: ask-no
+ Also note that using the old-style PGP message format is strongly deprecated. (PGP only)
- Controls whether or not Mutt-ng will move read messages from your spool mailbox
- to your ``_\b$_\bm_\bb_\bo_\bx (section 7.4.131 , page 122)'' mailbox, or as a result of a
- ``_\bm_\bb_\bo_\bx_\b-_\bh_\bo_\bo_\bk (section 3.14 , page 37)'' command.
+206. pgp_retainable_sigs
- _\b7_\b._\b4_\b._\b1_\b4_\b9 _\bm_\bs_\bg_\bi_\bd_\b__\bf_\bo_\br_\bm_\ba_\bt
+ Type: boolean
- Type: string
+ Default: no
- Default: '%Y%m%d%h%M%s.G%P%p'
+ If set, signed and encrypted messages will consist of nested multipart/signed and multipart/encrypted body parts.
- This is the format for the ``local part'' of the Message-Id: header field gen-
- erated by Mutt-ng. If this variable is empty, no Message-Id: headers will be
- generated. The '%' character marks that certain data will be added to the
- string, similar to printf(3). The following characters are allowed:
+ This is useful for applications like encrypted and signed mailing lists, where the outer layer (multipart/encrypted) can be easily removed, while the inner multipart/signed part is retained. (PGP only)
- %d
- the current day of month
+207. pgp_show_unusable
- %h
- the current hour
+ Type: boolean
- %m
- the current month
+ Default: yes
- %M
- the current minute
+ If set, Mutt-ng will display non-usable keys on the PGP key selection menu. This includes keys which have been revoked, have expired, or have been marked as ``disabled'' by the user. (PGP only)
- %O
- the current UNIX timestamp (octal)
+208. pgp_sign_as
- %p
- the process ID
+ Type: string
- %P
- the current Message-ID prefix (a character rotating with every Mes-
- sage-ID being generated)
+ Default: ""
- %r
- a random integer value (decimal)
+ If you have more than one key pair, this option allows you to specify which of your private keys to use. It is recommended that you use the keyid form to specify your key (e.g., ``0x00112233''). (PGP only)
- %R
- a random integer value (hexadecimal)
+209. pgp_sign_command
- %s
- the current second
+ Type: string
- %T
- the current UNIX timestamp (decimal)
+ Default: ""
- %X
- the current UNIX timestamp (hexadecimal)
+ This command is used to create the detached PGP signature for a multipart/signed PGP/MIME body part. (PGP only)
- The Mutt Next Generation E-Mail Client 127
+210. pgp_sort_keys
- %Y
- the current year (Y2K compliant)
+ Type: sort order
- %%
- the '%' character
+ Default: address
- N\bNo\bot\bte\be:\b: Please only change this setting if you know what you are doing. Also
- make sure to consult RFC2822 to produce technically _\bv_\ba_\bl_\bi_\bd strings.
+ Specifies how the entries in the ``pgp keys'' menu are sorted. The following are legal values:
- _\b7_\b._\b4_\b._\b1_\b5_\b0 _\bm_\bu_\bt_\bt_\bn_\bg_\b__\bb_\bi_\bn_\bd_\bi_\br
+ address
+ sort alphabetically by user id
- Type: system property
+ keyid
+ sort alphabetically by key id
- Value: /opt/freebsd4/mutt-ng/bin
+ date
+ sort by key creation date
- _\bT_\bh_\bi_\bs _\bi_\bs _\ba _\br_\be_\ba_\bd_\b-_\bo_\bn_\bl_\by _\bs_\by_\bs_\bt_\be_\bm _\bp_\br_\bo_\bp_\be_\br_\bt_\by _\ba_\bn_\bd _\bs_\bp_\be_\bc_\bi_\bf_\bi_\be_\bs _\bt_\bh_\be _\bd_\bi_\br_\be_\bc_\bt_\bo_\br_\by _\bc_\bo_\bn_\bt_\ba_\bi_\bn_\bi_\bn_\bg _\bt_\bh_\be
- _\bm_\bu_\bt_\bt_\bn_\bg _\bb_\bi_\bn_\ba_\br_\by_\b.
+ trust
+ sort by the trust of the key
- _\b7_\b._\b4_\b._\b1_\b5_\b1 _\bm_\bu_\bt_\bt_\bn_\bg_\b__\bd_\bo_\bc_\bd_\bi_\br
+ If you prefer reverse order of the above values, prefix it with ``reverse-''. (PGP only)
- Type: system property
+211. pgp_strict_enc
- Value: /opt/freebsd4/mutt-ng/doc/muttng
+ Type: boolean
- _\bT_\bh_\bi_\bs _\bi_\bs _\ba _\br_\be_\ba_\bd_\b-_\bo_\bn_\bl_\by _\bs_\by_\bs_\bt_\be_\bm _\bp_\br_\bo_\bp_\be_\br_\bt_\by _\ba_\bn_\bd _\bs_\bp_\be_\bc_\bi_\bf_\bi_\be_\bs _\bt_\bh_\be _\bd_\bi_\br_\be_\bc_\bt_\bo_\br_\by _\bc_\bo_\bn_\bt_\ba_\bi_\bn_\bi_\bn_\bg _\bt_\bh_\be
- _\bm_\bu_\bt_\bt_\bn_\bg _\bd_\bo_\bc_\bu_\bm_\be_\bn_\bt_\ba_\bt_\bi_\bo_\bn_\b.
+ Default: yes
- _\b7_\b._\b4_\b._\b1_\b5_\b2 _\bm_\bu_\bt_\bt_\bn_\bg_\b__\bf_\bo_\bl_\bd_\be_\br_\b__\bn_\ba_\bm_\be
+ If set, Mutt-ng will automatically encode PGP/MIME signed messages as quoted-printable. Please note that unsetting this variable may lead to problems with non-verifyable PGP signatures, so only change this if you know what you are doing. (PGP only)
- Type: system property
+212. pgp_timeout
- Value:
+ Type: number
- _\bT_\bh_\bi_\bs _\bi_\bs _\ba _\br_\be_\ba_\bd_\b-_\bo_\bn_\bl_\by _\bs_\by_\bs_\bt_\be_\bm _\bp_\br_\bo_\bp_\be_\br_\bt_\by _\ba_\bn_\bd_\b, _\ba_\bt _\br_\bu_\bn_\bt_\bi_\bm_\be_\b, _\bs_\bp_\be_\bc_\bi_\bf_\bi_\be_\bs _\bt_\bh_\be _\bl_\ba_\bs_\bt _\bp_\ba_\br_\bt _\bo_\bf
- _\bt_\bh_\be _\bf_\bu_\bl_\bl _\bp_\ba_\bt_\bh _\bo_\br _\bU_\bR_\bI _\bo_\bf _\bt_\bh_\be _\bf_\bo_\bl_\bd_\be_\br _\bc_\bu_\br_\br_\be_\bn_\bt_\bl_\by _\bo_\bp_\be_\bn _\b(_\bi_\bf _\ba_\bn_\by_\b)_\b, _\bi_\b._\be_\b. _\be_\bv_\be_\br_\by_\bt_\bh_\bi_\bn_\bg
- _\ba_\bf_\bt_\be_\br _\bt_\bh_\be _\bl_\ba_\bs_\bt _\b`_\b`_\b/_\b'_\b'_\b.
+ Default: 300
- _\b7_\b._\b4_\b._\b1_\b5_\b3 _\bm_\bu_\bt_\bt_\bn_\bg_\b__\bf_\bo_\bl_\bd_\be_\br_\b__\bp_\ba_\bt_\bh
+ The number of seconds after which a cached passphrase will expire if not used. Default: 300. (PGP only)
- Type: system property
+213. pgp_use_gpg_agent
- Value:
+ Type: boolean
- _\bT_\bh_\bi_\bs _\bi_\bs _\ba _\br_\be_\ba_\bd_\b-_\bo_\bn_\bl_\by _\bs_\by_\bs_\bt_\be_\bm _\bp_\br_\bo_\bp_\be_\br_\bt_\by _\ba_\bn_\bd_\b, _\ba_\bt _\br_\bu_\bn_\bt_\bi_\bm_\be_\b, _\bs_\bp_\be_\bc_\bi_\bf_\bi_\be_\bs _\bt_\bh_\be _\bf_\bu_\bl_\bl _\bp_\ba_\bt_\bh _\bo_\br
- _\bU_\bR_\bI _\bo_\bf _\bt_\bh_\be _\bf_\bo_\bl_\bd_\be_\br _\bc_\bu_\br_\br_\be_\bn_\bt_\bl_\by _\bo_\bp_\be_\bn _\b(_\bi_\bf _\ba_\bn_\by_\b)_\b.
+ Default: no
- _\b7_\b._\b4_\b._\b1_\b5_\b4 _\bm_\bu_\bt_\bt_\bn_\bg_\b__\bh_\bc_\ba_\bc_\bh_\be_\b__\bb_\ba_\bc_\bk_\be_\bn_\bd
+ If set, Mutt-ng will use a possibly-running gpg-agent process. (PGP only)
- Type: system property
+214. pgp_verify_command
- Value: qdbm
+ Type: string
- _\bT_\bh_\bi_\bs _\bi_\bs _\ba _\br_\be_\ba_\bd_\b-_\bo_\bn_\bl_\by _\bs_\by_\bs_\bt_\be_\bm _\bp_\br_\bo_\bp_\be_\br_\bt_\by _\ba_\bn_\bd _\bs_\bp_\be_\bc_\bi_\bf_\bi_\be_\bs _\bt_\bh_\be _\bh_\be_\ba_\bd_\be_\br _\bc_\bh_\ba_\bc_\bh_\bi_\bn_\bg_\b'_\bs _\bd_\ba_\bt_\ba_\b-
- _\bb_\ba_\bs_\be _\bb_\ba_\bc_\bk_\be_\bn_\bd_\b.
+ Default: ""
- The Mutt Next Generation E-Mail Client 128
+ This command is used to verify PGP signatures. (PGP only)
- _\b7_\b._\b4_\b._\b1_\b5_\b5 _\bm_\bu_\bt_\bt_\bn_\bg_\b__\bp_\bw_\bd
+215. pgp_verify_key_command
- Type: system property
+ Type: string
- Value:
+ Default: ""
- _\bT_\bh_\bi_\bs _\bi_\bs _\ba _\br_\be_\ba_\bd_\b-_\bo_\bn_\bl_\by _\bs_\by_\bs_\bt_\be_\bm _\bp_\br_\bo_\bp_\be_\br_\bt_\by _\ba_\bn_\bd_\b, _\ba_\bt _\br_\bu_\bn_\bt_\bi_\bm_\be_\b, _\bs_\bp_\be_\bc_\bi_\bf_\bi_\be_\bs _\bt_\bh_\be _\bc_\bu_\br_\br_\be_\bn_\bt
- _\bw_\bo_\br_\bk_\bi_\bn_\bg _\bd_\bi_\br_\be_\bc_\bt_\bo_\br_\by _\bo_\bf _\bt_\bh_\be _\bm_\bu_\bt_\bt_\bn_\bg _\bb_\bi_\bn_\ba_\br_\by_\b.
+ This command is used to verify key information from the key selection menu. (PGP only)
- _\b7_\b._\b4_\b._\b1_\b5_\b6 _\bm_\bu_\bt_\bt_\bn_\bg_\b__\br_\be_\bv_\bi_\bs_\bi_\bo_\bn
+216. pipe_decode
- Type: system property
+ Type: boolean
- Value: 471
+ Default: no
- _\bT_\bh_\bi_\bs _\bi_\bs _\ba _\br_\be_\ba_\bd_\b-_\bo_\bn_\bl_\by _\bs_\by_\bs_\bt_\be_\bm _\bp_\br_\bo_\bp_\be_\br_\bt_\by _\ba_\bn_\bd _\bs_\bp_\be_\bc_\bi_\bf_\bi_\be_\bs _\bm_\bu_\bt_\bt_\bn_\bg_\b'_\bs _\bs_\bu_\bb_\bv_\be_\br_\bs_\bi_\bo_\bn _\br_\be_\bv_\bi_\bs_\bi_\bo_\bn
- _\bs_\bt_\br_\bi_\bn_\bg_\b.
+ Used in connection with the pipe-message command. When unset, Mutt-ng will pipe the messages without any preprocessing. When set, Mutt-ng will weed headers and will attempt to PGP/MIME decode the messages first.
- _\b7_\b._\b4_\b._\b1_\b5_\b7 _\bm_\bu_\bt_\bt_\bn_\bg_\b__\bs_\by_\bs_\bc_\bo_\bn_\bf_\bd_\bi_\br
+217. pipe_sep
- Type: system property
+ Type: string
- Value: /opt/freebsd4/mutt-ng/etc
+ Default: "\n"
- _\bT_\bh_\bi_\bs _\bi_\bs _\ba _\br_\be_\ba_\bd_\b-_\bo_\bn_\bl_\by _\bs_\by_\bs_\bt_\be_\bm _\bp_\br_\bo_\bp_\be_\br_\bt_\by _\ba_\bn_\bd _\bs_\bp_\be_\bc_\bi_\bf_\bi_\be_\bs _\bt_\bh_\be _\bd_\bi_\br_\be_\bc_\bt_\bo_\br_\by _\bc_\bo_\bn_\bt_\ba_\bi_\bn_\bi_\bn_\bg _\bt_\bh_\be
- _\bm_\bu_\bt_\bt_\bn_\bg _\bs_\by_\bs_\bt_\be_\bm_\b-_\bw_\bi_\bd_\be _\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn_\b.
+ The separator to add between messages when piping a list of tagged messages to an external Unix command.
- _\b7_\b._\b4_\b._\b1_\b5_\b8 _\bm_\bu_\bt_\bt_\bn_\bg_\b__\bv_\be_\br_\bs_\bi_\bo_\bn
+218. pipe_split
- Type: system property
+ Type: boolean
- Value: devel
+ Default: no
- _\bT_\bh_\bi_\bs _\bi_\bs _\ba _\br_\be_\ba_\bd_\b-_\bo_\bn_\bl_\by _\bs_\by_\bs_\bt_\be_\bm _\bp_\br_\bo_\bp_\be_\br_\bt_\by _\ba_\bn_\bd _\bs_\bp_\be_\bc_\bi_\bf_\bi_\be_\bs _\bm_\bu_\bt_\bt_\bn_\bg_\b'_\bs _\bv_\be_\br_\bs_\bi_\bo_\bn _\bs_\bt_\br_\bi_\bn_\bg_\b.
+ Used in connection with the pipe-message command and the ``tag- prefix'' or ``tag-prefix-cond'' operators. If this variable is unset, when piping a list of tagged messages Mutt-ng will concatenate the messages and will pipe them as a single folder. When set, Mutt-ng will pipe the messages one by one. In both cases the messages are piped in the current sorted order, and the ``$pipe_sep'' separator is added after each message.
- _\b7_\b._\b4_\b._\b1_\b5_\b9 _\bn_\ba_\br_\br_\bo_\bw_\b__\bt_\br_\be_\be
+219. pop_auth_try_all
- Type: boolean
+ Type: boolean
- Default: no
+ Default: yes
- This variable, when _\bs_\be_\bt, makes the thread tree narrower, allowing deeper
- threads to fit on the screen.
+ Availability: POP
- _\b7_\b._\b4_\b._\b1_\b6_\b0 _\bn_\bn_\bt_\bp_\b__\ba_\bs_\bk_\b__\bf_\bo_\bl_\bl_\bo_\bw_\bu_\bp_\b__\bt_\bo
+ If set, Mutt-ng will try all available methods. When unset, Mutt-ng will only fall back to other authentication methods if the previous methods are unavailable. If a method is available but authentication fails, Mutt-ng will not connect to the POP server.
- Type: boolean
+220. pop_authenticators
- Default: no
+ Type: string
- Availability: NNTP
+ Default: ""
- If _\bs_\be_\bt, Mutt-ng will prompt you for the Followup-To: header field before edit-
- ing the body of an outgoing news article.
+ Availability: POP
- The Mutt Next Generation E-Mail Client 129
+ This is a colon-delimited list of authentication methods Mutt-ng may attempt to use to log in to an POP server, in the order Mutt-ng should try them. Authentication methods are either ``user'', ``apop'' or any SASL mechanism, eg ``digest-md5'', ``gssapi'' or ``cram-md5''.
- _\b7_\b._\b4_\b._\b1_\b6_\b1 _\bn_\bn_\bt_\bp_\b__\ba_\bs_\bk_\b__\bx_\b__\bc_\bo_\bm_\bm_\be_\bn_\bt_\b__\bt_\bo
+ This parameter is case-insensitive. If this parameter is unset (the default) Mutt-ng will try all available methods, in order from most-secure to least-secure.
- Type: boolean
+ Example: set pop_authenticators="digest-md5:apop:user"
- Default: no
+221. pop_delete
- Availability: NNTP
+ Type: quadoption
- If _\bs_\be_\bt, Mutt-ng will prompt you for the X-Comment-To: header field before edit-
- ing the body of an outgoing news article.
+ Default: ask-no
- _\b7_\b._\b4_\b._\b1_\b6_\b2 _\bn_\bn_\bt_\bp_\b__\bc_\ba_\bc_\bh_\be_\b__\bd_\bi_\br
+ Availability: POP
- Type: path
+ If set, Mutt-ng will delete successfully downloaded messages from the POP server when using the ``fetch-mail'' function. When unset, Mutt-ng will download messages but also leave them on the POP server.
- Default: '~/.muttng'
+222. pop_host
- Availability: NNTP
+ Type: string
- This variable points to directory where Mutt-ng will cache news article head-
- ers. If _\bu_\bn_\bs_\be_\bt, headers will not be saved at all and will be reloaded each time
- when you enter a newsgroup.
+ Default: ""
- As for the header caching in connection with IMAP and/or Maildir, this drasti-
- cally increases speed and lowers traffic.
+ Availability: POP
- _\b7_\b._\b4_\b._\b1_\b6_\b3 _\bn_\bn_\bt_\bp_\b__\bc_\ba_\bt_\bc_\bh_\bu_\bp
+ The name of your POP server for the ``fetch-mail'' function. You can also specify an alternative port, username and password, i.e.:
- Type: quadoption
+ [pop[s]://][username[:password]@]popserver[:port]
- Default: ask-yes
+ Note: Storing passwords in a configuration file presents a security risk since the superuser of your machine may read it regardless of the file's permissions.
- Availability: NNTP
+223. pop_last
- If this variable is _\bs_\be_\bt, Mutt-ng will mark all articles in a newsgroup as read
- when you leaving it.
+ Type: boolean
- _\b7_\b._\b4_\b._\b1_\b6_\b4 _\bn_\bn_\bt_\bp_\b__\bc_\bo_\bn_\bt_\be_\bx_\bt
+ Default: no
- Type: number
+ Availability: POP
- Default: 1000
+ If this variable is set, Mutt-ng will try to use the ``LAST'' POP command for retrieving only unread messages from the POP server when using the ``fetch-mail'' function.
- Availability: NNTP
+224. pop_mail_check
- This variable controls how many news articles to cache per newsgroup (if
- caching is enabled, see _\b$_\bn_\bn_\bt_\bp_\b__\bc_\ba_\bc_\bh_\be_\b__\bd_\bi_\br (section 7.4.162 , page 129)) and how
- many news articles to show in the ``index'' menu.
+ Type: number
- If there're more articles than defined with _\b$_\bn_\bn_\bt_\bp_\b__\bc_\bo_\bn_\bt_\be_\bx_\bt (section 7.4.164 ,
- page 129), all older ones will be removed/not shown in the index.
+ Default: 60
- _\b7_\b._\b4_\b._\b1_\b6_\b5 _\bn_\bn_\bt_\bp_\b__\bf_\bo_\bl_\bl_\bo_\bw_\bu_\bp_\b__\bt_\bo_\b__\bp_\bo_\bs_\bt_\be_\br
+ Availability: POP
- The Mutt Next Generation E-Mail Client 130
+ This variable configures how often (in seconds) POP should look for new mail.
- Type: quadoption
+225. pop_pass
- Default: ask-yes
+ Type: string
- Availability: NNTP
+ Default: ""
- If this variable is _\bs_\be_\bt and the keyword 'poster' is present in the Followup-To:
- header field, a follow-up to the newsgroup is not permitted. The message will
- be mailed to the submitter of the message via mail.
+ Availability: POP
- _\b7_\b._\b4_\b._\b1_\b6_\b6 _\bn_\bn_\bt_\bp_\b__\bg_\br_\bo_\bu_\bp_\b__\bi_\bn_\bd_\be_\bx_\b__\bf_\bo_\br_\bm_\ba_\bt
+ Specifies the password for your POP account. If unset, Mutt-ng will prompt you for your password when you open POP mailbox.
- Type: string
+ Note: Storing passwords in a configuration file presents a security risk since the superuser of your machine may read it regardless of the file's permissions.
- Default: '%4C %M%N %5s %-45.45f %d'
+226. pop_reconnect
- Availability: NNTP
+ Type: quadoption
- This variable allows you to customize the newsgroup browser display to your
- personal taste. This string is similar to ``_\bi_\bn_\bd_\be_\bx_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.116 ,
- page 116)'', but has its own set of printf(3)-like sequences:
+ Default: ask-yes
- %C current newsgroup number
- %d description of newsgroup (retrieved from server)
- %f newsgroup name
- %M ``-'' if newsgroup not allowed for direct post (moderated for example)
- %N ``N'' if newsgroup is new, ``u'' if unsubscribed, blank otherwise
- %n number of new articles in newsgroup
- %s number of unread articles in newsgroup
- %>X right justify the rest of the string and pad with character "X"
- %|X pad to the end of the line with character "X"
+ Availability: POP
- _\b7_\b._\b4_\b._\b1_\b6_\b7 _\bn_\bn_\bt_\bp_\b__\bh_\bo_\bs_\bt
+ Controls whether or not Mutt-ng will try to reconnect to a POP server when the connection is lost.
- Type: string
+227. pop_user
- Default: ''
+ Type: string
- Availability: NNTP
+ Default: ""
- This variable specifies the name (or address) of the NNTP server to be used.
+ Availability: POP
- It defaults to the value specified via the environment variable $NNTPSERVER or
- contained in the file /etc/nntpserver.
+ Your login name on the POP server.
- You can also specify a username and an alternative port for each newsserver,
- e.g.
+ This variable defaults to your user name on the local machine.
- [nntp[s]://][username[:password]@]newsserver[:port]
+228. post_indent_string
- N\bNo\bot\bte\be:\b: Using a password as shown and stored in a configuration file presents a
- security risk since the superuser of your machine may read it regardless of the
+ Type: string
- The Mutt Next Generation E-Mail Client 131
+ Default: ""
- file's permissions.
+ Similar to the ``$attribution'' variable, Mutt-ng will append this string after the inclusion of a message which is being replied to.
- _\b7_\b._\b4_\b._\b1_\b6_\b8 _\bn_\bn_\bt_\bp_\b__\bi_\bn_\be_\bw_\bs
+229. postpone
- Type: path
+ Type: quadoption
- Default: ''
+ Default: ask-yes
- Availability: NNTP
+ Controls whether or not messages are saved in the ``$postponed'' mailbox when you elect not to send immediately.
- If _\bs_\be_\bt, specifies the program and arguments used to deliver news posted by
- Mutt-ng. Otherwise, Mutt-ng posts article using current connection. The fol-
- lowing printf(3)-style sequence is understood:
+230. postponed
- %s newsserver name
+ Type: path
- Example: set inews='/usr/local/bin/inews -hS'
+ Default: "˜/postponed"
- _\b7_\b._\b4_\b._\b1_\b6_\b9 _\bn_\bn_\bt_\bp_\b__\bl_\bo_\ba_\bd_\b__\bd_\be_\bs_\bc_\br_\bi_\bp_\bt_\bi_\bo_\bn
+ Mutt-ng allows you to indefinitely ``postpone sending a message'' which you are editing. When you choose to postpone a message, Mutt-ng saves it in the mailbox specified by this variable. Also see the ``$postpone'' variable.
- Type: boolean
+231. preconnect
- Default: yes
+ Type: string
- Availability: NNTP
+ Default: ""
- This variable controls whether or not descriptions for newsgroups are to be
- loaded when subscribing to a newsgroup.
+ If set, a shell command to be executed if Mutt-ng fails to establish a connection to the server. This is useful for setting up secure connections, e.g. with ssh(1). If the command returns a nonzero status, Mutt-ng gives up opening the server. Example:
- _\b7_\b._\b4_\b._\b1_\b7_\b0 _\bn_\bn_\bt_\bp_\b__\bm_\ba_\bi_\bl_\b__\bc_\bh_\be_\bc_\bk
+ preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net sleep 20 < /dev/null > /dev/null"
- Type: number
+ Mailbox ``foo'' on mailhost.net can now be reached as ``{localhost:1234}foo''.
- Default: 60
+ Note: For this example to work, you must be able to log in to the remote machine without having to enter a password.
- Availability: NNTP
+232. print
- The time in seconds until any operations on a newsgroup except posting a new
- article will cause a recheck for new news. If set to 0, Mutt-ng will recheck on
- each operation in index (stepping, read article, etc.).
+ Type: quadoption
- _\b7_\b._\b4_\b._\b1_\b7_\b1 _\bn_\bn_\bt_\bp_\b__\bm_\bi_\bm_\be_\b__\bs_\bu_\bb_\bj_\be_\bc_\bt
+ Default: ask-no
- Type: boolean
+ Controls whether or not Mutt-ng really prints messages. This is set to ask-no by default, because some people accidentally hit ``p'' often.
- Default: yes
+233. print_command
- Availability: NNTP
+ Type: path
- If _\bu_\bn_\bs_\be_\bt, an 8-bit ``Subject:'' header field in a news article will not be
- encoded according to RFC2047.
+ Default: "lpr"
- The Mutt Next Generation E-Mail Client 132
+ This specifies the command pipe that should be used to print messages.
- N\bNo\bot\bte\be:\b: Only change this setting if you know what you are doing.
+234. print_decode
- _\b7_\b._\b4_\b._\b1_\b7_\b2 _\bn_\bn_\bt_\bp_\b__\bn_\be_\bw_\bs_\br_\bc
+ Type: boolean
- Type: path
+ Default: yes
- Default: '~/.newsrc'
+ Used in connection with the print-message command. If this option is set, the message is decoded before it is passed to the external command specified by $print_command. If this option is unset, no processing will be applied to the message when printing it. The latter setting may be useful if you are using some advanced printer filter which is able to properly format e-mail messages for printing.
- Availability: NNTP
+235. print_split
- This file contains information about subscribed newsgroup and articles read so
- far.
+ Type: boolean
- To ease the use of multiple news servers, the following printf(3)-style
- sequence is understood:
+ Default: no
- %s newsserver name
+ Used in connection with the print-message command. If this option is set, the command specified by $print_command is executed once for each message which is to be printed. If this option is unset, the command specified by $print_command is executed only once, and all the messages are concatenated, with a form feed as the message separator.
- _\b7_\b._\b4_\b._\b1_\b7_\b3 _\bn_\bn_\bt_\bp_\b__\bp_\ba_\bs_\bs
+ Those who use the enscript(1) program's mail-printing mode will most likely want to set this option.
- Type: string
+236. prompt_after
- Default: ''
+ Type: boolean
- Availability: NNTP
+ Default: yes
- Your password for NNTP account.
+ If you use an external ``$pager'', setting this variable will cause Mutt-ng to prompt you for a command when the pager exits rather than returning to the index menu. If unset, Mutt-ng will return to the index menu when the external pager exits.
- N\bNo\bot\bte\be:\b: Storing passwords in a configuration file presents a security risk since
- the superuser of your machine may read it regardless of the file's permissions.
+237. query_command
- _\b7_\b._\b4_\b._\b1_\b7_\b4 _\bn_\bn_\bt_\bp_\b__\bp_\bo_\bs_\bt_\b__\bm_\bo_\bd_\be_\br_\ba_\bt_\be_\bd
+ Type: path
- Type: quadoption
+ Default: ""
- Default: ask-yes
+ This specifies the command that Mutt-ng will use to make external address queries. The string should contain a %s, which will be substituted with the query string the user types. See ``query'' for more information.
- Availability: NNTP
+238. quit
- If set to _\by_\be_\bs, Mutt-ng will post articles to newsgroup that have not permis-
- sions to post (e.g. moderated).
+ Type: quadoption
- N\bNo\bot\bte\be:\b: if the newsserver does not support posting to that newsgroup or a group
- is totally read-only, that posting will not have any effect.
+ Default: yes
- _\b7_\b._\b4_\b._\b1_\b7_\b5 _\bn_\bn_\bt_\bp_\b__\br_\be_\bc_\bo_\bn_\bn_\be_\bc_\bt
+ This variable controls whether ``quit'' and ``exit'' actually quit from Mutt-ng. If it set to yes, they do quit, if it is set to no, they have no effect, and if it is set to ask-yes or ask-no, you are prompted for confirmation when you try to quit.
- Type: quadoption
+239. quote_empty
- Default: ask-yes
+ Type: boolean
- Availability: NNTP
+ Default: yes
- The Mutt Next Generation E-Mail Client 133
+ Controls whether or not empty lines will be quoted using ``indent_string''.
- Controls whether or not Mutt-ng will try to reconnect to a newsserver when the
- was connection lost.
+240. quote_quoted
- _\b7_\b._\b4_\b._\b1_\b7_\b6 _\bn_\bn_\bt_\bp_\b__\bs_\ba_\bv_\be_\b__\bu_\bn_\bs_\bu_\bb_\bs_\bc_\br_\bi_\bb_\be_\bd
+ Type: boolean
- Type: boolean
+ Default: no
- Default: no
+ Controls how quoted lines will be quoted. If set, one quote character will be added to the end of existing prefix. Otherwise, quoted lines will be prepended by ``indent_string''.
- Availability: NNTP
+241. quote_regexp
- When _\bs_\be_\bt, info about unsubscribed newsgroups will be saved into the ``newsrc''
- file and into the news cache.
+ Type: regular expression
- _\b7_\b._\b4_\b._\b1_\b7_\b7 _\bn_\bn_\bt_\bp_\b__\bs_\bh_\bo_\bw_\b__\bn_\be_\bw_\b__\bn_\be_\bw_\bs
+ Default: "^([ \t]*[|>:}#])+"
- Type: boolean
+ A regular expression used in the internal-pager to determine quoted sections of text in the body of a message.
- Default: yes
+ Note: In order to use the quotedx patterns in the internal pager, you need to set this to a regular expression that matches exactly the quote characters at the beginning of quoted lines.
- Availability: NNTP
+242. read_inc
- If _\bs_\be_\bt, the newsserver will be asked for new newsgroups on entering the
- browser. Otherwise, it will be done only once for a newsserver. Also controls
- whether or not the number of new articles of subscribed newsgroups will be
- checked.
+ Type: number
- _\b7_\b._\b4_\b._\b1_\b7_\b8 _\bn_\bn_\bt_\bp_\b__\bs_\bh_\bo_\bw_\b__\bo_\bn_\bl_\by_\b__\bu_\bn_\br_\be_\ba_\bd
+ Default: 10
- Type: boolean
+ If set to a value greater than 0, Mutt-ng will display which message it is currently on when reading a mailbox. The message is printed after read_inc messages have been read (e.g., if set to 25, Mutt-ng will print a message when it reads message 25, and then again when it gets to message 50). This variable is meant to indicate progress when reading large mailboxes which may take some time. When set to 0, only a single message will appear before the reading the mailbox.
- Default: no
+ Also see the ``$write_inc'' variable.
- Availability: NNTP
+243. read_only
- If _\bs_\be_\bt, only subscribed newsgroups that contain unread articles will be dis-
- played in the newsgroup browser.
+ Type: boolean
- _\b7_\b._\b4_\b._\b1_\b7_\b9 _\bn_\bn_\bt_\bp_\b__\bu_\bs_\be_\br
+ Default: no
- Type: string
+ If set, all folders are opened in read-only mode.
- Default: ''
+244. realname
- Availability: NNTP
+ Type: string
- Your login name on the NNTP server. If _\bu_\bn_\bs_\be_\bt and the server requires authen-
- tification, Mutt-ng will prompt you for your account name.
+ Default: ""
- _\b7_\b._\b4_\b._\b1_\b8_\b0 _\bn_\bn_\bt_\bp_\b__\bx_\b__\bc_\bo_\bm_\bm_\be_\bn_\bt_\b__\bt_\bo
+ This variable specifies what ``real'' or ``personal'' name should be used when sending messages.
- Type: boolean
+ By default, this is the GECOS field from /etc/passwd.
- Default: no
+ Note: This variable will not be used when the user has set a real name in the $from variable.
- The Mutt Next Generation E-Mail Client 134
+245. recall
- Availability: NNTP
+ Type: quadoption
- If _\bs_\be_\bt, Mutt-ng will add a ``X-Comment-To:'' header field (that contains full
- name of the original article author) to articles that you followup to.
+ Default: ask-yes
- _\b7_\b._\b4_\b._\b1_\b8_\b1 _\bo_\bp_\be_\br_\ba_\bt_\bi_\bn_\bg_\b__\bs_\by_\bs_\bt_\be_\bm
+ Controls whether or not Mutt-ng recalls postponed messages when composing a new message. Also see ``$postponed''.
- Type: string
+ Setting this variable to yes is not generally useful, and thus not recommended.
- Default: ''
+246. record
- This specifies the operating system name for the User-Agent: header field. If
- this is _\bu_\bn_\bs_\be_\bt, it will be set to the operating system name that uname(2)
- returns. If uname(2) fails, ``UNIX'' will be used.
+ Type: path
- It may, for example, look as: ``mutt-ng 1.5.9i (Linux)''.
+ Default: ""
- _\b7_\b._\b4_\b._\b1_\b8_\b2 _\bp_\ba_\bg_\be_\br
+ This specifies the file into which your outgoing messages should be appended. (This is meant as the primary method for saving a copy of your messages, but another way to do this is using the ``my_hdr'' command to create a Bcc: header field with your email address in it.)
- Type: path
+ The value of $record is overridden by the ``$force_name'' and ``$save_name'' variables, and the ``fcc-hook'' command.
- Default: 'builtin'
+247. reply_regexp
- This variable specifies which pager you would like to use to view messages.
- ``builtin'' means to use the builtin pager, otherwise this variable should
- specify the pathname of the external pager you would like to use.
+ Type: regular expression
- Using an external pager may have some disadvantages: Additional keystrokes are
- necessary because you can't call Mutt-ng functions directly from the pager, and
- screen resizes cause lines longer than the screen width to be badly formatted
- in the help menu.
+ Default: "^(re([\[0-9\]+])*|aw):[ \t]*"
- _\b7_\b._\b4_\b._\b1_\b8_\b3 _\bp_\ba_\bg_\be_\br_\b__\bc_\bo_\bn_\bt_\be_\bx_\bt
+ A regular expression used to recognize reply messages when threading and replying. The default value corresponds to the English ``Re:'' and the German ``Aw:''.
- Type: number
+248. reply_self
- Default: 0
+ Type: boolean
- This variable controls the number of lines of context that are given when dis-
- playing the next or previous page in the internal pager. By default, Mutt-ng
- will display the line after the last one on the screen at the top of the next
- page (0 lines of context).
+ Default: no
- _\b7_\b._\b4_\b._\b1_\b8_\b4 _\bp_\ba_\bg_\be_\br_\b__\bf_\bo_\br_\bm_\ba_\bt
+ If unset and you are replying to a message sent by you, Mutt-ng will assume that you want to reply to the recipients of that message rather than to yourself.
- Type: string
+249. reply_to
- Default: '-%Z- %C/%m: %-20.20n %s'
+ Type: quadoption
- This variable controls the format of the one-line message ``status'' displayed
- before each message in either the internal or an external pager. The valid
- sequences are listed in the ``_\b$_\bi_\bn_\bd_\be_\bx_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.116 , page 116)''
- section.
+ Default: ask-yes
- The Mutt Next Generation E-Mail Client 135
+ If set, when replying to a message, Mutt-ng will use the address listed in the ``Reply-To:'' header field as the recipient of the reply. If unset, it will use the address in the ``From:'' header field instead.
- _\b7_\b._\b4_\b._\b1_\b8_\b5 _\bp_\ba_\bg_\be_\br_\b__\bi_\bn_\bd_\be_\bx_\b__\bl_\bi_\bn_\be_\bs
+ This option is useful for reading a mailing list that sets the ``Reply-To:'' header field to the list address and you want to send a private message to the author of a message.
- Type: number
+250. resolve
- Default: 0
+ Type: boolean
- Determines the number of lines of a mini-index which is shown when in the
- pager. The current message, unless near the top or bottom of the folder, will
- be roughly one third of the way down this mini-index, giving the reader the
- context of a few messages before and after the message. This is useful, for
- example, to determine how many messages remain to be read in the current
- thread. One of the lines is reserved for the status bar from the index, so a
- _\bp_\ba_\bg_\be_\br_\b__\bi_\bn_\bd_\be_\bx_\b__\bl_\bi_\bn_\be_\bs of 6 will only show 5 lines of the actual index. A value of
- 0 results in no index being shown. If the number of messages in the current
- folder is less than _\bp_\ba_\bg_\be_\br_\b__\bi_\bn_\bd_\be_\bx_\b__\bl_\bi_\bn_\be_\bs, then the index will only use as many
- lines as it needs.
+ Default: yes
- _\b7_\b._\b4_\b._\b1_\b8_\b6 _\bp_\ba_\bg_\be_\br_\b__\bs_\bt_\bo_\bp
+ When set, the cursor will be automatically advanced to the next (possibly undeleted) message whenever a command that modifies the current message is executed.
- Type: boolean
+251. reverse_alias
- Default: no
+ Type: boolean
- When _\bs_\be_\bt, the internal-pager will n\bno\bot\bt move to the next message when you are at
- the end of a message and invoke the _\bn_\be_\bx_\bt_\b-_\bp_\ba_\bg_\be function.
+ Default: no
- _\b7_\b._\b4_\b._\b1_\b8_\b7 _\bp_\bg_\bp_\b__\ba_\bu_\bt_\bo_\b__\bd_\be_\bc_\bo_\bd_\be
+ This variable controls whether or not Mutt-ng will display the ``personal'' name from your aliases in the index menu if it finds an alias that matches the message's sender. For example, if you have the following alias:
- Type: boolean
+ alias juser abd30425@somewhere.net (Joe User)
- Default: no
+ and then you receive mail which contains the following header:
- If _\bs_\be_\bt, Mutt-ng will automatically attempt to decrypt traditional PGP messages
- whenever the user performs an operation which ordinarily would result in the
- contents of the message being operated on. For example, if the user displays a
- pgp-traditional message which has not been manually checked with the check-tra-
- ditional-pgp function, Mutt-ng will automatically check the message for tradi-
- tional pgp.
+ From: abd30425@somewhere.net
- _\b7_\b._\b4_\b._\b1_\b8_\b8 _\bp_\bg_\bp_\b__\ba_\bu_\bt_\bo_\bi_\bn_\bl_\bi_\bn_\be
+ It would be displayed in the index menu as ``Joe User'' instead of ``abd30425@somewhere.net.'' This is useful when the person's e-mail address is not human friendly (like CompuServe addresses).
- Type: boolean
+252. reverse_name
- Default: no
+ Type: boolean
- This option controls whether Mutt-ng generates old-style inline (traditional)
- PGP encrypted or signed messages under certain circumstances. This can be
- overridden by use of the _\bp_\bg_\bp_\b-_\bm_\be_\bn_\bu, when inline is not required.
+ Default: no
- Note that Mutt-ng might automatically use PGP/MIME for messages which consist
- of more than a single MIME part. Mutt-ng can be configured to ask before send-
- ing PGP/MIME messages when inline (traditional) would not work. See also:
- ``_\b$_\bp_\bg_\bp_\b__\bm_\bi_\bm_\be_\b__\ba_\bu_\bt_\bo (section 7.4.204 , page 139)''.
+ It may sometimes arrive that you receive mail to a certain machine, move the messages to another machine, and reply to some the messages from there. If this variable is set, the default From: line of the reply messages is built using the address where you received the messages you are replying to if that address matches your alternates. If the variable is unset, or the address that would be used doesn't match your alternates, the From: line will use your address on the current machine.
- The Mutt Next Generation E-Mail Client 136
+253. reverse_realname
- Also note that using the old-style PGP message format is s\bst\btr\bro\bon\bng\bgl\bly\by d\bde\bep\bpr\bre\bec\bca\bat\bte\bed\bd.
- (PGP only)
+ Type: boolean
- _\b7_\b._\b4_\b._\b1_\b8_\b9 _\bp_\bg_\bp_\b__\bc_\bh_\be_\bc_\bk_\b__\be_\bx_\bi_\bt
+ Default: yes
- Type: boolean
+ This variable fine-tunes the behaviour of the reverse_name feature. When it is set, Mutt-ng will use the address from incoming messages as-is, possibly including eventual real names. When it is unset, Mutt-ng will override any such real names with the setting of the realname variable.
- Default: yes
+254. rfc2047_parameters
- If _\bs_\be_\bt, Mutt-ng will check the exit code of the PGP subprocess when signing or
- encrypting. A non-zero exit code means that the subprocess failed. (PGP only)
+ Type: boolean
- _\b7_\b._\b4_\b._\b1_\b9_\b0 _\bp_\bg_\bp_\b__\bc_\bl_\be_\ba_\br_\bs_\bi_\bg_\bn_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Default: no
- Type: string
+ When this variable is set, Mutt-ng will decode RFC-2047-encoded MIME parameters. You want to set this variable when Mutt-ng suggests you to save attachments to files named like this:
- Default: ''
+ =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
- This format is used to create a old-style ``clearsigned'' PGP message.
+ When this variable is set interactively, the change doesn't have the desired effect before you have changed folders.
- Note that the use of this format is s\bst\btr\bro\bon\bng\bgl\bly\by d\bde\bep\bpr\bre\bec\bca\bat\bte\bed\bd. (PGP only)
+ Note that this use of RFC 2047's encoding is explicitly, prohibited by the standard, but nevertheless encountered in the wild.
- _\b7_\b._\b4_\b._\b1_\b9_\b1 _\bp_\bg_\bp_\b__\bd_\be_\bc_\bo_\bd_\be_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Also note that setting this parameter will not have the effect that Mutt-ng generates this kind of encoding. Instead, Mutt-ng will unconditionally use the encoding specified in RFC 2231.
- Type: string
+255. save_address
- Default: ''
+ Type: boolean
- This format strings specifies a command which is used to decode application/pgp
- attachments.
+ Default: no
- The PGP command formats have their own set of printf(3)-like sequences:
+ If set, Mutt-ng will take the sender's full address when choosing a default folder for saving a mail. If ``$save_name'' or ``$force_name'' is set too, the selection of the fcc folder will be changed as well.
- %p
- Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty
- string otherwise. Note: This may be used with a %? construct.
+256. save_empty
- %f
- Expands to the name of a file containing a message.
+ Type: boolean
- %s
- Expands to the name of a file containing the signature part of a
- multipart/signed attachment when verifying it.
+ Default: yes
- %a
- The value of _\b$_\bp_\bg_\bp_\b__\bs_\bi_\bg_\bn_\b__\ba_\bs (section 7.4.208 , page 140).
+ When unset, mailboxes which contain no saved messages will be removed when closed (the exception is ``$spoolfile'' which is never removed). If set, mailboxes are never removed.
- %r
- One or more key IDs.
+ Note: This only applies to mbox and MMDF folders, Mutt-ng does not delete MH and Maildir directories.
- For examples on how to configure these formats for the various versions of PGP
- which are floating around, see the pgp*.rc and gpg.rc files in the samples/
- subdirectory which has been installed on your system alongside the documenta-
- tion. (PGP only)
+257. save_name
- The Mutt Next Generation E-Mail Client 137
+ Type: boolean
- _\b7_\b._\b4_\b._\b1_\b9_\b2 _\bp_\bg_\bp_\b__\bd_\be_\bc_\br_\by_\bp_\bt_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Default: no
- Type: string
+ This variable controls how copies of outgoing messages are saved. When set, a check is made to see if a mailbox specified by the recipient address exists (this is done by searching for a mailbox in the ``$folder'' directory with the username part of the recipient address). If the mailbox exists, the outgoing message will be saved to that mailbox, otherwise the message is saved to the ``$record'' mailbox.
- Default: ''
+ Also see the ``$force_name'' variable.
- This command is used to decrypt a PGP encrypted message. (PGP only)
+258. score
- _\b7_\b._\b4_\b._\b1_\b9_\b3 _\bp_\bg_\bp_\b__\be_\bn_\bc_\br_\by_\bp_\bt_\b__\bo_\bn_\bl_\by_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Type: boolean
- Type: string
+ Default: yes
- Default: ''
+ When this variable is unset, scoring is turned off. This can be useful to selectively disable scoring for certain folders when the ``$score_threshold_delete'' variable and friends are used.
- This command is used to encrypt a body part without signing it. (PGP only)
+259. score_threshold_delete
- _\b7_\b._\b4_\b._\b1_\b9_\b4 _\bp_\bg_\bp_\b__\be_\bn_\bc_\br_\by_\bp_\bt_\b__\bs_\bi_\bg_\bn_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Type: number
- Type: string
+ Default: -1
- Default: ''
+ Messages which have been assigned a score equal to or lower than the value of this variable are automatically marked for deletion by Mutt-ng. Since Mutt-ng scores are always greater than or equal to zero, the default setting of this variable will never mark a message for deletion.
- This command is used to both sign and encrypt a body part. (PGP only)
+260. score_threshold_flag
- _\b7_\b._\b4_\b._\b1_\b9_\b5 _\bp_\bg_\bp_\b__\be_\bn_\bt_\br_\by_\b__\bf_\bo_\br_\bm_\ba_\bt
+ Type: number
- Type: string
+ Default: 9999
- Default: '%4n %t%f %4l/0x%k %-4a %2c %u'
+ Messages which have been assigned a score greater than or equal to this variable's value are automatically marked ``flagged''.
- This variable allows you to customize the PGP key selection menu to your per-
- sonal taste. This string is similar to ``_\b$_\bi_\bn_\bd_\be_\bx_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.116 , page
- 116)'', but has its own set of printf(3)-like sequences:
+261. score_threshold_read
- %n
- number
+ Type: number
- %k
- key id
+ Default: -1
- %u
- user id
+ Messages which have been assigned a score equal to or lower than the value of this variable are automatically marked as read by Mutt-ng. Since Mutt-ng scores are always greater than or equal to zero, the default setting of this variable will never mark a message read.
- %a
- algorithm
+262. send_charset
- %l
- key length
+ Type: string
- %f
- flags
+ Default: "us-ascii:iso-8859-1:utf-8"
- %c
- capabilities
+ A list of character sets for outgoing messages. Mutt-ng will use the first character set into which the text can be converted exactly. If your ``$charset'' is not iso-8859-1 and recipients may not understand UTF-8, it is advisable to include in the list an appropriate widely used standard character set (such as iso-8859-2, koi8-r or iso-2022-jp) either instead of or after iso-8859-1.
- The Mutt Next Generation E-Mail Client 138
+263. sendmail
- %t
- trust/validity of the key-uid association
+ Type: path
- %[<s>]
- date of the key where <s> is an strftime(3) expression
+ Default: "/usr/sbin/sendmail -oem -oi"
- (PGP only)
+ Specifies the program and arguments used to deliver mail sent by Mutt-ng. Mutt-ng expects that the specified program interprets additional arguments as recipient addresses.
- _\b7_\b._\b4_\b._\b1_\b9_\b6 _\bp_\bg_\bp_\b__\be_\bx_\bp_\bo_\br_\bt_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+264. sendmail_wait
- Type: string
+ Type: number
- Default: ''
+ Default: 0
- This command is used to export a public key from the user's key ring. (PGP
- only)
+ Specifies the number of seconds to wait for the ``$sendmail'' process to finish before giving up and putting delivery in the background.
- _\b7_\b._\b4_\b._\b1_\b9_\b7 _\bp_\bg_\bp_\b__\bg_\be_\bt_\bk_\be_\by_\bs_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Mutt-ng interprets the value of this variable as follows:
- Type: string
+ >0
+ number of seconds to wait for sendmail to finish before continuing
- Default: ''
+ 0
+ wait forever for sendmail to finish
- This command is invoked whenever Mutt-ng will need public key information. %r
- is the only printf(3)-like sequence used with this format. (PGP only)
+ <0
+ always put sendmail in the background without waiting
- _\b7_\b._\b4_\b._\b1_\b9_\b8 _\bp_\bg_\bp_\b__\bg_\bo_\bo_\bd_\b__\bs_\bi_\bg_\bn
+ Note that if you specify a value other than 0, the output of the child process will be put in a temporary file. If there is some error, you will be informed as to where to find the output.
- Type: regular expression
+265. shell
- Default: ''
+ Type: path
- If you assign a text to this variable, then a PGP signature is only considered
- verified if the output from _\b$_\bp_\bg_\bp_\b__\bv_\be_\br_\bi_\bf_\by_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd (section 7.4.214 , page 141)
- contains the text. Use this variable if the exit code from the command is 0
- even for bad signatures. (PGP only)
+ Default: ""
- _\b7_\b._\b4_\b._\b1_\b9_\b9 _\bp_\bg_\bp_\b__\bi_\bg_\bn_\bo_\br_\be_\b__\bs_\bu_\bb_\bk_\be_\by_\bs
+ Command to use when spawning a subshell. By default, the user's login shell from /etc/passwd is used.
- Type: boolean
+266. sidebar_boundary
- Default: yes
+ Type: string
- Setting this variable will cause Mutt-ng to ignore OpenPGP subkeys. Instead,
- the principal key will inherit the subkeys' capabilities. _\bU_\bn_\bs_\be_\bt this if you
- want to play interesting key selection games. (PGP only)
+ Default: "."
- _\b7_\b._\b4_\b._\b2_\b0_\b0 _\bp_\bg_\bp_\b__\bi_\bm_\bp_\bo_\br_\bt_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ When the sidebar is displayed and $sidebar_shorten_hierarchy is set, this variable specifies the characters at which to split a folder name into ``hierarchy items.''
- Type: string
+267. sidebar_delim
- Default: ''
+ Type: string
- This command is used to import a key from a message into the user's public key
+ Default: "|"
- The Mutt Next Generation E-Mail Client 139
+ This specifies the delimiter between the sidebar (if visible) and other screens.
- ring. (PGP only)
+268. sidebar_newmail_only
- _\b7_\b._\b4_\b._\b2_\b0_\b1 _\bp_\bg_\bp_\b__\bl_\bi_\bs_\bt_\b__\bp_\bu_\bb_\br_\bi_\bn_\bg_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Type: boolean
- Type: string
+ Default: no
- Default: ''
+ If set, only folders with new mail will be shown in the sidebar.
- This command is used to list the public key ring's contents. The output format
- must be analogous to the one used by gpg --list-keys --with-colons.
+269. sidebar_number_format
- This format is also generated by the pgpring utility which comes with Mutt-ng.
- (PGP only)
+ Type: string
- _\b7_\b._\b4_\b._\b2_\b0_\b2 _\bp_\bg_\bp_\b__\bl_\bi_\bs_\bt_\b__\bs_\be_\bc_\br_\bi_\bn_\bg_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Default: "%m%?n?(%n)?%?f?[%f]?"
- Type: string
+ This variable controls how message counts are printed when the sidebar is enabled. If this variable is empty (and only if), no numbers will be printed and mutt-ng won't frequently count mail (which may be a great speedup esp. with mbox-style mailboxes.)
- Default: ''
+ The following printf(3)-like sequences are supported all of which may be printed non-zero:
- This command is used to list the secret key ring's contents. The output format
- must be analogous to the one used by gpg --list-keys --with-colons.
+ %d
+ Number of deleted messages. 1)
- This format is also generated by the pgpring utility which comes with Mutt-ng.
- (PGP only)
+ %F
+ Number of flagged messages.
- _\b7_\b._\b4_\b._\b2_\b0_\b3 _\bp_\bg_\bp_\b__\bl_\bo_\bn_\bg_\b__\bi_\bd_\bs
+ %m
+ Total number of messages.
- Type: boolean
+ %M
+ Total number of messages shown, i.e. not hidden by a limit. 1)
- Default: no
+ %n
+ Number of new messages.
- If _\bs_\be_\bt, use 64 bit PGP key IDs. _\bU_\bn_\bs_\be_\bt uses the normal 32 bit Key IDs. (PGP
- only)
+ %t
+ Number of tagged messages. 1)
- _\b7_\b._\b4_\b._\b2_\b0_\b4 _\bp_\bg_\bp_\b__\bm_\bi_\bm_\be_\b__\ba_\bu_\bt_\bo
+ 1) These expandos only have a non-zero value for the current mailbox and will always be zero otherwise.
- Type: quadoption
+270. sidebar_shorten_hierarchy
- Default: ask-yes
+ Type: boolean
- This option controls whether Mutt-ng will prompt you for automatically sending
- a (signed/encrypted) message using PGP/MIME when inline (traditional) fails
- (for any reason).
+ Default: no
- Also note that using the old-style PGP message format is s\bst\btr\bro\bon\bng\bgl\bly\by d\bde\bep\bpr\bre\bec\bca\bat\bte\bed\bd.
- (PGP only)
+ When set, the ``hierarchy'' of the sidebar entries will be shortened only if they cannot be printed in full length (because ``$sidebar_width'' is set to a too low value). For example, if the newsgroup name ``de.alt.sysadmin.recovery'' doesn't fit on the screen, it'll get shortened ``d.a.s.recovery'' while ``de.alt.d0'' still would and thus will not get shortened.
- _\b7_\b._\b4_\b._\b2_\b0_\b5 _\bp_\bg_\bp_\b__\br_\be_\bp_\bl_\by_\bi_\bn_\bl_\bi_\bn_\be
+ At which characters this compression is done is controled via the $sidebar_boundary variable.
- Type: boolean
+271. sidebar_visible
- Default: no
+ Type: boolean
- The Mutt Next Generation E-Mail Client 140
+ Default: no
- Setting this variable will cause Mutt-ng to always attempt to create an inline
- (traditional) message when replying to a message which is PGP encrypted/signed
- inline. This can be overridden by use of the _\bp_\bg_\bp_\b-_\bm_\be_\bn_\bu, when inline is not
- required. This option does not automatically detect if the (replied-to) mes-
- sage is inline; instead it relies on Mutt-ng internals for previously
- checked/flagged messages.
+ This specifies whether or not to show the sidebar (a list of folders specified with the ``mailboxes'' command).
- Note that Mutt-ng might automatically use PGP/MIME for messages which consist
- of more than a single MIME part. Mutt-ng can be configured to ask before send-
- ing PGP/MIME messages when inline (traditional) would not work. See also:
- ``_\b$_\bp_\bg_\bp_\b__\bm_\bi_\bm_\be_\b__\ba_\bu_\bt_\bo (section 7.4.204 , page 139)''.
+272. sidebar_width
- Also note that using the old-style PGP message format is s\bst\btr\bro\bon\bng\bgl\bly\by d\bde\bep\bpr\bre\bec\bca\bat\bte\bed\bd.
- (PGP only)
+ Type: number
- _\b7_\b._\b4_\b._\b2_\b0_\b6 _\bp_\bg_\bp_\b__\br_\be_\bt_\ba_\bi_\bn_\ba_\bb_\bl_\be_\b__\bs_\bi_\bg_\bs
+ Default: 0
- Type: boolean
+ The width of the sidebar.
- Default: no
+273. sig_dashes
- If _\bs_\be_\bt, signed and encrypted messages will consist of nested multipart/signed
- and multipart/encrypted body parts.
+ Type: boolean
- This is useful for applications like encrypted and signed mailing lists, where
- the outer layer (multipart/encrypted) can be easily removed, while the inner
- multipart/signed part is retained. (PGP only)
+ Default: yes
- _\b7_\b._\b4_\b._\b2_\b0_\b7 _\bp_\bg_\bp_\b__\bs_\bh_\bo_\bw_\b__\bu_\bn_\bu_\bs_\ba_\bb_\bl_\be
+ If set, a line containing ``-- '' (dash, dash, space) will be inserted before your ``$signature''. It is strongly recommended that you not unset this variable unless your ``signature'' contains just your name. The reason for this is because many software packages use ``-- \n'' to detect your signature.
- Type: boolean
+ For example, Mutt-ng has the ability to highlight the signature in a different color in the builtin pager.
- Default: yes
+274. sig_on_top
- If _\bs_\be_\bt, Mutt-ng will display non-usable keys on the PGP key selection menu.
- This includes keys which have been revoked, have expired, or have been marked
- as ``disabled'' by the user. (PGP only)
+ Type: boolean
- _\b7_\b._\b4_\b._\b2_\b0_\b8 _\bp_\bg_\bp_\b__\bs_\bi_\bg_\bn_\b__\ba_\bs
+ Default: no
- Type: string
+ If set, the signature will be included before any quoted or forwarded text. It is strongly recommended that you do not set this variable unless you really know what you are doing, and are prepared to take some heat from netiquette guardians.
- Default: ''
+275. signature
- If you have more than one key pair, this option allows you to specify which of
- your private keys to use. It is recommended that you use the keyid form to
- specify your key (e.g., ``0x00112233''). (PGP only)
+ Type: path
- _\b7_\b._\b4_\b._\b2_\b0_\b9 _\bp_\bg_\bp_\b__\bs_\bi_\bg_\bn_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Default: "˜/.signature"
- Type: string
+ Specifies the filename of your signature, which is appended to all outgoing messages. If the filename ends with a pipe (``|''), it is assumed that filename is a shell command and input should be read from its stdout.
- Default: ''
+276. signoff_string
- The Mutt Next Generation E-Mail Client 141
+ Type: string
- This command is used to create the detached PGP signature for a multi-
- part/signed PGP/MIME body part. (PGP only)
+ Default: ""
- _\b7_\b._\b4_\b._\b2_\b1_\b0 _\bp_\bg_\bp_\b__\bs_\bo_\br_\bt_\b__\bk_\be_\by_\bs
+ If set, this string will be inserted before the signature. This is useful for people that want to sign off every message they send with their name.
- Type: sort order
+ If you want to insert your website's URL, additional contact information or witty quotes into your mails, better use a signature file instead of the signoff string.
- Default: address
+277. simple_search
- Specifies how the entries in the ``pgp keys'' menu are sorted. The following
- are legal values:
+ Type: string
- address
- sort alphabetically by user id
+ Default: "˜f %s | ˜s %s"
- keyid
- sort alphabetically by key id
+ Specifies how Mutt-ng should expand a simple search into a real search pattern. A simple search is one that does not contain any of the ˜ operators. See ``patterns'' for more information on search patterns.
- date
- sort by key creation date
+ For example, if you simply type ``joe'' at a search or limit prompt, Mutt-ng will automatically expand it to the value specified by this variable. For the default value it would be:
- trust
- sort by the trust of the key
+ ˜f joe | ˜s joe
- If you prefer reverse order of the above values, prefix it with ``reverse-''.
- (PGP only)
+278. sleep_time
- _\b7_\b._\b4_\b._\b2_\b1_\b1 _\bp_\bg_\bp_\b__\bs_\bt_\br_\bi_\bc_\bt_\b__\be_\bn_\bc
+ Type: number
- Type: boolean
+ Default: 1
- Default: yes
+ Specifies time, in seconds, to pause while displaying certain informational messages, while moving from folder to folder and after expunging messages from the current folder. The default is to pause one second, so a value of zero for this option suppresses the pause.
- If _\bs_\be_\bt, Mutt-ng will automatically encode PGP/MIME signed messages as quoted-
- printable. Please note that unsetting this variable may lead to problems with
- non-verifyable PGP signatures, so only change this if you know what you are
- doing. (PGP only)
+279. smart_wrap
- _\b7_\b._\b4_\b._\b2_\b1_\b2 _\bp_\bg_\bp_\b__\bt_\bi_\bm_\be_\bo_\bu_\bt
+ Type: boolean
- Type: number
+ Default: yes
- Default: 300
+ Controls the display of lines longer than the screen width in the internal pager. If set, long lines are wrapped at a word boundary. If unset, lines are simply wrapped at the screen edge. Also see the ``$markers'' variable.
- The number of seconds after which a cached passphrase will expire if not used.
- Default: 300. (PGP only)
+280. smileys
- _\b7_\b._\b4_\b._\b2_\b1_\b3 _\bp_\bg_\bp_\b__\bu_\bs_\be_\b__\bg_\bp_\bg_\b__\ba_\bg_\be_\bn_\bt
+ Type: regular expression
- Type: boolean
+ Default: "(>From )|(:[-^]?[][)(><}{|/DP])"
- Default: no
+ The pager uses this variable to catch some common false positives of ``$quote_regexp'', most notably smileys in the beginning of a line
- If _\bs_\be_\bt, Mutt-ng will use a possibly-running gpg-agent process. (PGP only)
+281. smime_ask_cert_label
- The Mutt Next Generation E-Mail Client 142
+ Type: boolean
- _\b7_\b._\b4_\b._\b2_\b1_\b4 _\bp_\bg_\bp_\b__\bv_\be_\br_\bi_\bf_\by_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Default: yes
- Type: string
+ This flag controls whether you want to be asked to enter a label for a certificate about to be added to the database or not. It is set by default. (S/MIME only)
- Default: ''
+282. smime_ca_location
- This command is used to verify PGP signatures. (PGP only)
+ Type: path
- _\b7_\b._\b4_\b._\b2_\b1_\b5 _\bp_\bg_\bp_\b__\bv_\be_\br_\bi_\bf_\by_\b__\bk_\be_\by_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Default: ""
- Type: string
+ This variable contains the name of either a directory, or a file which contains trusted certificates for use with OpenSSL. (S/MIME only)
- Default: ''
+283. smime_certificates
- This command is used to verify key information from the key selection menu.
- (PGP only)
+ Type: path
- _\b7_\b._\b4_\b._\b2_\b1_\b6 _\bp_\bi_\bp_\be_\b__\bd_\be_\bc_\bo_\bd_\be
+ Default: ""
- Type: boolean
+ Since there is no pubring/secring as with PGP, Mutt-ng has to handle storage and retrieval of keys by itself. This is very basic right now, and keys and certificates are stored in two different directories, both named as the hash-value retrieved from OpenSSL. There is an index file which contains mailbox-address keyid pairs, and which can be manually edited. This one points to the location of the certificates. (S/MIME only)
- Default: no
+284. smime_decrypt_command
- Used in connection with the _\bp_\bi_\bp_\be_\b-_\bm_\be_\bs_\bs_\ba_\bg_\be command. When _\bu_\bn_\bs_\be_\bt, Mutt-ng will
- pipe the messages without any preprocessing. When _\bs_\be_\bt, Mutt-ng will weed head-
- ers and will attempt to PGP/MIME decode the messages first.
+ Type: string
- _\b7_\b._\b4_\b._\b2_\b1_\b7 _\bp_\bi_\bp_\be_\b__\bs_\be_\bp
+ Default: ""
- Type: string
+ This format string specifies a command which is used to decrypt application/x-pkcs7-mime attachments.
- Default: '\n'
+ The OpenSSL command formats have their own set of printf(3)-like sequences similar to PGP's:
- The separator to add between messages when piping a list of tagged messages to
- an external Unix command.
+ %f
+ Expands to the name of a file containing a message.
- _\b7_\b._\b4_\b._\b2_\b1_\b8 _\bp_\bi_\bp_\be_\b__\bs_\bp_\bl_\bi_\bt
+ %s
+ Expands to the name of a file containing the signature part of a multipart/signed attachment when verifying it.
- Type: boolean
+ %k
+ The key-pair specified with $smime_default_key
- Default: no
+ %c
+ One or more certificate IDs.
- Used in connection with the _\bp_\bi_\bp_\be_\b-_\bm_\be_\bs_\bs_\ba_\bg_\be command and the ``tag- prefix'' or
- ``tag-prefix-cond'' operators. If this variable is _\bu_\bn_\bs_\be_\bt, when piping a list
- of tagged messages Mutt-ng will concatenate the messages and will pipe them as
- a single folder. When _\bs_\be_\bt, Mutt-ng will pipe the messages one by one. In both
- cases the messages are piped in the current sorted order, and the ``_\b$_\bp_\bi_\bp_\be_\b__\bs_\be_\bp
- (section 7.4.217 , page 142)'' separator is added after each message.
+ %a
+ The algorithm used for encryption.
- _\b7_\b._\b4_\b._\b2_\b1_\b9 _\bp_\bo_\bp_\b__\ba_\bu_\bt_\bh_\b__\bt_\br_\by_\b__\ba_\bl_\bl
+ %C
+ CA location: Depending on whether $smime_ca_location points to a directory or file, this expands to "-CApath $smime_ca_location" or "-CAfile $smime_ca_location".
- Type: boolean
+ For examples on how to configure these formats, see the smime.rc in the samples/ subdirectory which has been installed on your system alongside the documentation. (S/MIME only)
- Default: yes
+285. smime_decrypt_use_default_key
- The Mutt Next Generation E-Mail Client 143
+ Type: boolean
- Availability: POP
+ Default: yes
- If _\bs_\be_\bt, Mutt-ng will try all available methods. When _\bu_\bn_\bs_\be_\bt, Mutt-ng will only
- fall back to other authentication methods if the previous methods are unavail-
- able. If a method is available but authentication fails, Mutt-ng will not con-
- nect to the POP server.
+ If set (default) this tells Mutt-ng to use the default key for decryption. Otherwise, if manage multiple certificate-key-pairs, Mutt-ng will try to use the mailbox-address to determine the key to use. It will ask you to supply a key, if it can't find one. (S/MIME only)
- _\b7_\b._\b4_\b._\b2_\b2_\b0 _\bp_\bo_\bp_\b__\ba_\bu_\bt_\bh_\be_\bn_\bt_\bi_\bc_\ba_\bt_\bo_\br_\bs
+286. smime_default_key
- Type: string
+ Type: string
- Default: ''
+ Default: ""
- Availability: POP
+ This is the default key-pair to use for signing. This must be set to the keyid (the hash-value that OpenSSL generates) to work properly (S/MIME only)
- This is a colon-delimited list of authentication methods Mutt-ng may attempt to
- use to log in to an POP server, in the order Mutt-ng should try them. Authen-
- tication methods are either ``user'', ``apop'' or any SASL mechanism, eg
- ``digest-md5'', ``gssapi'' or ``cram-md5''.
+287. smime_encrypt_command
- This parameter is case-insensitive. If this parameter is _\bu_\bn_\bs_\be_\bt (the default)
- Mutt-ng will try all available methods, in order from most-secure to least-
- secure.
+ Type: string
- Example: set pop_authenticators='digest-md5:apop:user'
+ Default: ""
- _\b7_\b._\b4_\b._\b2_\b2_\b1 _\bp_\bo_\bp_\b__\bd_\be_\bl_\be_\bt_\be
+ This command is used to create encrypted S/MIME messages. (S/MIME only)
- Type: quadoption
+288. smime_encrypt_with
- Default: ask-no
+ Type: string
- Availability: POP
+ Default: ""
- If _\bs_\be_\bt, Mutt-ng will delete successfully downloaded messages from the POP
- server when using the ``fetch-mail'' function. When _\bu_\bn_\bs_\be_\bt, Mutt-ng will down-
- load messages but also leave them on the POP server.
+ This sets the algorithm that should be used for encryption. Valid choices are ``des'', ``des3'', ``rc2-40'', ``rc2-64'', ``\frc2-128''.
- _\b7_\b._\b4_\b._\b2_\b2_\b2 _\bp_\bo_\bp_\b__\bh_\bo_\bs_\bt
+ If unset ``3des'' (TripleDES) is used. (S/MIME only)
- Type: string
+289. smime_get_cert_command
- Default: ''
+ Type: string
- Availability: POP
+ Default: ""
- The name of your POP server for the ``fetch-mail'' function. You can also
- specify an alternative port, username and password, i.e.:
+ This command is used to extract X509 certificates from a PKCS7 structure. (S/MIME only)
- [pop[s]://][username[:password]@]popserver[:port]
+290. smime_get_cert_email_command
- N\bNo\bot\bte\be:\b: Storing passwords in a configuration file presents a security risk since
- the superuser of your machine may read it regardless of the file's permissions.
+ Type: string
- The Mutt Next Generation E-Mail Client 144
+ Default: ""
- _\b7_\b._\b4_\b._\b2_\b2_\b3 _\bp_\bo_\bp_\b__\bl_\ba_\bs_\bt
+ This command is used to extract the mail address(es) used for storing X509 certificates, and for verification purposes (to check whether the certificate was issued for the sender's mailbox). (S/MIME only)
- Type: boolean
+291. smime_get_signer_cert_command
- Default: no
+ Type: string
- Availability: POP
+ Default: ""
- If this variable is _\bs_\be_\bt, Mutt-ng will try to use the ``LAST'' POP command for
- retrieving only unread messages from the POP server when using the ``fetch-
- mail'' function.
+ This command is used to extract only the signers X509 certificate from a S/MIME signature, so that the certificate's owner may get compared to the email's ``From:'' header field. (S/MIME only)
- _\b7_\b._\b4_\b._\b2_\b2_\b4 _\bp_\bo_\bp_\b__\bm_\ba_\bi_\bl_\b__\bc_\bh_\be_\bc_\bk
+292. smime_import_cert_command
- Type: number
+ Type: string
- Default: 60
+ Default: ""
- Availability: POP
+ This command is used to import a certificate via smime_keysng. (S/MIME only)
- This variable configures how often (in seconds) POP should look for new mail.
+293. smime_is_default
- _\b7_\b._\b4_\b._\b2_\b2_\b5 _\bp_\bo_\bp_\b__\bp_\ba_\bs_\bs
+ Type: boolean
- Type: string
+ Default: no
- Default: ''
+ The default behaviour of Mutt-ng is to use PGP on all auto-sign/encryption operations. To override and to use OpenSSL instead this must be set.
- Availability: POP
+ However, this has no effect while replying, since Mutt-ng will automatically select the same application that was used to sign/encrypt the original message.
- Specifies the password for your POP account. If _\bu_\bn_\bs_\be_\bt, Mutt-ng will prompt you
- for your password when you open POP mailbox.
+ (Note that this variable can be overridden by unsetting $crypt_autosmime.) (S/MIME only)
- N\bNo\bot\bte\be:\b: Storing passwords in a configuration file presents a security risk since
- the superuser of your machine may read it regardless of the file's permissions.
+294. smime_keys
- _\b7_\b._\b4_\b._\b2_\b2_\b6 _\bp_\bo_\bp_\b__\br_\be_\bc_\bo_\bn_\bn_\be_\bc_\bt
+ Type: path
- Type: quadoption
+ Default: ""
- Default: ask-yes
+ Since there is no pubring/secring as with PGP, Mutt-ng has to handle storage ad retrieval of keys/certs by itself. This is very basic right now, and stores keys and certificates in two different directories, both named as the hash-value retrieved from OpenSSL. There is an index file which contains mailbox-address keyid pair, and which can be manually edited. This one points to the location of the private keys. (S/MIME only)
- Availability: POP
+295. smime_pk7out_command
- Controls whether or not Mutt-ng will try to reconnect to a POP server when the
- connection is lost.
+ Type: string
- _\b7_\b._\b4_\b._\b2_\b2_\b7 _\bp_\bo_\bp_\b__\bu_\bs_\be_\br
+ Default: ""
- Type: string
+ This command is used to extract PKCS7 structures of S/MIME signatures, in order to extract the public X509 certificate(s). (S/MIME only)
- Default: ''
+296. smime_sign_command
- Availability: POP
+ Type: string
- The Mutt Next Generation E-Mail Client 145
+ Default: ""
- Your login name on the POP server.
+ This command is used to created S/MIME signatures of type multipart/signed, which can be read by all mail clients. (S/MIME only)
- This variable defaults to your user name on the local machine.
+297. smime_sign_opaque_command
- _\b7_\b._\b4_\b._\b2_\b2_\b8 _\bp_\bo_\bs_\bt_\b__\bi_\bn_\bd_\be_\bn_\bt_\b__\bs_\bt_\br_\bi_\bn_\bg
+ Type: string
- Type: string
+ Default: ""
- Default: ''
+ This command is used to created S/MIME signatures of type application/x-pkcs7-signature, which can only be handled by mail clients supporting the S/MIME extension. (S/MIME only)
- Similar to the ``_\b$_\ba_\bt_\bt_\br_\bi_\bb_\bu_\bt_\bi_\bo_\bn (section 7.4.18 , page 94)'' variable, Mutt-ng
- will append this string after the inclusion of a message which is being replied
- to.
+298. smime_timeout
- _\b7_\b._\b4_\b._\b2_\b2_\b9 _\bp_\bo_\bs_\bt_\bp_\bo_\bn_\be
+ Type: number
- Type: quadoption
+ Default: 300
- Default: ask-yes
+ The number of seconds after which a cached passphrase will expire if not used. (S/MIME only)
- Controls whether or not messages are saved in the ``_\b$_\bp_\bo_\bs_\bt_\bp_\bo_\bn_\be_\bd (section
- 7.4.230 , page 145)'' mailbox when you elect not to send immediately.
+299. smime_verify_command
- _\b7_\b._\b4_\b._\b2_\b3_\b0 _\bp_\bo_\bs_\bt_\bp_\bo_\bn_\be_\bd
+ Type: string
- Type: path
+ Default: ""
- Default: '~/postponed'
+ This command is used to verify S/MIME signatures of type multipart/signed. (S/MIME only)
- Mutt-ng allows you to indefinitely ``_\bp_\bo_\bs_\bt_\bp_\bo_\bn_\be (section 7.4.229 , page 145)
- sending a message'' which you are editing. When you choose to postpone a mes-
- sage, Mutt-ng saves it in the mailbox specified by this variable. Also see the
- ``_\b$_\bp_\bo_\bs_\bt_\bp_\bo_\bn_\be (section 7.4.229 , page 145)'' variable.
+300. smime_verify_opaque_command
- _\b7_\b._\b4_\b._\b2_\b3_\b1 _\bp_\br_\be_\bc_\bo_\bn_\bn_\be_\bc_\bt
+ Type: string
- Type: string
+ Default: ""
- Default: ''
+ This command is used to verify S/MIME signatures of type application/x-pkcs7-mime. (S/MIME only)
- If _\bs_\be_\bt, a shell command to be executed if Mutt-ng fails to establish a connec-
- tion to the server. This is useful for setting up secure connections, e.g. with
- ssh(1). If the command returns a nonzero status, Mutt-ng gives up opening the
- server. Example:
+301. smtp_envelope
- preconnect='ssh -f -q -L 1234:mailhost.net:143 mailhost.net sleep 20 <
- /dev/null > /dev/null'
+ Type: string
- Mailbox ``foo'' on mailhost.net can now be reached as ``{localhost:1234}foo''.
+ Default: ""
- N\bNo\bot\bte\be:\b: For this example to work, you must be able to log in to the remote
- machine without having to enter a password.
+ Availability: SMTP
- The Mutt Next Generation E-Mail Client 146
+ If this variable is non-empty, it'll be used as the envelope sender. If it's empty (the default), the value of the regular From: header will be used.
- _\b7_\b._\b4_\b._\b2_\b3_\b2 _\bp_\br_\bi_\bn_\bt
+ This may be necessary as some providers don't allow for arbitrary values as the envelope sender but only a particular one which may not be the same as the user's desired From: header.
- Type: quadoption
+302. smtp_host
- Default: ask-no
+ Type: string
- Controls whether or not Mutt-ng really prints messages. This is set to _\ba_\bs_\bk_\b-_\bn_\bo
- by default, because some people accidentally hit ``p'' often.
+ Default: ""
- _\b7_\b._\b4_\b._\b2_\b3_\b3 _\bp_\br_\bi_\bn_\bt_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Availability: SMTP
- Type: path
+ Defines the SMTP host which will be used to deliver mail, as opposed to invoking the sendmail binary. Setting this variable overrides the value of ``$sendmail'', and any associated variables.
- Default: 'lpr'
+303. smtp_pass
- This specifies the command pipe that should be used to print messages.
+ Type: string
- _\b7_\b._\b4_\b._\b2_\b3_\b4 _\bp_\br_\bi_\bn_\bt_\b__\bd_\be_\bc_\bo_\bd_\be
+ Default: ""
- Type: boolean
+ Availability: SMTP
- Default: yes
+ Defines the password to use with SMTP AUTH. If ``$smtp_user'' is set, but this variable is not, you will be prompted for a password when sending.
- Used in connection with the print-message command. If this option is _\bs_\be_\bt, the
- message is decoded before it is passed to the external command specified by
- _\b$_\bp_\br_\bi_\bn_\bt_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd (section 7.4.233 , page 146). If this option is _\bu_\bn_\bs_\be_\bt, no pro-
- cessing will be applied to the message when printing it. The latter setting
- may be useful if you are using some advanced printer filter which is able to
- properly format e-mail messages for printing.
+ Note: Storing passwords in a configuration file presents a security risk since the superuser of your machine may read it regardless of the file's permissions.
- _\b7_\b._\b4_\b._\b2_\b3_\b5 _\bp_\br_\bi_\bn_\bt_\b__\bs_\bp_\bl_\bi_\bt
+304. smtp_port
- Type: boolean
+ Type: number
- Default: no
+ Default: 25
- Used in connection with the print-message command. If this option is _\bs_\be_\bt, the
- command specified by _\b$_\bp_\br_\bi_\bn_\bt_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd (section 7.4.233 , page 146) is executed
- once for each message which is to be printed. If this option is _\bu_\bn_\bs_\be_\bt, the
- command specified by _\b$_\bp_\br_\bi_\bn_\bt_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd (section 7.4.233 , page 146) is executed
- only once, and all the messages are concatenated, with a form feed as the mes-
- sage separator.
+ Availability: SMTP
- Those who use the enscript(1) program's mail-printing mode will most likely
- want to set this option.
+ Defines the port that the SMTP host is listening on for mail delivery. Must be specified as a number.
- _\b7_\b._\b4_\b._\b2_\b3_\b6 _\bp_\br_\bo_\bm_\bp_\bt_\b__\ba_\bf_\bt_\be_\br
+ Defaults to 25, the standard SMTP port, but RFC 2476-compliant SMTP servers will probably desire 587, the mail submission port.
- Type: boolean
+305. smtp_use_tls
- Default: yes
+ Type: string
- If you use an _\be_\bx_\bt_\be_\br_\bn_\ba_\bl ``_\b$_\bp_\ba_\bg_\be_\br (section 7.4.182 , page 134)'', setting this
- variable will cause Mutt-ng to prompt you for a command when the pager exits
+ Default: ""
- The Mutt Next Generation E-Mail Client 147
+ Availability: SMTP (and SSL)
- rather than returning to the index menu. If _\bu_\bn_\bs_\be_\bt, Mutt-ng will return to the
- index menu when the external pager exits.
+ Defines wether to use STARTTLS. If this option is set to ``required'' and the server does not support STARTTLS or there is an error in the TLS Handshake, the connection will fail. Setting this to ``enabled'' will try to start TLS and continue without TLS in case of an error. Muttng still needs to have SSL support enabled in order to use it.
- _\b7_\b._\b4_\b._\b2_\b3_\b7 _\bq_\bu_\be_\br_\by_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+306. smtp_user
- Type: path
+ Type: string
- Default: ''
+ Default: ""
- This specifies the command that Mutt-ng will use to make external address
- queries. The string should contain a %s, which will be substituted with the
- query string the user types. See ``_\bq_\bu_\be_\br_\by (section 4.7 , page 59)'' for more
- information.
+ Availability: SMTP
- _\b7_\b._\b4_\b._\b2_\b3_\b8 _\bq_\bu_\bi_\bt
+ Defines the username to use with SMTP AUTH. Setting this variable will cause Mutt-ng to attempt to use SMTP AUTH when sending.
- Type: quadoption
+307. sort
- Default: yes
+ Type: sort order
- This variable controls whether ``quit'' and ``exit'' actually quit from Mutt-
- ng. If it set to _\by_\be_\bs, they do quit, if it is set to _\bn_\bo, they have no effect,
- and if it is set to _\ba_\bs_\bk_\b-_\by_\be_\bs or _\ba_\bs_\bk_\b-_\bn_\bo, you are prompted for confirmation when
- you try to quit.
+ Default: date
- _\b7_\b._\b4_\b._\b2_\b3_\b9 _\bq_\bu_\bo_\bt_\be_\b__\be_\bm_\bp_\bt_\by
+ Specifies how to sort messages in the index menu. Valid values are:
+ date or date-sent
+ date-received
+ from
+ mailbox-order (unsorted)
+ score
+ size
+ spam
+ subject
+ threads
+ to
- Type: boolean
+ You may optionally use the ``reverse-'' prefix to specify reverse sorting order (example: set sort=reverse-date-sent).
- Default: yes
+308. sort_alias
- Controls whether or not empty lines will be quoted using ``_\bi_\bn_\bd_\be_\bn_\bt_\b__\bs_\bt_\br_\bi_\bn_\bg (sec-
- tion 7.4.115 , page 116)''.
+ Type: sort order
- _\b7_\b._\b4_\b._\b2_\b4_\b0 _\bq_\bu_\bo_\bt_\be_\b__\bq_\bu_\bo_\bt_\be_\bd
+ Default: alias
- Type: boolean
+ Specifies how the entries in the ``alias'' menu are sorted. The following are legal values:
+ address (sort alphabetically by email address)
+ alias (sort alphabetically by alias name)
+ unsorted (leave in order specified in .muttrc)
- Default: no
+309. sort_aux
- Controls how quoted lines will be quoted. If _\bs_\be_\bt, one quote character will be
- added to the end of existing prefix. Otherwise, quoted lines will be prepended
- by ``_\bi_\bn_\bd_\be_\bn_\bt_\b__\bs_\bt_\br_\bi_\bn_\bg (section 7.4.115 , page 116)''.
+ Type: sort order
- _\b7_\b._\b4_\b._\b2_\b4_\b1 _\bq_\bu_\bo_\bt_\be_\b__\br_\be_\bg_\be_\bx_\bp
+ Default: date
- Type: regular expression
+ When sorting by threads, this variable controls how threads are sorted in relation to other threads, and how the branches of the thread trees are sorted. This can be set to any value that ``$sort'' can, except threads (in that case, Mutt-ng will just use date-sent). You can also specify the ``last-'' prefix in addition to ``reverse-'' prefix, but last- must come after reverse-. The last- prefix causes messages to be sorted against its siblings by which has the last descendant, using the rest of sort_aux as an ordering.
- Default: '^([ \t]*[|>:}#])+'
+ For instance, set sort_aux=last-date-received would mean that if a new message is received in a thread, that thread becomes the last one displayed (or the first, if you have set sort=reverse-threads.)
- A regular expression used in the internal-pager to determine quoted sections of
- text in the body of a message.
+ Note: For reversed ``$sort'' order $sort_aux is reversed again (which is not the right thing to do, but kept to not break any existing configuration setting).
- N\bNo\bot\bte\be:\b: In order to use the _\bq_\bu_\bo_\bt_\be_\bdx\bx patterns in the internal pager, you need to
+310. sort_browser
- The Mutt Next Generation E-Mail Client 148
+ Type: sort order
- set this to a regular expression that matches _\be_\bx_\ba_\bc_\bt_\bl_\by the quote characters at
- the beginning of quoted lines.
+ Default: alpha
- _\b7_\b._\b4_\b._\b2_\b4_\b2 _\br_\be_\ba_\bd_\b__\bi_\bn_\bc
+ Specifies how to sort entries in the file browser. By default, the entries are sorted alphabetically. Valid values:
+ alpha (alphabetically)
+ date
+ size
+ unsorted
- Type: number
+ You may optionally use the ``reverse-'' prefix to specify reverse sorting order (example: set sort_browser=reverse-date).
- Default: 10
+311. sort_re
- If set to a value greater than 0, Mutt-ng will display which message it is cur-
- rently on when reading a mailbox. The message is printed after _\br_\be_\ba_\bd_\b__\bi_\bn_\bc mes-
- sages have been read (e.g., if set to 25, Mutt-ng will print a message when it
- reads message 25, and then again when it gets to message 50). This variable is
- meant to indicate progress when reading large mailboxes which may take some
- time. When set to 0, only a single message will appear before the reading the
- mailbox.
+ Type: boolean
- Also see the ``_\b$_\bw_\br_\bi_\bt_\be_\b__\bi_\bn_\bc (section 7.4.355 , page 175)'' variable.
+ Default: yes
- _\b7_\b._\b4_\b._\b2_\b4_\b3 _\br_\be_\ba_\bd_\b__\bo_\bn_\bl_\by
+ This variable is only useful when sorting by threads with ``$strict_threads'' unset. In that case, it changes the heuristic Mutt-ng uses to thread messages by subject. With $sort_re set, Mutt-ng will only attach a message as the child of another message by subject if the subject of the child message starts with a substring matching the setting of ``$reply_regexp''. With $sort_re unset, Mutt-ng will attach the message whether or not this is the case, as long as the non-``$reply_regexp'' parts of both messages are identical.
- Type: boolean
+312. spam_separator
- Default: no
+ Type: string
- If set, all folders are opened in read-only mode.
+ Default: ","
- _\b7_\b._\b4_\b._\b2_\b4_\b4 _\br_\be_\ba_\bl_\bn_\ba_\bm_\be
+ ``spam_separator'' controls what happens when multiple spam headers are matched: if unset, each successive header will overwrite any previous matches value for the spam label. If set, each successive match will append to the previous, using ``spam_separator'' as a separator.
- Type: string
+313. spoolfile
- Default: ''
+ Type: path
- This variable specifies what ``real'' or ``personal'' name should be used when
- sending messages.
+ Default: ""
- By default, this is the GECOS field from /etc/passwd.
+ If your spool mailbox is in a non-default place where Mutt-ng cannot find it, you can specify its location with this variable. Mutt-ng will automatically set this variable to the value of the environment variable $MAIL if it is not set.
- _\bN_\bo_\bt_\be_\b: This variable will _\bn_\bo_\bt be used when the user has set a real name in the
- _\b$_\bf_\br_\bo_\bm (section 7.4.80 , page 108) variable.
+314. ssl_ca_certificates_file
- _\b7_\b._\b4_\b._\b2_\b4_\b5 _\br_\be_\bc_\ba_\bl_\bl
+ Type: path
- Type: quadoption
+ Default: ""
- Default: ask-yes
+ This variable specifies a file containing trusted CA certificates. Any server certificate that is signed with one of these CA certificates are also automatically accepted.
- Controls whether or not Mutt-ng recalls postponed messages when composing a new
- message. Also see ``_\b$_\bp_\bo_\bs_\bt_\bp_\bo_\bn_\be_\bd (section 7.4.230 , page 145)''.
+ Example: set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
- Setting this variable to _\by_\be_\bs is not generally useful, and thus not recommended.
+315. ssl_client_cert
- _\b7_\b._\b4_\b._\b2_\b4_\b6 _\br_\be_\bc_\bo_\br_\bd
+ Type: path
- The Mutt Next Generation E-Mail Client 149
+ Default: ""
- Type: path
+ Availability: SSL
- Default: ''
+ The file containing a client certificate and its associated private key.
- This specifies the file into which your outgoing messages should be appended.
- (This is meant as the primary method for saving a copy of your messages, but
- another way to do this is using the ``_\bm_\by_\b__\bh_\bd_\br (section 3.16 , page 38)'' com-
- mand to create a Bcc: header field with your email address in it.)
+316. ssl_force_tls
- The value of _\b$_\br_\be_\bc_\bo_\br_\bd _\b(_\bs_\be_\bc_\bt_\bi_\bo_\bn _\b7_\b._\b4_\b._\b2_\b4_\b6 _\b, _\bp_\ba_\bg_\be _\b1_\b4_\b8_\b) is overridden by the
- ``_\b$_\bf_\bo_\br_\bc_\be_\b__\bn_\ba_\bm_\be (section 7.4.74 , page 107)'' and ``_\b$_\bs_\ba_\bv_\be_\b__\bn_\ba_\bm_\be (section
- 7.4.257 , page 151)'' variables, and the ``_\bf_\bc_\bc_\b-_\bh_\bo_\bo_\bk (section 3.19 , page
- 39)'' command.
+ Type: boolean
- _\b7_\b._\b4_\b._\b2_\b4_\b7 _\br_\be_\bp_\bl_\by_\b__\br_\be_\bg_\be_\bx_\bp
+ Default: no
- Type: regular expression
+ If this variable is set, mutt-ng will require that all connections to remote servers be encrypted. Furthermore it will attempt to negotiate TLS even if the server does not advertise the capability, since it would otherwise have to abort the connection anyway. This option supersedes ``$ssl_starttls''.
- Default: '^(re([\[0-9\]+])*|aw):[ \t]*'
+317. ssl_min_dh_prime_bits
- A regular expression used to recognize reply messages when threading and reply-
- ing. The default value corresponds to the English ``Re:'' and the German
- ``Aw:''.
+ Type: number
- _\b7_\b._\b4_\b._\b2_\b4_\b8 _\br_\be_\bp_\bl_\by_\b__\bs_\be_\bl_\bf
+ Default: 0
- Type: boolean
+ Availability: GNUTLS
- Default: no
+ This variable specifies the minimum acceptable prime size (in bits) for use in any Diffie-Hellman key exchange. A value of 0 will use the default from the GNUTLS library.
- If _\bu_\bn_\bs_\be_\bt and you are replying to a message sent by you, Mutt-ng will assume
- that you want to reply to the recipients of that message rather than to your-
- self.
+318. ssl_starttls
- _\b7_\b._\b4_\b._\b2_\b4_\b9 _\br_\be_\bp_\bl_\by_\b__\bt_\bo
+ Type: quadoption
- Type: quadoption
+ Default: yes
- Default: ask-yes
+ Availability: SSL or GNUTLS
- If _\bs_\be_\bt, when replying to a message, Mutt-ng will use the address listed in the
- ``Reply-To:'' header field as the recipient of the reply. If _\bu_\bn_\bs_\be_\bt, it will
- use the address in the ``From:'' header field instead.
+ If set (the default), Mutt-ng will attempt to use STARTTLS on servers advertising the capability. When unset, Mutt-ng will not attempt to use STARTTLS regardless of the server's capabilities.
- This option is useful for reading a mailing list that sets the ``Reply-To:''
- header field to the list address and you want to send a private message to the
- author of a message.
+319. ssl_use_sslv2
- _\b7_\b._\b4_\b._\b2_\b5_\b0 _\br_\be_\bs_\bo_\bl_\bv_\be
+ Type: boolean
- Type: boolean
+ Default: yes
- Default: yes
+ Availability: SSL
- The Mutt Next Generation E-Mail Client 150
+ This variables specifies whether to attempt to use SSLv2 in the SSL authentication process.
- When set, the cursor will be automatically advanced to the next (possibly
- undeleted) message whenever a command that modifies the current message is exe-
- cuted.
+320. ssl_use_sslv3
- _\b7_\b._\b4_\b._\b2_\b5_\b1 _\br_\be_\bv_\be_\br_\bs_\be_\b__\ba_\bl_\bi_\ba_\bs
+ Type: boolean
- Type: boolean
+ Default: yes
- Default: no
+ Availability: SSL or GNUTLS
- This variable controls whether or not Mutt-ng will display the ``personal''
- name from your aliases in the index menu if it finds an alias that matches the
- message's sender. For example, if you have the following alias:
+ This variables specifies whether to attempt to use SSLv3 in the SSL authentication process.
- alias juser abd30425@somewhere.net (Joe User)
+321. ssl_use_tlsv1
- and then you receive mail which contains the following header:
+ Type: boolean
- From: abd30425@somewhere.net
+ Default: yes
- It would be displayed in the index menu as ``Joe User'' instead of
- ``abd30425@somewhere.net.'' This is useful when the person's e-mail address is
- not human friendly (like CompuServe addresses).
+ Availability: SSL or GNUTLS
- _\b7_\b._\b4_\b._\b2_\b5_\b2 _\br_\be_\bv_\be_\br_\bs_\be_\b__\bn_\ba_\bm_\be
+ This variables specifies whether to attempt to use TLSv1 in the SSL authentication process.
- Type: boolean
+322. ssl_usesystemcerts
- Default: no
+ Type: boolean
- It may sometimes arrive that you receive mail to a certain machine, move the
- messages to another machine, and reply to some the messages from there. If
- this variable is _\bs_\be_\bt, the default From: line of the reply messages is built
- using the address where you received the messages you are replying to i\bif\bf that
- address matches your alternates. If the variable is _\bu_\bn_\bs_\be_\bt, or the address that
- would be used doesn't match your alternates, the From: line will use your
- address on the current machine.
+ Default: yes
- _\b7_\b._\b4_\b._\b2_\b5_\b3 _\br_\be_\bv_\be_\br_\bs_\be_\b__\br_\be_\ba_\bl_\bn_\ba_\bm_\be
+ Availability: SSL
- Type: boolean
+ If set to yes, Mutt-ng will use CA certificates in the system-wide certificate store when checking if server certificate is signed by a trusted CA.
- Default: yes
+323. status_chars
- This variable fine-tunes the behaviour of the _\br_\be_\bv_\be_\br_\bs_\be_\b__\bn_\ba_\bm_\be (section 7.4.252 ,
- page 150) feature. When it is _\bs_\be_\bt, Mutt-ng will use the address from incoming
- messages as-is, possibly including eventual real names. When it is _\bu_\bn_\bs_\be_\bt,
- Mutt-ng will override any such real names with the setting of the _\br_\be_\ba_\bl_\bn_\ba_\bm_\be
- (section 7.4.244 , page 148) variable.
+ Type: string
- _\b7_\b._\b4_\b._\b2_\b5_\b4 _\br_\bf_\bc_\b2_\b0_\b4_\b7_\b__\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br_\bs
+ Default: "-*%A"
- Type: boolean
+ Controls the characters used by the ``%r'' indicator in ``$status_format''. The first character is used when the mailbox is unchanged. The second is used when the mailbox has been changed, and it needs to be resynchronized. The third is used if the mailbox is in read-only mode, or if the mailbox will not be written when exiting that mailbox (You can toggle whether to write changes to a mailbox with the toggle-write operation, bound by default to ``%''). The fourth is used to indicate that the current folder has been opened in attach-message mode (Certain operations like composing a new mail, replying, forwarding, etc. are not permitted in this mode).
- The Mutt Next Generation E-Mail Client 151
+324. status_format
- Default: no
+ Type: string
- When this variable is _\bs_\be_\bt, Mutt-ng will decode RFC-2047-encoded MIME parame-
- ters. You want to set this variable when Mutt-ng suggests you to save attach-
- ments to files named like this:
+ Default: "-%r-Mutt-ng: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F? Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%s/%S)-%>-(%P)---"
- =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
+ Controls the format of the status line displayed in the index menu. This string is similar to ``$index_format'', but has its own set of printf(3)-like sequences:
- When this variable is _\bs_\be_\bt interactively, the change doesn't have the desired
- effect before you have changed folders.
+ %b
+ number of mailboxes with new mail *
- Note that this use of RFC 2047's encoding is explicitly, prohibited by the
- standard, but nevertheless encountered in the wild.
+ %B
+ the short pathname of the current mailbox
- Also note that setting this parameter will _\bn_\bo_\bt have the effect that Mutt-ng
- _\bg_\be_\bn_\be_\br_\ba_\bt_\be_\bs this kind of encoding. Instead, Mutt-ng will unconditionally use the
- encoding specified in RFC 2231.
+ %d
+ number of deleted messages *
- _\b7_\b._\b4_\b._\b2_\b5_\b5 _\bs_\ba_\bv_\be_\b__\ba_\bd_\bd_\br_\be_\bs_\bs
+ %f
+ the full pathname of the current mailbox
- Type: boolean
+ %F
+ number of flagged messages *
- Default: no
+ %h
+ local hostname
- If _\bs_\be_\bt, Mutt-ng will take the sender's full address when choosing a default
- folder for saving a mail. If ``_\b$_\bs_\ba_\bv_\be_\b__\bn_\ba_\bm_\be (section 7.4.257 , page 151)'' or
- ``_\b$_\bf_\bo_\br_\bc_\be_\b__\bn_\ba_\bm_\be (section 7.4.74 , page 107)'' is _\bs_\be_\bt too, the selection of the
- fcc folder will be changed as well.
+ %l
+ size (in bytes) of the current mailbox *
- _\b7_\b._\b4_\b._\b2_\b5_\b6 _\bs_\ba_\bv_\be_\b__\be_\bm_\bp_\bt_\by
+ %L
+ size (in bytes) of the messages shown (i.e., which match the current limit) *
- Type: boolean
+ %m
+ the number of messages in the mailbox *
- Default: yes
+ %M
+ the number of messages shown (i.e., which match the current limit) *
- When _\bu_\bn_\bs_\be_\bt, mailboxes which contain no saved messages will be removed when
- closed (the exception is ``_\b$_\bs_\bp_\bo_\bo_\bl_\bf_\bi_\bl_\be (section 7.4.313 , page 165)'' which is
- never removed). If _\bs_\be_\bt, mailboxes are never removed.
+ %n
+ number of new messages in the mailbox *
- N\bNo\bot\bte\be:\b: This only applies to mbox and MMDF folders, Mutt-ng does not delete MH
- and Maildir directories.
+ %o
+ number of old unread messages *
- _\b7_\b._\b4_\b._\b2_\b5_\b7 _\bs_\ba_\bv_\be_\b__\bn_\ba_\bm_\be
+ %p
+ number of postponed messages *
- Type: boolean
+ %P
+ percentage of the way through the index
- Default: no
+ %r
+ modified/read-only/won't-write/attach-message indicator, according to $status_chars
- This variable controls how copies of outgoing messages are saved. When set, a
- check is made to see if a mailbox specified by the recipient address exists
- (this is done by searching for a mailbox in the ``_\b$_\bf_\bo_\bl_\bd_\be_\br (section 7.4.70 ,
- page 105)'' directory with the _\bu_\bs_\be_\br_\bn_\ba_\bm_\be part of the recipient address). If the
- mailbox exists, the outgoing message will be saved to that mailbox, otherwise
- the message is saved to the ``_\b$_\br_\be_\bc_\bo_\br_\bd (section 7.4.246 , page 148)'' mailbox.
+ %s
+ current sorting mode ($sort)
- The Mutt Next Generation E-Mail Client 152
+ %S
+ current aux sorting method ($sort_aux)
- Also see the ``_\b$_\bf_\bo_\br_\bc_\be_\b__\bn_\ba_\bm_\be (section 7.4.74 , page 107)'' variable.
+ %t
+ number of tagged messages *
- _\b7_\b._\b4_\b._\b2_\b5_\b8 _\bs_\bc_\bo_\br_\be
+ %u
+ number of unread messages *
- Type: boolean
+ %v
+ Mutt-ng version string
- Default: yes
+ %V
+ currently active limit pattern, if any *
- When this variable is _\bu_\bn_\bs_\be_\bt, scoring is turned off. This can be useful to
- selectively disable scoring for certain folders when the ``_\b$_\bs_\bc_\bo_\br_\be_\b__\bt_\bh_\br_\be_\bs_\bh_\b-
- _\bo_\bl_\bd_\b__\bd_\be_\bl_\be_\bt_\be (section 7.4.259 , page 152)'' variable and friends are used.
+ %>X
+ right justify the rest of the string and pad with "X"
- _\b7_\b._\b4_\b._\b2_\b5_\b9 _\bs_\bc_\bo_\br_\be_\b__\bt_\bh_\br_\be_\bs_\bh_\bo_\bl_\bd_\b__\bd_\be_\bl_\be_\bt_\be
+ %|X
+ pad to the end of the line with "X"
- Type: number
+ * = can be optionally printed if nonzero
- Default: -1
+ Some of the above sequences can be used to optionally print a string if their value is nonzero. For example, you may only want to see the number of flagged messages if such messages exist, since zero is not particularly meaningful. To optionally print a string based upon one of the above sequences, the following construct is used
- Messages which have been assigned a score equal to or lower than the value of
- this variable are automatically marked for deletion by Mutt-ng. Since Mutt-ng
- scores are always greater than or equal to zero, the default setting of this
- variable will never mark a message for deletion.
+ %?<sequence_char>?<optional_string>?
- _\b7_\b._\b4_\b._\b2_\b6_\b0 _\bs_\bc_\bo_\br_\be_\b__\bt_\bh_\br_\be_\bs_\bh_\bo_\bl_\bd_\b__\bf_\bl_\ba_\bg
+ where sequence_char is a character from the table above, and optional_string is the string you would like printed if sequence_char is nonzero. optional_string may contain other sequences as well as normal text, but you may not nest optional strings.
- Type: number
+ Here is an example illustrating how to optionally print the number of new messages in a mailbox:
- Default: 9999
+ %?n?%n new messages.?
- Messages which have been assigned a score greater than or equal to this vari-
- able's value are automatically marked ``flagged''.
+ Additionally you can switch between two strings, the first one, if a value is zero, the second one, if the value is nonzero, by using the following construct:
- _\b7_\b._\b4_\b._\b2_\b6_\b1 _\bs_\bc_\bo_\br_\be_\b__\bt_\bh_\br_\be_\bs_\bh_\bo_\bl_\bd_\b__\br_\be_\ba_\bd
+ %?<sequence_char>?<if_string>&<else_string>?
- Type: number
+ You can additionally force the result of any printf(3)-like sequence to be lowercase by prefixing the sequence character with an underscore (_) sign. For example, if you want to display the local hostname in lowercase, you would use:
- Default: -1
+ %_h
- Messages which have been assigned a score equal to or lower than the value of
- this variable are automatically marked as read by Mutt-ng. Since Mutt-ng
- scores are always greater than or equal to zero, the default setting of this
- variable will never mark a message read.
+ If you prefix the sequence character with a colon (:) character, Mutt-ng will replace any dots in the expansion by underscores. This might be helpful with IMAP folders that don't like dots in folder names.
- _\b7_\b._\b4_\b._\b2_\b6_\b2 _\bs_\be_\bn_\bd_\b__\bc_\bh_\ba_\br_\bs_\be_\bt
+325. status_on_top
- Type: string
+ Type: boolean
- Default: 'us-ascii:iso-8859-1:utf-8'
+ Default: no
- A list of character sets for outgoing messages. Mutt-ng will use the first
- character set into which the text can be converted exactly. If your ``_\b$_\bc_\bh_\ba_\br_\bs_\be_\bt
- (section 7.4.27 , page 96)'' is not iso-8859-1 and recipients may not under-
- stand UTF-8, it is advisable to include in the list an appropriate widely used
- standard character set (such as iso-8859-2, koi8-r or iso-2022-jp) either
+ Setting this variable causes the ``status bar'' to be displayed on the first line of the screen rather than near the bottom.
- The Mutt Next Generation E-Mail Client 153
+326. strict_mailto
- instead of or after iso-8859-1.
+ Type: boolean
- _\b7_\b._\b4_\b._\b2_\b6_\b3 _\bs_\be_\bn_\bd_\bm_\ba_\bi_\bl
+ Default: yes
- Type: path
+ With mailto: style links, a body as well as arbitrary header information may be embedded. This may lead to (user) headers being overwriten without note if ``$edit_headers'' is unset.
- Default: '/usr/sbin/sendmail -oem -oi'
+ If this variable is set, mutt-ng is strict and allows anything to be changed. If it's unset, all headers given will be prefixed with ``X-Mailto-'' and the message including headers will be shown in the editor regardless of what ``$edit_headers'' is set to.
- Specifies the program and arguments used to deliver mail sent by Mutt-ng.
- Mutt-ng expects that the specified program interprets additional arguments as
- recipient addresses.
+327. strict_mime
- _\b7_\b._\b4_\b._\b2_\b6_\b4 _\bs_\be_\bn_\bd_\bm_\ba_\bi_\bl_\b__\bw_\ba_\bi_\bt
+ Type: boolean
- Type: number
+ Default: yes
- Default: 0
+ When unset, non MIME-compliant messages that doesn't have any charset indication in the ``Content-Type:'' header field can be displayed (non MIME-compliant messages are often generated by old mailers or buggy mailers like MS Outlook Express). See also $assumed_charset.
- Specifies the number of seconds to wait for the ``_\b$_\bs_\be_\bn_\bd_\bm_\ba_\bi_\bl (section 7.4.263 ,
- page 152)'' process to finish before giving up and putting delivery in the
- background.
+ This option also replaces linear-white-space between encoded-word and *text to a single space to prevent the display of MIME-encoded ``Subject:'' header field from being devided into multiple lines.
- Mutt-ng interprets the value of this variable as follows:
+328. strict_threads
- >0
- number of seconds to wait for sendmail to finish before continuing
+ Type: boolean
- 0
- wait forever for sendmail to finish
+ Default: no
- <0
- always put sendmail in the background without waiting
+ If set, threading will only make use of the ``In-Reply-To:'' and ``References:'' header fields when you ``$sort'' by message threads. By default, messages with the same subject are grouped together in ``pseudo threads.'' This may not always be desirable, such as in a personal mailbox where you might have several unrelated messages with the subject ``hi'' which will get grouped together.
- Note that if you specify a value other than 0, the output of the child process
- will be put in a temporary file. If there is some error, you will be informed
- as to where to find the output.
+329. strip_was
- _\b7_\b._\b4_\b._\b2_\b6_\b5 _\bs_\bh_\be_\bl_\bl
+ Type: boolean
- Type: path
+ Default: no
- Default: ''
+ When set, mutt-ng will remove the trailing part of the ``Subject:'' line which matches $strip_was_regex when replying. This is useful to properly react on subject changes and reduce ``subject noise.'' (esp. in Usenet)
- Command to use when spawning a subshell. By default, the user's login shell
- from /etc/passwd is used.
+330. strip_was_regex
- _\b7_\b._\b4_\b._\b2_\b6_\b6 _\bs_\bi_\bd_\be_\bb_\ba_\br_\b__\bb_\bo_\bu_\bn_\bd_\ba_\br_\by
+ Type: regular expression
- Type: string
+ Default: "\([Ww][Aa][RrSs]: .*\)[ ]*$"
- Default: '.'
+ When non-empty and $strip_was is set, mutt-ng will remove this trailing part of the ``Subject'' line when replying if it won't be empty afterwards.
- When the sidebar is displayed and _\b$_\bs_\bi_\bd_\be_\bb_\ba_\br_\b__\bs_\bh_\bo_\br_\bt_\be_\bn_\b__\bh_\bi_\be_\br_\ba_\br_\bc_\bh_\by (section
- 7.4.270 , page 154) is _\bs_\be_\bt, this variable specifies the characters at which to
+331. stuff_quoted
- The Mutt Next Generation E-Mail Client 154
+ Type: boolean
- split a folder name into ``hierarchy items.''
+ Default: no
- _\b7_\b._\b4_\b._\b2_\b6_\b7 _\bs_\bi_\bd_\be_\bb_\ba_\br_\b__\bd_\be_\bl_\bi_\bm
+ If set, attachments with flowed format will have their quoting ``stuffed'', i.e. a space will be inserted between the quote characters and the actual text.
- Type: string
+332. suspend
- Default: '|'
+ Type: boolean
- This specifies the delimiter between the sidebar (if visible) and other
- screens.
+ Default: yes
- _\b7_\b._\b4_\b._\b2_\b6_\b8 _\bs_\bi_\bd_\be_\bb_\ba_\br_\b__\bn_\be_\bw_\bm_\ba_\bi_\bl_\b__\bo_\bn_\bl_\by
+ When unset, Mutt-ng won't stop when the user presses the terminal's susp key, usually CTRL+Z. This is useful if you run Mutt-ng inside an xterm using a command like ``xterm -e muttng.''
- Type: boolean
+333. text_flowed
- Default: no
+ Type: boolean
- If _\bs_\be_\bt, only folders with new mail will be shown in the sidebar.
+ Default: no
- _\b7_\b._\b4_\b._\b2_\b6_\b9 _\bs_\bi_\bd_\be_\bb_\ba_\br_\b__\bn_\bu_\bm_\bb_\be_\br_\b__\bf_\bo_\br_\bm_\ba_\bt
+ When set, Mutt-ng will generate text/plain; format=flowed attachments. This format is easier to handle for some mailing software, and generally just looks like ordinary text. To actually make use of this format's features, you'll need support in your editor.
- Type: string
+ Note that $indent_string is ignored when this option is set.
- Default: '%m%?n?(%n)?%?f?[%f]?'
+334. thorough_search
- This variable controls how message counts are printed when the sidebar is
- enabled. If this variable is _\be_\bm_\bp_\bt_\by (_\ba_\bn_\bd _\bo_\bn_\bl_\by _\bi_\bf), no numbers will be printed
- _\ba_\bn_\bd mutt-ng won't frequently count mail (which may be a great speedup esp. with
- mbox-style mailboxes.)
+ Type: boolean
- The following printf(3)-like sequences are supported all of which may be
- printed non-zero:
+ Default: no
- %d
- Number of deleted messages. 1)
+ Affects the ˜b and ˜h search operations described in section ``patterns'' above. If set, the headers and attachments of messages to be searched are decoded before searching. If unset, messages are searched as they appear in the folder.
- %F
- Number of flagged messages.
+335. thread_received
- %m
- Total number of messages.
+ Type: boolean
- %M
- Total number of messages shown, i.e. not hidden by a limit. 1)
+ Default: no
- %n
- Number of new messages.
+ When set, Mutt-ng uses the date received rather than the date sent to thread messages by subject.
- %t
- Number of tagged messages. 1)
+336. tilde
- 1) These expandos only have a non-zero value for the current mailbox and will
- always be zero otherwise.
+ Type: boolean
- The Mutt Next Generation E-Mail Client 155
+ Default: no
- _\b7_\b._\b4_\b._\b2_\b7_\b0 _\bs_\bi_\bd_\be_\bb_\ba_\br_\b__\bs_\bh_\bo_\br_\bt_\be_\bn_\b__\bh_\bi_\be_\br_\ba_\br_\bc_\bh_\by
+ When set, the internal-pager will pad blank lines to the bottom of the screen with a tilde (˜).
- Type: boolean
+337. timeout
- Default: no
+ Type: number
- When _\bs_\be_\bt, the ``hierarchy'' of the sidebar entries will be shortened only if
- they cannot be printed in full length (because ``_\b$_\bs_\bi_\bd_\be_\bb_\ba_\br_\b__\bw_\bi_\bd_\bt_\bh (section
- 7.4.272 , page 155)'' is set to a too low value). For example, if the news-
- group name ``de.alt.sysadmin.recovery'' doesn't fit on the screen, it'll get
- shortened ``d.a.s.recovery'' while ``de.alt.d0'' still would and thus will not
- get shortened.
+ Default: 600
- At which characters this compression is done is controled via the _\b$_\bs_\bi_\bd_\be_\b-
- _\bb_\ba_\br_\b__\bb_\bo_\bu_\bn_\bd_\ba_\br_\by (section 7.4.266 , page 153) variable.
+ This variable controls the number of seconds Mutt-ng will wait for a key to be pressed in the main menu before timing out and checking for new mail. A value of zero or less will cause Mutt-ng to never time out.
- _\b7_\b._\b4_\b._\b2_\b7_\b1 _\bs_\bi_\bd_\be_\bb_\ba_\br_\b__\bv_\bi_\bs_\bi_\bb_\bl_\be
+338. tmpdir
- Type: boolean
+ Type: path
- Default: no
+ Default: ""
- This specifies whether or not to show the sidebar (a list of folders specified
- with the ``mailboxes'' command).
+ This variable allows you to specify where Mutt-ng will place its temporary files needed for displaying and composing messages. If this variable is not set, the environment variable $TMPDIR is used. If $TMPDIR is not set then "/tmp" is used.
- _\b7_\b._\b4_\b._\b2_\b7_\b2 _\bs_\bi_\bd_\be_\bb_\ba_\br_\b__\bw_\bi_\bd_\bt_\bh
+339. to_chars
- Type: number
+ Type: string
- Default: 0
+ Default: " +TCFL"
- The width of the sidebar.
+ Controls the character used to indicate mail addressed to you. The first character is the one used when the mail is NOT addressed to your address (default: space). The second is used when you are the only recipient of the message (default: +). The third is when your address appears in the ``To:'' header field, but you are not the only recipient of the message (default: T). The fourth character is used when your address is specified in the ``Cc:'' header field, but you are not the only recipient. The fifth character is used to indicate mail that was sent by you. The sixth character is used to indicate when a mail was sent to a mailing-list you're subscribe to (default: L).
- _\b7_\b._\b4_\b._\b2_\b7_\b3 _\bs_\bi_\bg_\b__\bd_\ba_\bs_\bh_\be_\bs
+340. trash
- Type: boolean
+ Type: path
- Default: yes
+ Default: ""
- If set, a line containing ``-- '' (dash, dash, space) will be inserted before
- your ``_\b$_\bs_\bi_\bg_\bn_\ba_\bt_\bu_\br_\be (section 7.4.275 , page 155)''. It is s\bst\btr\bro\bon\bng\bgl\bly\by recommended
- that you not unset this variable unless your ``signature'' contains just your
- name. The reason for this is because many software packages use ``-- \n'' to
- detect your signature.
+ If set, this variable specifies the path of the trash folder where the mails marked for deletion will be moved, instead of being irremediably purged.
- For example, Mutt-ng has the ability to highlight the signature in a different
- color in the builtin pager.
+ Note: When you delete a message in the trash folder, it is really deleted, so that there is no way to recover mail.
- _\b7_\b._\b4_\b._\b2_\b7_\b4 _\bs_\bi_\bg_\b__\bo_\bn_\b__\bt_\bo_\bp
+341. tunnel
- Type: boolean
+ Type: string
- Default: no
+ Default: ""
- The Mutt Next Generation E-Mail Client 156
+ Setting this variable will cause Mutt-ng to open a pipe to a command instead of a raw socket. You may be able to use this to set up preauthenticated connections to your IMAP/POP3 server. Example:
- If _\bs_\be_\bt, the signature will be included before any quoted or forwarded text. It
- is s\bst\btr\bro\bon\bng\bgl\bly\by recommended that you do not set this variable unless you really
- know what you are doing, and are prepared to take some heat from netiquette
- guardians.
+ tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
- _\b7_\b._\b4_\b._\b2_\b7_\b5 _\bs_\bi_\bg_\bn_\ba_\bt_\bu_\br_\be
+ Note: For this example to work you must be able to log in to the remote machine without having to enter a password.
- Type: path
+342. umask
- Default: '~/.signature'
+ Type: number
- Specifies the filename of your signature, which is appended to all outgoing
- messages. If the filename ends with a pipe (``|''), it is assumed that file-
- name is a shell command and input should be read from its stdout.
+ Default: 0077
- _\b7_\b._\b4_\b._\b2_\b7_\b6 _\bs_\bi_\bg_\bn_\bo_\bf_\bf_\b__\bs_\bt_\br_\bi_\bn_\bg
+ This sets the umask that will be used by Mutt-ng when creating all kinds of files. If unset, the default value is 077.
- Type: string
+343. uncollapse_jump
- Default: ''
+ Type: boolean
- If _\bs_\be_\bt, this string will be inserted before the signature. This is useful for
- people that want to sign off every message they send with their name.
+ Default: no
- If you want to insert your website's URL, additional contact information or
- witty quotes into your mails, better use a signature file instead of the sig-
- noff string.
+ When set, Mutt-ng will jump to the next unread message, if any, when the current thread is uncollapsed.
- _\b7_\b._\b4_\b._\b2_\b7_\b7 _\bs_\bi_\bm_\bp_\bl_\be_\b__\bs_\be_\ba_\br_\bc_\bh
+344. use_8bitmime
- Type: string
+ Type: boolean
- Default: '~f %s | ~s %s'
+ Default: no
- Specifies how Mutt-ng should expand a simple search into a real search pattern.
- A simple search is one that does not contain any of the ~ operators. See
- ``_\bp_\ba_\bt_\bt_\be_\br_\bn_\bs (section 7.2 , page 84)'' for more information on search patterns.
+ Warning: do not set this variable unless you are using a version of sendmail which supports the -B8BITMIME flag (such as sendmail 8.8.x) or in connection with the SMTP support via libESMTP. Otherwise you may not be able to send mail.
- For example, if you simply type ``joe'' at a search or limit prompt, Mutt-ng
- will automatically expand it to the value specified by this variable. For the
- default value it would be:
+ When set, Mutt-ng will either invoke ``$sendmail'' with the -B8BITMIME flag when sending 8-bit messages to enable ESMTP negotiation or tell libESMTP to do so.
- ~f joe | ~s joe
+345. use_domain
- _\b7_\b._\b4_\b._\b2_\b7_\b8 _\bs_\bl_\be_\be_\bp_\b__\bt_\bi_\bm_\be
+ Type: boolean
- Type: number
+ Default: yes
- Default: 1
+ When set, Mutt-ng will qualify all local addresses (ones without the @host portion) with the value of ``$hostname''. If unset, no addresses will be qualified.
- Specifies time, in seconds, to pause while displaying certain informational
- messages, while moving from folder to folder and after expunging messages from
- the current folder. The default is to pause one second, so a value of zero for
- this option suppresses the pause.
+346. use_from
- The Mutt Next Generation E-Mail Client 157
+ Type: boolean
- _\b7_\b._\b4_\b._\b2_\b7_\b9 _\bs_\bm_\ba_\br_\bt_\b__\bw_\br_\ba_\bp
+ Default: yes
- Type: boolean
+ When set, Mutt-ng will generate the ``From:'' header field when sending messages. If unset, no ``From:'' header field will be generated unless the user explicitly sets one using the ``my_hdr'' command.
- Default: yes
+347. use_idn
- Controls the display of lines longer than the screen width in the internal
- pager. If _\bs_\be_\bt, long lines are wrapped at a word boundary. If _\bu_\bn_\bs_\be_\bt, lines are
- simply wrapped at the screen edge. Also see the ``_\b$_\bm_\ba_\br_\bk_\be_\br_\bs (section 7.4.127 ,
- page 121)'' variable.
+ Type: boolean
- _\b7_\b._\b4_\b._\b2_\b8_\b0 _\bs_\bm_\bi_\bl_\be_\by_\bs
+ Default: yes
- Type: regular expression
+ Availability: IDN
- Default: '(>From )|(:[-^]?[][)(><}{|/DP])'
+ When set, Mutt-ng will show you international domain names decoded.
- The _\bp_\ba_\bg_\be_\br uses this variable to catch some common false positives of
- ``_\b$_\bq_\bu_\bo_\bt_\be_\b__\br_\be_\bg_\be_\bx_\bp (section 7.4.241 , page 147)'', most notably smileys in the
- beginning of a line
+ Note: You can use IDNs for addresses even if this is unset. This variable only affects decoding.
- _\b7_\b._\b4_\b._\b2_\b8_\b1 _\bs_\bm_\bi_\bm_\be_\b__\ba_\bs_\bk_\b__\bc_\be_\br_\bt_\b__\bl_\ba_\bb_\be_\bl
+348. use_ipv6
- Type: boolean
+ Type: boolean
- Default: yes
+ Default: yes
- This flag controls whether you want to be asked to enter a label for a certifi-
- cate about to be added to the database or not. It is _\bs_\be_\bt by default. (S/MIME
- only)
+ When set, Mutt-ng will look for IPv6 addresses of hosts it tries to contact. If this option is unset, Mutt-ng will restrict itself to IPv4 addresses. Normally, the default should work.
- _\b7_\b._\b4_\b._\b2_\b8_\b2 _\bs_\bm_\bi_\bm_\be_\b__\bc_\ba_\b__\bl_\bo_\bc_\ba_\bt_\bi_\bo_\bn
+349. visual
- Type: path
+ Type: path
- Default: ''
+ Default: ""
- This variable contains the name of either a directory, or a file which contains
- trusted certificates for use with OpenSSL. (S/MIME only)
+ Specifies the visual editor to invoke when the ˜v command is given in the builtin editor.
- _\b7_\b._\b4_\b._\b2_\b8_\b3 _\bs_\bm_\bi_\bm_\be_\b__\bc_\be_\br_\bt_\bi_\bf_\bi_\bc_\ba_\bt_\be_\bs
+350. wait_key
- Type: path
+ Type: boolean
- Default: ''
+ Default: yes
- Since there is no pubring/secring as with PGP, Mutt-ng has to handle storage
- and retrieval of keys by itself. This is very basic right now, and keys and
- certificates are stored in two different directories, both named as the hash-
- value retrieved from OpenSSL. There is an index file which contains mailbox-
- address keyid pairs, and which can be manually edited. This one points to the
- location of the certificates. (S/MIME only)
+ Controls whether Mutt-ng will ask you to press a key after shell- escape, pipe-message, pipe-entry, print-message, and print-entry commands.
- The Mutt Next Generation E-Mail Client 158
+ It is also used when viewing attachments with ``auto_view'', provided that the corresponding mailcap entry has a needsterminal flag, and the external program is interactive.
- _\b7_\b._\b4_\b._\b2_\b8_\b4 _\bs_\bm_\bi_\bm_\be_\b__\bd_\be_\bc_\br_\by_\bp_\bt_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ When set, Mutt-ng will always ask for a key. When unset, Mutt-ng will wait for a key only if the external command returned a non-zero status.
- Type: string
+351. weed
- Default: ''
+ Type: boolean
- This format string specifies a command which is used to decrypt application/x-
- pkcs7-mime attachments.
+ Default: yes
- The OpenSSL command formats have their own set of printf(3)-like sequences sim-
- ilar to PGP's:
+ When set, Mutt-ng will weed headers when displaying, forwarding, printing, or replying to messages.
- %f
- Expands to the name of a file containing a message.
+352. wrap_search
- %s
- Expands to the name of a file containing the signature part of a
- multipart/signed attachment when verifying it.
+ Type: boolean
- %k
- The key-pair specified with _\b$_\bs_\bm_\bi_\bm_\be_\b__\bd_\be_\bf_\ba_\bu_\bl_\bt_\b__\bk_\be_\by (section 7.4.286 ,
- page 158)
+ Default: yes
- %c
- One or more certificate IDs.
+ Controls whether searches wrap around the end of the mailbox.
- %a
- The algorithm used for encryption.
+ When set, searches will wrap around the first (or last) message. When unset, searches will not wrap.
- %C
- CA location: Depending on whether _\b$_\bs_\bm_\bi_\bm_\be_\b__\bc_\ba_\b__\bl_\bo_\bc_\ba_\bt_\bi_\bo_\bn (section
- 7.4.282 , page 157) points to a directory or file, this expands to
- '-CApath _\b$_\bs_\bm_\bi_\bm_\be_\b__\bc_\ba_\b__\bl_\bo_\bc_\ba_\bt_\bi_\bo_\bn (section 7.4.282 , page 157)' or
- '-CAfile _\b$_\bs_\bm_\bi_\bm_\be_\b__\bc_\ba_\b__\bl_\bo_\bc_\ba_\bt_\bi_\bo_\bn (section 7.4.282 , page 157)'.
+353. wrapmargin
- For examples on how to configure these formats, see the smime.rc in the sam-
- ples/ subdirectory which has been installed on your system alongside the docu-
- mentation. (S/MIME only)
+ Type: number
- _\b7_\b._\b4_\b._\b2_\b8_\b5 _\bs_\bm_\bi_\bm_\be_\b__\bd_\be_\bc_\br_\by_\bp_\bt_\b__\bu_\bs_\be_\b__\bd_\be_\bf_\ba_\bu_\bl_\bt_\b__\bk_\be_\by
+ Default: 0
- Type: boolean
+ Controls the size of the margin remaining at the right side of the terminal when Mutt-ng's pager does smart wrapping.
- Default: yes
+354. write_bcc
- If _\bs_\be_\bt (default) this tells Mutt-ng to use the default key for decryption. Oth-
- erwise, if manage multiple certificate-key-pairs, Mutt-ng will try to use the
- mailbox-address to determine the key to use. It will ask you to supply a key,
- if it can't find one. (S/MIME only)
+ Type: boolean
- _\b7_\b._\b4_\b._\b2_\b8_\b6 _\bs_\bm_\bi_\bm_\be_\b__\bd_\be_\bf_\ba_\bu_\bl_\bt_\b__\bk_\be_\by
+ Default: yes
- Type: string
+ Controls whether Mutt-ng writes out the Bcc header when preparing messages to be sent. Exim users may wish to unset this.
- The Mutt Next Generation E-Mail Client 159
+355. write_inc
- Default: ''
+ Type: number
- This is the default key-pair to use for signing. This must be set to the keyid
- (the hash-value that OpenSSL generates) to work properly (S/MIME only)
+ Default: 10
- _\b7_\b._\b4_\b._\b2_\b8_\b7 _\bs_\bm_\bi_\bm_\be_\b__\be_\bn_\bc_\br_\by_\bp_\bt_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ When writing a mailbox, a message will be printed every write_inc messages to indicate progress. If set to 0, only a single message will be displayed before writing a mailbox.
- Type: string
+ Also see the ``$read_inc'' variable.
- Default: ''
+356. xterm_icon
- This command is used to create encrypted S/MIME messages. (S/MIME only)
+ Type: string
- _\b7_\b._\b4_\b._\b2_\b8_\b8 _\bs_\bm_\bi_\bm_\be_\b__\be_\bn_\bc_\br_\by_\bp_\bt_\b__\bw_\bi_\bt_\bh
+ Default: "M%?n?AIL&ail?"
- Type: string
+ Controls the format of the X11 icon title, as long as $xterm_set_titles is set. This string is identical in formatting to the one used by ``$status_format''.
- Default: ''
+357. xterm_leave
- This sets the algorithm that should be used for encryption. Valid choices are
- ``des'', ``des3'', ``rc2-40'', ``rc2-64'', ``\frc2-128''.
+ Type: string
- If _\bu_\bn_\bs_\be_\bt ``_\b3_\bd_\be_\bs'' (TripleDES) is used. (S/MIME only)
+ Default: ""
- _\b7_\b._\b4_\b._\b2_\b8_\b9 _\bs_\bm_\bi_\bm_\be_\b__\bg_\be_\bt_\b__\bc_\be_\br_\bt_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ If $xterm_set_titles is set, this string will be used to set the title when leaving mutt-ng. For terminal-based programs, there's no easy and portable way to read the current title so mutt-ng cannot read it upon startup and restore it when exiting.
- Type: string
+ Based on the xterm FAQ, the following might work:
- Default: ''
+ set xterm_leave = "`test x$DISPLAY != x && xprop -id $WINDOWID | grep WM_NAME | cut -d '"' -f 2`"
- This command is used to extract X509 certificates from a PKCS7 structure.
- (S/MIME only)
+358. xterm_set_titles
- _\b7_\b._\b4_\b._\b2_\b9_\b0 _\bs_\bm_\bi_\bm_\be_\b__\bg_\be_\bt_\b__\bc_\be_\br_\bt_\b__\be_\bm_\ba_\bi_\bl_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Type: boolean
- Type: string
+ Default: no
- Default: ''
+ Controls whether Mutt-ng sets the xterm title bar and icon name (as long as you're in an appropriate terminal). The default must be unset to force in the validity checking.
- This command is used to extract the mail address(es) used for storing X509 cer-
- tificates, and for verification purposes (to check whether the certificate was
- issued for the sender's mailbox). (S/MIME only)
+359. xterm_title
- _\b7_\b._\b4_\b._\b2_\b9_\b1 _\bs_\bm_\bi_\bm_\be_\b__\bg_\be_\bt_\b__\bs_\bi_\bg_\bn_\be_\br_\b__\bc_\be_\br_\bt_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
+ Type: string
- Type: string
+ Default: "Mutt-ng with %?m?%m messages&no messages?%?n? [%n New]?"
- Default: ''
+ Controls the format of the title bar of the xterm provided that $xterm_set_titles has been set. This string is identical in formatting to the one used by ``$status_format''.
- This command is used to extract only the signers X509 certificate from a S/MIME
- signature, so that the certificate's owner may get compared to the email's
- ``From:'' header field. (S/MIME only)
+5. Functions
- The Mutt Next Generation E-Mail Client 160
+ The following is the list of available functions listed by the mapping in which they are available. The default key setting is given, and an explanation of what the function does. The key bindings of these functions can be changed with the bind command.
- _\b7_\b._\b4_\b._\b2_\b9_\b2 _\bs_\bm_\bi_\bm_\be_\b__\bi_\bm_\bp_\bo_\br_\bt_\b__\bc_\be_\br_\bt_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
-
- Type: string
-
- Default: ''
-
- This command is used to import a certificate via smime_keysng. (S/MIME only)
-
- _\b7_\b._\b4_\b._\b2_\b9_\b3 _\bs_\bm_\bi_\bm_\be_\b__\bi_\bs_\b__\bd_\be_\bf_\ba_\bu_\bl_\bt
-
- Type: boolean
-
- Default: no
-
- The default behaviour of Mutt-ng is to use PGP on all auto-sign/encryption
- operations. To override and to use OpenSSL instead this must be _\bs_\be_\bt.
-
- However, this has no effect while replying, since Mutt-ng will automatically
- select the same application that was used to sign/encrypt the original message.
-
- (Note that this variable can be overridden by unsetting _\b$_\bc_\br_\by_\bp_\bt_\b__\ba_\bu_\bt_\bo_\bs_\bm_\bi_\bm_\be (sec-
- tion 7.4.40 , page 99).) (S/MIME only)
-
- _\b7_\b._\b4_\b._\b2_\b9_\b4 _\bs_\bm_\bi_\bm_\be_\b__\bk_\be_\by_\bs
-
- Type: path
-
- Default: ''
-
- Since there is no pubring/secring as with PGP, Mutt-ng has to handle storage ad
- retrieval of keys/certs by itself. This is very basic right now, and stores
- keys and certificates in two different directories, both named as the hash-
- value retrieved from OpenSSL. There is an index file which contains mailbox-
- address keyid pair, and which can be manually edited. This one points to the
- location of the private keys. (S/MIME only)
-
- _\b7_\b._\b4_\b._\b2_\b9_\b5 _\bs_\bm_\bi_\bm_\be_\b__\bp_\bk_\b7_\bo_\bu_\bt_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
-
- Type: string
-
- Default: ''
-
- This command is used to extract PKCS7 structures of S/MIME signatures, in order
- to extract the public X509 certificate(s). (S/MIME only)
-
- _\b7_\b._\b4_\b._\b2_\b9_\b6 _\bs_\bm_\bi_\bm_\be_\b__\bs_\bi_\bg_\bn_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
-
- Type: string
-
- Default: ''
-
- This command is used to created S/MIME signatures of type multipart/signed,
- which can be read by all mail clients. (S/MIME only)
-
- The Mutt Next Generation E-Mail Client 161
-
- _\b7_\b._\b4_\b._\b2_\b9_\b7 _\bs_\bm_\bi_\bm_\be_\b__\bs_\bi_\bg_\bn_\b__\bo_\bp_\ba_\bq_\bu_\be_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
-
- Type: string
-
- Default: ''
-
- This command is used to created S/MIME signatures of type application/x-
- pkcs7-signature, which can only be handled by mail clients supporting the
- S/MIME extension. (S/MIME only)
-
- _\b7_\b._\b4_\b._\b2_\b9_\b8 _\bs_\bm_\bi_\bm_\be_\b__\bt_\bi_\bm_\be_\bo_\bu_\bt
-
- Type: number
-
- Default: 300
-
- The number of seconds after which a cached passphrase will expire if not used.
- (S/MIME only)
-
- _\b7_\b._\b4_\b._\b2_\b9_\b9 _\bs_\bm_\bi_\bm_\be_\b__\bv_\be_\br_\bi_\bf_\by_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
-
- Type: string
-
- Default: ''
-
- This command is used to verify S/MIME signatures of type multipart/signed.
- (S/MIME only)
-
- _\b7_\b._\b4_\b._\b3_\b0_\b0 _\bs_\bm_\bi_\bm_\be_\b__\bv_\be_\br_\bi_\bf_\by_\b__\bo_\bp_\ba_\bq_\bu_\be_\b__\bc_\bo_\bm_\bm_\ba_\bn_\bd
-
- Type: string
-
- Default: ''
-
- This command is used to verify S/MIME signatures of type application/x-
- pkcs7-mime. (S/MIME only)
-
- _\b7_\b._\b4_\b._\b3_\b0_\b1 _\bs_\bm_\bt_\bp_\b__\be_\bn_\bv_\be_\bl_\bo_\bp_\be
-
- Type: string
-
- Default: ''
-
- Availability: SMTP
-
- If this variable is non-empty, it'll be used as the envelope sender. If it's
- empty (the default), the value of the regular From: header will be used.
-
- This may be necessary as some providers don't allow for arbitrary values as the
- envelope sender but only a particular one which may not be the same as the
- user's desired From: header.
-
- _\b7_\b._\b4_\b._\b3_\b0_\b2 _\bs_\bm_\bt_\bp_\b__\bh_\bo_\bs_\bt
-
- The Mutt Next Generation E-Mail Client 162
-
- Type: string
-
- Default: ''
-
- Availability: SMTP
-
- Defines the SMTP host which will be used to deliver mail, as opposed to invok-
- ing the sendmail binary. Setting this variable overrides the value of ``_\b$_\bs_\be_\bn_\bd_\b-
- _\bm_\ba_\bi_\bl (section 7.4.263 , page 152)'', and any associated variables.
-
- _\b7_\b._\b4_\b._\b3_\b0_\b3 _\bs_\bm_\bt_\bp_\b__\bp_\ba_\bs_\bs
-
- Type: string
-
- Default: ''
-
- Availability: SMTP
-
- Defines the password to use with SMTP AUTH. If ``_\b$_\bs_\bm_\bt_\bp_\b__\bu_\bs_\be_\br (section
- 7.4.306 , page 162)'' is set, but this variable is not, you will be prompted
- for a password when sending.
-
- N\bNo\bot\bte\be:\b: Storing passwords in a configuration file presents a security risk since
- the superuser of your machine may read it regardless of the file's permissions.
-
- _\b7_\b._\b4_\b._\b3_\b0_\b4 _\bs_\bm_\bt_\bp_\b__\bp_\bo_\br_\bt
-
- Type: number
-
- Default: 25
-
- Availability: SMTP
-
- Defines the port that the SMTP host is listening on for mail delivery. Must be
- specified as a number.
-
- Defaults to 25, the standard SMTP port, but RFC 2476-compliant SMTP servers
- will probably desire 587, the mail submission port.
-
- _\b7_\b._\b4_\b._\b3_\b0_\b5 _\bs_\bm_\bt_\bp_\b__\bu_\bs_\be_\b__\bt_\bl_\bs
-
- Type: string
-
- Default: ''
-
- Availability: SMTP (and SSL)
-
- Defines wether to use STARTTLS. If this option is set to ``_\br_\be_\bq_\bu_\bi_\br_\be_\bd'' and the
- server does not support STARTTLS or there is an error in the TLS Handshake, the
- connection will fail. Setting this to ``_\be_\bn_\ba_\bb_\bl_\be_\bd'' will try to start TLS and
- continue without TLS in case of an error. Muttng still needs to have SSL sup-
- port enabled in order to use it.
-
- The Mutt Next Generation E-Mail Client 163
-
- _\b7_\b._\b4_\b._\b3_\b0_\b6 _\bs_\bm_\bt_\bp_\b__\bu_\bs_\be_\br
-
- Type: string
-
- Default: ''
-
- Availability: SMTP
-
- Defines the username to use with SMTP AUTH. Setting this variable will cause
- Mutt-ng to attempt to use SMTP AUTH when sending.
-
- _\b7_\b._\b4_\b._\b3_\b0_\b7 _\bs_\bo_\br_\bt
-
- Type: sort order
-
- Default: date
-
- Specifies how to sort messages in the _\bi_\bn_\bd_\be_\bx menu. Valid values are:
-
- date or date-sent
- date-received
- from
- mailbox-order (unsorted)
- score
- size
- spam
- subject
- threads
- to
-
- You may optionally use the ``reverse-'' prefix to specify reverse sorting order
- (example: set sort=reverse-date-sent).
-
- _\b7_\b._\b4_\b._\b3_\b0_\b8 _\bs_\bo_\br_\bt_\b__\ba_\bl_\bi_\ba_\bs
-
- Type: sort order
-
- Default: alias
-
- Specifies how the entries in the ``alias'' menu are sorted. The following are
- legal values:
-
- address (sort alphabetically by email address)
- alias (sort alphabetically by alias name)
- unsorted (leave in order specified in .muttrc)
-
- _\b7_\b._\b4_\b._\b3_\b0_\b9 _\bs_\bo_\br_\bt_\b__\ba_\bu_\bx
-
- Type: sort order
-
- The Mutt Next Generation E-Mail Client 164
-
- Default: date
-
- When sorting by threads, this variable controls how threads are sorted in rela-
- tion to other threads, and how the branches of the thread trees are sorted.
- This can be set to any value that ``_\b$_\bs_\bo_\br_\bt (section 7.4.307 , page 163)'' can,
- except threads (in that case, Mutt-ng will just use date-sent). You can also
- specify the ``last-'' prefix in addition to ``reverse-'' prefix, but last- must
- come after reverse-. The last- prefix causes messages to be sorted against its
- siblings by which has the last descendant, using the rest of sort_aux as an
- ordering.
-
- For instance, set sort_aux=last-date-received would mean that if a new message
- is received in a thread, that thread becomes the last one displayed (or the
- first, if you have set sort=reverse-threads.)
-
- N\bNo\bot\bte\be:\b: For reversed ``_\b$_\bs_\bo_\br_\bt (section 7.4.307 , page 163)'' order _\b$_\bs_\bo_\br_\bt_\b__\ba_\bu_\bx
- (section 7.4.309 , page 163) is reversed again (which is not the right thing
- to do, but kept to not break any existing configuration setting).
-
- _\b7_\b._\b4_\b._\b3_\b1_\b0 _\bs_\bo_\br_\bt_\b__\bb_\br_\bo_\bw_\bs_\be_\br
-
- Type: sort order
-
- Default: alpha
-
- Specifies how to sort entries in the file browser. By default, the entries are
- sorted alphabetically. Valid values:
-
- alpha (alphabetically)
- date
- size
- unsorted
-
- You may optionally use the ``reverse-'' prefix to specify reverse sorting order
- (example: set sort_browser=reverse-date).
-
- _\b7_\b._\b4_\b._\b3_\b1_\b1 _\bs_\bo_\br_\bt_\b__\br_\be
-
- Type: boolean
-
- Default: yes
-
- This variable is only useful when sorting by threads with ``_\b$_\bs_\bt_\br_\bi_\bc_\bt_\b__\bt_\bh_\br_\be_\ba_\bd_\bs
- (section 7.4.328 , page 170)'' _\bu_\bn_\bs_\be_\bt. In that case, it changes the heuristic
- Mutt-ng uses to thread messages by subject. With _\b$_\bs_\bo_\br_\bt_\b__\br_\be (section 7.4.311 ,
- page 164) _\bs_\be_\bt, Mutt-ng will only attach a message as the child of another mes-
- sage by subject if the subject of the child message starts with a substring
- matching the setting of ``_\b$_\br_\be_\bp_\bl_\by_\b__\br_\be_\bg_\be_\bx_\bp (section 7.4.247 , page 149)''. With
- _\b$_\bs_\bo_\br_\bt_\b__\br_\be (section 7.4.311 , page 164) _\bu_\bn_\bs_\be_\bt, Mutt-ng will attach the message
- whether or not this is the case, as long as the non-``_\b$_\br_\be_\bp_\bl_\by_\b__\br_\be_\bg_\be_\bx_\bp (section
- 7.4.247 , page 149)'' parts of both messages are identical.
-
- The Mutt Next Generation E-Mail Client 165
-
- _\b7_\b._\b4_\b._\b3_\b1_\b2 _\bs_\bp_\ba_\bm_\b__\bs_\be_\bp_\ba_\br_\ba_\bt_\bo_\br
-
- Type: string
-
- Default: ','
-
- ``_\bs_\bp_\ba_\bm_\b__\bs_\be_\bp_\ba_\br_\ba_\bt_\bo_\br (section 7.4.312 , page 164)'' controls what happens when
- multiple spam headers are matched: if _\bu_\bn_\bs_\be_\bt, each successive header will over-
- write any previous matches value for the spam label. If _\bs_\be_\bt, each successive
- match will append to the previous, using ``_\bs_\bp_\ba_\bm_\b__\bs_\be_\bp_\ba_\br_\ba_\bt_\bo_\br (section 7.4.312 ,
- page 164)'' as a separator.
-
- _\b7_\b._\b4_\b._\b3_\b1_\b3 _\bs_\bp_\bo_\bo_\bl_\bf_\bi_\bl_\be
-
- Type: path
-
- Default: ''
-
- If your spool mailbox is in a non-default place where Mutt-ng cannot find it,
- you can specify its location with this variable. Mutt-ng will automatically
- set this variable to the value of the environment variable $MAIL if it is not
- set.
-
- _\b7_\b._\b4_\b._\b3_\b1_\b4 _\bs_\bs_\bl_\b__\bc_\ba_\b__\bc_\be_\br_\bt_\bi_\bf_\bi_\bc_\ba_\bt_\be_\bs_\b__\bf_\bi_\bl_\be
-
- Type: path
-
- Default: ''
-
- This variable specifies a file containing trusted CA certificates. Any server
- certificate that is signed with one of these CA certificates are also automati-
- cally accepted.
-
- Example: set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
-
- _\b7_\b._\b4_\b._\b3_\b1_\b5 _\bs_\bs_\bl_\b__\bc_\bl_\bi_\be_\bn_\bt_\b__\bc_\be_\br_\bt
-
- Type: path
-
- Default: ''
-
- Availability: SSL
-
- The file containing a client certificate and its associated private key.
-
- _\b7_\b._\b4_\b._\b3_\b1_\b6 _\bs_\bs_\bl_\b__\bf_\bo_\br_\bc_\be_\b__\bt_\bl_\bs
-
- Type: boolean
-
- Default: no
-
- If this variable is _\bs_\be_\bt, mutt-ng will require that all connections to remote
- servers be encrypted. Furthermore it will attempt to negotiate TLS even if the
- server does not advertise the capability, since it would otherwise have to
-
- The Mutt Next Generation E-Mail Client 166
-
- abort the connection anyway. This option supersedes ``_\b$_\bs_\bs_\bl_\b__\bs_\bt_\ba_\br_\bt_\bt_\bl_\bs (section
- 7.4.318 , page 166)''.
-
- _\b7_\b._\b4_\b._\b3_\b1_\b7 _\bs_\bs_\bl_\b__\bm_\bi_\bn_\b__\bd_\bh_\b__\bp_\br_\bi_\bm_\be_\b__\bb_\bi_\bt_\bs
-
- Type: number
-
- Default: 0
-
- Availability: GNUTLS
-
- This variable specifies the minimum acceptable prime size (in bits) for use in
- any Diffie-Hellman key exchange. A value of 0 will use the default from the
- GNUTLS library.
-
- _\b7_\b._\b4_\b._\b3_\b1_\b8 _\bs_\bs_\bl_\b__\bs_\bt_\ba_\br_\bt_\bt_\bl_\bs
-
- Type: quadoption
-
- Default: yes
-
- Availability: SSL or GNUTLS
-
- If _\bs_\be_\bt (the default), Mutt-ng will attempt to use STARTTLS on servers advertis-
- ing the capability. When _\bu_\bn_\bs_\be_\bt, Mutt-ng will not attempt to use STARTTLS
- regardless of the server's capabilities.
-
- _\b7_\b._\b4_\b._\b3_\b1_\b9 _\bs_\bs_\bl_\b__\bu_\bs_\be_\b__\bs_\bs_\bl_\bv_\b2
-
- Type: boolean
-
- Default: yes
-
- Availability: SSL
-
- This variables specifies whether to attempt to use SSLv2 in the SSL authentica-
- tion process.
-
- _\b7_\b._\b4_\b._\b3_\b2_\b0 _\bs_\bs_\bl_\b__\bu_\bs_\be_\b__\bs_\bs_\bl_\bv_\b3
-
- Type: boolean
-
- Default: yes
-
- Availability: SSL or GNUTLS
-
- This variables specifies whether to attempt to use SSLv3 in the SSL authentica-
- tion process.
-
- _\b7_\b._\b4_\b._\b3_\b2_\b1 _\bs_\bs_\bl_\b__\bu_\bs_\be_\b__\bt_\bl_\bs_\bv_\b1
-
- Type: boolean
-
- Default: yes
-
- The Mutt Next Generation E-Mail Client 167
-
- Availability: SSL or GNUTLS
-
- This variables specifies whether to attempt to use TLSv1 in the SSL authentica-
- tion process.
-
- _\b7_\b._\b4_\b._\b3_\b2_\b2 _\bs_\bs_\bl_\b__\bu_\bs_\be_\bs_\by_\bs_\bt_\be_\bm_\bc_\be_\br_\bt_\bs
-
- Type: boolean
-
- Default: yes
-
- Availability: SSL
-
- If set to _\by_\be_\bs, Mutt-ng will use CA certificates in the system-wide certificate
- store when checking if server certificate is signed by a trusted CA.
-
- _\b7_\b._\b4_\b._\b3_\b2_\b3 _\bs_\bt_\ba_\bt_\bu_\bs_\b__\bc_\bh_\ba_\br_\bs
-
- Type: string
-
- Default: '-*%A'
-
- Controls the characters used by the ``%r'' indicator in ``_\b$_\bs_\bt_\ba_\bt_\bu_\bs_\b__\bf_\bo_\br_\bm_\ba_\bt (sec-
- tion 7.4.324 , page 167)''. The first character is used when the mailbox is
- unchanged. The second is used when the mailbox has been changed, and it needs
- to be resynchronized. The third is used if the mailbox is in read-only mode, or
- if the mailbox will not be written when exiting that mailbox (You can toggle
- whether to write changes to a mailbox with the toggle-write operation, bound by
- default to ``%''). The fourth is used to indicate that the current folder has
- been opened in attach-message mode (Certain operations like composing a new
- mail, replying, forwarding, etc. are not permitted in this mode).
-
- _\b7_\b._\b4_\b._\b3_\b2_\b4 _\bs_\bt_\ba_\bt_\bu_\bs_\b__\bf_\bo_\br_\bm_\ba_\bt
-
- Type: string
-
- Default: '-%r-Mutt-ng: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d?
- Del:%d?%?F? Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l?
- %l?]---(%s/%S)-%>-(%P)---'
-
- Controls the format of the status line displayed in the _\bi_\bn_\bd_\be_\bx menu. This
- string is similar to ``_\b$_\bi_\bn_\bd_\be_\bx_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.116 , page 116)'', but has
- its own set of printf(3)-like sequences:
-
- %b
- number of mailboxes with new mail *
-
- %B
- the short pathname of the current mailbox
-
- %d
- number of deleted messages *
-
- The Mutt Next Generation E-Mail Client 168
-
- %f
- the full pathname of the current mailbox
-
- %F
- number of flagged messages *
-
- %h
- local hostname
-
- %l
- size (in bytes) of the current mailbox *
-
- %L
- size (in bytes) of the messages shown (i.e., which match the cur-
- rent limit) *
-
- %m
- the number of messages in the mailbox *
-
- %M
- the number of messages shown (i.e., which match the current limit)
- *
-
- %n
- number of new messages in the mailbox *
-
- %o
- number of old unread messages *
-
- %p
- number of postponed messages *
-
- %P
- percentage of the way through the index
-
- %r
- modified/read-only/won't-write/attach-message indicator, according
- to _\b$_\bs_\bt_\ba_\bt_\bu_\bs_\b__\bc_\bh_\ba_\br_\bs (section 7.4.323 , page 167)
-
- %s
- current sorting mode (_\b$_\bs_\bo_\br_\bt (section 7.4.307 , page 163))
-
- %S
- current aux sorting method (_\b$_\bs_\bo_\br_\bt_\b__\ba_\bu_\bx (section 7.4.309 , page
- 163))
-
- %t
- number of tagged messages *
-
- %u
- number of unread messages *
-
- %v
- Mutt-ng version string
-
- The Mutt Next Generation E-Mail Client 169
-
- %V
- currently active limit pattern, if any *
-
- %>X
- right justify the rest of the string and pad with 'X'
-
- %|X
- pad to the end of the line with 'X'
-
- * = can be optionally printed if nonzero
-
- Some of the above sequences can be used to optionally print a string if their
- value is nonzero. For example, you may only want to see the number of flagged
- messages if such messages exist, since zero is not particularly meaningful. To
- optionally print a string based upon one of the above sequences, the following
- construct is used
-
- %?<sequence_char>?<optional_string>?
-
- where _\bs_\be_\bq_\bu_\be_\bn_\bc_\be_\b__\bc_\bh_\ba_\br is a character from the table above, and _\bo_\bp_\bt_\bi_\bo_\bn_\ba_\bl_\b__\bs_\bt_\br_\bi_\bn_\bg is
- the string you would like printed if _\bs_\be_\bq_\bu_\be_\bn_\bc_\be_\b__\bc_\bh_\ba_\br is nonzero. _\bo_\bp_\bt_\bi_\bo_\bn_\ba_\bl_\b__\bs_\bt_\br_\bi_\bn_\bg
- m\bma\bay\by contain other sequences as well as normal text, but you may n\bno\bot\bt nest
- optional strings.
-
- Here is an example illustrating how to optionally print the number of new mes-
- sages in a mailbox:
-
- %?n?%n new messages.?
-
- Additionally you can switch between two strings, the first one, if a value is
- zero, the second one, if the value is nonzero, by using the following con-
- struct:
-
- %?<sequence_char>?<if_string>&<else_string>?
-
- You can additionally force the result of any printf(3)-like sequence to be low-
- ercase by prefixing the sequence character with an underscore (_) sign. For
- example, if you want to display the local hostname in lowercase, you would use:
-
- %_h
-
- If you prefix the sequence character with a colon (:) character, Mutt-ng will
- replace any dots in the expansion by underscores. This might be helpful with
- IMAP folders that don't like dots in folder names.
-
- _\b7_\b._\b4_\b._\b3_\b2_\b5 _\bs_\bt_\ba_\bt_\bu_\bs_\b__\bo_\bn_\b__\bt_\bo_\bp
-
- Type: boolean
-
- Default: no
-
- Setting this variable causes the ``status bar'' to be displayed on the first
- line of the screen rather than near the bottom.
-
- The Mutt Next Generation E-Mail Client 170
-
- _\b7_\b._\b4_\b._\b3_\b2_\b6 _\bs_\bt_\br_\bi_\bc_\bt_\b__\bm_\ba_\bi_\bl_\bt_\bo
-
- Type: boolean
-
- Default: yes
-
- With mailto: style links, a body as well as arbitrary header information may be
- embedded. This may lead to (user) headers being overwriten without note if
- ``_\b$_\be_\bd_\bi_\bt_\b__\bh_\be_\ba_\bd_\be_\br_\bs (section 7.4.59 , page 103)'' is unset.
-
- If this variable is _\bs_\be_\bt, mutt-ng is strict and allows anything to be changed.
- If it's _\bu_\bn_\bs_\be_\bt, all headers given will be prefixed with ``X-Mailto-'' and the
- message including headers will be shown in the editor regardless of what
- ``_\b$_\be_\bd_\bi_\bt_\b__\bh_\be_\ba_\bd_\be_\br_\bs (section 7.4.59 , page 103)'' is set to.
-
- _\b7_\b._\b4_\b._\b3_\b2_\b7 _\bs_\bt_\br_\bi_\bc_\bt_\b__\bm_\bi_\bm_\be
-
- Type: boolean
-
- Default: yes
-
- When _\bu_\bn_\bs_\be_\bt, non MIME-compliant messages that doesn't have any charset indica-
- tion in the ``Content-Type:'' header field can be displayed (non MIME-compliant
- messages are often generated by old mailers or buggy mailers like MS Outlook
- Express). See also _\b$_\ba_\bs_\bs_\bu_\bm_\be_\bd_\b__\bc_\bh_\ba_\br_\bs_\be_\bt (section 7.4.13 , page 92).
-
- This option also replaces linear-white-space between encoded-word and *text to
- a single space to prevent the display of MIME-encoded ``Subject:'' header field
- from being devided into multiple lines.
-
- _\b7_\b._\b4_\b._\b3_\b2_\b8 _\bs_\bt_\br_\bi_\bc_\bt_\b__\bt_\bh_\br_\be_\ba_\bd_\bs
-
- Type: boolean
-
- Default: no
-
- If _\bs_\be_\bt, threading will only make use of the ``In-Reply-To:'' and ``Refer-
- ences:'' header fields when you ``_\b$_\bs_\bo_\br_\bt (section 7.4.307 , page 163)'' by mes-
- sage threads. By default, messages with the same subject are grouped together
- in ``pseudo threads.'' This may not always be desirable, such as in a personal
- mailbox where you might have several unrelated messages with the subject ``hi''
- which will get grouped together.
-
- _\b7_\b._\b4_\b._\b3_\b2_\b9 _\bs_\bt_\br_\bi_\bp_\b__\bw_\ba_\bs
-
- Type: boolean
-
- Default: no
-
- When _\bs_\be_\bt, mutt-ng will remove the trailing part of the ``Subject:'' line which
- matches _\b$_\bs_\bt_\br_\bi_\bp_\b__\bw_\ba_\bs_\b__\br_\be_\bg_\be_\bx (section 7.4.330 , page 170) when replying. This is
- useful to properly react on subject changes and reduce ``subject noise.'' (esp.
- in Usenet)
-
- The Mutt Next Generation E-Mail Client 171
-
- _\b7_\b._\b4_\b._\b3_\b3_\b0 _\bs_\bt_\br_\bi_\bp_\b__\bw_\ba_\bs_\b__\br_\be_\bg_\be_\bx
-
- Type: regular expression
-
- Default: '\([Ww][Aa][RrSs]: .*\)[ ]*$'
-
- When non-empty and _\b$_\bs_\bt_\br_\bi_\bp_\b__\bw_\ba_\bs (section 7.4.329 , page 170) is _\bs_\be_\bt, mutt-ng
- will remove this trailing part of the ``Subject'' line when replying if it
- won't be empty afterwards.
-
- _\b7_\b._\b4_\b._\b3_\b3_\b1 _\bs_\bt_\bu_\bf_\bf_\b__\bq_\bu_\bo_\bt_\be_\bd
-
- Type: boolean
-
- Default: no
-
- If _\bs_\be_\bt, attachments with flowed format will have their quoting ``stuffed'',
- i.e. a space will be inserted between the quote characters and the actual text.
-
- _\b7_\b._\b4_\b._\b3_\b3_\b2 _\bs_\bu_\bs_\bp_\be_\bn_\bd
-
- Type: boolean
-
- Default: yes
-
- When _\bu_\bn_\bs_\be_\bt, Mutt-ng won't stop when the user presses the terminal's _\bs_\bu_\bs_\bp key,
- usually CTRL+Z. This is useful if you run Mutt-ng inside an xterm using a com-
- mand like ``xterm -e muttng.''
-
- _\b7_\b._\b4_\b._\b3_\b3_\b3 _\bt_\be_\bx_\bt_\b__\bf_\bl_\bo_\bw_\be_\bd
-
- Type: boolean
-
- Default: no
-
- When _\bs_\be_\bt, Mutt-ng will generate text/plain; format=flowed attachments. This
- format is easier to handle for some mailing software, and generally just looks
- like ordinary text. To actually make use of this format's features, you'll
- need support in your editor.
-
- Note that _\b$_\bi_\bn_\bd_\be_\bn_\bt_\b__\bs_\bt_\br_\bi_\bn_\bg (section 7.4.115 , page 116) is ignored when this
- option is set.
-
- _\b7_\b._\b4_\b._\b3_\b3_\b4 _\bt_\bh_\bo_\br_\bo_\bu_\bg_\bh_\b__\bs_\be_\ba_\br_\bc_\bh
-
- Type: boolean
-
- Default: no
-
- Affects the ~b and ~h search operations described in section ``_\bp_\ba_\bt_\bt_\be_\br_\bn_\bs (sec-
- tion 7.2 , page 84)'' above. If _\bs_\be_\bt, the headers and attachments of messages
- to be searched are decoded before searching. If _\bu_\bn_\bs_\be_\bt, messages are searched
- as they appear in the folder.
-
- The Mutt Next Generation E-Mail Client 172
-
- _\b7_\b._\b4_\b._\b3_\b3_\b5 _\bt_\bh_\br_\be_\ba_\bd_\b__\br_\be_\bc_\be_\bi_\bv_\be_\bd
-
- Type: boolean
-
- Default: no
-
- When _\bs_\be_\bt, Mutt-ng uses the date received rather than the date sent to thread
- messages by subject.
-
- _\b7_\b._\b4_\b._\b3_\b3_\b6 _\bt_\bi_\bl_\bd_\be
-
- Type: boolean
-
- Default: no
-
- When _\bs_\be_\bt, the internal-pager will pad blank lines to the bottom of the screen
- with a tilde (~).
-
- _\b7_\b._\b4_\b._\b3_\b3_\b7 _\bt_\bi_\bm_\be_\bo_\bu_\bt
-
- Type: number
-
- Default: 600
-
- This variable controls the _\bn_\bu_\bm_\bb_\be_\br _\bo_\bf _\bs_\be_\bc_\bo_\bn_\bd_\bs Mutt-ng will wait for a key to be
- pressed in the main menu before timing out and checking for new mail. A value
- of zero or less will cause Mutt-ng to never time out.
-
- _\b7_\b._\b4_\b._\b3_\b3_\b8 _\bt_\bm_\bp_\bd_\bi_\br
-
- Type: path
-
- Default: ''
-
- This variable allows you to specify where Mutt-ng will place its temporary
- files needed for displaying and composing messages. If this variable is not
- set, the environment variable $TMPDIR is used. If $TMPDIR is not set then
- '/tmp' is used.
-
- _\b7_\b._\b4_\b._\b3_\b3_\b9 _\bt_\bo_\b__\bc_\bh_\ba_\br_\bs
-
- Type: string
-
- Default: ' +TCFL'
-
- Controls the character used to indicate mail addressed to you. The first char-
- acter is the one used when the mail is NOT addressed to your address (default:
- space). The second is used when you are the only recipient of the message
- (default: +). The third is when your address appears in the ``To:'' header
- field, but you are not the only recipient of the message (default: T). The
- fourth character is used when your address is specified in the ``Cc:'' header
- field, but you are not the only recipient. The fifth character is used to
- indicate mail that was sent by _\by_\bo_\bu. The sixth character is used to indicate
- when a mail was sent to a mailing-list you're subscribe to (default: L).
-
- The Mutt Next Generation E-Mail Client 173
-
- _\b7_\b._\b4_\b._\b3_\b4_\b0 _\bt_\br_\ba_\bs_\bh
-
- Type: path
-
- Default: ''
-
- If _\bs_\be_\bt, this variable specifies the path of the trash folder where the mails
- marked for deletion will be moved, instead of being irremediably purged.
-
- N\bNo\bot\bte\be: When you delete a message in the trash folder, it is really deleted, so
- that there is no way to recover mail.
-
- _\b7_\b._\b4_\b._\b3_\b4_\b1 _\bt_\bu_\bn_\bn_\be_\bl
-
- Type: string
-
- Default: ''
-
- Setting this variable will cause Mutt-ng to open a pipe to a command instead of
- a raw socket. You may be able to use this to set up preauthenticated connec-
- tions to your IMAP/POP3 server. Example:
-
- tunnel='ssh -q mailhost.net /usr/local/libexec/imapd'
-
- N\bNo\bot\bte\be:\b: For this example to work you must be able to log in to the remote machine
- without having to enter a password.
-
- _\b7_\b._\b4_\b._\b3_\b4_\b2 _\bu_\bm_\ba_\bs_\bk
-
- Type: number
-
- Default: 0077
-
- This sets the umask that will be used by Mutt-ng when creating all kinds of
- files. If _\bu_\bn_\bs_\be_\bt, the default value is 077.
-
- _\b7_\b._\b4_\b._\b3_\b4_\b3 _\bu_\bn_\bc_\bo_\bl_\bl_\ba_\bp_\bs_\be_\b__\bj_\bu_\bm_\bp
-
- Type: boolean
-
- Default: no
-
- When _\bs_\be_\bt, Mutt-ng will jump to the next unread message, if any, when the cur-
- rent thread is _\bu_\bncollapsed.
-
- _\b7_\b._\b4_\b._\b3_\b4_\b4 _\bu_\bs_\be_\b__\b8_\bb_\bi_\bt_\bm_\bi_\bm_\be
-
- Type: boolean
-
- Default: no
-
- W\bWa\bar\brn\bni\bin\bng\bg:\b: do not set this variable unless you are using a version of sendmail
- which supports the -B8BITMIME flag (such as sendmail 8.8.x) or in connection
- with the SMTP support via libESMTP. Otherwise you may not be able to send
-
- The Mutt Next Generation E-Mail Client 174
-
- mail.
-
- When _\bs_\be_\bt, Mutt-ng will either invoke ``_\b$_\bs_\be_\bn_\bd_\bm_\ba_\bi_\bl (section 7.4.263 , page
- 152)'' with the -B8BITMIME flag when sending 8-bit messages to enable ESMTP
- negotiation or tell libESMTP to do so.
-
- _\b7_\b._\b4_\b._\b3_\b4_\b5 _\bu_\bs_\be_\b__\bd_\bo_\bm_\ba_\bi_\bn
-
- Type: boolean
-
- Default: yes
-
- When _\bs_\be_\bt, Mutt-ng will qualify all local addresses (ones without the @host por-
- tion) with the value of ``_\b$_\bh_\bo_\bs_\bt_\bn_\ba_\bm_\be (section 7.4.95 , page 111)''. If _\bu_\bn_\bs_\be_\bt,
- no addresses will be qualified.
-
- _\b7_\b._\b4_\b._\b3_\b4_\b6 _\bu_\bs_\be_\b__\bf_\br_\bo_\bm
-
- Type: boolean
-
- Default: yes
-
- When _\bs_\be_\bt, Mutt-ng will generate the ``From:'' header field when sending mes-
- sages. If _\bu_\bn_\bs_\be_\bt, no ``From:'' header field will be generated unless the user
- explicitly sets one using the ``_\bm_\by_\b__\bh_\bd_\br (section 3.16 , page 38)'' command.
-
- _\b7_\b._\b4_\b._\b3_\b4_\b7 _\bu_\bs_\be_\b__\bi_\bd_\bn
-
- Type: boolean
-
- Default: yes
-
- Availability: IDN
-
- When _\bs_\be_\bt, Mutt-ng will show you international domain names decoded.
-
- N\bNo\bot\bte\be:\b: You can use IDNs for addresses even if this is _\bu_\bn_\bs_\be_\bt. This variable only
- affects decoding.
-
- _\b7_\b._\b4_\b._\b3_\b4_\b8 _\bu_\bs_\be_\b__\bi_\bp_\bv_\b6
-
- Type: boolean
-
- Default: yes
-
- When _\bs_\be_\bt, Mutt-ng will look for IPv6 addresses of hosts it tries to contact.
- If this option is _\bu_\bn_\bs_\be_\bt, Mutt-ng will restrict itself to IPv4 addresses. Nor-
- mally, the default should work.
-
- _\b7_\b._\b4_\b._\b3_\b4_\b9 _\bv_\bi_\bs_\bu_\ba_\bl
-
- Type: path
-
- Default: ''
-
- The Mutt Next Generation E-Mail Client 175
-
- Specifies the visual editor to invoke when the _\b~_\bv command is given in the
- builtin editor.
-
- _\b7_\b._\b4_\b._\b3_\b5_\b0 _\bw_\ba_\bi_\bt_\b__\bk_\be_\by
-
- Type: boolean
-
- Default: yes
-
- Controls whether Mutt-ng will ask you to press a key after _\bs_\bh_\be_\bl_\bl_\b- _\be_\bs_\bc_\ba_\bp_\be, _\bp_\bi_\bp_\be_\b-
- _\bm_\be_\bs_\bs_\ba_\bg_\be, _\bp_\bi_\bp_\be_\b-_\be_\bn_\bt_\br_\by, _\bp_\br_\bi_\bn_\bt_\b-_\bm_\be_\bs_\bs_\ba_\bg_\be, and _\bp_\br_\bi_\bn_\bt_\b-_\be_\bn_\bt_\br_\by commands.
-
- It is also used when viewing attachments with ``_\ba_\bu_\bt_\bo_\b__\bv_\bi_\be_\bw (section 5.4 , page
- 79)'', provided that the corresponding mailcap entry has a needsterminal flag,
- and the external program is interactive.
-
- When _\bs_\be_\bt, Mutt-ng will always ask for a key. When _\bu_\bn_\bs_\be_\bt, Mutt-ng will wait for
- a key only if the external command returned a non-zero status.
-
- _\b7_\b._\b4_\b._\b3_\b5_\b1 _\bw_\be_\be_\bd
-
- Type: boolean
-
- Default: yes
-
- When _\bs_\be_\bt, Mutt-ng will weed headers when displaying, forwarding, printing, or
- replying to messages.
-
- _\b7_\b._\b4_\b._\b3_\b5_\b2 _\bw_\br_\ba_\bp_\b__\bs_\be_\ba_\br_\bc_\bh
-
- Type: boolean
-
- Default: yes
-
- Controls whether searches wrap around the end of the mailbox.
-
- When _\bs_\be_\bt, searches will wrap around the first (or last) message. When _\bu_\bn_\bs_\be_\bt,
- searches will not wrap.
-
- _\b7_\b._\b4_\b._\b3_\b5_\b3 _\bw_\br_\ba_\bp_\bm_\ba_\br_\bg_\bi_\bn
-
- Type: number
-
- Default: 0
-
- Controls the size of the margin remaining at the right side of the terminal
- when Mutt-ng's pager does smart wrapping.
-
- _\b7_\b._\b4_\b._\b3_\b5_\b4 _\bw_\br_\bi_\bt_\be_\b__\bb_\bc_\bc
-
- Type: boolean
-
- Default: yes
-
- The Mutt Next Generation E-Mail Client 176
-
- Controls whether Mutt-ng writes out the Bcc header when preparing messages to
- be sent. Exim users may wish to _\bu_\bn_\bs_\be_\bt this.
-
- _\b7_\b._\b4_\b._\b3_\b5_\b5 _\bw_\br_\bi_\bt_\be_\b__\bi_\bn_\bc
-
- Type: number
-
- Default: 10
-
- When writing a mailbox, a message will be printed every _\bw_\br_\bi_\bt_\be_\b__\bi_\bn_\bc messages to
- indicate progress. If set to 0, only a single message will be displayed before
- writing a mailbox.
-
- Also see the ``_\b$_\br_\be_\ba_\bd_\b__\bi_\bn_\bc (section 7.4.242 , page 147)'' variable.
-
- _\b7_\b._\b4_\b._\b3_\b5_\b6 _\bx_\bt_\be_\br_\bm_\b__\bi_\bc_\bo_\bn
-
- Type: string
-
- Default: 'M%?n?AIL&ail?'
-
- Controls the format of the X11 icon title, as long as _\b$_\bx_\bt_\be_\br_\bm_\b__\bs_\be_\bt_\b__\bt_\bi_\bt_\bl_\be_\bs (sec-
- tion 7.4.358 , page 176) is _\bs_\be_\bt. This string is identical in formatting to the
- one used by ``_\b$_\bs_\bt_\ba_\bt_\bu_\bs_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.324 , page 167)''.
-
- _\b7_\b._\b4_\b._\b3_\b5_\b7 _\bx_\bt_\be_\br_\bm_\b__\bl_\be_\ba_\bv_\be
-
- Type: string
-
- Default: ''
-
- If _\b$_\bx_\bt_\be_\br_\bm_\b__\bs_\be_\bt_\b__\bt_\bi_\bt_\bl_\be_\bs (section 7.4.358 , page 176) is _\bs_\be_\bt, this string will be
- used to set the title when leaving mutt-ng. For terminal-based programs,
- there's no easy and portable way to read the current title so mutt-ng cannot
- read it upon startup and restore it when exiting.
-
- Based on the xterm FAQ, the following might work:
-
- set xterm_leave = '`test x$DISPLAY != x && xprop -id $WINDOWID | grep WM_NAME |
- cut -d ''' -f 2`'
-
- _\b7_\b._\b4_\b._\b3_\b5_\b8 _\bx_\bt_\be_\br_\bm_\b__\bs_\be_\bt_\b__\bt_\bi_\bt_\bl_\be_\bs
-
- Type: boolean
-
- Default: no
-
- Controls whether Mutt-ng sets the xterm title bar and icon name (as long as
- you're in an appropriate terminal). The default must be _\bu_\bn_\bs_\be_\bt to force in the
- validity checking.
-
- _\b7_\b._\b4_\b._\b3_\b5_\b9 _\bx_\bt_\be_\br_\bm_\b__\bt_\bi_\bt_\bl_\be
-
- Type: string
-
- The Mutt Next Generation E-Mail Client 177
-
- Default: 'Mutt-ng with %?m?%m messages&no messages?%?n? [%n New]?'
-
- Controls the format of the title bar of the xterm provided that
- _\b$_\bx_\bt_\be_\br_\bm_\b__\bs_\be_\bt_\b__\bt_\bi_\bt_\bl_\be_\bs (section 7.4.358 , page 176) has been _\bs_\be_\bt. This string is
- identical in formatting to the one used by ``_\b$_\bs_\bt_\ba_\bt_\bu_\bs_\b__\bf_\bo_\br_\bm_\ba_\bt (section 7.4.324 ,
- page 167)''.
-
- _\b7_\b._\b5 _\bF_\bu_\bn_\bc_\bt_\bi_\bo_\bn_\bs
-
- The following is the list of available functions listed by the mapping in which
- they are available. The default key setting is given, and an explanation of
- what the function does. The key bindings of these functions can be changed
- with the _\bb_\bi_\bn_\bd (section 3.5 , page 27) command.
-
- _\b7_\b._\b5_\b._\b1 _\bg_\be_\bn_\be_\br_\bi_\bc
-
- The _\bg_\be_\bn_\be_\br_\bi_\bc menu is not a real menu, but specifies common functions (such as
- movement) available in all menus except for _\bp_\ba_\bg_\be_\br and _\be_\bd_\bi_\bt_\bo_\br. Changing set-
- tings for this menu will affect the default bindings for all menus (except as
- noted).
-
- bottom-page L move to the bottom of the page
- current-bottom not bound move current entry to bottom of page
- current-middle not bound move current entry to middle of page
- current-top not bound move current entry to top of page
- enter-command : enter a muttngrc command
- exit q exit this menu
- first-entry = move to the first entry
- half-down ] scroll down 1/2 page
- half-up [ scroll up 1/2 page
- help ? this screen
- jump number jump to an index number
- last-entry * move to the last entry
- middle-page M move to the middle of the page
- next-entry j move to the next entry
- next-line > scroll down one line
- next-page z move to the next page
- previous-entry k move to the previous entry
- previous-line < scroll up one line
- previous-page Z move to the previous page
- refresh ^L clear and redraw the screen
- search / search for a regular expression
- search-next n search for next match
- search-opposite not bound search for next match in opposite direction
- search-reverse ESC / search backwards for a regular expression
- select-entry RET select the current entry
- shell-escape ! run a program in a subshell
- tag-entry t toggle the tag on the current entry
- tag-prefix ; apply next command to tagged entries
- tag-prefix-cond not bound apply next function ONLY to tagged messages
- top-page H move to the top of the page
- what-key not bound display the keycode for a key press
-
- The Mutt Next Generation E-Mail Client 178
-
- _\b7_\b._\b5_\b._\b2 _\bi_\bn_\bd_\be_\bx
-
- The Mutt Next Generation E-Mail Client 179
-
- bounce-message b remail a message to another user
- change-folder c open a different folder
- change-folder-readonly ESC c open a different folder in read only mode
- check-traditional-pgp ESC P check for classic pgp
- clear-flag W clear a status flag from a message
- copy-message C copy a message to a file/mailbox
- create-alias a create an alias from a message sender
- decode-copy ESC C decode a message and copy it to a file/mailbox
- decode-save ESC s decode a message and save it to a file/mailbox
- delete-message d delete the current entry
- delete-pattern D delete messages matching a pattern
- delete-subthread ESC d delete all messages in subthread
- delete-thread ^D delete all messages in thread
- display-address @ display full address of sender
- display-toggle-weed h display message and toggle header weeding
- display-message RET display a message
- edit e edit the current message
- edit-type ^E edit the current message's Content-Type
- exit x exit without saving changes
- extract-keys ^K extract PGP public keys
- fetch-mail G retrieve mail from POP server
- flag-message F toggle a message's 'important' flag
- forget-passphrase ^F wipe PGP passphrase from memory
- forward-message f forward a message with comments
- group-reply g reply to all recipients
- limit l show only messages matching a pattern
- list-reply L reply to specified mailing list
- mail m compose a new mail message
- mail-key ESC k mail a PGP public key
- next-new TAB jump to the next new message
- next-subthread ESC n jump to the next subthread
- next-thread ^N jump to the next thread
- next-undeleted j move to the next undeleted message
- next-unread not bound jump to the next unread message
- parent-message P jump to parent message in thread
- pipe-message | pipe message/attachment to a shell command
- previous-new ESC TAB jump to the previous new message
- previous-page Z move to the previous page
- previous-subthread ESC p jump to previous subthread
- previous-thread ^P jump to previous thread
- previous-undeleted k move to the last undelete message
- previous-unread not bound jump to the previous unread message
- print-message p print the current entry
- query Q query external program for addresses
- quit q save changes to mailbox and quit
- read-subthread ESC r mark the current subthread as read
- read-thread ^R mark the current thread as read
- recall-message R recall a postponed message
- reply r reply to a message
- resend-message ESC e resend message and preserve MIME structure
- save-message s save message/attachment to a file
- set-flag w set a status flag on a message
- show-version V show the Mutt-ng version number and date
- show-limit ESC l show currently active limit pattern, if any
-
- The Mutt Next Generation E-Mail Client 180
-
- sort-mailbox o sort messages
- sort-reverse O sort messages in reverse order
- sync-mailbox $ save changes to mailbox
- tag-pattern T tag messages matching a pattern
- tag-thread ESC t tag/untag all messages in the current thread
- toggle-new N toggle a message's 'new' flag
- toggle-write % toggle whether the mailbox will be rewritten
- undelete-message u undelete the current entry
- undelete-pattern U undelete messages matching a pattern
- undelete-subthread ESC u undelete all messages in subthread
- undelete-thread ^U undelete all messages in thread
- untag-pattern ^T untag messages matching a pattern
- view-attachments v show MIME attachments
-
- _\b7_\b._\b5_\b._\b3 _\bp_\ba_\bg_\be_\br
-
- The Mutt Next Generation E-Mail Client 181
-
- bottom not bound jump to the bottom of the message
- bounce-message b remail a message to another user
- change-folder c open a different folder
- change-folder-readonly ESC c open a different folder in read only mode
- check-traditional-pgp ESC P check for classic pgp
- copy-message C copy a message to a file/mailbox
- create-alias a create an alias from a message sender
- decode-copy ESC C decode a message and copy it to a file/mailbox
- decode-save ESC s decode a message and save it to a file/mailbox
- delete-message d delete the current entry
- delete-subthread ESC d delete all messages in subthread
- delete-thread ^D delete all messages in thread
- display-address @ display full address of sender
- display-toggle-weed h display message and toggle header weeding
- edit e edit the current message
- edit-type ^E edit the current message's Content-Type
- enter-command : enter a muttngrc command
- exit i return to the main-menu
- extract-keys ^K extract PGP public keys
- flag-message F toggle a message's 'important' flag
- forget-passphrase ^F wipe PGP passphrase from memory
- forward-message f forward a message with comments
- group-reply g reply to all recipients
- half-up not bound move up one-half page
- half-down not bound move down one-half page
- help ? this screen
- list-reply L reply to specified mailing list
- mail m compose a new mail message
- mail-key ESC k mail a PGP public key
- mark-as-new N toggle a message's 'new' flag
- next-line RET scroll down one line
- next-entry J move to the next entry
- next-new TAB jump to the next new message
- next-page move to the next page
- next-subthread ESC n jump to the next subthread
- next-thread ^N jump to the next thread
- next-undeleted j move to the next undeleted message
- next-unread not bound jump to the next unread message
- parent-message P jump to parent message in thread
- pipe-message | pipe message/attachment to a shell command
- previous-line BackSpace scroll up one line
- previous-entry K move to the previous entry
- previous-new not bound jump to the previous new message
- previous-page - move to the previous page
- previous-subthread ESC p jump to previous subthread
- previous-thread ^P jump to previous thread
- previous-undeleted k move to the last undelete message
- previous-unread not bound jump to the previous unread message
- print-message p print the current entry
- quit Q save changes to mailbox and quit
- read-subthread ESC r mark the current subthread as read
- read-thread ^R mark the current thread as read
- recall-message R recall a postponed message
- redraw-screen ^L clear and redraw the screen
-
- The Mutt Next Generation E-Mail Client 182
-
- reply r reply to a message
- save-message s save message/attachment to a file
- search / search for a regular expression
- search-next n search for next match
- search-opposite not bound search for next match in opposite direction
- search-reverse ESC / search backwards for a regular expression
- search-toggle \ toggle search pattern coloring
- shell-escape ! invoke a command in a subshell
- show-version V show the Mutt-ng version number and date
- skip-quoted S skip beyond quoted text
- sync-mailbox $ save changes to mailbox
- tag-message t tag a message
- toggle-quoted T toggle display of quoted text
- top ^ jump to the top of the message
- undelete-message u undelete the current entry
- undelete-subthread ESC u undelete all messages in subthread
- undelete-thread ^U undelete all messages in thread
- view-attachments v show MIME attachments
-
- _\b7_\b._\b5_\b._\b4 _\ba_\bl_\bi_\ba_\bs
-
- search / search for a regular expression
- search-next n search for next match
- search-reverse ESC / search backwards for a regular expression
-
- _\b7_\b._\b5_\b._\b5 _\bq_\bu_\be_\br_\by
-
- create-alias a create an alias from a message sender
- mail m compose a new mail message
- query Q query external program for addresses
- query-append A append new query results to current results
- search / search for a regular expression
- search-next n search for next match
- search-opposite not bound search for next match in opposite direction
- search-reverse ESC / search backwards for a regular expression
-
- _\b7_\b._\b5_\b._\b6 _\ba_\bt_\bt_\ba_\bc_\bh
-
- The Mutt Next Generation E-Mail Client 183
-
- bounce-message b remail a message to another user
- collapse-parts v toggle display of subparts
- delete-entry d delete the current entry
- display-toggle-weed h display message and toggle header weeding
- edit-type ^E edit the current entry's Content-Type
- extract-keys ^K extract PGP public keys
- forward-message f forward a message with comments
- group-reply g reply to all recipients
- list-reply L reply to specified mailing list
- pipe-entry | pipe message/attachment to a shell command
- print-entry p print the current entry
- reply r reply to a message
- resend-message ESC e resend message and preserve MIME structure
- save-entry s save message/attachment to a file
- undelete-entry u undelete the current entry
- view-attach RET view attachment using mailcap entry if necessary
- view-mailcap m force viewing of attachment using mailcap
- view-text T view attachment as text
-
- _\b7_\b._\b5_\b._\b7 _\bc_\bo_\bm_\bp_\bo_\bs_\be
-
- The Mutt Next Generation E-Mail Client 184
-
- attach-file a attach a file(s) to this message
- attach-message A attach message(s) to this message
- attach-key ESC k attach a PGP public key
- copy-file C save message/attachment to a file
- detach-file D delete the current entry
- display-toggle-weed h display message and toggle header weeding
- edit-bcc b edit the BCC list
- edit-cc c edit the CC list
- edit-description d edit attachment description
- edit-encoding ^E edit attachment transfer-encoding
- edit-fcc f enter a file to save a copy of this message in
- edit-from ESC f edit the from: field
- edit-file ^X e edit the file to be attached
- edit-headers E edit the message with headers
- edit e edit the message
- edit-mime m edit attachment using mailcap entry
- edit-reply-to r edit the Reply-To field
- edit-subject s edit the subject of this message
- edit-to t edit the TO list
- edit-type ^T edit attachment type
- filter-entry F filter attachment through a shell command
- forget-passphrase ^F wipe PGP passphrase from memory
- ispell i run ispell on the message
- new-mime n compose new attachment using mailcap entry
- pgp-menu p show PGP options
- pipe-entry | pipe message/attachment to a shell command
- postpone-message P save this message to send later
- print-entry l print the current entry
- rename-file R rename/move an attached file
- send-message y send the message
- toggle-unlink u toggle whether to delete file after sending it
- view-attach RET view attachment using mailcap entry if necessary
- write-fcc w write the message to a folder
-
- _\b7_\b._\b5_\b._\b8 _\bp_\bo_\bs_\bt_\bp_\bo_\bn_\be
-
- delete-entry d delete the current entry
- undelete-entry u undelete the current entry
-
- _\b7_\b._\b5_\b._\b9 _\bb_\br_\bo_\bw_\bs_\be_\br
-
- The Mutt Next Generation E-Mail Client 185
-
- change-dir c change directories
- check-new TAB check mailboxes for new mail
- enter-mask m enter a file mask
- search / search for a regular expression
- search-next n search for next match
- search-reverse ESC / search backwards for a regular expression
- select-new N select a new file in this directory
- sort o sort messages
- sort-reverse O sort messages in reverse order
- toggle-mailboxes TAB toggle whether to browse mailboxes or all files
- view-file SPACE view file
- subscribe s subscribe to current mailbox (IMAP Only)
- unsubscribe u unsubscribe to current mailbox (IMAP Only)
- toggle-subscribed T toggle view all/subscribed mailboxes (IMAP Only)
-
- _\b7_\b._\b5_\b._\b1_\b0 _\bp_\bg_\bp
-
- view-name % view the key's user id
- verify-key c verify a PGP public key
-
- _\b7_\b._\b5_\b._\b1_\b1 _\be_\bd_\bi_\bt_\bo_\br
-
- backspace BackSpace delete the char in front of the cursor
- backward-char ^B move the cursor one character to the left
- backward-word ESC b move the cursor to the previous word
- bol ^A jump to the beginning of the line
- buffy-cycle Space cycle among incoming mailboxes
- capitalize-word ESC c uppercase the first character in the word
- complete TAB complete filename or alias
- complete-query ^T complete address with query
- delete-char ^D delete the char under the cursor
- downcase-word ESC l lowercase all characters in current word
- eol ^E jump to the end of the line
- forward-char ^F move the cursor one character to the right
- forward-word ESC f move the cursor to the next word
- history-down not bound scroll down through the history list
- history-up not bound scroll up through the history list
- kill-eol ^K delete chars from cursor to end of line
- kill-eow ESC d delete chars from cursor to end of word
- kill-line ^U delete all chars on the line
- kill-word ^W delete the word in front of the cursor
- quote-char ^V quote the next typed key
- transpose-chars not bound transpose character under cursor with previous
- upcase-word ESC u uppercase all characters in current word
-
- _\b8_\b. _\bM_\bi_\bs_\bc_\be_\bl_\bl_\ba_\bn_\by
-
- The Mutt Next Generation E-Mail Client 186
-
- _\b8_\b._\b1 _\bA_\bc_\bk_\bn_\bo_\bw_\bl_\be_\bd_\bg_\bm_\be_\bn_\bt_\bs
-
- Kari Hurtta <kari.hurtta@fmi.fi> co-developed the original MIME parsing code
- back in the ELM-ME days.
-
- The following people have been very helpful to the development of Mutt:
-
- Vikas Agnihotri <vikasa@writeme.com>,
-
- Francois Berjon <Francois.Berjon@aar.alcatel-alsthom.fr>,
-
- Aric Blumer <aric@fore.com>,
-
- John Capo <jc@irbs.com>,
-
- David Champion <dgc@uchicago.edu,
-
- Brendan Cully <brendan@kublai.com>,
-
- Liviu Daia <daia@stoilow.imar.ro>,
-
- Thomas E. Dickey <dickey@herndon4.his.com>,
-
- David DeSimone <fox@convex.hp.com>,
-
- Nickolay N. Dudorov <nnd@wint.itfs.nsk.su>,
-
- Ruslan Ermilov <ru@freebsd.org>,
-
- Edmund Grimley Evans <edmundo@rano.org,
-
- Michael Finken <finken@conware.de>,
-
- Sven Guckes <guckes@math.fu-berlin.de>,
-
- Lars Hecking <lhecking@nmrc.ie>,
-
- Mark Holloman <holloman@nando.net>,
-
- Andreas Holzmann <holzmann@fmi.uni-passau.de>,
-
- Marco d'Itri <md@linux.it>,
-
- Bjrn Jacke <bjacke@suse.com>,
-
- Byrial Jensen <byrial@image.dk>,
-
- David Jeske <jeske@igcom.net>,
-
- Christophe Kalt <kalt@hugo.int-evry.fr>,
-
- Tommi Komulainen <Tommi.Komulainen@iki.fi>,
-
- Felix von Leitner (a.k.a ``Fefe'') <leitner@math.fu-berlin.de>,
-
- The Mutt Next Generation E-Mail Client 187
-
- Brandon Long <blong@fiction.net>,
-
- Jimmy Mkel <jmy@flashback.net>,
-
- Lars Marowsky-Bree <lmb@pointer.in-minden.de>,
-
- Thomas ``Mike'' Michlmayr <mike@cosy.sbg.ac.at>,
-
- Andrew W. Nosenko <awn@bcs.zp.ua>,
-
- David O'Brien <obrien@Nuxi.cs.ucdavis.edu>,
-
- Clint Olsen <olsenc@ichips.intel.com>,
-
- Park Myeong Seok <pms@romance.kaist.ac.kr>,
-
- Thomas Parmelan <tom@ankh.fr.eu.org>,
-
- Ollivier Robert <roberto@keltia.freenix.fr>,
-
- Thomas Roessler <roessler@does-not-exist.org>,
-
- Roland Rosenfeld <roland@spinnaker.de>,
-
- TAKIZAWA Takashi <taki@luna.email.ne.jp>,
-
- Allain Thivillon <Allain.Thivillon@alma.fr>,
-
- Gero Treuner <gero@faveve.uni-stuttgart.de>,
-
- Vsevolod Volkov <vvv@lucky.net>,
-
- Ken Weinert <kenw@ihs.com>
-
- Mutt-ng is developed by the following people:
-
- Andreas Krennmair <ak@synflood.at>
-
- Nico Golde <nico@ngolde.de>
-
- Rocco Rutte <pdmef@cs.tu-berlin.de>
-
- The following people have been very helpful to the development of Mutt-ng:
-
- Christian Gall <cg@cgall.de>
-
- Iain Lea <iain@bricbrac.de>
-
- Andreas Kneib <akneib@gmx.net>
-
- Carsten Schoelzki <cjs@weisshuhn.de>
-
- Elimar Riesebieter <riesebie@lxtec.de>
-
- The Mutt Next Generation E-Mail Client 188
-
- _\b8_\b._\b2 _\bA_\bb_\bo_\bu_\bt _\bt_\bh_\bi_\bs _\bd_\bo_\bc_\bu_\bm_\be_\bn_\bt
-
- This document was written in SGML, and then rendered using the sgml-tools pack-
- age.
-
- The Mutt Next Generation E-Mail Client 189
-
- CONTENTS
-
- 1. Introduction .......................................................... 1
- 1.1 Overview ........................................................ 1
- 1.2 Mutt-ng Home Page ............................................... 1
- 1.3 Mailing Lists ................................................... 1
- 1.4 Software Distribution Sites ..................................... 2
- 1.5 IRC ............................................................. 2
- 1.6 Weblog .......................................................... 2
- 1.7 Copyright ....................................................... 2
-
- 2. Getting Started ..................................................... 2
- 2.1 Basic Concepts .............................................. 2
- 2.1.1 Screens and Menus 3
- 2.1.2 Configuration 3
- 2.1.3 Functions 3
- 2.1.4 Interaction 4
- 2.1.5 Modularization 4
- 2.1.6 Patterns 4
- 2.2 Screens and Menus ........................................... 4
- 2.2.1 Index 4
- 2.2.2 Pager 5
- 2.2.3 File Browser 5
- 2.2.4 Sidebar 5
- 2.2.5 Help 5
- 2.2.6 Compose Menu 6
- 2.2.7 Alias Menu 6
- 2.2.8 Attachment Menu 6
- 2.2.9 Key Menu 6
- 2.3 Moving Around in Menus .......................................... 6
- 2.4 Editing Input Fields ............................................ 7
- 2.5 Reading Mail - The Index and Pager .............................. 8
- 2.5.1 The Message Index 8
- 2.5.2 The Pager 9
- 2.5.3 Threaded Mode 11
- 2.5.4 Miscellaneous Functions 11
- 2.6 Sending Mail ................................................... 14
- 2.6.1 Composing new messages 14
- 2.6.2 Replying 16
- 2.6.3 Editing the message header 17
- 2.6.4 Using Mutt-ng with PGP 18
- 2.6.5 Sending anonymous messages via mixmaster 19
- 2.7 Forwarding and Bouncing Mail ................................... 19
- 2.8 Postponing Mail ................................................ 20
-
- 3. Configuration ........................................................ 21
- 3.1 Locations of Configuration Files ............................... 21
- 3.2 Basic Syntax of Initialization Files ........................... 21
- 3.3 Expansion within variables ................................... 23
- 3.3.1 Commands' Output 23
- 3.3.2 Environment Variables 23
-
- i
-
- 3.3.3 Configuration Variables 23
- 3.3.4 Self-Defined Variables 24
- 3.3.5 Pre-Defined Variables 25
- 3.3.6 Type Conversions 26
- 3.4 Defining/Using aliases ......................................... 26
- 3.5 Changing the default key bindings .............................. 27
- 3.6 Defining aliases for character sets ........................... 29
- 3.7 Setting variables based upon mailbox ........................... 29
- 3.8 Keyboard macros ................................................ 30
- 3.9 Using color and mono video attributes .......................... 31
- 3.10 Ignoring (weeding) unwanted message headers .................... 33
- 3.11 Alternative addresses .......................................... 34
- 3.12 Format = Flowed .............................................. 34
- 3.12.1 Introduction 34
- 3.12.2 Receiving: Display Setup 34
- 3.12.3 Sending 35
- 3.12.4 Additional Notes 36
- 3.13 Mailing lists .................................................. 36
- 3.14 Using Multiple spool mailboxes ................................. 37
- 3.15 Defining mailboxes which receive mail .......................... 37
- 3.16 User defined headers ........................................... 38
- 3.17 Defining the order of headers when viewing messages ............ 39
- 3.18 Specify default save filename .................................. 39
- 3.19 Specify default Fcc: mailbox when composing .................... 39
- 3.20 Specify default save filename and default Fcc: mailbox at once . 40
- 3.21 Change settings based upon message recipients .................. 40
- 3.22 Change settings before formatting a message .................... 41
- 3.23 Choosing the cryptographic key of the recipient ................ 41
- 3.24 Adding key sequences to the keyboard buffer .................... 41
- 3.25 Executing functions ............................................ 42
- 3.26 Message Scoring ................................................ 42
- 3.27 Spam detection ................................................. 43
- 3.28 Setting variables .............................................. 45
- 3.29 Reading initialization commands from another file .............. 46
- 3.30 Removing hooks ................................................. 46
- 3.31 Sharing Setups ............................................. 46
- 3.31.1 Character Sets 46
- 3.31.2 Modularization 47
- 3.31.3 Conditional parts 47
- 3.32 Obsolete Variables ............................................. 49
-
- 4. Advanced Usage ....................................................... 49
- 4.1 Regular Expressions ............................................ 49
- 4.2 Patterns ....................................................... 52
- 4.2.1 Complex Patterns 52
- 4.2.2 Patterns and Dates 53
- 4.3 Format Strings ............................................. 53
- 4.3.1 Introduction 53
- 4.3.2 Conditional Expansion 55
- 4.3.3 Modifications and Padding 56
- 4.4 Using Tags ..................................................... 56
- 4.5 Using Hooks .................................................... 57
- 4.5.1 Message Matching in Hooks 58
-
- ii
-
- 4.6 Using the sidebar .............................................. 58
- 4.7 External Address Queries ....................................... 59
- 4.8 Mailbox Formats ................................................ 60
- 4.9 Mailbox Shortcuts .............................................. 61
- 4.10 Handling Mailing Lists ......................................... 61
- 4.11 Editing threads ................................................ 62
- 4.11.1 Linking threads 63
- 4.11.2 Breaking threads 63
- 4.12 Delivery Status Notification (DSN) Support ..................... 63
- 4.13 POP3 Support (OPTIONAL) ........................................ 63
- 4.14 IMAP Support (OPTIONAL) ........................................ 64
- 4.14.1 The Folder Browser 65
- 4.14.2 Authentication 65
- 4.15 NNTP Support (OPTIONAL) ........................................ 66
- 4.15.1 Again: Scoring 66
- 4.16 SMTP Support (OPTIONAL) ........................................ 67
- 4.17 Managing multiple IMAP/POP/NNTP accounts (OPTIONAL) ............ 68
- 4.18 Start a WWW Browser on URLs (EXTERNAL) ......................... 68
- 4.19 Compressed folders Support (OPTIONAL) .......................... 68
- 4.19.1 Open a compressed mailbox for reading 69
- 4.19.2 Write a compressed mailbox 69
- 4.19.3 Append a message to a compressed mailbox 70
- 4.19.4 Encrypted folders 71
-
- 5. Mutt-ng's MIME Support ............................................... 71
- 5.1 Using MIME in Mutt ............................................. 71
- 5.1.1 Viewing MIME messages in the pager 71
- 5.1.2 The Attachment Menu 72
- 5.1.3 The Compose Menu 72
- 5.2 MIME Type configuration with mime.types ........................ 72
- 5.3 MIME Viewer configuration with mailcap ......................... 73
- 5.3.1 The Basics of the mailcap file 74
- 5.3.2 Secure use of mailcap 75
- 5.3.3 Advanced mailcap Usage 75
- 5.3.4 Example mailcap files 78
- 5.4 MIME Autoview .................................................. 79
- 5.5 MIME Multipart/Alternative ..................................... 80
- 5.6 MIME Lookup .................................................... 80
-
- 6. Security Considerations ............................................ 81
- 6.1 Passwords .................................................. 81
- 6.2 Temporary Files ............................................ 81
- 6.3 Information Leaks ............................................ 81
- 6.3.1 Message-ID: headers 81
- 6.3.2 mailto:-style links 82
- 6.4 External applications ...................................... 82
- 6.4.1 mailcap 82
- 6.4.2 Other 83
-
- 7. Reference ............................................................ 83
- 7.1 Command line options ........................................... 83
- 7.2 Patterns ....................................................... 84
- 7.3 Configuration Commands ......................................... 86
-
- iii
-
- 7.4 Configuration variables .......................................... 88
- 7.4.1 abort_noattach 89
- 7.4.2 abort_nosubject 90
- 7.4.3 abort_unmodified 90
- 7.4.4 agent_string 90
- 7.4.5 alias_file 90
- 7.4.6 alias_format 90
- 7.4.7 allow_8bit 91
- 7.4.8 allow_ansi 91
- 7.4.9 arrow_cursor 91
- 7.4.10 ascii_chars 92
- 7.4.11 askbcc 92
- 7.4.12 askcc 92
- 7.4.13 assumed_charset 92
- 7.4.14 attach_format 92
- 7.4.15 attach_remind_regexp 93
- 7.4.16 attach_sep 94
- 7.4.17 attach_split 94
- 7.4.18 attribution 94
- 7.4.19 auto_tag 94
- 7.4.20 autoedit 94
- 7.4.21 beep 95
- 7.4.22 beep_new 95
- 7.4.23 bounce 95
- 7.4.24 bounce_delivered 95
- 7.4.25 braille_friendly 95
- 7.4.26 certificate_file 96
- 7.4.27 charset 96
- 7.4.28 check_new 96
- 7.4.29 collapse_unread 96
- 7.4.30 compose_format 97
- 7.4.31 config_charset 97
- 7.4.32 confirmappend 97
- 7.4.33 confirmcreate 97
- 7.4.34 connect_timeout 97
- 7.4.35 content_type 98
- 7.4.36 copy 98
- 7.4.37 crypt_autoencrypt 98
- 7.4.38 crypt_autopgp 98
- 7.4.39 crypt_autosign 99
- 7.4.40 crypt_autosmime 99
- 7.4.41 crypt_replyencrypt 99
- 7.4.42 crypt_replysign 99
- 7.4.43 crypt_replysignencrypted 99
- 7.4.44 crypt_timestamp 100
- 7.4.45 crypt_use_gpgme 100
- 7.4.46 crypt_verify_sig 100
- 7.4.47 date_format 100
- 7.4.48 debug_level 101
- 7.4.49 default_hook 101
- 7.4.50 delete 101
- 7.4.51 delete_space 101
- 7.4.52 delete_untag 102
-
- iv
-
- 7.4.53 digest_collapse 102
- 7.4.54 display_filter 102
- 7.4.55 dotlock_program 102
- 7.4.56 dsn_notify 102
- 7.4.57 dsn_return 103
- 7.4.58 duplicate_threads 103
- 7.4.59 edit_headers 103
- 7.4.60 editor 103
- 7.4.61 editor_headers 103
- 7.4.62 encode_from 104
- 7.4.63 entropy_file 104
- 7.4.64 envelope_from 104
- 7.4.65 escape 104
- 7.4.66 fast_reply 105
- 7.4.67 fcc_attach 105
- 7.4.68 fcc_clear 105
- 7.4.69 file_charset 105
- 7.4.70 folder 105
- 7.4.71 folder_format 106
- 7.4.72 followup_to 107
- 7.4.73 force_buffy_check 107
- 7.4.74 force_name 107
- 7.4.75 forward_decode 107
- 7.4.76 forward_decrypt 108
- 7.4.77 forward_edit 108
- 7.4.78 forward_format 108
- 7.4.79 forward_quote 108
- 7.4.80 from 108
- 7.4.81 gecos_mask 109
- 7.4.82 hdrs 109
- 7.4.83 header 109
- 7.4.84 header_cache 109
- 7.4.85 header_cache_compress 110
- 7.4.86 help 110
- 7.4.87 hidden_host 110
- 7.4.88 hide_limited 110
- 7.4.89 hide_missing 110
- 7.4.90 hide_thread_subject 111
- 7.4.91 hide_top_limited 111
- 7.4.92 hide_top_missing 111
- 7.4.93 history 111
- 7.4.94 honor_followup_to 111
- 7.4.95 hostname 112
- 7.4.96 ignore_list_reply_to 112
- 7.4.97 imap_authenticators 112
- 7.4.98 imap_check_subscribed 112
- 7.4.99 imap_delim_chars 113
- 7.4.100 imap_headers 113
- 7.4.101 imap_home_namespace 113
- 7.4.102 imap_keepalive 113
- 7.4.103 imap_list_subscribed 114
- 7.4.104 imap_login 114
- 7.4.105 imap_mail_check 114
-
- v
-
- 7.4.106 imap_pass 114
- 7.4.107 imap_passive 115
- 7.4.108 imap_peek 115
- 7.4.109 imap_reconnect 115
- 7.4.110 imap_servernoise 115
- 7.4.111 imap_user 116
- 7.4.112 implicit_autoview 116
- 7.4.113 include 116
- 7.4.114 include_onlyfirst 116
- 7.4.115 indent_string 116
- 7.4.116 index_format 116
- 7.4.117 ispell 119
- 7.4.118 keep_flagged 119
- 7.4.119 list_reply 120
- 7.4.120 locale 120
- 7.4.121 mail_check 120
- 7.4.122 mailcap_path 120
- 7.4.123 mailcap_sanitize 120
- 7.4.124 maildir_header_cache_verify 120
- 7.4.125 maildir_trash 121
- 7.4.126 mark_old 121
- 7.4.127 markers 121
- 7.4.128 mask 121
- 7.4.129 max_display_recips 122
- 7.4.130 max_line_length 122
- 7.4.131 mbox 122
- 7.4.132 mbox_type 122
- 7.4.133 menu_context 122
- 7.4.134 menu_move_off 123
- 7.4.135 menu_scroll 123
- 7.4.136 message_format 123
- 7.4.137 meta_key 123
- 7.4.138 metoo 123
- 7.4.139 mh_purge 124
- 7.4.140 mh_seq_flagged 124
- 7.4.141 mh_seq_replied 124
- 7.4.142 mh_seq_unseen 124
- 7.4.143 mime_forward 124
- 7.4.144 mime_forward_decode 124
- 7.4.145 mime_forward_rest 125
- 7.4.146 mix_entry_format 125
- 7.4.147 mixmaster 125
- 7.4.148 move 125
- 7.4.149 msgid_format 126
- 7.4.150 muttng_bindir 127
- 7.4.151 muttng_docdir 127
- 7.4.152 muttng_folder_name 127
- 7.4.153 muttng_folder_path 127
- 7.4.154 muttng_hcache_backend 127
- 7.4.155 muttng_pwd 128
- 7.4.156 muttng_revision 128
- 7.4.157 muttng_sysconfdir 128
- 7.4.158 muttng_version 128
-
- vi
-
- 7.4.159 narrow_tree 128
- 7.4.160 nntp_ask_followup_to 128
- 7.4.161 nntp_ask_x_comment_to 129
- 7.4.162 nntp_cache_dir 129
- 7.4.163 nntp_catchup 129
- 7.4.164 nntp_context 129
- 7.4.165 nntp_followup_to_poster 129
- 7.4.166 nntp_group_index_format 130
- 7.4.167 nntp_host 130
- 7.4.168 nntp_inews 131
- 7.4.169 nntp_load_description 131
- 7.4.170 nntp_mail_check 131
- 7.4.171 nntp_mime_subject 131
- 7.4.172 nntp_newsrc 132
- 7.4.173 nntp_pass 132
- 7.4.174 nntp_post_moderated 132
- 7.4.175 nntp_reconnect 132
- 7.4.176 nntp_save_unsubscribed 133
- 7.4.177 nntp_show_new_news 133
- 7.4.178 nntp_show_only_unread 133
- 7.4.179 nntp_user 133
- 7.4.180 nntp_x_comment_to 133
- 7.4.181 operating_system 134
- 7.4.182 pager 134
- 7.4.183 pager_context 134
- 7.4.184 pager_format 134
- 7.4.185 pager_index_lines 135
- 7.4.186 pager_stop 135
- 7.4.187 pgp_auto_decode 135
- 7.4.188 pgp_autoinline 135
- 7.4.189 pgp_check_exit 136
- 7.4.190 pgp_clearsign_command 136
- 7.4.191 pgp_decode_command 136
- 7.4.192 pgp_decrypt_command 137
- 7.4.193 pgp_encrypt_only_command 137
- 7.4.194 pgp_encrypt_sign_command 137
- 7.4.195 pgp_entry_format 137
- 7.4.196 pgp_export_command 138
- 7.4.197 pgp_getkeys_command 138
- 7.4.198 pgp_good_sign 138
- 7.4.199 pgp_ignore_subkeys 138
- 7.4.200 pgp_import_command 138
- 7.4.201 pgp_list_pubring_command 139
- 7.4.202 pgp_list_secring_command 139
- 7.4.203 pgp_long_ids 139
- 7.4.204 pgp_mime_auto 139
- 7.4.205 pgp_replyinline 139
- 7.4.206 pgp_retainable_sigs 140
- 7.4.207 pgp_show_unusable 140
- 7.4.208 pgp_sign_as 140
- 7.4.209 pgp_sign_command 140
- 7.4.210 pgp_sort_keys 141
- 7.4.211 pgp_strict_enc 141
-
- vii
-
- 7.4.212 pgp_timeout 141
- 7.4.213 pgp_use_gpg_agent 141
- 7.4.214 pgp_verify_command 142
- 7.4.215 pgp_verify_key_command 142
- 7.4.216 pipe_decode 142
- 7.4.217 pipe_sep 142
- 7.4.218 pipe_split 142
- 7.4.219 pop_auth_try_all 142
- 7.4.220 pop_authenticators 143
- 7.4.221 pop_delete 143
- 7.4.222 pop_host 143
- 7.4.223 pop_last 144
- 7.4.224 pop_mail_check 144
- 7.4.225 pop_pass 144
- 7.4.226 pop_reconnect 144
- 7.4.227 pop_user 144
- 7.4.228 post_indent_string 145
- 7.4.229 postpone 145
- 7.4.230 postponed 145
- 7.4.231 preconnect 145
- 7.4.232 print 146
- 7.4.233 print_command 146
- 7.4.234 print_decode 146
- 7.4.235 print_split 146
- 7.4.236 prompt_after 146
- 7.4.237 query_command 147
- 7.4.238 quit 147
- 7.4.239 quote_empty 147
- 7.4.240 quote_quoted 147
- 7.4.241 quote_regexp 147
- 7.4.242 read_inc 148
- 7.4.243 read_only 148
- 7.4.244 realname 148
- 7.4.245 recall 148
- 7.4.246 record 148
- 7.4.247 reply_regexp 149
- 7.4.248 reply_self 149
- 7.4.249 reply_to 149
- 7.4.250 resolve 149
- 7.4.251 reverse_alias 150
- 7.4.252 reverse_name 150
- 7.4.253 reverse_realname 150
- 7.4.254 rfc2047_parameters 150
- 7.4.255 save_address 151
- 7.4.256 save_empty 151
- 7.4.257 save_name 151
- 7.4.258 score 152
- 7.4.259 score_threshold_delete 152
- 7.4.260 score_threshold_flag 152
- 7.4.261 score_threshold_read 152
- 7.4.262 send_charset 152
- 7.4.263 sendmail 153
- 7.4.264 sendmail_wait 153
-
- viii
-
- 7.4.265 shell 153
- 7.4.266 sidebar_boundary 153
- 7.4.267 sidebar_delim 154
- 7.4.268 sidebar_newmail_only 154
- 7.4.269 sidebar_number_format 154
- 7.4.270 sidebar_shorten_hierarchy 155
- 7.4.271 sidebar_visible 155
- 7.4.272 sidebar_width 155
- 7.4.273 sig_dashes 155
- 7.4.274 sig_on_top 155
- 7.4.275 signature 156
- 7.4.276 signoff_string 156
- 7.4.277 simple_search 156
- 7.4.278 sleep_time 156
- 7.4.279 smart_wrap 157
- 7.4.280 smileys 157
- 7.4.281 smime_ask_cert_label 157
- 7.4.282 smime_ca_location 157
- 7.4.283 smime_certificates 157
- 7.4.284 smime_decrypt_command 158
- 7.4.285 smime_decrypt_use_default_key 158
- 7.4.286 smime_default_key 158
- 7.4.287 smime_encrypt_command 159
- 7.4.288 smime_encrypt_with 159
- 7.4.289 smime_get_cert_command 159
- 7.4.290 smime_get_cert_email_command 159
- 7.4.291 smime_get_signer_cert_command 159
- 7.4.292 smime_import_cert_command 160
- 7.4.293 smime_is_default 160
- 7.4.294 smime_keys 160
- 7.4.295 smime_pk7out_command 160
- 7.4.296 smime_sign_command 160
- 7.4.297 smime_sign_opaque_command 161
- 7.4.298 smime_timeout 161
- 7.4.299 smime_verify_command 161
- 7.4.300 smime_verify_opaque_command 161
- 7.4.301 smtp_envelope 161
- 7.4.302 smtp_host 161
- 7.4.303 smtp_pass 162
- 7.4.304 smtp_port 162
- 7.4.305 smtp_use_tls 162
- 7.4.306 smtp_user 163
- 7.4.307 sort 163
- 7.4.308 sort_alias 163
- 7.4.309 sort_aux 163
- 7.4.310 sort_browser 164
- 7.4.311 sort_re 164
- 7.4.312 spam_separator 165
- 7.4.313 spoolfile 165
- 7.4.314 ssl_ca_certificates_file 165
- 7.4.315 ssl_client_cert 165
- 7.4.316 ssl_force_tls 165
- 7.4.317 ssl_min_dh_prime_bits 166
-
- ix
-
- 7.4.318 ssl_starttls 166
- 7.4.319 ssl_use_sslv2 166
- 7.4.320 ssl_use_sslv3 166
- 7.4.321 ssl_use_tlsv1 166
- 7.4.322 ssl_usesystemcerts 167
- 7.4.323 status_chars 167
- 7.4.324 status_format 167
- 7.4.325 status_on_top 169
- 7.4.326 strict_mailto 170
- 7.4.327 strict_mime 170
- 7.4.328 strict_threads 170
- 7.4.329 strip_was 170
- 7.4.330 strip_was_regex 171
- 7.4.331 stuff_quoted 171
- 7.4.332 suspend 171
- 7.4.333 text_flowed 171
- 7.4.334 thorough_search 171
- 7.4.335 thread_received 172
- 7.4.336 tilde 172
- 7.4.337 timeout 172
- 7.4.338 tmpdir 172
- 7.4.339 to_chars 172
- 7.4.340 trash 173
- 7.4.341 tunnel 173
- 7.4.342 umask 173
- 7.4.343 uncollapse_jump 173
- 7.4.344 use_8bitmime 173
- 7.4.345 use_domain 174
- 7.4.346 use_from 174
- 7.4.347 use_idn 174
- 7.4.348 use_ipv6 174
- 7.4.349 visual 174
- 7.4.350 wait_key 175
- 7.4.351 weed 175
- 7.4.352 wrap_search 175
- 7.4.353 wrapmargin 175
- 7.4.354 write_bcc 175
- 7.4.355 write_inc 176
- 7.4.356 xterm_icon 176
- 7.4.357 xterm_leave 176
- 7.4.358 xterm_set_titles 176
- 7.4.359 xterm_title 176
- 7.5 Functions ....................................................... 177
- 7.5.1 generic 177
- 7.5.2 index 178
- 7.5.3 pager 180
- 7.5.4 alias 182
- 7.5.5 query 182
- 7.5.6 attach 182
- 7.5.7 compose 183
- 7.5.8 postpone 184
- 7.5.9 browser 184
- 7.5.10 pgp 185
-
- x
-
- 7.5.11 editor 185
-
- 8. Miscellany ............................................................ 185
- 8.1 Acknowledgments ................................................. 186
- 8.2 About this document ............................................. 188
-
- xi
+5.1. generic
+ The generic menu is not a real menu, but specifies common functions (such as movement) available in all menus except for pager and editor. Changing settings for this menu will affect the default bindings for all menus (except as noted).
+bottom-page L move to the bottom of the page
+current-bottom not bound move current entry to bottom of page
+current-middle not bound move current entry to middle of page
+current-top not bound move current entry to top of page
+enter-command : enter a muttngrc command
+exit q exit this menu
+first-entry = move to the first entry
+half-down ] scroll down 1/2 page
+half-up [ scroll up 1/2 page
+help ? this screen
+jump number jump to an index number
+last-entry * move to the last entry
+middle-page M move to the middle of the page
+next-entry j move to the next entry
+next-line > scroll down one line
+next-page z move to the next page
+previous-entry k move to the previous entry
+previous-line < scroll up one line
+previous-page Z move to the previous page
+refresh ^L clear and redraw the screen
+search / search for a regular expression
+search-next n search for next match
+search-opposite not bound search for next match in opposite direction
+search-reverse ESC / search backwards for a regular expression
+select-entry RET select the current entry
+shell-escape ! run a program in a subshell
+tag-entry t toggle the tag on the current entry
+tag-prefix ; apply next command to tagged entries
+tag-prefix-cond not bound apply next function ONLY to tagged messages
+top-page H move to the top of the page
+what-key not bound display the keycode for a key press
+
+5.2. index
+
+bounce-message b remail a message to another user
+change-folder c open a different folder
+change-folder-readonly ESC c open a different folder in read only mode
+check-traditional-pgp ESC P check for classic pgp
+clear-flag W clear a status flag from a message
+copy-message C copy a message to a file/mailbox
+create-alias a create an alias from a message sender
+decode-copy ESC C decode a message and copy it to a file/mailbox
+decode-save ESC s decode a message and save it to a file/mailbox
+delete-message d delete the current entry
+delete-pattern D delete messages matching a pattern
+delete-subthread ESC d delete all messages in subthread
+delete-thread ^D delete all messages in thread
+display-address @ display full address of sender
+display-toggle-weed h display message and toggle header weeding
+display-message RET display a message
+edit e edit the current message
+edit-type ^E edit the current message's Content-Type
+exit x exit without saving changes
+extract-keys ^K extract PGP public keys
+fetch-mail G retrieve mail from POP server
+flag-message F toggle a message's 'important' flag
+forget-passphrase ^F wipe PGP passphrase from memory
+forward-message f forward a message with comments
+group-reply g reply to all recipients
+limit l show only messages matching a pattern
+list-reply L reply to specified mailing list
+mail m compose a new mail message
+mail-key ESC k mail a PGP public key
+next-new TAB jump to the next new message
+next-subthread ESC n jump to the next subthread
+next-thread ^N jump to the next thread
+next-undeleted j move to the next undeleted message
+next-unread not bound jump to the next unread message
+parent-message P jump to parent message in thread
+pipe-message | pipe message/attachment to a shell command
+previous-new ESC TAB jump to the previous new message
+previous-page Z move to the previous page
+previous-subthread ESC p jump to previous subthread
+previous-thread ^P jump to previous thread
+previous-undeleted k move to the last undelete message
+previous-unread not bound jump to the previous unread message
+print-message p print the current entry
+query Q query external program for addresses
+quit q save changes to mailbox and quit
+read-subthread ESC r mark the current subthread as read
+read-thread ^R mark the current thread as read
+recall-message R recall a postponed message
+reply r reply to a message
+resend-message ESC e resend message and preserve MIME structure
+save-message s save message/attachment to a file
+set-flag w set a status flag on a message
+show-version V show the Mutt-ng version number and date
+show-limit ESC l show currently active limit pattern, if any
+sort-mailbox o sort messages
+sort-reverse O sort messages in reverse order
+sync-mailbox $ save changes to mailbox
+tag-pattern T tag messages matching a pattern
+tag-thread ESC t tag/untag all messages in the current thread
+toggle-new N toggle a message's 'new' flag
+toggle-write % toggle whether the mailbox will be rewritten
+undelete-message u undelete the current entry
+undelete-pattern U undelete messages matching a pattern
+undelete-subthread ESC u undelete all messages in subthread
+undelete-thread ^U undelete all messages in thread
+untag-pattern ^T untag messages matching a pattern
+view-attachments v show MIME attachments
+
+5.3. pager
+
+bottom not bound jump to the bottom of the message
+bounce-message b remail a message to another user
+change-folder c open a different folder
+change-folder-readonly ESC c open a different folder in read only mode
+check-traditional-pgp ESC P check for classic pgp
+copy-message C copy a message to a file/mailbox
+create-alias a create an alias from a message sender
+decode-copy ESC C decode a message and copy it to a file/mailbox
+decode-save ESC s decode a message and save it to a file/mailbox
+delete-message d delete the current entry
+delete-subthread ESC d delete all messages in subthread
+delete-thread ^D delete all messages in thread
+display-address @ display full address of sender
+display-toggle-weed h display message and toggle header weeding
+edit e edit the current message
+edit-type ^E edit the current message's Content-Type
+enter-command : enter a muttngrc command
+exit i return to the main-menu
+extract-keys ^K extract PGP public keys
+flag-message F toggle a message's 'important' flag
+forget-passphrase ^F wipe PGP passphrase from memory
+forward-message f forward a message with comments
+group-reply g reply to all recipients
+half-up not bound move up one-half page
+half-down not bound move down one-half page
+help ? this screen
+list-reply L reply to specified mailing list
+mail m compose a new mail message
+mail-key ESC k mail a PGP public key
+mark-as-new N toggle a message's 'new' flag
+next-line RET scroll down one line
+next-entry J move to the next entry
+next-new TAB jump to the next new message
+next-page move to the next page
+next-subthread ESC n jump to the next subthread
+next-thread ^N jump to the next thread
+next-undeleted j move to the next undeleted message
+next-unread not bound jump to the next unread message
+parent-message P jump to parent message in thread
+pipe-message | pipe message/attachment to a shell command
+previous-line BackSpace scroll up one line
+previous-entry K move to the previous entry
+previous-new not bound jump to the previous new message
+previous-page - move to the previous page
+previous-subthread ESC p jump to previous subthread
+previous-thread ^P jump to previous thread
+previous-undeleted k move to the last undelete message
+previous-unread not bound jump to the previous unread message
+print-message p print the current entry
+quit Q save changes to mailbox and quit
+read-subthread ESC r mark the current subthread as read
+read-thread ^R mark the current thread as read
+recall-message R recall a postponed message
+redraw-screen ^L clear and redraw the screen
+reply r reply to a message
+save-message s save message/attachment to a file
+search / search for a regular expression
+search-next n search for next match
+search-opposite not bound search for next match in opposite direction
+search-reverse ESC / search backwards for a regular expression
+search-toggle \ toggle search pattern coloring
+shell-escape ! invoke a command in a subshell
+show-version V show the Mutt-ng version number and date
+skip-quoted S skip beyond quoted text
+sync-mailbox $ save changes to mailbox
+tag-message t tag a message
+toggle-quoted T toggle display of quoted text
+top ^ jump to the top of the message
+undelete-message u undelete the current entry
+undelete-subthread ESC u undelete all messages in subthread
+undelete-thread ^U undelete all messages in thread
+view-attachments v show MIME attachments
+
+5.4. alias
+
+search / search for a regular expression
+search-next n search for next match
+search-reverse ESC / search backwards for a regular expression
+
+5.5. query
+
+create-alias a create an alias from a message sender
+mail m compose a new mail message
+query Q query external program for addresses
+query-append A append new query results to current results
+search / search for a regular expression
+search-next n search for next match
+search-opposite not bound search for next match in opposite direction
+search-reverse ESC / search backwards for a regular expression
+
+5.6. attach
+
+bounce-message b remail a message to another user
+collapse-parts v toggle display of subparts
+delete-entry d delete the current entry
+display-toggle-weed h display message and toggle header weeding
+edit-type ^E edit the current entry's Content-Type
+extract-keys ^K extract PGP public keys
+forward-message f forward a message with comments
+group-reply g reply to all recipients
+list-reply L reply to specified mailing list
+pipe-entry | pipe message/attachment to a shell command
+print-entry p print the current entry
+reply r reply to a message
+resend-message ESC e resend message and preserve MIME structure
+save-entry s save message/attachment to a file
+undelete-entry u undelete the current entry
+view-attach RET view attachment using mailcap entry if necessary
+view-mailcap m force viewing of attachment using mailcap
+view-text T view attachment as text
+
+5.7. compose
+
+attach-file a attach a file(s) to this message
+attach-message A attach message(s) to this message
+attach-key ESC k attach a PGP public key
+copy-file C save message/attachment to a file
+detach-file D delete the current entry
+display-toggle-weed h display message and toggle header weeding
+edit-bcc b edit the BCC list
+edit-cc c edit the CC list
+edit-description d edit attachment description
+edit-encoding ^E edit attachment transfer-encoding
+edit-fcc f enter a file to save a copy of this message in
+edit-from ESC f edit the from: field
+edit-file ^X e edit the file to be attached
+edit-headers E edit the message with headers
+edit e edit the message
+edit-mime m edit attachment using mailcap entry
+edit-reply-to r edit the Reply-To field
+edit-subject s edit the subject of this message
+edit-to t edit the TO list
+edit-type ^T edit attachment type
+filter-entry F filter attachment through a shell command
+forget-passphrase ^F wipe PGP passphrase from memory
+ispell i run ispell on the message
+new-mime n compose new attachment using mailcap entry
+pgp-menu p show PGP options
+pipe-entry | pipe message/attachment to a shell command
+postpone-message P save this message to send later
+print-entry l print the current entry
+rename-file R rename/move an attached file
+send-message y send the message
+toggle-unlink u toggle whether to delete file after sending it
+view-attach RET view attachment using mailcap entry if necessary
+write-fcc w write the message to a folder
+
+5.8. postpone
+
+delete-entry d delete the current entry
+undelete-entry u undelete the current entry
+
+5.9. browser
+
+change-dir c change directories
+check-new TAB check mailboxes for new mail
+enter-mask m enter a file mask
+search / search for a regular expression
+search-next n search for next match
+search-reverse ESC / search backwards for a regular expression
+select-new N select a new file in this directory
+sort o sort messages
+sort-reverse O sort messages in reverse order
+toggle-mailboxes TAB toggle whether to browse mailboxes or all files
+view-file SPACE view file
+subscribe s subscribe to current mailbox (IMAP Only)
+unsubscribe u unsubscribe to current mailbox (IMAP Only)
+toggle-subscribed T toggle view all/subscribed mailboxes (IMAP Only)
+
+5.10. pgp
+
+view-name % view the key's user id
+verify-key c verify a PGP public key
+
+5.11. editor
+
+backspace BackSpace delete the char in front of the cursor
+backward-char ^B move the cursor one character to the left
+backward-word ESC b move the cursor to the previous word
+bol ^A jump to the beginning of the line
+buffy-cycle Space cycle among incoming mailboxes
+capitalize-word ESC c uppercase the first character in the word
+complete TAB complete filename or alias
+complete-query ^T complete address with query
+delete-char ^D delete the char under the cursor
+downcase-word ESC l lowercase all characters in current word
+eol ^E jump to the end of the line
+forward-char ^F move the cursor one character to the right
+forward-word ESC f move the cursor to the next word
+history-down not bound scroll down through the history list
+history-up not bound scroll up through the history list
+kill-eol ^K delete chars from cursor to end of line
+kill-eow ESC d delete chars from cursor to end of word
+kill-line ^U delete all chars on the line
+kill-word ^W delete the word in front of the cursor
+quote-char ^V quote the next typed key
+transpose-chars not bound transpose character under cursor with previous
+upcase-word ESC u uppercase all characters in current word
+
+Chapter 8. Miscellany
+
+ Table of Contents
+
+ 1. Acknowledgments
+
+1. Acknowledgments
+
+ Kari Hurtta <kari.hurtta@fmi.fi> co-developed the original MIME >parsing code back in the ELM-ME days.
+
+ The following people have been very helpful to the development of Mutt:
+
+ Vikas Agnihotri <vikasa@writeme.com>, Francois Berjon <Francois.Berjon@aar.alcatel-alsthom.fr>, Aric Blumer <aric@fore.com>, John Capo <jc@irbs.com>, David Champion <dgc@uchicago.edu, Brendan Cully <brendan@kublai.com>, Liviu Daia <daia@stoilow.imar.ro>, Thomas E. Dickey <dickey@herndon4.his.com>, David DeSimone <fox@convex.hp.com>, Nickolay N. Dudorov <nnd@wint.itfs.nsk.su>, Ruslan Ermilov <ru@freebsd.org>, Edmund Grimley Evans <edmundo@rano.org, Michael Finken <finken@conware.de>, Sven Guckes <guckes@math.fu-berlin.de>, Lars Hecking <lhecking@nmrc.ie>, Mark Holloman <holloman@nando.net>, Andreas Holzmann <holzmann@fmi.uni-passau.de>, Marco d'Itri <md@linux.it>, Björn Jacke <bjacke@suse.com>, Byrial Jensen <byrial@image.dk>, David Jeske <jeske@igcom.net>, Christophe Kalt <kalt@hugo.int-evry.fr>, Tommi Komulainen <Tommi.Komulainen@iki.fi>, Felix von Leitner (a.k.a ``Fefe'') <leitner@math.fu-berlin.de>, Brandon Long <blong@fiction.net>, Jimmy Mäkelä <jmy@f
+ lashback.net>, Lars Marowsky-Bree <lmb@pointer.in-minden.de>, Thomas ``Mike'' Michlmayr <mike@cosy.sbg.ac.at>, Andrew W. Nosenko <awn@bcs.zp.ua>, David O'Brien <obrien@Nuxi.cs.ucdavis.edu>, Clint Olsen <olsenc@ichips.intel.com>, Park Myeong Seok <pms@romance.kaist.ac.kr>, Thomas Parmelan <tom@ankh.fr.eu.org>, Ollivier Robert <roberto@keltia.freenix.fr>, Thomas Roessler <roessler@does-not-exist.org>, Roland Rosenfeld <roland@spinnaker.de>, TAKIZAWA Takashi <taki@luna.email.ne.jp>, Allain Thivillon <Allain.Thivillon@alma.fr> Gero Treuner <gero@faveve.uni-stuttgart.de>, Vsevolod Volkov <vvv@lucky.net>, Ken Weinert <kenw@ihs.com>
+
+ Mutt-ng is developed by the following people:
+
+ Andreas Krennmair <ak@synflood.at>, Nico Golde <nico@ngolde.de>, Rocco Rutte <pdmef@cs.tu-berlin.de>
+
+ The following people have been very helpful to the development of Mutt-ng:
+
+ Christian Gall <cg@cgall.de>, Iain Lea <iain@bricbrac.de>, Andreas Kneib <akneib@gmx.net>, Carsten Schoelzki <cjs@weisshuhn.de>, Elimar Riesebieter <riesebie@lxtec.de>
projects / apps / madmutt.git / commitdiff