-<?xml version="1.0" encoding="utf-8" ?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-
-<book>
+<?xml version="1.0" encoding="utf-8"?>
+<!-- THIS FILE IST NOT VALID DOCBOOK ! DTD REMOVED -->
+<!-- Please don't use html entities like [, ] ^ -->
+<!-- etc. they don't work with xml! -->
+<book xmlns:muttng-doc="http://mutt-ng.berlios.de/doc/#NS">
<bookinfo> <!--{{{-->
<title>The Mutt Next Generation E-Mail Client</title>
</para>
</sect1>
-
+
+ <sect1 id="conventions">
+ <title>Manual Conventions</title>
+
+ <para>
+ This manual contains several (hopefully consistent) conventions to
+ specially layout different items in different fashions.
+ </para>
+
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>Configuration and environment variables will be printed
+ in a typewriter font and both prefixed with a dollar sign as
+ it's common for UNIX-like environments. Configuration
+ variables are lower-case only while environment variables
+ are upper-case only.</para>
+ </listitem>
+ <listitem>
+ <para>Muttng-specific commands are enclosed in
+ <literal><></literal> and printed in a typewriter font,
+ too.</para>
+ </listitem>
+ <listitem>
+ <para>As common for UNIX-like environments, references to
+ manual pages are printed with the section enclosed in
+ braces, as in <muttng-doc:man name="vi"/> or <muttng-doc:man
+ name="muttngrc" sect="5"/>. Execute <literal>man [section]
+ [name]</literal> to view the manual page.</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ If, while reading this fine manual, you find any inconsistencies
+ of whatever kind, please contact the developers via
+ <email>mutt-ng-devel@lists.berlios.de</email> to report it.
+ </para>
+
+ </sect1>
+
</chapter>
<!--}}}-->
<tbody>
<row>
<entry><literal>j</literal> or <literal>Down</literal></entry>
- <entry><literal>next-entry</literal></entry>
+ <entry><muttng-doc:funcref name="next-entry"/></entry>
<entry>move to the next entry</entry>
</row>
<row>
<entry><literal>k</literal> or <literal>Up</literal></entry>
- <entry><literal>previous-entry</literal></entry>
+ <entry><muttng-doc:funcref name="previous-entry"/></entry>
<entry>move to the previous entry</entry>
</row>
<row>
<entry><literal>z</literal> or <literal>PageDn</literal></entry>
- <entry><literal>page-down</literal></entry>
+ <entry><muttng-doc:funcref name="page-down"/></entry>
<entry>go to the next page</entry>
</row>
<row>
<entry><literal>Z</literal> or <literal>PageUp</literal></entry>
- <entry><literal>page-up</literal></entry>
+ <entry><muttng-doc:funcref name="page-up"/></entry>
<entry>go to the previous page</entry>
</row>
<row>
<entry><literal>=</literal> or <literal>Home</literal></entry>
- <entry><literal>first-entry</literal></entry>
+ <entry><muttng-doc:funcref name="first-entry"/></entry>
<entry>jump to the first entry</entry>
</row>
<row>
<entry><literal>*</literal> or <literal>End</literal></entry>
- <entry><literal>last-entry</literal></entry>
+ <entry><muttng-doc:funcref name="last-entry"/></entry>
<entry>jump to the last entry</entry>
</row>
<row>
<entry><literal>q</literal></entry>
- <entry><literal>quit</literal></entry>
+ <entry><muttng-doc:funcref name="quit"/></entry>
<entry>exit the current menu</entry>
</row>
<row>
<entry><literal>?</literal></entry>
- <entry><literal>help</literal></entry>
+ <entry><muttng-doc:funcref name="help"/></entry>
<entry>list all key bindings for the current menu</entry>
</row>
</tbody>
<tbody>
<row>
<entry><literal>^A or <Home> </literal></entry>
- <entry><literal>bol </literal></entry>
+ <entry><muttng-doc:funcref name="bol"/></entry>
<entry>move to the start of the line</entry>
</row>
<row>
<entry><literal>^B or <Left> </literal></entry>
- <entry><literal>backward-char </literal>
+ <entry><muttng-doc:funcref name="backward-char"/>
</entry><entry>move back one char</entry>
</row>
<row>
<entry><literal>Esc B </literal></entry>
- <entry><literal>backward-word </literal></entry>
+ <entry><muttng-doc:funcref name="backward-word"/></entry>
<entry>move back one word</entry>
</row>
<row>
<entry><literal>^D or <Delete> </literal></entry>
- <entry><literal>delete-char </literal></entry>
+ <entry><muttng-doc:funcref name="delete-char"/></entry>
<entry>delete the char under the cursor</entry>
</row>
<row>
<entry><literal>^E or <End> </literal></entry>
- <entry><literal>eol </literal></entry>
+ <entry><muttng-doc:funcref name="eol"/></entry>
<entry>move to the end of the line</entry>
</row>
<row>
<entry><literal>^F or <Right> </literal></entry>
- <entry><literal>forward-char </literal></entry>
+ <entry><muttng-doc:funcref name="forward-char"/></entry>
<entry>move forward one char</entry>
</row>
<row>
<entry><literal>Esc F </literal></entry>
- <entry><literal>forward-word </literal></entry>
+ <entry><muttng-doc:funcref name="forward-word"/></entry>
<entry>move forward one word</entry>
</row>
<row>
- <entry><literal><Tab> </literal></entry>
- <entry><literal>complete </literal></entry>
+ <entry><literal><Tab></literal></entry>
+ <entry><muttng-doc:funcref name="complete"/></entry>
<entry>complete filename or alias</entry>
</row>
<row>
- <entry><literal>^T </literal></entry>
- <entry><literal>complete-query </literal></entry>
+ <entry><literal>^T</literal></entry>
+ <entry><muttng-doc:funcref name="complete-query"/></entry>
<entry>complete address with query</entry>
</row>
<row>
- <entry><literal>^K </literal></entry>
- <entry><literal>kill-eol </literal></entry>
+ <entry><literal>^K</literal></entry>
+ <entry><muttng-doc:funcref name="kill-eol"/></entry>
<entry>delete to the end of the line</entry>
</row>
<row>
<entry><literal>ESC d </literal></entry>
- <entry><literal>kill-eow </literal></entry>
+ <entry><muttng-doc:funcref name="kill-eow"/></entry>
<entry>delete to the end of the word</entry>
</row>
<row>
- <entry><literal>^W </literal></entry>
- <entry><literal>kill-word </literal></entry>
+ <entry><literal>^W</literal></entry>
+ <entry><muttng-doc:funcref name="kill-word"/></entry>
<entry>kill the word in front of the cursor</entry>
</row>
<row>
- <entry><literal>^U </literal></entry>
- <entry><literal>kill-line </literal></entry>
+ <entry><literal>^U</literal></entry>
+ <entry><muttng-doc:funcref name="kill-line"/></entry>
<entry>delete entire line</entry>
</row>
<row>
- <entry><literal>^V </literal></entry>
- <entry><literal>quote-char </literal></entry>
+ <entry><literal>^V</literal></entry>
+ <entry><muttng-doc:funcref name="quote-char"/></entry>
<entry>quote the next typed key</entry>
</row>
<row>
- <entry><literal><Up> </literal></entry>
- <entry><literal>history-up </literal></entry>
+ <entry><literal><Up></literal></entry>
+ <entry><muttng-doc:funcref name="history-up"/></entry>
<entry>recall previous string from history</entry>
</row>
<row>
- <entry><literal><Down> </literal></entry>
- <entry><literal>history-down </literal></entry>
+ <entry><literal><Down></literal></entry>
+ <entry><muttng-doc:funcref name="history-down"/></entry>
<entry>recall next string from history</entry>
</row>
<row>
- <entry><literal><BackSpace> </literal></entry>
- <entry><literal>backspace </literal></entry>
+ <entry><literal><BackSpace></literal></entry>
+ <entry><muttng-doc:funcref name="backspace"/></entry>
<entry>kill the char in front of the cursor</entry>
</row>
<row>
<entry><literal>Esc u </literal></entry>
- <entry><literal>upcase-word </literal></entry>
+ <entry><muttng-doc:funcref name="upcase-word"/></entry>
<entry>convert word to upper case</entry>
</row>
<row>
<entry><literal>Esc l </literal></entry>
- <entry><literal>downcase-word </literal></entry>
+ <entry><muttng-doc:funcref name="downcase-word"/></entry>
<entry>convert word to lower case</entry>
</row>
<row>
<entry><literal>Esc c </literal></entry>
- <entry><literal>capitalize-word </literal></entry>
+ <entry><muttng-doc:funcref name="capitalize-word"/></entry>
<entry>capitalize the word</entry>
</row>
<row>
- <entry><literal>^G </literal></entry>
- <entry><literal>n/a </literal></entry>
+ <entry><literal>^G</literal></entry>
+ <entry><literal>n/a</literal></entry>
<entry>abort</entry>
</row>
<row>
- <entry><literal><Return> </literal></entry>
- <entry><literal>n/a </literal></entry>
+ <entry><literal><Return></literal></entry>
+ <entry><literal>n/a</literal></entry>
<entry>finish editing</entry>
</row>
</tbody>
</para>
<para>
- You can remap the <emphasis>editor</emphasis> functions using the <link linkend="bind">
- bind
- </link>
- command. For example, to make the <emphasis>Delete</emphasis> key
- delete the character in
- front of the cursor rather than under, you could use
+ You can remap the <emphasis>editor</emphasis> functions using the
+ <muttng-doc:command name="bind"/> command. For example, to make
+ the <emphasis>Delete</emphasis> key delete the character in front
+ of the cursor rather than under, you could use
</para>
<para>
</row>
</thead>
<tbody>
- <row><entry><literal>c </literal></entry><entry><literal></literal></entry><entry>change to a different mailbox</entry></row>
- <row><entry><literal>ESC c </literal></entry><entry><literal></literal></entry><entry>change to a folder in read-only mode</entry></row>
- <row><entry><literal>C </literal></entry><entry><literal></literal></entry><entry>copy the current message to another mailbox</entry></row>
- <row><entry><literal>ESC C </literal></entry><entry><literal></literal></entry><entry>decode a message and copy it to a folder</entry></row>
- <row><entry><literal>ESC s </literal></entry><entry><literal></literal></entry><entry>decode a message and save it to a folder</entry></row>
- <row><entry><literal>D </literal></entry><entry><literal></literal></entry><entry>delete messages matching a pattern</entry></row>
- <row><entry><literal>d </literal></entry><entry><literal></literal></entry><entry>delete the current message</entry></row>
- <row><entry><literal>F </literal></entry><entry><literal></literal></entry><entry>mark as important</entry></row>
- <row><entry><literal>l </literal></entry><entry><literal></literal></entry><entry>show messages matching a pattern</entry></row>
- <row><entry><literal>N </literal></entry><entry><literal></literal></entry><entry>mark message as new</entry></row>
- <row><entry><literal>o </literal></entry><entry><literal></literal></entry><entry>change the current sort method</entry></row>
- <row><entry><literal>O </literal></entry><entry><literal></literal></entry><entry>reverse sort the mailbox</entry></row>
- <row><entry><literal>q </literal></entry><entry><literal></literal></entry><entry>save changes and exit</entry></row>
- <row><entry><literal>s </literal></entry><entry><literal></literal></entry><entry>save-message</entry></row>
- <row><entry><literal>T </literal></entry><entry><literal></literal></entry><entry>tag messages matching a pattern</entry></row>
- <row><entry><literal>t </literal></entry><entry><literal></literal></entry><entry>toggle the tag on a message</entry></row>
- <row><entry><literal>ESC t </literal></entry><entry><literal></literal></entry><entry>toggle tag on entire message thread</entry></row>
- <row><entry><literal>U </literal></entry><entry><literal></literal></entry><entry>undelete messages matching a pattern</entry></row>
- <row><entry><literal>u </literal></entry><entry><literal></literal></entry><entry>undelete-message</entry></row>
- <row><entry><literal>v </literal></entry><entry><literal></literal></entry><entry>view-attachments</entry></row>
- <row><entry><literal>x </literal></entry><entry><literal></literal></entry><entry>abort changes and exit</entry></row>
- <row><entry><literal><Return> </literal></entry><entry><literal></literal></entry><entry>display-message</entry></row>
- <row><entry><literal><Tab> </literal></entry><entry><literal></literal></entry><entry>jump to the next new or unread message</entry></row>
- <row><entry><literal>@ </literal></entry><entry><literal></literal></entry><entry>show the author's full e-mail address</entry></row>
- <row><entry><literal>$ </literal></entry><entry><literal></literal></entry><entry>save changes to mailbox</entry></row>
- <row><entry><literal>/ </literal></entry><entry><literal></literal></entry><entry>search</entry></row>
- <row><entry><literal>ESC / </literal></entry><entry><literal></literal></entry><entry>search-reverse</entry></row>
- <row><entry><literal>^L </literal></entry><entry><literal></literal></entry><entry>clear and redraw the screen</entry></row>
- <row><entry><literal>^T </literal></entry><entry><literal></literal></entry><entry>untag messages matching a pattern</entry></row>
+ <row>
+ <entry><literal>c</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>change to a different mailbox</entry>
+ </row>
+ <row>
+ <entry><literal>ESC c </literal></entry>
+ <entry><literal></literal></entry>
+ <entry>change to a folder in read-only mode</entry>
+ </row>
+ <row>
+ <entry><literal>C</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>copy the current message to another mailbox</entry>
+ </row>
+ <row>
+ <entry><literal>ESC C </literal></entry>
+ <entry><literal></literal></entry>
+ <entry>decode a message and copy it to a folder</entry>
+ </row>
+ <row>
+ <entry><literal>ESC s </literal></entry>
+ <entry><literal></literal></entry>
+ <entry>decode a message and save it to a folder</entry>
+ </row>
+ <row>
+ <entry><literal>D</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>delete messages matching a pattern</entry>
+ </row>
+ <row>
+ <entry><literal>d</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>delete the current message</entry>
+ </row>
+ <row>
+ <entry><literal>F</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>mark as important</entry>
+ </row>
+ <row>
+ <entry><literal>l</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>show messages matching a pattern</entry>
+ </row>
+ <row>
+ <entry><literal>N</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>mark message as new</entry>
+ </row>
+ <row>
+ <entry><literal>o</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>change the current sort method</entry>
+ </row>
+ <row>
+ <entry><literal>O</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>reverse sort the mailbox</entry>
+ </row>
+ <row>
+ <entry><literal>q</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>save changes and exit</entry>
+ </row>
+ <row>
+ <entry><literal>s</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>save-message</entry>
+ </row>
+ <row>
+ <entry><literal>T</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>tag messages matching a pattern</entry>
+ </row>
+ <row>
+ <entry><literal>t</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>toggle the tag on a message</entry>
+ </row>
+ <row>
+ <entry><literal>ESC t </literal></entry>
+ <entry><literal></literal></entry>
+ <entry>toggle tag on entire message thread</entry>
+ </row>
+ <row>
+ <entry><literal>U</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>undelete messages matching a pattern</entry>
+ </row>
+ <row>
+ <entry><literal>u</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>undelete-message</entry>
+ </row>
+ <row>
+ <entry><literal>v</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>view-attachments</entry>
+ </row>
+ <row>
+ <entry><literal>x</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>abort changes and exit</entry>
+ </row>
+ <row>
+ <entry><literal><Return></literal></entry>
+ <entry><literal></literal></entry>
+ <entry>display-message</entry>
+ </row>
+ <row>
+ <entry><literal><Tab></literal></entry>
+ <entry><literal></literal></entry>
+ <entry>jump to the next new or unread message</entry>
+ </row>
+ <row>
+ <entry><literal>@</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>show the author's full e-mail address</entry>
+ </row>
+ <row>
+ <entry><literal>$</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>save changes to mailbox</entry>
+ </row>
+ <row>
+ <entry><literal>/</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>search</entry>
+ </row>
+ <row>
+ <entry><literal>ESC / </literal></entry>
+ <entry><literal></literal></entry>
+ <entry>search-reverse</entry>
+ </row>
+ <row>
+ <entry><literal>^L</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>clear and redraw the screen</entry>
+ </row>
+ <row>
+ <entry><literal>^T</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>untag messages matching a pattern</entry>
+ </row>
</tbody>
</tgroup>
</table>
Furthermore, the following flags reflect who the message is
addressed
to. They can be customized with the
- <link linkend="to-chars">$to_chars</link> variable.
+ <muttng-doc:varref name="to_chars" link="to-chars"/> variable.
</para>
<para>
</row>
</thead>
<tbody>
- <row><entry><literal><Return> </literal></entry><entry><literal></literal></entry><entry>go down one line</entry></row>
- <row><entry><literal><Space> </literal></entry><entry><literal></literal></entry><entry>display the next page (or next message if at the end of a message)</entry></row>
- <row><entry><literal>- </literal></entry><entry><literal></literal></entry><entry>go back to the previous page</entry></row>
- <row><entry><literal>n </literal></entry><entry><literal></literal></entry><entry>search for next match</entry></row>
- <row><entry><literal>S </literal></entry><entry><literal></literal></entry><entry>skip beyond quoted text</entry></row>
- <row><entry><literal>T </literal></entry><entry><literal></literal></entry><entry>toggle display of quoted text</entry></row>
- <row><entry><literal>? </literal></entry><entry><literal></literal></entry><entry>show key bindings</entry></row>
- <row><entry><literal>/ </literal></entry><entry><literal></literal></entry><entry>search for a regular expression (pattern)</entry></row>
- <row><entry><literal>ESC / </literal></entry><entry><literal></literal></entry><entry>search backwards for a regular expression</entry></row>
- <row><entry><literal>\ </literal></entry><entry><literal></literal></entry><entry>toggle search pattern coloring</entry></row>
- <row><entry><literal>^ </literal></entry><entry><literal></literal></entry><entry>jump to the top of the message</entry></row>
+ <row>
+ <entry><literal><Return></literal></entry>
+ <entry><literal></literal></entry>
+ <entry>go down one line</entry>
+ </row>
+ <row>
+ <entry><literal><Space></literal></entry>
+ <entry><literal></literal></entry>
+ <entry>display the next page (or next message if at the end of a message)</entry>
+ </row>
+ <row>
+ <entry><literal>-</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>go back to the previous page</entry>
+ </row>
+ <row>
+ <entry><literal>n</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>search for next match</entry>
+ </row>
+ <row>
+ <entry><literal>S</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>skip beyond quoted text</entry>
+ </row>
+ <row>
+ <entry><literal>T</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>toggle display of quoted text</entry>
+ </row>
+ <row>
+ <entry><literal>?</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>show key bindings</entry>
+ </row>
+ <row>
+ <entry><literal>/</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>search for a regular expression (pattern)</entry>
+ </row>
+ <row>
+ <entry><literal>ESC / </literal></entry>
+ <entry><literal></literal></entry>
+ <entry>search backwards for a regular expression</entry>
+ </row>
+ <row>
+ <entry><literal>\</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>toggle search pattern coloring</entry>
+ </row>
+ <row>
+ <entry><literal>^</literal></entry>
+ <entry><literal></literal></entry>
+ <entry>jump to the top of the message</entry>
+ </row>
</tbody>
</tgroup>
</table>
one, it will accept and translate the ``standard'' nroff sequences
forbold and underline. These sequences are a series of either the
letter,
- backspace (ˆH), the letter again for bold or the letter,
+ backspace (^H), the letter again for bold or the letter,
backspace,
- ``_'' for denoting underline. Mutt-ng will attempt to display
+ ``_'' 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>
+ not, you can use the bold and underline <muttng-doc:command name="color"/>
objects to specify a color or mono attribute for them.
</para>
</row>
</thead>
<tbody>
- <row><entry><literal>0 </literal></entry><entry>All Attributes Off</entry></row>
- <row><entry><literal>1 </literal></entry><entry>Bold on</entry></row>
- <row><entry><literal>4 </literal></entry><entry>Underline on</entry></row>
- <row><entry><literal>5 </literal></entry><entry>Blink on</entry></row>
- <row><entry><literal>7 </literal></entry><entry>Reverse video on</entry></row>
- <row><entry><literal>3x </literal></entry><entry>Foreground color is x (see table below)</entry></row>
- <row><entry><literal>4x </literal></entry><entry>Background color is x (see table below)</entry></row>
+ <row>
+ <entry><literal>0</literal></entry>
+ <entry>All Attributes Off</entry>
+ </row>
+ <row>
+ <entry><literal>1</literal></entry>
+ <entry>Bold on</entry>
+ </row>
+ <row>
+ <entry><literal>4</literal></entry>
+ <entry>Underline on</entry>
+ </row>
+ <row>
+ <entry><literal>5</literal></entry>
+ <entry>Blink on</entry>
+ </row>
+ <row>
+ <entry><literal>7</literal></entry>
+ <entry>Reverse video on</entry>
+ </row>
+ <row>
+ <entry><literal>3x</literal></entry>
+ <entry>Foreground color is x (see table below)</entry>
+ </row>
+ <row>
+ <entry><literal>4x</literal></entry>
+ <entry>Background color is x (see table below)</entry>
+ </row>
</tbody>
</tgroup>
</table>
</row>
</thead>
<tbody>
- <row><entry><literal>0 </literal></entry><entry>black</entry></row>
- <row><entry><literal>1 </literal></entry><entry>red</entry></row>
- <row><entry><literal>2 </literal></entry><entry>green</entry></row>
- <row><entry><literal>3 </literal></entry><entry>yellow</entry></row>
- <row><entry><literal>4 </literal></entry><entry>blue</entry></row>
- <row><entry><literal>5 </literal></entry><entry>magenta</entry></row>
- <row><entry><literal>6 </literal></entry><entry>cyan</entry></row>
- <row><entry><literal>7 </literal></entry><entry>white</entry></row>
+ <row>
+ <entry><literal>0</literal></entry>
+ <entry>black</entry>
+ </row>
+ <row>
+ <entry><literal>1</literal></entry>
+ <entry>red</entry>
+ </row>
+ <row>
+ <entry><literal>2</literal></entry>
+ <entry>green</entry>
+ </row>
+ <row>
+ <entry><literal>3</literal></entry>
+ <entry>yellow</entry>
+ </row>
+ <row>
+ <entry><literal>4</literal></entry>
+ <entry>blue</entry>
+ </row>
+ <row>
+ <entry><literal>5</literal></entry>
+ <entry>magenta</entry>
+ </row>
+ <row>
+ <entry><literal>6</literal></entry>
+ <entry>cyan</entry>
+ </row>
+ <row>
+ <entry><literal>7</literal></entry>
+ <entry>white</entry>
+ </row>
</tbody>
</tgroup>
</table>
<para>
Mutt-ng uses these attributes for handling text/enriched messages,
and they
- can also be used by an external <link
- linkend="auto-view">autoview</link>
+ can also be used by an external <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.
</row>
</thead>
<tbody>
- <row><entry><literal>^D </literal></entry><entry><literal>delete-thread </literal></entry><entry>delete all messages in the current thread</entry></row>
- <row><entry><literal>^U </literal></entry><entry><literal>undelete-thread </literal></entry><entry>undelete all messages in the current thread</entry></row>
- <row><entry><literal>^N </literal></entry><entry><literal>next-thread </literal></entry><entry>jump to the start of the next thread</entry></row>
- <row><entry><literal>^P </literal></entry><entry><literal>previous-thread </literal></entry><entry>jump to the start of the previous thread</entry></row>
- <row><entry><literal>^R </literal></entry><entry><literal>read-thread </literal></entry><entry>mark the current thread as read</entry></row>
- <row><entry><literal>ESC d </literal></entry><entry><literal>delete-subthread </literal></entry><entry>delete all messages in the current subthread</entry></row>
- <row><entry><literal>ESC u </literal></entry><entry><literal>undelete-subthread </literal></entry><entry>undelete all messages in the current subthread</entry></row>
- <row><entry><literal>ESC n </literal></entry><entry><literal>next-subthread </literal></entry><entry>jump to the start of the next subthread</entry></row>
- <row><entry><literal>ESC p </literal></entry><entry><literal>previous-subthread </literal></entry><entry>jump to the start of the previous subthread</entry></row>
- <row><entry><literal>ESC r </literal></entry><entry><literal>read-subthread </literal></entry><entry>mark the current subthread as read </entry></row>
- <row><entry><literal>ESC t </literal></entry><entry><literal>tag-thread </literal></entry><entry>toggle the tag on the current thread</entry></row>
- <row><entry><literal>ESC v </literal></entry><entry><literal>collapse-thread </literal></entry><entry>toggle collapse for the current thread</entry></row>
- <row><entry><literal>ESC V </literal></entry><entry><literal>collapse-all </literal></entry><entry>toggle collapse for all threads</entry></row>
- <row><entry><literal>P </literal></entry><entry><literal>parent-message </literal></entry><entry>jump to parent message in thread</entry></row>
+ <row>
+ <entry><literal>^D</literal></entry>
+ <entry><muttng-doc:funcref name="delete-thread"/></entry>
+ <entry>delete all messages in the current thread</entry>
+ </row>
+ <row>
+ <entry><literal>^U</literal></entry>
+ <entry><muttng-doc:funcref name="undelete-thread"/></entry>
+ <entry>undelete all messages in the current thread</entry>
+ </row>
+ <row>
+ <entry><literal>^N</literal></entry>
+ <entry><muttng-doc:funcref name="next-thread"/></entry>
+ <entry>jump to the start of the next thread</entry>
+ </row>
+ <row>
+ <entry><literal>^P</literal></entry>
+ <entry><muttng-doc:funcref name="previous-thread"/></entry>
+ <entry>jump to the start of the previous thread</entry>
+ </row>
+ <row>
+ <entry><literal>^R</literal></entry>
+ <entry><muttng-doc:funcref name="read-thread"/></entry>
+ <entry>mark the current thread as read</entry>
+ </row>
+ <row>
+ <entry><literal>ESC d </literal></entry>
+ <entry><muttng-doc:funcref name="delete-subthread"/></entry>
+ <entry>delete all messages in the current subthread</entry>
+ </row>
+ <row>
+ <entry><literal>ESC u </literal></entry>
+ <entry><muttng-doc:funcref name="undelete-subthread"/></entry>
+ <entry>undelete all messages in the current subthread</entry>
+ </row>
+ <row>
+ <entry><literal>ESC n </literal></entry>
+ <entry><muttng-doc:funcref name="next-subthread"/></entry>
+ <entry>jump to the start of the next subthread</entry>
+ </row>
+ <row>
+ <entry><literal>ESC p </literal></entry>
+ <entry><muttng-doc:funcref name="previous-subthread"/></entry>
+ <entry>jump to the start of the previous subthread</entry>
+ </row>
+ <row>
+ <entry><literal>ESC r </literal></entry>
+ <entry><muttng-doc:funcref name="read-subthread"/></entry>
+ <entry>mark the current subthread as read </entry>
+ </row>
+ <row>
+ <entry><literal>ESC t </literal></entry>
+ <entry><muttng-doc:funcref name="tag-thread"/></entry>
+ <entry>toggle the tag on the current thread</entry>
+ </row>
+ <row>
+ <entry><literal>ESC v </literal></entry>
+ <entry><muttng-doc:funcref name="collapse-thread"/></entry>
+ <entry>toggle collapse for the current thread</entry>
+ </row>
+ <row>
+ <entry><literal>ESC V </literal></entry>
+ <entry><muttng-doc:funcref name="collapse-all"/></entry>
+ <entry>toggle collapse for all threads</entry>
+ </row>
+ <row>
+ <entry><literal>P</literal></entry>
+ <entry><muttng-doc:funcref name="parent-message"/></entry>
+ <entry>jump to parent message in thread</entry>
+ </row>
</tbody>
</tgroup>
</table>
only the first message
in the thread and hides the others. This is useful when threads
contain so many messages that you can only see a handful of threads
- onthe screen. See %M in <link
- linkend="index-format">
- index-format
- </link>
- .
+ onthe screen. See <literal>%M</literal> in
+ <muttng-doc:varref name="index_format" link="index-format"/>.
+ </para>
+
+ <para>
For example, you could use
- "%?M?(#%03M)&(%4l)?" in <link linkend="index-format">
- index-format
- </link>
+ <literal>%?M?(#%03M)&(%4l)?</literal> in <muttng-doc:varref name="index_format" link="index-format"/>
to optionally
display the number of hidden messages if the thread is collapsed.
</para>
<para>
- See also: <link linkend="strict-threads">strict-threads</link>.
+ See also the <muttng-doc:varref name="strict_threads" link="strict-threads"/> variable.
</para>
</sect2>
<title>Miscellaneous Functions</title>
<para>
- <emphasis role="bold">create-alias</emphasis><anchor id="create-alias"/>
- (default: a)
-
+ <muttng-doc:funcdef name="create-alias" key="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>
+ new one). Once editing is complete, an <muttng-doc:command name="alias"/>
+ command is added to the file specified by the <muttng-doc:varref name="alias_file" link="alias-file"/>
variable for future use. <emphasis role="bold">Note:</emphasis>
- Specifying an <link linkend="alias-file">alias-file</link>
+ Specifying an <muttng-doc:varref name="alias_file" link="alias-file"/>
does not add the aliases specified there-in, you must also <link linkend="source">
source
</link>
</para>
<para>
- <emphasis role="bold">check-traditional-pgp</emphasis><anchor id="check-traditional-pgp"/>
- (default: ESC P)
-
+ <muttng-doc:funcdef name="check-traditional-pgp" key="ESC P"/>
</para>
<para>
encrypted with PGP the "traditional" way, that is, without proper
MIME tagging. Technically, this function will temporarily change
the MIME content types of the body parts containing PGP data; this
- is similar to the <link linkend="edit-type">edit-type</link>
+ is similar to the <muttng-doc:funcref name="edit-type"/>
function's
effect.
</para>
<para>
- <emphasis role="bold">display-toggle-weed</emphasis><anchor id="display-toggle-weed"/>
- (default: h)
-
+ <muttng-doc:funcdef name="display-toggle-weed" key="h"/>
</para>
<para>
</para>
<para>
- <emphasis role="bold">edit</emphasis><anchor id="edit"/>
- (default: e)
-
+ <muttng-doc:funcdef name="edit" key="e"/>
</para>
<para>
</para>
<para>
- <emphasis role="bold">edit-type</emphasis><anchor id="edit-type"/>
-
- (default: ˆE on the attachment menu, and in the pager and index
- menus; ˆT on the
- compose menu)
+ <muttng-doc:funcdef name="edit-type"/>
+ (default: <literal>^E</literal> on the attachment menu, and in the pager and index
+ menus; <literal>^T</literal> on the compose menu)
</para>
<para>
</para>
<para>
- <emphasis role="bold">enter-command</emphasis><anchor id="enter-command"/>
- (default: ``:'')
-
+ <muttng-doc:funcdef name="enter-command" key=":"/>
</para>
<para>
</para>
<para>
- <emphasis role="bold">extract-keys</emphasis><anchor id="extract-keys"/>
- (default: ˆK)
-
+ <muttng-doc:funcdef name="extract-keys" key="^K"/>
</para>
<para>
</para>
<para>
- <emphasis role="bold">forget-passphrase</emphasis><anchor id="forget-passphrase"/>
- (default:
- ˆF)
-
+ <muttng-doc:funcdef name="forget-passphrase" key="^F"/>
</para>
<para>
</para>
<para>
- <emphasis role="bold">list-reply</emphasis><anchor id="func-list-reply"/>
- (default: L)
-
+ <muttng-doc:funcdef name="list-reply" key="L"/>
</para>
<para>
</link>
commands, but also honor any <literal>Mail-Followup-To</literal>
header(s) if the
- <link linkend="honor-followup-to">honor-followup-to</link>
+ <muttng-doc:varref name="honor_followup_to" link="honor-followup-to"/>
configuration variable is set. Using this when replying to messages
posted
to mailing lists helps avoid duplicate copies being sent to the
</para>
<para>
- <emphasis role="bold">pipe-message</emphasis><anchor id="pipe-message"/>
- (default: |)
-
+ <muttng-doc:funcdef name="pipe-message" default="|"/>
</para>
<para>
Asks for an external Unix command and pipes the current or
- tagged message(s) to it. The variables <link linkend="pipe-decode">
- pipe-decode
- </link>
- ,<link linkend="pipe-split">pipe-split</link>, <link linkend="pipe-sep">
- pipe-sep
- </link>
- and <link linkend="wait-key">wait-key</link> control the exact
- behavior of this
- function.
+ tagged message(s) to it. The variables
+ <muttng-doc:varref name="pipe_decode" link="honor-followup-to"/>,
+ <muttng-doc:varref name="pipe_split" link="pipe-split"/>,
+ <muttng-doc:varref name="pipe_decode" link="pipe-decode"/> and
+ <muttng-doc:varref name="wait_key" link="wait-key"/>
+ control the exact behavior of this function.
</para>
<para>
- <emphasis role="bold">resend-message</emphasis><anchor id="resend-message"/>
- (default: ESC e)
-
+ <muttng-doc:funcdef name="resend-message" key="ESC e"/>
</para>
<para>
folders". It can conveniently be used to forward MIME messages while
preserving the original mail structure. Note that the amount of
headers
- included here depends on the value of the <link linkend="weed">weed</link>
+ included here depends on the value of the <muttng-doc:varref name="weed"/>
variable.
</para>
</para>
<para>
- <emphasis role="bold">shell-escape</emphasis><anchor id="shell-escape"/>
- (default: !)
-
+ <muttng-doc:funcdef name="shell-escape" key="!"/>
</para>
<para>
- Asks for an external Unix command and executes it. The <link linkend="wait-key">
- wait-key
- </link>
+ Asks for an external Unix command and executes it. The
+ <muttng-doc:varref name="wait_key" link="wait-key"/>
can be used to control
whether Mutt-ng will wait for a key to be pressed when the command
returns
</para>
<para>
- <emphasis role="bold">toggle-quoted</emphasis><anchor id="toggle-quoted"/>
- (default: T)
-
+ <muttng-doc:funcdef name="toggle-quoted" key="T"/>
</para>
<para>
- The <emphasis>pager</emphasis> uses the <link linkend="quote-regexp">
- quote-regexp
- </link>
+ The <emphasis>pager</emphasis> uses the
+ <muttng-doc:varref name="quote_regexp" link="quote-regexp"/>
variable to detect quoted text when
displaying the body of the message. This function toggles the
displayof the quoted material in the message. It is particularly
</para>
<para>
- <emphasis role="bold">skip-quoted</emphasis><anchor id="skip-quoted"/>
- (default: S)
-
+ <muttng-doc:funcdef name="skip-quoted" key="S"/>
</para>
<para>
</row>
</thead>
<tbody>
- <row><entry><literal>m </literal></entry><entry><literal>compose </literal></entry><entry>compose a new message</entry></row>
- <row><entry><literal>r </literal></entry><entry><literal>reply </literal></entry><entry>reply to sender</entry></row>
- <row><entry><literal>g </literal></entry><entry><literal>group-reply </literal></entry><entry>reply to all recipients</entry></row>
- <row><entry><literal>L </literal></entry><entry><literal>list-reply </literal></entry><entry>reply to mailing list address</entry></row>
- <row><entry><literal>f </literal></entry><entry><literal>forward </literal></entry><entry>forward message</entry></row>
- <row><entry><literal>b </literal></entry><entry><literal>bounce </literal></entry><entry>bounce (remail) message</entry></row>
- <row><entry><literal>ESC k </literal></entry><entry><literal>mail-key </literal></entry><entry>mail a PGP public key to someone</entry></row>
+ <row>
+ <entry><literal>m</literal></entry>
+ <entry><muttng-doc:funcref name="compose"/></entry>
+ <entry>compose a new message</entry>
+ </row>
+ <row>
+ <entry><literal>r</literal></entry>
+ <entry><muttng-doc:funcref name="reply"/></entry>
+ <entry>reply to sender</entry>
+ </row>
+ <row>
+ <entry><literal>g</literal></entry>
+ <entry><muttng-doc:funcref name="group-reply"/></entry>
+ <entry>reply to all recipients</entry>
+ </row>
+ <row>
+ <entry><literal>L</literal></entry>
+ <entry><muttng-doc:funcref name="list-reply"/></entry>
+ <entry>reply to mailing list address</entry>
+ </row>
+ <row>
+ <entry><literal>f</literal></entry>
+ <entry><muttng-doc:funcref name="forward"/></entry>
+ <entry>forward message</entry>
+ </row>
+ <row>
+ <entry><literal>b</literal></entry>
+ <entry><muttng-doc:funcref name="bounce"/></entry>
+ <entry>bounce (remail) message</entry>
+ </row>
+ <row>
+ <entry><literal>ESC k </literal></entry>
+ <entry><muttng-doc:funcref name="mail-key"/></entry>
+ <entry>mail a PGP public key to someone</entry>
+ </row>
</tbody>
</tgroup>
</table>
<para>
If you don't set your preferred editor in your configuration, mutt-ng
- first looks whether the environment variable <literal>$VISUAL</literal> is set, and if
+ first looks whether the environment variable <muttng-doc:envvar name="VISUAL"/> is set, and if
so, it takes its value as editor command. Otherwise, it has a look
- at <literal>$EDITOR</literal> and takes its value if it is set. If no
+ at <muttng-doc:envvar name="EDITOR"/> and takes its value if it is set. If no
editor command
- can be found, mutt-ng simply assumes <literal>vi</literal> to be the
+ can be found, mutt-ng simply assumes <muttng-doc:man name="vi"/> to be the
default editor,
since it's the most widespread editor in the Unix world and it's
pretty
</row>
</thead>
<tbody>
- <row><entry><literal>a </literal></entry><entry><literal>attach-file </literal></entry><entry>attach a file</entry></row>
- <row><entry><literal>A </literal></entry><entry><literal>attach-message </literal></entry><entry>attach message(s) to the message</entry></row>
- <row><entry><literal>ESC k </literal></entry><entry><literal>attach-key </literal></entry><entry>attach a PGP public key</entry></row>
- <row><entry><literal>d </literal></entry><entry><literal>edit-description </literal></entry><entry>edit description on attachment</entry></row>
- <row><entry><literal>D </literal></entry><entry><literal>detach-file </literal></entry><entry>detach a file</entry></row>
- <row><entry><literal>t </literal></entry><entry><literal>edit-to </literal></entry><entry>edit the To field</entry></row>
- <row><entry><literal>ESC f </literal></entry><entry><literal>edit-from </literal></entry><entry>edit the From field</entry></row>
- <row><entry><literal>r </literal></entry><entry><literal>edit-reply-to </literal></entry><entry>edit the Reply-To field</entry></row>
- <row><entry><literal>c </literal></entry><entry><literal>edit-cc </literal></entry><entry>edit the Cc field</entry></row>
- <row><entry><literal>b </literal></entry><entry><literal>edit-bcc </literal></entry><entry>edit the Bcc field</entry></row>
- <row><entry><literal>y </literal></entry><entry><literal>send-message </literal></entry><entry>send the message</entry></row>
- <row><entry><literal>s </literal></entry><entry><literal>edit-subject </literal></entry><entry>edit the Subject</entry></row>
- <row><entry><literal>S </literal></entry><entry><literal>smime-menu </literal></entry><entry>select S/MIME options</entry></row>
- <row><entry><literal>f </literal></entry><entry><literal>edit-fcc </literal></entry><entry>specify an ``Fcc'' mailbox</entry></row>
- <row><entry><literal>p </literal></entry><entry><literal>pgp-menu </literal></entry><entry>select PGP options</entry></row>
- <row><entry><literal>P </literal></entry><entry><literal>postpone-message </literal></entry><entry>postpone this message until later</entry></row>
- <row><entry><literal>q </literal></entry><entry><literal>quit </literal></entry><entry>quit (abort) sending the message</entry></row>
- <row><entry><literal>w </literal></entry><entry><literal>write-fcc </literal></entry><entry>write the message to a folder</entry></row>
- <row><entry><literal>i </literal></entry><entry><literal>ispell </literal></entry><entry>check spelling (if available on your system)</entry></row>
- <row><entry><literal>^F </literal></entry><entry><literal>forget-passphrase </literal></entry><entry>wipe passphrase(s) from memory</entry></row>
+ <row>
+ <entry><literal>a</literal></entry>
+ <entry><muttng-doc:funcref name="attach-file"/></entry>
+ <entry>attach a file</entry>
+ </row>
+ <row>
+ <entry><literal>A</literal></entry>
+ <entry><muttng-doc:funcref name="attach-message"/></entry>
+ <entry>attach message(s) to the message</entry>
+ </row>
+ <row>
+ <entry><literal>ESC k </literal></entry>
+ <entry><muttng-doc:funcref name="attach-key"/></entry>
+ <entry>attach a PGP public key</entry>
+ </row>
+ <row>
+ <entry><literal>d</literal></entry>
+ <entry><muttng-doc:funcref name="edit-description"/></entry>
+ <entry>edit description on attachment</entry>
+ </row>
+ <row>
+ <entry><literal>D</literal></entry>
+ <entry><muttng-doc:funcref name="detach-file"/></entry>
+ <entry>detach a file</entry>
+ </row>
+ <row>
+ <entry><literal>t</literal></entry>
+ <entry><muttng-doc:funcref name="edit-to"/></entry>
+ <entry>edit the To field</entry>
+ </row>
+ <row>
+ <entry><literal>ESC f </literal></entry>
+ <entry><muttng-doc:funcref name="edit-from"/></entry>
+ <entry>edit the From field</entry>
+ </row>
+ <row>
+ <entry><literal>r</literal></entry>
+ <entry><muttng-doc:funcref name="edit-reply-to"/></entry>
+ <entry>edit the Reply-To field</entry>
+ </row>
+ <row>
+ <entry><literal>c</literal></entry>
+ <entry><muttng-doc:funcref name="edit-cc"/></entry>
+ <entry>edit the Cc field</entry>
+ </row>
+ <row>
+ <entry><literal>b</literal></entry>
+ <entry><muttng-doc:funcref name="edit-bcc"/></entry>
+ <entry>edit the Bcc field</entry>
+ </row>
+ <row>
+ <entry><literal>y</literal></entry>
+ <entry><muttng-doc:funcref name="send-message"/></entry>
+ <entry>send the message</entry>
+ </row>
+ <row>
+ <entry><literal>s</literal></entry>
+ <entry><muttng-doc:funcref name="edit-subject"/></entry>
+ <entry>edit the Subject</entry>
+ </row>
+ <row>
+ <entry><literal>S</literal></entry>
+ <entry><muttng-doc:funcref name="smime-menu"/></entry>
+ <entry>select S/MIME options</entry>
+ </row>
+ <row>
+ <entry><literal>f</literal></entry>
+ <entry><muttng-doc:funcref name="edit-fcc"/></entry>
+ <entry>specify an ``Fcc'' mailbox</entry>
+ </row>
+ <row>
+ <entry><literal>p</literal></entry>
+ <entry><muttng-doc:funcref name="pgp-menu"/></entry>
+ <entry>select PGP options</entry>
+ </row>
+ <row>
+ <entry><literal>P</literal></entry>
+ <entry><muttng-doc:funcref name="postpone-message"/></entry>
+ <entry>postpone this message until later</entry>
+ </row>
+ <row>
+ <entry><literal>q</literal></entry>
+ <entry><muttng-doc:funcref name="quit"/></entry>
+ <entry>quit (abort) sending the message</entry>
+ </row>
+ <row>
+ <entry><literal>w</literal></entry>
+ <entry><muttng-doc:funcref name="write-fcc"/></entry>
+ <entry>write the message to a folder</entry>
+ </row>
+ <row>
+ <entry><literal>i</literal></entry>
+ <entry><muttng-doc:funcref name="ispell"/></entry>
+ <entry>check spelling (if available on your system)</entry>
+ </row>
+ <row>
+ <entry><literal>^F</literal></entry>
+ <entry><muttng-doc:funcref name="forget-passphrase"/></entry>
+ <entry>wipe passphrase(s) from memory</entry>
+ </row>
</tbody>
</tgroup>
</table>
theywill be attached to the message you are sending. Note that
certainoperations like composing a new mail, replying, forwarding,
etc. are
- not permitted when you are in that folder. The %r in <link linkend="status-format">
- status-format
- </link>
+ not permitted when you are in that folder. The <literal>%r</literal>
+ in <muttng-doc:varref name="status_format" link="status-format"/>
will change to
a 'A' to indicate that you are in attach-message mode.
</para>
<para>
You can also attach files to your message by specifying
-
- <literal>Attach:</literal> <emphasis>filename</emphasis> [ <emphasis>
- description
- </emphasis>
- ]
-
+
+ <screen>
+Attach: filename [description]</screen>
+
where <emphasis>filename</emphasis> is the file to attach and <emphasis>
description
</emphasis>
</para>
<para>
- Also see <link linkend="edit-headers">edit-headers</link>.
+ Also see the <muttng-doc:varref name="edit_headers" link="edit-headers"/> and
+ <muttng-doc:varref name="editor_headers" link="editor-headers"/> variables
</para>
<para>
<para>
If you want to use PGP, you can specify
- </para>
- <para>
- <literal>Pgp:</literal> [ <literal>E</literal> | <literal>
- S
- </literal>
- | <literal>S</literal><emphasis><id></emphasis> ]
-
- </para>
-
- <para>
+ <screen>
+Pgp: [E | S | S id]</screen>
+
``E'' encrypts, ``S'' signs and
- ``S<id>'' signs with the given key, setting <link linkend="pgp-sign-as">
- pgp-sign-as
- </link>
+ ``S<id>'' signs with the given key, setting
+ <muttng-doc:varref name="pgp_sign_as" link="pgp-sign-as"/>
permanently.
</para>
In these cases, you are dropped into a menu with a list of keys from
which you can select one. When you quit this menu, or mutt can't
find any matching keys, you are prompted for a user ID. You can, as
- usually, abort this prompt using <literal>ˆG</literal>. When
+ usually, abort this prompt using <literal>^G</literal>. When
you do so, mutt will
return to the compose screen.
</para>
</para>
<para>
- Most fields of the entries in the key selection menu (see also <link linkend="pgp-entry-format">
- pgp-entry-format
- </link>
- )
+ Most fields of the entries in the key selection menu (see also
+ <muttng-doc:varref name="pgp_entry_format" link="pgp-entry-format"/>)
have obvious meanings. But some explanations on the capabilities,
flags,
and validity fields are in order.
</para>
<para>
- The flags sequence (%f) will expand to one of the following
+ The flags sequence (%f) will expand to one of the following
flags:
</row>
</thead>
<tbody>
- <row><entry><literal>R </literal></entry><entry>The key has been revoked and can't be used.</entry></row>
- <row><entry><literal>X </literal></entry><entry>The key is expired and can't be used.</entry></row>
- <row><entry><literal>d </literal></entry><entry>You have marked the key as disabled.</entry></row>
- <row><entry><literal>c </literal></entry><entry>There are unknown critical self-signature packets.</entry></row>
+ <row>
+ <entry><literal>R</literal></entry>
+ <entry>The key has been revoked and can't be used.</entry>
+ </row>
+ <row>
+ <entry><literal>X</literal></entry>
+ <entry>The key is expired and can't be used.</entry>
+ </row>
+ <row>
+ <entry><literal>d</literal></entry>
+ <entry>You have marked the key as disabled.</entry>
+ </row>
+ <row>
+ <entry><literal>c</literal></entry>
+ <entry>There are unknown critical self-signature packets.</entry>
+ </row>
</tbody>
</tgroup>
</table>
</para>
<para>
- The capabilities field (%c) expands to a two-character
+ The capabilities field (%c) expands to a two-character
sequencerepresenting a key's capabilities. The first character gives
the key's encryption capabilities: A minus sign (<emphasis role="bold">
-
</para>
<para>
- Finally, the validity field (%t) indicates how well-certified
+ Finally, the validity field (%t) indicates how well-certified
a user-id
is. A question mark (<emphasis role="bold">?</emphasis>) indicates
undefined validity, a minus
<para>
Note that different remailers do have different capabilities,
- indicated in the %c entry of the remailer menu lines (see
- <link linkend="mix-entry-format">mix-entry-format</link>). Most
- important is
+ indicated in the <literal>%c</literal> entry of the remailer menu lines (see
+ <muttng-doc:varref name="mix_entry_format" link="mix-entry-format"/>).
+ Most important is
the ``middleman'' capability, indicated by a capital ``M'': This
means that the remailer in question cannot be used as the final
element of a chain, but will only forward messages to other
already begun to compose. When the <emphasis>postpone-message</emphasis> function is
used in the <emphasis>compose</emphasis> menu, the body of your message
and attachments
- are stored in the mailbox specified by the <link linkend="postponed">
- postponed
- </link>
- variable. This means that you can recall the
+ are stored in the mailbox specified by the
+ <muttng-doc:varref name="postponed"/> variable. This means that you can recall the
message even if you exit Mutt-ng and then restart it at a later time.
</para>
</para>
<para>
- See also the <link linkend="postpone">postpone</link> quad-option.
+ See also the <muttng-doc:varref name="postpone"/> quad-option.
</para>
<para>
set realname='Mutt-ng user' ; ignore x-</screen>
The hash mark, or pound sign
- (``#''), is used as a ``comment'' character. You can use it to
+ (``#''), is used as a ``comment'' character. You can use it to
annotate your initialization file. All text after the comment character
to the end of the line is ignored. For example,
</para>
<para>
<screen>
-my_hdr X-Disclaimer: Why are you listening to me? # This is a comment</screen>
+my_hdr X-Disclaimer: Why are you listening to me? # This is a comment</screen>
</para>
namely that a single quote is used to specify a literal string (one
that is
not interpreted for shell variables or quoting with a backslash
- [see
- next paragraph]), while double quotes indicate a string for which
+ (see
+ next paragraph), while double quotes indicate a string for which
should be evaluated. For example, backtics are evaluated inside of
double
quotes, but <emphasis role="bold">not</emphasis> for single quotes.
</para>
<para>
- \ quotes the next character, just as in shells such as bash and
+ \ quotes the next character, just as in shells such as bash and
zsh.
For example, if want to put quotes ``"'' inside of a string, you
can use
- ``\'' to force the next character to be a literal instead of
+ ``\'' to force the next character to be a literal instead of
interpreted
character.
</para>
<para>
- ``\\'' means to insert a literal ``\'' into the line.
- ``\n'' and ``\r'' have their usual C meanings of linefeed and
+ ``\\'' means to insert a literal ``\'' into the line.
+ ``\n'' and ``\r'' have their usual C meanings of linefeed and
carriage-return, respectively.
</para>
<para>
- A \ at the end of a line can be used to split commands over
+ A \ at the end of a line can be used to split commands over
multiple lines, provided that the split points don't appear in the
middle of command names.
</para>
<para>
Please note that, unlike the various shells, mutt-ng interprets a
- ``\''
+ ``\''
at the end of a line also in comments. This allows you to disable a
command
- split over multiple lines with only one ``#''.
+ split over multiple lines with only one ``#''.
</para>
<para>
at the end of the commented line extends the current line with the next
line
- then referred to as a ``continuation line''. As the first line is
- commented with a hash (#) all following continuation lines are also
+ commented with a hash (#) all following continuation lines are also
part of a comment and therefore are ignored, too. So take care of
comments
when continuation lines are involved within your setup files!
</para>
<para>
- line1 ``continues'' until line4. however, the part after the # is a
+ line1 ``continues'' until line4. however, the part after the # is a
comment which includes line3 and line4. line5 is a new line of its own
and
thus is interpreted again.
<para>
UNIX environments can be accessed like the way it is done in
shells like sh and bash: Prepend the name of the environment by a
- ``$'' sign. For example,
+ ``$'' sign. For example,
</para>
<para>
</para>
<para>
- sets the <link linkend="record">record</link> variable to the
- string <emphasis>+sent_on_</emphasis> and appends the
+ sets the <muttng-doc:varref name="record"/> variable to the
+ string <emphasis>+sent_on_</emphasis> and appends the
value of the evironment
- variable <literal>$HOSTNAME</literal>.
+ variable <muttng-doc:envvar name="HOSTNAME"/>.
</para>
<para>
</para>
<para>
- would set the value of <link linkend="imap-home-namespace">
- imap-home-namespace
- </link>
- to the value to
- which <link linkend="folder">folder</link> is <emphasis>currently</emphasis> set
- to.
+ would set the value of <muttng-doc:varref name="imap_home_namespace" link="imap-home-namespace"/>
+ to the value to which <muttng-doc:varref name="folder"/>
+ is <emphasis>currently</emphasis> set to.
</para>
<para>
<emphasis role="bold">Note:</emphasis> There're no logical links
established in such cases so
- that the the value for <link linkend="imap-home-namespace">
- imap-home-namespace
- </link>
+ that the the value for <muttng-doc:varref name="imap_home_namespace" link="imap-home-namespace"/>
won't change even
- if <link linkend="folder">folder</link> gets changed.
+ if <muttng-doc:varref name="folder"/> gets changed.
</para>
<para>
Mutt-ng flexibly allows users to define their own variables. To
avoid conflicts with the standard set and to prevent misleading
error messages, there's a reserved namespace for them: all
- user-defined variables must be prefixed with <literal>user_</literal> and can be
+ user-defined variables must be prefixed with <literal>user_</literal> and can be
used just like any ordinary configuration or environment
variable.
</para>
</para>
<para>
- the variable <literal>$user_foo</literal> has a current value
+ the variable <literal>$user_foo</literal> has a current value
of 666 and an
initial of 42. The query
</para>
In order to allow users to share one setup over a number of
different machines without having to change its contents, there's a
number of pre-defined variables. These are prefixed with
- <literal>muttng_</literal> and are read-only, i.e. they cannot
+ <literal>muttng_</literal> and are read-only, i.e. they cannot
be set, unset or
reset. The reference chapter lists all available variables.
</para>
</para>
<para>
- with <literal>some_folder</literal> being the name of the
+ with <literal>some_folder</literal> being the name of the
first folder muttng
opens. On the contrary,
</para>
<para>
will be executed at runtime because of the single quotes so that
- <literal>user_current_folder</literal> will always have
+ <literal>user_current_folder</literal> will always have
the value of the currently
opened folder.
</para>
<para>
<literallayout>
-Usage: <literal>alias</literal> <emphasis>key</emphasis> <emphasis>address</emphasis>[ , <emphasis>address</emphasis>, ... ]
+Usage: <literal>alias</literal> <emphasis>key</emphasis> <emphasis>address</emphasis> [, <emphasis>address</emphasis>,...]
</literallayout>
</para>
</para>
<para>
- <literal>unalias</literal> [ * | <emphasis>key</emphasis> <emphasis>
- ...
- </emphasis>
- ]
+ <literal>unalias</literal> [* | <emphasis>key</emphasis> <emphasis>...</emphasis>]
</para>
<para>
</para>
<para>
- On the other hand, the <link linkend="create-alias">create-alias</link>
- function can use only one file, the one pointed to by the <link linkend="alias-file">
- alias-file
- </link>
+ On the other hand, the <muttng-doc:funcref name="create-alias"/>
+ function can use only one file, the one pointed to by the
+ <muttng-doc:varref name="alias_file" link="alias-file"/>
variable (which is
- <literal>˜/.muttrc</literal> by default). This file is not
+ <literal>~/.muttrc</literal> by default). This file is not
special either,
in the sense that Mutt-ng will happily append aliases to any file, but
in
prompt. You can
also enter aliases in your editor at the appropriate headers if you
have the
- <link linkend="edit-headers">edit-headers</link> variable set.
+ <muttng-doc:varref name="editor_headers" link="edit-headers"/>
+ variable set.
</para>
<para>
<para>
<emphasis>key</emphasis> is the key (or key sequence) you wish to bind.
To specify a
- control character, use the sequence <emphasis>\Cx</emphasis>,
+ control character, use the sequence <emphasis>\Cx</emphasis>,
where <emphasis>x</emphasis> is the
letter of the control character (for example, to specify control-A use
- ``\Ca''). Note that the case of <emphasis>x</emphasis> as well as
- <emphasis>\C</emphasis> is
- ignored, so that <emphasis>\CA</emphasis>, <emphasis>\Ca</emphasis>, <emphasis>
- \cA
+ ``\Ca''). Note that the case of <emphasis>x</emphasis> as well as
+ <emphasis>\C</emphasis> is
+ ignored, so that <emphasis>\CA</emphasis>, <emphasis>\Ca</emphasis>, <emphasis>
+ \cA
</emphasis>
- and <emphasis>\ca</emphasis> are all
+ and <emphasis>\ca</emphasis> are all
equivalent. An alternative form is to specify the key as a three digit
- octal number prefixed with a ``\'' (for example <emphasis>
- \177
+ octal number prefixed with a ``\'' (for example <emphasis>
+ \177
</emphasis>
is
- equivalent to <emphasis>\c?</emphasis>).
+ equivalent to <emphasis>\c?</emphasis>).
</para>
<para>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
<row>
- <entry>Sequence</entry>
- <entry>Description</entry>
+ <entry>Sequence</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>\t</literal></entry>
+ <entry>tab</entry>
+ </row>
+ <row>
+ <entry><literal><tab></literal></entry>
+ <entry>tab</entry>
+ </row>
+ <row>
+ <entry><literal><backtab></literal></entry>
+ <entry>backtab / shift-tab</entry>
+ </row>
+ <row>
+ <entry><literal>\r</literal></entry>
+ <entry>carriage return</entry>
+ </row>
+ <row>
+ <entry><literal>\n</literal></entry>
+ <entry>newline</entry>
+ </row>
+ <row>
+ <entry><literal>\e</literal></entry>
+ <entry>escape</entry>
+ </row>
+ <row>
+ <entry><literal><esc></literal></entry>
+ <entry>escape</entry>
+ </row>
+ <row>
+ <entry><literal><up></literal></entry>
+ <entry>up arrow</entry>
+ </row>
+ <row>
+ <entry><literal><down></literal></entry>
+ <entry>down arrow</entry>
+ </row>
+ <row>
+ <entry><literal><left></literal></entry>
+ <entry>left arrow</entry>
+ </row>
+ <row>
+ <entry><literal><right></literal></entry>
+ <entry>right arrow</entry>
+ </row>
+ <row>
+ <entry><literal><pageup></literal></entry>
+ <entry>Page Up</entry>
+ </row>
+ <row>
+ <entry><literal><pagedown></literal></entry>
+ <entry>Page Down</entry>
+ </row>
+ <row>
+ <entry><literal><backspace></literal></entry>
+ <entry>Backspace</entry>
+ </row>
+ <row>
+ <entry><literal><delete></literal></entry>
+ <entry>Delete</entry>
+ </row>
+ <row>
+ <entry><literal><insert></literal></entry>
+ <entry>Insert</entry>
+ </row>
+ <row>
+ <entry><literal><enter></literal></entry>
+ <entry>Enter</entry>
+ </row>
+ <row>
+ <entry><literal><return></literal></entry>
+ <entry>Return</entry>
+ </row>
+ <row>
+ <entry><literal><home></literal></entry>
+ <entry>Home</entry>
+ </row>
+ <row>
+ <entry><literal><end></literal></entry>
+ <entry>End</entry>
+ </row>
+ <row>
+ <entry><literal><space></literal></entry>
+ <entry>Space bar</entry>
+ </row>
+ <row>
+ <entry><literal><f1></literal></entry>
+ <entry>function key 1</entry>
+ </row>
+ <row>
+ <entry><literal><f10></literal></entry>
+ <entry>function key 10</entry>
</row>
- </thead>
- <tbody>
- <row><entry><literal>\t </literal></entry><entry>tab</entry></row>
- <row><entry><literal><tab> </literal></entry><entry>tab</entry></row>
- <row><entry><literal><backtab> </literal></entry><entry>backtab / shift-tab</entry></row>
- <row><entry><literal>\r </literal></entry><entry>carriage return</entry></row>
- <row><entry><literal>\n </literal></entry><entry>newline</entry></row>
- <row><entry><literal>\e </literal></entry><entry>escape</entry></row>
- <row><entry><literal><esc> </literal></entry><entry>escape</entry></row>
- <row><entry><literal><up> </literal></entry><entry>up arrow</entry></row>
- <row><entry><literal><down> </literal></entry><entry>down arrow</entry></row>
- <row><entry><literal><left> </literal></entry><entry>left arrow</entry></row>
- <row><entry><literal><right> </literal></entry><entry>right arrow</entry></row>
- <row><entry><literal><pageup> </literal></entry><entry>Page Up</entry></row>
- <row><entry><literal><pagedown> </literal></entry><entry>Page Down</entry></row>
- <row><entry><literal><backspace> </literal></entry><entry>Backspace</entry></row>
- <row><entry><literal><delete> </literal></entry><entry>Delete</entry></row>
- <row><entry><literal><insert> </literal></entry><entry>Insert</entry></row>
- <row><entry><literal><enter> </literal></entry><entry>Enter</entry></row>
- <row><entry><literal><return> </literal></entry><entry>Return</entry></row>
- <row><entry><literal><home> </literal></entry><entry>Home</entry></row>
- <row><entry><literal><end> </literal></entry><entry>End</entry></row>
- <row><entry><literal><space> </literal></entry><entry>Space bar</entry></row>
- <row><entry><literal><f1> </literal></entry><entry>function key 1</entry></row>
- <row><entry><literal><f10> </literal></entry><entry>function key 10</entry></row>
</tbody>
</tgroup>
</table>
<para>
<literallayout>
-Usage: <literal>charset-hook</literal> <emphasis>alias</emphasis> <emphasis> charset</emphasis>
-Usage: <literal>iconv-hook</literal> <emphasis>charset</emphasis> <emphasis> local-charset </emphasis>
+Usage: <muttng-doc:hook name="charset"/> <emphasis>alias</emphasis> <emphasis> charset</emphasis>
+Usage: <muttng-doc:hook name="iconv"/> <emphasis>charset</emphasis> <emphasis> local-charset </emphasis>
</literallayout>
</para>
<para>
- The <literal>charset-hook</literal> command defines an alias for a
+ The <muttng-doc:hook name="charset"/> command defines an alias for a
character set.
This is useful to properly display messages which are tagged with a
character set name not known to mutt.
</para>
<para>
- The <literal>iconv-hook</literal> command defines a system-specific
+ The <muttng-doc:hook name="iconv"/> command defines a system-specific
name for a
character set. This is helpful when your systems character
conversion library insists on using strange, system-specific names
<para>
<literallayout>
-Usage: <literal>folder-hook</literal> [!]<emphasis>regexp</emphasis> <emphasis>command</emphasis>
+Usage: <muttng-doc:hook name="folder"/> [!]<emphasis>regexp</emphasis> <emphasis>command</emphasis>
</literallayout>
</para>
<para>
It is often desirable to change settings based on which mailbox you are
- reading. The folder-hook command provides a method by which you can
+ reading. The <muttng-doc:hook name="folder"/> command provides a method by which you can
execute
any configuration command. <emphasis>regexp</emphasis> is a regular
expression specifying
in which mailboxes to execute <emphasis>command</emphasis> before
loading. If a mailbox
- matches multiple folder-hook's, they are executed in the order given in
+ matches multiple <muttng-doc:hook name="folder"/>'s, they are executed in the order given in
the
muttrc.
</para>
<para>
<emphasis role="bold">Note:</emphasis> if you use the ``!'' shortcut
- for <link linkend="spoolfile">spoolfile</link> at the beginning of the
+ for <muttng-doc:varref name="spoolfile"/> at the beginning of the
pattern, you must place it
inside of double or single quotes in order to distinguish it from the
logical <emphasis>not</emphasis> operator for the expression.
<para>
<literallayout>
-Usage: <literal>macro</literal> <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>sequence</emphasis> [ <emphasis>description</emphasis> ]
+Usage: <literal>macro</literal> <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>sequence</emphasis> [<emphasis>description</emphasis>]
</literallayout>
</para>
some additions however. The
first is that control characters in <emphasis>sequence</emphasis> can
also be specified
- as <emphasis>ˆx</emphasis>. In order to get a caret (`ˆ'')
+ as <emphasis>^x</emphasis>. In order to get a caret (`^'')
you need to use
- <emphasis>ˆˆ</emphasis>. Secondly, to specify a certain key
+ <emphasis>^^</emphasis>. Secondly, to specify a certain key
such as <emphasis>up</emphasis>
or to invoke a function directly, you can use the format
<emphasis><key name></emphasis> and <emphasis><function
<para>
<literallayout>
-Usage: <literal>color</literal> <emphasis>object</emphasis> <emphasis>foreground</emphasis><emphasis>background</emphasis> [ <emphasis>regexp</emphasis>]
+Usage: <literal>color</literal> <emphasis>object</emphasis> <emphasis>foreground</emphasis><emphasis>background</emphasis> [<emphasis>regexp</emphasis>]
Usage: <literal>color</literal> index <emphasis>foreground</emphasis> <emphasis>background</emphasis><emphasis>pattern</emphasis>
-Usage: <literal>uncolor</literal> index <emphasis>pattern</emphasis>[ <emphasis>pattern</emphasis> ... ]
+Usage: <literal>uncolor</literal> index <emphasis>pattern</emphasis>[<emphasis>pattern</emphasis>...]
</literallayout>
</para>
<listitem>
<para>
- quoted (text matching <link linkend="quote-regexp">quote-regexp</link> in the body of a message)
+ quoted (text matching <muttng-doc:varref name="quote_regexp" link="quote-regexp"/> in the body of a message)
</para>
</listitem>
<listitem>
<listitem>
<para>
- tilde (the ``˜'' used to pad blank lines in the pager)
+ tilde (the ``~'' used to pad blank lines in the pager)
</para>
</listitem>
<listitem>
used as a transparent color. The value <emphasis>brightdefault</emphasis> is also valid.
If Mutt-ng is linked against the <emphasis>S-Lang</emphasis> library,
you also need to set
- the <emphasis>COLORFGBG</emphasis> environment variable to the default
+ the <muttng-doc:envvar name="COLORFGBG"/> environment variable to the default
colors of your
terminal for this to work; for example (for Bourne-like shells):
</para>
Mutt-ng also recognizes the keywords <emphasis>color0</emphasis>, <emphasis>
color1
</emphasis>
- ,…,
+ ,...,
<emphasis>color</emphasis><emphasis role="bold">N-1</emphasis> (<emphasis role="bold">
N
</emphasis>
<para>
<literallayout>
-Usage: <literal>mono</literal> <emphasis><object> <attribute></emphasis>[ <emphasis>regexp</emphasis> ]
+Usage: <literal>mono</literal> <emphasis><object> <attribute></emphasis>[<emphasis>regexp</emphasis>]
Usage: <literal>mono</literal> index <emphasis>attribute</emphasis> <emphasis>pattern</emphasis>
-Usage: <literal>unmono</literal> index <emphasis>pattern</emphasis>[ <emphasis>pattern</emphasis> ... ]
+Usage: <literal>unmono</literal> index <emphasis>pattern</emphasis> [<emphasis>pattern</emphasis>...]
</literallayout>
</para>
<para>
<literallayout>
-Usage: <literal>[un]ignore</literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis>... ]
+Usage: <literal>[un]ignore</literal> <emphasis>pattern</emphasis> [<emphasis>pattern</emphasis>...]
</literallayout>
</para>
<title>Alternative addresses</title>
<para>
- Usage: <literal>[un]alternates</literal> <emphasis>regexp</emphasis> [ <emphasis>
- regexp
- </emphasis>
- ... ]
+ Usage: <literal>[un]alternates</literal> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
</para>
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>
- .)
+ yourself won't make much sense in many cases.
+ (See <muttng-doc:varref name="reply_to" link="reply-to"/>.)
</para>
<para>
<para>
Additionally, you have to use an editor which supports writing
- <literal>format=flowed</literal>-conforming emails. For vim, this is
+ <literal>format=flowed</literal>-conforming emails. For <muttng-doc:man name="vim"/>, this is
done by
adding <literal>w</literal> to the formatoptions (see <literal>:h
formatoptions
<title>Additional Notes</title>
<para>
- For completeness, the <link linkend="delete-space">delete-space</link> variable provides the mechanism
+ For completeness, the <muttng-doc:varref name="delete_space" link="delete-space"/> variable provides the mechanism
to generate a <literal>DelSp=yes</literal> parameter on <emphasis>
outgoing
</emphasis>
<para>
<literallayout>
-Usage: <literal>[un]lists</literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>... ]
-Usage: <literal>[un]subscribe</literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>... ]
+Usage: <literal>[un]lists</literal> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
+Usage: <literal>[un]subscribe</literal> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
</literallayout>
</para>
supported by all mail user agents. Adding it is not bullet-proof
against
receiving personal CCs of list messages. Also note that the generation
- of the Mail-Followup-To header is controlled by the <link linkend="followup-to">
- followup-to
- </link>
+ of the Mail-Followup-To header is controlled by the
+ <muttng-doc:varref name="followup_to" link="followup-to"/>
configuration variable.
</para>
You can use regular expressions with both commands. To mark all
messages sent to a specific bug report's address on mutt's bug
tracking system as list mail, for instance, you could say
- ``subscribe [0-9]*@bugs.guug.de''. Often, it's sufficient to just
+ ``subscribe [0-9]*@bugs.guug.de''. Often, it's sufficient to just
give a portion of the list's e-mail address.
</para>
add ``subscribe mutt-users'' to your initialization file instead.
If you also happen to get mail from someone whose address is
<emphasis>mutt-users@example.com</emphasis>, you could use ``lists
- mutt-users@mutt\\.org''
- or ``subscribe mutt-users@mutt\\.org'' to
+ mutt-users@mutt\\.org''
+ or ``subscribe mutt-users@mutt\\.org'' to
match only mail from the actual list.
</para>
<para>
<literallayout>
-Usage: <literal>mbox-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
+Usage: <muttng-doc:hook name="mbox"/> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
</literallayout>
</para>
<para>
<literallayout>
-Usage: <literal>[un]mailboxes</literal> [!]<emphasis>filename</emphasis>[ <emphasis>filename</emphasis> ... ]
+Usage: <literal>[un]mailboxes</literal> [!]<emphasis>filename</emphasis> [<emphasis>filename</emphasis>...]
</literallayout>
</para>
shortcuts
</link>
(such as ``='' and ``!''), any variable
- definition that affect these characters (like <link linkend="folder">
- folder
- </link>
- and <link linkend="spoolfile">spoolfile</link>)
+ definition that affect these characters (like <muttng-doc:varref name="folder"/>
+ and <muttng-doc:varref name="spoolfile"/>)
should be executed before the <literal>mailboxes</literal> command.
</para>
<para>
<literallayout>
-Usage: <literal>my_hdr</literal> <emphasis>string</emphasis>
-Usage: <literal>unmy_hdr</literal> <emphasis>field</emphasis> [ <emphasis>field</emphasis>... ]
+Usage: <literal>my_hdr</literal> <emphasis>string</emphasis>
+Usage: <literal>unmy_hdr</literal> <emphasis>field</emphasis> [<emphasis>field</emphasis>...]
</literallayout>
</para>
<para>
- The ``my_hdr'' command allows you to create your own header
+ The ``my_hdr'' command allows you to create your own header
fields which will be added to every message you send.
</para>
<para>
<screen>
-my_hdr Organization: A Really Big Company, Anytown, USA</screen>
+my_hdr Organization: A Really Big Company, Anytown, USA</screen>
</para>
<para>
<para>
If you would like to add a header field to a single message, you should
- either set the <link linkend="edit-headers">edit-headers</link>
+ either set the <muttng-doc:varref name="edit_headers" link="edit-headers"/>
variable,
or use the <emphasis>edit-headers</emphasis> function (default: ``E'')
in the send-menu so
</para>
<para>
- To remove user defined header fields, use the ``unmy_hdr''
+ To remove user defined header fields, use the ``unmy_hdr''
command. You may specify an asterisk (``*'') to remove all header
fields, or the fields to remove. For example, to remove all ``To'' and
``Cc'' header fields, you could use:
<para>
<screen>
-unmy_hdr to cc</screen>
+unmy_hdr to cc</screen>
</para>
<para>
<para>
<literallayout>
-Usage: <literal>hdr_order</literal> <emphasis>header1</emphasis><emphasis>header2</emphasis> <emphasis>header3</emphasis>
+Usage: <literal>hdr_order</literal> <emphasis>header1</emphasis><emphasis>header2</emphasis> <emphasis>header3</emphasis>
</literallayout>
</para>
</para>
<para>
- ``unhdr_order *'' will clear all previous headers from the order
+ ``unhdr_order *'' will clear all previous headers from the order
list,
thus removing the header order effects set by the system-wide startup
file.
<para>
<screen>
-hdr_order From Date: From: To: Cc: Subject:</screen>
+hdr_order From Date: From: To: Cc: Subject:</screen>
</para>
<para>
<literallayout>
-Usage: <literal>save-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>filename</emphasis>
+Usage: <muttng-doc:hook name="save"/> [!]<emphasis>pattern</emphasis> <emphasis>filename</emphasis>
</literallayout>
</para>
</para>
<para>
- See <link linkend="pattern-hook">pattern-hook</link> for information on
+ See <muttng-doc:hook name="pattern"/> for information on
the exact format of <emphasis>pattern</emphasis>.
</para>
</para>
<para>
- Also see the <link linkend="fcc-save-hook">fcc-save-hook</link>
+ Also see the <muttng-doc:hook name="fcc-save"/>
command.
</para>
<para>
<literallayout>
-Usage: <literal>fcc-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
+Usage: <muttng-doc:hook name="fcc"/> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
</literallayout>
</para>
<para>
This command is used to save outgoing mail in a mailbox other than
- <link linkend="record">record</link>. Mutt-ng searches the initial
+ <muttng-doc:varref name="record"/>. Mutt-ng searches the initial
list of
message recipients for the first matching <emphasis>regexp</emphasis>
and uses <emphasis>mailbox</emphasis>
as the default Fcc: mailbox. If no match is found the message will be
saved
- to <link linkend="record">record</link> mailbox.
+ to <muttng-doc:varref name="record"/> mailbox.
</para>
<para>
- See <link linkend="pattern-hook">pattern-hook</link> for information on
+ See <muttng-doc:hook name="pattern"/> for information on
the exact format of <emphasis>pattern</emphasis>.
</para>
<para>
- Example: <literal>fcc-hook [@.]aol\\.com$
+ Example: <literal><muttng-doc:hook name="fcc"/> ]@.[aol\\.com$
+spammers
</literal>
</para>
<para>
The above will save a copy of all messages going to the aol.com domain
to
- the `+spammers' mailbox by default. Also see the <link linkend="fcc-save-hook">
- fcc-save-hook
- </link>
+ the `+spammers' mailbox by default. Also see the <muttng-doc:hook name="fcc-save"/>
command.
</para>
<para>
<literallayout>
-Usage: <literal>fcc-save-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
+Usage: <literal><muttng-doc:hook name="fcc-save"/></literal> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
</literallayout>
</para>
<para>
- This command is a shortcut, equivalent to doing both a <link linkend="fcc-hook">
- fcc-hook
- </link>
- and a <link linkend="save-hook">save-hook</link> with its arguments.
+ This command is a shortcut, equivalent to doing both a <muttng-doc:hook name="fcc"/>
+ and a <muttng-doc:hook name="save"/> with its arguments.
</para>
<para>
<anchor id="reply-hook"/>
<para>
<literallayout>
-Usage: <literal>reply-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
-Usage: <literal>send-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
-Usage: <literal>send2-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
+Usage: <muttng-doc:hook name="reply"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
+Usage: <muttng-doc:hook name="send"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
+Usage: <muttng-doc:hook name="send2"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
</literallayout>v
</para>
</para>
<para>
- <literal>reply-hook</literal> is matched against the message you are <emphasis>
+ <muttng-doc:hook name="reply"/> is matched against the message you are <emphasis>
replying
</emphasis>
<emphasis role="bold">to</emphasis>, instead of the message you are <emphasis>
sending
</emphasis>
- .<literal>send-hook</literal> is
+ .<muttng-doc:hook name="send"/> is
matched against all messages, both <emphasis>new</emphasis> and <emphasis>
replies
</emphasis>
.<emphasis role="bold">Note:</emphasis>
- <literal>reply-hook</literal>s are matched <emphasis role="bold">before</emphasis> the <literal>
- send-hook
- </literal>
- ,<emphasis role="bold">regardless</emphasis>
+ <muttng-doc:hook name="reply"/>s are matched <emphasis role="bold">before</emphasis> the
+ <muttng-doc:hook name="send"/>, <emphasis role="bold">regardless</emphasis>
of the order specified in the users's configuration file.
</para>
<para>
- <literal>send2-hook</literal> is matched every time a message is
+ <muttng-doc:hook name="send2"/> is matched every time a message is
changed, either
by editing it, or by using the compose menu to change its recipients
- or subject. <literal>send2-hook</literal> is executed after <literal>
- send-hook
- </literal>
+ or subject. <muttng-doc:hook name="send2"/> is executed after <muttng-doc:hook name="send"/>
,and
- can, e.g., be used to set parameters such as the <link linkend="sendmail">
- sendmail
- </link>
+ can, e.g., be used to set parameters such as the <muttng-doc:varref name="sendmail"/>
variable depending on the message's sender
address.
</para>
<para>
- For each type of <literal>send-hook</literal> or <literal>reply-hook</literal>, when multiple matches
+ For each type of <muttng-doc:hook name="send"/> or <muttng-doc:hook name="reply"/>, when multiple matches
occur, commands are executed in the order they are specified in the
muttrc
(for that type of hook).
</para>
<para>
- See <link linkend="pattern-hook">pattern-hook</link> for information on
+ See <muttng-doc:hook name="pattern"/> for information on
the exact format of <emphasis>pattern</emphasis>.
</para>
<para>
- Example: <literal>send-hook mutt "set mime_forward
+ Example: <literal>send-hook mutt "set mime_forward
signature=''"
</literal>
</para>
<para>
Another typical use for this command is to change the values of the
- <link linkend="attribution">attribution</link>, <link linkend="signature">
- signature
- </link>
- and <link linkend="locale">locale</link>
+ <muttng-doc:varref name="attribution"/>,
+ <muttng-doc:varref name="signature"/> and <muttng-doc:varref
+ name="locale"/>
variables in order to change the language of the attributions and
signatures based upon the recipients.
</para>
<para>
- <emphasis role="bold">Note:</emphasis> the send-hook's are only
+ <emphasis role="bold">Note:</emphasis> the <muttng-doc:hook name="send"/>'s are only
executed ONCE after getting the initial
list of recipients. Adding a recipient after replying or editing the
- message will NOT cause any send-hook to be executed. Also note that
- my_hdr commands which modify recipient headers, or the message's
+ message will NOT cause any <muttng-doc:hook name="send"/> to be executed. Also note that
+ my_hdr commands which modify recipient headers, or the message's
subject, don't have any effect on the current message when executed
- from a send-hook.
+ from a <muttng-doc:hook name="send"/>.
</para>
<para>
<para>
<literallayout>
-Usage: <literal>message-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
+Usage: <muttng-doc:hook name="message"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
</literallayout>
</para>
</para>
<para>
- See <link linkend="pattern-hook">pattern-hook</link> for
+ See <muttng-doc:hook name="pattern"/> for
information on the exact format of <emphasis>pattern</emphasis>.
</para>
Example:
<screen>
-message-hook ~A 'set pager=builtin'
-message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject:.*\""'</screen>
+message-hook <muttng-doc:pattern name="A"/> 'set pager=builtin'
+message-hook '<muttng-doc:pattern name="f"/> freshmeat-news' 'set pager="less \"+/^ subject:.*\""'</screen>
</para>
<para>
<literallayout>
-Usage: <literal>crypt-hook</literal> <emphasis>pattern</emphasis> <emphasis>keyid</emphasis>
+Usage: <muttng-doc:hook name="crypt"/> <emphasis>pattern</emphasis> <emphasis>keyid</emphasis>
</literallayout>
</para>
key with a given e-mail address automatically, either because the
recipient's public key can't be deduced from the destination address,
or because, for some reasons, you need to override the key Mutt-ng
- wouldnormally use. The crypt-hook command provides a method by which
+ wouldnormally use. The <muttng-doc:hook name="crypt"/> command provides a method by which
you can
specify the ID of the public key to be used when encrypting messages to
a certain recipient.
<para>
<literallayout>
-Usage: <literal>exec</literal> <emphasis>function</emphasis> [ <emphasis>function</emphasis> ... ]
+Usage: <literal>exec</literal> <emphasis>function</emphasis> [<emphasis>function</emphasis>...]
</literallayout>
</para>
<para>
<literallayout>
Usage: <literal>score</literal> <emphasis>pattern</emphasis> <emphasis>value</emphasis>
-Usage: <literal>unscore</literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis>... ]
+Usage: <literal>unscore</literal> <emphasis>pattern</emphasis> [<emphasis>pattern</emphasis>...]
</literallayout>
</para>
<para>
<screen>
-score "~f nion@muttng\.org" 50
-score "~f @sco\.com" -100</screen>
+score "<muttng-doc:pattern name="f"/> nion@muttng\.org" 50
+score "<muttng-doc:pattern name="f"/> @sco\.com" -100</screen>
</para>
<para>
<screen>
-score "~f santaclaus@northpole\.int" =666</screen>
+score "<muttng-doc:pattern name="f"/> santaclaus@northpole\.int" =666</screen>
</para>
</para>
<para>
- These three thresholds can be set via the variables <link linkend="score-threshold-flag">
- score-threshold-flag
- </link>
- ,<link linkend="score-threshold-read">score-threshold-read</link>, <link linkend="score-threshold-delete">
- score-threshold-delete
- </link>
- and. By
- default, <link linkend="score-threshold-read">score-threshold-read</link> and <link linkend="score-threshold-delete">
- score-threshold-delete
- </link>
+ These three thresholds can be set via the variables
+ <muttng-doc:varref name="score_threshold_read" link="score-threshold-read"/>,
+ <muttng-doc:varref name="score_threshold_flag" link="score-threshold-flag"/> and
+ <muttng-doc:varref name="score_threshold_delete" link="score-threshold-delete"/>.
+ </para>
+ <para>
+ By default,
+ <muttng-doc:varref name="score_threshold_read" link="score-threshold-read"/> and
+ <muttng-doc:varref name="score_threshold_delete" link="score-threshold-delete"/>
are set to
<literal>-1</literal>, which means that in the default threshold
configuration no
color
</literal>
command
- and the <literal>˜n</literal> pattern:
+ and the <muttng-doc:pattern name="n"/> pattern:
</para>
<para>
<screen>
-color index black yellow "~n 10-"
-color index red yellow "~n 100-"</screen>
+color index black yellow "<muttng-doc:pattern name="n"/> 10-"
+color index red yellow "<muttng-doc:pattern name="n"/> 100-"</screen>
</para>
your
mail based on its spam attributes, as determined by the external
filter. You also can display the spam attributes in your index
- display using the <literal>%H</literal> selector in the <link linkend="index-format">
- index-format
- </link>
- variable. (Tip: try <literal>%?H?[%H] ?</literal>
+ display using the <literal>%H</literal> selector in the
+ <muttng-doc:varref name="index_format" link="index-format"/>
+ variable. (Tip: try <literal>%?H?[%H] ?</literal>
to display spam tags only when they are defined for a given message.)
</para>
pattern
</emphasis>
expression. (A regular expression ``back-reference'' refers to a
- sub-expression contained within parentheses.) <literal>%1</literal> is replaced with
- the first back-reference in the regex, <literal>%2</literal>
+ sub-expression contained within parentheses.) <literal>%1</literal> is replaced with
+ the first back-reference in the regex, <literal>%2</literal>
with the second, etc.
</para>
one spam-related header. You can define <literal>spam</literal>
patterns for each
filter you use. If a message matches two or more of these patterns, and
- the $spam_separator variable is set to a string, then the
+ the $spam_separator variable is set to a string, then the
message's spam tag will consist of all the <emphasis>format</emphasis>
strings joined
- together, with the value of $spam_separator separating
+ together, with the value of $spam_separator separating
them.
</para>
<para>
If I then received a message that DCC registered with ``many'' hits
under the ``Fuz2'' checksum, and that PureMessage registered with a
- 97% probability of being spam, that message's spam tag would
+ 97% probability of being spam, that message's spam tag would
read<literal>90+/DCC-Fuz2, 97/PM</literal>. (The four characters before
``=many'' in a
DCC report indicate the checksum used -- in this case, ``Fuz2''.)
</para>
<para>
- If the $spam_separator variable is unset, then each
+ If the $spam_separator variable is unset, then each
spam pattern match supersedes the previous one. Instead of getting
joined <emphasis>format</emphasis> strings, you'll get only the last
one to match.
<para>
The spam tag is what will be displayed in the index when you use
- <literal>%H</literal> in the <literal>
- $index_format
+ <literal>%H</literal> in the <literal>
+ $index_format
</literal>
variable. It's also the
- string that the <literal>˜H</literal> pattern-matching expression
+ string that the <muttng-doc:pattern name="H"/> pattern-matching expression
matches against for
<emphasis>search</emphasis> and <emphasis>limit</emphasis> functions.
And it's what sorting by spam
will be removed. This might be the default action if you use <literal>
spam
</literal>
- and <literal>nospam</literal> in conjunction with a <literal>
- folder-hook
- </literal>
- .
+ and <literal>nospam</literal> in conjunction with a <muttng-doc:hook name="folder"/>.
</para>
<para>
<para>
<literallayout>
-Usage: <literal>set</literal> [no|inv]<emphasis>variable</emphasis>[=<emphasis>value</emphasis>] [ <emphasis>variable</emphasis> ... ]
-Usage: <literal>toggle</literal> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>... ]
-Usage: <literal>unset</literal> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>... ]
-Usage: <literal>reset</literal> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>... ]
+Usage: <literal>set</literal> [no|inv]<emphasis>variable</emphasis>[=<emphasis>value</emphasis>] [<emphasis>variable</emphasis>...]
+Usage: <literal>toggle</literal> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>...]
+Usage: <literal>unset</literal> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>...]
+Usage: <literal>reset</literal> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>...]
</literallayout>
</para>
printable characters.
<emphasis>strings</emphasis> must be enclosed in quotes if they contain
spaces or tabs. You
- may also use the ``C'' escape sequences <emphasis role="bold">\n</emphasis> and <emphasis role="bold">
- \t
+ may also use the ``C'' escape sequences <emphasis role="bold">\n</emphasis> and <emphasis role="bold">
+ \t
</emphasis>
for
newline and tab, respectively.
the variable name with
<literal>inv</literal> to toggle the value (on or off). This is useful
when writing
- macros. Example: <literal>set invsmart_wrap</literal>.
+ macros. Example: <literal>set invsmart_wrap</literal>.
</para>
<para>
<para>
<literallayout>
-Usage: <literal>source</literal> <emphasis>filename</emphasis> [ <emphasis>filename</emphasis>... ]
+Usage: <literal>source</literal> <emphasis>filename</emphasis> [<emphasis>filename</emphasis>...]
</literallayout>
</para>
<para>
This command allows the inclusion of initialization commands
from other files. For example, I place all of my aliases in
- <literal>˜/.mail_aliases</literal> so that I can make my
- <literal>˜/.muttrc</literal> readable and keep my aliases
+ <literal>~/.mail_aliases</literal> so that I can make my
+ <literal>~/.muttrc</literal> readable and keep my aliases
private.
</para>
<para>
- If the filename begins with a tilde (``˜''), it will be expanded
+ If the filename begins with a tilde (``~''), it will be expanded
to the
path of your home directory.
</para>
<para>
- If the filename ends with a vertical bar (|), then <emphasis>
+ If the filename ends with a vertical bar (|), then <emphasis>
filename
</emphasis>
is
considered to be an executable program from which to read input (eg.
- <literal>source ˜/bin/myscript|</literal>).
+ <literal>source ~/bin/myscript|</literal>).
</para>
<para>
<para>
<literallayout>
-Usage: <literal>unhook</literal> [ * | <emphasis>hook-type</emphasis> ]
+Usage: <literal>unhook</literal> [* | <emphasis>hook-type</emphasis>]
</literallayout>
</para>
This command permits you to flush hooks you have previously defined.
You can either remove all hooks by giving the ``*'' character as an
argument, or you can remove all hooks of a specific type by saying
- something like <literal>unhook send-hook</literal>.
+ something like <literal>unhook send</literal>.
</para>
<para>
<para>
and replacing the dots with the actual character set. To avoid
- problems while maintaining the setup, vim user's may want to use
+ problems while maintaining the setup, <muttng-doc:man name="vim"/> user's may want to use
modelines as show in:
</para>
<para>
while, again, replacing the dots with the appropriate name. This
- tells vim as which character set to read and save the file.
+ tells <muttng-doc:man name="vim"/> as which character set to read and save the file.
</para>
<para>
All available functions, variables and menus are documented
elsewhere in this manual but ``features'' is specific to these
two commands. To test for one, prefix one of the following
- keywords with <literal>feature_</literal>: ncurses,
+ keywords with <literal>feature_</literal>: ncurses,
slang, iconv, idn, dotlock, standalone, pop, nntp, imap, ssl,
gnutls, sasl, sasl2, libesmtp, compressed, color, classic_pgp,
classic_smime, gpgme, header_cache
<para>
As an example, one can use the following in
- <literal>˜/.muttngrc</literal>:
+ <literal>~/.muttngrc</literal>:
</para>
<para>
</para>
<para>
- ...to only source <literal>˜/.mutt-ng/setup-imap</literal> if
+ ...to only source <literal>~/.mutt-ng/setup-imap</literal> if
IMAP
- support is built in, only source <literal>˜/.mutt-ng/setup-pop</literal>
+ support is built in, only source <literal>~/.mutt-ng/setup-pop</literal>
if POP support is built in and only source
- <literal>˜/.mutt-ng/setup-nntp</literal> if NNTP support is
+ <literal>~/.mutt-ng/setup-nntp</literal> if NNTP support is
built in.
</para>
<para>
An example for testing for variable names can be used if users
use different revisions of mutt-ng whereby the older one may not
- have a certain variable. To test for the availability of <link linkend="imap-mail-check">
- imap-mail-check
- </link>
- ,
+ have a certain variable. To test for the availability of
+ <muttng-doc:varref name="imap_mail_check" link="imap-mail-check"/>
use:
</para>
</para>
<para>
- Provided for completeness is the test for menu names. To set <link linkend="pager-index-lines">
- pager-index-lines
- </link>
+ Provided for completeness is the test for menu names. To set
+ <muttng-doc:varref name="pager_index_lines"
+ link="pager-index-lines"/>
only if the pager
menu is available, use:
</para>
<para>
The search is case sensitive if the pattern contains at least one upper
- case letter, and case insensitive otherwise. Note that ``\''
+ case letter, and case insensitive otherwise. Note that ``\''
must be quoted if used for a regular expression in an initialization
- command: ``\\''.
+ command: ``\\''.
</para>
<para>
</para>
<para>
- The period ``.'' matches any single character. The caret ``ˆ''
- andthe dollar sign ``$'' are metacharacters that respectively
+ The period ``.'' matches any single character. The caret ``^''
+ andthe dollar sign ``$'' are metacharacters that respectively
match
the empty string at the beginning and end of a line.
</para>
<para>
- A list of characters enclosed by ``['' and ``]'' matches any
+ A list of characters enclosed by ``]'' and ``['' matches any
single character in that list; if the first character of the list
- is a caret ``ˆ'' then it matches any character <emphasis role="bold">
+ is a caret ``^'' then it matches any character <emphasis role="bold">
not
</emphasis>
in the
list. For example, the regular expression <emphasis role="bold">
- [0123456789]
+ ]0123456789[
</emphasis>
matches any single digit. A range of ASCII characters may be specified
by giving the first and last characters, separated by a hyphen
``-''. Most metacharacters lose their special meaning inside
- lists. To include a literal ``]'' place it first in the list.
- Similarly, to include a literal ``ˆ'' place it anywhere but first.
+ lists. To include a literal ``['' place it first in the list.
+ Similarly, to include a literal ``^'' place it anywhere but first.
Finally, to include a literal hyphen ``-'' place it last.
</para>
<para>
Certain named classes of characters are predefined. Character classes
- consist of ``[:'', a keyword denoting the class, and ``:]''.
+ consist of ``]:'', a keyword denoting the class, and ``:[''.
The following classes are defined by the POSIX standard:
</para>
<variablelist>
<varlistentry>
- <term>[:alnum:]</term>
+ <term>]:alnum:[</term>
<listitem>
<para>
Alphanumeric characters.
</listitem>
</varlistentry>
<varlistentry>
- <term>[:alpha:]</term>
+ <term>]:alpha:[</term>
<listitem>
<para>
Alphabetic characters.
</listitem>
</varlistentry>
<varlistentry>
- <term>[:blank:]</term>
+ <term>]:blank:[</term>
<listitem>
<para>
Space or tab characters.
</listitem>
</varlistentry>
<varlistentry>
- <term>[:cntrl:]</term>
+ <term>]:cntrl:[</term>
<listitem>
<para>
Control characters.
</listitem>
</varlistentry>
<varlistentry>
- <term>[:digit:]</term>
+ <term>]:digit:[</term>
<listitem>
<para>
Numeric characters.
</listitem>
</varlistentry>
<varlistentry>
- <term>[:graph:]</term>
+ <term>]:graph:[</term>
<listitem>
<para>
Characters that are both printable and visible. (A space is
</listitem>
</varlistentry>
<varlistentry>
- <term>[:lower:]</term>
+ <term>]:lower:[</term>
<listitem>
<para>
Lower-case alphabetic characters.
</listitem>
</varlistentry>
<varlistentry>
- <term>[:print:]</term>
+ <term>]:print:[</term>
<listitem>
<para>
Printable characters (characters that are not control
</listitem>
</varlistentry>
<varlistentry>
- <term>[:punct:]</term>
+ <term>]:punct:[</term>
<listitem>
<para>
Punctuation characters (characters that are not letter, digits,
</listitem>
</varlistentry>
<varlistentry>
- <term>[:space:]</term>
+ <term>]:space:[</term>
<listitem>
<para>
Space characters (such as space, tab and formfeed, to name a
</listitem>
</varlistentry>
<varlistentry>
- <term>[:upper:]</term>
+ <term>]:upper:[</term>
<listitem>
<para>
Upper-case alphabetic characters.
</listitem>
</varlistentry>
<varlistentry>
- <term>[:xdigit:]</term>
+ <term>]:xdigit:[</term>
<listitem>
<para>
Characters that are hexadecimal digits.
brackets of a character list. Note that the brackets in these
class names are part of the symbolic names, and must be included
in addition to the brackets delimiting the bracket list. For
- example, <emphasis role="bold">[[:digit:]]</emphasis> is equivalent to
- <emphasis role="bold">[0-9]</emphasis>.
+ example, <emphasis role="bold">]]:digit:[[</emphasis> is equivalent to
+ <emphasis role="bold">]0-9[</emphasis>.
</para>
<para>
<para>
A collating symbol is a multi-character collating element
enclosed in
- ``[.'' and ``.]''. For example, if ``ch'' is a
+ ``].'' and ``.[''. For example, if ``ch'' is a
collating
element, then <emphasis role="bold">
- [[.ch.]]
+ ]].ch.[[
</emphasis>
is a regexp that matches
this collating element, while <emphasis role="bold">
- [ch]
+ ]ch[
</emphasis>
is a regexp that
matches either ``c'' or ``h''.
<para>
An equivalence class is a locale-specific name for a list of
characters that are equivalent. The name is enclosed in
- ``[=''
- and ``=]''. For example, the name ``e'' might be used to
- represent all of ``è'' ``é'' and ``e''. In this
+ ``]=''
+ and ``=[''. For example, the name ``e'' might be used to
+ represent all of ``è'' ``é'' and ``e''. In this
case,
- <emphasis role="bold">[[=e=]]</emphasis> is
+ <emphasis role="bold">]]=e=[[</emphasis> is
a regexp that matches any of
- ``è'', ``é'' and ``e''.
+ ``è'', ``é'' and ``e''.
</para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
- <term>{n}</term>
+ <term>{n}</term>
<listitem>
<para>
The preceding item is matched exactly <emphasis>n</emphasis>
</listitem>
</varlistentry>
<varlistentry>
- <term>{n,}</term>
+ <term>{n,}</term>
<listitem>
<para>
The preceding item is matched <emphasis>n</emphasis> or more
</listitem>
</varlistentry>
<varlistentry>
- <term>{,m}</term>
+ <term>{,m}</term>
<listitem>
<para>
The preceding item is matched at most <emphasis>m</emphasis>
</listitem>
</varlistentry>
<varlistentry>
- <term>{n,m}</term>
+ <term>{n,m}</term>
<listitem>
<para>
The preceding item is matched at least <emphasis>n</emphasis>
<para>
Two regular expressions may be joined by the infix operator
- ``|'';
+ ``|'';
the resulting regular expression matches any string matching either
subexpression.
</para>
<variablelist>
<varlistentry>
- <term>\\y</term>
+ <term>\\y</term>
<listitem>
<para>
Matches the empty string at either the beginning or the end of
</listitem>
</varlistentry>
<varlistentry>
- <term>\\B</term>
+ <term>\\B</term>
<listitem>
<para>
Matches the empty string within a word.
</listitem>
</varlistentry>
<varlistentry>
- <term>\\<</term>
+ <term>\\<</term>
<listitem>
<para>
Matches the empty string at the beginning of a word.
</listitem>
</varlistentry>
<varlistentry>
- <term>\\></term>
+ <term>\\></term>
<listitem>
<para>
Matches the empty string at the end of a word.
</listitem>
</varlistentry>
<varlistentry>
- <term>\\w</term>
+ <term>\\w</term>
<listitem>
<para>
Matches any word-constituent character (letter, digit, or
</listitem>
</varlistentry>
<varlistentry>
- <term>\\W</term>
+ <term>\\W</term>
<listitem>
<para>
Matches any character that is not word-constituent.
</listitem>
</varlistentry>
<varlistentry>
- <term>\\`</term>
+ <term>\\`</term>
<listitem>
<para>
Matches the empty string at the beginning of a buffer (string).
</listitem>
</varlistentry>
<varlistentry>
- <term>\\'</term>
+ <term>\\'</term>
<listitem>
<para>
Matches the empty string at the end of a buffer.
<para>
<screen>
-~s 'SPAM' ~U</screen>
+<muttng-doc:pattern name="s"/> 'SPAM' <muttng-doc:pattern name="U"/></screen>
</para>
</para>
<para>
- To logical OR patterns, simply use the <literal>|</literal>
+ To logical OR patterns, simply use the <literal>|</literal>
operator. This one
especially useful when using local groups:
</para>
<para>
<screen>
-~f ("nion@muttng\.org"|"ak@muttng\.org"|"pdmef@muttng\.org")
-(~b mutt-ng|~s Mutt-ng)
-!~x '@synflood\.at'</screen>
+<muttng-doc:pattern name="f"/> ("nion@muttng\.org"|"ak@muttng\.org"|"pdmef@muttng\.org")
+(<muttng-doc:pattern name="b"/> mutt-ng|<muttng-doc:pattern name="s"/> Mutt-ng)
+!<muttng-doc:pattern name="x"/> '@synflood\.at'</screen>
</para>
<para>
<screen>
-~d 01/01/2005+1y
-~d 18/10/2004-2w
-~d 28/12/2004*1d</screen>
+<muttng-doc:pattern name="d"/> 01/01/2005+1y
+<muttng-doc:pattern name="d"/> 18/10/2004-2w
+<muttng-doc:pattern name="d"/> 28/12/2004*1d</screen>
</para>
<para>
<screen>
-~d >2w # messages older than two weeks
-~d <3d # messages newer than 3 days
-~d =1m # messages that are exactly one month old</screen>
+<muttng-doc:pattern name="d"/> >2w # messages older than two weeks
+<muttng-doc:pattern name="d"/> <3d # messages newer than 3 days
+<muttng-doc:pattern name="d"/> =1m # messages that are exactly one month old</screen>
</para>
<para>
The setting for the status bar of the index is controlled via the
- <link linkend="status-format">status-format</link>
+ <muttng-doc:varref name="status_format" link="status-format"/>
variable. For the hostname and version string, there's an expando
- for <literal>$status_format</literal>: <literal>
- %h
+ for <literal>$status_format</literal>: <literal>
+ %h
</literal>
expands to the
- hostname and <literal>%v</literal> to the version string. When
+ hostname and <literal>%v</literal> to the version string. When
just configuring:
</para>
</para>
<para>
- mutt-ng will replace the sequence <literal>%v</literal> with
+ mutt-ng will replace the sequence <literal>%v</literal> with
the version string
- and <literal>%h</literal> with the host's name. When you are,
+ and <literal>%h</literal> with the host's name. When you are,
for example, running
mutt-ng version <literal>1.5.9i</literal> on host <literal>mailhost</literal>, you'll see the
following when you're in the index:
<para>
To only print the number of messages if there are new messages in
the current mailbox, further extend
- <literal>$status_format</literal> to:
+ <literal>$status_format</literal> to:
</para>
<para>
which tells mutt-ng to only look at <literal><string if
nonzero>
</literal>
- if the value of the <literal>%<item%gt;</literal>
+ if the value of the <literal>%<item%gt;</literal>
expando is different from zero. In our example, we used <literal>n</literal> as
- the expando to check for and <literal>%n new</literal> as the
+ the expando to check for and <literal>%n new</literal> as the
optional nonzero
string.
</para>
<listitem>
<para>
- When specifying <literal>%_<item></literal>
+ When specifying <literal>%_<item></literal>
instead of
- just <literal>%<item></literal>, mutt-ng will
+ just <literal>%<item></literal>, mutt-ng will
convert all
characters in the expansion of <literal><item></literal>
to
<listitem>
<para>
- When specifying <literal>%:<item></literal>
+ When specifying <literal>%:<item></literal>
instead of just
- <literal>%<item></literal>, mutt-ng will convert
+ <literal>%<item></literal>, mutt-ng will convert
all dots in the
expansion of <literal><item></literal> to underscores
- (<literal>_</literal>).
+ (<literal>_</literal>).
</para>
</listitem>
<para>
Also, there's a feature called <emphasis>Padding</emphasis> supplied
by the
- following two expandos: <literal>%|X</literal> and <literal>
- %>X
+ following two expandos: <literal>%|X</literal> and <literal>
+ %>X
</literal>
.
</para>
<varlistentry>
<term>
- <literal>%|X</literal>
+ <literal>%|X</literal>
</term>
<listitem>
<para>
</varlistentry>
<varlistentry>
<term>
- <literal>%>X</literal>
+ <literal>%>X</literal>
</term>
<listitem>
<para>
Since the previous expando stops at
the end of line, there must be a way to fill the gap between
- two items via the <literal>%>X</literal> expando:
+ two items via the <literal>%>X</literal> expando:
it puts as many
characters <literal>X</literal> in between two items so that
the rest of
the line will be right-justified. For example, to not put the
version string and hostname of our example on the left but on
the right and fill the gap with spaces, one might use (note
- the space after <literal>%></literal>):
+ the space after <literal>%></literal>):
</para>
<para>
</emphasis>
operation will
be applied to all tagged messages if that operation can be used in that
- manner. If the <link linkend="auto-tag">auto-tag</link>
+ manner. If the <muttng-doc:varref name="auto_tag" link="auto-tag"/>
variable is set, the next operation applies to the tagged messages
automatically, without requiring the ``tag-prefix''.
</para>
<listitem>
<para>
- <link linkend="folder-hook">folder-hook</link>
+ <muttng-doc:hook name="folder"/>
</para>
</listitem>
<listitem>
<para>
- <link linkend="send-hook">send-hook</link>
+ <muttng-doc:hook name="send"/>
</para>
</listitem>
<listitem>
<para>
- <link linkend="message-hook">message-hook</link>
+ <muttng-doc:hook name="message"/>
</para>
</listitem>
<listitem>
<para>
- <link linkend="save-hook">save-hook</link>
+ <muttng-doc:hook name="save"/>
</para>
</listitem>
<listitem>
<para>
- <link linkend="mbox-hook">mbox-hook</link>
+ <muttng-doc:hook name="mbox"/>
</para>
</listitem>
<listitem>
<para>
- <link linkend="fcc-hook">fcc-hook</link>
+ <muttng-doc:hook name="fcc"/>
</para>
</listitem>
<listitem>
<para>
- <link linkend="fcc-save-hook">fcc-save-hook</link>
+ <muttng-doc:hook name="fcc-save"/>
</para>
</listitem>
effective until the end of the current mutt session. As this is
generally
not desired, a default hook needs to be added before all other hooks to
- restore configuration defaults. Here is an example with send-hook and
+ restore configuration defaults. Here is an example with <muttng-doc:hook name="send"/> and
the
- my_hdr directive:
+ my_hdr directive:
</para>
<para>
<screen>
send-hook . 'unmy_hdr From:'
-send-hook ~C'^b@b\.b$' my_hdr from: c@c.c</screen>
+send-hook <muttng-doc:pattern name="C"/>'^b@b\.b$' my_hdr from: c@c.c</screen>
</para>
<title>Message Matching in Hooks</title>
<para>
- Hooks that act upon messages (<literal>send-hook, save-hook,
- fcc-hook,message-hook
+ Hooks that act upon messages (<literal><muttng-doc:hook name="send"/>, <muttng-doc:hook name="save"/>,
+ <muttng-doc:hook name="fcc"/>,<muttng-doc:hook name="message"/>
</literal>
)are evaluated in a slightly different manner. For the other
types of hooks, a <link linkend="advanced-regexp">regexp</link> is
mail to a specific address, you could do something like:
<screen>
-send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt-ng User <user@host>'</screen>
+send-hook '<muttng-doc:pattern name="t"/> ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt-ng User <user@host>'</screen>
which would execute the given command when sending mail to
<emphasis>me@cs.hmc.edu</emphasis>.
like the other hooks, in which case Mutt-ng will translate your
pattern into the full language, using the translation specified by
the
- <link linkend="default-hook">default-hook</link> variable. The
+ <muttng-doc:hook name="default"/> variable. The
pattern is translated at the time the hook is declared, so the value
of
- <link linkend="default-hook">default-hook</link> that is in effect
+ <muttng-doc:hook name="default"/> that is in effect
at that time will be used.
</para>
</row>
</thead>
<tbody>
- <row><entry><literal>none</literal></entry><entry><literal>sidebar-scroll-up </literal></entry><entry>Scrolls the mailbox list up 1 page</entry></row>
- <row><entry><literal>none</literal></entry><entry><literal>sidebar-scroll-down </literal></entry><entry>Scrolls the mailbox list down 1 page</entry></row>
- <row><entry><literal>none</literal></entry><entry><literal>sidebar-next </literal></entry><entry>Highlights the next mailbox</entry></row>
- <row><entry><literal>none</literal></entry><entry><literal>sidebar-next-new </literal></entry><entry>Highlights the next mailbox with new mail</entry></row>
- <row><entry><literal>none</literal></entry><entry><literal>sidebar-previous </literal></entry><entry>Highlights the previous mailbox</entry></row>
- <row><entry><literal>none</literal></entry><entry><literal>sidebar-open </literal></entry><entry>Opens the currently highlighted mailbox</entry></row>
+ <row>
+ <entry><literal>none</literal></entry>
+ <entry><muttng-doc:funcref name="sidebar-scroll-up"/></entry>
+ <entry>Scrolls the mailbox list up 1 page</entry>
+ </row>
+ <row>
+ <entry><literal>none</literal></entry>
+ <entry><muttng-doc:funcref name="sidebar-scroll-down"/></entry>
+ <entry>Scrolls the mailbox list down 1 page</entry>
+ </row>
+ <row>
+ <entry><literal>none</literal></entry>
+ <entry><muttng-doc:funcref name="sidebar-next"/></entry>
+ <entry>Highlights the next mailbox</entry>
+ </row>
+ <row>
+ <entry><literal>none</literal></entry>
+ <entry><muttng-doc:funcref name="sidebar-next-new"/></entry>
+ <entry>Highlights the next mailbox with new mail</entry>
+ </row>
+ <row>
+ <entry><literal>none</literal></entry>
+ <entry><muttng-doc:funcref name="sidebar-previous"/></entry>
+ <entry>Highlights the previous mailbox</entry>
+ </row>
+ <row>
+ <entry><literal>none</literal></entry>
+ <entry><muttng-doc:funcref name="sidebar-open"/></entry>
+ <entry>Opens the currently highlighted mailbox</entry>
+ </row>
</tbody>
</tgroup>
</table>
Mutt-ng supports connecting to external directory databases such as
LDAP,
ph/qi, bbdb, or NIS through a wrapper script which connects to mutt
- using a simple interface. Using the <link linkend="query-command">
- query-command
- </link>
+ using a simple interface. Using the
+ <muttng-doc:varref name="query_command" link="query-command"/>
variable, you specify the wrapper
command to use. For example:
</para>
<para>
The other mechanism for accessing the query function is for address
completion, similar to the alias completion. In any prompt for address
- entry, you can use the complete-query function (default: ˆT) to
+ entry, you can use the complete-query function (default: ^T) to
run a
query based on the current address you have typed. Like aliases, mutt
will look for what you have typed back to the last space or comma. If
Mutt-ng supports reading and writing of four different mailbox formats:
mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there
is no need to use a flag for different mailbox types. When creating
- newmailboxes, Mutt-ng uses the default specified with the <link linkend="mbox-type">
- mbox-type
- </link>
+ newmailboxes, Mutt-ng uses the default specified with the
+ <muttng-doc:varref name="mbox_type" link="mbox-type"/>
variable.
</para>
<para>
to denote the start of a new message (this is often referred to as the
- ``From_'' line).
+ ``From_'' line).
</para>
<para>
mbox
</emphasis>
format. Each message is
- surrounded by lines containing ``ˆAˆAˆAˆA'' (four
+ surrounded by lines containing ``^A^A^A^A'' (four
control-A's).
</para>
</emphasis>
Mutt
detects this type of mailbox by looking for either <literal>
- .mh_sequences
+ .mh_sequences
</literal>
or <literal>.xmhcache</literal> (needed to distinguish normal
directories from MH
<listitem>
<para>
- ! -- refers to your <link linkend="spoolfile">spoolfile</link>
+ ! -- refers to your <muttng-doc:varref name="spoolfile" link="spoolfile"/>
(incoming) mailbox
</para>
</listitem>
<listitem>
<para>
- > -- refers to your <link linkend="mbox">mbox</link> file
+ > -- refers to your <muttng-doc:varref name="mbox" link="mbox"/> file
</para>
</listitem>
<listitem>
<para>
- < -- refers to your <link linkend="record">record</link> file
+ < -- refers to your <muttng-doc:varref name="record" link="record"/> file
</para>
</listitem>
<listitem>
<para>
- ˆ -- refers to the current mailbox
+ ^ -- refers to the current mailbox
</para>
</listitem>
<listitem>
<listitem>
<para>
- ˜ -- refers to your home directory
+ ~ -- refers to your home directory
</para>
</listitem>
<listitem>
<para>
- = or + -- refers to your <link linkend="folder">folder</link>
+ = or + -- refers to your <muttng-doc:varref name="folder" link="folder"/>
directory
</para>
</listitem>
<listitem>
<para>
- @<emphasis>alias</emphasis> -- refers to the <link linkend="save-hook">
- save-hook
- </link>
+ @<emphasis>alias</emphasis> -- refers to the <muttng-doc:hook name="save"/>
as determined by the address of the alias
</para>
</listitem>
personal and list mail in the same mailbox. In the <link linkend="index-format">
index-format
</link>
- variable, the escape ``%L''
+ variable, the escape ``%L''
will return the string ``To <list>'' when ``list'' appears in the
``To'' field, and ``Cc <list>'' when it appears in the ``Cc''
field (otherwise it returns the name of the author).
Conversely, when group-replying or list-replying to a message which
has a <literal>Mail-Followup-To</literal> header, mutt will respect
this header if
- the <link linkend="honor-followup-to">honor-followup-to</link>
+ the <muttng-doc:varref name="honor_followup_to" link="honor-followup-to"/>
configuration
variable is set. Using list-reply will in this case also make sure
that the reply goes to the mailing list, even if it's not specified
than the author of the message. This can create problems when trying
to reply directly to the author in private, since most mail clients
will automatically reply to the address given in the ``Reply-To''
- field. Mutt-ng uses the <link linkend="reply-to">reply-to</link>
+ field. Mutt-ng uses the <muttng-doc:varref name="reply_to" link="reply-to"/>
variable to help decide which address to use. If set to <emphasis>
ask-yes
</emphasis>
<para>
The ``X-Label:'' header field can be used to further identify mailing
lists or list subject matter (or just to annotate messages
- individually). The <link linkend="index-format">index-format</link>
- variable's ``%y'' and
- ``%Y'' escapes can be used to expand ``X-Label:'' fields in the
+ individually). The <muttng-doc:varref name="index_format" link="index-format"/>
+ variable's ``%y'' and
+ ``%Y'' escapes can be used to expand ``X-Label:'' fields in the
index, and Mutt-ng's pattern-matcher can match regular expressions to
- ``X-Label:'' fields with the ``˜y'' selector. ``X-Label:'' is
+ ``X-Label:'' fields with the ``<muttng-doc:pattern name="y"/>'' selector. ``X-Label:'' is
not a
standard message header field, but it can easily be inserted by
procmailand other mail filtering agents.
<para>
You can also connect multiple children at once, tagging them and
using the
- tag-prefix command (';') or the auto_tag option.
+ tag-prefix command (';') or the auto_tag option.
</para>
</sect2>
changing
the subject to a totally unrelated one.
You can fix such threads by using the ``break-thread'' function
- (boundby default to #), which will turn the subthread starting
+ (boundby default to #), which will turn the subthread starting
from the
current message into a whole different thread.
</para>
<listitem>
<para>
- <link linkend="dsn-notify">dsn-notify</link> is used
+ <muttng-doc:varref name="dsn_notify" link="dsn-notify"/> is used
to request receipts for different results (such as failed
message,message delivered, etc.).
<listitem>
<para>
- <link linkend="dsn-return">dsn-return</link> requests
+ <muttng-doc:varref name="dsn_return" link="dsn-return"/> requests
how much of your message should be returned with the receipt
(headers or full message).
reason the frequency at which Mutt-ng will check for mail remotely can
be
controlled by the
- <link linkend="pop-mail-check">pop-mail-check</link>
+ <muttng-doc:varref name="pop_mail_check" link="pop-mail-check"/>
variable, which defaults to every 60 seconds.
</para>
pop-host
</link>
,fetch all your new mail and place it in the
- local <link linkend="spoolfile">spoolfile</link>. After this
+ local <muttng-doc:varref name="spoolfile" link="spoolfile"/>. After this
point, Mutt-ng runs exactly as if the mail had always been local.
</para>
<emphasis role="bold">Note:</emphasis> If you only need to fetch all
messages to local mailbox
you should consider using a specialized program, such as
- <ulink
- URL="http://www.ccil.org/~esr/fetchmail">fetchmail</ulink>
+ <muttng-doc:man name="fetchmail"/>.
</para>
<para>
<para>
Pine-compatible notation is also supported, i.e.
- <literal>{[username@]imapserver[:port][/ssl]}path/to/folder</literal>
+ <literal>{[username@]imapserver[:port][/ssl]}path/to/folder</literal>
</para>
<para>
When browsing folders on an IMAP server, you can toggle whether to look
at only the folders you are subscribed to, or all folders with the
<emphasis>toggle-subscribed</emphasis> command. See also the
- <link linkend="imap-list-subscribed">imap-list-subscribed</link>
+ <muttng-doc:varref name="imap_list_subscribed" link="imap-list-subscribed"/>
variable.
</para>
Polling for new mail on an IMAP server can cause noticeable delays. So,
you'll
want to carefully tune the
- <link linkend="imap-mail-check">imap-mail-check</link>
+ <muttng-doc:varref name="imap_mail_check" link="imap-mail-check"/>
and
- <link linkend="timeout">timeout</link>
+ <muttng-doc:varref name="timeout" link="timeout"/>
variables.
</para>
<listitem>
<para>
- <link linkend="imap-user">imap-user</link> - controls
+ <muttng-doc:varref name="imap_user" link="imap-user"/> - controls
the username under which you request authentication on the IMAP
server,
for all authenticators. This is overridden by an explicit
username in
the mailbox path (i.e. by using a mailbox name of the form
- <literal>{user@host}</literal>).
+ <literal>{user@host}</literal>).
</para>
</listitem>
<listitem>
<para>
- <link linkend="imap-pass">imap-pass</link> - a
+ <muttng-doc:varref name="imap_pass" link="imap-pass"/> - a
password which you may preset, used by all authentication
methods where
a password is needed.
<listitem>
<para>
- <link linkend="imap-authenticators">imap-authenticators</link>
+ <muttng-doc:varref name="imap_authenticators" link="imap-authenticators"/>
- a colon-delimited list of IMAP
authentication methods to try, in the order you wish to try
them. If
</para>
<para>
- The Default newsserver can be obtained from the
- <literal>$NNTPSERVER</literal> environment variable. Like other
+ The Default newsserver can be obtained from the <muttng-doc:envvar name="NNTPSERVER"/>
+ environment variable. Like other
news readers,
info about subscribed newsgroups is saved in a file as specified by the
- <link linkend="nntp-newsrc">nntp-newsrc</link> variable.
+ <muttng-doc:varref name="nntp_newsrc" link="nntp-newsrc"/> variable.
Article headers are cached and can be loaded from a file when a
newsgroup is entered instead loading from newsserver; currently, this
caching mechanism still is different from the header caching for
Especially for Usenet, people often ask for advanced filtering
and scoring functionality. Of course, mutt-ng has scoring and
allows a killfile, too. How to use a killfile has been discussed
- in <link linkend="score-command">score-command</link>.
+ in <link linkend="score-command">Message Scoring</link>.
</para>
<para>
<para>
<screen>
-score ~* =42</screen>
+score <muttng-doc:pattern name="*"/> =42</screen>
</para>
<para>
<screen>
-score !~* =42</screen>
+score !<muttng-doc:pattern name="*"/> =42</screen>
</para>
provides SMTP functionality. When <literal>configure</literal> was
called with
<literal>--with-libesmtp</literal> or the output <literal>muttng -v</literal> contains
- <literal>+USE_LIBESMTP</literal>, this will be or is the case
+ <literal>+USE_LIBESMTP</literal>, this will be or is the case
already. The SMTP
support includes support for Delivery Status Notification (see <link linkend="dsn">
dsn
Authentication mechanisms are available via the <link linkend="smtp-user">
smtp-user
</link>
- and <link linkend="smtp-pass">smtp-pass</link> variables.
+ and <muttng-doc:varref name="smtp_pass" link="smtp-pass"/> variables.
</para>
<para>
Transport Encryption via the StartTLS command is also available. For
this to work, first of all Mutt-ng must be built with SSL or GNUTLS.
- Secondly, the <link linkend="smtp-use-tls">smtp-use-tls</link> variable
+ Secondly, the <muttng-doc:varref name="smtp_use_tls" link="smtp-use-tls"/> variable
must be either set
to ``enabled'' or ``required.'' In both cases, StartTLS will be used if
the server supports it: for the second case, the connection will fail
sender, i.e. they allow for only one value which may not be what the
user wants to send as the <literal>From:</literal> header. In this
case, the variable
- <link linkend="smtp-envelope">smtp-envelope</link> may be used
+ <muttng-doc:varref name="smtp_envelope" link="smtp-envelope"/> may be used
to set the envelope different from the <literal>From:</literal> header.
</para>
<para>
If you happen to have accounts on multiple IMAP and/or POP servers,
you may find managing all the authentication settings inconvenient and
- error-prone. The account-hook command may help. This hook works like
- folder-hook but is invoked whenever you access a remote mailbox
+ error-prone. The <muttng-doc:hook name="account"/> command may help. This hook works like
+ <muttng-doc:hook name="folder"/> but is invoked whenever you access a remote mailbox
(including inside the folder browser), not just when you open the
mailbox.
</para>
</para>
<para>
- There are three hooks defined (<link linkend="open-hook">open-hook</link>,
- <link linkend="close-hook">close-hook</link> and <link linkend="append-hook">
- append-hook
- </link>
+ There are three hooks defined (<muttng-doc:hook name="open"/>,
+ <muttng-doc:hook name="close"/> and <muttng-doc:hook name="append"/>
)which define commands to uncompress and compress
a folder and to append messages to an existing compressed folder
respectively.
</para>
<para>
- You do not have to specify all of the commands. If you omit <link linkend="append-hook">
- append-hook
- </link>
+ You do not have to specify all of the commands. If you omit <muttng-doc:hook name="append"/>
,the folder will be open and
- closed again each time you will add to it. If you omit <link linkend="close-hook">
- close-hook
- </link>
+ closed again each time you will add to it. If you omit <muttng-doc:hook name="close"/>
(or give empty command) , the
- folder will be open in the mode. If you specify <link linkend="append-hook">
- append-hook
- </link>
+ folder will be open in the mode. If you specify <muttng-doc:hook name="append"/>
though you'll be able to append
to the folder.
</para>
<para>
<literallayout>
-Usage: <literal>open-hook</literal> <emphasis>regexp</emphasis> "<emphasis>command</emphasis>"
+Usage: <muttng-doc:hook name="open"/> <emphasis>regexp</emphasis> "<emphasis>command</emphasis>"
</literallayout>
</para>
<para>
The <emphasis>command</emphasis> string is the printf-like format
string, and it
- should accept two parameters: %f, which is replaced with the
- (compressed) folder name, and %t which is replaced with the
+ should accept two parameters: %f, which is replaced with the
+ (compressed) folder name, and %t which is replaced with the
name of the temporary folder to which to write.
</para>
<para>
- %f and %t can be repeated any number of times in the
+ %f and %t can be repeated any number of times in the
command string, and all of the entries are replaced with the
- appropriate folder name. In addition, %% is replaced by
- %, as in printf, and any other %anything is left as is.
+ appropriate folder name. In addition, %% is replaced by
+ %, as in printf, and any other %anything is left as is.
</para>
<para>
<para>
<literallayout>
-Usage: <literal>close-hook</literal> <emphasis>regexp</emphasis>"<emphasis>command</emphasis>"
+Usage: <muttng-doc:hook name="close"/> <emphasis>regexp</emphasis>"<emphasis>command</emphasis>"
</literallayout>
</para>
<para>
- This is used to close the folder that was open with the <link linkend="open-hook">
- open-hook
- </link>
+ This is used to close the folder that was open with the <muttng-doc:hook name="open"/>
command after some changes were made to it.
</para>
used for closing the
folders whose names match <emphasis>regexp</emphasis>. It has the
same format as in
- the <link linkend="open-hook">open-hook</link> command. Temporary
+ the <muttng-doc:hook name="open"/> command. Temporary
folder
- in this case is the folder previously produced by the <<link linkend="open-hook">
- open-hook
- </link>
+ in this case is the folder previously produced by the <muttng-doc:hook name="open"/>
command.
</para>
</para>
<para>
- <link linkend="close-hook">close-hook</link> is not called when you
+ <muttng-doc:hook name="close"/> is not called when you
exit
from the folder if the folder was not changed.
</para>
<para>
<literallayout>
-Usage: <literal>append-hook</literal> <emphasis>regexp</emphasis>"<emphasis>command</emphasis>"
+Usage: <muttng-doc:hook name="append"/> <emphasis>regexp</emphasis>"<emphasis>command</emphasis>"
</literallayout>
</para>
appending to the
folders whose names match <emphasis>regexp</emphasis>. It has the
same format as in
- the <link linkend="open-hook">open-hook</link> command.
+ the <muttng-doc:hook name="open"/> command.
The temporary folder in this case contains the messages that are
beingappended.
</para>
</para>
<para>
- When <link linkend="append-hook">append-hook</link> is used, the
+ When <muttng-doc:hook name="append"/> is used, the
folder is
not opened, which saves time, but this means that we can not find out
what the folder type is. Thus the default (<link linkend="mbox-type">
</para>
<para>
- If the file does not exist when you save to it, <link linkend="close-hook">
- close-hook
- </link>
- is called, and not <link linkend="append-hook">append-hook</link>. <link linkend="append-hook">
- append-hook
- </link>
+ If the file does not exist when you save to it, <muttng-doc:hook name="close"/>
+ is called, and not <muttng-doc:hook name="append"/>. <muttng-doc:hook name="append"/>
is only
for appending to existing folders.
</para>
If the <emphasis>command</emphasis> is empty, this operation is
disabled for this file
type. In this case, the folder will be open and closed again (using
- <link linkend="open-hook">open-hook</link> and <link linkend="close-hook">
- close-hook
- </link>
+ <muttng-doc:hook name="open"/> and <muttng-doc:hook name="close"/>
respectively) each time you will add to it.
</para>
<para>
Please note, that PGP does not support appending to an encrypted
- folder, so there is no append-hook defined.
+ folder, so there is no <muttng-doc:hook name="append"/> defined.
</para>
<para>
<para>
Finally, you can apply the usual message-related functions (like
- <link linkend="resend-message">resend-message</link>, and the reply
+ <muttng-doc:funcref name="resend-message"/>, and the reply
and forward functions) to attachments of type <literal>message/rfc822</literal>.
</para>
<literal>toggle-unlink</literal> command (default: u). The next
field is the MIME
content-type, and can be changed with the <literal>edit-type</literal> command
- (default: ˆT). The next field is the encoding for the
+ (default: ^T). The next field is the encoding for the
attachment,
which allows a binary message to be encoded for transmission on 7bit
links. It can be changed with the <literal>edit-encoding</literal>
command
- (default: ˆE). The next field is the size of the attachment,
+ (default: ^E). The next field is the size of the attachment,
rounded to kilobytes or megabytes. The next field is the filename,
which can be changed with the <literal>rename-file</literal> command
(default: R).
<para>
When you add an attachment to your mail message, Mutt-ng searches your
- personal mime.types file at <literal>
- ${HOME}/.mime.types
- </literal>
- ,and then
+ personal mime.types file within <muttng-doc:envvar name="HOME"/> and then
the system mime.types file at <literal>/usr/local/share/mutt/mime.types</literal> or
<literal>/etc/mime.types</literal>
</para>
type that Mutt-ng assigns to an attachment by using the <literal>
edit-type
</literal>
- command from the compose menu (default: ˆT). The MIME type is
+ command from the compose menu (default: ^T). The MIME type is
actually a
major mime type followed by the sub-type, separated by a '/'. 6 major
types: application, text, image, video, audio, and model have been
<screen>
${HOME}/.mailcap:/usr/local/share/mutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap</screen>
- where <literal>$HOME</literal> is your home directory.
+ where <muttng-doc:envvar name="HOME"/> is your home directory.
</para>
<para>
</para>
<para>
- A comment line consists of a # character followed by anything you
+ A comment line consists of a # character followed by anything you
want.
</para>
There
are two different types of commands supported. The default is to send
the body of the MIME message to the command on stdin. You can change
- this behavior by using %s as a parameter to your view command.
+ this behavior by using %s as a parameter to your view command.
This will cause Mutt-ng to save the body of the MIME message to a
temporary
- file, and then call the view command with the %s replaced by
+ file, and then call the view command with the %s replaced by
the name of the temporary file. In both cases, Mutt-ng will turn over
the
terminal to the view program until the program quits, at which time
text/html; lynx %s</screen>
In this case, lynx does not support viewing a file from stdin, so you
- must use the %s syntax.
+ must use the %s syntax.
<emphasis role="bold">Note:</emphasis> <emphasis>Some older versions
of lynx contain a bug where they
will check the mailcap file for a viewer for text/html. They will
parameters
can lead to security problems in general. Mutt-ng tries to quote
parameters
- in expansion of %s syntaxes properly, and avoids risky
+ in expansion of %s syntaxes properly, and avoids risky
characters by
substituting them, see the <link linkend="mailcap-sanitize">
mailcap-sanitize
</para>
<para>
- <emphasis>Keep the %-expandos away from shell quoting.</emphasis>
+ <emphasis>Keep the %-expandos away from shell quoting.</emphasis>
Don't quote them with single or double quotes. Mutt-ng does this for
you, the right way, as should any other program which interprets
mailcap. Don't put them into backtick expansions. Be highly careful
</para>
<para>
- If you have to use the %-expandos' values in context where you
+ If you have to use the %-expandos' values in context where you
need
quoting or backtick expansions, put that value into a shell variable
and reference the shell variable where necessary, as in the following
- example (using <literal>$charset</literal> inside the backtick
+ example (using <literal>$charset</literal> inside the backtick
expansion is safe,
since it is not itself subject to any further expansion):
</para>
auto-view
</link>
,in order to decide whether it should honor the setting
- of the <link linkend="wait-key">wait-key</link> variable or
+ of the <muttng-doc:varref name="wait_key" link="wait-key"/> variable or
not. When an attachment is viewed using an interactive
program, and the
corresponding mailcap entry has a <emphasis>needsterminal</emphasis> flag, Mutt-ng will use
- <link linkend="wait-key">wait-key</link> and the exit
+ <muttng-doc:varref name="wait_key" link="wait-key"/> and the exit
statusof the program to decide if it will ask you to press
a key after the
external program has exited. In all other situations it
<listitem>
<para>
This field specifies the format for the file denoted by
- %s in the
+ %s in the
command fields. Certain programs will require a certain
file extension,
for instance, to correctly view a file. For instance, lynx
<variablelist>
<varlistentry>
- <term>%s</term>
+ <term>%s</term>
<listitem>
<para>
As seen in the basic mailcap section, this variable is
</listitem>
</varlistentry>
<varlistentry>
- <term>%t</term>
+ <term>%t</term>
<listitem>
<para>
- Mutt-ng will expand %t to the text representation of
+ Mutt-ng will expand %t to the text representation of
the content
type of the message in the same form as the first parameter
of the
</listitem>
</varlistentry>
<varlistentry>
- <term>%{<parameter>}</term>
+ <term>%{<parameter>}</term>
<listitem>
<para>
Mutt-ng will expand this to the value of the specified
<screen>
Content-Type: text/plain; charset=iso-8859-1</screen>
- then Mutt-ng will expand %{charset} to
+ then Mutt-ng will expand %{charset} to
iso-8859-1. The default metamail
mailcap file uses this feature to test the charset to spawn
an xterm
</listitem>
</varlistentry>
<varlistentry>
- <term>\%</term>
+ <term>\%</term>
<listitem>
<para>
- This will be replaced by a %
+ This will be replaced by a %
</para>
</listitem>
</varlistentry>
</variablelist>
- Mutt-ng does not currently support the %F and %n
+ Mutt-ng does not currently support the %F and %n
keywords
specified in RFC 1524. The main purpose of these parameters is for
multipart messages, which is handled internally by Mutt-ng.
</para>
<para>
- You then use the <literal>auto_view</literal> muttrc command to
+ You then use the <literal>auto_view</literal> muttrc command to
list the
content-types that you wish to view automatically.
</para>
<para>
- For instance, if you set auto_view to:
+ For instance, if you set auto_view to:
<screen>
auto_view text/html application/x-gunzip application/postscript
</para>
<para>
- ``unauto_view'' can be used to remove previous entries from the
+ ``unauto_view'' can be used to remove previous entries from the
autoview list.
- This can be used with message-hook to autoview messages based on size,
+ This can be used with <muttng-doc:hook name="message"/> to autoview messages based on size,
etc.
- ``unauto_view *'' will remove all previous entries.
+ ``unauto_view *'' will remove all previous entries.
</para>
<para>
<para>
Mutt-ng has some heuristics for determining which attachment of a
multipart/alternative type to display. First, mutt will check the
- alternative_order list to determine if one of the available
- typesis preferred. The alternative_order list consists of a
+ alternative_order list to determine if one of the available
+ typesis preferred. The alternative_order list consists of a
number of
MIME types in order, including support for implicit and explicit
wildcards, for example:
</para>
<para>
- To remove a MIME type from the <literal>alternative_order</literal> list, use the
- <literal>unalternative_order</literal> command.
+ To remove a MIME type from the <literal>alternative_order</literal> list, use the
+ <literal>unalternative_order</literal> command.
</para>
<para>
<title>MIME Lookup</title>
<para>
- Mutt-ng's mime_lookup list specifies a list of mime-types that
+ Mutt-ng's mime_lookup list specifies a list of mime-types that
should not
be treated according to their mailcap entry. This option is designed
todeal with binary types such as application/octet-stream. When an
attachment's
- mime-type is listed in mime_lookup, then the extension of the
+ mime-type is listed in mime_lookup, then the extension of the
filename will
be compared to the list of extensions in the mime.types file. The
mime-type
attachment
according to the rules in the mailcap file and according to any other
configuration
- options (such as auto_view) specified. Common usage would be:
+ options (such as auto_view) specified. Common usage would be:
<screen>
mime_lookup application/octet-stream application/X-Lotus-Manuscript</screen>
</para>
<para>
- In addition, the unmime_lookup command may be used to disable
+ In addition, the unmime_lookup command may be used to disable
this feature
for any particular mime-type if it had been set, for example, in a
global
<para>
Mutt-ng uses many temporary files for viewing messages, verifying
- digital signatures, etc. The <link linkend="umask">umask</link>
+ digital signatures, etc. The <muttng-doc:varref name="umask" link="umask"/>
variable can be used to change the default permissions of these
files. Please only change it if you really know what you are doing.
Also, a different location for these files may be desired which can
- be changed via the <link linkend="tmpdir">tmpdir</link> variable.
+ be changed via the <muttng-doc:varref name="tmpdir" link="tmpdir"/> variable.
</para>
</sect1>
is increased
(and rotated) with every message sent. If you'd like to hide this
information probably telling others how many mail you sent in which
- time, you at least need to remove the <literal>%P</literal>
+ time, you at least need to remove the <literal>%P</literal>
expando from the
- default setting of the <link linkend="msgid-format">msgid-format</link> variable. Please make sure that
+ default setting of the <muttng-doc:varref name="msgid_format" link="msgid-format"/> variable. Please make sure that
you really know how local parts of these <literal>Message-ID:</literal> headers
are composed.
</para>
will be strict in interpreting them which means that arbitrary
header fields can be embedded in these links which could override
existing header fields or attach arbitrary files. This may be
- problematic if the <link linkend="edit-headers">edit-headers</link>
+ problematic if the <muttng-doc:varref name="edit_headers" link="edit-headers"/>
variable is <emphasis>unset</emphasis>, i.e. the
user doesn't want to see header fields while editing the message.
</para>
<listitem>
<para>
- turn on the <link linkend="edit-headers">edit-headers</link>
+ turn on the <muttng-doc:varref name="edit_headers" link="edit-headers"/>
variable by
force to let the user see all the headers
(because they still may leak information.)
1524. Mutt-ng can be set up to <emphasis>automatically</emphasis>
execute any
given utility as listed in one of the mailcap files (see the
- <link linkend="mailcap-path">mailcap-path</link>
+ <muttng-doc:varref name="mailcap_path" link="mailcap-path"/>
variable for details.)
</para>
<listitem>
<para>
- leave the <link linkend="mailcap-sanitize">mailcap-sanitize</link> variable in its default
+ leave the <muttng-doc:varref name="mailcap_sanitize" link="mailcap-sanitize"/> variable in its default
state to restrict mailcap expandos to a safe set of characters
</para>
</row>
</thead>
<tbody>
- <row><entry><literal>-A </literal></entry><entry>expand an alias</entry></row>
- <row><entry><literal>-a </literal></entry><entry>attach a file to a message</entry></row>
- <row><entry><literal>-b </literal></entry><entry>specify a blind carbon-copy (BCC) address</entry></row>
- <row><entry><literal>-c </literal></entry><entry>specify a carbon-copy (Cc) address</entry></row>
- <row><entry><literal>-e </literal></entry><entry>specify a config command to be run after initialization files are read</entry></row>
- <row><entry><literal>-f </literal></entry><entry>specify a mailbox to load</entry></row>
- <row><entry><literal>-F </literal></entry><entry>specify an alternate file to read initialization commands</entry></row>
- <row><entry><literal>-h </literal></entry><entry>print help on command line options</entry></row>
- <row><entry><literal>-H </literal></entry><entry>specify a draft file from which to read a header and body</entry></row>
- <row><entry><literal>-i </literal></entry><entry>specify a file to include in a message composition</entry></row>
- <row><entry><literal>-m </literal></entry><entry>specify a default mailbox type</entry></row>
- <row><entry><literal>-n </literal></entry><entry>do not read the system Muttngrc</entry></row>
- <row><entry><literal>-p </literal></entry><entry>recall a postponed message</entry></row>
- <row><entry><literal>-Q </literal></entry><entry>query a configuration variable</entry></row>
- <row><entry><literal>-R </literal></entry><entry>open mailbox in read-only mode</entry></row>
- <row><entry><literal>-s </literal></entry><entry>specify a subject (enclose in quotes if it contains spaces)</entry></row>
- <row><entry><literal>-t </literal></entry><entry>dump the value of all variables to stdout</entry></row>
- <row><entry><literal>-T </literal></entry><entry>dump the value of all changed variables to stdout</entry></row>
- <row><entry><literal>-v </literal></entry><entry>show version number and compile-time definitions</entry></row>
- <row><entry><literal>-x </literal></entry><entry>simulate the mailx(1) compose mode</entry></row>
- <row><entry><literal>-y </literal></entry><entry>show a menu containing the files specified by the mailboxes command</entry></row>
- <row><entry><literal>-z </literal></entry><entry>exit immediately if there are no messages in the mailbox</entry></row>
- <row><entry><literal>-Z </literal></entry><entry>open the first folder with new message,exit immediately if none</entry></row>
+ <row>
+ <entry><literal>-A</literal></entry>
+ <entry>expand an alias</entry>
+ </row>
+ <row>
+ <entry><literal>-a</literal></entry>
+ <entry>attach a file to a message</entry>
+ </row>
+ <row>
+ <entry><literal>-b</literal></entry>
+ <entry>specify a blind carbon-copy (BCC) address</entry>
+ </row>
+ <row>
+ <entry><literal>-c</literal></entry>
+ <entry>specify a carbon-copy (Cc) address</entry>
+ </row>
+ <row>
+ <entry><literal>-e</literal></entry>
+ <entry>specify a config command to be run after initialization files are read</entry>
+ </row>
+ <row>
+ <entry><literal>-f</literal></entry>
+ <entry>specify a mailbox to load</entry>
+ </row>
+ <row>
+ <entry><literal>-F</literal></entry>
+ <entry>specify an alternate file to read initialization commands</entry>
+ </row>
+ <row>
+ <entry><literal>-h</literal></entry>
+ <entry>print help on command line options</entry>
+ </row>
+ <row>
+ <entry><literal>-H</literal></entry>
+ <entry>specify a draft file from which to read a header and body</entry>
+ </row>
+ <row>
+ <entry><literal>-i</literal></entry>
+ <entry>specify a file to include in a message composition</entry>
+ </row>
+ <row>
+ <entry><literal>-m</literal></entry>
+ <entry>specify a default mailbox type</entry>
+ </row>
+ <row>
+ <entry><literal>-n</literal></entry>
+ <entry>do not read the system Muttngrc</entry>
+ </row>
+ <row>
+ <entry><literal>-p</literal></entry>
+ <entry>recall a postponed message</entry>
+ </row>
+ <row>
+ <entry><literal>-Q</literal></entry>
+ <entry>query a configuration variable</entry>
+ </row>
+ <row>
+ <entry><literal>-R</literal></entry>
+ <entry>open mailbox in read-only mode</entry>
+ </row>
+ <row>
+ <entry><literal>-s</literal></entry>
+ <entry>specify a subject (enclose in quotes if it contains spaces)</entry>
+ </row>
+ <row>
+ <entry><literal>-t</literal></entry>
+ <entry>dump the value of all variables to stdout</entry>
+ </row>
+ <row>
+ <entry><literal>-T</literal></entry>
+ <entry>dump the value of all changed variables to stdout</entry>
+ </row>
+ <row>
+ <entry><literal>-v</literal></entry>
+ <entry>show version number and compile-time definitions</entry>
+ </row>
+ <row>
+ <entry><literal>-x</literal></entry>
+ <entry>simulate the mailx(1) compose mode</entry>
+ </row>
+ <row>
+ <entry><literal>-y</literal></entry>
+ <entry>show a menu containing the files specified by the mailboxes command</entry>
+ </row>
+ <row>
+ <entry><literal>-z</literal></entry>
+ <entry>exit immediately if there are no messages in the mailbox</entry>
+ </row>
+ <row>
+ <entry><literal>-Z</literal></entry>
+ <entry>open the first folder with new message,exit immediately if none</entry>
+ </row>
</tbody>
</tgroup>
</table>
</para>
<para>
- <literal>mutt</literal> [ -nz ] [ -F <emphasis>muttrc</emphasis> ] [ -m <emphasis>
+ <literal>mutt</literal> ] -nz [ ] -F <emphasis>muttrc</emphasis> [ ] -m <emphasis>
type
</emphasis>
- ] [ -f <emphasis>mailbox</emphasis> ]
+ [ ] -f <emphasis>mailbox</emphasis> [
</para>
<para>
</para>
<para>
- <literal>mutt</literal> [ -n ] [ -F <emphasis>muttrc</emphasis> ] [ -a <emphasis>
+ <literal>mutt</literal> ] -n [ ] -F <emphasis>muttrc</emphasis> [ ] -a <emphasis>
file
</emphasis>
- ] [ -c <emphasis>address</emphasis> ] [ -i <emphasis>
+ [ ] -c <emphasis>address</emphasis> [ ] -i <emphasis>
filename
</emphasis>
- ] [ -s <emphasis>subject</emphasis> ] <emphasis>address</emphasis> [ <emphasis>
+ [ ] -s <emphasis>subject</emphasis> [ <emphasis>address</emphasis> ] <emphasis>
address
</emphasis>
- ... ]
+ ... [
</para>
<para>
</para>
<para>
- <literal>mutt -s "data set for run #2"
+ <literal>mutt -s "data set for run #2"
professor@bigschool.edu
- < ˜/run2.dat
+ < ~/run2.dat
</literal>
</para>
<para>
This command will send a message to ``professor@bigschool.edu'' with a
subject
- of ``data set for run #2''. In the body of the message will be the
+ of ``data set for run #2''. In the body of the message will be the
contents
- of the file ``˜/run2.dat''.
+ of the file ``~/run2.dat''.
</para>
<para>
</row>
</thead>
<tbody>
- <row><entry><literal>~A </literal></entry><entry><literal></literal></entry><entry>all messages</entry></row>
- <row><entry><literal>~b </literal></entry><entry><literal>EXPR </literal></entry><entry>messages which contain EXPR in the message body</entry></row>
- <row><entry><literal>~B </literal></entry><entry><literal>EXPR </literal></entry><entry>messages which contain EXPR in the whole message</entry></row>
- <row><entry><literal>~c </literal></entry><entry><literal>EXPR </literal></entry><entry>messages carbon-copied to EXPR</entry></row>
- <row><entry><literal>~C </literal></entry><entry><literal>EXPR </literal></entry><entry>message is either to: or cc: EXPR</entry></row>
- <row><entry><literal>~D </literal></entry><entry><literal></literal></entry><entry>deleted messages</entry></row>
- <row><entry><literal>~d </literal></entry><entry><literal>[MIN]-[MAX] </literal></entry><entry>messages with ``date-sent'' in a Date range</entry></row>
- <row><entry><literal>~E </literal></entry><entry><literal></literal></entry><entry>expired messages</entry></row>
- <row><entry><literal>~e </literal></entry><entry><literal>EXPR </literal></entry><entry>message which contains EXPR in the ``Sender'' field</entry></row>
- <row><entry><literal>~F </literal></entry><entry><literal></literal></entry><entry>flagged messages</entry></row>
- <row><entry><literal>~f </literal></entry><entry><literal>EXPR </literal></entry><entry>messages originating from EXPR</entry></row>
- <row><entry><literal>~g </literal></entry><entry><literal></literal></entry><entry>cryptographically signed messages</entry></row>
- <row><entry><literal>~G </literal></entry><entry><literal></literal></entry><entry>cryptographically encrypted messages</entry></row>
- <row><entry><literal>~H </literal></entry><entry><literal>EXPR </literal></entry><entry>messages with a spam attribute matching EXPR</entry></row>
- <row><entry><literal>~h </literal></entry><entry><literal>EXPR </literal></entry><entry>messages which contain EXPR in the message header</entry></row>
- <row><entry><literal>~k </literal></entry><entry><literal></literal></entry><entry>message contains PGP key material</entry></row>
- <row><entry><literal>~i </literal></entry><entry><literal>EXPR </literal></entry><entry>message which match ID in the ``Message-ID'' field</entry></row>
- <row><entry><literal>~L </literal></entry><entry><literal>EXPR </literal></entry><entry>message is either originated or received by EXPR</entry></row>
- <row><entry><literal>~l </literal></entry><entry><literal></literal></entry><entry>message is addressed to a known mailing list</entry></row>
- <row><entry><literal>~m </literal></entry><entry><literal>[MIN]-[MAX] </literal></entry><entry>message in the range MIN to MAX *)</entry></row>
- <row><entry><literal>~M </literal></entry><entry><literal></literal></entry><entry>multipart messages</entry></row>
- <row><entry><literal>~n </literal></entry><entry><literal>[MIN]-[MAX] </literal></entry><entry>messages with a score in the range MIN to MAX *)</entry></row>
- <row><entry><literal>~N </literal></entry><entry><literal></literal></entry><entry>new messages</entry></row>
- <row><entry><literal>~O </literal></entry><entry><literal></literal></entry><entry>old messages</entry></row>
- <row><entry><literal>~p </literal></entry><entry><literal></literal></entry><entry>message is addressed to you (consults alternates)</entry></row>
- <row><entry><literal>~P </literal></entry><entry><literal></literal></entry><entry>message is from you (consults alternates)</entry></row>
- <row><entry><literal>~Q </literal></entry><entry><literal></literal></entry><entry>messages which have been replied to</entry></row>
- <row><entry><literal>~R </literal></entry><entry><literal></literal></entry><entry>read messages</entry></row>
- <row><entry><literal>~r </literal></entry><entry><literal>[MIN]-[MAX] </literal></entry><entry>messages with ``date-received'' in a Date range</entry></row>
- <row><entry><literal>~S </literal></entry><entry><literal></literal></entry><entry>superseded messages</entry></row>
- <row><entry><literal>~s </literal></entry><entry><literal>EXPR </literal></entry><entry>messages having EXPR in the ``Subject'' field.</entry></row>
- <row><entry><literal>~T </literal></entry><entry><literal></literal></entry><entry>tagged messages</entry></row>
- <row><entry><literal>~t </literal></entry><entry><literal>EXPR </literal></entry><entry>messages addressed to EXPR</entry></row>
- <row><entry><literal>~U </literal></entry><entry><literal></literal></entry><entry>unread messages</entry></row>
- <row><entry><literal>~u </literal></entry><entry><literal></literal></entry><entry>message is addressed to a subscribed mailing list</entry></row>
- <row><entry><literal>~v </literal></entry><entry><literal></literal></entry><entry>message is part of a collapsed thread.</entry></row>
- <row><entry><literal>~V </literal></entry><entry><literal></literal></entry><entry>cryptographically verified messages</entry></row>
- <row><entry><literal>~w </literal></entry><entry><literal>EXPR </literal></entry><entry>messages which contain EXPR in the `Newsgroups' field (if compiled with NNTP support)</entry></row>
- <row><entry><literal>~x </literal></entry><entry><literal>EXPR </literal></entry><entry>messages which contain EXPR in the `References' field</entry></row>
- <row><entry><literal>~y </literal></entry><entry><literal>EXPR </literal></entry><entry>messages which contain EXPR in the `X-Label' field</entry></row>
- <row><entry><literal>~z </literal></entry><entry><literal>[MIN]-[MAX] </literal></entry><entry>messages with a size in the range MIN to MAX *)</entry></row>
- <row><entry><literal>~= </literal></entry><entry><literal></literal></entry><entry>duplicated messages (see $duplicate_threads)</entry></row>
- <row><entry><literal>~$ </literal></entry><entry><literal></literal></entry><entry>unreferenced messages (requires threaded view)</entry></row>
- <row><entry><literal>~* </literal></entry><entry><literal></literal></entry><entry>``From'' contains realname and (syntactically) valid address (excluded are addresses matching against alternates or any alias)</entry></row>
+ <row>
+ <entry><muttng-doc:pattern name="A"/></entry>
+ <entry><literal></literal></entry>
+ <entry>all messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="b"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages which contain EXPR in the message body</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="B"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages which contain EXPR in the whole message</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="c"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages carbon-copied to EXPR</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="C"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>message is either to: or cc: EXPR</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="D"/></entry>
+ <entry><literal></literal></entry>
+ <entry>deleted messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="d"/></entry>
+ <entry><literal>[MIN]-[MAX]</literal></entry>
+ <entry>messages with ``date-sent'' in a Date range</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="E"/></entry>
+ <entry><literal></literal></entry>
+ <entry>expired messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="e"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>message which contains EXPR in the ``Sender'' field</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="F"/></entry>
+ <entry><literal></literal></entry>
+ <entry>flagged messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="f"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages originating from EXPR</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="g"/></entry>
+ <entry><literal></literal></entry>
+ <entry>cryptographically signed messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="G"/></entry>
+ <entry><literal></literal></entry>
+ <entry>cryptographically encrypted messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="H"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages with a spam attribute matching EXPR</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="h"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages which contain EXPR in the message header</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="k"/></entry>
+ <entry><literal></literal></entry>
+ <entry>message contains PGP key material</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="i"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>message which match ID in the ``Message-ID'' field</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="L"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>message is either originated or received by EXPR</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="l"/></entry>
+ <entry><literal></literal></entry>
+ <entry>message is addressed to a known mailing list</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="m"/></entry>
+ <entry><literal>[MIN]-[MAX]</literal></entry>
+ <entry>message in the range MIN to MAX *)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="M"/></entry>
+ <entry><literal></literal></entry>
+ <entry>multipart messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="n"/></entry>
+ <entry><literal>[MIN]-[MAX]</literal></entry>
+ <entry>messages with a score in the range MIN to MAX *)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="N"/></entry>
+ <entry><literal></literal></entry>
+ <entry>new messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="O"/></entry>
+ <entry><literal></literal></entry>
+ <entry>old messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="p"/></entry>
+ <entry><literal></literal></entry>
+ <entry>message is addressed to you (consults alternates)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="P"/></entry>
+ <entry><literal></literal></entry>
+ <entry>message is from you (consults alternates)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="Q"/></entry>
+ <entry><literal></literal></entry>
+ <entry>messages which have been replied to</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="R"/></entry>
+ <entry><literal></literal></entry>
+ <entry>read messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="r"/></entry>
+ <entry><literal>[MIN]-[MAX]</literal></entry>
+ <entry>messages with ``date-received'' in a Date range</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="S"/></entry>
+ <entry><literal></literal></entry>
+ <entry>superseded messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="s"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages having EXPR in the ``Subject'' field.</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="T"/></entry>
+ <entry><literal></literal></entry>
+ <entry>tagged messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="t"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages addressed to EXPR</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="U"/></entry>
+ <entry><literal></literal></entry>
+ <entry>unread messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="u"/></entry>
+ <entry><literal></literal></entry>
+ <entry>message is addressed to a subscribed mailing list</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="v"/></entry>
+ <entry><literal></literal></entry>
+ <entry>message is part of a collapsed thread.</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="V"/></entry>
+ <entry><literal></literal></entry>
+ <entry>cryptographically verified messages</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="w"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages which contain EXPR in the `Newsgroups' field (if compiled with NNTP support)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="x"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages which contain EXPR in the `References' field</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="y"/></entry>
+ <entry><literal>EXPR</literal></entry>
+ <entry>messages which contain EXPR in the `X-Label' field</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="z"/></entry>
+ <entry><literal>[MIN]-[MAX]</literal></entry>
+ <entry>messages with a size in the range MIN to MAX *)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="="/></entry>
+ <entry><literal></literal></entry>
+ <entry>duplicated messages (see $duplicate_threads)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="$"/></entry>
+ <entry><literal></literal></entry>
+ <entry>unreferenced messages (requires threaded view)</entry>
+ </row>
+ <row>
+ <entry><muttng-doc:pattern name="*"/></entry>
+ <entry><literal></literal></entry>
+ <entry>``From'' contains realname and (syntactically) valid address
+ (excluded are addresses matching against alternates or any alias)</entry>
+ </row>
</tbody>
</tgroup>
</table>
</para>
<para>
- *) The forms <literal><[MAX]</literal>, <literal>
- >[MIN]
+ *) The forms <literal><]MAX[</literal>, <literal>
+ >]MIN[
</literal>
,
- <literal>[MIN]-</literal> and <literal>-[MAX]</literal>
+ <literal>]MIN[-</literal> and <literal>-]MAX[</literal>
are allowed, too.
</para>
<para>
<literal>
- <link linkend="account-hook">account-hook</link>
+ <muttng-doc:hook name="account"/>
</literal>
<emphasis>pattern</emphasis> <emphasis>command</emphasis>
</para>
<literal>
<link linkend="alias">alias</link>
</literal>
- <emphasis>key</emphasis> <emphasis>address</emphasis> [ , <emphasis>
+ <emphasis>key</emphasis> <emphasis>address</emphasis> ] , <emphasis>
address
</emphasis>
- ,... ]
+ ,... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="alias">alias</link>
</literal>
- [ * | <emphasis>key</emphasis> ... ]
+ ] * | <emphasis>key</emphasis> ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="alternates">alternates</link>
</literal>
- <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>
- ... ]
+ <emphasis>regexp</emphasis> ] <emphasis>regexp</emphasis>
+ ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="alternates">alternates</link>
</literal>
- [ * | <emphasis>regexp</emphasis> ... ]
+ ] * | <emphasis>regexp</emphasis> ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="alternative-order">alternative-order</link>
</literal>
- <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <emphasis>mimetype</emphasis> ] <emphasis>mimetype</emphasis> ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="alternative-order">alternative-order</link>
</literal>
- <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <emphasis>mimetype</emphasis> ] <emphasis>mimetype</emphasis> ... [
</para>
</listitem>
<listitem>
<para>
<literal>
- <link linkend="append-hook">append-hook</link>
+ <muttng-doc:hook name="append"/>
</literal>
<emphasis>regexp</emphasis> <emphasis>command</emphasis>
</para>
<literal>
<link linkend="auto-view">auto-view</link>
</literal>
- <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <emphasis>mimetype</emphasis> ] <emphasis>mimetype</emphasis> ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="auto-view">auto-view</link>
</literal>
- <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <emphasis>mimetype</emphasis> ] <emphasis>mimetype</emphasis> ... [
</para>
</listitem>
<listitem>
<para>
<literal>
- <link linkend="charset-hook">charset-hook</link>
+ <muttng-doc:hook name="charset"/>
</literal>
<emphasis>alias</emphasis> <emphasis>charset</emphasis>
</para>
<para>
<literal>
- <link linkend="close-hook">close-hook</link>
+ <muttng-doc:hook name="close"/>
</literal>
<emphasis>regexp</emphasis> <emphasis>command</emphasis>
</para>
<emphasis>object</emphasis> <emphasis>foreground</emphasis> <emphasis>
background
</emphasis>
- [ <emphasis>regexp</emphasis> ]
+ ] <emphasis>regexp</emphasis> [
</para>
</listitem>
<listitem>
<literal>
<link linkend="color">color</link>
</literal>
- <emphasis>index</emphasis> <emphasis>pattern</emphasis> [ <emphasis>
+ <emphasis>index</emphasis> <emphasis>pattern</emphasis> ] <emphasis>
pattern
</emphasis>
- ... ]
+ ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="exec">exec</link>
</literal>
- <emphasis>function</emphasis> [ <emphasis>function</emphasis> ... ]
+ <emphasis>function</emphasis> ] <emphasis>function</emphasis> ... [
</para>
</listitem>
<listitem>
<para>
<literal>
- <link linkend="fcc-hook">fcc-hook</link>
+ <muttng-doc:hook name="fcc"/>
</literal>
<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
</para>
<para>
<literal>
- <link linkend="fcc-save-hook">fcc-save-hook</link>
+ <muttng-doc:hook name="fcc-save"/>
</literal>
<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
</para>
<para>
<literal>
- <link linkend="folder-hook">folder-hook</link>
+ <muttng-doc:hook name="folder"/>
</literal>
<emphasis>pattern</emphasis> <emphasis>command</emphasis>
</para>
<literal>
<link linkend="hdr-order">hdr-order</link>
</literal>
- <emphasis>header</emphasis> [ <emphasis>header</emphasis>
- ... ]
+ <emphasis>header</emphasis> ] <emphasis>header</emphasis>
+ ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="hdr-order">hdr-order</link>
</literal>
- <emphasis>header</emphasis> [ <emphasis>header</emphasis>
- ... ]
+ <emphasis>header</emphasis> ] <emphasis>header</emphasis>
+ ... [
</para>
</listitem>
<listitem>
<para>
<literal>
- <link linkend="charset-hook">charset-hook</link>
+ <muttng-doc:hook name="charset"/>
</literal>
<emphasis>charset</emphasis> <emphasis>local-charset</emphasis>
</para>
<literal>
<link linkend="ignore">ignore</link>
</literal>
- <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis>
- ... ]
+ <emphasis>pattern</emphasis> ] <emphasis>pattern</emphasis>
+ ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="ignore">ignore</link>
</literal>
- <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis>
- ... ]
+ <emphasis>pattern</emphasis> ] <emphasis>pattern</emphasis>
+ ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="lists">lists</link>
</literal>
- <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>
- ... ]
+ <emphasis>regexp</emphasis> ] <emphasis>regexp</emphasis>
+ ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="lists">lists</link>
</literal>
- <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>
- ... ]
+ <emphasis>regexp</emphasis> ] <emphasis>regexp</emphasis>
+ ... [
</para>
</listitem>
<listitem>
<emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>
sequence
</emphasis>
- [ <emphasis>description</emphasis> ]
+ ] <emphasis>description</emphasis> [
</para>
</listitem>
<listitem>
<literal>
<link linkend="mailboxes">mailboxes</link>
</literal>
- <emphasis>filename</emphasis> [ <emphasis>filename</emphasis> ... ]
+ <emphasis>filename</emphasis> ] <emphasis>filename</emphasis> ... [
</para>
</listitem>
<listitem>
<para>
<literal>
- <link linkend="mbox-hook">mbox-hook</link>
+ <muttng-doc:hook name="mbox"/>
</literal>
<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
</para>
<para>
<literal>
- <link linkend="message-hook">message-hook</link>
+ <muttng-doc:hook name="message"/>
</literal>
<emphasis>pattern</emphasis> <emphasis>command</emphasis>
</para>
<literal>
<link linkend="mime-lookup">mime-lookup</link>
</literal>
- <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <emphasis>mimetype</emphasis> ] <emphasis>mimetype</emphasis> ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="mime-lookup">mime-lookup</link>
</literal>
- <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <emphasis>mimetype</emphasis> ] <emphasis>mimetype</emphasis> ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="color">color</link>
</literal>
- <emphasis>object attribute</emphasis> [ <emphasis>regexp</emphasis> ]
+ <emphasis>object attribute</emphasis> ] <emphasis>regexp</emphasis> [
</para>
</listitem>
<listitem>
<literal>
<link linkend="color">color</link>
</literal>
- <emphasis>index</emphasis> <emphasis>pattern</emphasis> [ <emphasis>
+ <emphasis>index</emphasis> <emphasis>pattern</emphasis> ] <emphasis>
pattern
</emphasis>
- ... ]
+ ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="my-hdr">my-hdr</link>
</literal>
- <emphasis>field</emphasis> [ <emphasis>field</emphasis> ...
- ]
+ <emphasis>field</emphasis> ] <emphasis>field</emphasis> ...
+ [
</para>
</listitem>
<listitem>
<para>
<literal>
- <link linkend="open-hook">open-hook</link>
+ <muttng-doc:hook name="open"/>
</literal>
<emphasis>regexp</emphasis> <emphasis>command</emphasis>
</para>
<para>
<literal>
- <link linkend="crypt-hook">crypt-hook</link>
+ <muttng-doc:hook name="crypt"/>
</literal>
<emphasis>pattern</emphasis> <emphasis>key-id</emphasis>
</para>
<literal>
<link linkend="set">set</link>
</literal>
- <emphasis>variable</emphasis> [<emphasis>variable</emphasis>
- ... ]
+ <emphasis>variable</emphasis> ]<emphasis>variable</emphasis>
+ ... [
</para>
</listitem>
<listitem>
<para>
<literal>
- <link linkend="save-hook">save-hook</link>
+ <muttng-doc:hook name="save"/>
</literal>
<emphasis>regexp</emphasis> <emphasis>filename</emphasis>
</para>
<literal>
<link linkend="score-command">score-command</link>
</literal>
- <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis>
- ... ]
+ <emphasis>pattern</emphasis> ] <emphasis>pattern</emphasis>
+ ... [
</para>
</listitem>
<listitem>
<para>
<literal>
- <link linkend="send-hook">send-hook</link>
+ <muttng-doc:hook name="send"/>
</literal>
<emphasis>regexp</emphasis> <emphasis>command</emphasis>
</para>
<para>
<literal>
- <link linkend="reply-hook">reply-hook</link>
+ <muttng-doc:hook name="reply"/>
</literal>
<emphasis>regexp</emphasis> <emphasis>command</emphasis>
</para>
<literal>
<link linkend="set">set</link>
</literal>
- [no|inv]<emphasis>variable</emphasis>[=<emphasis>
+ ]no|inv[<emphasis>variable</emphasis>]=<emphasis>
value
</emphasis>
- ] [ <emphasis>variable</emphasis> ... ]
+ [ ] <emphasis>variable</emphasis> ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="set">set</link>
</literal>
- <emphasis>variable</emphasis> [<emphasis>variable</emphasis>
- ... ]
+ <emphasis>variable</emphasis> ]<emphasis>variable</emphasis>
+ ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="lists">lists</link>
</literal>
- <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>
- ... ]
+ <emphasis>regexp</emphasis> ] <emphasis>regexp</emphasis>
+ ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="lists">lists</link>
</literal>
- <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>
- ... ]
+ <emphasis>regexp</emphasis> ] <emphasis>regexp</emphasis>
+ ... [
</para>
</listitem>
<listitem>
<literal>
<link linkend="set">set</link>
</literal>
- <emphasis>variable</emphasis> [<emphasis>variable</emphasis>
- ... ]
+ <emphasis>variable</emphasis> ]<emphasis>variable</emphasis>
+ ... [
</para>
</listitem>
<listitem>
</row>
</thead>
<tbody>
- <row><entry><literal>edit_hdrs</literal></entry><entry><literal>edit_headers</literal></entry></row>
- <row><entry><literal>forw_decode</literal></entry><entry><literal>forward_decode</literal></entry></row>
- <row><entry><literal>forw_format</literal></entry><entry><literal>forward_format</literal></entry></row>
- <row><entry><literal>forw_quote</literal></entry><entry><literal>forward_quote</literal></entry></row>
- <row><entry><literal>hdr_format</literal></entry><entry><literal>index_format</literal></entry></row>
- <row><entry><literal>indent_str</literal></entry><entry><literal>indent_string</literal></entry></row>
- <row><entry><literal>mime_fwd</literal></entry><entry><literal>mime_forward</literal></entry></row>
- <row><entry><literal>msg_format</literal></entry><entry><literal>message_format</literal></entry></row>
- <row><entry><literal>pgp_autosign</literal></entry><entry><literal>crypt_autosign</literal></entry></row>
- <row><entry><literal>pgp_autoencrypt</literal></entry><entry><literal>crypt_autoencrypt</literal></entry></row>
- <row><entry><literal>pgp_replyencrypt</literal></entry><entry><literal>crypt_replyencrypt</literal></entry></row>
- <row><entry><literal>pgp_replysign</literal></entry><entry><literal>crypt_replysign</literal></entry></row>
- <row><entry><literal>pgp_replysignencrypted</literal></entry><entry><literal>crypt_replysignencrypted</literal></entry></row>
- <row><entry><literal>pgp_verify_sig</literal></entry><entry><literal>crypt_verify_sig</literal></entry></row>
- <row><entry><literal>pgp_create_traditional</literal></entry><entry><literal>pgp_autoinline</literal></entry></row>
- <row><entry><literal>pgp_auto_traditional</literal></entry><entry><literal>pgp_replyinline</literal></entry></row>
- <row><entry><literal>forw_decrypt</literal></entry><entry><literal>forward_decrypt</literal></entry></row>
- <row><entry><literal>smime_sign_as</literal></entry><entry><literal>smime_default_key</literal></entry></row>
- <row><entry><literal>post_indent_str</literal></entry><entry><literal>post_indent_string</literal></entry></row>
- <row><entry><literal>print_cmd</literal></entry><entry><literal>print_command</literal></entry></row>
- <row><entry><literal>shorten_hierarchy</literal></entry><entry><literal>sidebar_shorten_hierarchy</literal></entry></row>
- <row><entry><literal>ask_followup_to</literal></entry><entry><literal>nntp_ask_followup_to</literal></entry></row>
- <row><entry><literal>ask_x_comment_to</literal></entry><entry><literal>nntp_ask_x_comment_to</literal></entry></row>
- <row><entry><literal>catchup_newsgroup</literal></entry><entry><literal>nntp_catchup</literal></entry></row>
- <row><entry><literal>followup_to_poster</literal></entry><entry><literal>nntp_followup_to_poster</literal></entry></row>
- <row><entry><literal>group_index_format</literal></entry><entry><literal>nntp_group_index_format</literal></entry></row>
- <row><entry><literal>inews</literal></entry><entry><literal>nntp_inews</literal></entry></row>
- <row><entry><literal>mime_subject</literal></entry><entry><literal>nntp_mime_subject</literal></entry></row>
- <row><entry><literal>news_cache_dir</literal></entry><entry><literal>nntp_cache_dir</literal></entry></row>
- <row><entry><literal>news_server</literal></entry><entry><literal>nntp_host</literal></entry></row>
- <row><entry><literal>newsrc</literal></entry><entry><literal>nntp_newsrc</literal></entry></row>
- <row><entry><literal>nntp_poll</literal></entry><entry><literal>nntp_mail_check</literal></entry></row>
- <row><entry><literal>pop_checkinterval</literal></entry><entry><literal>pop_mail_check</literal></entry></row>
- <row><entry><literal>post_moderated</literal></entry><entry><literal>nntp_post_moderated</literal></entry></row>
- <row><entry><literal>save_unsubscribed</literal></entry><entry><literal>nntp_save_unsubscribed</literal></entry></row>
- <row><entry><literal>show_new_news</literal></entry><entry><literal>nntp_show_new_news</literal></entry></row>
- <row><entry><literal>show_only_unread</literal></entry><entry><literal>nntp_show_only_unread</literal></entry></row>
- <row><entry><literal>x_comment_to</literal></entry><entry><literal>nntp_x_comment_to</literal></entry></row>
- <row><entry><literal>smtp_auth_username</literal></entry><entry><literal>smtp_user</literal></entry></row>
- <row><entry><literal>smtp_auth_password</literal></entry><entry><literal>smtp_pass</literal></entry></row>
- <row><entry><literal>user_agent</literal></entry><entry><literal>agent_string</literal></entry></row>
+ <row>
+ <entry><literal>edit_hdrs</literal></entry>
+ <entry><muttng-doc:varref name="edit_headers" link="edit-headers"/></entry>
+ </row>
+ <row>
+ <entry><literal>forw_decode</literal></entry>
+ <entry><muttng-doc:varref name="forward_decode" link="forward-decode"/></entry>
+ </row>
+ <row>
+ <entry><literal>forw_format</literal></entry>
+ <entry><muttng-doc:varref name="forward_format" link="forward-format"/></entry>
+ </row>
+ <row>
+ <entry><literal>forw_quote</literal></entry>
+ <entry><muttng-doc:varref name="forward_quote" link="forward-quote"/></entry>
+ </row>
+ <row>
+ <entry><literal>hdr_format</literal></entry>
+ <entry><muttng-doc:varref name="index_format" link="index-format"/></entry>
+ </row>
+ <row>
+ <entry><literal>indent_str</literal></entry>
+ <entry><muttng-doc:varref name="indent_string" link="indent-string"/></entry>
+ </row>
+ <row>
+ <entry><literal>mime_fwd</literal></entry>
+ <entry><muttng-doc:varref name="mime_forward" link="mime-forward"/></entry>
+ </row>
+ <row>
+ <entry><literal>msg_format</literal></entry>
+ <entry><muttng-doc:varref name="message_format" link="message-format"/></entry>
+ </row>
+ <row>
+ <entry><literal>pgp_autosign</literal></entry>
+ <entry><muttng-doc:varref name="crypt_autosign" link="crypt-autosign"/></entry>
+ </row>
+ <row>
+ <entry><literal>pgp_autoencrypt</literal></entry>
+ <entry><muttng-doc:varref name="crypt_autoencrypt" link="crypt-autoencrypt"/></entry>
+ </row>
+ <row>
+ <entry><literal>pgp_replyencrypt</literal></entry>
+ <entry><muttng-doc:varref name="crypt_replyencrypt" link="crypt-replyencrypt"/></entry>
+ </row>
+ <row>
+ <entry><literal>pgp_replysign</literal></entry>
+ <entry><muttng-doc:varref name="crypt_replysign" link="crypt-replysign"/></entry>
+ </row>
+ <row>
+ <entry><literal>pgp_replysignencrypted</literal></entry>
+ <entry><muttng-doc:varref name="crypt-replysignencrypted" link="crypt_replysignencrypted"/></entry>
+ </row>
+ <row>
+ <entry><literal>pgp_verify_sig</literal></entry>
+ <entry><muttng-doc:varref name="crypt_verify_sig" link="crypt-verify-sig"/></entry>
+ </row>
+ <row>
+ <entry><literal>pgp_create_traditional</literal></entry>
+ <entry><muttng-doc:varref name="pgp_autoinline" link="pgp-autoinline"/></entry>
+ </row>
+ <row>
+ <entry><literal>pgp_auto_traditional</literal></entry>
+ <entry><muttng-doc:varref name="pgp_replyinline" link="pgp-replyinline"/></entry>
+ </row>
+ <row>
+ <entry><literal>forw_decrypt</literal></entry>
+ <entry><muttng-doc:varref name="forward_decrypt" link="forward-decrypt"/></entry>
+ </row>
+ <row>
+ <entry><literal>smime_sign_as</literal></entry>
+ <entry><muttng-doc:varref name="smime_default_key" link="smime-default-key"/></entry>
+ </row>
+ <row>
+ <entry><literal>post_indent_str</literal></entry>
+ <entry><muttng-doc:varref name="post_indent_string" link="post-indent-string"/></entry>
+ </row>
+ <row>
+ <entry><literal>print_cmd</literal></entry>
+ <entry><muttng-doc:varref name="print_command" link="print-command"/></entry>
+ </row>
+ <row>
+ <entry><literal>shorten_hierarchy</literal></entry>
+ <entry><muttng-doc:varref name="sidebar-shorten-hierarchy" link="sidebar_shorten_hierarchy"/></entry>
+ </row>
+ <row>
+ <entry><literal>ask_followup_to</literal></entry>
+ <entry><muttng-doc:varref name="nntp_ask_followup_to" link="nntp-ask-followup-to"/></entry>
+ </row>
+ <row>
+ <entry><literal>ask_x_comment_to</literal></entry>
+ <entry><muttng-doc:varref name="nntp_ask_x_comment_to" link="nntp-ask-x-comment-to"/></entry>
+ </row>
+ <row>
+ <entry><literal>catchup_newsgroup</literal></entry>
+ <entry><muttng-doc:varref name="nntp_catchup" link="nntp-catchup"/></entry>
+ </row>
+ <row>
+ <entry><literal>followup_to_poster</literal></entry>
+ <entry><muttng-doc:varref name="nntp_followup_to_poster" link="nntp-followup-to-poster"/></entry>
+ </row>
+ <row>
+ <entry><literal>group_index_format</literal></entry>
+ <entry><muttng-doc:varref name="nntp_group_index_format" link="nntp-group-index-format"/></entry>
+ </row>
+ <row>
+ <entry><literal>inews</literal></entry>
+ <entry><muttng-doc:varref name="nntp_inews" link="nntp-inews"/></entry>
+ </row>
+ <row>
+ <entry><literal>mime_subject</literal></entry>
+ <entry><muttng-doc:varref name="nntp_mime_subject" link="nntp-mime-subject"/></entry>
+ </row>
+ <row>
+ <entry><literal>news_cache_dir</literal></entry>
+ <entry><muttng-doc:varref name="nntp_cache_dir" link="nntp-cache-dir"/></entry>
+ </row>
+ <row>
+ <entry><literal>news_server</literal></entry>
+ <entry><muttng-doc:varref name="nntp_host" link="nntp-host"/></entry>
+ </row>
+ <row>
+ <entry><literal>newsrc</literal></entry>
+ <entry><muttng-doc:varref name="nntp_newsrc" link="nntp-newsrc"/></entry>
+ </row>
+ <row>
+ <entry><literal>nntp_poll</literal></entry>
+ <entry><muttng-doc:varref name="nntp_mail_check" link="nntp-mail-check"/></entry>
+ </row>
+ <row>
+ <entry><literal>pop_checkinterval</literal></entry>
+ <entry><muttng-doc:varref name="pop_mail_check" link="pop-mail-check"/></entry>
+ </row>
+ <row>
+ <entry><literal>post_moderated</literal></entry>
+ <entry><muttng-doc:varref name="nntp_post_moderated" link="nntp-post-moderated"/></entry>
+ </row>
+ <row>
+ <entry><literal>save_unsubscribed</literal></entry>
+ <entry><muttng-doc:varref name="nntp_save_unsubscribed" link="nntp-save-unsubscribed"/></entry>
+ </row>
+ <row>
+ <entry><literal>show_new_news</literal></entry>
+ <entry><muttng-doc:varref name="nntp_show_new_news" link="nntp-show-new-news"/></entry>
+ </row>
+ <row>
+ <entry><literal>show_only_unread</literal></entry>
+ <entry><muttng-doc:varref name="nntp_show_only_unread" link="nntp-show-only-unread"/></entry>
+ </row>
+ <row>
+ <entry><literal>x_comment_to</literal></entry>
+ <entry><muttng-doc:varref name="nntp_x_comment_to" link="nntp-x-comment-to"/></entry>
+ </row>
+ <row>
+ <entry><literal>smtp_auth_username</literal></entry>
+ <entry><muttng-doc:varref name="smtp_user" link="smtp-user"/></entry>
+ </row>
+ <row>
+ <entry><literal>smtp_auth_password</literal></entry>
+ <entry><muttng-doc:varref name="smtp_pass" link="smtp-pass"/></entry>
+ </row>
+ <row>
+ <entry><literal>user_agent</literal></entry>
+ <entry><muttng-doc:varref name="agent_string" link="agent-string"/></entry>
+ </row>
</tbody>
</tgroup>
</table>
projects / apps / madmutt.git / commitdiff