<para>
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
</para>
</sect1>
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>
+ are upper-case only. <muttng-doc:varref
+ name="imap-mail-check"/> is a configuration variable while
+ <muttng-doc:envvar name="EDITOR"/> is an environment
+ variable.</para>
</listitem>
<listitem>
- <para>Muttng-specific commands are enclosed in
+ <para>Muttng-specific functions are enclosed in
<literal><></literal> and printed in a typewriter font,
- too.</para>
+ too, as in <muttng-doc:funcref name="sync-mailbox"/>.</para>
</listitem>
<listitem>
<para>As common for UNIX-like environments, references to
name="muttngrc" sect="5"/>. Execute <literal>man [section]
[name]</literal> to view the manual page.</para>
</listitem>
+ <listitem>
+ <para>Keys are presented in the following way: ordinary keys
+ are just given as-is, e.g.
+ <muttng-doc:key>q</muttng-doc:key>. Control characters are
+ prefixed with <literal>C-</literal> (e.g. the screen can be
+ redraw by pressing <muttng-doc:key
+ mod="C">L</muttng-doc:key>) and <literal>E-</literal> for
+ Escape, e.g. a folder can be opened read-only with
+ <muttng-doc:key mod="E">c</muttng-doc:key>.
+ </para>
+ </listitem>
</itemizedlist>
</para>
<para>
- <table frame="none" rowsep="1">
+ <table frame="none" rowsep="1" texstr="l|l|l">
<title>Most commonly used movement bindings</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
</thead>
<tbody>
<row>
- <entry><literal>j</literal> or <literal>Down</literal></entry>
+ <entry><muttng-doc:key>j</muttng-doc:key> or <muttng-doc:key>Down</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="next-entry"/></entry>
<entry>move to the next entry</entry>
</row>
<row>
- <entry><literal>k</literal> or <literal>Up</literal></entry>
+ <entry><muttng-doc:key>k</muttng-doc:key> or <muttng-doc:key>Up</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="previous-entry"/></entry>
<entry>move to the previous entry</entry>
</row>
<row>
- <entry><literal>z</literal> or <literal>PageDn</literal></entry>
+ <entry><muttng-doc:key>z</muttng-doc:key> or <muttng-doc:key>PageDn</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="page-down"/></entry>
<entry>go to the next page</entry>
</row>
<row>
- <entry><literal>Z</literal> or <literal>PageUp</literal></entry>
+ <entry><muttng-doc:key>Z</muttng-doc:key> or <muttng-doc:key>PageUp</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="page-up"/></entry>
<entry>go to the previous page</entry>
</row>
<row>
- <entry><literal>=</literal> or <literal>Home</literal></entry>
+ <entry><muttng-doc:key>=</muttng-doc:key> or <muttng-doc:key>Home</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="first-entry"/></entry>
<entry>jump to the first entry</entry>
</row>
<row>
- <entry><literal>*</literal> or <literal>End</literal></entry>
+ <entry><muttng-doc:key>*</muttng-doc:key> or <muttng-doc:key>End</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="last-entry"/></entry>
<entry>jump to the last entry</entry>
</row>
<row>
- <entry><literal>q</literal></entry>
+ <entry><muttng-doc:key>q</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="quit"/></entry>
<entry>exit the current menu</entry>
</row>
<row>
- <entry><literal>?</literal></entry>
+ <entry><muttng-doc:key>?</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="help"/></entry>
<entry>list all key bindings for the current menu</entry>
</row>
<para>
- <table frame="none" rowsep="1">
+ <table frame="none" rowsep="1" texstr="l|l|l">
<title>Line Editor Functions</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
</thead>
<tbody>
<row>
- <entry><literal>^A or <Home> </literal></entry>
+ <entry><muttng-doc:key mod="C">A</muttng-doc:key> or <muttng-doc:key>Home</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="bol"/></entry>
<entry>move to the start of the line</entry>
</row>
<row>
- <entry><literal>^B or <Left> </literal></entry>
+ <entry><muttng-doc:key mod="C">B</muttng-doc:key> or <muttng-doc:key>Left</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="backward-char"/>
</entry><entry>move back one char</entry>
</row>
<row>
- <entry><literal>Esc B </literal></entry>
+ <entry><muttng-doc:key mod="E">B</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="backward-word"/></entry>
<entry>move back one word</entry>
</row>
<row>
- <entry><literal>^D or <Delete> </literal></entry>
+ <entry><muttng-doc:key mod="C">D</muttng-doc:key> or <muttng-doc:key>Delete</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="delete-char"/></entry>
<entry>delete the char under the cursor</entry>
</row>
<row>
- <entry><literal>^E or <End> </literal></entry>
+ <entry><muttng-doc:key mod="C">E</muttng-doc:key> or <muttng-doc:key>End</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="eol"/></entry>
<entry>move to the end of the line</entry>
</row>
<row>
- <entry><literal>^F or <Right> </literal></entry>
+ <entry><muttng-doc:key mod="C">F</muttng-doc:key> or <muttng-doc:key>Right</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="forward-char"/></entry>
<entry>move forward one char</entry>
</row>
<row>
- <entry><literal>Esc F </literal></entry>
+ <entry><muttng-doc:key mod="E">F</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="forward-word"/></entry>
<entry>move forward one word</entry>
</row>
<row>
- <entry><literal><Tab></literal></entry>
+ <entry><muttng-doc:key>Tab</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="complete"/></entry>
<entry>complete filename or alias</entry>
</row>
<row>
- <entry><literal>^T</literal></entry>
+ <entry><muttng-doc:key mod="C">T</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="complete-query"/></entry>
<entry>complete address with query</entry>
</row>
<row>
- <entry><literal>^K</literal></entry>
+ <entry><muttng-doc:key mod="C">K</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="kill-eol"/></entry>
<entry>delete to the end of the line</entry>
</row>
<row>
- <entry><literal>ESC d </literal></entry>
+ <entry><muttng-doc:key mod="E">d</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="kill-eow"/></entry>
<entry>delete to the end of the word</entry>
</row>
<row>
- <entry><literal>^W</literal></entry>
+ <entry><muttng-doc:key mod="C">W</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="kill-word"/></entry>
<entry>kill the word in front of the cursor</entry>
</row>
<row>
- <entry><literal>^U</literal></entry>
+ <entry><muttng-doc:key mod="C">U</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="kill-line"/></entry>
<entry>delete entire line</entry>
</row>
<row>
- <entry><literal>^V</literal></entry>
+ <entry><muttng-doc:key mod="C">V</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="quote-char"/></entry>
<entry>quote the next typed key</entry>
</row>
<row>
- <entry><literal><Up></literal></entry>
+ <entry><muttng-doc:key>Up</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="history-up"/></entry>
<entry>recall previous string from history</entry>
</row>
<row>
- <entry><literal><Down></literal></entry>
+ <entry><muttng-doc:key>Down</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="history-down"/></entry>
<entry>recall next string from history</entry>
</row>
<row>
- <entry><literal><BackSpace></literal></entry>
+ <entry><muttng-doc:key>BackSpace</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="backspace"/></entry>
<entry>kill the char in front of the cursor</entry>
</row>
<row>
- <entry><literal>Esc u </literal></entry>
+ <entry><muttng-doc:key mod="E">u</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="upcase-word"/></entry>
<entry>convert word to upper case</entry>
</row>
<row>
- <entry><literal>Esc l </literal></entry>
+ <entry><muttng-doc:key mod="E">l</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="downcase-word"/></entry>
<entry>convert word to lower case</entry>
</row>
<row>
- <entry><literal>Esc c </literal></entry>
+ <entry><muttng-doc:key mod="E">c</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="capitalize-word"/></entry>
<entry>capitalize the word</entry>
</row>
<row>
- <entry><literal>^G</literal></entry>
- <entry><literal>n/a</literal></entry>
+ <entry><muttng-doc:key mod="C">G</muttng-doc:key></entry>
+ <entry></entry>
<entry>abort</entry>
</row>
<row>
- <entry><literal><Return></literal></entry>
- <entry><literal>n/a</literal></entry>
+ <entry><muttng-doc:key>Return</muttng-doc:key></entry>
+ <entry></entry>
<entry>finish editing</entry>
</row>
</tbody>
<para>
You can remap the <emphasis>editor</emphasis> functions using the
- <muttng-doc:command name="bind"/> command. For example, to make
+ <muttng-doc:cmdref name="bind"/> command. For example, to make
the <emphasis>Delete</emphasis> key delete the character in front
of the cursor rather than under, you could use
</para>
<para>
- <table frame="none" rowsep="1">
+ <table frame="none" rowsep="1" texstr="l|l|l">
<title>Most commonly used Index Bindings</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
</thead>
<tbody>
<row>
- <entry><literal>c</literal></entry>
+ <entry><muttng-doc:key>c</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>change to a different mailbox</entry>
</row>
<row>
- <entry><literal>ESC c </literal></entry>
+ <entry><muttng-doc:key mod="E">c</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>change to a folder in read-only mode</entry>
</row>
<row>
- <entry><literal>C</literal></entry>
+ <entry><muttng-doc:key>C</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>copy the current message to another mailbox</entry>
</row>
<row>
- <entry><literal>ESC C </literal></entry>
+ <entry><muttng-doc:key mod="E">C</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>decode a message and copy it to a folder</entry>
</row>
<row>
- <entry><literal>ESC s </literal></entry>
+ <entry><muttng-doc:key mod="E">s</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>decode a message and save it to a folder</entry>
</row>
<row>
- <entry><literal>D</literal></entry>
+ <entry><muttng-doc:key>D</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>delete messages matching a pattern</entry>
</row>
<row>
- <entry><literal>d</literal></entry>
+ <entry><muttng-doc:key>d</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>delete the current message</entry>
</row>
<row>
- <entry><literal>F</literal></entry>
+ <entry><muttng-doc:key>F</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>mark as important</entry>
</row>
<row>
- <entry><literal>l</literal></entry>
+ <entry><muttng-doc:key>l</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>show messages matching a pattern</entry>
</row>
<row>
- <entry><literal>N</literal></entry>
+ <entry><muttng-doc:key>N</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>mark message as new</entry>
</row>
<row>
- <entry><literal>o</literal></entry>
+ <entry><muttng-doc:key>o</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>change the current sort method</entry>
</row>
<row>
- <entry><literal>O</literal></entry>
+ <entry><muttng-doc:key>O</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>reverse sort the mailbox</entry>
</row>
<row>
- <entry><literal>q</literal></entry>
+ <entry><muttng-doc:key>q</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>save changes and exit</entry>
</row>
<row>
- <entry><literal>s</literal></entry>
+ <entry><muttng-doc:key>s</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>save-message</entry>
</row>
<row>
- <entry><literal>T</literal></entry>
+ <entry><muttng-doc:key>T</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>tag messages matching a pattern</entry>
</row>
<row>
- <entry><literal>t</literal></entry>
+ <entry><muttng-doc:key>t</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>toggle the tag on a message</entry>
</row>
<row>
- <entry><literal>ESC t </literal></entry>
+ <entry><muttng-doc:key mod="E">t</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>toggle tag on entire message thread</entry>
</row>
<row>
- <entry><literal>U</literal></entry>
+ <entry><muttng-doc:key>U</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>undelete messages matching a pattern</entry>
</row>
<row>
- <entry><literal>u</literal></entry>
+ <entry><muttng-doc:key>u</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>undelete-message</entry>
</row>
<row>
- <entry><literal>v</literal></entry>
+ <entry><muttng-doc:key>v</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>view-attachments</entry>
</row>
<row>
- <entry><literal>x</literal></entry>
+ <entry><muttng-doc:key>x</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>abort changes and exit</entry>
</row>
<row>
- <entry><literal><Return></literal></entry>
+ <entry><muttng-doc:key>Return</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>display-message</entry>
</row>
<row>
- <entry><literal><Tab></literal></entry>
+ <entry><muttng-doc:key>Tab</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>jump to the next new or unread message</entry>
</row>
<row>
- <entry><literal>@</literal></entry>
+ <entry><muttng-doc:key>@</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>show the author's full e-mail address</entry>
</row>
<row>
- <entry><literal>$</literal></entry>
+ <entry><muttng-doc:key>$</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>save changes to mailbox</entry>
</row>
<row>
- <entry><literal>/</literal></entry>
+ <entry><muttng-doc:key>/</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>search</entry>
</row>
<row>
- <entry><literal>ESC / </literal></entry>
+ <entry><muttng-doc:key mod="E">/</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>search-reverse</entry>
</row>
<row>
- <entry><literal>^L</literal></entry>
+ <entry><muttng-doc:key mod="C">L</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>clear and redraw the screen</entry>
</row>
<row>
- <entry><literal>^T</literal></entry>
+ <entry><muttng-doc:key mod="C">T</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>untag messages matching a pattern</entry>
</row>
Furthermore, the following flags reflect who the message is
addressed
to. They can be customized with the
- <muttng-doc:varref name="to_chars" link="to-chars"/> variable.
+ <muttng-doc:varref name="to-chars"/> variable.
</para>
<para>
<para>
- <table frame="none" rowsep="1">
+ <table frame="none" rowsep="1" texstr="l|l|l">
<title>Most commonly used Pager Bindings</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
</thead>
<tbody>
<row>
- <entry><literal><Return></literal></entry>
+ <entry><muttng-doc:key>Return</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>go down one line</entry>
</row>
<row>
- <entry><literal><Space></literal></entry>
+ <entry><muttng-doc:key>Space</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>display the next page (or next message if at the end of a message)</entry>
</row>
<row>
- <entry><literal>-</literal></entry>
+ <entry><muttng-doc:key>-</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>go back to the previous page</entry>
</row>
<row>
- <entry><literal>n</literal></entry>
+ <entry><muttng-doc:key>n</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>search for next match</entry>
</row>
<row>
- <entry><literal>S</literal></entry>
+ <entry><muttng-doc:key>S</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>skip beyond quoted text</entry>
</row>
<row>
- <entry><literal>T</literal></entry>
+ <entry><muttng-doc:key>T</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>toggle display of quoted text</entry>
</row>
<row>
- <entry><literal>?</literal></entry>
+ <entry><muttng-doc:key>?</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>show key bindings</entry>
</row>
<row>
- <entry><literal>/</literal></entry>
+ <entry><muttng-doc:key>/</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>search for a regular expression (pattern)</entry>
</row>
<row>
- <entry><literal>ESC / </literal></entry>
+ <entry><muttng-doc:key mod="E">/</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>search backwards for a regular expression</entry>
</row>
<row>
- <entry><literal>\</literal></entry>
+ <entry><muttng-doc:key>\</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>toggle search pattern coloring</entry>
</row>
<row>
- <entry><literal>^</literal></entry>
+ <entry><muttng-doc:key>^</muttng-doc:key></entry>
<entry><literal></literal></entry>
<entry>jump to the top of the message</entry>
</row>
</para>
<para>
- Also, the internal pager supports a couple other advanced features.
- For
- one, it will accept and translate the ``standard'' nroff sequences
- forbold and underline. These sequences are a series of either the
- letter,
- backspace (^H), the letter again for bold or the letter,
- backspace,
- ``_'' for denoting underline. Mutt-ng will attempt to display
- these
- in bold and underline respectively if your terminal supports them. If
- not, you can use the bold and underline <muttng-doc:command name="color"/>
- objects to specify a color or mono attribute for them.
+ Also, the internal pager supports a couple other advanced
+ features. For one, it will accept and translate the
+ ``standard'' nroff sequences forbold and underline. These
+ sequences are a series of either the letter, backspace
+ (<muttng-doc:key mod="C">H</muttng-doc:key>), the letter again for bold
+ or the letter, backspace, <muttng-doc:key>_</muttng-doc:key> for denoting
+ underline. Mutt-ng will attempt to display these in bold and
+ underline respectively if your terminal supports them. If not,
+ you can use the bold and underline <muttng-doc:cmdref
+ name="color"/> objects to specify a color or mono attribute
+ for them.
</para>
<para>
<para>
- <table frame="none" rowsep="1">
+ <table frame="none" rowsep="1" texstr="l|l">
<title>ANSI Escape Sequences</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
</table>
- <table frame="none" rowsep="1">
+ <table frame="none" rowsep="1" texstr="l|l">
<title>ANSI Colors</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
<para>
Mutt-ng uses these attributes for handling text/enriched messages,
and they
- can also be used by an external <muttng-doc:command name="auto_view"/>
+ can also be used by an external <muttng-doc:cmdref name="auto_view"/>
script for highlighting purposes. <emphasis role="bold">Note:</emphasis> If you change the colors for your
display, for example by changing the color associated with color2 for
your xterm, then that color will be used instead of green.
<para>
- <table frame="none" rowsep="1">
+ <table frame="none" rowsep="1" texstr="l|l|l">
<title>Most commonly used thread-related bindings</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
</thead>
<tbody>
<row>
- <entry><literal>^D</literal></entry>
+ <entry><muttng-doc:key mod="C">D</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="delete-thread"/></entry>
<entry>delete all messages in the current thread</entry>
</row>
<row>
- <entry><literal>^U</literal></entry>
+ <entry><muttng-doc:key mod="C">U</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="undelete-thread"/></entry>
<entry>undelete all messages in the current thread</entry>
</row>
<row>
- <entry><literal>^N</literal></entry>
+ <entry><muttng-doc:key mod="C">N</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="next-thread"/></entry>
<entry>jump to the start of the next thread</entry>
</row>
<row>
- <entry><literal>^P</literal></entry>
+ <entry><muttng-doc:key mod="C">P</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="previous-thread"/></entry>
<entry>jump to the start of the previous thread</entry>
</row>
<row>
- <entry><literal>^R</literal></entry>
+ <entry><muttng-doc:key mod="C">R</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="read-thread"/></entry>
<entry>mark the current thread as read</entry>
</row>
<row>
- <entry><literal>ESC d </literal></entry>
+ <entry><muttng-doc:key mod="E">d</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="delete-subthread"/></entry>
<entry>delete all messages in the current subthread</entry>
</row>
<row>
- <entry><literal>ESC u </literal></entry>
+ <entry><muttng-doc:key mod="E">u</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="undelete-subthread"/></entry>
<entry>undelete all messages in the current subthread</entry>
</row>
<row>
- <entry><literal>ESC n </literal></entry>
+ <entry><muttng-doc:key mod="E">n</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="next-subthread"/></entry>
<entry>jump to the start of the next subthread</entry>
</row>
<row>
- <entry><literal>ESC p </literal></entry>
+ <entry><muttng-doc:key mod="E">p</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="previous-subthread"/></entry>
<entry>jump to the start of the previous subthread</entry>
</row>
<row>
- <entry><literal>ESC r </literal></entry>
+ <entry><muttng-doc:key mod="E">r</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="read-subthread"/></entry>
<entry>mark the current subthread as read </entry>
</row>
<row>
- <entry><literal>ESC t </literal></entry>
+ <entry><muttng-doc:key mod="E">t</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="tag-thread"/></entry>
<entry>toggle the tag on the current thread</entry>
</row>
<row>
- <entry><literal>ESC v </literal></entry>
+ <entry><muttng-doc:key mod="E">v</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="collapse-thread"/></entry>
<entry>toggle collapse for the current thread</entry>
</row>
<row>
- <entry><literal>ESC V </literal></entry>
+ <entry><muttng-doc:key mod="E">V</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="collapse-all"/></entry>
<entry>toggle collapse for all threads</entry>
</row>
<row>
- <entry><literal>P</literal></entry>
+ <entry><muttng-doc:key>P</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="parent-message"/></entry>
<entry>jump to parent message in thread</entry>
</row>
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 <literal>%M</literal> in
- <muttng-doc:varref name="index_format" link="index-format"/>.
+ <muttng-doc:varref name="index-format"/>.
</para>
<para>
For example, you could use
- <literal>%?M?(#%03M)&(%4l)?</literal> in <muttng-doc:varref name="index_format" link="index-format"/>
+ <literal>%?M?(#%03M)&(%4l)?</literal> in <muttng-doc:varref name="index-format"/>
to optionally
display the number of hidden messages if the thread is collapsed.
</para>
<para>
- See also the <muttng-doc:varref name="strict_threads" link="strict-threads"/> variable.
+ See also the <muttng-doc:varref name="strict-threads"/> variable.
</para>
</sect2>
<title>Miscellaneous Functions</title>
<para>
- <muttng-doc:funcdef name="create-alias" key="a"/>
+ <muttng-doc:funcdef name="create-alias"><muttng-doc:key>a</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
Creates a new alias based upon the current message (or prompts for a
- new one). Once editing is complete, an <muttng-doc:command name="alias"/>
- command is added to the file specified by the <muttng-doc:varref name="alias_file" link="alias-file"/>
+ new one). Once editing is complete, an <muttng-doc:cmdref name="alias"/>
+ command is added to the file specified by the <muttng-doc:varref name="alias-file"/>
variable for future use. <emphasis role="bold">Note:</emphasis>
- Specifying an <muttng-doc:varref name="alias_file" link="alias-file"/>
- does not add the aliases specified there-in, you must also <muttng-doc:command name="source"/>
+ Specifying an <muttng-doc:varref name="alias-file"/>
+ does not add the aliases specified there-in, you must also <muttng-doc:cmdref name="source"/>
the file.
</para>
<para>
- <muttng-doc:funcdef name="check-traditional-pgp" key="ESC P"/>
+ <muttng-doc:funcdef name="check-traditional-pgp"><muttng-doc:key mod="E">P</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
</para>
<para>
- <muttng-doc:funcdef name="display-toggle-weed" key="h"/>
+ <muttng-doc:funcdef name="display-toggle-weed"><muttng-doc:key>h</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
- Toggles the weeding of message header fields specified by <muttng-doc:command name="ignore"/>
+ Toggles the weeding of message header fields specified by <muttng-doc:cmdref name="ignore"/>
commands.
</para>
<para>
- <muttng-doc:funcdef name="edit" key="e"/>
+ <muttng-doc:funcdef name="edit"><muttng-doc:key>e</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
<para>
<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)
+ (default: <muttng-doc:key mod="C">E</muttng-doc:key> on the attachment menu, and in the pager and index
+ menus; <muttng-doc:key mod="C">T</muttng-doc:key> on the compose menu)
</para>
<para>
</para>
<para>
- <muttng-doc:funcdef name="enter-command" key=":"/>
+ <muttng-doc:funcdef name="enter-command"><muttng-doc:key>:</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
a
configuration file. A common use is to check the settings of
variables, or
- in conjunction with <muttng-doc:command name="macro"/> to change
+ in conjunction with <muttng-doc:cmdref name="macro"/> to change
settings on the
fly.
</para>
<para>
- <muttng-doc:funcdef name="extract-keys" key="^K"/>
+ <muttng-doc:funcdef name="extract-keys"><muttng-doc:key mod="C">K</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
</para>
<para>
- <muttng-doc:funcdef name="forget-passphrase" key="^F"/>
+ <muttng-doc:funcdef name="forget-passphrase"><muttng-doc:key mod="C">F</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
</para>
<para>
- <muttng-doc:funcdef name="list-reply" key="L"/>
+ <muttng-doc:funcdef name="list-reply"><muttng-doc:key>L</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
Reply to the current or tagged message(s) by extracting any addresses
which
- match the regular expressions given by the <muttng-doc:command name="lists"/>
+ match the regular expressions given by the <muttng-doc:cmdref name="lists"/>
commands, but also honor any <literal>Mail-Followup-To</literal>
header(s) if the
- <muttng-doc:varref name="honor_followup_to" link="honor-followup-to"/>
+ <muttng-doc:varref name="honor-followup-to"/>
configuration variable is set. Using this when replying to messages
posted
to mailing lists helps avoid duplicate copies being sent to the
<para>
Asks for an external Unix command and pipes the current or
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"/>
+ <muttng-doc:varref name="pipe-decode"/>,
+ <muttng-doc:varref name="pipe-split"/>,
+ <muttng-doc:varref name="pipe-decode"/> and
+ <muttng-doc:varref name="wait-key"/>
control the exact behavior of this function.
</para>
<para>
- <muttng-doc:funcdef name="resend-message" key="ESC e"/>
+ <muttng-doc:funcdef name="resend-message"><muttng-doc:key mod="E">e</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
</para>
<para>
- <muttng-doc:funcdef name="shell-escape" key="!"/>
+ <muttng-doc:funcdef name="shell-escape"><muttng-doc:key>!</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
Asks for an external Unix command and executes it. The
- <muttng-doc:varref name="wait_key" link="wait-key"/>
+ <muttng-doc:varref name="wait-key"/>
can be used to control
whether Mutt-ng will wait for a key to be pressed when the command
returns
</para>
<para>
- <muttng-doc:funcdef name="toggle-quoted" key="T"/>
+ <muttng-doc:funcdef name="toggle-quoted"><muttng-doc:key>T</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
The <emphasis>pager</emphasis> uses the
- <muttng-doc:varref name="quote_regexp" link="quote-regexp"/>
+ <muttng-doc:varref name="quote-regexp"/>
variable to detect quoted text when
displaying the body of the message. This function toggles the
displayof the quoted material in the message. It is particularly
</para>
<para>
- <muttng-doc:funcdef name="skip-quoted" key="S"/>
+ <muttng-doc:funcdef name="skip-quoted"><muttng-doc:key>S</muttng-doc:key></muttng-doc:funcdef>
</para>
<para>
<para>
- <table frame="none" rowsep="1">
+ <table frame="none" rowsep="1" texstr="l|l|l">
<title>Most commonly used Mail Composition Bindings</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
</thead>
<tbody>
<row>
- <entry><literal>m</literal></entry>
+ <entry><muttng-doc:key>m</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="compose"/></entry>
<entry>compose a new message</entry>
</row>
<row>
- <entry><literal>r</literal></entry>
+ <entry><muttng-doc:key>r</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="reply"/></entry>
<entry>reply to sender</entry>
</row>
<row>
- <entry><literal>g</literal></entry>
+ <entry><muttng-doc:key>g</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="group-reply"/></entry>
<entry>reply to all recipients</entry>
</row>
<row>
- <entry><literal>L</literal></entry>
+ <entry><muttng-doc:key>L</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="list-reply"/></entry>
<entry>reply to mailing list address</entry>
</row>
<row>
- <entry><literal>f</literal></entry>
+ <entry><muttng-doc:key>f</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="forward"/></entry>
<entry>forward message</entry>
</row>
<row>
- <entry><literal>b</literal></entry>
+ <entry><muttng-doc:key>b</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="bounce"/></entry>
<entry>bounce (remail) message</entry>
</row>
<row>
- <entry><literal>ESC k </literal></entry>
+ <entry><muttng-doc:key mod="E">k</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="mail-key"/></entry>
<entry>mail a PGP public key to someone</entry>
</row>
<title>Composing new messages</title>
<para>
- When you want to send an email using mutt-ng, simply press <literal>m</literal> on
+ When you want to send an email using mutt-ng, simply press <muttng-doc:key>m</muttng-doc:key> on
your keyboard. Then, mutt-ng asks for the recipient via a prompt in
the last line:
</para>
<para>
- <screen>
-To:</screen>
+ <muttng-doc:lstmail>
+To:</muttng-doc:lstmail>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
set editor = "vim +/^$/ -c ':set tw=72'"
set editor = "nano"
-set editor = "emacs"</screen>
+set editor = "emacs"</muttng-doc:lstconf>
</para>
</para>
<para>
- At this point, you can add more attachments, pressing <literal>a</literal>, you
- can edit the recipient addresses, pressing <literal>t</literal> for
+ At this point, you can add more attachments, pressing <muttng-doc:key>a</muttng-doc:key>, you
+ can edit the recipient addresses, pressing <muttng-doc:key>t</muttng-doc:key> for
the "To:" field,
- <literal>c</literal> for the "Cc:" field, and <literal>b</literal>
+ <muttng-doc:key>c</muttng-doc:key> for the "Cc:" field, and <muttng-doc:key>b</muttng-doc:key>
for the "Bcc: field. You can
- also edit the subject the subject by simply pressing <literal>s</literal> or the
- email message that you've entered before by pressing <literal>e</literal>. You will
+ also edit the subject the subject by simply pressing <muttng-doc:key>s</muttng-doc:key> or the
+ email message that you've entered before by pressing <muttng-doc:key>e</muttng-doc:key>. You will
then again return to the editor. You can even edit the sender, by
pressing
<literal><esc>f</literal>, but this shall only be used with
<para>
- <screen>
-set edit_headers</screen>
+ <muttng-doc:lstconf>
+set edit_headers</muttng-doc:lstconf>
</para>
<para>
- <table frame="none" rowsep="1">
+ <table frame="none" rowsep="1" texstr="l|l|l">
<title>Most commonly used Compose Menu Bindings</title>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
</thead>
<tbody>
<row>
- <entry><literal>a</literal></entry>
+ <entry><muttng-doc:key>a</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="attach-file"/></entry>
<entry>attach a file</entry>
</row>
<row>
- <entry><literal>A</literal></entry>
+ <entry><muttng-doc:key>A</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="attach-message"/></entry>
<entry>attach message(s) to the message</entry>
</row>
<row>
- <entry><literal>ESC k </literal></entry>
+ <entry><muttng-doc:key mod="E">k</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="attach-key"/></entry>
<entry>attach a PGP public key</entry>
</row>
<row>
- <entry><literal>d</literal></entry>
+ <entry><muttng-doc:key>d</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="edit-description"/></entry>
<entry>edit description on attachment</entry>
</row>
<row>
- <entry><literal>D</literal></entry>
+ <entry><muttng-doc:key>D</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="detach-file"/></entry>
<entry>detach a file</entry>
</row>
<row>
- <entry><literal>t</literal></entry>
+ <entry><muttng-doc:key>t</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="edit-to"/></entry>
<entry>edit the To field</entry>
</row>
<row>
- <entry><literal>ESC f </literal></entry>
+ <entry><muttng-doc:key mod="E">f</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="edit-from"/></entry>
<entry>edit the From field</entry>
</row>
<row>
- <entry><literal>r</literal></entry>
+ <entry><muttng-doc:key>r</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="edit-reply-to"/></entry>
<entry>edit the Reply-To field</entry>
</row>
<row>
- <entry><literal>c</literal></entry>
+ <entry><muttng-doc:key>c</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="edit-cc"/></entry>
<entry>edit the Cc field</entry>
</row>
<row>
- <entry><literal>b</literal></entry>
+ <entry><muttng-doc:key>b</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="edit-bcc"/></entry>
<entry>edit the Bcc field</entry>
</row>
<row>
- <entry><literal>y</literal></entry>
+ <entry><muttng-doc:key>y</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="send-message"/></entry>
<entry>send the message</entry>
</row>
<row>
- <entry><literal>s</literal></entry>
+ <entry><muttng-doc:key>s</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="edit-subject"/></entry>
<entry>edit the Subject</entry>
</row>
<row>
- <entry><literal>S</literal></entry>
+ <entry><muttng-doc:key>S</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="smime-menu"/></entry>
<entry>select S/MIME options</entry>
</row>
<row>
- <entry><literal>f</literal></entry>
+ <entry><muttng-doc:key>f</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="edit-fcc"/></entry>
<entry>specify an ``Fcc'' mailbox</entry>
</row>
<row>
- <entry><literal>p</literal></entry>
+ <entry><muttng-doc:key>p</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="pgp-menu"/></entry>
<entry>select PGP options</entry>
</row>
<row>
- <entry><literal>P</literal></entry>
+ <entry><muttng-doc:key>P</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="postpone-message"/></entry>
<entry>postpone this message until later</entry>
</row>
<row>
- <entry><literal>q</literal></entry>
+ <entry><muttng-doc:key>q</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="quit"/></entry>
<entry>quit (abort) sending the message</entry>
</row>
<row>
- <entry><literal>w</literal></entry>
+ <entry><muttng-doc:key>w</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="write-fcc"/></entry>
<entry>write the message to a folder</entry>
</row>
<row>
- <entry><literal>i</literal></entry>
+ <entry><muttng-doc:key>i</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="ispell"/></entry>
<entry>check spelling (if available on your system)</entry>
</row>
<row>
- <entry><literal>^F</literal></entry>
+ <entry><muttng-doc:key mod="C">F</muttng-doc:key></entry>
<entry><muttng-doc:funcref name="forget-passphrase"/></entry>
<entry>wipe passphrase(s) from memory</entry>
</row>
certainoperations like composing a new mail, replying, forwarding,
etc. are
not permitted when you are in that folder. The <literal>%r</literal>
- in <muttng-doc:varref name="status_format" link="status-format"/>
+ in <muttng-doc:varref name="status-format"/>
will change to
a 'A' to indicate that you are in attach-message mode.
</para>
<para>
When you want to reply to an email message, select it in the index
- menu and then press <literal>r</literal>. Mutt-ng's behaviour is
+ menu and then press <muttng-doc:key>r</muttng-doc:key>. Mutt-ng's behaviour is
then similar to the
behaviour when you compose a message: first, you will be asked for
the recipient, then for the subject, and then, mutt-ng will start
<para>
- <screen>
+ <muttng-doc:lstmail>
On Mon, Mar 07, 2005 at 05:02:12PM +0100, Michael Svensson wrote:
> Bill, can you please send last month's progress report to Mr.
> Morgan? We also urgently need the cost estimation for the new
> production server that we want to set up before our customer's
-> project will go live.</screen>
+> project will go live.</muttng-doc:lstmail>
</para>
<para>
The quote attribution is configurable, by default it is set to
- <screen>
-set attribution = "On %d, %n wrote:"</screen>
+ <muttng-doc:lstconf>
+set attribution = "On %d, %n wrote:"</muttng-doc:lstconf>
</para>
<para>
It can also be set to something more compact, e.g.
- <screen>
-set attribution = "attribution="* %n <%a> [%(%y-%m-%d %H:%M)]:"</screen>
+ <muttng-doc:lstconf>
+set attribution = "attribution="* %n <%a> [%(%y-%m-%d %H:%M)]:"</muttng-doc:lstconf>
</para>
<para>
The example above results in the following attribution:
- <screen>
+ <muttng-doc:lstmail>
* Michael Svensson <svensson@foobar.com> [05-03-06 17:02]:
> Bill, can you please send last month's progress report to Mr.
> Morgan? We also urgently need the cost estimation for the new
> production server that we want to set up before our customer's
-> project will go live.</screen>
+> project will go live.</muttng-doc:lstmail>
</para>
In the situation where a group of people uses email as a
discussion, most of the emails will have one or more recipients,
and probably several "Cc:" recipients. The group reply
- functionalityensures that when you press <literal>g</literal>
- instead of <literal>r</literal> to do a reply,
+ functionalityensures that when you press <muttng-doc:key>g</muttng-doc:key>
+ instead of <muttng-doc:key>r</muttng-doc:key> to do a reply,
each and every recipient that is contained in the original message
will receive a copy of the message, either as normal recipient or
as "Cc:" recipient.
</para>
<para>
- To do a list reply, simply press <literal>L</literal>. If the email
+ To do a list reply, simply press <muttng-doc:key>L</muttng-doc:key>. If the email
contains
a <literal>Mail-Followup-To:</literal> header, its value will be
used as reply
<para>
- <screen>
-lists linuxevent@luga\.at vuln-dev@ mutt-ng-users@</screen>
+ <muttng-doc:lstconf>
+lists linuxevent@luga\.at vuln-dev@ mutt-ng-users@</muttng-doc:lstconf>
</para>
<para>
You can also attach files to your message by specifying
- <screen>
-Attach: filename [description]</screen>
+ <muttng-doc:lstmail>
+Attach: filename [description]</muttng-doc:lstmail>
where <emphasis>filename</emphasis> is the file to attach and <emphasis>
description
</para>
<para>
- Also see the <muttng-doc:varref name="edit_headers" link="edit-headers"/> and
- <muttng-doc:varref name="editor_headers" link="editor-headers"/> variables
+ Also see the <muttng-doc:varref name="edit-headers"/> and
+ <muttng-doc:varref name="editor-headers"/> variables
</para>
<para>
<para>
If you want to use PGP, you can specify
- <screen>
-Pgp: [E | S | S id]</screen>
+ <muttng-doc:lstmail>
+Pgp: [E | S | S id]</muttng-doc:lstmail>
``E'' encrypts, ``S'' signs and
``S<id>'' signs with the given key, setting
- <muttng-doc:varref name="pgp_sign_as" link="pgp-sign-as"/>
+ <muttng-doc:varref name="pgp-sign-as"/>
permanently.
</para>
In these cases, you are dropped into a menu with a list of keys from
which you can select one. When you quit this menu, or mutt can't
find any matching keys, you are prompted for a user ID. You can, as
- usually, abort this prompt using <literal>^G</literal>. When
+ usually, abort this prompt using <muttng-doc:key mod="C">G</muttng-doc:key>. When
you do so, mutt will
return to the compose screen.
</para>
<para>
Most fields of the entries in the key selection menu (see also
- <muttng-doc:varref name="pgp_entry_format" link="pgp-entry-format"/>)
+ <muttng-doc:varref name="pgp-entry-format"/>)
have obvious meanings. But some explanations on the capabilities,
flags,
and validity fields are in order.
flags:
- <table frame="none" rowsep="1">
+ <table frame="none" rowsep="1" texstr="l|l">
<title>PGP Key Menu Flags</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
and
<literal>chain-next</literal> functions, which are by default bound
to the left
- and right arrows and to the <literal>h</literal> and <literal>l</literal> keys (think vi
+ and right arrows and to the <muttng-doc:key>h</muttng-doc:key> and <muttng-doc:key>l</muttng-doc:key> keys (think vi
keyboard bindings). To insert a remailer at the current chain
position, use the <literal>insert</literal> function. To append a
remailer behind
<para>
Note that different remailers do have different capabilities,
indicated in the <literal>%c</literal> entry of the remailer menu lines (see
- <muttng-doc:varref name="mix_entry_format" link="mix-entry-format"/>).
+ <muttng-doc:varref name="mix-entry-format"/>).
Most important is
the ``middleman'' capability, indicated by a capital ``M'': This
means that the remailer in question cannot be used as the final
<para>
The first one is regular forwarding, as you probably know it from
- other mail clients. You simply press <literal>f</literal>, enter the
+ other mail clients. You simply press <muttng-doc:key>f</muttng-doc:key>, enter the
recipient
email address, the subject of the forwarded email, and then you can
edit the message to be forwarded in the editor. The forwarded
<para>
- <screen>
------ Forwarded message from Lucas User <luser@example.com> -----
+ <muttng-doc:lstmail>
+----- Forwarded message from Lucas User <luser@example.com> -----
-From: Lucas User <luser@example.com>
+From: Lucas User <luser@example.com>
Date: Thu, 02 Dec 2004 03:08:34 +0100
-To: Michael Random <mrandom@example.com>
+To: Michael Random <mrandom@example.com>
Subject: Re: blackmail
Pay me EUR 50,000.- cash or your favorite stuffed animal will die
a horrible death.
------ End forwarded message -----</screen>
+----- End forwarded message -----</muttng-doc:lstmail>
</para>
another
address, it will be sent in practically the same format you send it
(except for headers that are created during transporting the
- message). To bounce a message, press <literal>b</literal> and enter the
+ message). To bounce a message, press <muttng-doc:key>b</muttng-doc:key> and enter the
recipient
email address. By default, you are then asked whether you really
want to bounce the message to the specified recipient. If you answer
When multiple commands are used, they must be separated by a semicolon
(;).
- <screen>
-set realname='Mutt-ng user' ; ignore x-</screen>
+ <muttng-doc:lstconf>
+set realname='Mutt-ng user' ; ignore x-</muttng-doc:lstconf>
The hash mark, or pound sign
(``#''), is used as a ``comment'' character. You can use it to
<para>
- <screen>
-my_hdr X-Disclaimer: Why are you listening to me? # This is a comment</screen>
+ <muttng-doc:lstconf>
+my_hdr X-Disclaimer: Why are you listening to me? # This is a comment</muttng-doc:lstconf>
</para>
interpreted
character.
- <screen>
-set realname="Michael \"MuttDude\" Elkins"</screen>
+ <muttng-doc:lstconf>
+set realname="Michael \"MuttDude\" Elkins"</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
# folder-hook . \
-set realname="Michael \"MuttDude\" Elkins"</screen>
+set realname="Michael \"MuttDude\" Elkins"</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
line1\
line2a # line2b\
line3\
line4
-line5</screen>
+line5</muttng-doc:lstconf>
</para>
<para>
- <screen>
-my_hdr X-Operating-System: `uname -a`</screen>
+ <muttng-doc:lstconf>
+my_hdr X-Operating-System: `uname -a`</muttng-doc:lstconf>
</para>
<para>
- <screen>
-set record=+sent_on_$HOSTNAME</screen>
+ <muttng-doc:lstconf>
+set record=+sent_on_$HOSTNAME</muttng-doc:lstconf>
</para>
<para>
- <screen>
-set imap_home_namespace = $folder</screen>
+ <muttng-doc:lstconf>
+set imap_home_namespace = $folder</muttng-doc:lstconf>
</para>
<para>
- would set the value of <muttng-doc:varref name="imap_home_namespace" link="imap-home-namespace"/>
+ would set the value of <muttng-doc:varref name="imap-home-namespace"/>
to the value to which <muttng-doc:varref name="folder"/>
is <emphasis>currently</emphasis> set to.
</para>
<para>
<emphasis role="bold">Note:</emphasis> There're no logical links
established in such cases so
- that the the value for <muttng-doc:varref name="imap_home_namespace" link="imap-home-namespace"/>
+ that the the value for <muttng-doc:varref name="imap-home-namespace"/>
won't change even
if <muttng-doc:varref name="folder"/> gets changed.
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
macro generic <F1> "!less -r /path/to/manual" "Show manual"
-macro pager <F1> "!less -r /path/to/manual" "Show manual"</screen>
+macro pager <F1> "!less -r /path/to/manual" "Show manual"</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
set user_manualcmd = "!less -r /path/to_manual"
macro generic <F1> "$user_manualcmd<enter>" "Show manual"
macro pager <F1> "$user_manualcmd<enter>" "Show manual"
-macro index <F1> "$user_manualcmd<enter>" "Show manual"</screen>
+macro index <F1> "$user_manualcmd<enter>" "Show manual"</muttng-doc:lstconf>
</para>
<para>
- <screen>
-macro index <F2> "$user_manualcmd | grep '\^[ ]\\+~. '" "Show Patterns"</screen>
+ <muttng-doc:lstconf>
+macro index <F2> "$user_manualcmd | grep '\^[ ]\\+~. '" "Show Patterns"</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
set user_foo = 42
-set user_foo = 666</screen>
+set user_foo = 666</muttng-doc:lstconf>
</para>
<para>
- <screen>
-set ?user_foo</screen>
+ <muttng-doc:lstconf>
+set ?user_foo</muttng-doc:lstconf>
</para>
<para>
- <screen>
-reset user_foo</screen>
+ <muttng-doc:lstconf>
+reset user_foo</muttng-doc:lstconf>
</para>
<para>
- <screen>
-unset user_foo</screen>
+ <muttng-doc:lstconf>
+unset user_foo</muttng-doc:lstconf>
</para>
<para>
- <screen>
-muttng -Q muttng_docdir</screen>
+ <muttng-doc:lstshell>
+$ muttng -Q muttng_docdir</muttng-doc:lstshell>
</para>
<para>
- <screen>
-set user_manualcmd = '!less -r /path/to_manual'</screen>
+ <muttng-doc:lstconf>
+set user_manualcmd = '!less -r /path/to_manual'</muttng-doc:lstconf>
</para>
<para>
- <screen>
-set user_manualcmd = "!less -r $muttng_docdir/manual.txt"</screen>
+ <muttng-doc:lstconf>
+set user_manualcmd = "!less -r $muttng_docdir/manual.txt"</muttng-doc:lstconf>
</para>
<para>
- <screen>
-folder-hook . "set user_current_folder = $muttng_folder_name"</screen>
+ <muttng-doc:lstconf>
+folder-hook . "set user_current_folder = $muttng_folder_name"</muttng-doc:lstconf>
</para>
<para>
- <screen>
-folder-hook . "set user_current_folder = some_folder"</screen>
+ <muttng-doc:lstconf>
+folder-hook . "set user_current_folder = some_folder"</muttng-doc:lstconf>
</para>
<para>
- <screen>
-folder-hook . 'set user_current_folder = $muttng_folder_name'</screen>
+ <muttng-doc:lstconf>
+folder-hook . 'set user_current_folder = $muttng_folder_name'</muttng-doc:lstconf>
</para>
<para>
- <screen>
-folder-hook . 'source ~/.mutt/score-$muttng_folder_name'</screen>
+ <muttng-doc:lstconf>
+folder-hook . 'source ~/.mutt/score-$muttng_folder_name'</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
set read_inc = 100
set folder = $read_inc
set read_inc = $folder
set user_magic_number = 42
-set folder = $user_magic_number</screen>
+set folder = $user_magic_number</muttng-doc:lstconf>
</para>
</sect1>
- <sect1 id="command-alias"><anchor id="command-unalias"/>
+ <sect1>
<title>Defining/Using aliases</title>
<para>
- Usage: <muttng-doc:command name="alias"/> <emphasis>key</emphasis> <emphasis>address</emphasis> [, <emphasis>address</emphasis>,...]
+ <muttng-doc:cmddef name="alias">
+ key address [, address,...]
+ </muttng-doc:cmddef>
</para>
<para>
</para>
<para>
- <literal>unalias</literal> [* | <emphasis>key</emphasis> <emphasis>...</emphasis>]
+ <muttng-doc:cmddef name="unalias">
+ [* | key ... ]
+ </muttng-doc:cmddef>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
alias muttdude me@cs.hmc.edu (Michael Elkins)
-alias theguys manny, moe, jack</screen>
+alias theguys manny, moe, jack</muttng-doc:lstconf>
</para>
Unlike other mailers, Mutt-ng doesn't require aliases to be defined
in a special file. The <literal>alias</literal> command can appear
anywhere in
- a configuration file, as long as this file is <muttng-doc:command name="source"/>.
+ a configuration file, as long as this file is <muttng-doc:cmdref name="source"/>.
Consequently, you can have multiple alias files, or
you can have all aliases defined in your muttrc.
</para>
<para>
On the other hand, the <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"/>
+ <muttng-doc:varref name="alias-file"/>
variable (which is
<literal>~/.muttrc</literal> by default). This file is not
special either,
in the sense that Mutt-ng will happily append aliases to any file, but
in
- order for the new aliases to take effect you need to explicitly <muttng-doc:command name="source"/>
+ order for the new aliases to take effect you need to explicitly <muttng-doc:cmdref name="source"/>
this file too.
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
source /usr/local/share/Mutt-ng.aliases
source ~/.mail_aliases
-set alias_file=~/.mail_aliases</screen>
+set alias_file=~/.mail_aliases</muttng-doc:lstconf>
</para>
prompt. You can
also enter aliases in your editor at the appropriate headers if you
have the
- <muttng-doc:varref name="editor_headers" link="edit-headers"/>
+ <muttng-doc:varref name="editor-headers"/>
variable set.
</para>
</sect1>
- <sect1 id="command-bind">
+ <sect1>
<title>Changing the default key bindings</title>
<para>
- Usage: <muttng-doc:command name="bind"/> <emphasis>map</emphasis> <emphasis>key</emphasis> <emphasis>function</emphasis>
+ <muttng-doc:cmddef name="bind">
+ map key function
+ </muttng-doc:cmddef>
</para>
<para>
<para>
- <table frame="none" rowsep="1">
+ <table frame="none" rowsep="1" texstr="l|l">
<title>Alternative Key Names</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
<entry>tab</entry>
</row>
<row>
- <entry><literal><tab></literal></entry>
+ <entry><literal><tab></literal></entry>
<entry>tab</entry>
</row>
<row>
- <entry><literal><backtab></literal></entry>
+ <entry><literal><backtab></literal></entry>
<entry>backtab / shift-tab</entry>
</row>
<row>
<entry>escape</entry>
</row>
<row>
- <entry><literal><esc></literal></entry>
+ <entry><literal><esc></literal></entry>
<entry>escape</entry>
</row>
<row>
- <entry><literal><up></literal></entry>
+ <entry><literal><up></literal></entry>
<entry>up arrow</entry>
</row>
<row>
- <entry><literal><down></literal></entry>
+ <entry><literal><down></literal></entry>
<entry>down arrow</entry>
</row>
<row>
- <entry><literal><left></literal></entry>
+ <entry><literal><left></literal></entry>
<entry>left arrow</entry>
</row>
<row>
- <entry><literal><right></literal></entry>
+ <entry><literal><right></literal></entry>
<entry>right arrow</entry>
</row>
<row>
- <entry><literal><pageup></literal></entry>
+ <entry><literal><pageup></literal></entry>
<entry>Page Up</entry>
</row>
<row>
- <entry><literal><pagedown></literal></entry>
+ <entry><literal><pagedown></literal></entry>
<entry>Page Down</entry>
</row>
<row>
- <entry><literal><backspace></literal></entry>
+ <entry><literal><backspace></literal></entry>
<entry>Backspace</entry>
</row>
<row>
- <entry><literal><delete></literal></entry>
+ <entry><literal><delete></literal></entry>
<entry>Delete</entry>
</row>
<row>
- <entry><literal><insert></literal></entry>
+ <entry><literal><insert></literal></entry>
<entry>Insert</entry>
</row>
<row>
- <entry><literal><enter></literal></entry>
+ <entry><literal><enter></literal></entry>
<entry>Enter</entry>
</row>
<row>
- <entry><literal><return></literal></entry>
+ <entry><literal><return></literal></entry>
<entry>Return</entry>
</row>
<row>
- <entry><literal><home></literal></entry>
+ <entry><literal><home></literal></entry>
<entry>Home</entry>
</row>
<row>
- <entry><literal><end></literal></entry>
+ <entry><literal><end></literal></entry>
<entry>End</entry>
</row>
<row>
- <entry><literal><space></literal></entry>
+ <entry><literal><space></literal></entry>
<entry>Space bar</entry>
</row>
<row>
- <entry><literal><f1></literal></entry>
+ <entry><literal><f1></literal></entry>
<entry>function key 1</entry>
</row>
<row>
- <entry><literal><f10></literal></entry>
+ <entry><literal><f10></literal></entry>
<entry>function key 10</entry>
</row>
</tbody>
<para>
- <screen>
-folder-hook mutt set sort=threads</screen>
+ <muttng-doc:lstconf>
+folder-hook mutt set sort=threads</muttng-doc:lstconf>
</para>
<para>
- <screen>
-folder-hook . set sort=date-sent</screen>
+ <muttng-doc:lstconf>
+folder-hook . set sort=date-sent</muttng-doc:lstconf>
</para>
</sect1>
- <sect1 id="command-macro">
+ <sect1>
<title>Keyboard macros</title>
<para>
- Usage: <muttng-doc:command name="macro"/> <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>sequence</emphasis> [<emphasis>description</emphasis>]
+ <muttng-doc:cmddef name="macro">
+ menu key sequence [description]
+ </muttng-doc:cmddef>
</para>
<para>
</para>
<para>
- <emphasis>key</emphasis> and <emphasis>sequence</emphasis> are expanded
- by the same rules as the <muttng-doc:command name="bind"/>. There are
- some additions however. The
- first is that control characters in <emphasis>sequence</emphasis> can
- also be specified
- as <emphasis>^x</emphasis>. In order to get a caret (`^'')
- you need to use
- <emphasis>^^</emphasis>. Secondly, to specify a certain key
- such as <emphasis>up</emphasis>
- or to invoke a function directly, you can use the format
+ <emphasis>key</emphasis> and <emphasis>sequence</emphasis> are
+ expanded by the same rules as the <muttng-doc:cmdref
+ name="bind"/>. There are some additions however. The first
+ is that control characters in <emphasis>sequence</emphasis> can
+ also be specified as <literal>^x</literal>. In order to get a
+ caret (`^'') you need to specify it twice. Secondly,
+ to specify a certain key such as <emphasis>up</emphasis> or to
+ invoke a function directly, you can use the format
<emphasis><key name></emphasis> and <emphasis><function
- name>
- </emphasis>
- .For a listing of key
- names see the section on <muttng-doc:command name="bind"/>. Functions
- are listed in the <link linkend="functions">functions</link>.
+ name> </emphasis> .For a listing of key names see the
+ section on <muttng-doc:cmdref name="bind"/>. Functions are
+ listed in the <link linkend="functions">functions</link>.
</para>
<para>
</sect1>
- <sect1 id="command-color"><anchor id="command-uncolor"/>
+ <sect1>
<title>Using color and mono video attributes</title>
- <anchor id="command-mono"/>
- <anchor id="command-unmono"/>
<para>
- Usage: <muttng-doc:command name="color"/> <emphasis>object</emphasis> <emphasis>foreground</emphasis><emphasis>background</emphasis> [<emphasis>regexp</emphasis>]
+ <muttng-doc:cmddef name="color">object foreground background [regexp]</muttng-doc:cmddef>
</para>
<para>
- Usage: <muttng-doc:command name="color"/> index <emphasis>foreground</emphasis> <emphasis>background</emphasis><emphasis>pattern</emphasis>
+ <muttng-doc:cmddef name="color" noanchor="1">index foreground pattern</muttng-doc:cmddef>
</para>
<para>
- Usage: <muttng-doc:command name="uncolor"/> index <emphasis>pattern</emphasis>[<emphasis>pattern</emphasis>...]
+ <muttng-doc:cmddef name="uncolor">index pattern [pattern ...]</muttng-doc:cmddef>
</para>
<para>
<listitem>
<para>
- quoted (text matching <muttng-doc:varref name="quote_regexp" link="quote-regexp"/> in the body of a message)
+ quoted (text matching <muttng-doc:varref name="quote-regexp"/> in the body of a message)
</para>
</listitem>
<listitem>
<para>
- <screen>
+ <muttng-doc:lstshell>
set COLORFGBG="green;black"
-export COLORFGBG</screen>
+export COLORFGBG</muttng-doc:lstshell>
</para>
</para>
<para>
- Usage: <muttng-doc:command name="mono"/> <emphasis><object> <attribute></emphasis>[<emphasis>regexp</emphasis>]
+ <muttng-doc:cmddef name="mono">object attribute [regexp]</muttng-doc:cmddef>
</para>
<para>
- Usage: <muttng-doc:command name="mono"/> index <emphasis>attribute</emphasis> <emphasis>pattern</emphasis>
+ <muttng-doc:cmddef name="mono" noanchor="1">index attribute pattern</muttng-doc:cmddef>
</para>
<para>
- Usage: <muttng-doc:command name="unmono"/> index <emphasis>pattern</emphasis> [<emphasis>pattern</emphasis>...]
+ <muttng-doc:cmddef name="unmono">index pattern [pattern ...]</muttng-doc:cmddef>
</para>
<para>
</sect1>
- <sect1 id="command-ignore"><anchor id="command-unignore"/>
+ <sect1>
<title>Ignoring (weeding) unwanted message headers</title>
<para>
- Usage: <muttng-doc:command name="ignore"/> <emphasis>pattern</emphasis> [<emphasis>pattern</emphasis>...]
+ <muttng-doc:cmddef name="ignore">pattern [pattern ...]</muttng-doc:cmddef>
</para>
<para>
- Usage: <muttng-doc:command name="unignore"/> <emphasis>pattern</emphasis> [<emphasis>pattern</emphasis>...]
+ <muttng-doc:cmddef name="unignore">pattern [pattern ...]</muttng-doc:cmddef>
</para>
<para>
<para>
For example:
- <screen>
+ <muttng-doc:lstconf>
# Sven's draconian header weeding
ignore *
unignore from date subject to cc
unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
-unignore posted-to:</screen>
+unignore posted-to:</muttng-doc:lstconf>
</para>
</sect1>
- <sect1 id="command-alternates"><anchor id="command-unalternates"/>
+ <sect1>
<title>Alternative addresses</title>
<para>
- Usage: <muttng-doc:command name="alternates"/> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
+ <muttng-doc:cmddef name="alternates">regexp [regexp ...]</muttng-doc:cmddef>
</para>
<para>
- Usage: <muttng-doc:command name="unalternates"/> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
+ <muttng-doc:cmddef name="unalternates">regexp [regexp ...]</muttng-doc:cmddef>
</para>
<para>
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 <muttng-doc:varref name="reply_to" link="reply-to"/>.)
+ (See <muttng-doc:varref name="reply-to"/>.)
</para>
<para>
<para>
- <screen>
-set wrapmargin = 10</screen>
+ <muttng-doc:lstconf>
+set wrapmargin = 10</muttng-doc:lstconf>
</para>
<para>
- <screen>
-set max_line_length = 120</screen>
+ <muttng-doc:lstconf>
+set max_line_length = 120</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstmail>
>Bill, can you please send last month's progress report to Mr.
>Morgan? We also urgently need the cost estimation for the new
>production server that we want to set up before our customer's
->project will go live.</screen>
+>project will go live.</muttng-doc:lstmail>
</para>
<para>
- <screen>
-set stuff_quoted</screen>
+ <muttng-doc:lstconf>
+set stuff_quoted</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstmail>
> Bill, can you please send last month's progress report to Mr.
> Morgan? We also urgently need the cost estimation for the new
> production server that we want to set up before our customer's
-> project will go live.</screen>
+> project will go live.</muttng-doc:lstmail>
</para>
<para>
- <screen>
-set text_flowed</screen>
+ <muttng-doc:lstconf>
+set text_flowed</muttng-doc:lstconf>
</para>
<title>Additional Notes</title>
<para>
- For completeness, the <muttng-doc:varref name="delete_space" link="delete-space"/> variable provides the mechanism
+ For completeness, the <muttng-doc:varref name="delete-space"/> variable provides the mechanism
to generate a <literal>DelSp=yes</literal> parameter on <emphasis>
outgoing
</emphasis>
</sect1>
- <sect1 id="command-lists"><anchor id="command-unlists"/><anchor id="command-subscribe"/>
- <anchor id="command-unsubscribe"/>
+ <sect1>
<title>Mailing lists</title>
<para>
- Usage: <muttng-doc:command name="lists"/> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
+ <muttng-doc:cmddef name="lists">regexp [regexp ...]</muttng-doc:cmddef>
</para>
<para>
- Usage: <muttng-doc:command name="unlists"/> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
+ <muttng-doc:cmddef name="unlists">regexp [regexp ...]</muttng-doc:cmddef>
</para>
<para>
- Usage: <muttng-doc:command name="subscribe"/> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
+ <muttng-doc:cmddef name="subscribe">regexp [regexp ...]</muttng-doc:cmddef>
</para>
<para>
- Usage: <muttng-doc:command name="unsubscribe"/> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
+ <muttng-doc:cmddef name="unsubscribe">regexp [regexp ...]</muttng-doc:cmddef>
</para>
<para>
against
receiving personal CCs of list messages. Also note that the generation
of the Mail-Followup-To header is controlled by the
- <muttng-doc:varref name="followup_to" link="followup-to"/>
+ <muttng-doc:varref name="followup-to"/>
configuration variable.
</para>
</sect1>
- <sect1 id="command-mailboxes"><anchor id="command-unmailboxes"/>
+ <sect1>
<title>Defining mailboxes which receive mail</title>
<para>
- Usage: <muttng-doc:command name="mailboxes"/> [!]<emphasis>filename</emphasis> [<emphasis>filename</emphasis>...]
+ <muttng-doc:cmddef name="mailboxes"> [!]filename [filename ... ]</muttng-doc:cmddef>
</para>
<para>
- Usage: <muttng-doc:command name="unmailboxes"/> [!]<emphasis>filename</emphasis> [<emphasis>filename</emphasis>...]
+ <muttng-doc:cmddef name="unmailboxes"> [!]filename [filename ... ]</muttng-doc:cmddef>
</para>
<para>
</sect1>
- <sect1 id="command-my_hdr"><anchor id="command-unmy_hdr"/>
+ <sect1>
<title>User defined headers</title>
<para>
- Usage: <muttng-doc:command name="my_hdr"/> <emphasis>string</emphasis>
+ <muttng-doc:cmddef name="my_hdr">string</muttng-doc:cmddef>
</para>
<para>
- Usage: <muttng-doc:command name="unmy_hdr"/> <emphasis>field</emphasis> [<emphasis>field</emphasis>...]
+ <muttng-doc:cmddef name="unmy_hdr">field [field ...]</muttng-doc:cmddef>
</para>
<para>
</para>
<para>
- <screen>
-my_hdr Organization: A Really Big Company, Anytown, USA</screen>
+ <muttng-doc:lstconf>
+my_hdr Organization: A Really Big Company, Anytown, USA</muttng-doc:lstconf>
</para>
<para>
<para>
If you would like to add a header field to a single message, you should
- either set the <muttng-doc:varref name="edit_headers" link="edit-headers"/>
+ either set the <muttng-doc:varref name="edit-headers"/>
variable,
or use the <emphasis>edit-headers</emphasis> function (default: ``E'')
in the send-menu so
</para>
<para>
- <screen>
-unmy_hdr to cc</screen>
+ <muttng-doc:lstconf>
+unmy_hdr to cc</muttng-doc:lstconf>
</para>
<para>
</sect1>
- <sect1 id="command-hdr_order"><anchor id="command-unhdr_order"/>
+ <sect1>
<title>Defining the order of headers when viewing messages</title>
<para>
- Usage: <muttng-doc:command name="hdr_order"/> <emphasis>header1</emphasis><emphasis>header2</emphasis> <emphasis>header3</emphasis>
+ <muttng-doc:cmddef name="hdr_order">header header [header ...]</muttng-doc:cmddef>
</para>
-
+
+ <para>
+ <muttng-doc:cmddef name="unhdr_order">[ * | header header ...]</muttng-doc:cmddef>
+ </para>
+
<para>
With this command, you can specify an order in which mutt will attempt
to present headers to you when viewing messages.
<para>
- <screen>
-hdr_order From Date: From: To: Cc: Subject:</screen>
+ <muttng-doc:lstconf>
+hdr_order From Date: From: To: Cc: Subject:</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
-save-hook aol\\.com$ +spam</screen>
+save-hook aol\\.com$ +spam</muttng-doc:lstconf>
</para>
</para>
<para>
- Example: <literal><muttng-doc:hook name="fcc"/> [@.]aol\\.com$
- +spammers
- </literal>
+ Example:
+ </para>
+
+ <para>
+ <muttng-doc:lstconf>
+fcc-hook [@.]aol\\.com$ +spammers</muttng-doc:lstconf>
</para>
<para>
- The above will save a copy of all messages going to the aol.com domain
- to
- the `+spammers' mailbox by default. Also see the <muttng-doc:hook name="fcc-save"/>
- command.
+ The above will save a copy of all messages going to the aol.com
+ domain to the `+spammers' mailbox by default. Also see the
+ <muttng-doc:hook name="fcc-save"/> command.
</para>
<para>
<para>
Example:
- <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>
+ <muttng-doc:lstconf>
+message-hook ~A 'set pager=builtin'
+message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject:.*\""'</muttng-doc:lstconf>
</para>
</sect1>
- <sect1 id="command-push">
+ <sect1>
<title>Adding key sequences to the keyboard buffer</title>
<para>
- Usage: <muttng-doc:command name="push"/> <emphasis>string</emphasis>
+ <muttng-doc:cmddef name="push">string</muttng-doc:cmddef>
</para>
<para>
This command adds the named string to the keyboard buffer. The
string may contain control characters, key names and function
- names like the sequence string in the <muttng-doc:command name="macro"/> command. You may use it to
+ names like the sequence string in the <muttng-doc:cmdref name="macro"/> command. You may use it to
automatically run a sequence of commands at startup, or when
entering certain folders. For example, the following command
will automatically collapse all threads when entering a folder:
- <screen>
-folder-hook . 'push <collapse-all>'
- </screen>
+ <muttng-doc:lstconf>
+folder-hook . 'push <collapse-all>'</muttng-doc:lstconf>
</para>
</sect1>
- <sect1 id="command-exec">
+ <sect1>
<title>Executing functions</title>
<para>
- Usage: <muttng-doc:command name="exec"/> <emphasis>function</emphasis> [<emphasis>function</emphasis>...]
+ <muttng-doc:cmddef name="exec">function [function ... ]</muttng-doc:cmddef>
</para>
<para>
</sect1>
- <sect1 id="command-score"><anchor id="command-unscore"/>
+ <sect1>
<title>Message Scoring</title>
<para>
- Usage: <muttng-doc:command name="score"/> <emphasis>pattern</emphasis> <emphasis>value</emphasis>
+ <muttng-doc:cmddef name="score">pattern value</muttng-doc:cmddef>
</para>
<para>
- Usage: <muttng-doc:command name="unscore"/> <emphasis>pattern</emphasis> [<emphasis>pattern</emphasis>...]
+ <muttng-doc:cmddef name="unscore">pattern [pattern ... ]</muttng-doc:cmddef>
</para>
<para>
<para>
- <screen>
-score "<muttng-doc:pattern name="f"/> nion@muttng\.org" 50
-score "<muttng-doc:pattern name="f"/> @sco\.com" -100</screen>
+ <muttng-doc:lstconf>
+score "~f nion@muttng\.org" 50
+score "~f @sco\.com" -100</muttng-doc:lstconf>
</para>
<para>
- <screen>
-score "<muttng-doc:pattern name="f"/> santaclaus@northpole\.int" =666</screen>
+ <muttng-doc:lstconf>
+score "~f santaclaus@northpole\.int" =666</muttng-doc:lstconf>
</para>
<para>
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"/>.
+ <muttng-doc:varref name="score-threshold-read"/>,
+ <muttng-doc:varref name="score-threshold-flag"/> and
+ <muttng-doc:varref name="score-threshold-delete"/>.
</para>
<para>
By default,
- <muttng-doc:varref name="score_threshold_read" link="score-threshold-read"/> and
- <muttng-doc:varref name="score_threshold_delete" link="score-threshold-delete"/>
+ <muttng-doc:varref name="score-threshold-read"/> and
+ <muttng-doc:varref name="score-threshold-delete"/>
are set to
<literal>-1</literal>, which means that in the default threshold
configuration no
<para>
- <screen>
-color index black yellow "<muttng-doc:pattern name="n"/> 10-"
-color index red yellow "<muttng-doc:pattern name="n"/> 100-"</screen>
+ <muttng-doc:lstconf>
+color index black yellow "~n 10-"
+color index red yellow "~n 100-"</muttng-doc:lstconf>
</para>
</sect1>
- <sect1 id="command-spam"><anchor id="command-nospam"/>
+ <sect1>
<title>Spam detection</title>
<para>
- Usage: <muttng-doc:command name="spam"/> <emphasis>pattern</emphasis> <emphasis>format </emphasis>
+ <muttng-doc:cmddef name="spam">pattern format</muttng-doc:cmddef>
</para>
<para>
- Usage: <muttng-doc:command name="nospam"/> <emphasis>pattern</emphasis>
+ <muttng-doc:cmddef name="nospam">pattern</muttng-doc:cmddef>
</para>
<para>
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
- <muttng-doc:varref name="index_format" link="index-format"/>
+ <muttng-doc:varref name="index-format"/>
variable. (Tip: try <literal>%?H?[%H] ?</literal>
to display spam tags only when they are defined for a given message.)
</para>
For example, suppose I use DCC, SpamAssassin, and PureMessage. I might
define these spam settings:
- <screen>
+ <muttng-doc:lstconf>
spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1"
spam "X-Spam-Status: Yes" "90+/SA"
spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
-set spam_separator=", "</screen>
+set spam_separator=", "</muttng-doc:lstconf>
</para>
<para>
- <screen>
-spam "^From: .*MAILER-DAEMON" "999"</screen>
+ <muttng-doc:lstconf>
+spam "^From: .*MAILER-DAEMON" "999"</muttng-doc:lstconf>
</para>
</sect1>
- <sect1 id="command-set"><anchor id="command-unset"/><anchor id="command-reset"/><anchor id="command-toggle"/>
+ <sect1>
<title>Setting variables</title>
<para>
- Usage: <muttng-doc:command name="set"/> [no|inv]<emphasis>variable</emphasis>[=<emphasis>value</emphasis>] [<emphasis>variable</emphasis>...]
+ <muttng-doc:cmddef name="set">[no|inv]variable [=value] [variable...]</muttng-doc:cmddef>
</para>
<para>
- Usage: <muttng-doc:command name="toggle"/> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>...]
+ <muttng-doc:cmddef name="toggle">variable [variable ...]</muttng-doc:cmddef>
</para>
<para>
- Usage: <muttng-doc:command name="unset"/> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>...]
+ <muttng-doc:cmddef name="unset">variable [variable ...]</muttng-doc:cmddef>
</para>
<para>
- Usage: <muttng-doc:command name="reset"/> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>...]
+ <muttng-doc:cmddef name="reset">variable [variable ...]</muttng-doc:cmddef>
</para>
<para>
<para>
- <screen>
-set ?allow_8bit</screen>
+ <muttng-doc:lstconf>
+set ?allow_8bit</muttng-doc:lstconf>
</para>
</sect1>
- <sect1 id="command-source">
+ <sect1>
<title>Reading initialization commands from another file</title>
<para>
- Usage: <muttng-doc:command name="source"/> <emphasis>filename</emphasis> [<emphasis>filename</emphasis>...]
+ <muttng-doc:cmddef name="source">filename [filename ...]</muttng-doc:cmddef>
</para>
<para>
</sect1>
- <sect1 id="command-unhook">
+ <sect1>
<title>Removing hooks</title>
<para>
- Usage: <muttng-doc:command name="unhook"/> [* | <emphasis>hook-type</emphasis>]
+ <muttng-doc:cmddef name="unhook">[* | hook-type]</muttng-doc:cmddef>
</para>
<para>
<para>
- <screen>
-set config_charset = "..."</screen>
+ <muttng-doc:lstconf>
+set config_charset = "..."</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
ifdef <item> <command>
-ifndef <item> <command></screen>
+ifndef <item> <command></muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
ifdef feature_imap 'source ~/.mutt-ng/setup-imap'
ifdef feature_pop 'source ~/.mutt-ng/setup-pop'
-ifdef feature_nntp 'source ~/.mutt-ng/setup-nntp'</screen>
+ifdef feature_nntp 'source ~/.mutt-ng/setup-nntp'</muttng-doc:lstconf>
</para>
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
- <muttng-doc:varref name="imap_mail_check" link="imap-mail-check"/>
+ <muttng-doc:varref name="imap-mail-check"/>
use:
</para>
<para>
- <screen>
-ifdef imap_mail_check 'set imap_mail_check = 300'</screen>
+ <muttng-doc:lstconf>
+ifdef imap_mail_check 'set imap_mail_check = 300'</muttng-doc:lstconf>
</para>
<para>
Provided for completeness is the test for menu names. To set
- <muttng-doc:varref name="pager_index_lines"
- link="pager-index-lines"/>
+ <muttng-doc:varref name="pager-index-lines"
+ />
only if the pager
menu is available, use:
</para>
<para>
- <screen>
-ifdef pager 'set pager_index_lines = 10'</screen>
+ <muttng-doc:lstconf>
+ifdef pager 'set pager_index_lines = 10'</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
ifdef feature_ncurses 'source ~/.mutt-ng/setup-ncurses'
-ifndef feature_ncurses 'source ~/.mutt-ng/setup-slang'</screen>
+ifndef feature_ncurses 'source ~/.mutt-ng/setup-slang'</muttng-doc:lstconf>
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
ifdef feature_slang 'source ~/.mutt-ng/setup-slang'
-ifndef feature_slang 'source ~/.mutt-ng/setup-ncurses'</screen>
+ifndef feature_slang 'source ~/.mutt-ng/setup-ncurses'</muttng-doc:lstconf>
</para>
<para>
It must be noted that in this table, <literal>EXPR</literal> is
a regular expression. For ranges, the forms
- <literal><[MAX]</literal>, <literal>>>[MIN]</literal>,
+ <literal><[MAX]</literal>, <literal>>>[MIN]</literal>,
<literal> [MIN]-</literal> and <literal>-[MAX]</literal> are
also possible.
</para>
<para>
The setting for the status bar of the index is controlled via the
- <muttng-doc:varref name="status_format" link="status-format"/>
+ <muttng-doc:varref name="status-format"/>
variable. For the hostname and version string, there's an expando
for <literal>$status_format</literal>: <literal>
%h
<para>
- <screen>
-set status_format = "%v on %h: ..."</screen>
+ <muttng-doc:lstconf>
+set status_format = "%v on %h: ..."</muttng-doc:lstconf>
</para>
<para>
- <screen>
-set status_format = "%v on %h: %B: ...</screen>
+ <muttng-doc:lstconf>
+set status_format = "%v on %h: %B: ...</muttng-doc:lstconf>
</para>
<para>
- <screen>
-set status_format = "%v on %h: %B %?n?%n new? ...</screen>
+ <muttng-doc:lstconf>
+set status_format = "%v on %h: %B %?n?%n new? ...</muttng-doc:lstconf>
</para>
<para>
<screen>
-%?<item>?<string if nonzero>?</screen>
+%?<item>?<string if nonzero>?</screen>
</para>
<para>
<screen>
-%?<item>?<string if nonzero>&<string if zero>?</screen>
+%?<item>?<string if nonzero>&<string if zero>?</screen>
</para>
<para>
- <screen>
-set status_format = "%v on %h: %B: %?n?%n new messages&no new messages? ...</screen>
+ <muttng-doc:lstconf>
+set status_format = "%v on %h: %B: %?n?%n new messages&no new messages? ...</muttng-doc:lstconf>
</para>
<para>
- <screen>
-set status_format = "%v on %h: %B: %?n?%n&no? new messages ...</screen>
+ <muttng-doc:lstconf>
+set status_format = "%v on %h: %B: %?n?%n&no? new messages ...</muttng-doc:lstconf>
</para>
<para>
- <screen>
-set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"</screen>
+ <muttng-doc:lstconf>
+set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"</muttng-doc:lstconf>
</para>
</listitem>
<para>
- <screen>
-set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"</screen>
+ <muttng-doc:lstconf>
+set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"</muttng-doc:lstconf>
</para>
</listitem>
</emphasis>
operation will
be applied to all tagged messages if that operation can be used in that
- manner. If the <muttng-doc:varref name="auto_tag" link="auto-tag"/>
+ manner. If the <muttng-doc:varref name="auto-tag"/>
variable is set, the next operation applies to the tagged messages
automatically, without requiring the ``tag-prefix''.
</para>
<para>
- In <muttng-doc:command name="macro"/> or <muttng-doc:command name="push"/> commands,
+ In <muttng-doc:cmdref name="macro"/> or <muttng-doc:cmdref name="push"/> commands,
you can use the ``tag-prefix-cond'' operator. If there are no tagged
messages, mutt will "eat" the rest of the macro to abort it's
execution.Mutt-ng will stop "eating" the macro when it encounters the
<para>
- <screen>
+ <muttng-doc:lstconf>
send-hook . 'unmy_hdr From:'
-send-hook <muttng-doc:pattern name="C"/>'^b@b\.b$' my_hdr from: c@c.c</screen>
+send-hook '~C ^b@b\.b$' my-hdr from: c@c.c</muttng-doc:lstconf>
</para>
sending
mail to a specific address, you could do something like:
- <screen>
-send-hook '<muttng-doc:pattern name="t"/> ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt-ng User <user@host>'</screen>
+ <muttng-doc:lstconf>
+send-hook '~t ^me@cs\.hmc\.edu$' 'my-hdr From: Mutt-ng User <user@host>'</muttng-doc:lstconf>
which would execute the given command when sending mail to
<emphasis>me@cs.hmc.edu</emphasis>.
and highlights the ones with new email
Use the following configuration commands:
- <screen>
+ <muttng-doc:lstconf>
set sidebar_visible="yes"
-set sidebar_width=25</screen>
+set sidebar_width=25</muttng-doc:lstconf>
</para>
<para>
If you want to specify the mailboxes you can do so with:
- <screen>
+ <muttng-doc:lstconf>
set mbox='=INBOX'
mailboxes INBOX \
MBOX1 \
MBOX2 \
-...</screen>
+...</muttng-doc:lstconf>
</para>
<para>
You can also specify the colors for mailboxes with new mails by using:
- <screen>
+ <muttng-doc:lstconf>
color sidebar_new red black
-color sidebar white black</screen>
+color sidebar white black</muttng-doc:lstconf>
</para>
<para>
Reasonable key bindings look e.g. like this:
- <screen>
+ <muttng-doc:lstconf>
bind index \Cp sidebar-prev
bind index \Cn sidebar-next
bind index \Cb sidebar-open
bind pager \Cb sidebar-open
macro index B ':toggle sidebar_visible^M'
-macro pager B ':toggle sidebar_visible^M'</screen>
+macro pager B ':toggle sidebar_visible^M'</muttng-doc:lstconf>
</para>
LDAP,
ph/qi, bbdb, or NIS through a wrapper script which connects to mutt
using a simple interface. Using the
- <muttng-doc:varref name="query_command" link="query-command"/>
+ <muttng-doc:varref name="query-command"/>
variable, you specify the wrapper
command to use. For example:
</para>
<para>
- <screen>
-set query_command = "mutt_ldap_query.pl '%s'"</screen>
+ <muttng-doc:lstconf>
+set query_command = "mutt_ldap_query.pl '%s'"</muttng-doc:lstconf>
</para>
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
- <muttng-doc:varref name="mbox_type" link="mbox-type"/>
+ <muttng-doc:varref name="mbox-type"/>
variable.
</para>
<para>
- <screen>
-From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST</screen>
+ <muttng-doc:lstmail>
+From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST</muttng-doc:lstmail>
</para>
<listitem>
<para>
- ! -- refers to your <muttng-doc:varref name="spoolfile" link="spoolfile"/>
+ ! -- refers to your <muttng-doc:varref name="spoolfile"/>
(incoming) mailbox
</para>
</listitem>
<listitem>
<para>
- > -- refers to your <muttng-doc:varref name="mbox" link="mbox"/> file
+ > -- refers to your <muttng-doc:varref name="mbox"/> file
</para>
</listitem>
<listitem>
<para>
- < -- refers to your <muttng-doc:varref name="record" link="record"/> file
+ < -- refers to your <muttng-doc:varref name="record"/> file
</para>
</listitem>
<listitem>
<listitem>
<para>
- = or + -- refers to your <muttng-doc:varref name="folder" link="folder"/>
+ = or + -- refers to your <muttng-doc:varref name="folder"/>
directory
</para>
</listitem>
know what addresses you consider to be mailing lists (technically
this does not have to be a mailing list, but that is what it is most
often used for), and what lists you are subscribed to. This is
- accomplished through the use of the <muttng-doc:command name="lists"/>
+ accomplished through the use of the <muttng-doc:cmdref name="lists"/>
commands in your muttrc.
</para>
the <emphasis>index</emphasis> menu display. This is useful to
distinguish between
personal and list mail in the same mailbox. In the
- <muttng-doc:varref name="index_format" link="index-format"/>
+ <muttng-doc:varref name="index-format"/>
variable, the escape ``%L''
will return the string ``To <list>'' when ``list'' appears in the
``To'' field, and ``Cc <list>'' when it appears in the ``Cc''
Mutt-ng also supports the <literal>Mail-Followup-To</literal> header.
When you send
a message to a list of recipients which includes one or several
- subscribed mailing lists, and if the <muttng-doc:varref name="followup_to" link="followup-to"/>
+ subscribed mailing lists, and if the <muttng-doc:varref name="followup-to"/>
option is set, mutt will generate
a Mail-Followup-To header which contains all the recipients to whom
you send this message, but not your address. This indicates that
Conversely, when group-replying or list-replying to a message which
has a <literal>Mail-Followup-To</literal> header, mutt will respect
this header if
- the <muttng-doc:varref name="honor_followup_to" link="honor-followup-to"/>
+ the <muttng-doc:varref name="honor-followup-to"/>
configuration
variable is set. Using list-reply will in this case also make sure
that the reply goes to the mailing list, even if it's not specified
than the author of the message. This can create problems when trying
to reply directly to the author in private, since most mail clients
will automatically reply to the address given in the ``Reply-To''
- field. Mutt-ng uses the <muttng-doc:varref name="reply_to" link="reply-to"/>
+ field. Mutt-ng uses the <muttng-doc:varref name="reply-to"/>
variable to help decide which address to use. If set to <emphasis>
ask-yes
</emphasis>
<para>
The ``X-Label:'' header field can be used to further identify mailing
lists or list subject matter (or just to annotate messages
- individually). The <muttng-doc:varref name="index_format" link="index-format"/>
+ individually). The <muttng-doc:varref name="index-format"/>
variable's ``%y'' and
``%Y'' escapes can be used to expand ``X-Label:'' fields in the
index, and Mutt-ng's pattern-matcher can match regular expressions to
<listitem>
<para>
- <muttng-doc:varref name="dsn_notify" link="dsn-notify"/> is used
+ <muttng-doc:varref name="dsn-notify"/> is used
to request receipts for different results (such as failed
message,message delivered, etc.).
<listitem>
<para>
- <muttng-doc:varref name="dsn_return" link="dsn-return"/> requests
+ <muttng-doc:varref name="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
- <muttng-doc:varref name="pop_mail_check" link="pop-mail-check"/>
+ <muttng-doc:varref name="pop-mail-check"/>
variable, which defaults to every 60 seconds.
</para>
(default: G). It allows to connect to <link
linkend="pop-host">pop-host</link>
,fetch all your new mail and place it in the
- local <muttng-doc:varref name="spoolfile" link="spoolfile"/>. After this
+ local <muttng-doc:varref name="spoolfile"/>. After this
point, Mutt-ng runs exactly as if the mail had always been local.
</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
- <muttng-doc:varref name="imap_list_subscribed" link="imap-list-subscribed"/>
+ <muttng-doc:varref name="imap-list-subscribed"/>
variable.
</para>
Polling for new mail on an IMAP server can cause noticeable delays. So,
you'll
want to carefully tune the
- <muttng-doc:varref name="imap_mail_check" link="imap-mail-check"/>
+ <muttng-doc:varref name="imap-mail-check"/>
and
- <muttng-doc:varref name="timeout" link="timeout"/>
+ <muttng-doc:varref name="timeout"/>
variables.
</para>
<listitem>
<para>
- <muttng-doc:varref name="imap_user" link="imap-user"/> - controls
+ <muttng-doc:varref name="imap-user"/> - controls
the username under which you request authentication on the IMAP
server,
for all authenticators. This is overridden by an explicit
<listitem>
<para>
- <muttng-doc:varref name="imap_pass" link="imap-pass"/> - a
+ <muttng-doc:varref name="imap-pass"/> - a
password which you may preset, used by all authentication
methods where
a password is needed.
<listitem>
<para>
- <muttng-doc:varref name="imap_authenticators" link="imap-authenticators"/>
+ <muttng-doc:varref name="imap-authenticators"/>
- a colon-delimited list of IMAP
authentication methods to try, in the order you wish to try
them. If
If compiled with ``--enable-nntp'' option, Mutt-ng can read news from
a newsserver via NNTP. You can open a newsgroup with the
``change-newsgroup'' function from the index/pager which is by default
- bound to <literal>i</literal>.
+ bound to <muttng-doc:key>i</muttng-doc:key>.
</para>
<para>
environment variable. Like other
news readers,
info about subscribed newsgroups is saved in a file as specified by the
- <muttng-doc:varref name="nntp_newsrc" link="nntp-newsrc"/> variable.
+ <muttng-doc:varref name="nntp-newsrc"/> variable.
Article headers are cached and can be loaded from a file when a
newsgroup is entered instead loading from newsserver; currently, this
caching mechanism still is different from the header caching for
<para>
- <screen>
-score <muttng-doc:pattern name="*"/> =42</screen>
+ <muttng-doc:lstconf>
+score ~* =42</muttng-doc:lstconf>
</para>
<para>
- <screen>
-score !<muttng-doc:pattern name="*"/> =42</screen>
+ <muttng-doc:lstconf>
+score !~* =42</muttng-doc:lstconf>
</para>
support includes support for Delivery Status Notification
(see <link linkend="dsn">dsn</link> section) as well as
handling the <literal>8BITMIME</literal> flag controlled via
- <muttng-doc:varref name="use_8bitmime" link="use-8bitmime"/>.
+ <muttng-doc:varref name="use-8bitmime"/>.
</para>
<para>
To enable sending mail directly via SMTP without an MTA such as
- Postfix or SSMTP and the like, simply set the <muttng-doc:varref name="smtp_host" link="smtp-host"/>
+ Postfix or SSMTP and the like, simply set the <muttng-doc:varref name="smtp-host"/>
variable pointing to your SMTP server.
</para>
<para>
- Authentication mechanisms are available via the <muttng-doc:varref name="smtp_user" link="smtp-user"/>
- and <muttng-doc:varref name="smtp_pass" link="smtp-pass"/> variables.
+ Authentication mechanisms are available via the <muttng-doc:varref name="smtp-user"/>
+ and <muttng-doc:varref name="smtp-pass"/> variables.
</para>
<para>
Transport Encryption via the StartTLS command is also available. For
this to work, first of all Mutt-ng must be built with SSL or GNUTLS.
- Secondly, the <muttng-doc:varref name="smtp_use_tls" link="smtp-use-tls"/> variable
+ Secondly, the <muttng-doc:varref name="smtp-use-tls"/> variable
must be either set
to ``enabled'' or ``required.'' In both cases, StartTLS will be used if
the server supports it: for the second case, the connection will fail
sender, i.e. they allow for only one value which may not be what the
user wants to send as the <literal>From:</literal> header. In this
case, the variable
- <muttng-doc:varref name="smtp_envelope" link="smtp-envelope"/> may be used
+ <muttng-doc:varref name="smtp-envelope"/> may be used
to set the envelope different from the <literal>From:</literal> header.
</para>
<para>
- <screen>
+ <muttng-doc:lstconf>
account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
-account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'</screen>
+account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'</muttng-doc:lstconf>
</para>
retrieved at <muttng-doc:web url="ftp://ftp.mutt.org/mutt/contrib/"/>
and the configuration commands:
- <screen>
+ <muttng-doc:lstconf>
macro index \cb |urlview\n
-macro pager \cb |urlview\n</screen>
+macro pager \cb |urlview\n</muttng-doc:lstconf>
</para>
<para>
- <screen>
-open-hook \\.gz$ "gzip -cd %f > %t"
-close-hook \\.gz$ "gzip -c %t > %f"
-append-hook \\.gz$ "gzip -c %t >> %f" </screen>
+ <muttng-doc:lstconf>
+open-hook \\.gz$ "gzip -cd %f > %t"
+close-hook \\.gz$ "gzip -c %t > %f"
+append-hook \\.gz$ "gzip -c %t >> %f" </muttng-doc:lstconf>
</para>
use of programs that do not have well defined extensions. Just use
"." as a regexp. But this may be surprising if your
compressing script produces empty files. In this situation, unset
- <muttng-doc:varref name="save_empty" link="save-empty"/>
+ <muttng-doc:varref name="save-empty"/>
,so that the compressed file
will be removed if you delete all of the messages.
</para>
<para>
- <screen>
-open-hook \\.gz$ "gzip -cd %f > %t"
-</screen>
+ <muttng-doc:lstconf>
+open-hook \\.gz$ "gzip -cd %f > %t"</muttng-doc:lstconf>
</para>
<para>
- <screen>
-close-hook \\.gz$ "gzip -c %t > %f"</screen>
+ <muttng-doc:lstconf>
+close-hook \\.gz$ "gzip -c %t > %f"</muttng-doc:lstconf>
</para>
<para>
- <screen>
-append-hook \\.gz$ "gzip -c %t >> %f" </screen>
+ <muttng-doc:lstconf>
+append-hook \\.gz$ "gzip -c %t >> %f" </muttng-doc:lstconf>
</para>
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 (<muttng-doc:varref name="mbox_type" link="mbox-type"/>
+ what the folder type is. Thus the default (<muttng-doc:varref name="mbox-type"/>
)type is always supposed (i.e.
this is the format used for the temporary folder).
</para>
<para>
- <screen>
-open-hook \\.pgp$ "pgp -f < %f > %t"
-close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId < %t > %f"
-</screen>
+ <muttng-doc:lstconf>
+open-hook \\.pgp$ "pgp -f < %f > %t"
+close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId < %t > %f"</muttng-doc:lstconf>
</para>
Attachments appear as follows:
<screen>
-1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no description>
-2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no description></screen>
+1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no description>
+2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no description></screen>
</para>
parameters
in expansion of %s syntaxes properly, and avoids risky
characters by
- substituting them, see the <muttng-doc:varref name="mailcap_sanitize" link="mailcap-sanitize"/>
+ substituting them, see the <muttng-doc:varref name="mailcap-sanitize"/>
variable.
</para>
<term>needsterminal</term>
<listitem>
<para>
- Mutt-ng uses this flag when viewing attachments with <muttng-doc:command name="auto_view"/>,
+ Mutt-ng uses this flag when viewing attachments with <muttng-doc:cmdref name="auto_view"/>,
in order to decide whether it should honor the setting
- of the <muttng-doc:varref name="wait_key" link="wait-key"/> variable or
+ of the <muttng-doc:varref name="wait-key"/> variable or
not. When an attachment is viewed using an interactive
program, and the
corresponding mailcap entry has a <emphasis>needsterminal</emphasis> flag, Mutt-ng will use
- <muttng-doc:varref name="wait_key" link="wait-key"/> and the exit
+ <muttng-doc:varref name="wait-key"/> and the exit
statusof the program to decide if it will ask you to press
a key after the
external program has exited. In all other situations it
</para>
<para>
- In addition, you can use this with <muttng-doc:command name="auto_view"/>
+ In addition, you can use this with <muttng-doc:cmdref name="auto_view"/>
to denote two commands for viewing an attachment, one to be viewed
automatically, the other to be viewed interactively from the
attachment
text/html; lynx %s; nametemplate=%s.html
text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput</screen>
- For <muttng-doc:command name="auto_view"/>, Mutt-ng will choose
+ For <muttng-doc:cmdref name="auto_view"/>, Mutt-ng will choose
the third
entry because of the copiousoutput tag. For interactive viewing,
Mutt
instance, if
Your mail message contains:
- <screen>
-Content-Type: text/plain; charset=iso-8859-1</screen>
+ <muttng-doc:lstmail>
+Content-Type: text/plain; charset=iso-8859-1</muttng-doc:lstmail>
then Mutt-ng will expand %{charset} to
iso-8859-1. The default metamail
<screen>>
# I'm always running X :)
-video/*; xanim %s > /dev/null
-image/*; xv %s > /dev/null
+video/*; xanim %s > /dev/null
+image/*; xv %s > /dev/null
# I'm always running netscape (if my computer had more memory, maybe)
text/html; netscape -remote 'openURL(%s)'</screen>
<screen>
# Use xanim to view all videos Xanim produces a header on startup,
# send that to /dev/null so I don't see it
-video/*; xanim %s > /dev/null
+video/*; xanim %s > /dev/null
# Send html to a running netscape by remote
text/html; netscape -remote 'openURL(%s)'; test=RunningNetscape
image/*;xv %s; test=RunningX; edit=xpaint %s
# Convert images to text using the netpbm tools
-image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
-pbmtoascii -1x2 ) 2>&1 ; copiousoutput
+image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | \
+pgmtopbm | pbmtoascii -1x2 ) 2>&1 ; copiousoutput
# Send excel spreadsheets to my NT box
application/ms-excel; open.pl %s</screen>
</sect1>
- <sect1 id="command-auto_view"><anchor id="command-unauto_view"/>
+ <sect1>
<title>MIME Autoview</title>
-
+
+ <para>
+ <muttng-doc:cmddef name="auto_view">mime-type [mime-type ...]</muttng-doc:cmddef>
+ </para>
+
+ <para>
+ <muttng-doc:cmddef name="unauto_view">mime-type [mime-type ...]</muttng-doc:cmddef>
+ </para>
+
<para>
In addition to explicitly telling Mutt-ng to view an attachment with
theMIME viewer defined in the mailcap file, Mutt-ng has support for
<para>
For instance, if you set auto_view to:
- <screen>
+ <muttng-doc:lstconf>
auto_view text/html application/x-gunzip application/postscript
-image/gif application/x-tar-gz</screen>
+image/gif application/x-tar-gz</muttng-doc:lstconf>
</para>
</sect1>
- <sect1 id="command-alternative_order"><anchor id="command-unalternative_order"/>
+ <sect1>
<title>MIME Multipart/Alternative</title>
+
+ <para>
+ <muttng-doc:cmddef name="alternative_order">mime-type [mime-type ...]</muttng-doc:cmddef>
+ </para>
+ <para>
+ <muttng-doc:cmddef name="unalternative_order">mime-type [mime-type ...]</muttng-doc:cmddef>
+ </para>
+
<para>
Mutt-ng has some heuristics for determining which attachment of a
multipart/alternative type to display. First, mutt will check the
number of
MIME types in order, including support for implicit and explicit
wildcards, for example:
-
- <screen>
+
+ <muttng-doc:lstconf>
alternative_order text/enriched text/plain text
-application/postscript image/*</screen>
+application/postscript image/*</muttng-doc:lstconf>
</para>
<para>
Next, mutt will check if any of the types have a defined
- <muttng-doc:command name="auto_view"/>, and use that. Failing
+ <muttng-doc:cmdref name="auto_view"/>, and use that. Failing
that, Mutt-ng will look for any text type. As a last attempt, mutt
willlook for any type it knows how to handle.
</para>
</para>
</sect1>
-
- <sect1 id="command-mime_lookup"><anchor id="command-unmime_lookup"/>
+
+ <sect1 id="attachments">
+ <title>Attachment Searching and Counting</title>
+
+ <para>
+ If you ever lose track of attachments in your mailboxes, Mutt's
+ attachment-counting and -searching support might be for you. You
+ can make your message index display the number of qualifying
+ attachments in each message, or search for messages by
+ attachment count. You also can configure what kinds of
+ attachments qualify for this feature with the attachments and
+ unattachments commands.
+ </para>
+
+<para>
+The syntax is:
+</para>
+
+<para>
+ <muttng-doc:cmddef name="attachments">
+ ( {+|-}disposition mime-type | ? )
+ </muttng-doc:cmddef>
+</para>
+<para>
+ <muttng-doc:cmddef name="unattachments">
+ {+|-}disposition mime-type
+ </muttng-doc:cmddef>
+</para>
+
+<para>
+Disposition is the attachment's Content-disposition type -- either
+"inline" or "attachment". You can abbreviate this to I or A.
+</para>
+
+<para>
+Disposition is prefixed by either a + symbolor a - symbol. If it's
+a +, you're saying that you want to allow this disposition and MIME
+type to qualify. If it's a -, you're saying that this disposition
+and MIME type is an exception to previous + rules. There are examples
+below of how this is useful.
+</para>
+
+<para>
+Mime-type is, unsurprisingly, the MIME type of the attachment you want
+to affect. A MIME type is always of the format "major/minor", where
+"major" describes the broad category of document you're looking at, and
+"minor" describes the specific type within that category. The major
+part of mim-type must be literal text (or the special token "*"), but
+the minor part may be a regular expression. (Therefore, "*/.*" matches
+any MIME type.)
+</para>
+
+<para>
+The MIME types you give to the attachments directive are a kind of
+pattern. When you use the attachments directive, the patterns you
+specify are added to a list. When you use unattachments, the pattern
+is removed from the list. The patterns are not expanded and matched
+to specific MIME types at this time -- they're just text in a list.
+They're only matched when actually evaluating a message.
+</para>
+
+<para>
+Some examples might help to illustrate. The examples that are not
+commented out define the default configuration of the lists.
+</para>
+
+<screen>
+## Removing a pattern from a list removes that pattern literally. It
+## does not remove any type matching the pattern.
+##
+## attachments +A */.*
+## attachments +A image/jpeg
+## unattachments +A */.*
+##
+## This leaves "attached" image/jpeg files on the allowed attachments
+## list. It does not remove all items, as you might expect, because the
+## second */.* is not a matching expression at this time.
+##
+## Remember: "unattachments" only undoes what "attachments" has done!
+## It does not trigger any matching on actual messages.
+
+
+## Qualify any MIME part with an "attachment" disposition, EXCEPT for
+## text/x-vcard and application/pgp parts. (PGP parts are already known
+## to mutt, and can be searched for with ~g, ~G, and ~k.)
+##
+## I've added x-pkcs7 to this, since it functions (for S/MIME)
+## analogously to PGP signature attachments. S/MIME isn't supported
+## in a stock mutt build, but we can still treat it specially here.
+##
+attachments +A */.*
+attachments -A text/x-vcard application/pgp.*
+attachments -A application/x-pkcs7-.*
+
+## Discount all MIME parts with an "inline" disposition, unless they're
+## text/plain. (Why inline a text/plain part unless it's external to the
+## message flow?)
+##
+attachments +I text/plain
+
+## These two lines make Mutt qualify MIME containers. (So, for example,
+## a message/rfc822 forward will count as an attachment.) The first
+## line is unnecessary if you already have "attach-allow */.*", of
+## course. These are off by default! The MIME elements contained
+## within a message/* or multipart/* are still examined, even if the
+## containers themseves don't qualify.
+##
+#attachments +A message/.* multipart/.*
+#attachments +I message/.* multipart/.*
+
+## You probably don't really care to know about deleted attachments.
+attachments -A message/external-body
+attachments -I message/external-body
+</screen>
+
+<para>
+"attachments ?" will list your current settings in Muttrc format, so
+that it can be pasted elsewhere.
+</para>
+
+</sect1>
+
+ <sect1>
<title>MIME Lookup</title>
-
+
+ <para>
+ <muttng-doc:cmddef name="mime_lookup">mime-type [mime-type ...]</muttng-doc:cmddef>
+ </para>
+
+ <para>
+ <muttng-doc:cmddef name="unmime_lookup">mime-type [mime-type ...]</muttng-doc:cmddef>
+ </para>
+
<para>
Mutt-ng's mime_lookup list specifies a list of mime-types that
should not
configuration
options (such as auto_view) specified. Common usage would be:
- <screen>
-mime_lookup application/octet-stream application/X-Lotus-Manuscript</screen>
+ <muttng-doc:lstconf>
+mime_lookup application/octet-stream application/X-Lotus-Manuscript</muttng-doc:lstconf>
</para>
<para>
Mutt-ng uses many temporary files for viewing messages, verifying
- digital signatures, etc. The <muttng-doc:varref name="umask" link="umask"/>
+ digital signatures, etc. The <muttng-doc:varref name="umask"/>
variable can be used to change the default permissions of these
files. Please only change it if you really know what you are doing.
Also, a different location for these files may be desired which can
- be changed via the <muttng-doc:varref name="tmpdir" link="tmpdir"/> variable.
+ be changed via the <muttng-doc:varref name="tmpdir"/> variable.
</para>
</sect1>
information probably telling others how many mail you sent in which
time, you at least need to remove the <literal>%P</literal>
expando from the
- default setting of the <muttng-doc:varref name="msgid_format" link="msgid-format"/> variable. Please make sure that
+ default setting of the <muttng-doc:varref name="msgid-format"/> variable. Please make sure that
you really know how local parts of these <literal>Message-ID:</literal> headers
are composed.
</para>
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 <muttng-doc:varref name="edit_headers" link="edit-headers"/>
+ problematic if the <muttng-doc:varref name="edit-headers"/>
variable is <emphasis>unset</emphasis>, i.e. the
user doesn't want to see header fields while editing the message.
</para>
</para>
<para>
- When <emphasis>unsetting</emphasis> the <muttng-doc:varref name="strict_mailto" link="strict-mailto"/>
+ When <emphasis>unsetting</emphasis> the <muttng-doc:varref name="strict-mailto"/>
variable, mutt-ng will
</para>
<listitem>
<para>
- turn on the <muttng-doc:varref name="edit_headers" link="edit-headers"/>
+ turn on the <muttng-doc:varref name="edit-headers"/>
variable by
force to let the user see all the headers
(because they still may leak information.)
by <muttng-doc:rfc num="1524"/>. Mutt-ng can be set up to <emphasis>automatically</emphasis>
execute any
given utility as listed in one of the mailcap files (see the
- <muttng-doc:varref name="mailcap_path" link="mailcap-path"/>
+ <muttng-doc:varref name="mailcap-path"/>
variable for details.)
</para>
<listitem>
<para>
- leave the <muttng-doc:varref name="mailcap_sanitize" link="mailcap-sanitize"/> variable in its default
+ leave the <muttng-doc:varref name="mailcap-sanitize"/> variable in its default
state to restrict mailcap expandos to a safe set of characters
</para>
<para>
- <table frame="none" rowsep="1">
+ <table frame="none" rowsep="1" texstr="l|l">
<title>Reference: Command Line Options</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
<para>
- <table frame="none" rowsep="1" id="tab-patterns">
+ <table frame="none" rowsep="1" id="tab-patterns" texstr="l|l|l">
<title>Reference: Patterns</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
<entry><literal>EXPR</literal></entry>
<entry>messages which contain EXPR in the `References' field</entry>
</row>
+ <row>
+ <entry><muttng-doc:pattern full="1" name="X"/></entry>
+ <entry><literal>[MIN]-[MAX]</literal></entry>
+ <entry>messages with MIN to MAX attachments *)</entry>
+ </row>
<row>
<entry><muttng-doc:pattern full="1" name="y"/></entry>
<entry><literal>EXPR</literal></entry>
<listitem>
<para>
- <literal><muttng-doc:command name="alias"/></literal> <emphasis>key</emphasis> <emphasis>address</emphasis> [, <emphasis>address</emphasis>, ... ]
+ <literal><muttng-doc:cmdref name="alias"/></literal> <emphasis>key</emphasis> <emphasis>address</emphasis> [, <emphasis>address</emphasis>, ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="unalias"/></literal> [ * | <emphasis>key</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="unalias"/></literal> [ * | <emphasis>key</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="alternates"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="alternates"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="unalternates"/></literal> [ * | <emphasis>regexp</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="unalternates"/></literal> [ * | <emphasis>regexp</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="alternative_order"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="alternative_order"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="unalternative_order"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="unalternative_order"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
</para>
</listitem>
<listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="auto_view"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="auto_view"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="unauto_view"/></literal><emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="unauto_view"/></literal><emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="bind"/></literal> <emphasis>map</emphasis> <emphasis>key</emphasis> <emphasis>function</emphasis>
+ <literal><muttng-doc:cmdref name="bind"/></literal> <emphasis>map</emphasis> <emphasis>key</emphasis> <emphasis>function</emphasis>
</para>
</listitem>
<listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="color"/></literal> <emphasis>object</emphasis> <emphasis>foreground</emphasis> <emphasis>background</emphasis> [ <emphasis>regexp</emphasis> ]
+ <literal><muttng-doc:cmdref name="color"/></literal> <emphasis>object</emphasis> <emphasis>foreground</emphasis> <emphasis>background</emphasis> [ <emphasis>regexp</emphasis> ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="uncolor"/></literal> <emphasis>index</emphasis> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="uncolor"/></literal> <emphasis>index</emphasis> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="exec"/></literal> <emphasis>function</emphasis> [ <emphasis>function</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="exec"/></literal> <emphasis>function</emphasis> [ <emphasis>function</emphasis> ... ]
</para>
</listitem>
<listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="hdr_order"/></literal> <emphasis>header</emphasis> [ <emphasis>header</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="hdr_order"/></literal> <emphasis>header</emphasis> [ <emphasis>header</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="unhdr_order"/></literal> <emphasis>header</emphasis> [ <emphasis>header</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="unhdr_order"/></literal> <emphasis>header</emphasis> [ <emphasis>header</emphasis> ... ]
</para>
</listitem>
<listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="ignore"/></literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="ignore"/></literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="unignore"/></literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="unignore"/></literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="lists"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="lists"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="unlists"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="unlists"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="macro"/></literal> <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>sequence</emphasis> [ <emphasis>description</emphasis> ]
+ <literal><muttng-doc:cmdref name="macro"/></literal> <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>sequence</emphasis> [ <emphasis>description</emphasis> ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="mailboxes"/></literal> <emphasis>filename</emphasis> [ <emphasis>filename</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="mailboxes"/></literal> <emphasis>filename</emphasis> [ <emphasis>filename</emphasis> ... ]
</para>
</listitem>
<listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="mime_lookup"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="mime_lookup"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
<literal>
- <muttng-doc:command name="unmime_lookup"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
+ <muttng-doc:cmdref name="unmime_lookup"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="mono"/></literal> <emphasis>object attribute</emphasis> [ <emphasis>regexp</emphasis> ]
+ <literal><muttng-doc:cmdref name="mono"/></literal> <emphasis>object attribute</emphasis> [ <emphasis>regexp</emphasis> ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="unmono"/></literal> <emphasis>index</emphasis> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="unmono"/></literal> <emphasis>index</emphasis> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="my_hdr"/></literal> <emphasis>string</emphasis>
+ <literal><muttng-doc:cmdref name="my_hdr"/></literal> <emphasis>string</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="unmy_hdr"/></literal> <emphasis>field</emphasis> [ <emphasis>field</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="unmy_hdr"/></literal> <emphasis>field</emphasis> [ <emphasis>field</emphasis> ... ]
</para>
</listitem>
<listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="push"/></literal> <emphasis>string</emphasis>
+ <literal><muttng-doc:cmdref name="push"/></literal> <emphasis>string</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="reset"/> </literal><emphasis>variable</emphasis> [ <emphasis>variable</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="reset"/> </literal><emphasis>variable</emphasis> [ <emphasis>variable</emphasis> ... ]
</para>
</listitem>
<listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="score"/> </literal> <emphasis>pattern</emphasis> <emphasis>value</emphasis>
+ <literal><muttng-doc:cmdref name="score"/> </literal> <emphasis>pattern</emphasis> <emphasis>value</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="unscore"/></literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="unscore"/></literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
</para>
</listitem>
<listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="set"/></literal> [no|inv]<emphasis>variable</emphasis>[ =<emphasis>value</emphasis> ] [ <emphasis>variable</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="set"/></literal> [no|inv]<emphasis>variable</emphasis>[ =<emphasis>value</emphasis> ] [ <emphasis>variable</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="unset"/></literal> <emphasis>variable</emphasis> [ <emphasis>variable</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="unset"/></literal> <emphasis>variable</emphasis> [ <emphasis>variable</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="source"/></literal> <emphasis>filename</emphasis>
+ <literal><muttng-doc:cmdref name="source"/></literal> <emphasis>filename</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="spam"/></literal> <emphasis>pattern</emphasis> <emphasis>format</emphasis>
+ <literal><muttng-doc:cmdref name="spam"/></literal> <emphasis>pattern</emphasis> <emphasis>format</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="nospam"/></literal> <emphasis>pattern</emphasis>
+ <literal><muttng-doc:cmdref name="nospam"/></literal> <emphasis>pattern</emphasis>
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="subscribe"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="subscribe"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="unsubscribe"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="unsubscribe"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="toggle"/></literal> <emphasis>variable</emphasis> [ <emphasis>variable</emphasis> ... ]
+ <literal><muttng-doc:cmdref name="toggle"/></literal> <emphasis>variable</emphasis> [ <emphasis>variable</emphasis> ... ]
</para>
</listitem>
<listitem>
<para>
- <literal><muttng-doc:command name="unhook"/></literal> <emphasis>hook-type</emphasis>
+ <literal><muttng-doc:cmdref name="unhook"/></literal> <emphasis>hook-type</emphasis>
</para>
</listitem>
<para>
<anchor id="sect-obsolete"/>
- <table frame="none" rowsep="1">
+ <table frame="none" rowsep="1" texstr="l|l">
<title>Reference: Obsolete Variables</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<thead>
<tbody>
<row>
<entry><literal>edit_hdrs</literal></entry>
- <entry><muttng-doc:varref name="edit_headers" link="edit-headers"/></entry>
+ <entry><muttng-doc:varref name="edit-headers"/></entry>
</row>
<row>
<entry><literal>forw_decode</literal></entry>
- <entry><muttng-doc:varref name="forward_decode" link="forward-decode"/></entry>
+ <entry><muttng-doc:varref name="forward-decode"/></entry>
</row>
<row>
<entry><literal>forw_format</literal></entry>
- <entry><muttng-doc:varref name="forward_format" link="forward-format"/></entry>
+ <entry><muttng-doc:varref name="forward-format"/></entry>
</row>
<row>
<entry><literal>forw_quote</literal></entry>
- <entry><muttng-doc:varref name="forward_quote" link="forward-quote"/></entry>
+ <entry><muttng-doc:varref name="forward-quote"/></entry>
</row>
<row>
<entry><literal>hdr_format</literal></entry>
- <entry><muttng-doc:varref name="index_format" link="index-format"/></entry>
+ <entry><muttng-doc:varref name="index-format"/></entry>
</row>
<row>
<entry><literal>indent_str</literal></entry>
- <entry><muttng-doc:varref name="indent_string" link="indent-string"/></entry>
+ <entry><muttng-doc:varref name="indent-string"/></entry>
</row>
<row>
<entry><literal>mime_fwd</literal></entry>
- <entry><muttng-doc:varref name="mime_forward" link="mime-forward"/></entry>
+ <entry><muttng-doc:varref name="mime-forward"/></entry>
</row>
<row>
<entry><literal>msg_format</literal></entry>
- <entry><muttng-doc:varref name="message_format" link="message-format"/></entry>
+ <entry><muttng-doc:varref name="message-format"/></entry>
</row>
<row>
<entry><literal>pgp_autosign</literal></entry>
- <entry><muttng-doc:varref name="crypt_autosign" link="crypt-autosign"/></entry>
+ <entry><muttng-doc:varref name="crypt-autosign"/></entry>
</row>
<row>
<entry><literal>pgp_autoencrypt</literal></entry>
- <entry><muttng-doc:varref name="crypt_autoencrypt" link="crypt-autoencrypt"/></entry>
+ <entry><muttng-doc:varref name="crypt-autoencrypt"/></entry>
</row>
<row>
<entry><literal>pgp_replyencrypt</literal></entry>
- <entry><muttng-doc:varref name="crypt_replyencrypt" link="crypt-replyencrypt"/></entry>
+ <entry><muttng-doc:varref name="crypt-replyencrypt"/></entry>
</row>
<row>
<entry><literal>pgp_replysign</literal></entry>
- <entry><muttng-doc:varref name="crypt_replysign" link="crypt-replysign"/></entry>
+ <entry><muttng-doc:varref name="crypt-replysign"/></entry>
</row>
<row>
<entry><literal>pgp_replysignencrypted</literal></entry>
- <entry><muttng-doc:varref name="crypt_replysignencrypted" link="crypt-replysignencrypted"/></entry>
+ <entry><muttng-doc:varref name="crypt-replysignencrypted"/></entry>
</row>
<row>
<entry><literal>pgp_verify_sig</literal></entry>
- <entry><muttng-doc:varref name="crypt_verify_sig" link="crypt-verify-sig"/></entry>
+ <entry><muttng-doc:varref name="crypt-verify-sig"/></entry>
</row>
<row>
<entry><literal>pgp_create_traditional</literal></entry>
- <entry><muttng-doc:varref name="pgp_autoinline" link="pgp-autoinline"/></entry>
+ <entry><muttng-doc:varref name="pgp-autoinline"/></entry>
</row>
<row>
<entry><literal>pgp_auto_traditional</literal></entry>
- <entry><muttng-doc:varref name="pgp_replyinline" link="pgp-replyinline"/></entry>
+ <entry><muttng-doc:varref name="pgp-replyinline"/></entry>
</row>
<row>
<entry><literal>forw_decrypt</literal></entry>
- <entry><muttng-doc:varref name="forward_decrypt" link="forward-decrypt"/></entry>
+ <entry><muttng-doc:varref name="forward-decrypt"/></entry>
</row>
<row>
<entry><literal>smime_sign_as</literal></entry>
- <entry><muttng-doc:varref name="smime_default_key" link="smime-default-key"/></entry>
+ <entry><muttng-doc:varref name="smime-default-key"/></entry>
</row>
<row>
<entry><literal>post_indent_str</literal></entry>
- <entry><muttng-doc:varref name="post_indent_string" link="post-indent-string"/></entry>
+ <entry><muttng-doc:varref name="post-indent-string"/></entry>
</row>
<row>
<entry><literal>print_cmd</literal></entry>
- <entry><muttng-doc:varref name="print_command" link="print-command"/></entry>
+ <entry><muttng-doc:varref name="print-command"/></entry>
</row>
<row>
<entry><literal>shorten_hierarchy</literal></entry>
- <entry><muttng-doc:varref name="sidebar_shorten_hierarchy" link="sidebar-shorten-hierarchy"/></entry>
+ <entry><muttng-doc:varref name="sidebar-shorten-hierarchy"/></entry>
</row>
<row>
<entry><literal>ask_followup_to</literal></entry>
- <entry><muttng-doc:varref name="nntp_ask_followup_to" link="nntp-ask-followup-to"/></entry>
+ <entry><muttng-doc:varref name="nntp-ask-followup-to"/></entry>
</row>
<row>
<entry><literal>ask_x_comment_to</literal></entry>
- <entry><muttng-doc:varref name="nntp_ask_x_comment_to" link="nntp-ask-x-comment-to"/></entry>
+ <entry><muttng-doc:varref name="nntp-ask-x-comment-to"/></entry>
</row>
<row>
<entry><literal>catchup_newsgroup</literal></entry>
- <entry><muttng-doc:varref name="nntp_catchup" link="nntp-catchup"/></entry>
+ <entry><muttng-doc:varref name="nntp-catchup"/></entry>
</row>
<row>
<entry><literal>followup_to_poster</literal></entry>
- <entry><muttng-doc:varref name="nntp_followup_to_poster" link="nntp-followup-to-poster"/></entry>
+ <entry><muttng-doc:varref name="nntp-followup-to-poster"/></entry>
</row>
<row>
<entry><literal>group_index_format</literal></entry>
- <entry><muttng-doc:varref name="nntp_group_index_format" link="nntp-group-index-format"/></entry>
+ <entry><muttng-doc:varref name="nntp-group-index-format"/></entry>
</row>
<row>
<entry><literal>inews</literal></entry>
- <entry><muttng-doc:varref name="nntp_inews" link="nntp-inews"/></entry>
+ <entry><muttng-doc:varref name="nntp-inews"/></entry>
</row>
<row>
<entry><literal>mime_subject</literal></entry>
- <entry><muttng-doc:varref name="nntp_mime_subject" link="nntp-mime-subject"/></entry>
+ <entry><muttng-doc:varref name="nntp-mime-subject"/></entry>
</row>
<row>
<entry><literal>news_cache_dir</literal></entry>
- <entry><muttng-doc:varref name="nntp_cache_dir" link="nntp-cache-dir"/></entry>
+ <entry><muttng-doc:varref name="nntp-cache-dir"/></entry>
</row>
<row>
<entry><literal>news_server</literal></entry>
- <entry><muttng-doc:varref name="nntp_host" link="nntp-host"/></entry>
+ <entry><muttng-doc:varref name="nntp-host"/></entry>
</row>
<row>
<entry><literal>newsrc</literal></entry>
- <entry><muttng-doc:varref name="nntp_newsrc" link="nntp-newsrc"/></entry>
+ <entry><muttng-doc:varref name="nntp-newsrc"/></entry>
</row>
<row>
<entry><literal>nntp_poll</literal></entry>
- <entry><muttng-doc:varref name="nntp_mail_check" link="nntp-mail-check"/></entry>
+ <entry><muttng-doc:varref name="nntp-mail-check"/></entry>
</row>
<row>
<entry><literal>pop_checkinterval</literal></entry>
- <entry><muttng-doc:varref name="pop_mail_check" link="pop-mail-check"/></entry>
+ <entry><muttng-doc:varref name="pop-mail-check"/></entry>
</row>
<row>
<entry><literal>post_moderated</literal></entry>
- <entry><muttng-doc:varref name="nntp_post_moderated" link="nntp-post-moderated"/></entry>
+ <entry><muttng-doc:varref name="nntp-post-moderated"/></entry>
</row>
<row>
<entry><literal>save_unsubscribed</literal></entry>
- <entry><muttng-doc:varref name="nntp_save_unsubscribed" link="nntp-save-unsubscribed"/></entry>
+ <entry><muttng-doc:varref name="nntp-save-unsubscribed"/></entry>
</row>
<row>
<entry><literal>show_new_news</literal></entry>
- <entry><muttng-doc:varref name="nntp_show_new_news" link="nntp-show-new-news"/></entry>
+ <entry><muttng-doc:varref name="nntp-show-new-news"/></entry>
</row>
<row>
<entry><literal>show_only_unread</literal></entry>
- <entry><muttng-doc:varref name="nntp_show_only_unread" link="nntp-show-only-unread"/></entry>
+ <entry><muttng-doc:varref name="nntp-show-only-unread"/></entry>
</row>
<row>
<entry><literal>x_comment_to</literal></entry>
- <entry><muttng-doc:varref name="nntp_x_comment_to" link="nntp-x-comment-to"/></entry>
+ <entry><muttng-doc:varref name="nntp-x-comment-to"/></entry>
</row>
<row>
<entry><literal>smtp_auth_username</literal></entry>
- <entry><muttng-doc:varref name="smtp_user" link="smtp-user"/></entry>
+ <entry><muttng-doc:varref name="smtp-user"/></entry>
</row>
<row>
<entry><literal>smtp_auth_password</literal></entry>
- <entry><muttng-doc:varref name="smtp_pass" link="smtp-pass"/></entry>
+ <entry><muttng-doc:varref name="smtp-pass"/></entry>
</row>
<row>
<entry><literal>user_agent</literal></entry>
- <entry><muttng-doc:varref name="agent_string" link="agent-string"/></entry>
+ <entry><muttng-doc:varref name="agent-string"/></entry>
</row>
</tbody>
</tgroup>
projects / apps / madmutt.git / blobdiff