Rocco Rutte:

[apps/madmutt.git] / doc / manual.xml.head

<?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>

<bookinfo>
  <title>The Mutt Next Generation E-Mail Client</title>
  <author>
    <firstname>Andreas</firstname><surname>Krennmair</surname>
    <email>ak@synflood.at</email>
  </author>
  <author>
    <firstname>Michael</firstname><surname>Elkins</surname>
    <email>me@cs.hmc.edu</email>
  </author>
  <pubdate>version devel-r473</pubdate>
  <abstract>
    <para>
      Michael Elinks on mutt, circa 1995:
      ``All mail clients suck. This one just sucks less.''
    </para>
    <para>
      Sven Guckes on mutt, ca. 2003: ``But it still sucks!''
    </para>
  </abstract>
</bookinfo>

<chapter> <!--{{{-->
  <title>Introduction  </title>
  
  <sect1>
    <title>Overview  </title>
    
    <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>
    
    <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>
          
          <para>
            <email>mutt-ng-users@lists.berlios.de</email>: This is
            where the mutt-ng user support happens.
          </para>
        </listitem>
        <listitem>
          
          <para>
            <email>mutt-ng-devel@lists.berlios.de</email>: The
            development mailing list for mutt-ng
          </para>
        </listitem>
        
      </itemizedlist>
      
    </para>
    
    <para>
      
    </para>
    
  </sect1>
  
  <sect1>
    <title>Software Distribution Sites  </title>
    
    <para>
      So far, there are no official releases of Mutt-ng, but you can
      download daily snapshots from <ulink
        url="http://mutt-ng.berlios.de/snapshots/"
        >http://mutt-ng.berlios.de/snapshots/</ulink>
    </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>
    
  </sect1>
  
  <sect1>
    <title>Weblog  </title>
    
    <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 <ulink
        url="http://mutt-ng.supersized.org/">Mutt-ng development
        weblog</ulink>.
    </para>
    
  </sect1>
  
  <sect1>
    <title>Copyright  </title>
    
    <para>
      Mutt is Copyright (C) 1996-2000 Michael R. Elkins
      &lt;me@cs.hmc.edu&gt; 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>
    
  </sect1>
  
</chapter>
  <!--}}}-->

<chapter>
  <title>Getting Started    </title>
  
  <sect1> <!--{{{-->
    <title>Basic Concepts      </title>
    
    <sect2> <!--{{{-->
      <title>Screens and Menus        </title>
      
      <para>
        mutt-ng offers different screens of which every has its special
        purpose:
      </para>
      
      <para>
        
        <itemizedlist>
          <listitem>
            
            <para>
              The <emphasis>index</emphasis> displays the contents of the
              currently opened
              mailbox.
              
            </para>
          </listitem>
          <listitem>
            
            <para>
              The <emphasis>pager</emphasis> is responsible for displaying
              messages, that
              is, the header, the body and all attached parts.
              
            </para>
          </listitem>
          <listitem>
            
            <para>
              The <emphasis>file browser</emphasis> offers operations on and
              displays
              information of all folders mutt-ng should watch for mail.
              
            </para>
          </listitem>
          <listitem>
            
            <para>
              The <emphasis>sidebar</emphasis> offers a permanent view of
              which mailboxes
              contain how many total, new and/or flagged mails.
              
            </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.
              
            </para>
          </listitem>
          <listitem>
            
            <para>
              The <emphasis>compose</emphasis> menu is a comfortable
              interface take last
              actions before sending mail: change subjects, attach files,
              remove
              attachements, etc.
              
            </para>
          </listitem>
          <listitem>
            
            <para>
              The <emphasis>attachement</emphasis> menu gives a summary and
              the tree
              structure of the attachements of the current message.
              
            </para>
          </listitem>
          <listitem>
            
            <para>
              The <emphasis>alias</emphasis> menu lists all or a fraction of
              the aliases
              a user has defined.
              
            </para>
          </listitem>
          <listitem>
            
            <para>
              The <emphasis>key</emphasis> menu used in connection with
              encryption lets
              users choose the right key to encrypt with.
              
            </para>
          </listitem>
          
        </itemizedlist>
        
      </para>
      
      <para>
        When mutt-ng is started without any further options, it'll open
        the users default mailbox and display the index.
      </para>
      
      <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>
      
    </sect2>
      <!--}}}-->
    
    <sect2> <!--{{{-->
      <title>Functions        </title>
      
      <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>
      
      <para>
        
      </para>
      
    </sect2>
      <!--}}}-->
    
    <sect2> <!--{{{-->
      <title>Interaction        </title>
      
      <para>
        Mutt-ng has two basic concepts of user interaction:
      </para>
      
      <para>
        
        <orderedlist>
          <listitem>
            
            <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.
              
            </para>
          </listitem>
          <listitem>
            
            <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>
          
        </orderedlist>
        
      </para>
      
      <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>
      
    </sect2>
      <!--}}}-->
    
    <sect2> <!--{{{-->
      <title>Patterns        </title>
      
      <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>
      
      <para>
        
      </para>
      
      <para>
        
      </para>
      
    </sect2>
      <!--}}}-->
    
  </sect1>
  
  <!--}}}-->
  
  <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>
      
    </sect2>
    
    <sect2>
      <title>File Browser        </title>
      
      <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>
      
      <para>
        
      </para>
      
    </sect2>
    
    <sect2>
      <title>Sidebar        </title>
      
      <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>
      
      <para>
        
      </para>
      
    </sect2>
    
    <sect2>
      <title>Help        </title>
      
      <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>
      
      <para>
        
      </para>
      
    </sect2>
    
    <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>
    
  </sect1>
    <!--}}}-->
  
  <sect1> <!--{{{-->
    <title>Moving Around in Menus  </title>
    
    <para>
      Information is presented in menus, very similar to ELM.  Here is a
      tableshowing the common keys used to navigate menus in Mutt-ng.
    </para>
    
    <para>

      <table>
        <title>Default Menu Movement Keys</title>
        <tgroup cols="3" align="left" colsep="1" rowsep="1">
        <thead>
          <row>
            <entry>Key</entry>
            <entry>Function</entry>
            <entry>Description</entry>
          </row>
        </thead>
        <tbody>
          <row>
            <entry><code>j</code> or <code>Down</code></entry>
            <entry><code>next-entry</code></entry>
            <entry>move to the next entry</entry>
          </row>
          <row>
            <entry><code>k</code> or <code>Up</code></entry>
            <entry><code>previous-entry</code></entry>
            <entry>move to the previous entry</entry>
          </row>
          <row>
            <entry><code>z</code> or <code>PageDn</code></entry>
            <entry><code>page-down</code></entry>
            <entry>go to the next page</entry>
          </row>
          <row>
            <entry><code>Z</code> or <code>PageUp</code></entry>
            <entry><code>page-up</code></entry>
            <entry>go to the previous page</entry>
          </row>
          <row>
            <entry><code>=</code> or <code>Home</code></entry>
            <entry><code>first-entry</code></entry>
            <entry>jump to the first entry</entry>
          </row>
          <row>
            <entry><code>*</code> or <code>End</code></entry>
            <entry><code>last-entry</code></entry>
            <entry>jump to the last entry</entry>
          </row>
          <row>
            <entry><code>q</code></entry>
            <entry><code>quit</code></entry>
            <entry>exit the current menu</entry>
          </row>
          <row>
            <entry><code>?</code></entry>
            <entry><code>help</code></entry>
            <entry>list all key bindings for the current menu</entry>
          </row>
        </tbody>
      </tgroup>
    </table>


    </para>
    
    <para>
      
    </para>
    
  </sect1>
    <!--}}}-->
  
  <sect1 id="editing"> <!--{{{-->
    <title>Editing Input Fields  </title>
    
    <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>
    
    <para>

      <table>
        <title>Built-In Editor Functions</title>
        <tgroup cols="3" align="left" colsep="1" rowsep="1">
        <thead>
          <row>
            <entry>Key</entry>
            <entry>Function</entry>
            <entry>Description</entry>
          </row>
        </thead>
        <tbody>
          <row>
            <entry><code>^A or &#60;Home&#62;  </code></entry>
            <entry><code>bol     </code></entry>
            <entry>move to the start of the line</entry>
          </row>
          <row>
            <entry><code>^B or &#60;Left&#62;   </code></entry>
            <entry><code>backward-char </code>
            </entry><entry>move back one char</entry>
          </row>
          <row>
            <entry><code>Esc B  </code></entry>
            <entry><code>backward-word    </code></entry>
            <entry>move back one word</entry>
          </row>
          <row>
            <entry><code>^D or &#60;Delete&#62;  </code></entry>
            <entry><code>delete-char    </code></entry>
            <entry>delete the char under the cursor</entry>
          </row>
          <row>
            <entry><code>^E or &#60;End&#62;   </code></entry>
            <entry><code>eol          </code></entry>
            <entry>move to the end of the line</entry>
          </row>
          <row>
            <entry><code>^F or &#60;Right&#62;  </code></entry>
            <entry><code>forward-char   </code></entry>
            <entry>move forward one char</entry>
          </row>
          <row>
            <entry><code>Esc F </code></entry>
            <entry><code>forward-word      </code></entry>
            <entry>move forward one word</entry>
          </row>
          <row>
            <entry><code>&#60;Tab&#62;   </code></entry>
            <entry><code>complete     </code></entry>
            <entry>complete filename or alias</entry>
          </row>
          <row>
            <entry><code>^T         </code></entry>
            <entry><code>complete-query   </code></entry>
            <entry>complete address with query</entry>
          </row>
          <row>
            <entry><code>^K          </code></entry>
            <entry><code>kill-eol      </code></entry>
            <entry>delete to the end of the line</entry>
          </row>
          <row>
            <entry><code>ESC d </code></entry>
            <entry><code>kill-eow    </code></entry>
            <entry>delete to the end of the word</entry>
          </row>
          <row>
            <entry><code>^W     </code></entry>
            <entry><code>kill-word     </code></entry>
            <entry>kill the word in front of the cursor</entry>
          </row>
          <row>
            <entry><code>^U      </code></entry>
            <entry><code>kill-line      </code></entry>
            <entry>delete entire line</entry>
          </row>
          <row>
            <entry><code>^V       </code></entry>
            <entry><code>quote-char    </code></entry>
            <entry>quote the next typed key</entry>
          </row>
          <row>
            <entry><code>&#60;Up&#62;   </code></entry>
            <entry><code>history-up   </code></entry>
            <entry>recall previous string from history</entry>
          </row>
          <row>
            <entry><code>&#60;Down&#62;      </code></entry>
            <entry><code>history-down   </code></entry>
            <entry>recall next string from history</entry>
          </row>
          <row>
            <entry><code>&#60;BackSpace&#62;  </code></entry>
            <entry><code>backspace     </code></entry>
            <entry>kill the char in front of the cursor</entry>
          </row>
          <row>
            <entry><code>Esc u        </code></entry>
            <entry><code>upcase-word      </code></entry>
            <entry>convert word to upper case</entry>
          </row>
          <row>
            <entry><code>Esc l        </code></entry>
            <entry><code>downcase-word      </code></entry>
            <entry>convert word to lower case</entry>
          </row>
          <row>
            <entry><code>Esc c        </code></entry>
            <entry><code>capitalize-word    </code></entry>
            <entry>capitalize the word</entry>
          </row>
          <row>
            <entry><code>^G           </code></entry>
            <entry><code>n/a    </code></entry>
            <entry>abort</entry>
          </row>
          <row>
            <entry><code>&#60;Return&#62;     </code></entry>
            <entry><code>n/a    </code></entry>
            <entry>finish editing</entry>
          </row>
        </tbody>
      </tgroup>
    </table>

    </para>
    
    <para>
      You can remap the <emphasis>editor</emphasis> functions using the <link linkend="bind">
        bind
      </link>
      command.  For example, to make the <emphasis>Delete</emphasis> key
      delete the character in
      front of the cursor rather than under, you could use
    </para>
    
    <para>
      <literal>bind editor &lt;delete&gt; backspace</literal>
    </para>
    
    <para>
      
    </para>
    
  </sect1>
    <!--}}}-->
  
  <sect1>
    <title>Reading Mail - The Index and Pager  </title> <!--{{{-->
    
    <para>
      Similar to many other mail clients, there are two modes in which mail
      isread 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>
    
    <sect2>
      <title>The Message Index</title> <!--{{{-->
      
      <para>

      <table>
        <title>Default Index Menu Bindings</title>
        <tgroup cols="3" align="left" colsep="1" rowsep="1">
        <thead>
          <row>
            <entry>Key</entry>
            <entry>Function</entry>
            <entry>Description</entry>
          </row>
        </thead>
        <tbody>
          <row><entry><code>c      </code></entry><entry><code></code></entry><entry>change to a different mailbox</entry></row>
          <row><entry><code>ESC c    </code></entry><entry><code></code></entry><entry>change to a folder in read-only mode</entry></row>
          <row><entry><code>C        </code></entry><entry><code></code></entry><entry>copy the current message to another mailbox</entry></row>
          <row><entry><code>ESC C     </code></entry><entry><code></code></entry><entry>decode a message and copy it to a folder</entry></row>
          <row><entry><code>ESC s    </code></entry><entry><code></code></entry><entry>decode a message and save it to a folder</entry></row>
          <row><entry><code>D       </code></entry><entry><code></code></entry><entry>delete messages matching a pattern</entry></row>
          <row><entry><code>d     </code></entry><entry><code></code></entry><entry>delete the current message</entry></row>
          <row><entry><code>F      </code></entry><entry><code></code></entry><entry>mark as important</entry></row>
          <row><entry><code>l      </code></entry><entry><code></code></entry><entry>show messages matching a pattern</entry></row>
          <row><entry><code>N       </code></entry><entry><code></code></entry><entry>mark message as new</entry></row>
          <row><entry><code>o       </code></entry><entry><code></code></entry><entry>change the current sort method</entry></row>
          <row><entry><code>O       </code></entry><entry><code></code></entry><entry>reverse sort the mailbox</entry></row>
          <row><entry><code>q       </code></entry><entry><code></code></entry><entry>save changes and exit</entry></row>
          <row><entry><code>s        </code></entry><entry><code></code></entry><entry>save-message</entry></row>
          <row><entry><code>T       </code></entry><entry><code></code></entry><entry>tag messages matching a pattern</entry></row>
          <row><entry><code>t       </code></entry><entry><code></code></entry><entry>toggle the tag on a message</entry></row>
          <row><entry><code>ESC t  </code></entry><entry><code></code></entry><entry>toggle tag on entire message thread</entry></row>
          <row><entry><code>U       </code></entry><entry><code></code></entry><entry>undelete messages matching a pattern</entry></row>
          <row><entry><code>u        </code></entry><entry><code></code></entry><entry>undelete-message</entry></row>
          <row><entry><code>v        </code></entry><entry><code></code></entry><entry>view-attachments</entry></row>
          <row><entry><code>x       </code></entry><entry><code></code></entry><entry>abort changes and exit</entry></row>
          <row><entry><code>&#60;Return&#62;  </code></entry><entry><code></code></entry><entry>display-message</entry></row>
          <row><entry><code>&#60;Tab&#62;      </code></entry><entry><code></code></entry><entry>jump to the next new message</entry></row>
          <row><entry><code>@      </code></entry><entry><code></code></entry><entry>show the author's full e-mail address</entry></row>
          <row><entry><code>$       </code></entry><entry><code></code></entry><entry>save changes to mailbox</entry></row>
          <row><entry><code>/       </code></entry><entry><code></code></entry><entry>search</entry></row>
          <row><entry><code>ESC /     </code></entry><entry><code></code></entry><entry>search-reverse</entry></row>
          <row><entry><code>^L       </code></entry><entry><code></code></entry><entry>clear and redraw the screen</entry></row>
          <row><entry><code>^T        </code></entry><entry><code></code></entry><entry>untag messages matching a pattern</entry></row>
        </tbody>
      </tgroup>
    </table>

      </para>
      
      <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
          
          <itemizedlist>
            <listitem>
              
              <para>
                <emphasis role="bold">set-flag</emphasis> (default: w)
              </para>
            </listitem>
            <listitem>
              
              <para>
                <emphasis role="bold">clear-flag</emphasis> (default: W)
              </para>
            </listitem>
            
          </itemizedlist>
          
        </para>
        
        <para>
          Furthermore, the following flags reflect who the message is
          addressed
          to.  They can be customized with the
          <link linkend="to-chars">&dollar;to&lowbar;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>
      
      <!--}}}-->
    </sect2>
    
    <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 <emphasis>less</emphasis> though not nearly as
        featureful.
      </para>
      
      <para>

      <table>
        <title>Default Pager Menu Bindings</title>
        <tgroup cols="3" align="left" colsep="1" rowsep="1">
        <thead>
          <row>
            <entry>Key</entry>
            <entry>Function</entry>
            <entry>Description</entry>
          </row>
        </thead>
        <tbody>
          <row><entry><code>&#60;Return&#62;   </code></entry><entry><code></code></entry><entry>go down one line</entry></row>
          <row><entry><code>&#60;Space&#62;   </code></entry><entry><code></code></entry><entry>display the next page (or next message if at the end of a message)</entry></row>
          <row><entry><code>-           </code></entry><entry><code></code></entry><entry>go back to the previous page</entry></row>
          <row><entry><code>n            </code></entry><entry><code></code></entry><entry>search for next match</entry></row>
          <row><entry><code>S         </code></entry><entry><code></code></entry><entry>skip beyond quoted text</entry></row>
          <row><entry><code>T         </code></entry><entry><code></code></entry><entry>toggle display of quoted text</entry></row>
          <row><entry><code>?        </code></entry><entry><code></code></entry><entry>show key bindings</entry></row>
          <row><entry><code>/        </code></entry><entry><code></code></entry><entry>search for a regular expression (pattern)</entry></row>
          <row><entry><code>ESC /   </code></entry><entry><code></code></entry><entry>search backwards for a regular expression</entry></row>
          <row><entry><code>\       </code></entry><entry><code></code></entry><entry>toggle search pattern coloring</entry></row>
          <row><entry><code>^      </code></entry><entry><code></code></entry><entry>jump to the top of the message</entry></row>
        </tbody>
      </tgroup>
    </table>


      </para>
      
      <para>
        In addition, many of the functions from the <emphasis>index</emphasis> are available in
        the pager, such as <emphasis>delete-message</emphasis> or <emphasis>
          copy-message
        </emphasis>
        (this is one
        advantage over using an external pager to view messages).
      </para>
      
      <para>
        Also, the internal pager supports a couple other advanced features.
        For
        one, it will accept and translate the ``standard'' nroff sequences
        forbold and underline. These sequences are a series of either the
        letter,
        backspace (&circ;H), the letter again for bold or the letter,
        backspace,
        ``&lowbar;'' for denoting underline. Mutt-ng will attempt to display
        these
        in bold and underline respectively if your terminal supports them. If
        not, you can use the bold and underline <link
linkend="color">color</link>
        objects to specify a color or mono attribute for them.
      </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: <literal>ESC [ Ps;Ps;Ps;...;Ps
          m</literal> (see table below for possible values for
        <code>Ps</code>).
      </para>
      
      <para>

      <table>
        <title>ANSI Escape Sequences</title>
        <tgroup cols="2" align="left" colsep="1" rowsep="1">
        <thead>
          <row>
            <entry>Value</entry>
            <entry>Attribute</entry>
          </row>
        </thead>
        <tbody>
          <row><entry><code>0  </code></entry><entry>All Attributes Off</entry></row>
          <row><entry><code>1  </code></entry><entry>Bold on</entry></row>
          <row><entry><code>4  </code></entry><entry>Underline on</entry></row>
          <row><entry><code>5  </code></entry><entry>Blink on</entry></row>
          <row><entry><code>7 </code></entry><entry>Reverse video on</entry></row>
          <row><entry><code>3x  </code></entry><entry>Foreground color is x (see table below)</entry></row>
          <row><entry><code>4x </code></entry><entry>Background color is x (see table below)</entry></row>
        </tbody>
      </tgroup>
    </table>

    
      <table>
        <title>ANSI Colors</title>
        <tgroup cols="2" align="left" colsep="1" rowsep="1">
        <thead>
          <row>
            <entry>Number</entry>
            <entry>Color</entry>
          </row>
        </thead>
        <tbody>
          <row><entry><code>0   </code></entry><entry>black</entry></row>
          <row><entry><code>1  </code></entry><entry>red</entry></row>
          <row><entry><code>2  </code></entry><entry>green</entry></row>
          <row><entry><code>3  </code></entry><entry>yellow</entry></row>
          <row><entry><code>4  </code></entry><entry>blue</entry></row>
          <row><entry><code>5 </code></entry><entry>magenta</entry></row>
          <row><entry><code>6  </code></entry><entry>cyan</entry></row>
          <row><entry><code>7 </code></entry><entry>white</entry></row>
        </tbody>
      </tgroup>
    </table>


        </para>
        
        <para>
          Mutt-ng uses these attributes for handling text/enriched messages,
          and they
          can also be used by an external <link
  linkend="auto-view">autoview</link>
          script for highlighting purposes.  <emphasis role="bold">Note:</emphasis> If you change the colors for your
          display, for example by changing the color associated with color2 for
          your xterm, then that color will be used instead of green.
        </para>
        
        <!--}}}-->
      </sect2>
      
      <sect2 id="threads">
        <title>Threaded Mode</title> <!--{{{-->
        
        <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>

        <table>
          <title>Default Thread Function Bindings</title>
          <tgroup cols="3" align="left" colsep="1" rowsep="1">
          <thead>
            <row>
              <entry>Key</entry>
              <entry>Function</entry>
              <entry>Description</entry>
            </row>
          </thead>
          <tbody>
            <row><entry><code>^D   </code></entry><entry><code>delete-thread       </code></entry><entry>delete all messages in the current  thread</entry></row>
            <row><entry><code>^U   </code></entry><entry><code>undelete-thread     </code></entry><entry>undelete all messages in the current thread</entry></row>
            <row><entry><code>^N   </code></entry><entry><code>next-thread         </code></entry><entry>jump to the start of the next thread</entry></row>
            <row><entry><code>^P   </code></entry><entry><code>previous-thread     </code></entry><entry>jump to the start of the previous thread</entry></row>
            <row><entry><code>^R    </code></entry><entry><code>read-thread         </code></entry><entry>mark the current thread as read</entry></row>
            <row><entry><code>ESC d </code></entry><entry><code>delete-subthread    </code></entry><entry>delete all messages in the current subthread</entry></row>
            <row><entry><code>ESC u </code></entry><entry><code>undelete-subthread  </code></entry><entry>undelete all messages in the current subthread</entry></row>
            <row><entry><code>ESC n </code></entry><entry><code>next-subthread      </code></entry><entry>jump to the start of the next subthread</entry></row>
            <row><entry><code>ESC p </code></entry><entry><code>previous-subthread  </code></entry><entry>jump to the start of the previous subthread</entry></row>
            <row><entry><code>ESC r </code></entry><entry><code>read-subthread      </code></entry><entry>mark the current subthread as read </entry></row>
            <row><entry><code>ESC t </code></entry><entry><code>tag-thread          </code></entry><entry>toggle the tag on the current thread</entry></row>
            <row><entry><code>ESC v </code></entry><entry><code>collapse-thread    </code></entry><entry>toggle collapse for the current thread</entry></row>
            <row><entry><code>ESC V </code></entry><entry><code>collapse-all      </code></entry><entry>toggle collapse for all threads</entry></row>
            <row><entry><code>P    </code></entry><entry><code>parent-message        </code></entry><entry>jump to parent message in thread</entry></row>
          </tbody>
        </tgroup>
      </table>

          
        </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
          onthe screen. See &percnt;M in <link
  linkend="index-format">
            index-format
          </link>
          .
          For example, you could use
          "&percnt;?M?(&num;&percnt;03M)&amp;(&percnt;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> <!--{{{-->
        
        <para>
          <emphasis role="bold">create-alias</emphasis><anchor id="create-alias"/>
           (default: a)
          
        </para>
        
        <para>
          Creates a new alias based upon the current message (or prompts for a
          new one).  Once editing is complete, an <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>
        
        <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 <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>
        
        <para>
          Toggles the weeding of message header fields specified by <link linkend="ignore">
            ignore
          </link>
          commands.
        </para>
        
        <para>
          <emphasis role="bold">edit</emphasis><anchor id="edit"/>
           (default: e)
          
        </para>
        
        <para>
          This command (available in the ``index'' and ``pager'') allows you to
          edit the raw current message as it's present in the mail folder.
          After you have finished editing, the changed message will be
          appended to the current folder, and the original message will be
          marked for deletion.
        </para>
        
        <para>
          <emphasis role="bold">edit-type</emphasis><anchor id="edit-type"/>
          
          (default: &circ;E on the attachment menu, and in the pager and index
          menus; &circ;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
          <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>
        
        <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: ``:'')
          
        </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 <link linkend="macro">macro</link> to change
          settings on the
          fly.
        </para>
        
        <para>
          <emphasis role="bold">extract-keys</emphasis><anchor id="extract-keys"/>
           (default: &circ;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>
        
        <para>
          <emphasis role="bold">forget-passphrase</emphasis><anchor id="forget-passphrase"/>
           (default:
          &circ;F)
          
        </para>
        
        <para>
          This command wipes the passphrase(s) from memory. It is useful, if
          you misspelled the passphrase.
        </para>
        
        <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 <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: &verbar;)
          
        </para>
        
        <para>
          Asks for an external Unix command and pipes the current or
          tagged message(s) to it.  The variables <link linkend="pipe-decode">
            pipe-decode
          </link>
          ,<link linkend="pipe-split">pipe-split</link>, <link linkend="pipe-sep">
            pipe-sep
          </link>
          and <link linkend="wait-key">wait-key</link> control the exact
          behavior of this
          function.
        </para>
        
        <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 <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: !)
          
        </para>
        
        <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>
        
        <para>
          <emphasis role="bold">toggle-quoted</emphasis><anchor id="toggle-quoted"/>
           (default: T)
          
        </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
          displayof 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)
          
        </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>
        
        <!--}}}-->
      </sect2>
      
      <!--}}}-->
    </sect1>
    
    <sect1>
      <title>Sending Mail  </title> <!--{{{-->
      
      <para>
        The following bindings are available in the <emphasis>index</emphasis>
        for sending
        messages.
      </para>
      
      <para>

        <table>
          <title>Default Mail Composition Bindings</title>
          <tgroup cols="3" align="left" colsep="1" rowsep="1">
          <thead>
            <row>
              <entry>Key</entry>
              <entry>Function</entry>
              <entry>Description</entry>
            </row>
          </thead>
          <tbody>
            <row><entry><code>m    </code></entry><entry><code>compose    </code></entry><entry>compose a new message</entry></row>
            <row><entry><code>r     </code></entry><entry><code>reply       </code></entry><entry>reply to sender</entry></row>
            <row><entry><code>g     </code></entry><entry><code>group-reply </code></entry><entry>reply to all recipients</entry></row>
            <row><entry><code>L     </code></entry><entry><code>list-reply  </code></entry><entry>reply to mailing list address</entry></row>
            <row><entry><code>f     </code></entry><entry><code>forward     </code></entry><entry>forward message</entry></row>
            <row><entry><code>b     </code></entry><entry><code>bounce      </code></entry><entry>bounce (remail) message</entry></row>
            <row><entry><code>ESC k  </code></entry><entry><code>mail-key    </code></entry><entry>mail a PGP public key to someone</entry></row>
          </tbody>
        </tgroup>
      </table>

      </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 <link linkend="forwarding-mail">
          forwarding-mail
        </link>
        .
      </para>
      
      <sect2>
        <title>Composing new messages  </title> <!--{{{-->
        
        <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>
          
          <screen>
To:</screen>
          
        </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 "<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>
        
        <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>
          
          <screen>
set editor = "vim +/^$/ -c ':set tw=72'"
set editor = "nano"
set editor = "emacs"</screen>
          
        </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 <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>
        
        <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>
        
        <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.
        </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
          <literal>&lt;esc&gt;f</literal>, but this shall only be used with
          caution.
        </para>
        
        <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>
        
        <para>
          
          <screen>
set edit_headers</screen>
          
        </para>
        
        <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>
        
        <para>

        <table>
          <title>Default Compose Menu Bindings</title>
          <tgroup cols="3" align="left" colsep="1" rowsep="1">
          <thead>
            <row>
              <entry>Key</entry>
              <entry>Function</entry>
              <entry>Description</entry>
            </row>
          </thead>
          <tbody>
            <row><entry><code>a    </code></entry><entry><code>attach-file  </code></entry><entry>attach a file</entry></row>
            <row><entry><code>A    </code></entry><entry><code>attach-message  </code></entry><entry>attach message(s) to the message</entry></row>
            <row><entry><code>ESC k  </code></entry><entry><code>attach-key       </code></entry><entry>attach a PGP public key</entry></row>
            <row><entry><code>d    </code></entry><entry><code>edit-description  </code></entry><entry>edit description on attachment</entry></row>
            <row><entry><code>D  </code></entry><entry><code>detach-file     </code></entry><entry>detach a file</entry></row>
            <row><entry><code>t </code></entry><entry><code>edit-to         </code></entry><entry>edit the To field</entry></row>
            <row><entry><code>ESC f </code></entry><entry><code>edit-from       </code></entry><entry>edit the From field</entry></row>
            <row><entry><code>r  </code></entry><entry><code>edit-reply-to   </code></entry><entry>edit the Reply-To field</entry></row>
            <row><entry><code>c </code></entry><entry><code>edit-cc         </code></entry><entry>edit the Cc field</entry></row>
            <row><entry><code>b      </code></entry><entry><code>edit-bcc        </code></entry><entry>edit the Bcc field</entry></row>
            <row><entry><code>y     </code></entry><entry><code>send-message    </code></entry><entry>send the message</entry></row>
            <row><entry><code>s    </code></entry><entry><code>edit-subject    </code></entry><entry>edit the Subject</entry></row>
            <row><entry><code>S   </code></entry><entry><code>smime-menu        </code></entry><entry>select S/MIME options</entry></row>
            <row><entry><code>f      </code></entry><entry><code>edit-fcc        </code></entry><entry>specify an ``Fcc'' mailbox</entry></row>
            <row><entry><code>p     </code></entry><entry><code>pgp-menu        </code></entry><entry>select PGP options</entry></row>
            <row><entry><code>P    </code></entry><entry><code>postpone-message </code></entry><entry>postpone this message until later</entry></row>
            <row><entry><code>q   </code></entry><entry><code>quit            </code></entry><entry>quit (abort) sending the message</entry></row>
            <row><entry><code>w  </code></entry><entry><code>write-fcc      </code></entry><entry>write the message to a folder</entry></row>
            <row><entry><code>i </code></entry><entry><code>ispell          </code></entry><entry>check spelling (if available on your system)</entry></row>
            <row><entry><code>^F  </code></entry><entry><code>forget-passphrase   </code></entry><entry>wipe passphrase(s) from memory</entry></row>
          </tbody>
        </tgroup>
      </table>

        </para>
        
        <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
          theywill be attached to the message you are sending. Note that
          certainoperations like composing a new mail, replying, forwarding,
          etc. are
          not permitted when you are in that folder. The &percnt;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>
        
        <!--}}}-->
      </sect2>
      
      <sect2>
        <title>Replying      </title> <!--{{{-->
        
        <sect3>
          <title>Simple Replies       </title> <!--{{{-->
          
          <para>
            When you want to reply to an email message, select it in the index
            menu and then press <literal>r</literal>. Mutt-ng's behaviour is
            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>
          
          <para>
            
            <screen>
On Mon, Mar 07, 2005 at 05:02:12PM +0100, Michael Svensson wrote:
&gt; Bill, can you please send last month's progress report to Mr. 
&gt; Morgan? We also urgently need the cost estimation for the new 
&gt; production server that we want to set up before our customer's 
&gt; project will go live.</screen>
            
          </para>
          
          <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:"</screen>
            
          </para>
          
          <para>
            It can also be set to something more compact, e.g.
            
            <screen>
set attribution = "attribution="* %n &lt;%a&gt; [%(%y-%m-%d %H:%M)]:"</screen>
            
          </para>
          
          <para>
            The example above results in the following attribution:
            
            <screen>
* Michael Svensson &lt;svensson@foobar.com&gt; [05-03-06 17:02]:
&gt; Bill, can you please send last month's progress report to Mr. 
&gt; Morgan? We also urgently need the cost estimation for the new 
&gt; production server that we want to set up before our customer's 
&gt; project will go live.</screen>
            
          </para>
          
          <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>
          
          <para>
            
          </para>
          
          <!--}}}-->
        </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
            functionalityensures 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>
            
          </para>
          
          <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>
          
          <para>
            
          </para>
          
          <para>
            
          </para>
          
          <!--}}}-->
        </sect3>
        
        <!--}}}-->
      </sect2>
      
      <sect2>
        <title>Editing the message header  </title>
        
        <para>
          When editing the header of your outgoing message, there are a couple
          of
          special features available.
        </para>
        
        <para>
          If you specify
          
          <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>  &lsqb; <emphasis>
            description
          </emphasis>
          &rsqb;
          
          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>
        
        <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>
        
        <para>
          Also see <link linkend="edit-headers">edit-headers</link>.
        </para>
        
        <para>
          
        </para>
        
      </sect2>
      
      <sect2>
        <title>Using Mutt-ng with PGP  </title>
        
        <para>
          If you want to use PGP, you can specify 
        </para>
        
        <para>
          <literal>Pgp:</literal> &lsqb; <literal>E</literal> &verbar; <literal>
            S
          </literal>
          &verbar; <literal>S</literal><emphasis>&lt;id&gt;</emphasis> &rsqb; 
          
        </para>
        
        <para>
          ``E'' encrypts, ``S'' signs and
          ``S&lt;id&gt;'' 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
          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.
        </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 <literal>&circ;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>
        
        <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 (&percnt;f) will expand to one of the following
          flags:


        <table>
          <title>PGP Key Menu Flags</title>
          <tgroup cols="2" align="left" colsep="1" rowsep="1">
          <thead>
            <row>
              <entry>Flag</entry>
              <entry>Description</entry>
            </row>
          </thead>
          <tbody>
            <row><entry><code>R      </code></entry><entry>The key has been revoked and can't be used.</entry></row>
            <row><entry><code>X     </code></entry><entry>The key is expired and can't be used.</entry></row>
            <row><entry><code>d     </code></entry><entry>You have marked the key as disabled.</entry></row>
            <row><entry><code>c     </code></entry><entry>There are unknown critical self-signature packets.</entry></row>
          </tbody>
        </tgroup>
      </table>

        </para>
        
        <para>
          The capabilities field (&percnt;c) expands to a two-character
          sequencerepresenting a key's capabilities.  The first character gives
          the key's encryption capabilities: A minus sign (<emphasis role="bold">
            -
          </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 <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 ``<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
          ``<emphasis role="bold">s</emphasis>'' denotes a key which can be
          used for signing.
        </para>
        
        <para>
          Finally, the validity field (&percnt;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>
      
      <sect2>
        <title>Sending anonymous messages via mixmaster  </title>
        
        <para>
          You may also have configured mutt to co-operate with Mixmaster, an
          anonymous remailer.  Mixmaster permits you to send your messages
          anonymously using a chain of remailers. Mixmaster support in mutt is
          for 
          mixmaster version 2.04 (beta 45 appears to be the latest) and 2.03. 
          It does not support earlier versions or the later so-called version 3
          betas, 
          of which the latest appears to be called 2.9b23.
        </para>
        
        <para>
          To use it, you'll have to obey certain restrictions.  Most
          important, you cannot use the <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>
        
        <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 <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
          <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 &percnt;c entry of the remailer menu lines (see
          <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>
    
    <sect1 id="forwarding-mail">
      <title>Forwarding and Bouncing Mail  </title>
      
      <para>
        Often, it is necessary to forward mails to other people.
        Therefore, mutt-ng supports forwarding messages in two different
        ways.
      </para>
      
      <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>
        
        <screen>
----- Forwarded message from Lucas User &#60;luser@example.com&#62; -----

From: Lucas User &#60;luser@example.com&#62;
Date: Thu, 02 Dec 2004 03:08:34 +0100
To: Michael Random &#60;mrandom@example.com&#62;
Subject: Re: blackmail

Pay me EUR 50,000.- cash or your favorite stuffed animal will die
a horrible death.

----- End forwarded message -----</screen>
        
      </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>
      
      <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 <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>
      
      <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>
    
    <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 <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 <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
        <emphasis>postponed</emphasis> menu will pop up and you can select
        which message you would
        like to resume.
      </para>
      
      <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>
      
      <para>
        See also the <link linkend="postpone">postpone</link> quad-option.
      </para>
      
      <para>
        
      </para>
      
      <para>
        
      </para>
      
    </sect1>
    
  </chapter>
  
  <chapter>
    <title>Configuration  </title>
    
    <sect1>
      <title>Locations of Configuration Files  </title>
      
      <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'' <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>
    
    <sect1 id="muttrc-syntax">
      <title>Basic Syntax of Initialization Files  </title>
      
      <para>
        An initialization file consists of a series of <link linkend="commands">
          commands
        </link>
        .Each line of the file may contain one or more commands.
        When multiple commands are used, they must be separated by a semicolon
        (;).
        
        <screen>
set realname='Mutt-ng user' ; ignore x-</screen>
        
        The hash mark, or pound sign
        (``&num;''), is used as a ``comment'' character. You can use it to
        annotate your initialization file. All text after the comment character
        to the end of the line is ignored. For example,
      </para>
      
      <para>
        
        <screen>
my_hdr X-Disclaimer: Why are you listening to me? &num; This is a comment</screen>
        
      </para>
      
      <para>
        Single quotes (') and double quotes (&quot;) 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
        &lsqb;see
        next paragraph&rsqb;), while double quotes indicate a string for which
        should be evaluated.  For example, backtics are evaluated inside of
        double
        quotes, but <emphasis role="bold">not</emphasis> for single quotes.
      </para>
      
      <para>
        &bsol; quotes the next character, just as in shells such as bash and
        zsh.
        For example, if want to put quotes ``&quot;'' inside of a string, you
        can use
        ``&bsol;'' to force the next character to be a literal instead of
        interpreted
        character.
        
        <screen>
set realname="Michael \"MuttDude\" Elkins"</screen>
        
      </para>
      
      <para>
        ``&bsol;&bsol;'' means to insert a literal ``&bsol;'' into the line.
        ``&bsol;n'' and ``&bsol;r'' have their usual C meanings of linefeed and
        carriage-return, respectively.
      </para>
      
      <para>
        A &bsol; 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
        ``&bsol;''
        at the end of a line also in comments. This allows you to disable a
        command
        split over multiple lines with only one ``&num;''.
      </para>
      
      <para>
        
        <screen>
# folder-hook . \
set realname="Michael \"MuttDude\" Elkins"</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 (&num;) 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:
      </para>
      
      <para>
        
        <screen>
line1\
line2a # line2b\
line3\
line4
line5</screen>
        
      </para>
      
      <para>
        line1 ``continues'' until line4. however, the part after the &num; 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 <link linkend="commands">commands</link>.
      </para>
      
      <para>
        
      </para>
      
    </sect1>
    
    <sect1>
      <title>Expansion within variables    </title>
      
      <para>
        Besides just assign static content to variables, there's plenty of
        ways of adding external and more or less dynamic content.
      </para>
      
      <sect2>
        <title>Commands' Output     </title>
        
        <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>
        
        <para>
          
          <screen>
my_hdr X-Operating-System: `uname -a`</screen>
          
        </para>
        
        <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>
        
      </sect2>
      
      <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
          ``&dollar;'' sign. For example,
        </para>
        
        <para>
          
          <screen>
set record=+sent_on_$HOSTNAME</screen>
          
        </para>
        
        <para>
          sets the <link linkend="record">record</link> variable to the
          string <emphasis>+sent&lowbar;on&lowbar;</emphasis> and appends the
          value of the evironment
          variable <literal>&dollar;HOSTNAME</literal>.
        </para>
        
        <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>
        
      </sect2>
      
      <sect2>
        <title>Configuration Variables     </title>
        
        <para>
          As for environment variables, the values of all configuration
          variables as string can be used in the same way, too. For example,
        </para>
        
        <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&lowbar;</literal> and can be
          used just like any ordinary configuration or environment
          variable.
        </para>
        
        <para>
          For example, to view the manual, users can either define two
          macros like the following
        </para>
        
        <para>
          
          <screen>
macro generic &lt;F1&gt; "!less -r /path/to/manual" "Show manual"
macro pager &lt;F1&gt; "!less -r /path/to/manual" "Show manual"</screen>
          
        </para>
        
        <para>
          for <literal>generic</literal>, <literal>pager</literal> and <literal>
            index
          </literal>
          .The alternative is to
          define a custom variable like so:
        </para>
        
        <para>
          
          <screen>
set user_manualcmd = "!less -r /path/to_manual" 
macro generic &lt;F1&gt; "$user_manualcmd&lt;enter&gt;" "Show manual"
macro pager &lt;F1&gt; "$user_manualcmd&lt;enter&gt;" "Show manual"
macro index &lt;F1&gt; "$user_manualcmd&lt;enter&gt;" "Show manual"</screen>
          
        </para>
        
        <para>
          to re-use the command sequence as in:
        </para>
        
        <para>
          
          <screen>
macro index &lt;F2&gt; "$user_manualcmd | grep '\^[ ]\\+~. '" "Show Patterns"</screen>
          
        </para>
        
        <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>
        
        <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>
        
        <para>
          The complete removal is done via the <literal>unset</literal>
          keyword.
        </para>
        
        <para>
          After the following sequence:
        </para>
        
        <para>
          
          <screen>
set user_foo = 42
set user_foo = 666</screen>
          
        </para>
        
        <para>
          the variable <literal>$user&lowbar;foo</literal> has a current value
          of 666 and an
          initial of 42. The query
        </para>
        
        <para>
          
          <screen>
set ?user_foo</screen>
          
        </para>
        
        <para>
          will show 666. After doing the reset via
        </para>
        
        <para>
          
          <screen>
reset user_foo</screen>
          
        </para>
        
        <para>
          a following query will give 42 as the result. After unsetting it
          via
        </para>
        
        <para>
          
          <screen>
unset user_foo</screen>
          
        </para>
        
        <para>
          any query or operation (except the noted expansion within other
          statements) will lead to an error message.
        </para>
        
      </sect2>
      
      <sect2>
        <title>Pre-Defined Variables     </title>
        
        <para>
          In order to allow users to share one setup over a number of
          different machines without having to change its contents, there's a
          number of pre-defined variables. These are prefixed with
          <literal>muttng&lowbar;</literal> and are read-only, i.e. they cannot
          be set, unset or
          reset. The reference chapter lists all available variables.
        </para>
        
        <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>
        
        <para>
          
          <screen>
muttng -Q muttng_docdir</screen>
          
        </para>
        
        <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'</screen>
          
        </para>
        
        <para>
          to:
        </para>
        
        <para>
          
          <screen>
set user_manualcmd = "!less -r $muttng_docdir/manual.txt"</screen>
          
        </para>
        
        <para>
          which works everywhere if a manual is installed.
        </para>
        
        <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>
        
        <para>
          For example, the statement
        </para>
        
        <para>
          
          <screen>
folder-hook . "set user_current_folder = $muttng_folder_name"</screen>
          
        </para>
        
        <para>
          will be already be translated to the following when reading the
          startup files:
        </para>
        
        <para>
          
          <screen>
folder-hook . "set user_current_folder = some_folder"</screen>
          
        </para>
        
        <para>
          with <literal>some&lowbar;folder</literal> being the name of the
          first folder muttng
          opens. On the contrary,
        </para>
        
        <para>
          
          <screen>
folder-hook . 'set user_current_folder = $muttng_folder_name'</screen>
          
        </para>
        
        <para>
          will be executed at runtime because of the single quotes so that
          <literal>user&lowbar;current&lowbar;folder</literal> will always have
          the value of the currently
          opened folder.
        </para>
        
        <para>
          A more practical example is:
        </para>
        
        <para>
          
          <screen>
folder-hook . 'source ~/.mutt/score-$muttng_folder_name'</screen>
          
        </para>
        
        <para>
          which can be used to source files containing score commands
          depending on the folder the user enters.
        </para>
        
      </sect2>
      
      <sect2>
        <title>Type Conversions     </title>
        
        <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>
        
        <para>
          
          <screen>
set read_inc = 100
set folder = $read_inc
set read_inc = $folder
set user_magic_number = 42
set folder = $user_magic_number</screen>
          
        </para>
        
      </sect2>
      
    </sect1>
    
    <sect1 id="alias">
      <title>Defining/Using aliases  </title>
      
      <para>
        Usage: <literal>alias</literal> <emphasis>key</emphasis> <emphasis>
          address
        </emphasis>
        &lsqb; , <emphasis>address</emphasis>, ... &rsqb;
      </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>
      
      <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> &lsqb; * &verbar; <emphasis>key</emphasis> <emphasis>
          ...
        </emphasis>
        &rsqb;
      </para>
      
      <para>
        
        <screen>
alias muttdude me@cs.hmc.edu (Michael Elkins)
alias theguys manny, moe, jack</screen>
        
      </para>
      
      <para>
        Unlike other mailers, Mutt-ng doesn't require aliases to be defined
        in a special file.  The <literal>alias</literal> command can appear
        anywhere in
        a configuration file, as long as this file is <link linkend="source">
          source
        </link>
        .Consequently, you can have multiple alias files, or
        you can have all aliases defined in your muttrc.
      </para>
      
      <para>
        On the other hand, the <link linkend="create-alias">create-alias</link>
        function can use only one file, the one pointed to by the <link linkend="alias-file">
          alias-file
        </link>
        variable (which is
        <literal>&tilde;/.muttrc</literal> by default). This file is not
        special either,
        in the sense that Mutt-ng will happily append aliases to any file, but
        in
        order for the new aliases to take effect you need to explicitly <link linkend="source">
          source
        </link>
        this file too.
      </para>
      
      <para>
        For example:
      </para>
      
      <para>
        
        <screen>
source /usr/local/share/Mutt-ng.aliases
source ~/.mail_aliases
set alias_file=~/.mail_aliases</screen>
        
      </para>
      
      <para>
        To use aliases, you merely use the alias at any place in mutt where
        muttprompts 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
        <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
        <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>
      
      <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>
      
      <para>
        <emphasis>map</emphasis> specifies in which menu the binding belongs. 
        Multiple maps may
        be specified by separating them with commas (no additional whitespace
        isallowed). The currently defined maps are:
      </para>
      
      <para>
        <anchor id="maps"/>
        <variablelist>
          
          <varlistentry>
            <term>generic</term>
            <listitem>
              <para>
                This is not a real menu, but is used as a fallback for all of
                the other
                menus except for the pager and editor modes.  If a key is not
                defined in
                another menu, Mutt-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.
              </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).
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>attach</term>
            <listitem>
              <para>
                The attachment menu is used to access the attachments on
                received messages.
              </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.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>editor</term>
            <listitem>
              <para>
                The editor is the line-based editor the user enters text data.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>index</term>
            <listitem>
              <para>
                The index is the list of messages contained in a mailbox.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>compose</term>
            <listitem>
              <para>
                The compose menu is the screen used when sending a new message.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>pager</term>
            <listitem>
              <para>
                The pager is the mode used to display message/attachment data,
                and help
                listings.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>pgp</term>
            <listitem>
              <para>
                The pgp menu is used to select the OpenPGP keys used for
                encrypting outgoing
                messages.
              </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.
              </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>&bsol;Cx</emphasis>,
        where <emphasis>x</emphasis> is the
        letter of the control character (for example, to specify control-A use
        ``&bsol;Ca'').  Note that the case of <emphasis>x</emphasis> as well as
        <emphasis>&bsol;C</emphasis> is
        ignored, so that <emphasis>&bsol;CA</emphasis>, <emphasis>&bsol;Ca</emphasis>, <emphasis>
          &bsol;cA
        </emphasis>
        and <emphasis>&bsol;ca</emphasis> are all
        equivalent.  An alternative form is to specify the key as a three digit
        octal number prefixed with a ``&bsol;'' (for example <emphasis>
          &bsol;177
        </emphasis>
        is
        equivalent to <emphasis>&bsol;c?</emphasis>).
      </para>
      
      <para>
        In addition, <emphasis>key</emphasis> may consist of:
      </para>
      
      <para>
        
        <table>
          <title>Alternative Key Names</title>
          <tgroup cols="2" align="left" colsep="1" rowsep="1">
          <thead>
            <row>
              <entry>Sequence</entry>
              <entry>Description</entry>
            </row>
          </thead>
          <tbody>
            <row><entry><code>\t     </code></entry><entry>tab</entry></row>
            <row><entry><code>&#60;tab&#62;      </code></entry><entry>tab</entry></row>
            <row><entry><code>&#60;backtab&#62;   </code></entry><entry>backtab / shift-tab</entry></row>
            <row><entry><code>\r    </code></entry><entry>carriage return</entry></row>
            <row><entry><code>\n     </code></entry><entry>newline</entry></row>
            <row><entry><code>\e      </code></entry><entry>escape</entry></row>
            <row><entry><code>&#60;esc&#62;   </code></entry><entry>escape</entry></row>
            <row><entry><code>&#60;up&#62;     </code></entry><entry>up arrow</entry></row>
            <row><entry><code>&#60;down&#62;     </code></entry><entry>down arrow</entry></row>
            <row><entry><code>&#60;left&#62;     </code></entry><entry>left arrow</entry></row>
            <row><entry><code>&#60;right&#62;    </code></entry><entry>right arrow</entry></row>
            <row><entry><code>&#60;pageup&#62;   </code></entry><entry>Page Up</entry></row>
            <row><entry><code>&#60;pagedown&#62;  </code></entry><entry>Page Down</entry></row>
            <row><entry><code>&#60;backspace&#62;  </code></entry><entry>Backspace</entry></row>
            <row><entry><code>&#60;delete&#62;    </code></entry><entry>Delete</entry></row>
            <row><entry><code>&#60;insert&#62;     </code></entry><entry>Insert</entry></row>
            <row><entry><code>&#60;enter&#62;    </code></entry><entry>Enter</entry></row>
            <row><entry><code>&#60;return&#62;   </code></entry><entry>Return</entry></row>
            <row><entry><code>&#60;home&#62;     </code></entry><entry>Home</entry></row>
            <row><entry><code>&#60;end&#62;      </code></entry><entry>End</entry></row>
            <row><entry><code>&#60;space&#62;    </code></entry><entry>Space bar</entry></row>
            <row><entry><code>&#60;f1&#62;       </code></entry><entry>function key 1</entry></row>
            <row><entry><code>&#60;f10&#62;       </code></entry><entry>function key 10</entry></row>
          </tbody>
        </tgroup>
      </table>
        
      </para>
      
      <para>
        <emphasis>key</emphasis> does not need to be enclosed in quotes unless
        it contains a
        space (`` '').
      </para>
      
      <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>
      
      <para>
        Usage: <literal>charset-hook</literal> <emphasis>alias</emphasis> <emphasis>
          charset
        </emphasis>
        
        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>
      
      <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>
    
    <sect1 id="folder-hook">
      <title>Setting variables based upon mailbox  </title>
      
      <para>
        Usage: <literal>folder-hook</literal> &lsqb;!&rsqb;<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.  <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>
      
      <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 <emphasis>not</emphasis> operator for the expression.
      </para>
      
      <para>
        Note that the settings are <emphasis>not</emphasis> restored when you
        leave the mailbox.
        For example, a command action to perform is to change the sorting
        methodbased upon the mailbox being read:
      </para>
      
      <para>
        
        <screen>
folder-hook mutt set sort=threads</screen>
        
      </para>
      
      <para>
        However, the sorting method is not restored to its previous value when
        reading a different mailbox.  To specify a <emphasis>default</emphasis>
        command, use the
        pattern ``.'':
      </para>
      
      <para>
        
        <screen>
folder-hook . set sort=date-sent</screen>
        
      </para>
      
      <para>
        
      </para>
      
    </sect1>
    
    <sect1 id="macro">
      <title>Keyboard macros  </title>
      
      <para>
        Usage: <literal>macro</literal> <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>
          sequence
        </emphasis>
        &lsqb; <emphasis>description</emphasis> &rsqb;
      </para>
      
      <para>
        Macros are useful when you would like a single key to perform a series
        of
        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
        singlekey.
      </para>
      
      <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
        thecommas separating them.
      </para>
      
      <para>
        <emphasis>key</emphasis> and <emphasis>sequence</emphasis> are expanded
        by the same rules as the <link linkend="bind">bind</link>.  There are
        some additions however.  The
        first is that control characters in <emphasis>sequence</emphasis> can
        also be specified
        as <emphasis>&circ;x</emphasis>.  In order to get a caret (`&circ;'')
        you need to use
        <emphasis>&circ;&circ;</emphasis>.  Secondly, to specify a certain key
        such as <emphasis>up</emphasis>
        or to invoke a function directly, you can use the format
        <emphasis>&lt;key name&gt;</emphasis> and <emphasis>&lt;function
          name&gt;
        </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
        willwork regardless of the current key bindings, so they are not
        dependent on
        the user having particular key definitions.  This makes them more
        robustand portable, and also facilitates defining of macros in files
        used by more
        than one user (eg. the system Muttngrc).
      </para>
      
      <para>
        Optionally you can specify a descriptive text after <emphasis>sequence</emphasis>,
        which is shown in the help screens.
      </para>
      
      <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> &lsqb; <emphasis>regexp</emphasis>
        &rsqb;
        
        Usage: <literal>color</literal> index <emphasis>foreground</emphasis> <emphasis>
          background
        </emphasis>
        <emphasis>pattern</emphasis>
        
        Usage: <literal>uncolor</literal> index <emphasis>pattern</emphasis>
        &lsqb; <emphasis>pattern</emphasis> ...  &rsqb;
        
      </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 <emphasis role="bold">and</emphasis> a background color (it is not
        possible to only specify one or the other).
      </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 ``&tilde;'' 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>
        
        <screen>
set COLORFGBG="green;black"
export COLORFGBG</screen>
        
      </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>
      
      <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>
      
      <para>
        Mutt-ng also recognizes the keywords <emphasis>color0</emphasis>, <emphasis>
          color1
        </emphasis>
        ,&hellip;,
        <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 <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>&lt;object&gt;
          &lt;attribute&gt;
        </emphasis>
        &lsqb; <emphasis>regexp</emphasis> &rsqb;
        
        Usage: <literal>mono</literal> index <emphasis>attribute</emphasis> <emphasis>
          pattern
        </emphasis>
        
        Usage: <literal>unmono</literal> index <emphasis>pattern</emphasis>
        &lsqb; <emphasis>pattern</emphasis> ...  &rsqb;
        
      </para>
      
      <para>
        where <emphasis>attribute</emphasis> is one of the following:
      </para>
      
      <para>
        
        <itemizedlist>
          <listitem>
            
            <para>
              none
            </para>
          </listitem>
          <listitem>
            
            <para>
              bold
            </para>
          </listitem>
          <listitem>
            
            <para>
              underline
            </para>
          </listitem>
          <listitem>
            
            <para>
              reverse
            </para>
          </listitem>
          <listitem>
            
            <para>
              standout
            </para>
          </listitem>
          
        </itemizedlist>
        
      </para>
      
      <para>
        
      </para>
      
    </sect1>
    
    <sect1 id="ignore">
      <title>Ignoring (weeding) unwanted message headers  </title>
      
      <para>
        Usage: <literal>&lsqb;un&rsqb;ignore</literal> <emphasis>pattern</emphasis> &lsqb; <emphasis>
          pattern
        </emphasis>
        ... &rsqb;
      </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:
        
        <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:</screen>
        
      </para>
      
      <para>
        
      </para>
      
    </sect1>
    
    <sect1 id="alternates">
      <title>Alternative addresses  </title>
      
      <para>
        Usage: <literal>&lsqb;un&rsqb;alternates</literal> <emphasis>regexp</emphasis> &lsqb; <emphasis>
          regexp
        </emphasis>
        ... &rsqb;
        
      </para>
      
      <para>
        With various functions, mutt will treat messages differently,
        depending on whether you sent them or whether you received them from
        someone else.  For instance, when replying to a message that you
        sent to a different party, mutt will automatically suggest to send
        the response to the original message's recipients -- responding to
        yourself won't make much sense in many cases.  (See <link linkend="reply-to">
          reply-to
        </link>
        .)
      </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 <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>
      
      <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">&#60;http://www.joeclark.org/ffaq.html&#62;</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>
          
        </para>
        
        <para>
          The code above makes the line break 10 columns before the right
          side of the terminal.
        </para>
        
        <para>