mutt stable branch with some hacks

Manual: Reformat paragraphs, fix ˜ -> ~ breakage

+1805 -1583
+1799 -1575
doc/manual.xml.head
··· 13 13 14 14 <abstract> 15 15 <para> 16 - <quote>All mail clients suck. This one just sucks less.</quote> &mdash; me, circa 1995 16 + <quote>All mail clients suck. This one just sucks less.</quote> &mdash; 17 + me, circa 1995 17 18 </para> 18 19 </abstract> 19 20 </bookinfo> ··· 22 23 <title>Introduction</title> 23 24 24 25 <para> 25 - <emphasis role="bold">Mutt</emphasis> is a small but very powerful text-based MIME mail client. Mutt is 26 - highly configurable, and is well suited to the mail power user with advanced 27 - features like key bindings, keyboard macros, mail threading, regular 28 - expression searches and a powerful pattern matching language for selecting 29 - groups of messages. 26 + <emphasis role="bold">Mutt</emphasis> is a small but very powerful 27 + text-based MIME mail client. Mutt is highly configurable, and is well 28 + suited to the mail power user with advanced features like key bindings, 29 + keyboard macros, mail threading, regular expression searches and a 30 + powerful pattern matching language for selecting groups of messages. 30 31 </para> 31 32 32 33 <sect1 id="homepage"> ··· 43 44 <title>Mailing Lists</title> 44 45 45 46 <para> 46 - To subscribe to one of the following mailing lists, send a message with the 47 - word <emphasis>subscribe</emphasis> in the body to 47 + To subscribe to one of the following mailing lists, send a message with 48 + the word <emphasis>subscribe</emphasis> in the body to 48 49 <literal>list-name</literal><emphasis>-request</emphasis><literal>@mutt.org</literal>. 49 50 </para> 50 51 ··· 52 53 <listitem> 53 54 54 55 <para> 55 - <email>mutt-announce-request@mutt.org</email> -- low traffic list for announcements 56 + <email>mutt-announce-request@mutt.org</email> &mdash; low traffic list for 57 + announcements 56 58 </para> 57 59 </listitem> 58 60 <listitem> 59 61 60 62 <para> 61 - <email>mutt-users-request@mutt.org</email> -- help, bug reports and feature requests 63 + <email>mutt-users-request@mutt.org</email> &mdash; help, bug reports and 64 + feature requests 62 65 </para> 63 66 </listitem> 64 67 <listitem> 65 68 66 69 <para> 67 - <email>mutt-dev-request@mutt.org</email> -- development mailing list 70 + <email>mutt-dev-request@mutt.org</email> &mdash; development mailing list 68 71 </para> 69 72 </listitem> 70 73 ··· 85 88 <title>Getting Mutt</title> 86 89 87 90 <para> 88 - Mutt releases can be downloaded from 89 - <ulink url="ftp://ftp.mutt.org/mutt/">ftp://ftp.mutt.org/mutt/</ulink>. 90 - For a list of mirror sites, please refer to 91 - <ulink url="http://www.mutt.org/download.html">http://www.mutt.org/download.html</ulink>. 91 + Mutt releases can be downloaded from <ulink 92 + url="ftp://ftp.mutt.org/mutt/">ftp://ftp.mutt.org/mutt/</ulink>. For a 93 + list of mirror sites, please refer to <ulink 94 + url="http://www.mutt.org/download.html">http://www.mutt.org/download.html</ulink>. 92 95 </para> 93 96 94 97 <para> ··· 225 228 </para> 226 229 227 230 <para> 228 - This program is free software; you can redistribute it and/or modify 229 - it under the terms of the GNU General Public License as published by 230 - the Free Software Foundation; either version 2 of the License, or 231 - (at your option) any later version. 231 + This program is free software; you can redistribute it and/or modify it 232 + under the terms of the GNU General Public License as published by the 233 + Free Software Foundation; either version 2 of the License, or (at your 234 + option) any later version. 232 235 </para> 233 236 234 237 <para> 235 - This program is distributed in the hope that it will be useful, 236 - but WITHOUT ANY WARRANTY; without even the implied warranty of 237 - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 238 - GNU General Public License for more details. 238 + This program is distributed in the hope that it will be useful, but 239 + WITHOUT ANY WARRANTY; without even the implied warranty of 240 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 241 + General Public License for more details. 239 242 </para> 240 243 241 244 <para> 242 - You should have received a copy of the GNU General Public License 243 - along with this program; if not, write to the Free Software 244 - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 245 + You should have received a copy of the GNU General Public License along 246 + with this program; if not, write to the Free Software Foundation, Inc., 247 + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 245 248 </para> 246 249 247 250 </sect1> ··· 252 255 <title>Getting Started</title> 253 256 254 257 <para> 255 - This section is intended as a brief overview of how to use Mutt. There are 256 - many other features which are described elsewhere in the manual. There 257 - is even more information available in the Mutt FAQ and various web 258 - pages. See the <ulink url="http://www.mutt.org/">Mutt homepage</ulink> for more details. 258 + This section is intended as a brief overview of how to use Mutt. There 259 + are many other features which are described elsewhere in the manual. 260 + There is even more information available in the Mutt FAQ and various web 261 + pages. See the <ulink url="http://www.mutt.org/">Mutt homepage</ulink> 262 + for more details. 259 263 </para> 260 264 261 265 <para> 262 - The keybindings described in this section are the defaults as distributed. 263 - Your local system administrator may have altered the defaults for your site. 264 - You can always type <quote>?</quote> in any menu to display the current bindings. 266 + The keybindings described in this section are the defaults as 267 + distributed. Your local system administrator may have altered the 268 + defaults for your site. You can always type <quote>?</quote> in any 269 + menu to display the current bindings. 265 270 </para> 266 271 267 272 <para> 268 - The first thing you need to do is invoke Mutt, simply by typing <literal>mutt</literal> 269 - at the command line. There are various command-line options, see 270 - either the Mutt man page or the <link linkend="commandline">reference</link>. 273 + The first thing you need to do is invoke Mutt, simply by typing 274 + <literal>mutt</literal> at the command line. There are various 275 + command-line options, see either the Mutt man page or the <link 276 + linkend="commandline">reference</link>. 271 277 </para> 272 278 273 279 <sect1 id="core-concepts"> ··· 276 282 <para> 277 283 Mutt is a text-based application which interacts with users through 278 284 different menus which are mostly line-/entry-based or page-based. A 279 - line-based menu is the so-called <quote>index</quote> menu (listing all messages of 280 - the currently opened folder) or the <quote>alias</quote> menu (allowing you to 281 - select recipients from a list). Examples for page-based menus are the 282 - <quote>pager</quote> (showing one message at a time) or the <quote>help</quote> menu listing 283 - all available key bindings. 285 + line-based menu is the so-called <quote>index</quote> menu (listing all 286 + messages of the currently opened folder) or the <quote>alias</quote> 287 + menu (allowing you to select recipients from a list). Examples for 288 + page-based menus are the <quote>pager</quote> (showing one message at a 289 + time) or the <quote>help</quote> menu listing all available key 290 + bindings. 284 291 </para> 285 292 286 293 <para> ··· 300 307 301 308 <para> 302 309 Because Mutt allows for customizing almost all key bindings, there are 303 - so-called <quote>functions</quote> which can be executed manually (using the 304 - command line) or in macros. Macros allow the user to bind a sequence of 305 - commands to a single key or a short key sequence instead of repeating a 306 - sequence of actions over and over. 310 + so-called <quote>functions</quote> which can be executed manually (using 311 + the command line) or in macros. Macros allow the user to bind a sequence 312 + of commands to a single key or a short key sequence instead of repeating 313 + a sequence of actions over and over. 307 314 </para> 308 315 309 316 <para> 310 317 Many commands (such as saving or copying a message to another folder) 311 318 can be applied to a single message or a set of messages (so-called 312 - <quote>tagged</quote> messages). To help selecting messages, Mutt provides a rich 313 - set of message patterns (such as recipients, sender, body contents, date 314 - sent/received, etc.) which can be combined into complex expressions 315 - using the boolean <emphasis>and</emphasis> and <emphasis>or</emphasis> 316 - operations as well as negating. These patterns can also be used to (for 317 - example) search for messages or to limit the index to show only matching 318 - messages. 319 + <quote>tagged</quote> messages). To help selecting messages, Mutt 320 + provides a rich set of message patterns (such as recipients, sender, 321 + body contents, date sent/received, etc.) which can be combined into 322 + complex expressions using the boolean <emphasis>and</emphasis> and 323 + <emphasis>or</emphasis> operations as well as negating. These patterns 324 + can also be used to (for example) search for messages or to limit the 325 + index to show only matching messages. 319 326 </para> 320 327 321 328 <para> 322 - Mutt supports a <quote>hook</quote> concept which allows the user to execute 323 - arbitrary configuration commands and functions in certain situations 324 - such as entering a folder, starting a new message or replying to an 325 - existing one. These hooks can be used to highly customize Mutt's 329 + Mutt supports a <quote>hook</quote> concept which allows the user to 330 + execute arbitrary configuration commands and functions in certain 331 + situations such as entering a folder, starting a new message or replying 332 + to an existing one. These hooks can be used to highly customize Mutt's 326 333 behaviour including managing multiple identities, customizing the 327 334 display for a folder or even implementing auto-archiving based on a 328 335 per-folder basis and much more. ··· 465 472 466 473 <para> 467 474 The most important navigation keys common to line- or entry-based menus 468 - are shown in <xref linkend="tab-keys-nav-line"/> and in 469 - <xref linkend="tab-keys-nav-page"/> for page-based menus. 475 + are shown in <xref linkend="tab-keys-nav-line"/> and in <xref 476 + linkend="tab-keys-nav-page"/> for page-based menus. 470 477 </para> 471 478 472 479 <table id="tab-keys-nav-line"> ··· 514 521 <title>Introduction</title> 515 522 516 523 <para> 517 - Mutt has a built-in line editor for inputting text, e.g. email 518 - addresses or filenames. The keys used to manipulate text input are 519 - very similar to those of Emacs. See <xref linkend="tab-keys-editor"/> for a full 520 - reference of available functions, their default key bindings, and 521 - short descriptions. 524 + Mutt has a built-in line editor for inputting text, e.g. email addresses 525 + or filenames. The keys used to manipulate text input are very similar to 526 + those of Emacs. See <xref linkend="tab-keys-editor"/> for a full 527 + reference of available functions, their default key bindings, and short 528 + descriptions. 522 529 </para> 523 530 524 531 <table id="tab-keys-editor"> ··· 555 562 </table> 556 563 557 564 <para> 558 - You can remap the <emphasis>editor</emphasis> functions using the 559 - <link linkend="bind"><command>bind</command></link> command. For example, to make 560 - the &lt;Delete&gt; key delete the character in front of 561 - the cursor rather than under, you could use: 565 + You can remap the <emphasis>editor</emphasis> functions using the <link 566 + linkend="bind"><command>bind</command></link> command. For example, to 567 + make the &lt;Delete&gt; key delete the character in front of the cursor 568 + rather than under, you could use: 562 569 </para> 563 570 564 571 <screen> ··· 572 579 573 580 <para> 574 581 Mutt maintains a history for the built-in editor. The number of items 575 - is controlled by the <link linkend="history">$history</link> 576 - variable and can be made persistent using an external file specified 577 - using <link linkend="history-file">$history_file</link>. 578 - You may cycle through them at an editor prompt by using the 579 - <literal>&lt;history-up&gt;</literal> and/or 580 - <literal>&lt;history-down&gt;</literal> commands. But notice that Mutt 581 - does not remember the currently entered text, it only cycles through 582 - history and wraps around at the end or beginning. 582 + is controlled by the <link linkend="history">$history</link> variable 583 + and can be made persistent using an external file specified using <link 584 + linkend="history-file">$history_file</link>. You may cycle through them 585 + at an editor prompt by using the <literal>&lt;history-up&gt;</literal> 586 + and/or <literal>&lt;history-down&gt;</literal> commands. But notice that 587 + Mutt does not remember the currently entered text, it only cycles 588 + through history and wraps around at the end or beginning. 583 589 </para> 584 590 585 591 <para> ··· 597 603 </itemizedlist> 598 604 599 605 <para> 600 - Mutt automatically filters out consecutively repeated items from the history. It 601 - also mimics the behavior of some shells by ignoring items starting 602 - with a space. The latter feature can be useful in macros to not clobber 603 - the history's valuable entries with unwanted entries. 606 + Mutt automatically filters out consecutively repeated items from the 607 + history. It also mimics the behavior of some shells by ignoring items 608 + starting with a space. The latter feature can be useful in macros to not 609 + clobber the history's valuable entries with unwanted entries. 604 610 </para> 605 611 606 612 </sect2> ··· 613 619 <para> 614 620 Similar to many other mail clients, there are two modes in which mail is 615 621 read in Mutt. The first is a list of messages in the mailbox, which is 616 - called the <quote>index</quote> menu in Mutt. The second mode is the display of the 617 - message contents. This is called the <quote>pager.</quote> 622 + called the <quote>index</quote> menu in Mutt. The second mode is the 623 + display of the message contents. This is called the 624 + <quote>pager.</quote> 618 625 </para> 619 626 620 627 <para> ··· 628 635 <para> 629 636 Common keys used to navigate through and manage messages in the index 630 637 are shown in <xref linkend="tab-key-index"/>. How messages are presented 631 - in the index menu can be customized using the 632 - <link linkend="index-format">$index_format</link> variable. 638 + in the index menu can be customized using the <link 639 + linkend="index-format">$index_format</link> variable. 633 640 </para> 634 641 635 642 <table id="tab-key-index"> ··· 675 682 <para> 676 683 In addition to who sent the message and the subject, a short summary of 677 684 the disposition of each message is printed beside the message number. 678 - Zero or more of the <quote>flags</quote> in <xref linkend="tab-msg-status-flags"/> 679 - may appear, some of which can be turned on or off using these functions: 680 - <literal>&lt;set-flag&gt;</literal> and 681 - <literal>&lt;clear-flag&gt;</literal> 682 - bound by default to <quote>w</quote> and <quote>W</quote> respectively. 685 + Zero or more of the <quote>flags</quote> in <xref 686 + linkend="tab-msg-status-flags"/> may appear, some of which can be turned 687 + on or off using these functions: <literal>&lt;set-flag&gt;</literal> and 688 + <literal>&lt;clear-flag&gt;</literal> bound by default to 689 + <quote>w</quote> and <quote>W</quote> respectively. 683 690 </para> 684 691 685 692 <para> 686 693 Furthermore, the flags in <xref linkend="tab-msg-recip-flags"/> reflect 687 - who the message is addressed to. They can be customized with the 688 - <link linkend="to-chars">$to_chars</link> variable. 694 + who the message is addressed to. They can be customized with the <link 695 + linkend="to-chars">$to_chars</link> variable. 689 696 </para> 690 697 691 698 <table id="tab-msg-status-flags"> ··· 734 741 <para> 735 742 By default, Mutt uses its builtin pager to display the contents of 736 743 messages (an external pager such as <literal>less(1)</literal> can be 737 - configured, see <link linkend="pager">$pager</link> variable). 738 - The pager is very similar to the Unix program <literal>less(1)</literal> 744 + configured, see <link linkend="pager">$pager</link> variable). The 745 + pager is very similar to the Unix program <literal>less(1)</literal> 739 746 though not nearly as featureful. 740 747 </para> 741 748 ··· 762 769 </table> 763 770 764 771 <para> 765 - In addition to key bindings in <xref linkend="tab-key-pager"/>, 766 - many of the functions from the index menu are also available in 767 - the pager, such as <literal>&lt;delete-message&gt;</literal> or <literal>&lt;copy-message&gt;</literal> 768 - (this is one advantage over using an external pager to view messages). 772 + In addition to key bindings in <xref linkend="tab-key-pager"/>, many of 773 + the functions from the index menu are also available in the pager, such 774 + as <literal>&lt;delete-message&gt;</literal> or 775 + <literal>&lt;copy-message&gt;</literal> (this is one advantage over 776 + using an external pager to view messages). 769 777 </para> 770 778 771 779 <para> 772 780 Also, the internal pager supports a couple other advanced features. For 773 - one, it will accept and translate the <quote>standard</quote> nroff sequences for 774 - bold and underline. These sequences are a series of either the letter, 775 - backspace (<quote>^H</quote>), the letter again for bold or the letter, backspace, 776 - <quote>_</quote> for denoting underline. Mutt will attempt to display these 777 - in bold and underline respectively if your terminal supports them. If 778 - not, you can use the bold and underline <link linkend="color">color</link> 779 - objects to specify a <command>color</command> or mono attribute for them. 781 + one, it will accept and translate the <quote>standard</quote> nroff 782 + sequences for bold and underline. These sequences are a series of either 783 + the letter, backspace (<quote>^H</quote>), the letter again for bold or 784 + the letter, backspace, <quote>_</quote> for denoting underline. Mutt 785 + will attempt to display these in bold and underline respectively if your 786 + terminal supports them. If not, you can use the bold and underline <link 787 + linkend="color">color</link> objects to specify a 788 + <command>color</command> or mono attribute for them. 780 789 </para> 781 790 782 791 <para> ··· 790 799 </screen> 791 800 792 801 <para> 793 - where <emphasis>Ps</emphasis> can be one of the codes shown in 794 - <xref linkend="tab-ansi-esc"/>. 802 + where <emphasis>Ps</emphasis> can be one of the codes shown in <xref 803 + linkend="tab-ansi-esc"/>. 795 804 </para> 796 805 797 806 <table id="tab-ansi-esc"> ··· 833 842 834 843 <para> 835 844 Mutt uses these attributes for handling <literal>text/enriched</literal> 836 - messages, and they can also be used by an external 837 - <link linkend="auto-view">autoview</link> script for highlighting 838 - purposes. 845 + messages, and they can also be used by an external <link 846 + linkend="auto-view">autoview</link> script for highlighting purposes. 839 847 </para> 840 848 841 849 <note> 842 850 <para> 843 - If you change the colors for your 844 - display, for example by changing the color associated with color2 for 845 - your xterm, then that color will be used instead of green. 851 + If you change the colors for your display, for example by changing the 852 + color associated with color2 for your xterm, then that color will be 853 + used instead of green. 846 854 </para> 847 855 </note> 848 856 849 857 <note> 850 858 <para> 851 859 Note that the search commands in the pager take regular expressions, 852 - which are not quite the same as the more 853 - complex <link linkend="patterns">patterns</link> used by the search 854 - command in the index. This is because patterns are used to select messages by 855 - criteria whereas the pager already displays a selected message. 860 + which are not quite the same as the more complex <link 861 + linkend="patterns">patterns</link> used by the search command in the 862 + index. This is because patterns are used to select messages by criteria 863 + whereas the pager already displays a selected message. 856 864 </para> 857 865 </note> 858 866 ··· 902 910 </table> 903 911 904 912 <para> 905 - Collapsing a thread displays only the first message 906 - in the thread and hides the others. This is useful when threads 907 - contain so many messages that you can only see a handful of threads on 908 - the screen. See %M in <link linkend="index-format">$index_format</link>. 909 - For example, you could use <quote>%?M?(#%03M)&amp;(%4l)?</quote> in <link linkend="index-format">$index_format</link> to optionally 910 - display the number of hidden messages if the thread is 911 - collapsed. The <literal>%?&lt;char&gt;?&lt;if-part&gt;&amp;&lt;else-part&gt;?</literal> 912 - syntax is explained in detail in 913 - <link linkend="formatstrings-conditionals">format string conditionals</link>. 913 + Collapsing a thread displays only the first message in the thread and 914 + hides the others. This is useful when threads contain so many messages 915 + that you can only see a handful of threads on the screen. See %M in 916 + <link linkend="index-format">$index_format</link>. For example, you 917 + could use <quote>%?M?(#%03M)&amp;(%4l)?</quote> in <link 918 + linkend="index-format">$index_format</link> to optionally display the 919 + number of hidden messages if the thread is collapsed. The 920 + <literal>%?&lt;char&gt;?&lt;if-part&gt;&amp;&lt;else-part&gt;?</literal> 921 + syntax is explained in detail in <link 922 + linkend="formatstrings-conditionals">format string conditionals</link>. 914 923 </para> 915 924 916 925 <para> 917 926 Technically, every reply should contain a list of its parent messages in 918 927 the thread tree, but not all do. In these cases, Mutt groups them by 919 - subject which can be controlled using the 920 - <link linkend="strict-threads">$strict_threads</link> variable. 928 + subject which can be controlled using the <link 929 + linkend="strict-threads">$strict_threads</link> variable. 921 930 </para> 922 931 923 932 </sect2> ··· 926 935 <title>Miscellaneous Functions</title> 927 936 928 937 <para> 929 - In addition, the <emphasis>index</emphasis> and <emphasis>pager</emphasis> 930 - menus have these interesting functions: 938 + In addition, the <emphasis>index</emphasis> and 939 + <emphasis>pager</emphasis> menus have these interesting functions: 931 940 </para> 932 941 933 942 <variablelist> 934 943 935 944 <varlistentry> 936 945 <term> 937 - <literal>&lt;create-alias&gt;</literal><anchor id="create-alias"/> (default: a) 946 + <literal>&lt;create-alias&gt;</literal><anchor id="create-alias"/> 947 + (default: a) 938 948 </term> 939 949 <listitem> 940 950 <para> 941 - Creates a new alias based upon the current message (or prompts for a 942 - new one). Once editing is complete, an <link linkend="alias"><command>alias</command></link> 943 - command is added to the file specified by 944 - the <link linkend="alias-file">$alias_file</link> variable 945 - for future use 951 + Creates a new alias based upon the current message (or prompts for a new 952 + one). Once editing is complete, an <link 953 + linkend="alias"><command>alias</command></link> command is added to the 954 + file specified by the <link linkend="alias-file">$alias_file</link> 955 + variable for future use 946 956 </para> 947 957 948 958 <note> 949 959 <para> 950 960 Mutt does not read the <link linkend="alias-file">$alias_file</link> 951 - upon startup so you must explicitly <link linkend="source"><command>source</command></link> the file. 961 + upon startup so you must explicitly <link 962 + linkend="source"><command>source</command></link> the file. 952 963 </para> 953 964 </note> 954 965 </listitem> ··· 956 967 957 968 <varlistentry> 958 969 <term> 959 - <literal>&lt;check-traditional-pgp&gt;</literal><anchor id="check-traditional-pgp"/> (default: Esc P) 970 + <literal>&lt;check-traditional-pgp&gt;</literal><anchor 971 + id="check-traditional-pgp"/> (default: Esc P) 960 972 </term> 961 973 <listitem> 962 974 <para> 963 975 This function will search the current message for content signed or 964 - encrypted with PGP the <quote>traditional</quote> way, that is, without proper 965 - MIME tagging. Technically, this function will temporarily change 966 - the MIME content types of the body parts containing PGP data; this 967 - is similar to the <link linkend="edit-type"><literal>&lt;edit-type&gt;</literal></link> function's 968 - effect. 976 + encrypted with PGP the <quote>traditional</quote> way, that is, without 977 + proper MIME tagging. Technically, this function will temporarily change 978 + the MIME content types of the body parts containing PGP data; this is 979 + similar to the <link 980 + linkend="edit-type"><literal>&lt;edit-type&gt;</literal></link> 981 + function's effect. 969 982 </para> 970 983 </listitem> 971 984 </varlistentry> ··· 976 989 </term> 977 990 <listitem> 978 991 <para> 979 - This command (available in the index and pager) allows you to 980 - edit the raw current message as it's present in the mail folder. 981 - After you have finished editing, the changed message will be 982 - appended to the current folder, and the original message will be 983 - marked for deletion; if the message is unchanged it won't be replaced. 992 + This command (available in the index and pager) allows you to edit the 993 + raw current message as it's present in the mail folder. After you have 994 + finished editing, the changed message will be appended to the current 995 + folder, and the original message will be marked for deletion; if the 996 + message is unchanged it won't be replaced. 984 997 </para> 985 998 </listitem> 986 999 </varlistentry> ··· 988 1001 <varlistentry> 989 1002 <term> 990 1003 <literal>&lt;edit-type&gt;</literal><anchor id="edit-type"/> (default: 991 - ^E on the attachment menu, and in the pager and index menus; 992 - ^T on the compose menu) 1004 + ^E on the attachment menu, and in the pager and index menus; ^T on the 1005 + compose menu) 993 1006 </term> 994 1007 <listitem> 995 1008 <para> 996 - This command is used to temporarily edit an attachment's content 997 - type to fix, for instance, bogus character set parameters. When 998 - invoked from the index or from the pager, you'll have the 999 - opportunity to edit the top-level attachment's content type. On the 1000 - <link linkend="attach-menu">attachment menu</link>, you can change any 1009 + This command is used to temporarily edit an attachment's content type to 1010 + fix, for instance, bogus character set parameters. When invoked from 1011 + the index or from the pager, you'll have the opportunity to edit the 1012 + top-level attachment's content type. On the <link 1013 + linkend="attach-menu">attachment menu</link>, you can change any 1001 1014 attachment's content type. These changes are not persistent, and get 1002 1015 lost upon changing folders. 1003 1016 </para> 1004 1017 1005 1018 <para> 1006 - Note that this command is also available on the <link linkend="compose-menu">compose 1007 - menu</link>. There, it's used to fine-tune the properties of attachments you are going 1008 - to send. 1019 + Note that this command is also available on the <link 1020 + linkend="compose-menu">compose menu</link>. There, it's used to 1021 + fine-tune the properties of attachments you are going to send. 1009 1022 </para> 1010 1023 </listitem> 1011 1024 </varlistentry> 1012 1025 1013 1026 <varlistentry> 1014 1027 <term> 1015 - <literal>&lt;enter-command&gt;</literal><anchor id="enter-command"/> (default: <quote>:</quote>) 1028 + <literal>&lt;enter-command&gt;</literal><anchor id="enter-command"/> 1029 + (default: <quote>:</quote>) 1016 1030 </term> 1017 1031 <listitem> 1018 1032 <para> 1019 1033 This command is used to execute any command you would normally put in a 1020 - configuration file. A common use is to check the settings of variables, or 1021 - in conjunction with <link linkend="macro">macros</link> to change settings on the 1022 - fly. 1034 + configuration file. A common use is to check the settings of variables, 1035 + or in conjunction with <link linkend="macro">macros</link> to change 1036 + settings on the fly. 1023 1037 </para> 1024 1038 </listitem> 1025 1039 </varlistentry> 1026 1040 1027 1041 <varlistentry> 1028 1042 <term> 1029 - <literal>&lt;extract-keys&gt;</literal><anchor id="extract-keys"/> (default: ^K) 1043 + <literal>&lt;extract-keys&gt;</literal><anchor id="extract-keys"/> 1044 + (default: ^K) 1030 1045 </term> 1031 1046 <listitem> 1032 1047 <para> ··· 1038 1053 1039 1054 <varlistentry> 1040 1055 <term> 1041 - <literal>&lt;forget-passphrase&gt;</literal><anchor id="forget-passphrase"/> (default: 1042 - ^F) 1056 + <literal>&lt;forget-passphrase&gt;</literal><anchor 1057 + id="forget-passphrase"/> (default: ^F) 1043 1058 </term> 1044 1059 <listitem> 1045 1060 <para> 1046 - This command wipes the passphrase(s) from memory. It is useful, if 1047 - you misspelled the passphrase. 1061 + This command wipes the passphrase(s) from memory. It is useful, if you 1062 + misspelled the passphrase. 1048 1063 </para> 1049 1064 </listitem> 1050 1065 </varlistentry> 1051 1066 1052 1067 <varlistentry> 1053 1068 <term> 1054 - <literal>&lt;list-reply&gt;</literal><anchor id="list-reply"/> (default: L) 1069 + <literal>&lt;list-reply&gt;</literal><anchor id="list-reply"/> (default: 1070 + L) 1055 1071 </term> 1056 1072 <listitem> 1057 1073 <para> 1058 - Reply to the current or tagged message(s) by extracting any addresses which 1059 - match the regular expressions given by the <link linkend="lists"><command>lists</command> or <command>subscribe</command></link> 1060 - commands, but also honor any <literal>Mail-Followup-To</literal> header(s) if the 1061 - <link linkend="honor-followup-to">$honor_followup_to</link> 1062 - configuration variable is set. Using this when replying to messages posted 1063 - to mailing lists helps avoid duplicate copies being sent to the author of 1064 - the message you are replying to. 1074 + Reply to the current or tagged message(s) by extracting any addresses 1075 + which match the regular expressions given by the <link 1076 + linkend="lists"><command>lists</command> or 1077 + <command>subscribe</command></link> commands, but also honor any 1078 + <literal>Mail-Followup-To</literal> header(s) if the <link 1079 + linkend="honor-followup-to">$honor_followup_to</link> configuration 1080 + variable is set. Using this when replying to messages posted to mailing 1081 + lists helps avoid duplicate copies being sent to the author of the 1082 + message you are replying to. 1065 1083 </para> 1066 1084 </listitem> 1067 1085 </varlistentry> 1068 1086 1069 1087 <varlistentry> 1070 1088 <term> 1071 - <literal>&lt;pipe-message&gt;</literal><anchor id="pipe-message"/> (default: |) 1089 + <literal>&lt;pipe-message&gt;</literal><anchor id="pipe-message"/> 1090 + (default: |) 1072 1091 </term> 1073 1092 <listitem> 1074 1093 <para> 1075 - Asks for an external Unix command and pipes the current or 1076 - tagged message(s) to it. The variables <link linkend="pipe-decode">$pipe_decode</link>, <link linkend="pipe-split">$pipe_split</link>, 1077 - <link linkend="pipe-sep">$pipe_sep</link> and <link linkend="wait-key">$wait_key</link> control the exact behavior of this function. 1094 + Asks for an external Unix command and pipes the current or tagged 1095 + message(s) to it. The variables <link 1096 + linkend="pipe-decode">$pipe_decode</link>, <link 1097 + linkend="pipe-split">$pipe_split</link>, <link 1098 + linkend="pipe-sep">$pipe_sep</link> and <link 1099 + linkend="wait-key">$wait_key</link> control the exact behavior of this 1100 + function. 1078 1101 </para> 1079 1102 </listitem> 1080 1103 </varlistentry> 1081 1104 1082 1105 <varlistentry> 1083 1106 <term> 1084 - <literal>&lt;resend-message&gt;</literal><anchor id="resend-message"/> (default: Esc e) 1107 + <literal>&lt;resend-message&gt;</literal><anchor id="resend-message"/> 1108 + (default: Esc e) 1085 1109 </term> 1086 1110 <listitem> 1087 1111 <para> 1088 - Mutt takes the current message as a template for a 1089 - new message. This function is best described as "recall from arbitrary 1090 - folders". It can conveniently be used to forward MIME messages while 1091 - preserving the original mail structure. Note that the amount of headers 1092 - included here depends on the value of the <link linkend="weed">$weed</link> 1093 - variable. 1112 + Mutt takes the current message as a template for a new message. This 1113 + function is best described as "recall from arbitrary folders". It can 1114 + conveniently be used to forward MIME messages while preserving the 1115 + original mail structure. Note that the amount of headers included here 1116 + depends on the value of the <link linkend="weed">$weed</link> variable. 1094 1117 </para> 1095 1118 1096 1119 <para> 1097 - This function is also available from the attachment menu. You can use this 1098 - to easily resend a message which was included with a bounce message 1120 + This function is also available from the attachment menu. You can use 1121 + this to easily resend a message which was included with a bounce message 1099 1122 as a <literal>message/rfc822</literal> body part. 1100 1123 </para> 1101 1124 </listitem> ··· 1103 1126 1104 1127 <varlistentry> 1105 1128 <term> 1106 - <literal>&lt;shell-escape&gt;</literal><anchor id="shell-escape"/> (default: !) 1129 + <literal>&lt;shell-escape&gt;</literal><anchor id="shell-escape"/> 1130 + (default: !) 1107 1131 </term> 1108 1132 <listitem> 1109 1133 <para> 1110 - Asks for an external Unix command and executes it. The <link linkend="wait-key">$wait_key</link> can be used to control 1111 - whether Mutt will wait for a key to be pressed when the command returns 1112 - (presumably to let the user read the output of the command), based on 1113 - the return status of the named command. If no command is given, an 1114 - interactive shell is executed. 1134 + Asks for an external Unix command and executes it. The <link 1135 + linkend="wait-key">$wait_key</link> can be used to control whether Mutt 1136 + will wait for a key to be pressed when the command returns (presumably 1137 + to let the user read the output of the command), based on the return 1138 + status of the named command. If no command is given, an interactive 1139 + shell is executed. 1115 1140 </para> 1116 1141 </listitem> 1117 1142 </varlistentry> 1118 1143 1119 1144 <varlistentry> 1120 1145 <term> 1121 - <literal>&lt;toggle-quoted&gt;</literal><anchor id="toggle-quoted"/> (default: T) 1146 + <literal>&lt;toggle-quoted&gt;</literal><anchor id="toggle-quoted"/> 1147 + (default: T) 1122 1148 </term> 1123 1149 <listitem> 1124 1150 <para> 1125 - The pager uses the <link linkend="quote-regexp">$quote_regexp</link> variable to detect quoted text when 1126 - displaying the body of the message. This function toggles the display 1127 - of the quoted material in the message. It is particularly useful when 1128 - being interested in just the response and there is a large amount of 1129 - quoted text in the way. 1151 + The pager uses the <link linkend="quote-regexp">$quote_regexp</link> 1152 + variable to detect quoted text when displaying the body of the message. 1153 + This function toggles the display of the quoted material in the message. 1154 + It is particularly useful when being interested in just the response and 1155 + there is a large amount of quoted text in the way. 1130 1156 </para> 1131 1157 </listitem> 1132 1158 </varlistentry> 1133 1159 1134 1160 <varlistentry> 1135 1161 <term> 1136 - <literal>&lt;skip-quoted&gt;</literal><anchor id="skip-quoted"/> (default: S) 1162 + <literal>&lt;skip-quoted&gt;</literal><anchor id="skip-quoted"/> 1163 + (default: S) 1137 1164 </term> 1138 1165 <listitem> 1139 1166 <para> ··· 1156 1183 <title>Introduction</title> 1157 1184 1158 1185 <para> 1159 - The bindings shown in <xref linkend="tab-key-send"/> are available in the 1160 - <emphasis>index</emphasis> and <emphasis>pager</emphasis> to start a new message. 1186 + The bindings shown in <xref linkend="tab-key-send"/> are available in 1187 + the <emphasis>index</emphasis> and <emphasis>pager</emphasis> to start a 1188 + new message. 1161 1189 </para> 1162 1190 1163 1191 <table id="tab-key-send"> ··· 1179 1207 </table> 1180 1208 1181 1209 <para> 1182 - <emphasis>Bouncing</emphasis> a message sends the message as-is to the recipient you 1183 - specify. <emphasis>Forwarding</emphasis> a message allows you to add comments or 1184 - modify the message you are forwarding. These items are discussed 1185 - in greater detail in the next section <quote><link linkend="forwarding-mail">Forwarding 1186 - and Bouncing Mail</link>.</quote> 1210 + <emphasis>Bouncing</emphasis> a message sends the message as-is to the 1211 + recipient you specify. <emphasis>Forwarding</emphasis> a message allows 1212 + you to add comments or modify the message you are forwarding. These 1213 + items are discussed in greater detail in the next section <quote><link 1214 + linkend="forwarding-mail">Forwarding and Bouncing Mail</link>.</quote> 1187 1215 </para> 1188 1216 1189 1217 <para> 1190 - Mutt will then enter the <emphasis>compose</emphasis> menu and prompt you for the 1191 - recipients to place on the <quote>To:</quote> header field when you hit <literal>m</literal> to start a new message. Next, it will ask 1192 - you for the <quote>Subject:</quote> field for the message, providing a default if 1193 - you are replying to or forwarding a message. You again 1194 - have the chance to adjust recipients, subject, and security settings 1195 - right before actually sending the message. See also 1196 - <link linkend="askcc">$askcc</link>, 1197 - <link linkend="askbcc">$askbcc</link>, 1198 - <link linkend="autoedit">$autoedit</link>, 1199 - <link linkend="bounce">$bounce</link>, 1200 - <link linkend="fast-reply">$fast_reply</link>, 1201 - and <link linkend="include">$include</link> 1202 - for changing how and if Mutt asks these questions. 1218 + Mutt will then enter the <emphasis>compose</emphasis> menu and prompt 1219 + you for the recipients to place on the <quote>To:</quote> header field 1220 + when you hit <literal>m</literal> to start a new message. Next, it will 1221 + ask you for the <quote>Subject:</quote> field for the message, providing 1222 + a default if you are replying to or forwarding a message. You again have 1223 + the chance to adjust recipients, subject, and security settings right 1224 + before actually sending the message. See also <link 1225 + linkend="askcc">$askcc</link>, <link linkend="askbcc">$askbcc</link>, 1226 + <link linkend="autoedit">$autoedit</link>, <link 1227 + linkend="bounce">$bounce</link>, <link 1228 + linkend="fast-reply">$fast_reply</link>, and <link 1229 + linkend="include">$include</link> for changing how and if Mutt asks 1230 + these questions. 1203 1231 </para> 1204 1232 1205 1233 <para> ··· 1239 1267 1240 1268 <para> 1241 1269 After getting recipients for new messages, forwards or replies, Mutt 1242 - will then automatically start your <link 1243 - linkend="editor">$editor</link> on the message body. If the <link 1244 - linkend="edit-headers">$edit_headers</link> variable is 1245 - set, the headers will be at the top of the message in your editor. Any 1246 - messages you are replying to will be added in sort order to the message, 1247 - with appropriate <link linkend="attribution">$attribution</link>, 1248 - <link linkend="indent-string">$indent_string</link> and 1249 - <link 1250 - linkend="post-indent-string">$post_indent_string</link>. 1251 - When forwarding a message, if the <link 1252 - linkend="mime-forward">$mime_forward</link> variable is 1253 - unset, a copy of the forwarded message will be included. If you have 1254 - specified a <link linkend="signature">$signature</link>, it will 1255 - be appended to the message. 1270 + will then automatically start your <link linkend="editor">$editor</link> 1271 + on the message body. If the <link 1272 + linkend="edit-headers">$edit_headers</link> variable is set, the headers 1273 + will be at the top of the message in your editor. Any messages you are 1274 + replying to will be added in sort order to the message, with appropriate 1275 + <link linkend="attribution">$attribution</link>, <link 1276 + linkend="indent-string">$indent_string</link> and <link 1277 + linkend="post-indent-string">$post_indent_string</link>. When 1278 + forwarding a message, if the <link 1279 + linkend="mime-forward">$mime_forward</link> variable is unset, a copy of 1280 + the forwarded message will be included. If you have specified a <link 1281 + linkend="signature">$signature</link>, it will be appended to the 1282 + message. 1256 1283 </para> 1257 1284 1258 1285 <para> 1259 1286 Once you have finished editing the body of your mail message, you are 1260 - returned to the <emphasis>compose</emphasis> menu providing the functions 1261 - shown in <xref linkend="tab-func-compose"/> to modify, send or postpone the 1262 - message. 1287 + returned to the <emphasis>compose</emphasis> menu providing the 1288 + functions shown in <xref linkend="tab-func-compose"/> to modify, send or 1289 + postpone the message. 1263 1290 </para> 1264 1291 1265 1292 <table id="tab-func-compose"> ··· 1294 1321 </table> 1295 1322 1296 1323 <para> 1297 - The compose menu is also used to edit the attachments for a message which can be either files 1298 - or other messages. The <literal>&lt;attach-message&gt;</literal> function to will prompt you for a folder to 1299 - attach messages from. You can now tag messages in that folder and they 1300 - will be attached to the message you are sending. 1324 + The compose menu is also used to edit the attachments for a message 1325 + which can be either files or other messages. The 1326 + <literal>&lt;attach-message&gt;</literal> function to will prompt you 1327 + for a folder to attach messages from. You can now tag messages in that 1328 + folder and they will be attached to the message you are sending. 1301 1329 </para> 1302 1330 1303 1331 <note> 1304 1332 <para> 1305 - Note that certain 1306 - operations like composing a new mail, replying, forwarding, etc. are 1307 - not permitted when you are in that folder. The %r in 1308 - <link linkend="status-format">$status_format</link> will change to 1309 - a <quote>A</quote> to indicate that you are in attach-message mode. 1333 + Note that certain operations like composing a new mail, replying, 1334 + forwarding, etc. are not permitted when you are in that folder. The %r 1335 + in <link linkend="status-format">$status_format</link> will change to a 1336 + <quote>A</quote> to indicate that you are in attach-message mode. 1310 1337 </para> 1311 1338 </note> 1312 1339 ··· 1316 1343 <title>Editing the Message Header</title> 1317 1344 1318 1345 <para> 1319 - When editing the header because of <link linkend="edit-headers">$edit_headers</link> 1320 - being set, there are a several pseudo headers available which 1321 - will not be included in sent messages but trigger special Mutt behavior. 1346 + When editing the header because of <link 1347 + linkend="edit-headers">$edit_headers</link> being set, there are a 1348 + several pseudo headers available which will not be included in sent 1349 + messages but trigger special Mutt behavior. 1322 1350 </para> 1323 1351 1324 1352 <sect3 id="fcc-header"> ··· 1333 1361 </para> 1334 1362 1335 1363 <para> 1336 - as a header, Mutt will pick up <emphasis>filename</emphasis> 1337 - just as if you had used the <literal>&lt;edit-fcc&gt;</literal> function in the <emphasis>compose</emphasis> menu. 1338 - It can later be changed from the compose menu. 1364 + as a header, Mutt will pick up <emphasis>filename</emphasis> just as if 1365 + you had used the <literal>&lt;edit-fcc&gt;</literal> function in the 1366 + <emphasis>compose</emphasis> menu. It can later be changed from the 1367 + compose menu. 1339 1368 </para> 1340 1369 1341 1370 </sect3> ··· 1353 1382 </para> 1354 1383 1355 1384 <para> 1356 - where <emphasis>filename</emphasis> is the file to attach and <emphasis>description</emphasis> is an 1357 - optional string to use as the description of the attached file. Spaces 1358 - in filenames have to be escaped using backslash (<quote>\</quote>). 1359 - The file can be removed as well as more added from the compose menu. 1385 + where <emphasis>filename</emphasis> is the file to attach and 1386 + <emphasis>description</emphasis> is an optional string to use as the 1387 + description of the attached file. Spaces in filenames have to be escaped 1388 + using backslash (<quote>\</quote>). The file can be removed as well as 1389 + more added from the compose menu. 1360 1390 </para> 1361 1391 1362 1392 </sect3> ··· 1374 1404 </para> 1375 1405 1376 1406 <para> 1377 - <quote>E</quote> selects encryption, <quote>S</quote> selects signing and 1378 - <quote>S&lt;id&gt;</quote> selects signing with the given key, setting 1379 - <link linkend="pgp-sign-as">$pgp_sign_as</link> 1380 - permanently. The selection can later be changed in the compose menu. 1407 + <quote>E</quote> selects encryption, <quote>S</quote> selects signing 1408 + and <quote>S&lt;id&gt;</quote> selects signing with the given key, 1409 + setting <link linkend="pgp-sign-as">$pgp_sign_as</link> permanently. The 1410 + selection can later be changed in the compose menu. 1381 1411 </para> 1382 1412 1383 1413 </sect3> ··· 1386 1416 <title>In-Reply-To: Header</title> 1387 1417 1388 1418 <para> 1389 - When replying to messages, the <emphasis>In-Reply-To:</emphasis> header contains the 1390 - Message-Id of the message(s) you reply to. If you remove or modify its value, Mutt will not generate a 1391 - <emphasis>References:</emphasis> field, which allows you to create a new message thread, for example 1392 - to create a new message to a mailing list without having to enter the mailing list's address. 1419 + When replying to messages, the <emphasis>In-Reply-To:</emphasis> header 1420 + contains the Message-Id of the message(s) you reply to. If you remove or 1421 + modify its value, Mutt will not generate a 1422 + <emphasis>References:</emphasis> field, which allows you to create a new 1423 + message thread, for example to create a new message to a mailing list 1424 + without having to enter the mailing list's address. 1393 1425 </para> 1394 1426 1395 1427 </sect3> ··· 1400 1432 <title>Sending Cryptographically Signed/Encrypted Messages</title> 1401 1433 1402 1434 <para> 1403 - If you have told Mutt to PGP or S/MIME encrypt a message, it will guide you 1404 - through a key selection process when you try to send the message. 1405 - Mutt will not ask you any questions about keys which have a 1406 - certified user ID matching one of the message recipients' mail 1407 - addresses. However, there may be situations in which there are 1408 - several keys, weakly certified user ID fields, or where no matching 1409 - keys can be found. 1435 + If you have told Mutt to PGP or S/MIME encrypt a message, it will guide 1436 + you through a key selection process when you try to send the message. 1437 + Mutt will not ask you any questions about keys which have a certified 1438 + user ID matching one of the message recipients' mail addresses. 1439 + However, there may be situations in which there are several keys, weakly 1440 + certified user ID fields, or where no matching keys can be found. 1410 1441 </para> 1411 1442 1412 1443 <para> 1413 1444 In these cases, you are dropped into a menu with a list of keys from 1414 - which you can select one. When you quit this menu, or Mutt can't 1415 - find any matching keys, you are prompted for a user ID. You can, as 1416 - usually, abort this prompt using <literal>^G</literal>. When you do so, Mutt will 1417 - return to the compose screen. 1445 + which you can select one. When you quit this menu, or Mutt can't find 1446 + any matching keys, you are prompted for a user ID. You can, as usually, 1447 + abort this prompt using <literal>^G</literal>. When you do so, Mutt 1448 + will return to the compose screen. 1418 1449 </para> 1419 1450 1420 1451 <para> 1421 - Once you have successfully finished the key selection, the message 1422 - will be encrypted using the selected public keys when sent out. 1452 + Once you have successfully finished the key selection, the message will 1453 + be encrypted using the selected public keys when sent out. 1423 1454 </para> 1424 1455 1425 1456 <para> 1426 - Most fields of the entries in the key selection menu (see also <link linkend="pgp-entry-format">$pgp_entry_format</link>) 1427 - have obvious meanings. But some explanations on the capabilities, flags, 1428 - and validity fields are in order. 1457 + Most fields of the entries in the key selection menu (see also <link 1458 + linkend="pgp-entry-format">$pgp_entry_format</link>) have obvious 1459 + meanings. But some explanations on the capabilities, flags, and 1460 + validity fields are in order. 1429 1461 </para> 1430 1462 1431 1463 <para> 1432 - The flags sequence (<quote>%f</quote>) will expand to one of the flags in 1433 - <xref linkend="tab-pgp-menuflags"/>. 1464 + The flags sequence (<quote>%f</quote>) will expand to one of the flags 1465 + in <xref linkend="tab-pgp-menuflags"/>. 1434 1466 </para> 1435 1467 1436 1468 <table id="tab-pgp-menuflags"> ··· 1449 1481 </table> 1450 1482 1451 1483 <para> 1452 - The capabilities field (<quote>%c</quote>) expands to a two-character sequence 1453 - representing a key's capabilities. The first character gives 1484 + The capabilities field (<quote>%c</quote>) expands to a two-character 1485 + sequence representing a key's capabilities. The first character gives 1454 1486 the key's encryption capabilities: A minus sign (<quote>-</quote>) means 1455 - that the key cannot be used for encryption. A dot (<quote>.</quote>) means that 1456 - it's marked as a signature key in one of the user IDs, but may 1457 - also be used for encryption. The letter <quote>e</quote> indicates that 1458 - this key can be used for encryption. 1487 + that the key cannot be used for encryption. A dot (<quote>.</quote>) 1488 + means that it's marked as a signature key in one of the user IDs, but 1489 + may also be used for encryption. The letter <quote>e</quote> indicates 1490 + that this key can be used for encryption. 1459 1491 </para> 1460 1492 1461 1493 <para> 1462 1494 The second character indicates the key's signing capabilities. Once 1463 - again, a <quote>-</quote> implies <quote>not for signing</quote>, <quote>.</quote> implies 1464 - that the key is marked as an encryption key in one of the user-ids, and 1465 - <quote>s</quote> denotes a key which can be used for signing. 1495 + again, a <quote>-</quote> implies <quote>not for signing</quote>, 1496 + <quote>.</quote> implies that the key is marked as an encryption key in 1497 + one of the user-ids, and <quote>s</quote> denotes a key which can be 1498 + used for signing. 1466 1499 </para> 1467 1500 1468 1501 <para> 1469 - Finally, the validity field (<quote>%t</quote>) indicates how well-certified a user-id 1470 - is. A question mark (<quote>?</quote>) indicates undefined validity, a minus 1471 - character (<quote>-</quote>) marks an untrusted association, a space character 1472 - means a partially trusted association, and a plus character (<quote>+</quote>) 1473 - indicates complete validity. 1502 + Finally, the validity field (<quote>%t</quote>) indicates how 1503 + well-certified a user-id is. A question mark (<quote>?</quote>) 1504 + indicates undefined validity, a minus character (<quote>-</quote>) marks 1505 + an untrusted association, a space character means a partially trusted 1506 + association, and a plus character (<quote>+</quote>) indicates complete 1507 + validity. 1474 1508 </para> 1475 1509 1476 1510 </sect2> ··· 1482 1516 <title>Concept</title> 1483 1517 1484 1518 <para> 1485 - <literal>format=flowed</literal>-style messages (or <literal>f=f</literal> 1486 - for short) are <literal>text/plain</literal> messages that consist of paragraphs which a receiver's 1487 - mail client may reformat to its own needs which mostly means to 1488 - customize line lengths regardless of what the sender sent. Technically this is 1489 - achieved by letting lines of a <quote>flowable</quote> paragraph end in spaces 1519 + <literal>format=flowed</literal>-style messages (or 1520 + <literal>f=f</literal> for short) are <literal>text/plain</literal> 1521 + messages that consist of paragraphs which a receiver's mail client may 1522 + reformat to its own needs which mostly means to customize line lengths 1523 + regardless of what the sender sent. Technically this is achieved by 1524 + letting lines of a <quote>flowable</quote> paragraph end in spaces 1490 1525 except for the last line. 1491 1526 </para> 1492 1527 ··· 1504 1539 <para> 1505 1540 Mutt only supports setting the required <literal>format=flowed</literal> 1506 1541 MIME parameter on outgoing messages if the <link 1507 - linkend="text-flowed">$text_flowed</link> 1508 - variable is set, specifically it does not add the 1509 - trailing spaces. 1542 + linkend="text-flowed">$text_flowed</link> variable is set, specifically 1543 + it does not add the trailing spaces. 1510 1544 </para> 1511 1545 1512 1546 <para> 1513 - After editing the initial message text and before entering 1514 - the compose menu, Mutt properly space-stuffes the message. 1547 + After editing the initial message text and before entering the compose 1548 + menu, Mutt properly space-stuffes the message. 1515 1549 <emphasis>Space-stuffing</emphasis> is required by RfC3676 defining 1516 1550 <literal>format=flowed</literal> and means to prepend a space to: 1517 1551 </para> 1518 1552 1519 1553 <itemizedlist> 1520 1554 <listitem><para>all lines starting with a space</para></listitem> 1521 - <listitem><para>lines starting with the word <quote><literal>From</literal></quote> 1522 - followed by space</para></listitem> 1523 - <listitem><para>all lines starting with <quote><literal>&gt;</literal></quote> which 1524 - is not intended to be a quote character</para></listitem> 1555 + <listitem><para>lines starting with the word 1556 + <quote><literal>From</literal></quote> followed by 1557 + space</para></listitem> 1558 + <listitem><para>all lines starting with 1559 + <quote><literal>&gt;</literal></quote> which is not intended to be a 1560 + quote character</para></listitem> 1525 1561 </itemizedlist> 1526 1562 1527 1563 <note> 1528 1564 <para> 1529 - Mutt only supports space-stuffing 1530 - for the first two types of lines but not for the third: It is impossible to 1531 - safely detect whether a leading <literal>&gt;</literal> character starts a 1532 - quote or not. Furthermore, Mutt only applies space-stuffing 1533 - <emphasis>once</emphasis> after the initial edit is finished. 1565 + Mutt only supports space-stuffing for the first two types of lines but 1566 + not for the third: It is impossible to safely detect whether a leading 1567 + <literal>&gt;</literal> character starts a quote or not. Furthermore, 1568 + Mutt only applies space-stuffing <emphasis>once</emphasis> after the 1569 + initial edit is finished. 1534 1570 </para> 1535 1571 </note> 1536 1572 1537 1573 <para> 1538 - All leading spaces are to be removed by receiving clients to restore 1539 - the original message prior to further processing. 1574 + All leading spaces are to be removed by receiving clients to restore the 1575 + original message prior to further processing. 1540 1576 </para> 1541 1577 1542 1578 </sect3> ··· 1545 1581 <title>Editor Considerations</title> 1546 1582 1547 1583 <para> 1548 - As Mutt provides no additional features to compose <literal>f=f</literal> 1549 - messages, it's completely up to the user and his editor to produce 1550 - proper messages. Please consider your editor's documentation if you 1551 - intend to send <literal>f=f</literal> messages. 1584 + As Mutt provides no additional features to compose 1585 + <literal>f=f</literal> messages, it's completely up to the user and his 1586 + editor to produce proper messages. Please consider your editor's 1587 + documentation if you intend to send <literal>f=f</literal> messages. 1552 1588 </para> 1553 1589 1554 1590 <para> ··· 1577 1613 Bouncing and forwarding let you send an existing message to recipients 1578 1614 that you specify. Bouncing a message sends a verbatim copy of a message 1579 1615 to alternative addresses as if they were the message's original 1580 - recipients specified in the Bcc header. 1581 - Forwarding a message, on the other hand, allows you to modify the message 1582 - before it is resent (for example, by adding your own comments). Bouncing 1583 - is done using the <literal>&lt;bounce&gt;</literal> function and forwarding 1584 - using the <literal>&lt;forward&gt;</literal> function bound to <quote>b</quote> and <quote>f</quote> 1585 - respectively. 1616 + recipients specified in the Bcc header. Forwarding a message, on the 1617 + other hand, allows you to modify the message before it is resent (for 1618 + example, by adding your own comments). Bouncing is done using the 1619 + <literal>&lt;bounce&gt;</literal> function and forwarding using the 1620 + <literal>&lt;forward&gt;</literal> function bound to <quote>b</quote> 1621 + and <quote>f</quote> respectively. 1586 1622 </para> 1587 1623 1588 1624 <para> 1589 1625 Forwarding can be done by including the original message in the new 1590 - message's body (surrounded by indicating lines) or including it as a MIME 1591 - attachment, depending on the value of the <link linkend="mime-forward">$mime_forward</link> variable. Decoding of attachments, 1592 - like in the pager, can be controlled by the <link linkend="forward-decode">$forward_decode</link> and <link linkend="mime-forward-decode">$mime_forward_decode</link> variables, 1626 + message's body (surrounded by indicating lines) or including it as a 1627 + MIME attachment, depending on the value of the <link 1628 + linkend="mime-forward">$mime_forward</link> variable. Decoding of 1629 + attachments, like in the pager, can be controlled by the <link 1630 + linkend="forward-decode">$forward_decode</link> and <link 1631 + linkend="mime-forward-decode">$mime_forward_decode</link> variables, 1593 1632 respectively. The desired forwarding format may depend on the content, 1594 - therefore <link linkend="mime-forward">$mime_forward</link> is a quadoption which, for 1595 - example, can be set to <quote>ask-no</quote>. 1633 + therefore <link linkend="mime-forward">$mime_forward</link> is a 1634 + quadoption which, for example, can be set to <quote>ask-no</quote>. 1596 1635 </para> 1597 1636 1598 1637 <para> 1599 1638 The inclusion of headers is controlled by the current setting of the 1600 - <link linkend="weed">$weed</link> variable, unless <link linkend="mime-forward">$mime_forward</link> is set. 1639 + <link linkend="weed">$weed</link> variable, unless <link 1640 + linkend="mime-forward">$mime_forward</link> is set. 1601 1641 </para> 1602 1642 1603 1643 <para> ··· 1612 1652 1613 1653 <para> 1614 1654 At times it is desirable to delay sending a message that you have 1615 - already begun to compose. When the <literal>&lt;postpone-message&gt;</literal> function is 1616 - used in the <emphasis>compose</emphasis> menu, the body of your message and attachments 1617 - are stored in the mailbox specified by the <link linkend="postponed">$postponed</link> variable. This means that you can recall the 1618 - message even if you exit Mutt and then restart it at a later time. 1655 + already begun to compose. When the 1656 + <literal>&lt;postpone-message&gt;</literal> function is used in the 1657 + <emphasis>compose</emphasis> menu, the body of your message and 1658 + attachments are stored in the mailbox specified by the <link 1659 + linkend="postponed">$postponed</link> variable. This means that you can 1660 + recall the message even if you exit Mutt and then restart it at a later 1661 + time. 1619 1662 </para> 1620 1663 1621 1664 <para> 1622 - Once a message is postponed, there are several ways to resume it. From the 1623 - command line you can use the <quote>-p</quote> option, or if you compose a new 1624 - message from the <emphasis>index</emphasis> or <emphasis>pager</emphasis> you will be prompted if postponed 1625 - messages exist. If multiple messages are currently postponed, the 1626 - <emphasis>postponed</emphasis> menu will pop up and you can select which message you would 1627 - like to resume. 1665 + Once a message is postponed, there are several ways to resume it. From 1666 + the command line you can use the <quote>-p</quote> option, or if you 1667 + compose a new message from the <emphasis>index</emphasis> or 1668 + <emphasis>pager</emphasis> you will be prompted if postponed messages 1669 + exist. If multiple messages are currently postponed, the 1670 + <emphasis>postponed</emphasis> menu will pop up and you can select which 1671 + message you would like to resume. 1628 1672 </para> 1629 1673 1630 1674 <note> 1631 1675 <para> 1632 - If you postpone a reply to a message, the reply setting of 1633 - the message is only updated when you actually finish the message and 1634 - send it. Also, you must be in the same folder with the message you 1635 - replied to for the status of the message to be updated. 1676 + If you postpone a reply to a message, the reply setting of the message 1677 + is only updated when you actually finish the message and send it. Also, 1678 + you must be in the same folder with the message you replied to for the 1679 + status of the message to be updated. 1636 1680 </para> 1637 1681 </note> 1638 1682 ··· 1651 1695 <title>Location of Initialization Files</title> 1652 1696 1653 1697 <para> 1654 - While the default configuration (or <quote>preferences</quote>) make Mutt 1655 - usable right out of the box, it is often desirable to tailor Mutt to 1656 - suit your own tastes. When Mutt is first invoked, it will attempt to 1657 - read the <quote>system</quote> configuration file (defaults set by your local 1658 - system administrator), unless the <quote>-n</quote> <link linkend="commandline">command line</link> option is specified. This file is typically 1659 - <literal>/usr/local/share/mutt/Muttrc</literal> or <literal>/etc/Muttrc</literal>. Mutt 1660 - will next look for a file named <literal>.muttrc</literal> in your home 1661 - directory. If this file does not exist and your home directory has 1662 - a subdirectory named <literal>.mutt</literal>, Mutt tries to load a file named 1698 + While the default configuration (or <quote>preferences</quote>) make 1699 + Mutt usable right out of the box, it is often desirable to tailor Mutt 1700 + to suit your own tastes. When Mutt is first invoked, it will attempt to 1701 + read the <quote>system</quote> configuration file (defaults set by your 1702 + local system administrator), unless the <quote>-n</quote> <link 1703 + linkend="commandline">command line</link> option is specified. This 1704 + file is typically <literal>/usr/local/share/mutt/Muttrc</literal> or 1705 + <literal>/etc/Muttrc</literal>. Mutt will next look for a file named 1706 + <literal>.muttrc</literal> in your home directory. If this file does 1707 + not exist and your home directory has a subdirectory named 1708 + <literal>.mutt</literal>, Mutt tries to load a file named 1663 1709 <literal>.mutt/muttrc</literal>. 1664 1710 </para> 1665 1711 1666 1712 <para> 1667 - <literal>.muttrc</literal> is the file where you will usually place your <link linkend="commands">commands</link> to configure Mutt. 1713 + <literal>.muttrc</literal> is the file where you will usually place your 1714 + <link linkend="commands">commands</link> to configure Mutt. 1668 1715 </para> 1669 1716 1670 1717 <para> 1671 1718 In addition, Mutt supports version specific configuration files that are 1672 - parsed instead of the default files as explained above. For instance, if 1673 - your system has a <literal>Muttrc-0.88</literal> file in the system configuration 1674 - directory, and you are running version 0.88 of Mutt, this file will be 1675 - sourced instead of the <literal>Muttrc</literal> file. The same is true of the user 1676 - configuration file, if you have a file <literal>.muttrc-0.88.6</literal> in your home 1677 - directory, when you run Mutt version 0.88.6, it will source this file 1678 - instead of the default <literal>.muttrc</literal> file. The version number is the 1679 - same which is visible using the <quote>-v</quote> <link linkend="commandline">command line</link> switch or using the <literal>show-version</literal> key (default: 1680 - V) from the index menu. 1719 + parsed instead of the default files as explained above. For instance, 1720 + if your system has a <literal>Muttrc-0.88</literal> file in the system 1721 + configuration directory, and you are running version 0.88 of Mutt, this 1722 + file will be sourced instead of the <literal>Muttrc</literal> file. The 1723 + same is true of the user configuration file, if you have a file 1724 + <literal>.muttrc-0.88.6</literal> in your home directory, when you run 1725 + Mutt version 0.88.6, it will source this file instead of the default 1726 + <literal>.muttrc</literal> file. The version number is the same which 1727 + is visible using the <quote>-v</quote> <link 1728 + linkend="commandline">command line</link> switch or using the 1729 + <literal>show-version</literal> key (default: V) from the index menu. 1681 1730 </para> 1682 1731 1683 1732 </sect1> ··· 1686 1735 <title>Syntax of Initialization Files</title> 1687 1736 1688 1737 <para> 1689 - An initialization file consists of a series of <link linkend="commands">commands</link>. Each line of the file may contain one or more commands. 1690 - When multiple commands are used, they must be separated by a semicolon 1691 - (<quote>;</quote>). 1738 + An initialization file consists of a series of <link 1739 + linkend="commands">commands</link>. Each line of the file may contain 1740 + one or more commands. When multiple commands are used, they must be 1741 + separated by a semicolon (<quote>;</quote>). 1692 1742 </para> 1693 1743 1694 1744 <example id="ex-rc-multiple-cmds"> ··· 1699 1749 </example> 1700 1750 1701 1751 <para> 1702 - The hash mark, or pound sign 1703 - (<quote>#</quote>), is used as a <quote>comment</quote> character. You can use it to 1704 - annotate your initialization file. All text after the comment character 1705 - to the end of the line is ignored. 1752 + The hash mark, or pound sign (<quote>#</quote>), is used as a 1753 + <quote>comment</quote> character. You can use it to annotate your 1754 + initialization file. All text after the comment character to the end of 1755 + the line is ignored. 1706 1756 </para> 1707 1757 1708 1758 <example id="ex-ec-comment"> ··· 1713 1763 </example> 1714 1764 1715 1765 <para> 1716 - Single quotes (<quote>'</quote>) and double quotes (<quote>"</quote>) can be used to quote strings 1717 - which contain spaces or other special characters. The difference between 1718 - the two types of quotes is similar to that of many popular shell programs, 1719 - namely that a single quote is used to specify a literal string (one that is 1720 - not interpreted for shell variables or quoting with a backslash [see 1721 - next paragraph]), while double quotes indicate a string for which 1722 - should be evaluated. For example, backticks are evaluated inside of double 1723 - quotes, but <emphasis>not</emphasis> for single quotes. 1766 + Single quotes (<quote>'</quote>) and double quotes (<quote>"</quote>) 1767 + can be used to quote strings which contain spaces or other special 1768 + characters. The difference between the two types of quotes is similar 1769 + to that of many popular shell programs, namely that a single quote is 1770 + used to specify a literal string (one that is not interpreted for shell 1771 + variables or quoting with a backslash [see next paragraph]), while 1772 + double quotes indicate a string for which should be evaluated. For 1773 + example, backticks are evaluated inside of double quotes, but 1774 + <emphasis>not</emphasis> for single quotes. 1724 1775 </para> 1725 1776 1726 1777 <para> 1727 - <quote>\</quote> quotes the next character, just as in shells such as bash and zsh. 1728 - For example, if want to put quotes <quote>"</quote> inside of a string, you can use 1729 - <quote>\</quote> to force the next character to be a literal instead of interpreted 1730 - character. 1778 + <quote>\</quote> quotes the next character, just as in shells such as 1779 + bash and zsh. For example, if want to put quotes <quote>"</quote> 1780 + inside of a string, you can use <quote>\</quote> to force the next 1781 + character to be a literal instead of interpreted character. 1731 1782 </para> 1732 1783 1733 1784 <example id="ex-rc-quote"> ··· 1744 1795 </para> 1745 1796 1746 1797 <para> 1747 - A <quote>\</quote> at the end of a line can be used to split commands over 1748 - multiple lines as it <quote>escapes</quote> the line end, provided that the split points don't appear in the 1749 - middle of command names. Lines are first concatenated before 1750 - interpretation so that a multi-line can be commented by commenting out 1751 - the first line only. 1798 + A <quote>\</quote> at the end of a line can be used to split commands 1799 + over multiple lines as it <quote>escapes</quote> the line end, provided 1800 + that the split points don't appear in the middle of command names. Lines 1801 + are first concatenated before interpretation so that a multi-line can be 1802 + commented by commenting out the first line only. 1752 1803 </para> 1753 1804 1754 1805 <example id="ex-rc-split"> ··· 1764 1815 It is also possible to substitute the output of a Unix command in an 1765 1816 initialization file. This is accomplished by enclosing the command in 1766 1817 backticks (``). In <xref linkend="ex-rc-backtick"/>, the output of the 1767 - Unix command <quote>uname -a</quote> will be substituted before the 1768 - line is parsed. 1769 - Since initialization files are line oriented, only 1770 - the first line of output from the Unix command will be substituted. 1818 + Unix command <quote>uname -a</quote> will be substituted before the line 1819 + is parsed. Since initialization files are line oriented, only the first 1820 + line of output from the Unix command will be substituted. 1771 1821 </para> 1772 1822 1773 1823 <example id="ex-rc-backtick"> ··· 1791 1841 1792 1842 <para> 1793 1843 will cause Mutt to save outgoing messages to a folder named 1794 - <quote>sent_on_kremvax</quote> if the environment variable <literal>$HOSTNAME</literal> is set to 1795 - <quote>kremvax.</quote> (See <link linkend="record">$record</link> for 1796 - details.) 1844 + <quote>sent_on_kremvax</quote> if the environment variable 1845 + <literal>$HOSTNAME</literal> is set to <quote>kremvax.</quote> (See 1846 + <link linkend="record">$record</link> for details.) 1797 1847 </para> 1798 1848 1799 1849 <para> 1800 1850 Mutt expands the variable when it is assigned, not when it is used. If 1801 - the value of a variable on the right-hand side of an assignment 1802 - changes after the assignment, the variable on the left-hand side will 1803 - not be affected. 1851 + the value of a variable on the right-hand side of an assignment changes 1852 + after the assignment, the variable on the left-hand side will not be 1853 + affected. 1804 1854 </para> 1805 1855 1806 1856 <para> 1807 1857 The commands understood by Mutt are explained in the next paragraphs. 1808 - For a complete list, see the <link linkend="commands">command reference</link>. 1858 + For a complete list, see the <link linkend="commands">command 1859 + reference</link>. 1809 1860 </para> 1810 1861 1811 1862 <para> 1812 1863 All configuration files are expected to be in the current locale as 1813 - specified by the <link linkend="charset">$charset</link> variable 1814 - which doesn't have a default value since it's determined by Mutt at startup. 1864 + specified by the <link linkend="charset">$charset</link> variable which 1865 + doesn't have a default value since it's determined by Mutt at startup. 1815 1866 If a configuration file is not encoded in the same character set the 1816 - <link linkend="config-charset">$config_charset</link> 1817 - variable should be used: all lines starting with the next are recoded 1818 - from <link linkend="config-charset">$config_charset</link> 1819 - to <link linkend="charset">$charset</link>. 1867 + <link linkend="config-charset">$config_charset</link> variable should be 1868 + used: all lines starting with the next are recoded from <link 1869 + linkend="config-charset">$config_charset</link> to <link 1870 + linkend="charset">$charset</link>. 1820 1871 </para> 1821 1872 1822 1873 <para> 1823 - This mechanism should be avoided if possible as it has the 1824 - following implications: 1874 + This mechanism should be avoided if possible as it has the following 1875 + implications: 1825 1876 </para> 1826 1877 1827 1878 <itemizedlist> 1828 1879 1829 1880 <listitem><para>These variables should be set early in a configuration 1830 - file with <link linkend="charset">$charset</link> preceding 1831 - <link linkend="config-charset">$config_charset</link> so Mutt 1832 - knows what character set to convert to.</para></listitem> 1881 + file with <link linkend="charset">$charset</link> preceding <link 1882 + linkend="config-charset">$config_charset</link> so Mutt knows what 1883 + character set to convert to.</para></listitem> 1833 1884 1834 - <listitem><para>If <link linkend="config-charset">$config_charset</link> is set, it should be set 1835 - in each configuration file because the value is global and <emphasis>not</emphasis> 1836 - per configuration file.</para></listitem> 1885 + <listitem><para>If <link linkend="config-charset">$config_charset</link> 1886 + is set, it should be set in each configuration file because the value is 1887 + global and <emphasis>not</emphasis> per configuration 1888 + file.</para></listitem> 1837 1889 1838 - <listitem><para>Because Mutt first recodes a line before it attempts to parse it, 1839 - a conversion introducing question marks or other characters as 1840 - part of errors (unconvertable characters, transliteration) may introduce syntax 1841 - errors or silently change the meaning of certain tokens (e.g. inserting 1842 - question marks into regular expressions).</para></listitem> 1890 + <listitem><para>Because Mutt first recodes a line before it attempts to 1891 + parse it, a conversion introducing question marks or other characters as 1892 + part of errors (unconvertable characters, transliteration) may introduce 1893 + syntax errors or silently change the meaning of certain tokens 1894 + (e.g. inserting question marks into regular 1895 + expressions).</para></listitem> 1843 1896 1844 1897 </itemizedlist> 1845 1898 ··· 1898 1951 </para> 1899 1952 1900 1953 <para> 1901 - These address groups can also be created implicitly by the 1902 - <link linkend="alias"><command>alias</command></link>, <link linkend="lists">lists</link>, 1903 - <link linkend="lists">subscribe</link> and 1904 - <link linkend="alternates"><command>alternates</command></link> commands by specifying the 1905 - optional <literal>-group</literal> option. 1954 + These address groups can also be created implicitly by the <link 1955 + linkend="alias"><command>alias</command></link>, <link 1956 + linkend="lists">lists</link>, <link linkend="lists">subscribe</link> and 1957 + <link linkend="alternates"><command>alternates</command></link> commands 1958 + by specifying the optional <literal>-group</literal> option. 1906 1959 </para> 1907 1960 1908 1961 <para> 1909 - Once defined, these address groups can be used in 1910 - <link linkend="patterns">patterns</link> to search for and limit the 1911 - display to messages matching a group. 1962 + Once defined, these address groups can be used in <link 1963 + linkend="patterns">patterns</link> to search for and limit the display 1964 + to messages matching a group. 1912 1965 </para> 1913 1966 1914 1967 <para> ··· 1958 2011 </cmdsynopsis> 1959 2012 1960 2013 <para> 1961 - It's usually very cumbersome to remember or type out the address of someone 1962 - you are communicating with. Mutt allows you to create <quote>aliases</quote> which map 1963 - a short string to a full address. 2014 + It's usually very cumbersome to remember or type out the address of 2015 + someone you are communicating with. Mutt allows you to create 2016 + <quote>aliases</quote> which map a short string to a full address. 1964 2017 </para> 1965 2018 1966 2019 <note> 1967 2020 <para> 1968 - If you want to create an alias for more than 1969 - one address, you <emphasis>must</emphasis> separate the addresses with a comma (<quote>,</quote>). 2021 + If you want to create an alias for more than one address, you 2022 + <emphasis>must</emphasis> separate the addresses with a comma 2023 + (<quote>,</quote>). 1970 2024 </para> 1971 2025 </note> 1972 2026 ··· 1986 2040 </screen> 1987 2041 1988 2042 <para> 1989 - Unlike other mailers, Mutt doesn't require aliases to be defined 1990 - in a special file. The <command>alias</command> command can appear anywhere in 1991 - a configuration file, as long as this file is <link linkend="source"><command>source</command>d</link>. Consequently, you can have multiple alias files, or 1992 - you can have all aliases defined in your <literal>.muttrc</literal>. 2043 + Unlike other mailers, Mutt doesn't require aliases to be defined in a 2044 + special file. The <command>alias</command> command can appear anywhere 2045 + in a configuration file, as long as this file is <link 2046 + linkend="source"><command>source</command>d</link>. Consequently, you 2047 + can have multiple alias files, or you can have all aliases defined in 2048 + your <literal>.muttrc</literal>. 1993 2049 </para> 1994 2050 1995 2051 <para> 1996 - On the other hand, the <link linkend="create-alias"><literal>&lt;create-alias&gt;</literal></link> 1997 - function can use only one file, the one pointed to by the <link linkend="alias-file">$alias_file</link> variable (which is 1998 - <literal>#/.muttrc</literal> by default). This file is not special either, 1999 - in the sense that Mutt will happily append aliases to any file, but in 2000 - order for the new aliases to take effect you need to explicitly <link linkend="source"><command>source</command></link> this file too. 2052 + On the other hand, the <link 2053 + linkend="create-alias"><literal>&lt;create-alias&gt;</literal></link> 2054 + function can use only one file, the one pointed to by the <link 2055 + linkend="alias-file">$alias_file</link> variable (which is 2056 + <literal>~/.muttrc</literal> by default). This file is not special 2057 + either, in the sense that Mutt will happily append aliases to any file, 2058 + but in order for the new aliases to take effect you need to explicitly 2059 + <link linkend="source"><command>source</command></link> this file too. 2001 2060 </para> 2002 2061 2003 2062 <example id="ex-alias-external"> ··· 2011 2070 2012 2071 <para> 2013 2072 To use aliases, you merely use the alias at any place in Mutt where Mutt 2014 - prompts for addresses, such as the <emphasis>To:</emphasis> or <emphasis>Cc:</emphasis> prompt. You can 2015 - also enter aliases in your editor at the appropriate headers if you have the 2016 - <link linkend="edit-headers">$edit_headers</link> variable set. 2073 + prompts for addresses, such as the <emphasis>To:</emphasis> or 2074 + <emphasis>Cc:</emphasis> prompt. You can also enter aliases in your 2075 + editor at the appropriate headers if you have the <link 2076 + linkend="edit-headers">$edit_headers</link> variable set. 2017 2077 </para> 2018 2078 2019 2079 <para> 2020 - In addition, at the various address prompts, you can use the tab character 2021 - to expand a partial alias to the full alias. If there are multiple matches, 2022 - Mutt will bring up a menu with the matching aliases. In order to be 2023 - presented with the full list of aliases, you must hit tab without a partial 2024 - alias, such as at the beginning of the prompt or after a comma denoting 2025 - multiple addresses. 2080 + In addition, at the various address prompts, you can use the tab 2081 + character to expand a partial alias to the full alias. If there are 2082 + multiple matches, Mutt will bring up a menu with the matching aliases. 2083 + In order to be presented with the full list of aliases, you must hit tab 2084 + without a partial alias, such as at the beginning of the prompt or after 2085 + a comma denoting multiple addresses. 2026 2086 </para> 2027 2087 2028 2088 <para> 2029 2089 In the alias menu, you can select as many aliases as you want with the 2030 - <literal>select-entry</literal> key (default: &lt;Return&gt;), and use the 2031 - <emphasis>exit</emphasis> key (default: q) to return to the address prompt. 2090 + <literal>select-entry</literal> key (default: &lt;Return&gt;), and use 2091 + the <emphasis>exit</emphasis> key (default: q) to return to the address 2092 + prompt. 2032 2093 </para> 2033 2094 2034 2095 </sect1> ··· 2057 2118 </para> 2058 2119 2059 2120 <para> 2060 - <emphasis>map</emphasis> specifies in which menu the binding belongs. Multiple maps may 2061 - be specified by separating them with commas (no additional whitespace is 2062 - allowed). The currently defined maps are: 2121 + <emphasis>map</emphasis> specifies in which menu the binding belongs. 2122 + Multiple maps may be specified by separating them with commas (no 2123 + additional whitespace is allowed). The currently defined maps are: 2063 2124 </para> 2064 2125 2065 2126 <anchor id="maps"/> ··· 2071 2132 <para> 2072 2133 This is not a real menu, but is used as a fallback for all of the other 2073 2134 menus except for the pager and editor modes. If a key is not defined in 2074 - another menu, Mutt will look for a binding to use in this menu. This allows 2075 - you to bind a key to a certain function in multiple menus instead of having 2076 - multiple <command>bind</command> statements to accomplish the same task. 2135 + another menu, Mutt will look for a binding to use in this menu. This 2136 + allows you to bind a key to a certain function in multiple menus instead 2137 + of having multiple <command>bind</command> statements to accomplish the 2138 + same task. 2077 2139 </para> 2078 2140 </listitem> 2079 2141 </varlistentry> ··· 2082 2144 <listitem> 2083 2145 <para> 2084 2146 The alias menu is the list of your personal aliases as defined in your 2085 - <literal>.muttrc</literal>. It is the mapping from a short alias name to the full email 2086 - address(es) of the recipient(s). 2147 + <literal>.muttrc</literal>. It is the mapping from a short alias name 2148 + to the full email address(es) of the recipient(s). 2087 2149 </para> 2088 2150 </listitem> 2089 2151 </varlistentry> ··· 2091 2153 <term>attach</term> 2092 2154 <listitem> 2093 2155 <para> 2094 - The attachment menu is used to access the attachments on received messages. 2156 + The attachment menu is used to access the attachments on received 2157 + messages. 2095 2158 </para> 2096 2159 </listitem> 2097 2160 </varlistentry> ··· 2099 2162 <term>browser</term> 2100 2163 <listitem> 2101 2164 <para> 2102 - The browser is used for both browsing the local directory structure, and for 2103 - listing all of your incoming mailboxes. 2165 + The browser is used for both browsing the local directory structure, and 2166 + for listing all of your incoming mailboxes. 2104 2167 </para> 2105 2168 </listitem> 2106 2169 </varlistentry> ··· 2150 2213 <term>smime</term> 2151 2214 <listitem> 2152 2215 <para> 2153 - The smime menu is used to select the OpenSSL certificates used to encrypt outgoing 2154 - messages. 2216 + The smime menu is used to select the OpenSSL certificates used to 2217 + encrypt outgoing messages. 2155 2218 </para> 2156 2219 </listitem> 2157 2220 </varlistentry> ··· 2168 2231 <term>query</term> 2169 2232 <listitem> 2170 2233 <para> 2171 - The query menu is the browser for results returned by 2172 - <link linkend="query-command">$query_command</link>. 2234 + The query menu is the browser for results returned by <link 2235 + linkend="query-command">$query_command</link>. 2173 2236 </para> 2174 2237 </listitem> 2175 2238 </varlistentry> ··· 2185 2248 </variablelist> 2186 2249 2187 2250 <para> 2188 - <emphasis>key</emphasis> is the key (or key sequence) you wish to bind. To specify a 2189 - control character, use the sequence <emphasis>\Cx</emphasis>, where <emphasis>x</emphasis> is the 2190 - letter of the control character (for example, to specify control-A use 2191 - <quote>\Ca</quote>). Note that the case of <emphasis>x</emphasis> as well as <emphasis>\C</emphasis> is 2192 - ignored, so that <emphasis>\CA</emphasis>, <emphasis>\Ca</emphasis>, <emphasis>\cA</emphasis> and <emphasis>\ca</emphasis> are all 2251 + <emphasis>key</emphasis> is the key (or key sequence) you wish to bind. 2252 + To specify a control character, use the sequence 2253 + <emphasis>\Cx</emphasis>, where <emphasis>x</emphasis> is the letter of 2254 + the control character (for example, to specify control-A use 2255 + <quote>\Ca</quote>). Note that the case of <emphasis>x</emphasis> as 2256 + well as <emphasis>\C</emphasis> is ignored, so that 2257 + <emphasis>\CA</emphasis>, <emphasis>\Ca</emphasis>, 2258 + <emphasis>\cA</emphasis> and <emphasis>\ca</emphasis> are all 2193 2259 equivalent. An alternative form is to specify the key as a three digit 2194 - octal number prefixed with a <quote>\</quote> (for example <emphasis>\177</emphasis> is 2195 - equivalent to <emphasis>\c?</emphasis>). In addition, <emphasis>key</emphasis> may 2196 - be a symbolic name as shown in <xref linkend="tab-key-names"/>. 2260 + octal number prefixed with a <quote>\</quote> (for example 2261 + <emphasis>\177</emphasis> is equivalent to <emphasis>\c?</emphasis>). In 2262 + addition, <emphasis>key</emphasis> may be a symbolic name as shown in 2263 + <xref linkend="tab-key-names"/>. 2197 2264 </para> 2198 2265 2199 2266 <table id="tab-key-names"> ··· 2231 2298 </table> 2232 2299 2233 2300 <para> 2234 - <emphasis>key</emphasis> does not need to be enclosed in quotes unless it contains a 2235 - space (<quote>&nbsp;</quote>) or semi-colon (<quote>;</quote>). 2301 + <emphasis>key</emphasis> does not need to be enclosed in quotes unless 2302 + it contains a space (<quote>&nbsp;</quote>) or semi-colon 2303 + (<quote>;</quote>). 2236 2304 </para> 2237 2305 2238 2306 <para> ··· 2274 2342 </cmdsynopsis> 2275 2343 2276 2344 <para> 2277 - The <command>charset-hook</command> command defines an alias for a character set. 2278 - This is useful to properly display messages which are tagged with a 2279 - character set name not known to Mutt. 2345 + The <command>charset-hook</command> command defines an alias for a 2346 + character set. This is useful to properly display messages which are 2347 + tagged with a character set name not known to Mutt. 2280 2348 </para> 2281 2349 2282 2350 <para> 2283 - The <command>iconv-hook</command> command defines a system-specific name for a 2284 - character set. This is helpful when your systems character 2285 - conversion library insists on using strange, system-specific names 2286 - for character sets. 2351 + The <command>iconv-hook</command> command defines a system-specific name 2352 + for a character set. This is helpful when your systems character 2353 + conversion library insists on using strange, system-specific names for 2354 + character sets. 2287 2355 </para> 2288 2356 2289 2357 </sect1> ··· 2305 2373 2306 2374 <para> 2307 2375 It is often desirable to change settings based on which mailbox you are 2308 - reading. The <command>folder-hook</command> command provides a method by which you can execute 2309 - any configuration command. <emphasis>regexp</emphasis> is a regular expression specifying 2310 - in which mailboxes to execute <emphasis>command</emphasis> before loading. If a mailbox 2311 - matches multiple <command>folder-hook</command>s, they are executed in the order given in the 2312 - <literal>.muttrc</literal>. 2376 + reading. The <command>folder-hook</command> command provides a method 2377 + by which you can execute any configuration command. 2378 + <emphasis>regexp</emphasis> is a regular expression specifying in which 2379 + mailboxes to execute <emphasis>command</emphasis> before loading. If a 2380 + mailbox matches multiple <command>folder-hook</command>s, they are 2381 + executed in the order given in the <literal>.muttrc</literal>. 2313 2382 </para> 2314 2383 2315 2384 <note> 2316 2385 <para> 2317 - If you use the <quote>!</quote> shortcut for <link linkend="spoolfile">$spoolfile</link> at the beginning of the pattern, you must place it 2318 - inside of double or single quotes in order to distinguish it from the 2319 - logical <emphasis>not</emphasis> operator for the expression. 2386 + If you use the <quote>!</quote> shortcut for <link 2387 + linkend="spoolfile">$spoolfile</link> at the beginning of the pattern, 2388 + you must place it inside of double or single quotes in order to 2389 + distinguish it from the logical <emphasis>not</emphasis> operator for 2390 + the expression. 2320 2391 </para> 2321 2392 </note> 2322 2393 2323 2394 <note> 2324 2395 <para> 2325 - Settings are <emphasis>not</emphasis> restored when you leave the mailbox. 2326 - For example, a command action to perform is to change the sorting method 2327 - based upon the mailbox being read: 2396 + Settings are <emphasis>not</emphasis> restored when you leave the 2397 + mailbox. For example, a command action to perform is to change the 2398 + sorting method based upon the mailbox being read: 2399 + </para> 2328 2400 2329 2401 <screen> 2330 2402 folder-hook mutt "set sort=threads"</screen> 2331 2403 2404 + <para> 2332 2405 However, the sorting method is not restored to its previous value when 2333 - reading a different mailbox. To specify a <emphasis>default</emphasis> command, use the 2334 - pattern <quote>.</quote> before other <command>folder-hook</command>s adjusting a value on a per-folder basis 2335 - because <command>folder-hook</command>s are evaluated in the order given in the 2336 - configuration file. 2406 + reading a different mailbox. To specify a <emphasis>default</emphasis> 2407 + command, use the pattern <quote>.</quote> before other 2408 + <command>folder-hook</command>s adjusting a value on a per-folder basis 2409 + because <command>folder-hook</command>s are evaluated in the order given 2410 + in the configuration file. 2337 2411 </para> 2338 2412 </note> 2339 2413 2340 2414 <para> 2341 - The following example will set the <link linkend="sort">sort</link> variable 2342 - to <literal>date-sent</literal> for all folders but to <literal>threads</literal> 2343 - for all folders containing <quote>mutt</quote> in their name. 2415 + The following example will set the <link linkend="sort">sort</link> 2416 + variable to <literal>date-sent</literal> for all folders but to 2417 + <literal>threads</literal> for all folders containing 2418 + <quote>mutt</quote> in their name. 2344 2419 </para> 2345 2420 2346 2421 <example id="ex-folder-sorting"> ··· 2375 2450 </cmdsynopsis> 2376 2451 2377 2452 <para> 2378 - Macros are useful when you would like a single key to perform a series of 2379 - actions. When you press <emphasis>key</emphasis> in menu <emphasis>menu</emphasis>, Mutt will behave as if 2380 - you had typed <emphasis>sequence</emphasis>. So if you have a common sequence of commands 2381 - you type, you can create a macro to execute those commands with a single 2382 - key or fewer keys. 2453 + Macros are useful when you would like a single key to perform a series 2454 + of actions. When you press <emphasis>key</emphasis> in menu 2455 + <emphasis>menu</emphasis>, Mutt will behave as if you had typed 2456 + <emphasis>sequence</emphasis>. So if you have a common sequence of 2457 + commands you type, you can create a macro to execute those commands with 2458 + a single key or fewer keys. 2383 2459 </para> 2384 2460 2385 2461 <para> 2386 - <emphasis>menu</emphasis> is the <link linkend="maps">map</link> which the macro will be bound in. 2387 - Multiple maps may be specified by separating multiple menu arguments by 2388 - commas. Whitespace may not be used in between the menu arguments and the 2389 - commas separating them. 2462 + <emphasis>menu</emphasis> is the <link linkend="maps">map</link> which 2463 + the macro will be bound in. Multiple maps may be specified by 2464 + separating multiple menu arguments by commas. Whitespace may not be used 2465 + in between the menu arguments and the commas separating them. 2390 2466 </para> 2391 2467 2392 2468 <para> 2393 - <emphasis>key</emphasis> and <emphasis>sequence</emphasis> are expanded by the same rules as the 2394 - <link linkend="bind">key bindings</link> with some additions. The 2395 - first is that control characters in <emphasis>sequence</emphasis> can also be specified 2396 - as <emphasis>^x</emphasis>. In order to get a caret (<quote>^</quote>) you need to use 2397 - <emphasis>^^</emphasis>. Secondly, to specify a certain key such as <emphasis>up</emphasis> 2398 - or to invoke a function directly, you can use the format 2399 - <emphasis>&lt;key name&gt;</emphasis> and <emphasis>&lt;function name&gt;</emphasis>. For a listing of key 2400 - names see the section on <link linkend="bind">key bindings</link>. Functions 2469 + <emphasis>key</emphasis> and <emphasis>sequence</emphasis> are expanded 2470 + by the same rules as the <link linkend="bind">key bindings</link> with 2471 + some additions. The first is that control characters in 2472 + <emphasis>sequence</emphasis> can also be specified as 2473 + <emphasis>^x</emphasis>. In order to get a caret (<quote>^</quote>) you 2474 + need to use <emphasis>^^</emphasis>. Secondly, to specify a certain key 2475 + such as <emphasis>up</emphasis> or to invoke a function directly, you 2476 + can use the format <emphasis>&lt;key name&gt;</emphasis> and 2477 + <emphasis>&lt;function name&gt;</emphasis>. For a listing of key names 2478 + see the section on <link linkend="bind">key bindings</link>. Functions 2401 2479 are listed in the <link linkend="functions">reference</link>. 2402 2480 </para> 2403 2481 2404 2482 <para> 2405 2483 The advantage with using function names directly is that the macros will 2406 - work regardless of the current key bindings, so they are not dependent on 2407 - the user having particular key definitions. This makes them more robust 2408 - and portable, and also facilitates defining of macros in files used by more 2409 - than one user (e.g., the system Muttrc). 2484 + work regardless of the current key bindings, so they are not dependent 2485 + on the user having particular key definitions. This makes them more 2486 + robust and portable, and also facilitates defining of macros in files 2487 + used by more than one user (e.g., the system Muttrc). 2410 2488 </para> 2411 2489 2412 2490 <para> 2413 - Optionally you can specify a descriptive text after <emphasis>sequence</emphasis>, 2414 - which is shown in the help screens if they contain a description. 2491 + Optionally you can specify a descriptive text after 2492 + <emphasis>sequence</emphasis>, which is shown in the help screens if 2493 + they contain a description. 2415 2494 </para> 2416 2495 2417 2496 <note> ··· 2496 2575 </cmdsynopsis> 2497 2576 2498 2577 <para> 2499 - If your terminal supports color, you can spice up Mutt by creating your own 2500 - color scheme. To define the color of an object (type of information), you 2501 - must specify both a foreground color <emphasis>and</emphasis> a background color (it is not 2502 - possible to only specify one or the other). 2578 + If your terminal supports color, you can spice up Mutt by creating your 2579 + own color scheme. To define the color of an object (type of 2580 + information), you must specify both a foreground color 2581 + <emphasis>and</emphasis> a background color (it is not possible to only 2582 + specify one or the other). 2503 2583 </para> 2504 2584 2505 2585 <para> 2506 - <emphasis>header</emphasis> and <emphasis>body</emphasis> match <emphasis>regexp</emphasis> 2507 - in the header/body of a message, <emphasis>index</emphasis> matches <emphasis>pattern</emphasis> 2508 - (see <xref linkend="patterns"/>) in the message index. 2586 + <emphasis>header</emphasis> and <emphasis>body</emphasis> match 2587 + <emphasis>regexp</emphasis> in the header/body of a message, 2588 + <emphasis>index</emphasis> matches <emphasis>pattern</emphasis> (see 2589 + <xref linkend="patterns"/>) in the message index. 2509 2590 </para> 2510 2591 2511 2592 <para> ··· 2525 2606 <listitem><para>quoted1, quoted2, ..., quoted<emphasis>N</emphasis> (higher levels of quoting)</para></listitem> 2526 2607 <listitem><para>search (hiliting of words in the pager)</para></listitem> 2527 2608 <listitem><para>signature</para></listitem><listitem><para>status (mode lines used to display info about the mailbox or message)</para></listitem> 2528 - <listitem><para>tilde (the <quote>#</quote> used to pad blank lines in the pager)</para></listitem> 2609 + <listitem><para>tilde (the <quote>~</quote> used to pad blank lines in the pager)</para></listitem> 2529 2610 <listitem><para>tree (thread tree drawn in the message index and attachment menu)</para></listitem> 2530 2611 <listitem><para>underline (hiliting underlined patterns in the body of messages)</para></listitem> 2531 2612 </itemizedlist> 2532 2613 2533 2614 <para> 2534 - <emphasis>foreground</emphasis> and <emphasis>background</emphasis> can be one of the following: 2615 + <emphasis>foreground</emphasis> and <emphasis>background</emphasis> can 2616 + be one of the following: 2535 2617 </para> 2536 2618 2537 2619 <itemizedlist> ··· 2549 2631 </itemizedlist> 2550 2632 2551 2633 <para> 2552 - <emphasis>foreground</emphasis> can optionally be prefixed with the keyword <literal>bright</literal> to make 2553 - the foreground color boldfaced (e.g., <literal>brightred</literal>). 2634 + <emphasis>foreground</emphasis> can optionally be prefixed with the 2635 + keyword <literal>bright</literal> to make the foreground color boldfaced 2636 + (e.g., <literal>brightred</literal>). 2554 2637 </para> 2555 2638 2556 2639 <para> 2557 - If your terminal supports it, the special keyword <emphasis>default</emphasis> can be 2558 - used as a transparent color. The value <emphasis>brightdefault</emphasis> is also valid. 2559 - If Mutt is linked against the <emphasis>S-Lang</emphasis> library, you also need to set 2560 - the <literal>$COLORFGBG</literal> environment variable to the default colors of your 2561 - terminal for this to work; for example (for Bourne-like shells): 2640 + If your terminal supports it, the special keyword 2641 + <emphasis>default</emphasis> can be used as a transparent color. The 2642 + value <emphasis>brightdefault</emphasis> is also valid. If Mutt is 2643 + linked against the <emphasis>S-Lang</emphasis> library, you also need to 2644 + set the <literal>$COLORFGBG</literal> environment variable to the 2645 + default colors of your terminal for this to work; for example (for 2646 + Bourne-like shells): 2562 2647 </para> 2563 2648 2564 2649 <screen> ··· 2568 2653 2569 2654 <note> 2570 2655 <para> 2571 - The <emphasis>S-Lang</emphasis> library requires you to use the <emphasis>lightgray</emphasis> 2572 - and <emphasis>brown</emphasis> keywords instead of <emphasis>white</emphasis> and <emphasis>yellow</emphasis> when 2573 - setting this variable. 2656 + The <emphasis>S-Lang</emphasis> library requires you to use the 2657 + <emphasis>lightgray</emphasis> and <emphasis>brown</emphasis> keywords 2658 + instead of <emphasis>white</emphasis> and <emphasis>yellow</emphasis> 2659 + when setting this variable. 2574 2660 </para> 2575 2661 </note> 2576 2662 2577 2663 <note> 2578 2664 <para> 2579 - The <command>uncolor</command> command can be applied to the index, header and body objects only. It 2580 - removes entries from the list. You <emphasis>must</emphasis> specify the same pattern 2581 - specified in the <command>color</command> command for it to be removed. The pattern <quote>*</quote> is 2582 - a special token which means to clear the color list of all entries. 2665 + The <command>uncolor</command> command can be applied to the index, 2666 + header and body objects only. It removes entries from the list. You 2667 + <emphasis>must</emphasis> specify the same pattern specified in the 2668 + <command>color</command> command for it to be removed. The pattern 2669 + <quote>*</quote> is a special token which means to clear the color list 2670 + of all entries. 2583 2671 </para> 2584 2672 </note> 2585 2673 2586 2674 <para> 2587 - Mutt also recognizes the keywords <emphasis>color0</emphasis>, <emphasis>color1</emphasis>, ..., 2588 - <emphasis>color</emphasis><emphasis>N-1</emphasis> (<emphasis>N</emphasis> being the number of colors supported 2589 - by your terminal). This is useful when you remap the colors for your 2590 - display (for example by changing the color associated with <emphasis>color2</emphasis> 2591 - for your xterm), since color names may then lose their normal meaning. 2675 + Mutt also recognizes the keywords <emphasis>color0</emphasis>, 2676 + <emphasis>color1</emphasis>, ..., 2677 + <emphasis>color</emphasis><emphasis>N-1</emphasis> 2678 + (<emphasis>N</emphasis> being the number of colors supported by your 2679 + terminal). This is useful when you remap the colors for your display 2680 + (for example by changing the color associated with 2681 + <emphasis>color2</emphasis> for your xterm), since color names may then 2682 + lose their normal meaning. 2592 2683 </para> 2593 2684 2594 2685 <anchor id="mono"/> 2595 2686 <para> 2596 - If your terminal does not support color, it is still possible change the video 2597 - attributes through the use of the <quote>mono</quote> command. Usage: 2687 + If your terminal does not support color, it is still possible change the 2688 + video attributes through the use of the <quote>mono</quote> 2689 + command. Usage: 2598 2690 </para> 2599 2691 2600 2692 <cmdsynopsis> ··· 2656 2748 </cmdsynopsis> 2657 2749 2658 2750 <para> 2659 - For <emphasis>object</emphasis>, see the <command>color</command> command. <emphasis>attribute</emphasis> 2660 - can be one of the following: 2751 + For <emphasis>object</emphasis>, see the <command>color</command> 2752 + command. <emphasis>attribute</emphasis> can be one of the following: 2661 2753 </para> 2662 2754 2663 2755 <itemizedlist> ··· 2678 2770 2679 2771 <para> 2680 2772 When displaying a message in the pager, Mutt folds long header lines at 2681 - <link linkend="wrap">$wrap</link> columns. Though there're 2682 - precise rules about where to break and how, Mutt always folds headers 2683 - using a tab for readability. (Note that the sending side is not affected 2684 - by this, Mutt tries to implement standards compliant folding.) 2773 + <link linkend="wrap">$wrap</link> columns. Though there're precise rules 2774 + about where to break and how, Mutt always folds headers using a tab for 2775 + readability. (Note that the sending side is not affected by this, Mutt 2776 + tries to implement standards compliant folding.) 2685 2777 </para> 2686 2778 2687 2779 </sect2> ··· 2712 2804 </cmdsynopsis> 2713 2805 2714 2806 <para> 2715 - Messages often have many header fields added by automatic processing systems, 2716 - or which may not seem useful to display on the screen. This command allows 2717 - you to specify header fields which you don't normally want to see in the pager. 2807 + Messages often have many header fields added by automatic processing 2808 + systems, or which may not seem useful to display on the screen. This 2809 + command allows you to specify header fields which you don't normally 2810 + want to see in the pager. 2718 2811 </para> 2719 2812 2720 2813 <para> 2721 2814 You do not need to specify the full header field name. For example, 2722 - <quote>ignore content-</quote> will ignore all header fields that begin with the pattern 2723 - <quote>content-</quote>. <quote>ignore *</quote> will ignore all headers. 2815 + <quote>ignore content-</quote> will ignore all header fields that begin 2816 + with the pattern <quote>content-</quote>. <quote>ignore *</quote> will 2817 + ignore all headers. 2724 2818 </para> 2725 2819 2726 2820 <para> 2727 - To remove a previously added token from the list, use the <quote>unignore</quote> command. 2728 - The <quote>unignore</quote> command will make Mutt display headers with the given pattern. 2729 - For example, if you do <quote>ignore x-</quote> it is possible to <quote>unignore x-mailer</quote>. 2821 + To remove a previously added token from the list, use the 2822 + <quote>unignore</quote> command. The <quote>unignore</quote> command 2823 + will make Mutt display headers with the given pattern. For example, if 2824 + you do <quote>ignore x-</quote> it is possible to <quote>unignore 2825 + x-mailer</quote>. 2730 2826 </para> 2731 2827 2732 2828 <para> ··· 2772 2868 </cmdsynopsis> 2773 2869 2774 2870 <para> 2775 - With the <command>hdr_order</command> command you can specify an order in 2776 - which Mutt will attempt to present these headers to you when viewing messages. 2871 + With the <command>hdr_order</command> command you can specify an order 2872 + in which Mutt will attempt to present these headers to you when viewing 2873 + messages. 2777 2874 </para> 2778 2875 2779 2876 <para> 2780 - <quote><command>unhdr_order</command> *</quote> will clear all previous headers from the order list, 2781 - thus removing the header order effects set by the system-wide startup file. 2877 + <quote><command>unhdr_order</command> *</quote> will clear all previous 2878 + headers from the order list, thus removing the header order effects set 2879 + by the system-wide startup file. 2782 2880 </para> 2783 2881 2784 2882 <example id="ex-hdr-order"> ··· 2825 2923 </cmdsynopsis> 2826 2924 2827 2925 <para> 2828 - With various functions, Mutt will treat messages differently, 2829 - depending on whether you sent them or whether you received them from 2830 - someone else. For instance, when replying to a message that you 2831 - sent to a different party, Mutt will automatically suggest to send 2832 - the response to the original message's recipients &mdash; responding to 2833 - yourself won't make much sense in many cases. (See <link linkend="reply-to">$reply_to</link>.) 2926 + With various functions, Mutt will treat messages differently, depending 2927 + on whether you sent them or whether you received them from someone else. 2928 + For instance, when replying to a message that you sent to a different 2929 + party, Mutt will automatically suggest to send the response to the 2930 + original message's recipients &mdash; responding to yourself won't make 2931 + much sense in many cases. (See <link 2932 + linkend="reply-to">$reply_to</link>.) 2834 2933 </para> 2835 2934 2836 2935 <para> 2837 2936 Many users receive e-mail under a number of different addresses. To 2838 - fully use Mutt's features here, the program must be able to 2839 - recognize what e-mail addresses you receive mail under. That's the 2840 - purpose of the <command>alternates</command> command: It takes a list of regular 2937 + fully use Mutt's features here, the program must be able to recognize 2938 + what e-mail addresses you receive mail under. That's the purpose of the 2939 + <command>alternates</command> command: It takes a list of regular 2841 2940 expressions, each of which can identify an address under which you 2842 2941 receive e-mail. 2843 2942 </para> ··· 2853 2952 </screen> 2854 2953 2855 2954 <para> 2856 - Mutt will consider <quote><literal>some-user@example</literal></quote> as 2857 - being your address, too which may not be desired. As a solution, in such 2858 - cases addresses should be specified as: 2955 + Mutt will consider <quote><literal>some-user@example</literal></quote> 2956 + as being your address, too which may not be desired. As a solution, in 2957 + such cases addresses should be specified as: 2859 2958 </para> 2860 2959 2861 2960 <screen> ··· 2863 2962 </screen> 2864 2963 2865 2964 <para> 2866 - The <literal>-group</literal> flag causes all of the subsequent regular expressions 2867 - to be added to the named group. 2965 + The <literal>-group</literal> flag causes all of the subsequent regular 2966 + expressions to be added to the named group. 2868 2967 </para> 2869 2968 2870 2969 <para> 2871 - The <command>unalternates</command> command can be used to write exceptions to 2872 - <command>alternates</command> patterns. If an address matches something in an 2873 - <command>alternates</command> command, but you nonetheless do not think it is 2874 - from you, you can list a more precise pattern under an <command>unalternates</command> 2875 - command. 2970 + The <command>unalternates</command> command can be used to write 2971 + exceptions to <command>alternates</command> patterns. If an address 2972 + matches something in an <command>alternates</command> command, but you 2973 + nonetheless do not think it is from you, you can list a more precise 2974 + pattern under an <command>unalternates</command> command. 2876 2975 </para> 2877 2976 2878 2977 <para> 2879 - To remove a regular expression from the <command>alternates</command> list, use the 2880 - <command>unalternates</command> command with exactly the same <emphasis>regexp</emphasis>. 2881 - Likewise, if the <emphasis>regexp</emphasis> for an <command>alternates</command> command matches 2882 - an entry on the <command>unalternates</command> list, that <command>unalternates</command> 2883 - entry will be removed. If the <emphasis>regexp</emphasis> for <command>unalternates</command> 2884 - is <quote>*</quote>, <emphasis>all entries</emphasis> on <command>alternates</command> will be removed. 2978 + To remove a regular expression from the <command>alternates</command> 2979 + list, use the <command>unalternates</command> command with exactly the 2980 + same <emphasis>regexp</emphasis>. Likewise, if the 2981 + <emphasis>regexp</emphasis> for an <command>alternates</command> command 2982 + matches an entry on the <command>unalternates</command> list, that 2983 + <command>unalternates</command> entry will be removed. If the 2984 + <emphasis>regexp</emphasis> for <command>unalternates</command> is 2985 + <quote>*</quote>, <emphasis>all entries</emphasis> on 2986 + <command>alternates</command> will be removed. 2885 2987 </para> 2886 2988 2887 2989 </sect1> ··· 2947 3049 </cmdsynopsis> 2948 3050 2949 3051 <para> 2950 - Mutt has a few nice features for <link linkend="using-lists">handling mailing lists</link>. In order to take advantage of them, you must 2951 - specify which addresses belong to mailing lists, and which mailing 2952 - lists you are subscribed to. Mutt also has limited support for 2953 - auto-detecting mailing lists: it supports parsing 2954 - <literal>mailto:</literal> links in the common 2955 - <literal>List-Post:</literal> header which has the same effect as 2956 - specifying the list address via the <command>lists</command> command 2957 - (except the group feature). Once you have done this, the 2958 - <link linkend="list-reply"><literal>&lt;list-reply&gt;</literal></link> 2959 - function will work for all known lists. 2960 - Additionally, when you send a message to a subscribed list, Mutt will 2961 - add a Mail-Followup-To header to tell other users' mail user agents 2962 - not to send copies of replies to your personal address. 3052 + Mutt has a few nice features for <link linkend="using-lists">handling 3053 + mailing lists</link>. In order to take advantage of them, you must 3054 + specify which addresses belong to mailing lists, and which mailing lists 3055 + you are subscribed to. Mutt also has limited support for auto-detecting 3056 + mailing lists: it supports parsing <literal>mailto:</literal> links in 3057 + the common <literal>List-Post:</literal> header which has the same 3058 + effect as specifying the list address via the <command>lists</command> 3059 + command (except the group feature). Once you have done this, the <link 3060 + linkend="list-reply"><literal>&lt;list-reply&gt;</literal></link> 3061 + function will work for all known lists. Additionally, when you send a 3062 + message to a subscribed list, Mutt will add a Mail-Followup-To header to 3063 + tell other users' mail user agents not to send copies of replies to your 3064 + personal address. 2963 3065 </para> 2964 3066 2965 3067 <note> 2966 3068 <para> 2967 3069 The Mail-Followup-To header is a non-standard extension which is not 2968 - supported by all mail user agents. Adding it is not bullet-proof against 2969 - receiving personal CCs of list messages. Also note that the generation 2970 - of the Mail-Followup-To header is controlled by the 2971 - <link linkend="followup-to">$followup_to</link> 2972 - configuration variable since it's common practice on some mailing lists 2973 - to send Cc upons replies (which is more a group- than a list-reply). 3070 + supported by all mail user agents. Adding it is not bullet-proof 3071 + against receiving personal CCs of list messages. Also note that the 3072 + generation of the Mail-Followup-To header is controlled by the <link 3073 + linkend="followup-to">$followup_to</link> configuration variable since 3074 + it's common practice on some mailing lists to send Cc upons replies 3075 + (which is more a group- than a list-reply). 2974 3076 </para> 2975 3077 </note> 2976 3078 2977 3079 <para> 2978 - More precisely, Mutt maintains lists of patterns for the addresses 2979 - of known and subscribed mailing lists. Every subscribed mailing 2980 - list is known. To mark a mailing list as known, use the <command>list</command> 3080 + More precisely, Mutt maintains lists of patterns for the addresses of 3081 + known and subscribed mailing lists. Every subscribed mailing list is 3082 + known. To mark a mailing list as known, use the <command>list</command> 2981 3083 command. To mark it as subscribed, use <command>subscribe</command>. 2982 3084 </para> 2983 3085 2984 3086 <para> 2985 - You can use regular expressions with both commands. To mark all 2986 - messages sent to a specific bug report's address on Debian's bug 2987 - tracking system as list mail, for instance, you could say 3087 + You can use regular expressions with both commands. To mark all messages 3088 + sent to a specific bug report's address on Debian's bug tracking system 3089 + as list mail, for instance, you could say 2988 3090 </para> 2989 3091 2990 3092 <screen> 2991 3093 subscribe [0-9]*.*@bugs.debian.org</screen> 2992 3094 2993 3095 <para> 2994 - as it's often, it's sufficient to just give a portion of the list's e-mail address. 3096 + as it's often, it's sufficient to just give a portion of the list's 3097 + e-mail address. 2995 3098 </para> 2996 3099 2997 3100 <para> 2998 3101 Specify as much of the address as you need to to remove ambiguity. For 2999 - example, if you've subscribed to the Mutt mailing list, you will receive mail 3000 - addressed to <literal>mutt-users@mutt.org</literal>. So, to tell Mutt 3001 - that this is a mailing list, you could add <literal>lists mutt-users@</literal> to your 3002 - initialization file. To tell Mutt that you are subscribed to it, 3003 - add <literal><command>subscribe</command> mutt-users</literal> to your initialization file instead. 3004 - If you also happen to get mail from someone whose address is 3102 + example, if you've subscribed to the Mutt mailing list, you will receive 3103 + mail addressed to <literal>mutt-users@mutt.org</literal>. So, to tell 3104 + Mutt that this is a mailing list, you could add <literal>lists 3105 + mutt-users@</literal> to your initialization file. To tell Mutt that 3106 + you are subscribed to it, add <literal><command>subscribe</command> 3107 + mutt-users</literal> to your initialization file instead. If you also 3108 + happen to get mail from someone whose address is 3005 3109 <literal>mutt-users@example.com</literal>, you could use 3006 - <literal><command>lists</command> ^mutt-users@mutt\\.org$</literal> 3007 - or <literal><command>subscribe</command> ^mutt-users@mutt\\.org$</literal> to 3008 - match only mail from the actual list. 3110 + <literal><command>lists</command> ^mutt-users@mutt\\.org$</literal> or 3111 + <literal><command>subscribe</command> ^mutt-users@mutt\\.org$</literal> 3112 + to match only mail from the actual list. 3009 3113 </para> 3010 3114 3011 3115 <para> 3012 - The <literal>-group</literal> flag adds all of the subsequent regular expressions 3013 - to the named group. 3116 + The <literal>-group</literal> flag adds all of the subsequent regular 3117 + expressions to the named group. 3014 3118 </para> 3015 3119 3016 3120 <para> 3017 - The <quote>unlists</quote> command is used to remove a token from the list of 3018 - known and subscribed mailing-lists. Use <quote>unlists *</quote> to remove all 3019 - tokens. 3121 + The <quote>unlists</quote> command is used to remove a token from the 3122 + list of known and subscribed mailing-lists. Use <quote>unlists *</quote> 3123 + to remove all tokens. 3020 3124 </para> 3021 3125 3022 3126 <para> 3023 - To remove a mailing list from the list of subscribed mailing lists, 3024 - but keep it on the list of known mailing lists, use <command>unsubscribe</command>. 3127 + To remove a mailing list from the list of subscribed mailing lists, but 3128 + keep it on the list of known mailing lists, use 3129 + <command>unsubscribe</command>. 3025 3130 </para> 3026 3131 3027 3132 </sect1> ··· 3044 3149 <para> 3045 3150 This command is used to move read messages from a specified mailbox to a 3046 3151 different mailbox automatically when you quit or change folders. 3047 - <emphasis>pattern</emphasis> is a regular expression specifying the mailbox to treat as a 3048 - <quote>spool</quote> mailbox and <emphasis>mailbox</emphasis> specifies where mail should be saved when 3152 + <emphasis>pattern</emphasis> is a regular expression specifying the 3153 + mailbox to treat as a <quote>spool</quote> mailbox and 3154 + <emphasis>mailbox</emphasis> specifies where mail should be saved when 3049 3155 read. 3050 3156 </para> 3051 3157 3052 3158 <para> 3053 - Unlike some of the other <emphasis>hook</emphasis> commands, only the <emphasis>first</emphasis> matching 3054 - pattern is used (it is not possible to save read mail in more than a single 3055 - mailbox). 3159 + Unlike some of the other <emphasis>hook</emphasis> commands, only the 3160 + <emphasis>first</emphasis> matching pattern is used (it is not possible 3161 + to save read mail in more than a single mailbox). 3056 3162 </para> 3057 3163 3058 3164 </sect1> ··· 3083 3189 </cmdsynopsis> 3084 3190 3085 3191 <para> 3086 - This command specifies folders which can receive mail and 3087 - which will be checked for new messages periodically. 3192 + This command specifies folders which can receive mail and which will be 3193 + checked for new messages periodically. 3088 3194 </para> 3089 3195 3090 3196 <para> 3091 3197 <emphasis>folder</emphasis> can either be a local file or directory 3092 3198 (Mbox/Mmdf or Maildir/Mh). If Mutt was built with POP and/or IMAP 3093 3199 support, <emphasis>folder</emphasis> can also be a POP/IMAP folder 3094 - URL. The URL syntax is described in <xref linkend="url-syntax"/>, 3095 - POP and IMAP are described in <xref linkend="pop"/> and <xref linkend="imap"/> 3096 - respectively. 3200 + URL. The URL syntax is described in <xref linkend="url-syntax"/>, POP 3201 + and IMAP are described in <xref linkend="pop"/> and <xref 3202 + linkend="imap"/> respectively. 3097 3203 </para> 3098 3204 3099 3205 <para> 3100 3206 Mutt provides a number of advanced features for handling (possibly many) 3101 - folders and new mail within them, please refer to 3102 - <xref linkend="new-mail"/> for details (including in what 3103 - situations and how often Mutt checks for new mail). 3207 + folders and new mail within them, please refer to <xref 3208 + linkend="new-mail"/> for details (including in what situations and how 3209 + often Mutt checks for new mail). 3104 3210 </para> 3105 3211 3106 3212 <para> 3107 - The <quote>unmailboxes</quote> command is used to remove a token from the list 3108 - of folders which receive mail. Use <quote>unmailboxes *</quote> to remove all 3109 - tokens. 3213 + The <quote>unmailboxes</quote> command is used to remove a token from 3214 + the list of folders which receive mail. Use <quote>unmailboxes *</quote> 3215 + to remove all tokens. 3110 3216 </para> 3111 3217 3112 3218 <note> 3113 3219 <para> 3114 - The folders in the <command>mailboxes</command> command are resolved when 3115 - the command is executed, so if these names contain <link linkend="shortcuts">shortcut characters</link> (such as <quote>=</quote> and <quote>!</quote>), any variable 3116 - definition that affects these characters (like <link linkend="folder">$folder</link> and <link linkend="spoolfile">$spoolfile</link>) 3117 - should be set before the <command>mailboxes</command> command. If 3118 - none of these shorcuts are used, a local path should be absolute as 3119 - otherwise Mutt tries to find it relative to the directory 3120 - from where Mutt was started which may not always be desired. 3220 + The folders in the <command>mailboxes</command> command are resolved 3221 + when the command is executed, so if these names contain <link 3222 + linkend="shortcuts">shortcut characters</link> (such as <quote>=</quote> 3223 + and <quote>!</quote>), any variable definition that affects these 3224 + characters (like <link linkend="folder">$folder</link> and <link 3225 + linkend="spoolfile">$spoolfile</link>) should be set before the 3226 + <command>mailboxes</command> command. If none of these shorcuts are 3227 + used, a local path should be absolute as otherwise Mutt tries to find it 3228 + relative to the directory from where Mutt was started which may not 3229 + always be desired. 3121 3230 </para> 3122 3231 </note> 3123 3232 ··· 3146 3255 </cmdsynopsis> 3147 3256 3148 3257 <para> 3149 - The <command>my_hdr</command> command allows you to create your own header 3150 - fields which will be added to every message you send and appear in the 3151 - editor if <link linkend="edit-headers">$edit_headers</link> is set. 3258 + The <command>my_hdr</command> command allows you to create your own 3259 + header fields which will be added to every message you send and appear 3260 + in the editor if <link linkend="edit-headers">$edit_headers</link> is 3261 + set. 3152 3262 </para> 3153 3263 3154 3264 <para> 3155 - For example, if you would like to add an <quote>Organization:</quote> header field to 3156 - all of your outgoing messages, you can put the command something like 3157 - shown in <xref linkend="ex-my-hdr"/> in your <literal>.muttrc</literal>. 3265 + For example, if you would like to add an <quote>Organization:</quote> 3266 + header field to all of your outgoing messages, you can put the command 3267 + something like shown in <xref linkend="ex-my-hdr"/> in your 3268 + <literal>.muttrc</literal>. 3158 3269 </para> 3159 3270 3160 3271 <example id="ex-my-hdr"> ··· 3166 3277 3167 3278 <note> 3168 3279 <para> 3169 - Space characters are <emphasis>not</emphasis> allowed between the keyword and 3170 - the colon (<quote>:</quote>). The standard for electronic mail (RFC2822) says that 3171 - space is illegal there, so Mutt enforces the rule. 3280 + Space characters are <emphasis>not</emphasis> allowed between the 3281 + keyword and the colon (<quote>:</quote>). The standard for electronic 3282 + mail (RFC2822) says that space is illegal there, so Mutt enforces the 3283 + rule. 3172 3284 </para> 3173 3285 </note> 3174 3286 3175 3287 <para> 3176 3288 If you would like to add a header field to a single message, you should 3177 - either set the <link linkend="edit-headers">$edit_headers</link> variable, 3178 - or use the <literal>&lt;edit-headers&gt;</literal> function (default: <quote>E</quote>) in the compose menu so 3179 - that you can edit the header of your message along with the body. 3289 + either set the <link linkend="edit-headers">$edit_headers</link> 3290 + variable, or use the <literal>&lt;edit-headers&gt;</literal> function 3291 + (default: <quote>E</quote>) in the compose menu so that you can edit the 3292 + header of your message along with the body. 3180 3293 </para> 3181 3294 3182 3295 <para> 3183 - To remove user defined header fields, use the <command>unmy_hdr</command> 3184 - command. You may specify an asterisk (<quote>*</quote>) to remove all header 3185 - fields, or the fields to remove. For example, to remove all <quote>To</quote> and 3296 + To remove user defined header fields, use the 3297 + <command>unmy_hdr</command> command. You may specify an asterisk 3298 + (<quote>*</quote>) to remove all header fields, or the fields to 3299 + remove. For example, to remove all <quote>To</quote> and 3186 3300 <quote>Cc</quote> header fields, you could use: 3187 3301 </para> 3188 3302 ··· 3209 3323 3210 3324 <para> 3211 3325 This command is used to override the default mailbox used when saving 3212 - messages. <emphasis>mailbox</emphasis> will be used as the default if the message 3213 - matches <emphasis>pattern</emphasis>, see <xref linkend="pattern-hook"/> for information 3214 - on the exact format. 3326 + messages. <emphasis>mailbox</emphasis> will be used as the default if 3327 + the message matches <emphasis>pattern</emphasis>, see <xref 3328 + linkend="pattern-hook"/> for information on the exact format. 3215 3329 </para> 3216 3330 3217 3331 <para> 3218 - To provide more flexibility and good defaults, Mutt applies the 3219 - expandos of <link linkend="index-format">$index_format</link> to 3332 + To provide more flexibility and good defaults, Mutt applies the expandos 3333 + of <link linkend="index-format">$index_format</link> to 3220 3334 <emphasis>mailbox</emphasis> after it was expanded. 3221 3335 </para> 3222 3336 ··· 3235 3349 </example> 3236 3350 3237 3351 <para> 3238 - Also see the <link linkend="fcc-save-hook"><command>fcc-save-hook</command></link> command. 3352 + Also see the <link 3353 + linkend="fcc-save-hook"><command>fcc-save-hook</command></link> command. 3239 3354 </para> 3240 3355 3241 3356 </sect1> ··· 3256 3371 </cmdsynopsis> 3257 3372 3258 3373 <para> 3259 - This command is used to save outgoing mail in a mailbox other than 3260 - <link linkend="record">$record</link>. Mutt searches the initial list of 3261 - message recipients for the first matching <emphasis>regexp</emphasis> and uses <emphasis>mailbox</emphasis> 3262 - as the default Fcc: mailbox. If no match is found the message will be saved 3263 - to <link linkend="record">$record</link> mailbox. 3374 + This command is used to save outgoing mail in a mailbox other than <link 3375 + linkend="record">$record</link>. Mutt searches the initial list of 3376 + message recipients for the first matching <emphasis>regexp</emphasis> 3377 + and uses <emphasis>mailbox</emphasis> as the default Fcc: mailbox. If 3378 + no match is found the message will be saved to <link 3379 + linkend="record">$record</link> mailbox. 3264 3380 </para> 3265 3381 3266 3382 <para> ··· 3270 3386 </para> 3271 3387 3272 3388 <para> 3273 - See <xref linkend="pattern-hook"/> for information on the exact format of <emphasis>pattern</emphasis>. 3389 + See <xref linkend="pattern-hook"/> for information on the exact format 3390 + of <emphasis>pattern</emphasis>. 3274 3391 </para> 3275 3392 3276 3393 <screen>fcc-hook [@.]aol\\.com$ +spammers</screen> 3277 3394 3278 3395 <para> 3279 - ...will save a copy of all messages going to the aol.com domain to 3280 - the `+spammers' mailbox by default. Also see the <link linkend="fcc-save-hook"><command>fcc-save-hook</command></link> command. 3396 + ...will save a copy of all messages going to the aol.com domain to the 3397 + `+spammers' mailbox by default. Also see the <link 3398 + linkend="fcc-save-hook"><command>fcc-save-hook</command></link> command. 3281 3399 </para> 3282 3400 3283 3401 </sect1> ··· 3298 3416 </cmdsynopsis> 3299 3417 3300 3418 <para> 3301 - This command is a shortcut, equivalent to doing both a <link linkend="fcc-hook"><command>fcc-hook</command></link> 3302 - and a <link linkend="save-hook"><command>save-hook</command></link> with its arguments, 3303 - including %-expansion on <emphasis>mailbox</emphasis> according 3304 - to <link linkend="index-format">$index_format</link>. 3419 + This command is a shortcut, equivalent to doing both a <link 3420 + linkend="fcc-hook"><command>fcc-hook</command></link> and a <link 3421 + linkend="save-hook"><command>save-hook</command></link> with its 3422 + arguments, including %-expansion on <emphasis>mailbox</emphasis> 3423 + according to <link linkend="index-format">$index_format</link>. 3305 3424 </para> 3306 3425 3307 3426 </sect1> ··· 3341 3460 </cmdsynopsis> 3342 3461 3343 3462 <para> 3344 - These commands can be used to execute arbitrary configuration commands based 3345 - upon recipients of the message. <emphasis>pattern</emphasis> is used to match 3346 - the message, see <xref linkend="pattern-hook"/> for details. <emphasis>command</emphasis> 3347 - is executed when <emphasis>pattern</emphasis> matches. 3463 + These commands can be used to execute arbitrary configuration commands 3464 + based upon recipients of the message. <emphasis>pattern</emphasis> is 3465 + used to match the message, see <xref linkend="pattern-hook"/> for 3466 + details. <emphasis>command</emphasis> is executed when 3467 + <emphasis>pattern</emphasis> matches. 3348 3468 </para> 3349 3469 3350 3470 <para> 3351 - <command>reply-hook</command> is matched against the message you are <emphasis>replying to</emphasis>, 3352 - instead of the message you are <emphasis>sending</emphasis>. <command>send-hook</command> is 3353 - matched against all messages, both <emphasis>new</emphasis> 3354 - and <emphasis>replies</emphasis>. 3471 + <command>reply-hook</command> is matched against the message you are 3472 + <emphasis>replying to</emphasis>, instead of the message you are 3473 + <emphasis>sending</emphasis>. <command>send-hook</command> is matched 3474 + against all messages, both <emphasis>new</emphasis> and 3475 + <emphasis>replies</emphasis>. 3355 3476 </para> 3356 3477 3357 3478 <note> 3358 3479 <para> 3359 - <command>reply-hook</command>s are matched <emphasis>before</emphasis> the <command>send-hook</command>, <emphasis>regardless</emphasis> 3360 - of the order specified in the user's configuration file. 3480 + <command>reply-hook</command>s are matched <emphasis>before</emphasis> 3481 + the <command>send-hook</command>, <emphasis>regardless</emphasis> of the 3482 + order specified in the user's configuration file. 3361 3483 </para> 3362 3484 </note> 3363 3485 3364 3486 <para> 3365 - <command>send2-hook</command> is matched every time a message is changed, either 3366 - by editing it, or by using the compose menu to change its recipients 3367 - or subject. <command>send2-hook</command> is executed after <command>send-hook</command>, and 3368 - can, e.g., be used to set parameters such as the <link linkend="sendmail">$sendmail</link> variable depending on the message's sender 3369 - address. 3487 + <command>send2-hook</command> is matched every time a message is 3488 + changed, either by editing it, or by using the compose menu to change 3489 + its recipients or subject. <command>send2-hook</command> is executed 3490 + after <command>send-hook</command>, and can, e.g., be used to set 3491 + parameters such as the <link linkend="sendmail">$sendmail</link> 3492 + variable depending on the message's sender address. 3370 3493 </para> 3371 3494 3372 3495 <para> 3373 - For each type of <command>send-hook</command> or <command>reply-hook</command>, when multiple matches 3374 - occur, commands are executed in the order they are specified in the <literal>.muttrc</literal> 3375 - (for that type of hook). 3496 + For each type of <command>send-hook</command> or 3497 + <command>reply-hook</command>, when multiple matches occur, commands are 3498 + executed in the order they are specified in the 3499 + <literal>.muttrc</literal> (for that type of hook). 3376 3500 </para> 3377 3501 3378 3502 <para> 3379 - Example: <literal><command>send-hook</command> mutt "<command>set</command> mime_forward signature=''"</literal> 3503 + Example: <literal><command>send-hook</command> mutt 3504 + "<command>set</command> mime_forward signature=''"</literal> 3380 3505 </para> 3381 3506 3382 3507 <para> 3383 3508 Another typical use for this command is to change the values of the 3384 - <link linkend="attribution">$attribution</link>, <link linkend="signature">$signature</link> and <link linkend="locale">$locale</link> 3385 - variables in order to change the language of the attributions and 3386 - signatures based upon the recipients. 3509 + <link linkend="attribution">$attribution</link>, <link 3510 + linkend="signature">$signature</link> and <link 3511 + linkend="locale">$locale</link> variables in order to change the 3512 + language of the attributions and signatures based upon the recipients. 3387 3513 </para> 3388 3514 3389 3515 <note> 3390 3516 <para> 3391 3517 <command>send-hook</command>'s are only executed once after getting the 3392 3518 initial list of recipients. Adding a recipient after replying or 3393 - editing the message will not cause any <command>send-hook</command> to be executed, 3394 - similarily if <link linkend="autoedit">$autoedit</link> is set 3395 - (as then the initial list of recipients is empty). Also note that <link 3396 - linkend="my-hdr"><command>my_hdr</command></link> commands which 3519 + editing the message will not cause any <command>send-hook</command> to 3520 + be executed, similarily if <link linkend="autoedit">$autoedit</link> is 3521 + set (as then the initial list of recipients is empty). Also note that 3522 + <link linkend="my-hdr"><command>my_hdr</command></link> commands which 3397 3523 modify recipient headers, or the message's subject, don't have any 3398 3524 effect on the current message when executed from a 3399 3525 <command>send-hook</command>. ··· 3419 3545 3420 3546 <para> 3421 3547 This command can be used to execute arbitrary configuration commands 3422 - before viewing or formatting a message based upon information about the message. 3423 - <emphasis>command</emphasis> is executed if the <emphasis>pattern</emphasis> matches the message to be 3424 - displayed. When multiple matches occur, commands are executed in the order 3425 - they are specified in the <literal>.muttrc</literal>. 3548 + before viewing or formatting a message based upon information about the 3549 + message. <emphasis>command</emphasis> is executed if the 3550 + <emphasis>pattern</emphasis> matches the message to be displayed. When 3551 + multiple matches occur, commands are executed in the order they are 3552 + specified in the <literal>.muttrc</literal>. 3426 3553 </para> 3427 3554 3428 3555 <para> 3429 - See <xref linkend="pattern-hook"/> for 3430 - information on the exact format of <emphasis>pattern</emphasis>. 3556 + See <xref linkend="pattern-hook"/> for information on the exact format 3557 + of <emphasis>pattern</emphasis>. 3431 3558 </para> 3432 3559 3433 3560 <para> ··· 3457 3584 </cmdsynopsis> 3458 3585 3459 3586 <para> 3460 - When encrypting messages with PGP/GnuPG or OpenSSL, you may want to associate a certain 3461 - key with a given e-mail address automatically, either because the 3462 - recipient's public key can't be deduced from the destination address, 3463 - or because, for some reasons, you need to override the key Mutt would 3464 - normally use. The <command>crypt-hook</command> command provides a 3465 - method by which you can specify the ID of the public key to be used 3466 - when encrypting messages to a certain recipient. 3587 + When encrypting messages with PGP/GnuPG or OpenSSL, you may want to 3588 + associate a certain key with a given e-mail address automatically, 3589 + either because the recipient's public key can't be deduced from the 3590 + destination address, or because, for some reasons, you need to override 3591 + the key Mutt would normally use. The <command>crypt-hook</command> 3592 + command provides a method by which you can specify the ID of the public 3593 + key to be used when encrypting messages to a certain recipient. 3467 3594 </para> 3468 3595 3469 3596 <para> 3470 - The meaning of <emphasis>keyid</emphasis> is to be taken broadly in this context: You 3471 - can either put a numerical key ID here, an e-mail address, or even 3472 - just a real name. 3597 + The meaning of <emphasis>keyid</emphasis> is to be taken broadly in this 3598 + context: You can either put a numerical key ID here, an e-mail address, 3599 + or even just a real name. 3473 3600 </para> 3474 3601 3475 3602 </sect1> ··· 3487 3614 </cmdsynopsis> 3488 3615 3489 3616 <para> 3490 - This command adds the named string to the keyboard buffer. The string may 3491 - contain control characters, key names and function names like the sequence 3492 - string in the <link linkend="macro">macro</link> command. You may use it to 3493 - automatically run a sequence of commands at startup, or when entering 3494 - certain folders. For example, <xref linkend="ex-folder-hook-push"/> 3495 - shows how to automatically collapse all threads when entering a folder. 3617 + This command adds the named string to the keyboard buffer. The string 3618 + may contain control characters, key names and function names like the 3619 + sequence string in the <link linkend="macro">macro</link> command. You 3620 + may use it to automatically run a sequence of commands at startup, or 3621 + when entering certain folders. For example, <xref 3622 + linkend="ex-folder-hook-push"/> shows how to automatically collapse all 3623 + threads when entering a folder. 3496 3624 </para> 3497 3625 3498 3626 <example id="ex-folder-hook-push"> ··· 3520 3648 </cmdsynopsis> 3521 3649 3522 3650 <para> 3523 - This command can be used to execute any function. Functions are 3524 - listed in the <link linkend="functions">function reference</link>. 3525 - <quote><command>exec</command><literal>function</literal></quote> is equivalent to 3526 - <quote><literal>push &lt;function&gt;</literal></quote>. 3651 + This command can be used to execute any function. Functions are listed 3652 + in the <link linkend="functions">function reference</link>. 3653 + <quote><command>exec</command><literal>function</literal></quote> is 3654 + equivalent to <quote><literal>push &lt;function&gt;</literal></quote>. 3527 3655 </para> 3528 3656 3529 3657 </sect1> ··· 3554 3682 </cmdsynopsis> 3555 3683 3556 3684 <para> 3557 - The <command>score</command> commands adds <emphasis>value</emphasis> to a message's score if <emphasis>pattern</emphasis> 3558 - matches it. <emphasis>pattern</emphasis> is a string in the format described in the <link linkend="patterns">patterns</link> section (note: For efficiency reasons, patterns 3559 - which scan information not available in the index, such as <literal>#b</literal>, 3560 - <literal>#B</literal> or <literal>#h</literal>, may not be used). <emphasis>value</emphasis> is a 3561 - positive or negative integer. A message's final score is the sum total of all 3562 - matching <command>score</command> entries. However, you may optionally prefix <emphasis>value</emphasis> with 3563 - an equal sign (<quote>=</quote>) to cause evaluation to stop at a particular entry if there is 3564 - a match. Negative final scores are rounded up to 0. 3685 + The <command>score</command> commands adds <emphasis>value</emphasis> to 3686 + a message's score if <emphasis>pattern</emphasis> matches it. 3687 + <emphasis>pattern</emphasis> is a string in the format described in the 3688 + <link linkend="patterns">patterns</link> section (note: For efficiency 3689 + reasons, patterns which scan information not available in the index, 3690 + such as <literal>~b</literal>, <literal>~B</literal> or 3691 + <literal>~h</literal>, may not be used). <emphasis>value</emphasis> is 3692 + a positive or negative integer. A message's final score is the sum 3693 + total of all matching <command>score</command> entries. However, you 3694 + may optionally prefix <emphasis>value</emphasis> with an equal sign 3695 + (<quote>=</quote>) to cause evaluation to stop at a particular entry if 3696 + there is a match. Negative final scores are rounded up to 0. 3565 3697 </para> 3566 3698 3567 3699 <para> 3568 - The <command>unscore</command> command removes score entries from the list. You <emphasis>must</emphasis> 3569 - specify the same pattern specified in the <command>score</command> command for it to be 3570 - removed. The pattern <quote>*</quote> is a special token which means to clear the list 3571 - of all score entries. 3700 + The <command>unscore</command> command removes score entries from the 3701 + list. You <emphasis>must</emphasis> specify the same pattern specified 3702 + in the <command>score</command> command for it to be removed. The 3703 + pattern <quote>*</quote> is a special token which means to clear the 3704 + list of all score entries. 3572 3705 </para> 3573 3706 3574 3707 </sect1> ··· 3599 3732 </cmdsynopsis> 3600 3733 3601 3734 <para> 3602 - Mutt has generalized support for external spam-scoring filters. 3603 - By defining your spam patterns with the <command>spam</command> and <literal>nospam</literal> 3604 - commands, you can <emphasis>limit</emphasis>, <emphasis>search</emphasis>, and <emphasis>sort</emphasis> your 3605 - mail based on its spam attributes, as determined by the external 3606 - filter. You also can display the spam attributes in your index 3607 - display using the <literal>%H</literal> selector in the <link linkend="index-format">$index_format</link> variable. (Tip: try <literal>%?H?[%H] ?</literal> 3608 - to display spam tags only when they are defined for a given message.) 3735 + Mutt has generalized support for external spam-scoring filters. By 3736 + defining your spam patterns with the <command>spam</command> and 3737 + <literal>nospam</literal> commands, you can <emphasis>limit</emphasis>, 3738 + <emphasis>search</emphasis>, and <emphasis>sort</emphasis> your mail 3739 + based on its spam attributes, as determined by the external filter. You 3740 + also can display the spam attributes in your index display using the 3741 + <literal>%H</literal> selector in the <link 3742 + linkend="index-format">$index_format</link> variable. (Tip: try 3743 + <literal>%?H?[%H] ?</literal> to display spam tags only when they are 3744 + defined for a given message.) 3609 3745 </para> 3610 3746 3611 3747 <para> 3612 3748 Your first step is to define your external filter's spam patterns using 3613 - the <command>spam</command> command. <emphasis>pattern</emphasis> should be a regular expression 3614 - that matches a header in a mail message. If any message in the mailbox 3615 - matches this regular expression, it will receive a <quote>spam tag</quote> or 3616 - <quote>spam attribute</quote> (unless it also matches a <command>nospam</command> pattern &mdash; see 3617 - below.) The appearance of this attribute is entirely up to you, and is 3618 - governed by the <emphasis>format</emphasis> parameter. <emphasis>format</emphasis> can be any static 3619 - text, but it also can include back-references from the <emphasis>pattern</emphasis> 3620 - expression. (A regular expression <quote>back-reference</quote> refers to a 3621 - sub-expression contained within parentheses.) <literal>%1</literal> is replaced with 3622 - the first back-reference in the regex, <literal>%2</literal> with the second, etc. 3749 + the <command>spam</command> command. <emphasis>pattern</emphasis> should 3750 + be a regular expression that matches a header in a mail message. If any 3751 + message in the mailbox matches this regular expression, it will receive 3752 + a <quote>spam tag</quote> or <quote>spam attribute</quote> (unless it 3753 + also matches a <command>nospam</command> pattern &mdash; see below.) The 3754 + appearance of this attribute is entirely up to you, and is governed by 3755 + the <emphasis>format</emphasis> parameter. <emphasis>format</emphasis> 3756 + can be any static text, but it also can include back-references from the 3757 + <emphasis>pattern</emphasis> expression. (A regular expression 3758 + <quote>back-reference</quote> refers to a sub-expression contained 3759 + within parentheses.) <literal>%1</literal> is replaced with the first 3760 + back-reference in the regex, <literal>%2</literal> with the second, etc. 3623 3761 </para> 3624 3762 3625 3763 <para> 3626 3764 To match spam tags, mutt needs the corresponding header information 3627 3765 which is always the case for local and POP folders but not for IMAP in 3628 3766 the default configuration. Depending on the spam header to be analyzed, 3629 - <link linkend="imap-headers">$imap_headers</link> may need 3630 - to be adjusted. 3767 + <link linkend="imap-headers">$imap_headers</link> may need to be 3768 + adjusted. 3631 3769 </para> 3632 3770 3633 3771 <para> 3634 - If you're using multiple spam filters, a message can have more than 3635 - one spam-related header. You can define <command>spam</command> patterns for each 3636 - filter you use. If a message matches two or more of these patterns, and 3637 - the <link linkend="spam-separator">$spam_separator</link> variable is set to a string, then the 3638 - message's spam tag will consist of all the <emphasis>format</emphasis> strings joined 3639 - together, with the value of <link linkend="spam-separator">$spam_separator</link> separating 3640 - them. 3772 + If you're using multiple spam filters, a message can have more than one 3773 + spam-related header. You can define <command>spam</command> patterns for 3774 + each filter you use. If a message matches two or more of these patterns, 3775 + and the <link linkend="spam-separator">$spam_separator</link> variable 3776 + is set to a string, then the message's spam tag will consist of all the 3777 + <emphasis>format</emphasis> strings joined together, with the value of 3778 + <link linkend="spam-separator">$spam_separator</link> separating them. 3641 3779 </para> 3642 3780 3643 3781 <para> ··· 3656 3794 </example> 3657 3795 3658 3796 <para> 3659 - If then a message is received that DCC registered with <quote>many</quote> hits 3660 - under the <quote>Fuz2</quote> checksum, and that PureMessage registered with a 3661 - 97% probability of being spam, that message's spam tag would read 3662 - <literal>90+/DCC-Fuz2, 97/PM</literal>. (The four characters before <quote>=many</quote> in a 3663 - DCC report indicate the checksum used &mdash; in this case, <quote>Fuz2</quote>.) 3797 + If then a message is received that DCC registered with 3798 + <quote>many</quote> hits under the <quote>Fuz2</quote> checksum, and 3799 + that PureMessage registered with a 97% probability of being spam, that 3800 + message's spam tag would read <literal>90+/DCC-Fuz2, 3801 + 97/PM</literal>. (The four characters before <quote>=many</quote> in a 3802 + DCC report indicate the checksum used &mdash; in this case, 3803 + <quote>Fuz2</quote>.) 3664 3804 </para> 3665 3805 3666 3806 <para> 3667 - If the <link linkend="spam-separator">$spam_separator</link> variable is unset, then each 3668 - spam pattern match supersedes the previous one. Instead of getting 3669 - joined <emphasis>format</emphasis> strings, you'll get only the last one to match. 3807 + If the <link linkend="spam-separator">$spam_separator</link> variable is 3808 + unset, then each spam pattern match supersedes the previous one. Instead 3809 + of getting joined <emphasis>format</emphasis> strings, you'll get only 3810 + the last one to match. 3670 3811 </para> 3671 3812 3672 3813 <para> 3673 3814 The spam tag is what will be displayed in the index when you use 3674 - <literal>%H</literal> in the <link linkend="index-format">$index_format</link> variable. It's also the 3675 - string that the <literal>#H</literal> pattern-matching expression matches against for 3676 - <literal>&lt;search&gt;</literal> and <literal>&lt;limit&gt;</literal> functions. And it's what sorting by spam 3677 - attribute will use as a sort key. 3815 + <literal>%H</literal> in the <link 3816 + linkend="index-format">$index_format</link> variable. It's also the 3817 + string that the <literal>~H</literal> pattern-matching expression 3818 + matches against for <literal>&lt;search&gt;</literal> and 3819 + <literal>&lt;limit&gt;</literal> functions. And it's what sorting by 3820 + spam attribute will use as a sort key. 3678 3821 </para> 3679 3822 3680 3823 <para> ··· 3685 3828 </para> 3686 3829 3687 3830 <para> 3688 - Generally, when you sort by spam tag, Mutt will sort <emphasis>lexically</emphasis> &mdash; 3689 - that is, by ordering strings alphanumerically. However, if a spam tag 3690 - begins with a number, Mutt will sort numerically first, and lexically 3691 - only when two numbers are equal in value. (This is like UNIX's 3692 - <literal>sort -n</literal>.) A message with no spam attributes at all &mdash; that is, one 3693 - that didn't match <emphasis>any</emphasis> of your <command>spam</command> patterns &mdash; is sorted at 3694 - lowest priority. Numbers are sorted next, beginning with 0 and ranging 3695 - upward. Finally, non-numeric strings are sorted, with <quote>a</quote> taking lower 3696 - priority than <quote>z</quote>. Clearly, in general, sorting by spam tags is most 3697 - effective when you can coerce your filter to give you a raw number. But 3698 - in case you can't, Mutt can still do something useful. 3831 + Generally, when you sort by spam tag, Mutt will sort 3832 + <emphasis>lexically</emphasis> &mdash; that is, by ordering strings 3833 + alphanumerically. However, if a spam tag begins with a number, Mutt will 3834 + sort numerically first, and lexically only when two numbers are equal in 3835 + value. (This is like UNIX's <literal>sort -n</literal>.) A message with 3836 + no spam attributes at all &mdash; that is, one that didn't match 3837 + <emphasis>any</emphasis> of your <command>spam</command> patterns 3838 + &mdash; is sorted at lowest priority. Numbers are sorted next, beginning 3839 + with 0 and ranging upward. Finally, non-numeric strings are sorted, with 3840 + <quote>a</quote> taking lower priority than <quote>z</quote>. Clearly, 3841 + in general, sorting by spam tags is most effective when you can coerce 3842 + your filter to give you a raw number. But in case you can't, Mutt can 3843 + still do something useful. 3699 3844 </para> 3700 3845 3701 3846 <para> 3702 - The <command>nospam</command> command can be used to write exceptions to <command>spam</command> 3703 - patterns. If a header pattern matches something in a <command>spam</command> command, 3704 - but you nonetheless do not want it to receive a spam tag, you can list a 3705 - more precise pattern under a <command>nospam</command> command. 3847 + The <command>nospam</command> command can be used to write exceptions to 3848 + <command>spam</command> patterns. If a header pattern matches something 3849 + in a <command>spam</command> command, but you nonetheless do not want it 3850 + to receive a spam tag, you can list a more precise pattern under a 3851 + <command>nospam</command> command. 3706 3852 </para> 3707 3853 3708 3854 <para> 3709 - If the <emphasis>pattern</emphasis> given to <command>nospam</command> is exactly the same as the 3710 - <emphasis>pattern</emphasis> on an existing <command>spam</command> list entry, the effect will be to 3711 - remove the entry from the spam list, instead of adding an exception. 3712 - Likewise, if the <emphasis>pattern</emphasis> for a <command>spam</command> command matches an entry 3713 - on the <command>nospam</command> list, that nospam entry will be removed. If the 3714 - <emphasis>pattern</emphasis> for <command>nospam</command> is <quote>*</quote>, <emphasis>all entries on both lists</emphasis> 3715 - will be removed. This might be the default action if you use <command>spam</command> 3716 - and <command>nospam</command> in conjunction with a <command>folder-hook</command>. 3855 + If the <emphasis>pattern</emphasis> given to <command>nospam</command> 3856 + is exactly the same as the <emphasis>pattern</emphasis> on an existing 3857 + <command>spam</command> list entry, the effect will be to remove the 3858 + entry from the spam list, instead of adding an exception. Likewise, if 3859 + the <emphasis>pattern</emphasis> for a <command>spam</command> command 3860 + matches an entry on the <command>nospam</command> list, that nospam 3861 + entry will be removed. If the <emphasis>pattern</emphasis> for 3862 + <command>nospam</command> is <quote>*</quote>, <emphasis>all entries on 3863 + both lists</emphasis> will be removed. This might be the default action 3864 + if you use <command>spam</command> and <command>nospam</command> in 3865 + conjunction with a <command>folder-hook</command>. 3717 3866 </para> 3718 3867 3719 3868 <para> 3720 - You can have as many <command>spam</command> or <command>nospam</command> commands as you like. 3721 - You can even do your own primitive <command>spam</command> detection within Mutt &mdash; for 3722 - example, if you consider all mail from <literal>MAILER-DAEMON</literal> to be spam, 3723 - you can use a <command>spam</command> command like this: 3869 + You can have as many <command>spam</command> or 3870 + <command>nospam</command> commands as you like. You can even do your 3871 + own primitive <command>spam</command> detection within Mutt &mdash; for 3872 + example, if you consider all mail from <literal>MAILER-DAEMON</literal> 3873 + to be spam, you can use a <command>spam</command> command like this: 3724 3874 </para> 3725 3875 3726 3876 <screen> ··· 3770 3920 <para> 3771 3921 A specialized string for representing paths including support for 3772 3922 mailbox shortcuts (see <xref linkend="shortcuts"/>) as well as tilde 3773 - (<quote>#</quote>) for a user's home directory and more. 3923 + (<quote>~</quote>) for a user's home directory and more. 3774 3924 </para> 3775 3925 </listitem> 3776 3926 </varlistentry> ··· 3806 3956 <listitem> 3807 3957 <para> 3808 3958 Specifies the type of folder to use: <emphasis>mbox</emphasis>, 3809 - <emphasis>mmdf</emphasis>, <emphasis>mh</emphasis> 3810 - or <emphasis>maildir</emphasis>. 3811 - Currently only used to determine the type for newly created folders. 3959 + <emphasis>mmdf</emphasis>, <emphasis>mh</emphasis> or 3960 + <emphasis>maildir</emphasis>. Currently only used to determine the type 3961 + for newly created folders. 3812 3962 </para> 3813 3963 </listitem> 3814 3964 </varlistentry> ··· 3816 3966 <term>e-mail address</term> 3817 3967 <listitem> 3818 3968 <para> 3819 - An e-mail address either with or without 3820 - realname. The older <quote><literal>user@example.org (Joe User)</literal></quote> 3821 - form is supported but strongly deprecated. 3969 + An e-mail address either with or without realname. The older 3970 + <quote><literal>user@example.org (Joe User)</literal></quote> form is 3971 + supported but strongly deprecated. 3822 3972 </para> 3823 3973 </listitem> 3824 3974 </varlistentry> ··· 3885 4035 </cmdsynopsis> 3886 4036 3887 4037 <para> 3888 - This command is used to set (and unset) <link linkend="variables">configuration variables</link>. There are four basic types of variables: 3889 - boolean, number, string and quadoption. <emphasis>boolean</emphasis> variables can be 3890 - <emphasis>set</emphasis> (true) or <emphasis>unset</emphasis> (false). <emphasis>number</emphasis> variables can be 3891 - assigned a positive integer value. 3892 - <emphasis>string</emphasis> variables consist of any number of printable characters and 3893 - must be enclosed in quotes if they contain spaces or tabs. You 3894 - may also use the escape sequences <quote>\n</quote> and <quote>\t</quote> for newline and tab, respectively. 3895 - <emphasis>quadoption</emphasis> variables are used to control whether or not to be prompted 3896 - for certain actions, or to specify a default action. A value of <emphasis>yes</emphasis> 3897 - will cause the action to be carried out automatically as if you had answered 3898 - yes to the question. Similarly, a value of <emphasis>no</emphasis> will cause the 3899 - action to be carried out as if you had answered <quote>no.</quote> A value of 3900 - <emphasis>ask-yes</emphasis> will cause a prompt with a default answer of <quote>yes</quote> and 3901 - <emphasis>ask-no</emphasis> will provide a default answer of <quote>no.</quote> 4038 + This command is used to set (and unset) <link 4039 + linkend="variables">configuration variables</link>. There are four 4040 + basic types of variables: boolean, number, string and quadoption. 4041 + <emphasis>boolean</emphasis> variables can be <emphasis>set</emphasis> 4042 + (true) or <emphasis>unset</emphasis> (false). 4043 + <emphasis>number</emphasis> variables can be assigned a positive integer 4044 + value. <emphasis>string</emphasis> variables consist of any number of 4045 + printable characters and must be enclosed in quotes if they contain 4046 + spaces or tabs. You may also use the escape sequences <quote>\n</quote> 4047 + and <quote>\t</quote> for newline and tab, respectively. 4048 + <emphasis>quadoption</emphasis> variables are used to control whether or 4049 + not to be prompted for certain actions, or to specify a default action. 4050 + A value of <emphasis>yes</emphasis> will cause the action to be carried 4051 + out automatically as if you had answered yes to the question. 4052 + Similarly, a value of <emphasis>no</emphasis> will cause the action to 4053 + be carried out as if you had answered <quote>no.</quote> A value of 4054 + <emphasis>ask-yes</emphasis> will cause a prompt with a default answer 4055 + of <quote>yes</quote> and <emphasis>ask-no</emphasis> will provide a 4056 + default answer of <quote>no.</quote> 3902 4057 </para> 3903 4058 3904 4059 <para> 3905 - Prefixing a variable with <quote>no</quote> will unset it. Example: <literal><command>set</command> noaskbcc</literal>. 4060 + Prefixing a variable with <quote>no</quote> will unset it. Example: 4061 + <literal><command>set</command> noaskbcc</literal>. 3906 4062 </para> 3907 4063 3908 4064 <para> 3909 - For <emphasis>boolean</emphasis> variables, you may optionally prefix the variable name with 3910 - <literal>inv</literal> to toggle the value (on or off). This is useful when writing 3911 - macros. Example: <literal><command>set</command> invsmart_wrap</literal>. 4065 + For <emphasis>boolean</emphasis> variables, you may optionally prefix 4066 + the variable name with <literal>inv</literal> to toggle the value (on or 4067 + off). This is useful when writing macros. Example: 4068 + <literal><command>set</command> invsmart_wrap</literal>. 3912 4069 </para> 3913 4070 3914 4071 <para> 3915 - The <command>toggle</command> command automatically prepends the <literal>inv</literal> prefix to all 3916 - specified variables. 4072 + The <command>toggle</command> command automatically prepends the 4073 + <literal>inv</literal> prefix to all specified variables. 3917 4074 </para> 3918 4075 3919 4076 <para> 3920 - The <command>unset</command> command automatically prepends the <literal>no</literal> prefix to all 3921 - specified variables. 4077 + The <command>unset</command> command automatically prepends the 4078 + <literal>no</literal> prefix to all specified variables. 3922 4079 </para> 3923 4080 3924 4081 <para> 3925 - Using the <literal>&lt;enter-command&gt;</literal> function in the <emphasis>index</emphasis> menu, you can query the 3926 - value of a variable by prefixing the name of the variable with a question 3927 - mark: 4082 + Using the <literal>&lt;enter-command&gt;</literal> function in the 4083 + <emphasis>index</emphasis> menu, you can query the value of a variable 4084 + by prefixing the name of the variable with a question mark: 3928 4085 </para> 3929 4086 3930 4087 <screen> ··· 3937 4094 </para> 3938 4095 3939 4096 <para> 3940 - The <command>reset</command> command resets all given variables to the compile time 3941 - defaults (hopefully mentioned in this manual). If you use the command 3942 - <command>set</command> and prefix the variable with <quote>&amp;</quote> this has the same 3943 - behavior as the <command>reset</command> command. 4097 + The <command>reset</command> command resets all given variables to the 4098 + compile time defaults (hopefully mentioned in this manual). If you use 4099 + the command <command>set</command> and prefix the variable with 4100 + <quote>&amp;</quote> this has the same behavior as the 4101 + <command>reset</command> command. 3944 4102 </para> 3945 4103 3946 4104 <para> 3947 - With the <command>reset</command> command there exists the special variable <quote>all</quote>, 3948 - which allows you to reset all variables to their system defaults. 4105 + With the <command>reset</command> command there exists the special 4106 + variable <quote>all</quote>, which allows you to reset all variables to 4107 + their system defaults. 3949 4108 </para> 3950 4109 3951 4110 </sect2> ··· 3957 4116 <title>Introduction</title> 3958 4117 3959 4118 <para> 3960 - Along with the variables listed in the 3961 - <link linkend="variables">Configuration variables</link> section, Mutt 3962 - supports user-defined variables with names starting 3963 - with <literal>my_</literal> as in, for 3964 - example, <literal>my_cfgdir</literal>. 4119 + Along with the variables listed in the <link 4120 + linkend="variables">Configuration variables</link> section, Mutt 4121 + supports user-defined variables with names starting with 4122 + <literal>my_</literal> as in, for example, <literal>my_cfgdir</literal>. 3965 4123 </para> 3966 4124 3967 4125 <para> 3968 - The <command>set</command> command either creates a 3969 - custom <literal>my_</literal> variable or changes its 3970 - value if it does exist already. The <command>unset</command> and <command>reset</command> 4126 + The <command>set</command> command either creates a custom 4127 + <literal>my_</literal> variable or changes its value if it does exist 4128 + already. The <command>unset</command> and <command>reset</command> 3971 4129 commands remove the variable entirely. 3972 4130 </para> 3973 4131 3974 4132 <para> 3975 4133 Since user-defined variables are expanded in the same way that 3976 - environment variables are (except for 3977 - the <link linkend="shell-escape">shell-escape</link> command and 3978 - backtick expansion), this feature can be used to make configuration 3979 - files more readable. 4134 + environment variables are (except for the <link 4135 + linkend="shell-escape">shell-escape</link> command and backtick 4136 + expansion), this feature can be used to make configuration files more 4137 + readable. 3980 4138 </para> 3981 4139 3982 4140 </sect3> ··· 3985 4143 <title>Examples</title> 3986 4144 3987 4145 <para> 3988 - The following example defines and uses the variable <literal>my_cfgdir</literal> 3989 - to abbreviate the calls of the <link linkend="source"><command>source</command></link> command: 4146 + The following example defines and uses the variable 4147 + <literal>my_cfgdir</literal> to abbreviate the calls of the <link 4148 + linkend="source"><command>source</command></link> command: 3990 4149 </para> 3991 4150 3992 4151 <example id="ex-myvar1"> ··· 4002 4161 4003 4162 <para> 4004 4163 A custom variable can also be used in macros to backup the current value 4005 - of another variable. In the following example, the value of the 4006 - <link linkend="delete">$delete</link> is changed temporarily 4007 - while its original value is saved as <literal>my_delete</literal>. 4008 - After the macro has executed all commands, the original value of <link 4164 + of another variable. In the following example, the value of the <link 4165 + linkend="delete">$delete</link> is changed temporarily while its 4166 + original value is saved as <literal>my_delete</literal>. After the 4167 + macro has executed all commands, the original value of <link 4009 4168 linkend="delete">$delete</link> is restored. 4010 4169 </para> 4011 4170 ··· 4044 4203 </example> 4045 4204 4046 4205 <para> 4047 - Note that there is a space 4048 - between <literal>&lt;enter-command&gt;</literal> and 4049 - the <command>set</command> configuration command, preventing Mutt from 4050 - recording the <command>macro</command>'s commands into its history. 4206 + Note that there is a space between 4207 + <literal>&lt;enter-command&gt;</literal> and the <command>set</command> 4208 + configuration command, preventing Mutt from recording the 4209 + <command>macro</command>'s commands into its history. 4051 4210 </para> 4052 4211 4053 4212 </sect3> ··· 4061 4220 Variables are always assigned string values which Mutt parses into its 4062 4221 internal representation according to the type of the variable, for 4063 4222 example an integer number for numeric types. For all queries (including 4064 - $-expansion) the value is converted from its internal type back 4065 - into string. As a result, any variable can be assigned any value given 4066 - that its content is valid for the target. This also counts for custom 4223 + $-expansion) the value is converted from its internal type back into 4224 + string. As a result, any variable can be assigned any value given that 4225 + its content is valid for the target. This also counts for custom 4067 4226 variables which are of type string. In case of parsing errors, Mutt will 4068 4227 print error messages. <xref linkend="ex-myvar4"/> demonstrates type 4069 4228 conversions. ··· 4114 4273 mailboxes $my_mx +mailbox3</screen> 4115 4274 4116 4275 <para> 4117 - because the value of <literal>$my_mx</literal> is 4118 - interpreted as a single mailbox named <quote>+mailbox1 +mailbox2</quote> 4119 - and not two distinct mailboxes. 4276 + because the value of <literal>$my_mx</literal> is interpreted as a 4277 + single mailbox named <quote>+mailbox1 +mailbox2</quote> and not two 4278 + distinct mailboxes. 4120 4279 </para> 4121 4280 4122 4281 </sect2> ··· 4136 4295 </cmdsynopsis> 4137 4296 4138 4297 <para> 4139 - This command allows the inclusion of initialization commands 4140 - from other files. For example, I place all of my aliases in 4141 - <literal>#/.mail_aliases</literal> so that I can make my 4142 - <literal>#/.muttrc</literal> readable and keep my aliases private. 4298 + This command allows the inclusion of initialization commands from other 4299 + files. For example, I place all of my aliases in 4300 + <literal>~/.mail_aliases</literal> so that I can make my 4301 + <literal>~/.muttrc</literal> readable and keep my aliases private. 4143 4302 </para> 4144 4303 4145 4304 <para> 4146 - If the filename begins with a tilde (<quote>#</quote>), it will be expanded to the 4147 - path of your home directory. 4305 + If the filename begins with a tilde (<quote>~</quote>), it will be 4306 + expanded to the path of your home directory. 4148 4307 </para> 4149 4308 4150 4309 <para> 4151 - If the filename ends with a vertical bar (<quote>|</quote>), then <emphasis>filename</emphasis> is 4152 - considered to be an executable program from which to read input (eg. 4153 - <literal><command>source</command> #/bin/myscript|</literal>). 4310 + If the filename ends with a vertical bar (<quote>|</quote>), then 4311 + <emphasis>filename</emphasis> is considered to be an executable program 4312 + from which to read input (eg. <literal><command>source</command> 4313 + ~/bin/myscript|</literal>). 4154 4314 </para> 4155 4315 4156 4316 </sect1> ··· 4174 4334 4175 4335 <para> 4176 4336 This command permits you to flush hooks you have previously defined. 4177 - You can either remove all hooks by giving the <quote>*</quote> character as an 4178 - argument, or you can remove all hooks of a specific type by saying 4337 + You can either remove all hooks by giving the <quote>*</quote> character 4338 + as an argument, or you can remove all hooks of a specific type by saying 4179 4339 something like <literal><command>unhook</command> send-hook</literal>. 4180 4340 </para> 4181 4341 ··· 4189 4349 4190 4350 <para> 4191 4351 Format strings are a general concept you'll find in several locations 4192 - through the Mutt configuration, especially in the 4193 - <link linkend="index-format">$index_format</link>, 4194 - <link linkend="pager-format">$pager_format</link>, 4195 - <link linkend="status-format">$status_format</link>, 4196 - and other related variables. These can be very straightforward, 4197 - and it's quite possible you already know how to use them. 4352 + through the Mutt configuration, especially in the <link 4353 + linkend="index-format">$index_format</link>, <link 4354 + linkend="pager-format">$pager_format</link>, <link 4355 + linkend="status-format">$status_format</link>, and other related 4356 + variables. These can be very straightforward, and it's quite possible 4357 + you already know how to use them. 4198 4358 </para> 4199 4359 4200 4360 <para> 4201 - The most basic format string element is a percent symbol followed 4202 - by another character. For example, <literal>%s</literal> 4203 - represents a message's Subject: header in the <link 4361 + The most basic format string element is a percent symbol followed by 4362 + another character. For example, <literal>%s</literal> represents a 4363 + message's Subject: header in the <link 4204 4364 linkend="index-format">$index_format</link> variable. The 4205 - <quote>expandos</quote> available are documented with each format variable, but 4206 - there are general modifiers available with all formatting expandos, 4207 - too. Those are our concern here. 4365 + <quote>expandos</quote> available are documented with each format 4366 + variable, but there are general modifiers available with all formatting 4367 + expandos, too. Those are our concern here. 4208 4368 </para> 4209 4369 4210 4370 <para> 4211 - Some of the modifiers are borrowed right out of C (though you might 4212 - know them from Perl, Python, shell, or another language). These are 4213 - the <literal>[-]m.n</literal> modifiers, as in <literal>%-12.12s</literal>. As with 4214 - such programming languages, these modifiers allow you to specify the 4215 - minimum and maximum size of the resulting string, as well as its 4216 - justification. If the <quote>-</quote> sign follows the percent, the string will 4217 - be left-justified instead of right-justified. If there's a number 4218 - immediately following that, it's the minimum amount of space the 4219 - formatted string will occupy &mdash; if it's naturally smaller than that, it 4220 - will be padded out with spaces. If a decimal point and another number 4221 - follow, that's the maximum space allowable &mdash; the string will not be 4222 - permitted to exceed that width, no matter its natural size. Each of 4223 - these three elements is optional, so that all these are legal format 4224 - strings: <literal>%-12s</literal>, <literal>%4c</literal>, 4225 - <literal>%.15F</literal> and <literal>%-12.15L</literal>. 4371 + Some of the modifiers are borrowed right out of C (though you might know 4372 + them from Perl, Python, shell, or another language). These are the 4373 + <literal>[-]m.n</literal> modifiers, as in 4374 + <literal>%-12.12s</literal>. As with such programming languages, these 4375 + modifiers allow you to specify the minimum and maximum size of the 4376 + resulting string, as well as its justification. If the <quote>-</quote> 4377 + sign follows the percent, the string will be left-justified instead of 4378 + right-justified. If there's a number immediately following that, it's 4379 + the minimum amount of space the formatted string will occupy &mdash; if 4380 + it's naturally smaller than that, it will be padded out with spaces. If 4381 + a decimal point and another number follow, that's the maximum space 4382 + allowable &mdash; the string will not be permitted to exceed that width, 4383 + no matter its natural size. Each of these three elements is optional, so 4384 + that all these are legal format strings: <literal>%-12s</literal>, 4385 + <literal>%4c</literal>, <literal>%.15F</literal> and 4386 + <literal>%-12.15L</literal>. 4226 4387 </para> 4227 4388 4228 4389 <para> 4229 4390 Mutt adds some other modifiers to format strings. If you use an equals 4230 4391 symbol (<literal>=</literal>) as a numeric prefix (like the minus 4231 - above), it will force the string to be centered within its minimum 4232 - space range. For example, <literal>%=14y</literal> will reserve 14 4233 - characters for the %y expansion &mdash; that's the X-Label: header, in 4234 - <link linkend="index-format">$index_format</link>. If the expansion 4235 - results in a string less than 14 characters, it will be centered in a 4236 - 14-character space. If the X-Label for a message were <quote>test</quote>, that 4237 - expansion would look like <quote>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;test&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</quote>. 4392 + above), it will force the string to be centered within its minimum space 4393 + range. For example, <literal>%=14y</literal> will reserve 14 characters 4394 + for the %y expansion &mdash; that's the X-Label: header, in <link 4395 + linkend="index-format">$index_format</link>. If the expansion results in 4396 + a string less than 14 characters, it will be centered in a 14-character 4397 + space. If the X-Label for a message were <quote>test</quote>, that 4398 + expansion would look like 4399 + <quote>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;test&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</quote>. 4238 4400 </para> 4239 4401 4240 4402 <para> 4241 4403 There are two very little-known modifiers that affect the way that an 4242 - expando is replaced. If there is an underline (<quote>_</quote>) character 4243 - between any format modifiers (as above) and the expando letter, it will 4244 - expands in all lower case. And if you use a colon (<quote>:</quote>), it will 4245 - replace all decimal points with underlines. 4404 + expando is replaced. If there is an underline (<quote>_</quote>) 4405 + character between any format modifiers (as above) and the expando 4406 + letter, it will expands in all lower case. And if you use a colon 4407 + (<quote>:</quote>), it will replace all decimal points with underlines. 4246 4408 </para> 4247 4409 4248 4410 </sect2> ··· 4264 4426 4265 4427 <para> 4266 4428 where <emphasis>sequence_char</emphasis> is an expando, and 4267 - <emphasis>optional_string</emphasis> is the string you would like printed if 4268 - <emphasis>sequence_char</emphasis> is nonzero. 4269 - <emphasis>optional_string</emphasis> may contain other 4270 - sequences as well as normal text, but you may not nest optional 4271 - strings. 4429 + <emphasis>optional_string</emphasis> is the string you would like 4430 + printed if <emphasis>sequence_char</emphasis> is nonzero. 4431 + <emphasis>optional_string</emphasis> may contain other sequences as well 4432 + as normal text, but you may not nest optional strings. 4272 4433 </para> 4273 4434 4274 4435 <para> 4275 4436 Here is an example illustrating how to optionally print the number of 4276 - new messages in a mailbox in 4277 - <link linkend="status-format">$status_format</link>: 4437 + new messages in a mailbox in <link 4438 + linkend="status-format">$status_format</link>: 4278 4439 </para> 4279 4440 4280 4441 <screen> ··· 4288 4449 %?&lt;sequence_char&gt;?&lt;if_string&gt;&amp;&lt;else_string&gt;?</screen> 4289 4450 4290 4451 <para> 4291 - If the value of <emphasis>sequence_char</emphasis> is 4292 - non-zero, <emphasis>if_string</emphasis> will be expanded, 4293 - otherwise <emphasis>else_string</emphasis> will be expanded. 4452 + If the value of <emphasis>sequence_char</emphasis> is non-zero, 4453 + <emphasis>if_string</emphasis> will be expanded, otherwise 4454 + <emphasis>else_string</emphasis> will be expanded. 4294 4455 </para> 4295 4456 4296 4457 </sect2> ··· 4300 4461 4301 4462 <para> 4302 4463 Any format string ending in a vertical bar (<quote>|</quote>) will be 4303 - expanded and piped through the first word in the string, using spaces 4304 - as separator. The string returned will be used for display. 4305 - If the returned string ends in %, it will be passed through 4306 - the formatter a second time. This allows the filter to generate a 4307 - replacement format string including % expandos. 4464 + expanded and piped through the first word in the string, using spaces as 4465 + separator. The string returned will be used for display. If the 4466 + returned string ends in %, it will be passed through the formatter a 4467 + second time. This allows the filter to generate a replacement format 4468 + string including % expandos. 4308 4469 </para> 4309 4470 4310 4471 <para> 4311 - All % expandos in a format string are expanded before the script 4312 - is called so that: 4472 + All % expandos in a format string are expanded before the script is 4473 + called so that: 4313 4474 </para> 4314 4475 4315 4476 <example id="ex-fmtpipe"> ··· 4320 4481 </example> 4321 4482 4322 4483 <para> 4323 - will make Mutt expand <literal>%r</literal>, 4324 - <literal>%f</literal> and <literal>%L</literal> 4325 - before calling the script. The example also shows that arguments can be 4326 - quoted: the script will receive the expanded string between the single quotes 4327 - as the only argument. 4484 + will make Mutt expand <literal>%r</literal>, <literal>%f</literal> and 4485 + <literal>%L</literal> before calling the script. The example also shows 4486 + that arguments can be quoted: the script will receive the expanded 4487 + string between the single quotes as the only argument. 4328 4488 </para> 4329 4489 4330 4490 <para> 4331 - A practical example is the <literal>mutt_xtitle</literal> 4332 - script installed in the <literal>samples</literal> 4333 - subdirectory of the Mutt documentation: it can be used as filter for 4334 - <link linkend="status-format">$status_format</link> to set the current 4491 + A practical example is the <literal>mutt_xtitle</literal> script 4492 + installed in the <literal>samples</literal> subdirectory of the Mutt 4493 + documentation: it can be used as filter for <link 4494 + linkend="status-format">$status_format</link> to set the current 4335 4495 terminal's title, if supported. 4336 4496 </para> 4337 4497 ··· 4350 4510 <term><literal>%|X</literal></term> 4351 4511 <listitem> 4352 4512 <para> 4353 - When this occurs, Mutt will fill the rest of the 4354 - line with the character <literal>X</literal>. For 4355 - example, filling the rest of the line with dashes is 4356 - done by setting: 4513 + When this occurs, Mutt will fill the rest of the line with the character 4514 + <literal>X</literal>. For example, filling the rest of the line with 4515 + dashes is done by setting: 4357 4516 </para> 4358 4517 <screen> 4359 4518 set status_format = "%v on %h: %B: %?n?%n&amp;no? new messages %|-"</screen> ··· 4389 4548 showing padding only if there's still room. If necessary, soft-fill will 4390 4549 eat text leftwards to make room for rightward text. For example, to 4391 4550 right-justify the subject making sure as much as possible of it fits on 4392 - screen, one might use (note two spaces after <literal>%* 4393 - </literal>: the second ensures there's a space between the truncated 4394 - right-hand side and the subject): 4551 + screen, one might use (note two spaces after <literal>%* </literal>: the 4552 + second ensures there's a space between the truncated right-hand side and 4553 + the subject): 4395 4554 </para> 4396 4555 <screen> 4397 4556 set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&amp;%4c?)%* %s"</screen> ··· 4463 4622 <title>Regular Expressions</title> 4464 4623 4465 4624 <para> 4466 - All string patterns in Mutt including those in more complex 4467 - <link linkend="patterns">patterns</link> must be specified 4468 - using regular expressions (regexp) in the <quote>POSIX extended</quote> syntax (which 4625 + All string patterns in Mutt including those in more complex <link 4626 + linkend="patterns">patterns</link> must be specified using regular 4627 + expressions (regexp) in the <quote>POSIX extended</quote> syntax (which 4469 4628 is more or less the syntax used by egrep and GNU awk). For your 4470 4629 convenience, we have included below a brief description of this syntax. 4471 4630 </para> ··· 4477 4636 4478 4637 <note> 4479 4638 <para> 4480 - <quote>\</quote> 4481 - must be quoted if used for a regular expression in an initialization 4482 - command: <quote>\\</quote>. 4639 + <quote>\</quote> must be quoted if used for a regular expression in an 4640 + initialization command: <quote>\\</quote>. 4483 4641 </para> 4484 4642 </note> 4485 4643 ··· 4491 4649 4492 4650 <note> 4493 4651 <para> 4494 - The regular expression can be enclosed/delimited by either " 4495 - or ' which is useful if the regular expression includes a white-space 4496 - character. See <xref linkend="muttrc-syntax"/> 4497 - for more information on " and ' delimiter processing. To match a 4498 - literal " or ' you must preface it with \ (backslash). 4652 + The regular expression can be enclosed/delimited by either " or ' which 4653 + is useful if the regular expression includes a white-space character. 4654 + See <xref linkend="muttrc-syntax"/> for more information on " and ' 4655 + delimiter processing. To match a literal " or ' you must preface it 4656 + with \ (backslash). 4499 4657 </para> 4500 4658 </note> 4501 4659 4502 4660 <para> 4503 - The fundamental building blocks are the regular expressions that match 4504 - a single character. Most characters, including all letters and digits, 4661 + The fundamental building blocks are the regular expressions that match a 4662 + single character. Most characters, including all letters and digits, 4505 4663 are regular expressions that match themselves. Any metacharacter with 4506 4664 special meaning may be quoted by preceding it with a backslash. 4507 4665 </para> 4508 4666 4509 4667 <para> 4510 - The period <quote>.</quote> matches any single character. The caret <quote>^</quote> and 4511 - the dollar sign <quote>$</quote> are metacharacters that respectively match 4512 - the empty string at the beginning and end of a line. 4668 + The period <quote>.</quote> matches any single character. The caret 4669 + <quote>^</quote> and the dollar sign <quote>$</quote> are metacharacters 4670 + that respectively match the empty string at the beginning and end of a 4671 + line. 4513 4672 </para> 4514 4673 4515 4674 <para> 4516 - A list of characters enclosed by <quote>[</quote> and <quote>]</quote> matches any 4517 - single character in that list; if the first character of the list 4518 - is a caret <quote>^</quote> then it matches any character <emphasis>not</emphasis> in the 4519 - list. For example, the regular expression <emphasis>[0123456789]</emphasis> 4520 - matches any single digit. A range of ASCII characters may be specified 4521 - by giving the first and last characters, separated by a hyphen 4522 - <quote>-</quote>. Most metacharacters lose their special meaning inside 4523 - lists. To include a literal <quote>]</quote> place it first in the list. 4524 - Similarly, to include a literal <quote>^</quote> place it anywhere but first. 4675 + A list of characters enclosed by <quote>[</quote> and <quote>]</quote> 4676 + matches any single character in that list; if the first character of the 4677 + list is a caret <quote>^</quote> then it matches any character 4678 + <emphasis>not</emphasis> in the list. For example, the regular 4679 + expression <emphasis>[0123456789]</emphasis> matches any single digit. 4680 + A range of ASCII characters may be specified by giving the first and 4681 + last characters, separated by a hyphen <quote>-</quote>. Most 4682 + metacharacters lose their special meaning inside lists. To include a 4683 + literal <quote>]</quote> place it first in the list. Similarly, to 4684 + include a literal <quote>^</quote> place it anywhere but first. 4525 4685 Finally, to include a literal hyphen <quote>-</quote> place it last. 4526 4686 </para> 4527 4687 4528 4688 <para> 4529 4689 Certain named classes of characters are predefined. Character classes 4530 - consist of <quote>[:</quote>, a keyword denoting the class, and <quote>:]</quote>. 4531 - The following classes are defined by the POSIX standard in 4690 + consist of <quote>[:</quote>, a keyword denoting the class, and 4691 + <quote>:]</quote>. The following classes are defined by the POSIX 4692 + standard in 4532 4693 <xref linkend="posix-regex-char-classes"/> 4533 4694 </para> 4534 4695 ··· 4562 4723 4563 4724 <note> 4564 4725 <para> 4565 - Note that the brackets in these 4566 - class names are part of the symbolic names, and must be included 4567 - in addition to the brackets delimiting the bracket list. For 4568 - example, <emphasis>[[:digit:]]</emphasis> is equivalent to 4569 - <emphasis>[0-9]</emphasis>. 4726 + Note that the brackets in these class names are part of the symbolic 4727 + names, and must be included in addition to the brackets delimiting the 4728 + bracket list. For example, <emphasis>[[:digit:]]</emphasis> is 4729 + equivalent to <emphasis>[0-9]</emphasis>. 4570 4730 </para> 4571 4731 </note> 4572 4732 ··· 4585 4745 <listitem> 4586 4746 <para> 4587 4747 A collating symbol is a multi-character collating element enclosed in 4588 - <quote>[.</quote> and <quote>.]</quote>. For example, if <quote>ch</quote> is a collating 4589 - element, then <emphasis>[[.ch.]]</emphasis> is a regexp that matches 4590 - this collating element, while <emphasis>[ch]</emphasis> is a regexp that 4591 - matches either <quote>c</quote> or <quote>h</quote>. 4748 + <quote>[.</quote> and <quote>.]</quote>. For example, if 4749 + <quote>ch</quote> is a collating element, then 4750 + <emphasis>[[.ch.]]</emphasis> is a regexp that matches this collating 4751 + element, while <emphasis>[ch]</emphasis> is a regexp that matches either 4752 + <quote>c</quote> or <quote>h</quote>. 4592 4753 </para> 4593 4754 </listitem> 4594 4755 </varlistentry> ··· 4596 4757 <term>Equivalence Classes</term> 4597 4758 <listitem> 4598 4759 <para> 4599 - An equivalence class is a locale-specific name for a list of 4600 - characters that are equivalent. The name is enclosed in <quote>[=</quote> 4601 - and <quote>=]</quote>. For example, the name <quote>e</quote> might be used to 4602 - represent all of <quote>&egrave;</quote> <quote>&eacute;</quote> and <quote>e</quote>. In this case, 4603 - <emphasis>[[=e=]]</emphasis> is a regexp that matches any of 4604 - <quote>&egrave;</quote>, <quote>&eacute;</quote> and <quote>e</quote>. 4760 + An equivalence class is a locale-specific name for a list of characters 4761 + that are equivalent. The name is enclosed in <quote>[=</quote> and 4762 + <quote>=]</quote>. For example, the name <quote>e</quote> might be used 4763 + to represent all of <quote>&egrave;</quote> <quote>&eacute;</quote> and 4764 + <quote>e</quote>. In this case, <emphasis>[[=e=]]</emphasis> is a 4765 + regexp that matches any of <quote>&egrave;</quote>, 4766 + <quote>&eacute;</quote> and <quote>e</quote>. 4605 4767 </para> 4606 4768 </listitem> 4607 4769 </varlistentry> ··· 4609 4771 4610 4772 <para> 4611 4773 A regular expression matching a single character may be followed by one 4612 - of several repetition operators described in <xref linkend="regex-repeat"/>. 4774 + of several repetition operators described in <xref 4775 + linkend="regex-repeat"/>. 4613 4776 </para> 4614 4777 4615 4778 <table id="regex-repeat"> ··· 4637 4800 </para> 4638 4801 4639 4802 <para> 4640 - Two regular expressions may be joined by the infix operator <quote>|</quote>; 4641 - the resulting regular expression matches any string matching either 4642 - subexpression. 4803 + Two regular expressions may be joined by the infix operator 4804 + <quote>|</quote>; the resulting regular expression matches any string 4805 + matching either subexpression. 4643 4806 </para> 4644 4807 4645 4808 <para> ··· 4651 4814 <note> 4652 4815 <para> 4653 4816 If you compile Mutt with the included regular expression engine, the 4654 - following operators may also be used in regular expressions as described in <xref linkend="regex-gnu-ext"/>. 4817 + following operators may also be used in regular expressions as described 4818 + in <xref linkend="regex-gnu-ext"/>. 4655 4819 </para> 4656 4820 </note> 4657 4821 ··· 4757 4921 </table> 4758 4922 4759 4923 <para> 4760 - Where <emphasis>EXPR</emphasis> is a 4761 - <link linkend="regexp">regular expression</link>. 4924 + Where <emphasis>EXPR</emphasis> is a <link linkend="regexp">regular 4925 + expression</link>. 4762 4926 </para> 4763 4927 4764 4928 <para> 4765 - *) The forms <quote>&lt;[<emphasis>MAX</emphasis>]</quote>, <quote>&gt;[<emphasis>MIN</emphasis>]</quote>, 4766 - <quote>[<emphasis>MIN</emphasis>]-</quote> and <quote>-[<emphasis>MAX</emphasis>]</quote> 4767 - are allowed, too. 4929 + *) The forms <quote>&lt;[<emphasis>MAX</emphasis>]</quote>, 4930 + <quote>&gt;[<emphasis>MIN</emphasis>]</quote>, 4931 + <quote>[<emphasis>MIN</emphasis>]-</quote> and 4932 + <quote>-[<emphasis>MAX</emphasis>]</quote> are allowed, too. 4768 4933 </para> 4769 4934 4770 4935 <para> 4771 - **) The suffixes <quote>K</quote> and <quote>M</quote> are allowed to specify kilobyte and megabyte respectively. 4936 + **) The suffixes <quote>K</quote> and <quote>M</quote> are allowed to 4937 + specify kilobyte and megabyte respectively. 4772 4938 </para> 4773 4939 4774 4940 <para> 4775 - Special attention has to be 4776 - payed when using regular expressions inside of patterns. Specifically, 4777 - Mutt's parser for these patterns will strip one level of backslash (<quote>\</quote>), 4778 - which is normally used for quoting. If it is your intention to use a 4779 - backslash in the regular expression, you will need to use two backslashes 4780 - instead (<quote>\\</quote>). You can force Mutt to treat <emphasis>EXPR</emphasis> as a simple string 4781 - instead of a regular expression by using = instead of # in the 4782 - pattern name. For example, <literal>=b *.*</literal> will find all messages that contain 4783 - the literal string <quote>*.*</quote>. Simple string matches are less powerful than 4784 - regular expressions but can be considerably faster. This is especially 4785 - true for IMAP folders, because string matches can be performed on the 4786 - server instead of by fetching every message. IMAP treats <literal>=h</literal> specially: 4787 - it must be of the form <quote>header: substring</quote> and will not partially 4788 - match header names. The substring part may be omitted if you simply 4789 - wish to find messages containing a particular header without regard to 4790 - its value. 4941 + Special attention has to be payed when using regular expressions inside 4942 + of patterns. Specifically, Mutt's parser for these patterns will strip 4943 + one level of backslash (<quote>\</quote>), which is normally used for 4944 + quoting. If it is your intention to use a backslash in the regular 4945 + expression, you will need to use two backslashes instead 4946 + (<quote>\\</quote>). You can force Mutt to treat 4947 + <emphasis>EXPR</emphasis> as a simple string instead of a regular 4948 + expression by using = instead of ~ in the pattern name. For example, 4949 + <literal>=b *.*</literal> will find all messages that contain the 4950 + literal string <quote>*.*</quote>. Simple string matches are less 4951 + powerful than regular expressions but can be considerably faster. This 4952 + is especially true for IMAP folders, because string matches can be 4953 + performed on the server instead of by fetching every message. IMAP 4954 + treats <literal>=h</literal> specially: it must be of the form 4955 + <quote>header: substring</quote> and will not partially match header 4956 + names. The substring part may be omitted if you simply wish to find 4957 + messages containing a particular header without regard to its value. 4791 4958 </para> 4792 4959 4793 4960 <para> 4794 - Patterns matching lists of addresses (notably c, C, p, P and t) 4795 - match if there is at least one match in the whole list. If you want to 4796 - make sure that all elements of that list match, you need to prefix your 4797 - pattern with <quote>^</quote>. 4798 - This example matches all mails which only has recipients from Germany. 4961 + Patterns matching lists of addresses (notably c, C, p, P and t) match if 4962 + there is at least one match in the whole list. If you want to make sure 4963 + that all elements of that list match, you need to prefix your pattern 4964 + with <quote>^</quote>. This example matches all mails which only has 4965 + recipients from Germany. 4799 4966 </para> 4800 4967 4801 4968 <example id="ex-recips"> ··· 4811 4978 <title>Simple Searches</title> 4812 4979 4813 4980 <para> 4814 - Mutt supports two versions of so called <quote>simple searches</quote>. These are 4815 - issued if the query entered for searching, limiting and similar 4816 - operations does not seem to contain a valid pattern modifier (i.e. it does not contain 4817 - one of these characters: <quote>#</quote>, <quote>=</quote> or <quote>%</quote>). If the query is 4818 - supposed to contain one of these special characters, they must be escaped 4819 - by prepending a backslash (<quote>\</quote>). 4981 + Mutt supports two versions of so called <quote>simple 4982 + searches</quote>. These are issued if the query entered for searching, 4983 + limiting and similar operations does not seem to contain a valid pattern 4984 + modifier (i.e. it does not contain one of these characters: 4985 + <quote>~</quote>, <quote>=</quote> or <quote>%</quote>). If the query is 4986 + supposed to contain one of these special characters, they must be 4987 + escaped by prepending a backslash (<quote>\</quote>). 4820 4988 </para> 4821 4989 4822 4990 <para> ··· 4854 5022 </table> 4855 5023 4856 5024 <para> 4857 - The second type of simple search is to build a complex search 4858 - pattern using <link linkend="simple-search">$simple_search</link> 4859 - as a template. Mutt will insert your query properly quoted and search 4860 - for the composed complex query. 5025 + The second type of simple search is to build a complex search pattern 5026 + using <link linkend="simple-search">$simple_search</link> as a 5027 + template. Mutt will insert your query properly quoted and search for the 5028 + composed complex query. 4861 5029 </para> 4862 5030 4863 5031 </sect2> ··· 4875 5043 </screen> 4876 5044 4877 5045 <para> 4878 - would select messages which contain the word <quote>mutt</quote> in the list of 4879 - recipients <emphasis>and</emphasis> that have the word <quote>elkins</quote> in the <quote>From</quote> header 4880 - field. 5046 + would select messages which contain the word <quote>mutt</quote> in the 5047 + list of recipients <emphasis>and</emphasis> that have the word 5048 + <quote>elkins</quote> in the <quote>From</quote> header field. 4881 5049 </para> 4882 5050 4883 5051 <para> 4884 - Mutt also recognizes the following operators to create more complex search 4885 - patterns: 5052 + Mutt also recognizes the following operators to create more complex 5053 + search patterns: 4886 5054 </para> 4887 5055 4888 5056 <itemizedlist> ··· 4908 5076 </itemizedlist> 4909 5077 4910 5078 <para> 4911 - Here is an example illustrating a complex search pattern. This pattern will 4912 - select all messages which do not contain <quote>mutt</quote> in the <quote>To</quote> or <quote>Cc</quote> 4913 - field and which are from <quote>elkins</quote>. 5079 + Here is an example illustrating a complex search pattern. This pattern 5080 + will select all messages which do not contain <quote>mutt</quote> in the 5081 + <quote>To</quote> or <quote>Cc</quote> field and which are from 5082 + <quote>elkins</quote>. 4914 5083 </para> 4915 5084 4916 5085 <example id="ex-pattern-bool"> ··· 4921 5090 </example> 4922 5091 4923 5092 <para> 4924 - Here is an example using white space in the regular expression (note 4925 - the ' and " delimiters). For this to match, the mail's subject must 4926 - match the <quote>^Junk +From +Me$</quote> and it must be from either <quote>Jim +Somebody</quote> 4927 - or <quote>Ed +SomeoneElse</quote>: 5093 + Here is an example using white space in the regular expression (note the 5094 + ' and " delimiters). For this to match, the mail's subject must match 5095 + the <quote>^Junk +From +Me$</quote> and it must be from either 5096 + <quote>Jim +Somebody</quote> or <quote>Ed +SomeoneElse</quote>: 4928 5097 </para> 4929 5098 4930 5099 <screen> ··· 4933 5102 4934 5103 <note> 4935 5104 <para> 4936 - If a regular expression contains parenthesis, or a vertical bar 4937 - ("|"), you <emphasis>must</emphasis> enclose the expression in double or single quotes since 4938 - those characters are also used to separate different parts of Mutt's 4939 - pattern language. For example: <literal>~f "me@(mutt\.org|cs\.hmc\.edu)"</literal> 4940 - Without the quotes, the parenthesis wouldn't end. 4941 - This would be separated to two OR'd patterns: <emphasis>#f me@(mutt\.org</emphasis> 4942 - and <emphasis>cs\.hmc\.edu)</emphasis>. They are never what you want. 5105 + If a regular expression contains parenthesis, or a vertical bar ("|"), 5106 + you <emphasis>must</emphasis> enclose the expression in double or single 5107 + quotes since those characters are also used to separate different parts 5108 + of Mutt's pattern language. For example: <literal>~f 5109 + "me@(mutt\.org|cs\.hmc\.edu)"</literal> Without the quotes, the 5110 + parenthesis wouldn't end. This would be separated to two OR'd patterns: 5111 + <emphasis>~f me@(mutt\.org</emphasis> and 5112 + <emphasis>cs\.hmc\.edu)</emphasis>. They are never what you want. 4943 5113 </para> 4944 5114 </note> 4945 5115 ··· 4949 5119 <title>Searching by Date</title> 4950 5120 4951 5121 <para> 4952 - Mutt supports two types of dates, <emphasis>absolute</emphasis> and <emphasis>relative</emphasis>. 5122 + Mutt supports two types of dates, <emphasis>absolute</emphasis> and 5123 + <emphasis>relative</emphasis>. 4953 5124 </para> 4954 5125 4955 5126 <sect3 id="date-absolute"> 4956 5127 <title>Absolute Dates</title> 4957 5128 4958 5129 <para> 4959 - Dates <emphasis>must</emphasis> be in DD/MM/YY format (month and year are 4960 - optional, defaulting to the current month and year). An example of a valid 4961 - range of dates is: 5130 + Dates <emphasis>must</emphasis> be in DD/MM/YY format (month and year 5131 + are optional, defaulting to the current month and year). An example of 5132 + a valid range of dates is: 4962 5133 </para> 4963 5134 4964 5135 <screen> ··· 4966 5137 </screen> 4967 5138 4968 5139 <para> 4969 - If you omit the minimum (first) date, and just specify <quote>-DD/MM/YY</quote>, all 4970 - messages <emphasis>before</emphasis> the given date will be selected. If you omit the maximum 4971 - (second) date, and specify <quote>DD/MM/YY-</quote>, all messages <emphasis>after</emphasis> the given 4972 - date will be selected. If you specify a single date with no dash (<quote>-</quote>), 4973 - only messages sent on the given date will be selected. 5140 + If you omit the minimum (first) date, and just specify 5141 + <quote>-DD/MM/YY</quote>, all messages <emphasis>before</emphasis> the 5142 + given date will be selected. If you omit the maximum (second) date, and 5143 + specify <quote>DD/MM/YY-</quote>, all messages 5144 + <emphasis>after</emphasis> the given date will be selected. If you 5145 + specify a single date with no dash (<quote>-</quote>), only messages 5146 + sent on the given date will be selected. 4974 5147 </para> 4975 5148 4976 5149 <para> 4977 - You can add error margins to absolute dates. 4978 - An error margin is a sign (+ or -), followed by a digit, followed by 4979 - one of the units in <xref linkend="tab-date-units"/>. As a special case, you can replace the 4980 - sign by a <quote>*</quote> character, which is equivalent to giving identical plus and minus error margins. 5150 + You can add error margins to absolute dates. An error margin is a sign 5151 + (+ or -), followed by a digit, followed by one of the units in <xref 5152 + linkend="tab-date-units"/>. As a special case, you can replace the sign 5153 + by a <quote>*</quote> character, which is equivalent to giving identical 5154 + plus and minus error margins. 4981 5155 </para> 4982 5156 4983 5157 <table id="tab-date-units"> ··· 4996 5170 </table> 4997 5171 4998 5172 <para> 4999 - Example: To select any messages two weeks around January 15, 2001, 5000 - you'd use the following pattern: 5173 + Example: To select any messages two weeks around January 15, 2001, you'd 5174 + use the following pattern: 5001 5175 </para> 5002 5176 5003 5177 <screen> ··· 5010 5184 <title>Relative Dates</title> 5011 5185 5012 5186 <para> 5013 - This type of date is relative to the current date, and may 5014 - be specified as: 5187 + This type of date is relative to the current date, and may be specified 5188 + as: 5015 5189 </para> 5016 5190 5017 5191 <itemizedlist> 5018 5192 <listitem> 5019 5193 5020 5194 <para> 5021 - &gt;<emphasis>offset</emphasis> for messages older than <emphasis>offset</emphasis> units 5195 + &gt;<emphasis>offset</emphasis> for messages older than 5196 + <emphasis>offset</emphasis> units 5022 5197 </para> 5023 5198 </listitem> 5024 5199 <listitem> 5025 5200 5026 5201 <para> 5027 - &lt;<emphasis>offset</emphasis> for messages newer than <emphasis>offset</emphasis> units 5202 + &lt;<emphasis>offset</emphasis> for messages newer than 5203 + <emphasis>offset</emphasis> units 5028 5204 </para> 5029 5205 </listitem> 5030 5206 <listitem> 5031 5207 5032 5208 <para> 5033 - =<emphasis>offset</emphasis> for messages exactly <emphasis>offset</emphasis> units old 5209 + =<emphasis>offset</emphasis> for messages exactly 5210 + <emphasis>offset</emphasis> units old 5034 5211 </para> 5035 5212 </listitem> 5036 5213 5037 5214 </itemizedlist> 5038 5215 5039 5216 <para> 5040 - <emphasis>offset</emphasis> is specified as a positive number with one of the units from <xref linkend="tab-date-units"/>. 5217 + <emphasis>offset</emphasis> is specified as a positive number with one 5218 + of the units from <xref linkend="tab-date-units"/>. 5041 5219 </para> 5042 5220 5043 5221 <para> ··· 5051 5229 <note> 5052 5230 <para> 5053 5231 All dates used when searching are relative to the 5054 - <emphasis>local</emphasis> time zone, so unless you change the setting of your <link linkend="index-format">$index_format</link> to include a 5055 - <literal>%[...]</literal> format, these are <emphasis>not</emphasis> the dates shown 5056 - in the main index. 5232 + <emphasis>local</emphasis> time zone, so unless you change the setting 5233 + of your <link linkend="index-format">$index_format</link> to include a 5234 + <literal>%[...]</literal> format, these are <emphasis>not</emphasis> the 5235 + dates shown in the main index. 5057 5236 </para> 5058 5237 </note> 5059 5238 ··· 5067 5246 <title>Using Tags</title> 5068 5247 5069 5248 <para> 5070 - Sometimes it is desirable to perform an operation on a group of 5071 - messages all at once rather than one at a time. An example might be 5072 - to save messages to a mailing list to a separate folder, or to 5073 - delete all messages with a given subject. To tag all messages 5074 - matching a pattern, use the <literal>&lt;tag-pattern&gt;</literal> function, which is bound to 5075 - <quote>shift-T</quote> by default. Or you can select individual messages by 5076 - hand using the <literal>&lt;tag-message&gt;</literal> function, which is bound to <quote>t</quote> by 5077 - default. See <link linkend="patterns">patterns</link> for Mutt's pattern 5078 - matching syntax. 5249 + Sometimes it is desirable to perform an operation on a group of messages 5250 + all at once rather than one at a time. An example might be to save 5251 + messages to a mailing list to a separate folder, or to delete all 5252 + messages with a given subject. To tag all messages matching a pattern, 5253 + use the <literal>&lt;tag-pattern&gt;</literal> function, which is bound 5254 + to <quote>shift-T</quote> by default. Or you can select individual 5255 + messages by hand using the <literal>&lt;tag-message&gt;</literal> 5256 + function, which is bound to <quote>t</quote> by default. See <link 5257 + linkend="patterns">patterns</link> for Mutt's pattern matching syntax. 5079 5258 </para> 5080 5259 5081 5260 <para> 5082 5261 Once you have tagged the desired messages, you can use the 5083 - <quote>tag-prefix</quote> operator, which is the <quote>;</quote> (semicolon) key by default. 5084 - When the <quote>tag-prefix</quote> operator is used, the <emphasis>next</emphasis> operation will 5085 - be applied to all tagged messages if that operation can be used in that 5086 - manner. If the <link linkend="auto-tag">$auto_tag</link> 5087 - variable is set, the next operation applies to the tagged messages 5088 - automatically, without requiring the <quote>tag-prefix</quote>. 5262 + <quote>tag-prefix</quote> operator, which is the <quote>;</quote> 5263 + (semicolon) key by default. When the <quote>tag-prefix</quote> operator 5264 + is used, the <emphasis>next</emphasis> operation will be applied to all 5265 + tagged messages if that operation can be used in that manner. If the 5266 + <link linkend="auto-tag">$auto_tag</link> variable is set, the next 5267 + operation applies to the tagged messages automatically, without 5268 + requiring the <quote>tag-prefix</quote>. 5089 5269 </para> 5090 5270 5091 5271 <para> 5092 - In <link linkend="macro"><command>macro</command>s</link> or <link linkend="push"><command>push</command></link> commands, 5093 - you can use the <literal>&lt;tag-prefix-cond&gt;</literal> operator. If there are no tagged 5094 - messages, Mutt will <quote>eat</quote> the rest of the macro to abort it's execution. 5095 - Mutt will stop <quote>eating</quote> the macro when it encounters the <literal>&lt;end-cond&gt;</literal> 5096 - operator; after this operator the rest of the macro will be executed as 5097 - normal. 5272 + In <link linkend="macro"><command>macro</command>s</link> or <link 5273 + linkend="push"><command>push</command></link> commands, you can use the 5274 + <literal>&lt;tag-prefix-cond&gt;</literal> operator. If there are no 5275 + tagged messages, Mutt will <quote>eat</quote> the rest of the macro to 5276 + abort it's execution. Mutt will stop <quote>eating</quote> the macro 5277 + when it encounters the <literal>&lt;end-cond&gt;</literal> operator; 5278 + after this operator the rest of the macro will be executed as normal. 5098 5279 </para> 5099 5280 5100 5281 </sect1> ··· 5103 5284 <title>Using Hooks</title> 5104 5285 5105 5286 <para> 5106 - A <emphasis>hook</emphasis> is a concept found in many other programs which allows you to 5107 - execute arbitrary commands before performing some operation. For example, 5108 - you may wish to tailor your configuration based upon which mailbox you are 5109 - reading, or to whom you are sending mail. In the Mutt world, a <emphasis>hook</emphasis> 5110 - consists of a <link linkend="regexp">regular expression</link> or 5111 - <link linkend="patterns">pattern</link> along with a 5112 - configuration option/command. See: 5287 + A <emphasis>hook</emphasis> is a concept found in many other programs 5288 + which allows you to execute arbitrary commands before performing some 5289 + operation. For example, you may wish to tailor your configuration based 5290 + upon which mailbox you are reading, or to whom you are sending mail. In 5291 + the Mutt world, a <emphasis>hook</emphasis> consists of a <link 5292 + linkend="regexp">regular expression</link> or <link 5293 + linkend="patterns">pattern</link> along with a configuration 5294 + option/command. See: 5113 5295 5114 5296 <itemizedlist> 5115 5297 ··· 5198 5380 5199 5381 <note> 5200 5382 <para> 5201 - If a hook changes configuration settings, these changes remain 5202 - effective until the end of the current Mutt session. As this is generally 5203 - not desired, a <quote>default</quote> hook needs to be added before all 5204 - other hooks of that type to restore configuration defaults. 5383 + If a hook changes configuration settings, these changes remain effective 5384 + until the end of the current Mutt session. As this is generally not 5385 + desired, a <quote>default</quote> hook needs to be added before all 5386 + other hooks of that type to restore configuration defaults. 5205 5387 </para> 5206 5388 </note> 5207 5389 ··· 5214 5396 </example> 5215 5397 5216 5398 <para> 5217 - In <xref linkend="ex-default-hook"/>, by default the value of 5218 - <link linkend="from">$from</link> 5219 - and <link linkend="realname">$realname</link> 5220 - is not overridden. When sending messages either To: or Cc: 5221 - to <literal>&lt;b@b.b&gt;</literal>, the From: header is changed to 5222 - <literal>&lt;c@c.c&gt;</literal>. 5399 + In <xref linkend="ex-default-hook"/>, by default the value of <link 5400 + linkend="from">$from</link> and <link 5401 + linkend="realname">$realname</link> is not overridden. When sending 5402 + messages either To: or Cc: to <literal>&lt;b@b.b&gt;</literal>, the 5403 + From: header is changed to <literal>&lt;c@c.c&gt;</literal>. 5223 5404 </para> 5224 5405 5225 5406 <sect2 id="pattern-hook" xreflabel="Message Matching in Hooks"> 5226 5407 <title>Message Matching in Hooks</title> 5227 5408 5228 5409 <para> 5229 - Hooks that act upon messages (<command>message-hook</command>, <command>reply-hook</command>, 5230 - <command>send-hook</command>, <command>send2-hook</command>, <command>save-hook</command>, <command>fcc-hook</command>) are evaluated in a 5231 - slightly different manner. For the other 5232 - types of hooks, a <link linkend="regexp">regular expression</link> is 5233 - sufficient. But in dealing with messages a finer grain of control is 5234 - needed for matching since for different purposes you want to match 5235 - different criteria. 5410 + Hooks that act upon messages (<command>message-hook</command>, 5411 + <command>reply-hook</command>, <command>send-hook</command>, 5412 + <command>send2-hook</command>, <command>save-hook</command>, 5413 + <command>fcc-hook</command>) are evaluated in a slightly different 5414 + manner. For the other types of hooks, a <link linkend="regexp">regular 5415 + expression</link> is sufficient. But in dealing with messages a finer 5416 + grain of control is needed for matching since for different purposes you 5417 + want to match different criteria. 5236 5418 </para> 5237 5419 5238 5420 <para> 5239 - Mutt allows the use of the <link linkend="patterns">search pattern</link> 5240 - language for matching messages in hook commands. This works in 5241 - exactly the same way as it would when <emphasis>limiting</emphasis> or 5242 - <emphasis>searching</emphasis> the mailbox, except that you are restricted to those 5243 - operators which match information Mutt extracts from the header of 5244 - the message (i.e., from, to, cc, date, subject, etc.). 5421 + Mutt allows the use of the <link linkend="patterns">search 5422 + pattern</link> language for matching messages in hook commands. This 5423 + works in exactly the same way as it would when 5424 + <emphasis>limiting</emphasis> or <emphasis>searching</emphasis> the 5425 + mailbox, except that you are restricted to those operators which match 5426 + information Mutt extracts from the header of the message (i.e., from, 5427 + to, cc, date, subject, etc.). 5245 5428 </para> 5246 5429 5247 5430 <para> ··· 5259 5442 </para> 5260 5443 5261 5444 <para> 5262 - However, it is not required that you write the pattern to match using the 5263 - full searching language. You can still specify a simple <emphasis>regular 5264 - expression</emphasis> like the other hooks, in which case Mutt will translate your 5265 - pattern into the full language, using the translation specified by the 5266 - <link linkend="default-hook">$default_hook</link> variable. The 5267 - pattern is translated at the time the hook is declared, so the value of 5268 - <link linkend="default-hook">$default_hook</link> that is in effect 5269 - at that time will be used. 5445 + However, it is not required that you write the pattern to match using 5446 + the full searching language. You can still specify a simple 5447 + <emphasis>regular expression</emphasis> like the other hooks, in which 5448 + case Mutt will translate your pattern into the full language, using the 5449 + translation specified by the <link 5450 + linkend="default-hook">$default_hook</link> variable. The pattern is 5451 + translated at the time the hook is declared, so the value of <link 5452 + linkend="default-hook">$default_hook</link> that is in effect at that 5453 + time will be used. 5270 5454 </para> 5271 5455 5272 5456 </sect2> ··· 5279 5463 <para> 5280 5464 Mutt supports connecting to external directory databases such as LDAP, 5281 5465 ph/qi, bbdb, or NIS through a wrapper script which connects to Mutt 5282 - using a simple interface. Using the <link linkend="query-command">$query_command</link> variable, you specify the wrapper 5283 - command to use. For example: 5466 + using a simple interface. Using the <link 5467 + linkend="query-command">$query_command</link> variable, you specify the 5468 + wrapper command to use. For example: 5284 5469 </para> 5285 5470 5286 5471 <screen> ··· 5308 5493 5309 5494 <para> 5310 5495 There are two mechanisms for accessing the query function of Mutt. One 5311 - is to do a query from the index menu using the <literal>&lt;query&gt;</literal> function (default: Q). 5312 - This will prompt for a query, then bring up the query menu which will 5313 - list the matching responses. From the query menu, you can select 5314 - addresses to create aliases, or to mail. You can tag multiple addresses 5315 - to mail, start a new query, or have a new query appended to the current 5496 + is to do a query from the index menu using the 5497 + <literal>&lt;query&gt;</literal> function (default: Q). This will 5498 + prompt for a query, then bring up the query menu which will list the 5499 + matching responses. From the query menu, you can select addresses to 5500 + create aliases, or to mail. You can tag multiple addresses to mail, 5501 + start a new query, or have a new query appended to the current 5316 5502 responses. 5317 5503 </para> 5318 5504 5319 5505 <para> 5320 5506 The other mechanism for accessing the query function is for address 5321 5507 completion, similar to the alias completion. In any prompt for address 5322 - entry, you can use the <literal>&lt;complete-query&gt;</literal> function (default: ^T) to run a 5323 - query based on the current address you have typed. Like aliases, Mutt 5324 - will look for what you have typed back to the last space or comma. If 5325 - there is a single response for that query, Mutt will expand the address 5326 - in place. If there are multiple responses, Mutt will activate the query 5327 - menu. At the query menu, you can select one or more addresses to be 5328 - added to the prompt. 5508 + entry, you can use the <literal>&lt;complete-query&gt;</literal> 5509 + function (default: ^T) to run a query based on the current address you 5510 + have typed. Like aliases, Mutt will look for what you have typed back 5511 + to the last space or comma. If there is a single response for that 5512 + query, Mutt will expand the address in place. If there are multiple 5513 + responses, Mutt will activate the query menu. At the query menu, you 5514 + can select one or more addresses to be added to the prompt. 5329 5515 </para> 5330 5516 5331 5517 </sect1> ··· 5334 5520 <title>Mailbox Formats</title> 5335 5521 5336 5522 <para> 5337 - Mutt supports reading and writing of four different local mailbox formats: 5338 - mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there 5339 - is no need to use a flag for different mailbox types. When creating new 5340 - mailboxes, Mutt uses the default specified with the 5341 - <link linkend="mbox-type">$mbox_type</link> variable. A 5342 - short description of the formats follows. 5523 + Mutt supports reading and writing of four different local mailbox 5524 + formats: mbox, MMDF, MH and Maildir. The mailbox type is autodetected, 5525 + so there is no need to use a flag for different mailbox types. When 5526 + creating new mailboxes, Mutt uses the default specified with the <link 5527 + linkend="mbox-type">$mbox_type</link> variable. A short description of 5528 + the formats follows. 5343 5529 </para> 5344 5530 5345 5531 <para> 5346 - <emphasis>mbox</emphasis>. This is a widely used mailbox format for UNIX. All 5347 - messages are stored in a single file. Each message has a line of the form: 5532 + <emphasis>mbox</emphasis>. This is a widely used mailbox format for 5533 + UNIX. All messages are stored in a single file. Each message has a 5534 + line of the form: 5348 5535 </para> 5349 5536 5350 5537 <screen> ··· 5353 5540 5354 5541 <para> 5355 5542 to denote the start of a new message (this is often referred to as the 5356 - <quote>From_</quote> line). The mbox format requires mailbox 5357 - locking, is prone to mailbox corruption with concurrently writing 5358 - clients or misinterpreted From_ lines. Depending on the 5359 - environment, new mail detection can be unreliable. Mbox folders are fast 5360 - to open and easy to archive. 5543 + <quote>From_</quote> line). The mbox format requires mailbox locking, is 5544 + prone to mailbox corruption with concurrently writing clients or 5545 + misinterpreted From_ lines. Depending on the environment, new mail 5546 + detection can be unreliable. Mbox folders are fast to open and easy to 5547 + archive. 5361 5548 </para> 5362 5549 5363 5550 <para> 5364 - <emphasis>MMDF</emphasis>. This is a variant of 5365 - the <emphasis>mbox</emphasis> format. Each message is surrounded by 5366 - lines containing <quote>^A^A^A^A</quote> (four 5367 - control-A's). The same problems as for mbox apply (also with finding the 5368 - right message separator as four control-A's may appear in message 5369 - bodies). 5551 + <emphasis>MMDF</emphasis>. This is a variant of the 5552 + <emphasis>mbox</emphasis> format. Each message is surrounded by lines 5553 + containing <quote>^A^A^A^A</quote> (four control-A's). The same problems 5554 + as for mbox apply (also with finding the right message separator as four 5555 + control-A's may appear in message bodies). 5370 5556 </para> 5371 5557 5372 5558 <para> 5373 - <emphasis>MH</emphasis>. A radical departure from <emphasis>mbox</emphasis> and <emphasis>MMDF</emphasis>, a mailbox 5559 + <emphasis>MH</emphasis>. A radical departure from 5560 + <emphasis>mbox</emphasis> and <emphasis>MMDF</emphasis>, a mailbox 5374 5561 consists of a directory and each message is stored in a separate file. 5375 5562 The filename indicates the message number (however, this is may not 5376 5563 correspond to the message number Mutt displays). Deleted messages are 5377 5564 renamed with a comma (<quote>,</quote>) prepended to the filename. Mutt 5378 - detects this type of mailbox by looking for either <literal>.mh_sequences</literal> 5379 - or <literal>.xmhcache</literal> files (needed to distinguish normal directories from MH 5380 - mailboxes). MH is more robust with concurrent clients writing the mailbox, 5381 - but still may suffer from lost flags; message corruption is less likely 5382 - to occur than with mbox/mmdf. It's usually slower to open compared to 5383 - mbox/mmdf since many small files have to be read (Mutt provides 5384 - <xref linkend="header-caching"/> to greatly speed this process up). 5385 - Depending on the environment, MH is not very disk-space efficient. 5565 + detects this type of mailbox by looking for either 5566 + <literal>.mh_sequences</literal> or <literal>.xmhcache</literal> files 5567 + (needed to distinguish normal directories from MH mailboxes). MH is more 5568 + robust with concurrent clients writing the mailbox, but still may suffer 5569 + from lost flags; message corruption is less likely to occur than with 5570 + mbox/mmdf. It's usually slower to open compared to mbox/mmdf since many 5571 + small files have to be read (Mutt provides <xref 5572 + linkend="header-caching"/> to greatly speed this process up). Depending 5573 + on the environment, MH is not very disk-space efficient. 5386 5574 </para> 5387 5575 5388 5576 <para> 5389 - <emphasis>Maildir</emphasis>. The newest of the mailbox formats, used by the Qmail MTA (a 5390 - replacement for sendmail). Similar to <emphasis>MH</emphasis>, except that it adds three 5391 - subdirectories of the mailbox: <emphasis>tmp</emphasis>, <emphasis>new</emphasis> and <emphasis>cur</emphasis>. Filenames 5392 - for the messages are chosen in such a way they are unique, even when two 5393 - programs are writing the mailbox over NFS, which means that no file locking 5394 - is needed and corruption is very unlikely. Maildir maybe 5395 - slower to open without caching in Mutt, it too is not very 5396 - disk-space efficient depending on the environment. Since no additional 5397 - files are used for metadata (which is embedded in the message filenames) 5398 - and Maildir is locking-free, it's easy to sync across different machines 5399 - using file-level synchronization tools. 5577 + <emphasis>Maildir</emphasis>. The newest of the mailbox formats, used 5578 + by the Qmail MTA (a replacement for sendmail). Similar to 5579 + <emphasis>MH</emphasis>, except that it adds three subdirectories of the 5580 + mailbox: <emphasis>tmp</emphasis>, <emphasis>new</emphasis> and 5581 + <emphasis>cur</emphasis>. Filenames for the messages are chosen in such 5582 + a way they are unique, even when two programs are writing the mailbox 5583 + over NFS, which means that no file locking is needed and corruption is 5584 + very unlikely. Maildir maybe slower to open without caching in Mutt, it 5585 + too is not very disk-space efficient depending on the environment. Since 5586 + no additional files are used for metadata (which is embedded in the 5587 + message filenames) and Maildir is locking-free, it's easy to sync across 5588 + different machines using file-level synchronization tools. 5400 5589 </para> 5401 5590 5402 5591 </sect1> ··· 5405 5594 <title>Mailbox Shortcuts</title> 5406 5595 5407 5596 <para> 5408 - There are a number of built in shortcuts which refer to specific mailboxes. 5409 - These shortcuts can be used anywhere you are prompted for a file or mailbox 5410 - path or in path-related configuration variables. Note that these only 5411 - work at the beginning of a string. 5597 + There are a number of built in shortcuts which refer to specific 5598 + mailboxes. These shortcuts can be used anywhere you are prompted for a 5599 + file or mailbox path or in path-related configuration variables. Note 5600 + that these only work at the beginning of a string. 5412 5601 </para> 5413 5602 5414 5603 <itemizedlist> 5415 5604 <listitem> 5416 5605 5417 5606 <para> 5418 - ! &mdash; refers to your <link linkend="spoolfile">$spoolfile</link> (incoming) mailbox 5607 + ! &mdash; refers to your <link linkend="spoolfile">$spoolfile</link> 5608 + (incoming) mailbox 5419 5609 </para> 5420 5610 </listitem> 5421 5611 <listitem> ··· 5445 5635 <listitem> 5446 5636 5447 5637 <para> 5448 - # &mdash; refers to your home directory 5638 + ~ &mdash; refers to your home directory 5449 5639 </para> 5450 5640 </listitem> 5451 5641 <listitem> 5452 5642 5453 5643 <para> 5454 - = or + &mdash; refers to your <link linkend="folder">$folder</link> directory 5644 + = or + &mdash; refers to your <link linkend="folder">$folder</link> 5645 + directory 5455 5646 </para> 5456 5647 </listitem> 5457 5648 <listitem> 5458 5649 5459 5650 <para> 5460 - @<emphasis>alias</emphasis> &mdash; refers to the <link linkend="save-hook">default save folder</link> as determined by the address of the alias 5651 + @<emphasis>alias</emphasis> &mdash; refers to the <link 5652 + linkend="save-hook">default save folder</link> as determined by the 5653 + address of the alias 5461 5654 </para> 5462 5655 </listitem> 5463 5656 ··· 5465 5658 5466 5659 <para> 5467 5660 For example, to store a copy of outgoing messages in the folder they 5468 - were composed in, 5469 - a <link linkend="folder-hook"><command>folder-hook</command></link> can 5470 - be used to set <link linkend="record">$record</link>: 5661 + were composed in, a <link 5662 + linkend="folder-hook"><command>folder-hook</command></link> can be used 5663 + to set <link linkend="record">$record</link>: 5471 5664 </para> 5472 5665 5473 5666 <screen> ··· 5480 5673 5481 5674 <para> 5482 5675 Mutt has a few configuration options that make dealing with large 5483 - amounts of mail easier. The first thing you must do is to let Mutt 5484 - know what addresses you consider to be mailing lists (technically 5485 - this does not have to be a mailing list, but that is what it is most 5486 - often used for), and what lists you are subscribed to. This is 5487 - accomplished through the use of the <link linkend="lists"><command>lists</command> and <command>subscribe</command></link> commands in your <literal>.muttrc</literal>. 5676 + amounts of mail easier. The first thing you must do is to let Mutt know 5677 + what addresses you consider to be mailing lists (technically this does 5678 + not have to be a mailing list, but that is what it is most often used 5679 + for), and what lists you are subscribed to. This is accomplished 5680 + through the use of the <link linkend="lists"><command>lists</command> 5681 + and <command>subscribe</command></link> commands in your 5682 + <literal>.muttrc</literal>. 5488 5683 </para> 5489 5684 5490 5685 <para> 5491 5686 Now that Mutt knows what your mailing lists are, it can do several 5492 5687 things, the first of which is the ability to show the name of a list 5493 - through which you received a message (i.e., of a subscribed list) in 5494 - the <emphasis>index</emphasis> menu display. This is useful to distinguish between 5495 - personal and list mail in the same mailbox. In the <link linkend="index-format">$index_format</link> variable, the expando <quote>%L</quote> 5496 - will print the string <quote>To &lt;list&gt;</quote> when <quote>list</quote> appears in the 5497 - <quote>To</quote> field, and <quote>Cc &lt;list&gt;</quote> when it appears in the <quote>Cc</quote> 5688 + through which you received a message (i.e., of a subscribed list) in the 5689 + <emphasis>index</emphasis> menu display. This is useful to distinguish 5690 + between personal and list mail in the same mailbox. In the <link 5691 + linkend="index-format">$index_format</link> variable, the expando 5692 + <quote>%L</quote> will print the string <quote>To &lt;list&gt;</quote> 5693 + when <quote>list</quote> appears in the <quote>To</quote> field, and 5694 + <quote>Cc &lt;list&gt;</quote> when it appears in the <quote>Cc</quote> 5498 5695 field (otherwise it prints the name of the author). 5499 5696 </para> 5500 5697 5501 5698 <para> 5502 - Often times the <quote>To</quote> and <quote>Cc</quote> fields in mailing list messages 5503 - tend to get quite large. Most people do not bother to remove the 5504 - author of the message they reply to from the list, resulting in 5505 - two or more copies being sent to that person. The <literal>&lt;list-reply&gt;</literal> 5506 - function, which by default is bound to <quote>L</quote> in the <emphasis>index</emphasis> menu 5507 - and <emphasis>pager</emphasis>, helps reduce the clutter by only replying to the 5508 - known mailing list addresses instead of all recipients (except as 5699 + Often times the <quote>To</quote> and <quote>Cc</quote> fields in 5700 + mailing list messages tend to get quite large. Most people do not bother 5701 + to remove the author of the message they reply to from the list, 5702 + resulting in two or more copies being sent to that person. The 5703 + <literal>&lt;list-reply&gt;</literal> function, which by default is 5704 + bound to <quote>L</quote> in the <emphasis>index</emphasis> menu and 5705 + <emphasis>pager</emphasis>, helps reduce the clutter by only replying to 5706 + the known mailing list addresses instead of all recipients (except as 5509 5707 specified by <literal>Mail-Followup-To</literal>, see below). 5510 5708 </para> 5511 5709 5512 5710 <para> 5513 - Mutt also supports the <literal>Mail-Followup-To</literal> header. When you send 5514 - a message to a list of recipients which includes one or several 5515 - subscribed mailing lists, and if the <link linkend="followup-to">$followup_to</link> option is set, Mutt will generate 5516 - a Mail-Followup-To header which contains all the recipients to whom 5517 - you send this message, but not your address. This indicates that 5518 - group-replies or list-replies (also known as <quote>followups</quote>) to this 5519 - message should only be sent to the original recipients of the 5711 + Mutt also supports the <literal>Mail-Followup-To</literal> header. When 5712 + you send a message to a list of recipients which includes one or several 5713 + subscribed mailing lists, and if the <link 5714 + linkend="followup-to">$followup_to</link> option is set, Mutt will 5715 + generate a Mail-Followup-To header which contains all the recipients to 5716 + whom you send this message, but not your address. This indicates that 5717 + group-replies or list-replies (also known as <quote>followups</quote>) 5718 + to this message should only be sent to the original recipients of the 5520 5719 message, and not separately to you - you'll receive your copy through 5521 5720 one of the mailing lists you are subscribed to. 5522 5721 </para> 5523 5722 5524 5723 <para> 5525 - Conversely, when group-replying or list-replying to a message which 5526 - has a <literal>Mail-Followup-To</literal> header, Mutt will respect this header if 5527 - the <link linkend="honor-followup-to">$honor_followup_to</link> configuration 5528 - variable is set. Using <link linkend="list-reply">list-reply</link> will in this case also make sure 5529 - that the reply goes to the mailing list, even if it's not specified 5530 - in the list of recipients in the <literal>Mail-Followup-To</literal>. 5724 + Conversely, when group-replying or list-replying to a message which has 5725 + a <literal>Mail-Followup-To</literal> header, Mutt will respect this 5726 + header if the <link 5727 + linkend="honor-followup-to">$honor_followup_to</link> configuration 5728 + variable is set. Using <link linkend="list-reply">list-reply</link> 5729 + will in this case also make sure that the reply goes to the mailing 5730 + list, even if it's not specified in the list of recipients in the 5731 + <literal>Mail-Followup-To</literal>. 5531 5732 </para> 5532 5733 5533 5734 <note> 5534 5735 <para> 5535 5736 When header editing is enabled, you can create a 5536 - <literal>Mail-Followup-To</literal> header manually. Mutt will only auto-generate 5537 - this header if it doesn't exist when you send the message. 5737 + <literal>Mail-Followup-To</literal> header manually. Mutt will only 5738 + auto-generate this header if it doesn't exist when you send the message. 5538 5739 </para> 5539 5740 </note> 5540 5741 5541 5742 <para> 5542 5743 The other method some mailing list admins use is to generate a 5543 - <quote>Reply-To</quote> field which points back to the mailing list address rather 5544 - than the author of the message. This can create problems when trying 5545 - to reply directly to the author in private, since most mail clients 5546 - will automatically reply to the address given in the <quote>Reply-To</quote> 5547 - field. Mutt uses the <link linkend="reply-to">$reply_to</link> 5548 - variable to help decide which address to use. If set to <emphasis>ask-yes</emphasis> or 5549 - <emphasis>ask-no</emphasis>, you will be 5550 - prompted as to whether or not you would like to use the address given in 5551 - the <quote>Reply-To</quote> field, or reply directly to the address given in the 5552 - <quote>From</quote> field. When set to <emphasis>yes</emphasis>, the <quote>Reply-To</quote> field will be used when 5553 - present. 5744 + <quote>Reply-To</quote> field which points back to the mailing list 5745 + address rather than the author of the message. This can create problems 5746 + when trying to reply directly to the author in private, since most mail 5747 + clients will automatically reply to the address given in the 5748 + <quote>Reply-To</quote> field. Mutt uses the <link 5749 + linkend="reply-to">$reply_to</link> variable to help decide which 5750 + address to use. If set to <emphasis>ask-yes</emphasis> or 5751 + <emphasis>ask-no</emphasis>, you will be prompted as to whether or not 5752 + you would like to use the address given in the <quote>Reply-To</quote> 5753 + field, or reply directly to the address given in the <quote>From</quote> 5754 + field. When set to <emphasis>yes</emphasis>, the 5755 + <quote>Reply-To</quote> field will be used when present. 5554 5756 </para> 5555 5757 5556 5758 <para> 5557 - The <quote>X-Label:</quote> header field can be used to further identify mailing 5558 - lists or list subject matter (or just to annotate messages 5559 - individually). The <link linkend="index-format">$index_format</link> variable's <quote>%y</quote> and 5560 - <quote>%Y</quote> expandos can be used to expand <quote>X-Label:</quote> fields in the 5561 - index, and Mutt's pattern-matcher can match regular expressions to 5562 - <quote>X-Label:</quote> fields with the <quote>#y</quote> selector. <quote>X-Label:</quote> is not a 5563 - standard message header field, but it can easily be inserted by procmail 5564 - and other mail filtering agents. 5759 + The <quote>X-Label:</quote> header field can be used to further identify 5760 + mailing lists or list subject matter (or just to annotate messages 5761 + individually). The <link linkend="index-format">$index_format</link> 5762 + variable's <quote>%y</quote> and <quote>%Y</quote> expandos can be used 5763 + to expand <quote>X-Label:</quote> fields in the index, and Mutt's 5764 + pattern-matcher can match regular expressions to <quote>X-Label:</quote> 5765 + fields with the <quote>~y</quote> selector. <quote>X-Label:</quote> is 5766 + not a standard message header field, but it can easily be inserted by 5767 + procmail and other mail filtering agents. 5565 5768 </para> 5566 5769 5567 5770 <para> 5568 - Lastly, Mutt has the ability to <link linkend="sort">sort</link> the mailbox into 5569 - <link linkend="threads">threads</link>. A thread is a group of messages which all relate to the same 5570 - subject. This is usually organized into a tree-like structure where a 5571 - message and all of its replies are represented graphically. If you've ever 5572 - used a threaded news client, this is the same concept. It makes dealing 5573 - with large volume mailing lists easier because you can easily delete 5574 - uninteresting threads and quickly find topics of value. 5771 + Lastly, Mutt has the ability to <link linkend="sort">sort</link> the 5772 + mailbox into <link linkend="threads">threads</link>. A thread is a 5773 + group of messages which all relate to the same subject. This is usually 5774 + organized into a tree-like structure where a message and all of its 5775 + replies are represented graphically. If you've ever used a threaded 5776 + news client, this is the same concept. It makes dealing with large 5777 + volume mailing lists easier because you can easily delete uninteresting 5778 + threads and quickly find topics of value. 5575 5779 </para> 5576 5780 5577 5781 </sect1> ··· 5700 5904 <title>Linking Threads</title> 5701 5905 5702 5906 <para> 5703 - Some mailers tend to <quote>forget</quote> to correctly set the <quote>In-Reply-To:</quote> and 5704 - <quote>References:</quote> headers when replying to a message. This results in broken 5705 - discussions because Mutt has not enough information to guess the correct 5706 - threading. 5707 - You can fix this by tagging the reply, then moving to the parent message 5708 - and using the <literal>&lt;link-threads&gt;</literal> function (bound to &amp; by default). The 5709 - reply will then be connected to this parent message. 5907 + Some mailers tend to <quote>forget</quote> to correctly set the 5908 + <quote>In-Reply-To:</quote> and <quote>References:</quote> headers when 5909 + replying to a message. This results in broken discussions because Mutt 5910 + has not enough information to guess the correct threading. You can fix 5911 + this by tagging the reply, then moving to the parent message and using 5912 + the <literal>&lt;link-threads&gt;</literal> function (bound to &amp; by 5913 + default). The reply will then be connected to this parent message. 5710 5914 </para> 5711 5915 5712 5916 <para> 5713 - You can also connect multiple children at once, tagging them and using the 5714 - <literal>&lt;tag-prefix&gt;</literal> command (';') or the <link linkend="auto-tag">$auto_tag</link> option. 5917 + You can also connect multiple children at once, tagging them and using 5918 + the <literal>&lt;tag-prefix&gt;</literal> command (';') or the <link 5919 + linkend="auto-tag">$auto_tag</link> option. 5715 5920 </para> 5716 5921 5717 5922 </sect2> ··· 5721 5926 5722 5927 <para> 5723 5928 On mailing lists, some people are in the bad habit of starting a new 5724 - discussion by hitting <quote>reply</quote> to any message from the list and changing 5725 - the subject to a totally unrelated one. 5726 - You can fix such threads by using the <literal>&lt;break-thread&gt;</literal> function (bound 5727 - by default to #), which will turn the subthread starting from the 5929 + discussion by hitting <quote>reply</quote> to any message from the list 5930 + and changing the subject to a totally unrelated one. You can fix such 5931 + threads by using the <literal>&lt;break-thread&gt;</literal> function 5932 + (bound by default to #), which will turn the subthread starting from the 5728 5933 current message into a whole different thread. 5729 5934 </para> 5730 5935 ··· 5737 5942 5738 5943 <para> 5739 5944 RFC1894 defines a set of MIME content types for relaying information 5740 - about the status of electronic mail messages. These can be thought of as 5741 - <quote>return receipts.</quote> 5945 + about the status of electronic mail messages. These can be thought of 5946 + as <quote>return receipts.</quote> 5742 5947 </para> 5743 5948 5744 5949 <para> 5745 - To support DSN, there are two variables. <link linkend="dsn-notify">$dsn_notify</link> is used to request receipts for 5950 + To support DSN, there are two variables. <link 5951 + linkend="dsn-notify">$dsn_notify</link> is used to request receipts for 5746 5952 different results (such as failed message, message delivered, etc.). 5747 - <link linkend="dsn-return">$dsn_return</link> requests how much 5748 - of your message should be returned with the receipt (headers or full 5749 - message). 5953 + <link linkend="dsn-return">$dsn_return</link> requests how much of your 5954 + message should be returned with the receipt (headers or full message). 5750 5955 </para> 5751 5956 5752 5957 <para> 5753 - When using <link linkend="sendmail">$sendmail</link> for mail 5754 - delivery, you need to use either Berkeley sendmail 8.8.x (or greater) a MTA 5755 - supporting DSN command line options compatible to Sendmail: The -N and -R 5756 - options can be used by the mail client to make requests as to what type of 5757 - status messages should be returned. Please consider your MTA documentation 5758 - whether DSN is supported. 5958 + When using <link linkend="sendmail">$sendmail</link> for mail delivery, 5959 + you need to use either Berkeley sendmail 8.8.x (or greater) a MTA 5960 + supporting DSN command line options compatible to Sendmail: The -N and 5961 + -R options can be used by the mail client to make requests as to what 5962 + type of status messages should be returned. Please consider your MTA 5963 + documentation whether DSN is supported. 5759 5964 </para> 5760 5965 5761 5966 <para> 5762 - For SMTP delivery using <link 5763 - linkend="smtp-url">$smtp_url</link>, it depends on the 5764 - capabilities announced by the server whether Mutt will attempt to 5765 - request DSN or not. 5967 + For SMTP delivery using <link linkend="smtp-url">$smtp_url</link>, it 5968 + depends on the capabilities announced by the server whether Mutt will 5969 + attempt to request DSN or not. 5766 5970 </para> 5767 5971 5768 5972 </sect1> ··· 5771 5975 <title>Start a WWW Browser on URLs</title> 5772 5976 5773 5977 <para> 5774 - If a message contains URLs, it is efficient to get 5775 - a menu with all the URLs and start a WWW browser on one of them. This 5776 - functionality is provided by the external urlview program which can be 5777 - retrieved at 5778 - <ulink url="ftp://ftp.mutt.org/mutt/contrib/">ftp://ftp.mutt.org/mutt/contrib/</ulink> 5978 + If a message contains URLs, it is efficient to get a menu with all the 5979 + URLs and start a WWW browser on one of them. This functionality is 5980 + provided by the external urlview program which can be retrieved at 5981 + <ulink 5982 + url="ftp://ftp.mutt.org/mutt/contrib/">ftp://ftp.mutt.org/mutt/contrib/</ulink> 5779 5983 and the configuration commands: 5780 5984 </para> 5781 5985 ··· 5801 6005 <listitem> 5802 6006 <para> 5803 6007 Mutt normalizes all e-mail addresses to the simplest form possible. If 5804 - an address contains a realname, the form 5805 - <emphasis>Joe User &lt;joe@example.com&gt;</emphasis> is used and the 5806 - pure e-mail address without angle brackets otherwise, i.e. just 6008 + an address contains a realname, the form <emphasis>Joe User 6009 + &lt;joe@example.com&gt;</emphasis> is used and the pure e-mail address 6010 + without angle brackets otherwise, i.e. just 5807 6011 <emphasis>joe@example.com</emphasis>. 5808 6012 </para> 5809 6013 <para> ··· 5822 6026 present. Otherwise, the value of <literal>$MAILDIR</literal> is taken 5823 6027 into account. If that isn't present either, Mutt takes the user's 5824 6028 mailbox in the mailspool as determined at compile-time (which may also 5825 - reside in the home directory). The 5826 - <link linkend="spoolfile">$spoolfile</link> setting overrides 5827 - this selection. Highest priority has the mailbox given with the 6029 + reside in the home directory). The <link 6030 + linkend="spoolfile">$spoolfile</link> setting overrides this 6031 + selection. Highest priority has the mailbox given with the 5828 6032 <literal>-f</literal> command line option. 5829 6033 </para> 5830 6034 </listitem> ··· 5844 6048 the discerning MIME user requires, and the conformance to the standards 5845 6049 wherever possible. When configuring Mutt for MIME, there are two extra 5846 6050 types of configuration files which Mutt uses. One is the 5847 - <literal>mime.types</literal> file, which contains the mapping of file extensions to 5848 - IANA MIME types. The other is the <literal>mailcap</literal> file, which specifies 5849 - the external commands to use for handling specific MIME types. 6051 + <literal>mime.types</literal> file, which contains the mapping of file 6052 + extensions to IANA MIME types. The other is the 6053 + <literal>mailcap</literal> file, which specifies the external commands 6054 + to use for handling specific MIME types. 5850 6055 </para> 5851 6056 5852 6057 <sect1 id="using-mime"> ··· 5869 6074 Besides the handling of non-ascii characters in message headers, to Mutt 5870 6075 the most important aspect of MIME are so-called MIME types. These are 5871 6076 constructed using a <emphasis>major</emphasis> and 5872 - <emphasis>minor</emphasis> type separated by a forward slash. 5873 - These specify details about the content that follows. Based upon these, 5874 - Mutt decides how to handle this part. The most popular major type is 6077 + <emphasis>minor</emphasis> type separated by a forward slash. These 6078 + specify details about the content that follows. Based upon these, Mutt 6079 + decides how to handle this part. The most popular major type is 5875 6080 <quote><literal>text</literal></quote> with minor types for plain text, 5876 6081 HTML and various other formats. Major types also exist for images, 5877 6082 audio, video and of course general application data (e.g. to separate 5878 6083 cryptographically signed data with a signature, send office documents, 5879 6084 and in general arbitrary binary data). There's also the 5880 - <literal>multipart</literal> major type which represents the root of 5881 - a subtree of MIME parts. A list of supported MIME types can be found in 6085 + <literal>multipart</literal> major type which represents the root of a 6086 + subtree of MIME parts. A list of supported MIME types can be found in 5882 6087 <xref linkend="supported-mime-types"/>. 5883 6088 </para> 5884 6089 ··· 7015 7220 7016 7221 <para> 7017 7222 Mutt supports several of optional features which can be enabled or 7018 - disabled at compile-time by giving the <emphasis>configure</emphasis> script 7019 - certain arguments. These are listed in the <quote>Optional features</quote> section of 7020 - the <emphasis>configure --help</emphasis> output. 7223 + disabled at compile-time by giving the <emphasis>configure</emphasis> 7224 + script certain arguments. These are listed in the <quote>Optional 7225 + features</quote> section of the <emphasis>configure --help</emphasis> 7226 + output. 7021 7227 </para> 7022 7228 7023 7229 <para> 7024 7230 Which features are enabled or disabled can later be determined from the 7025 7231 output of <literal>mutt -v</literal>. If a compile option starts with 7026 - <quote>+</quote> it is enabled and disabled if prefixed with <quote>-</quote>. For example, if 7027 - Mutt was compiled using GnuTLS for encrypted communication instead of 7028 - OpenSSL, <literal>mutt -v</literal> would contain: 7232 + <quote>+</quote> it is enabled and disabled if prefixed with 7233 + <quote>-</quote>. For example, if Mutt was compiled using GnuTLS for 7234 + encrypted communication instead of OpenSSL, <literal>mutt -v</literal> 7235 + would contain: 7029 7236 </para> 7030 7237 7031 7238 <screen> ··· 7039 7246 <para> 7040 7247 Mutt optionally supports the IMAP, POP3 and SMTP protocols which require 7041 7248 to access servers using URLs. The canonical syntax for specifying URLs 7042 - in Mutt is (an item enclosed in <literal>[]</literal> means it is optional and 7043 - may be omitted): 7249 + in Mutt is (an item enclosed in <literal>[]</literal> means it is 7250 + optional and may be omitted): 7044 7251 </para> 7045 7252 7046 7253 <screen> ··· 7059 7266 Since all protocols supported by Mutt support/require authentication, 7060 7267 login credentials may be specified in the URL. This has the advantage 7061 7268 that multiple IMAP, POP3 or SMTP servers may be specified (which isn't 7062 - possible using, for example, 7063 - <link linkend="imap-user">$imap_user</link>). The username 7064 - may contain the <quote>@</quote> symbol being used by many mail systems 7065 - as part of the login name. The special characters <quote>/</quote> 7066 - (<literal>%2F</literal>), 7067 - <quote>:</quote> (<literal>%3A</literal>) 7068 - and <quote>%</quote> (<literal>%25</literal>) have to be 7069 - URL-encoded in usernames using the <literal>%</literal>-notation. 7269 + possible using, for example, <link 7270 + linkend="imap-user">$imap_user</link>). The username may contain the 7271 + <quote>@</quote> symbol being used by many mail systems as part of the 7272 + login name. The special characters <quote>/</quote> 7273 + (<literal>%2F</literal>), <quote>:</quote> (<literal>%3A</literal>) and 7274 + <quote>%</quote> (<literal>%25</literal>) have to be URL-encoded in 7275 + usernames using the <literal>%</literal>-notation. 7070 7276 </para> 7071 7277 7072 7278 <para> ··· 7101 7307 7102 7308 <para> 7103 7309 If Mutt is compiled with IMAP, POP3 and/or SMTP support, it can also be 7104 - compiled with support for SSL or TLS using either OpenSSL or GnuTLS ( 7105 - by running the <emphasis>configure</emphasis> script with the 7310 + compiled with support for SSL or TLS using either OpenSSL or GnuTLS ( by 7311 + running the <emphasis>configure</emphasis> script with the 7106 7312 <emphasis>--enable-ssl=...</emphasis> option for OpenSSL or 7107 7313 <emphasis>--enable-gnutls=...</emphasis> for GnuTLS). Mutt can then 7108 7314 attempt to encrypt communication with remote servers if these protocols 7109 - are suffixed with <quote>s</quote> for <quote>secure communication</quote>. 7315 + are suffixed with <quote>s</quote> for <quote>secure 7316 + communication</quote>. 7110 7317 </para> 7111 7318 7112 7319 </sect1> ··· 7115 7322 <title>POP3 Support</title> 7116 7323 7117 7324 <para> 7118 - If Mutt is compiled with POP3 support (by running the <emphasis>configure</emphasis> 7119 - script with the <emphasis>--enable-pop</emphasis> flag), it has the ability to work 7120 - with mailboxes located on a remote POP3 server and fetch mail for local 7325 + If Mutt is compiled with POP3 support (by running the 7326 + <emphasis>configure</emphasis> script with the 7327 + <emphasis>--enable-pop</emphasis> flag), it has the ability to work with 7328 + mailboxes located on a remote POP3 server and fetch mail for local 7121 7329 browsing. 7122 7330 </para> 7123 7331 7124 7332 <para> 7125 - Remote POP3 servers can be accessed using URLs with the <literal>pop</literal> protocol 7126 - for unencrypted and <literal>pops</literal> for encrypted 7127 - communication, see <xref linkend="url-syntax"/> for details. 7333 + Remote POP3 servers can be accessed using URLs with the 7334 + <literal>pop</literal> protocol for unencrypted and 7335 + <literal>pops</literal> for encrypted communication, see <xref 7336 + linkend="url-syntax"/> for details. 7128 7337 </para> 7129 7338 7130 7339 <para> 7131 7340 Polling for new mail is more expensive over POP3 than locally. For this 7132 7341 reason the frequency at which Mutt will check for mail remotely can be 7133 - controlled by the 7134 - <link linkend="pop-checkinterval">$pop_checkinterval</link> 7135 - variable, which defaults to every 60 seconds. 7342 + controlled by the <link 7343 + linkend="pop-checkinterval">$pop_checkinterval</link> variable, which 7344 + defaults to every 60 seconds. 7136 7345 </para> 7137 7346 7138 7347 <para> 7139 7348 POP is read-only which doesn't allow for some features like editing 7140 - messages or changing flags. However, using 7141 - <xref linkend="header-caching"/> and <xref linkend="body-caching"/> 7142 - Mutt simulates the new/old/read flags as well as flagged and replied. 7143 - Mutt applies some logic on top of remote messages but cannot change 7144 - them so that modifications of flags are lost when 7145 - messages are downloaded from the POP server (either by Mutt or other 7146 - tools). 7349 + messages or changing flags. However, using <xref 7350 + linkend="header-caching"/> and <xref linkend="body-caching"/> Mutt 7351 + simulates the new/old/read flags as well as flagged and replied. Mutt 7352 + applies some logic on top of remote messages but cannot change them so 7353 + that modifications of flags are lost when messages are downloaded from 7354 + the POP server (either by Mutt or other tools). 7147 7355 </para> 7148 7356 7149 7357 <anchor id="fetch-mail"/> 7150 7358 <para> 7151 - Another way to access your POP3 mail is the <literal>&lt;fetch-mail&gt;</literal> function 7152 - (default: G). It allows to connect to <link linkend="pop-host">$pop_host</link>, fetch all your new mail and place it in the 7153 - local <link linkend="spoolfile">$spoolfile</link>. After this 7154 - point, Mutt runs exactly as if the mail had always been local. 7359 + Another way to access your POP3 mail is the 7360 + <literal>&lt;fetch-mail&gt;</literal> function (default: G). It allows 7361 + to connect to <link linkend="pop-host">$pop_host</link>, fetch all your 7362 + new mail and place it in the local <link 7363 + linkend="spoolfile">$spoolfile</link>. After this point, Mutt runs 7364 + exactly as if the mail had always been local. 7155 7365 </para> 7156 7366 7157 7367 <note> 7158 7368 <para> 7159 - If you only need to fetch all messages to a 7160 - local mailbox you should consider using a specialized program, such as 7161 - <literal>fetchmail(1)</literal>, <literal>getmail(1)</literal> or similar. 7369 + If you only need to fetch all messages to a local mailbox you should 7370 + consider using a specialized program, such as 7371 + <literal>fetchmail(1)</literal>, <literal>getmail(1)</literal> or 7372 + similar. 7162 7373 </para> 7163 7374 </note> 7164 7375 ··· 7168 7379 <title>IMAP Support</title> 7169 7380 7170 7381 <para> 7171 - If Mutt was compiled with IMAP support (by running the <emphasis>configure</emphasis> 7172 - script with the <emphasis>--enable-imap</emphasis> flag), it has the ability to work 7382 + If Mutt was compiled with IMAP support (by running the 7383 + <emphasis>configure</emphasis> script with the 7384 + <emphasis>--enable-imap</emphasis> flag), it has the ability to work 7173 7385 with folders located on a remote IMAP server. 7174 7386 </para> 7175 7387 7176 7388 <para> 7177 - You can access the remote inbox by selecting the folder by its URL 7178 - (see <xref linkend="url-syntax"/> for details) using the 7389 + You can access the remote inbox by selecting the folder by its URL (see 7390 + <xref linkend="url-syntax"/> for details) using the 7179 7391 <literal>imap</literal> or <literal>imaps</literal> protocol. 7180 7392 Alternatively, a pine-compatible notation is also supported, ie 7181 7393 <literal>{[username@]imapserver[:port][/ssl]}path/to/folder</literal> 7182 7394 </para> 7183 7395 7184 7396 <para> 7185 - Note that not all servers use <quote>/</quote> as the hierarchy separator. Mutt should 7186 - correctly notice which separator is being used by the server and convert 7187 - paths accordingly. 7397 + Note that not all servers use <quote>/</quote> as the hierarchy 7398 + separator. Mutt should correctly notice which separator is being used 7399 + by the server and convert paths accordingly. 7188 7400 </para> 7189 7401 7190 7402 <para> 7191 7403 When browsing folders on an IMAP server, you can toggle whether to look 7192 7404 at only the folders you are subscribed to, or all folders with the 7193 - <emphasis>toggle-subscribed</emphasis> command. See also the 7194 - <link linkend="imap-list-subscribed">$imap_list_subscribed</link> variable. 7405 + <emphasis>toggle-subscribed</emphasis> command. See also the <link 7406 + linkend="imap-list-subscribed">$imap_list_subscribed</link> variable. 7195 7407 </para> 7196 7408 7197 7409 <para> 7198 - Polling for new mail on an IMAP server can cause noticeable delays. So, you'll 7199 - want to carefully tune the 7200 - <link linkend="mail-check">$mail_check</link> 7201 - and 7202 - <link linkend="timeout">$timeout</link> 7203 - variables. Reasonable values are: 7410 + Polling for new mail on an IMAP server can cause noticeable delays. So, 7411 + you'll want to carefully tune the <link 7412 + linkend="mail-check">$mail_check</link> and <link 7413 + linkend="timeout">$timeout</link> variables. Reasonable values are: 7204 7414 </para> 7205 7415 7206 7416 <screen> ··· 7215 7425 <note> 7216 7426 <para> 7217 7427 Note that if you are using mbox as the mail store on UW servers prior to 7218 - v12.250, the server has been reported to disconnect a client if another client 7219 - selects the same folder. 7428 + v12.250, the server has been reported to disconnect a client if another 7429 + client selects the same folder. 7220 7430 </para> 7221 7431 </note> 7222 7432 ··· 7233 7443 <listitem> 7234 7444 7235 7445 <para> 7236 - In lieu of file permissions, Mutt displays the string <quote>IMAP</quote>, 7237 - possibly followed by the symbol <quote>+</quote>, indicating 7238 - that the entry contains both messages and subfolders. On 7446 + In lieu of file permissions, Mutt displays the string 7447 + <quote>IMAP</quote>, possibly followed by the symbol <quote>+</quote>, 7448 + indicating that the entry contains both messages and subfolders. On 7239 7449 Cyrus-like servers folders will often contain both messages and 7240 7450 subfolders. 7241 7451 </para> ··· 7243 7453 <listitem> 7244 7454 7245 7455 <para> 7246 - For the case where an entry can contain both messages and 7247 - subfolders, the selection key (bound to <literal>enter</literal> by default) 7248 - will choose to descend into the subfolder view. If you wish to view 7249 - the messages in that folder, you must use <literal>view-file</literal> instead 7250 - (bound to <literal>space</literal> by default). 7456 + For the case where an entry can contain both messages and subfolders, 7457 + the selection key (bound to <literal>enter</literal> by default) will 7458 + choose to descend into the subfolder view. If you wish to view the 7459 + messages in that folder, you must use <literal>view-file</literal> 7460 + instead (bound to <literal>space</literal> by default). 7251 7461 </para> 7252 7462 </listitem> 7253 7463 <listitem> 7254 7464 7255 7465 <para> 7256 7466 You can create, delete and rename mailboxes with the 7257 - <literal>&lt;create-mailbox&gt;</literal>, <literal>&lt;delete-mailbox&gt;</literal>, and 7258 - <literal>&lt;rename-mailbox&gt;</literal> commands (default bindings: <literal>C</literal>, 7259 - <literal>d</literal> and <literal>r</literal>, respectively). You may also 7260 - <literal>&lt;subscribe&gt;</literal> and <literal>&lt;unsubscribe&gt;</literal> to mailboxes (normally 7261 - these are bound to <literal>s</literal> and <literal>u</literal>, respectively). 7467 + <literal>&lt;create-mailbox&gt;</literal>, 7468 + <literal>&lt;delete-mailbox&gt;</literal>, and 7469 + <literal>&lt;rename-mailbox&gt;</literal> commands (default bindings: 7470 + <literal>C</literal>, <literal>d</literal> and <literal>r</literal>, 7471 + respectively). You may also <literal>&lt;subscribe&gt;</literal> and 7472 + <literal>&lt;unsubscribe&gt;</literal> to mailboxes (normally these are 7473 + bound to <literal>s</literal> and <literal>u</literal>, respectively). 7262 7474 </para> 7263 7475 </listitem> 7264 7476 ··· 7273 7485 Mutt supports four authentication methods with IMAP servers: SASL, 7274 7486 GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add 7275 7487 NTLM authentication for you poor exchange users out there, but it has 7276 - yet to be integrated into the main tree). There is also support for 7277 - the pseudo-protocol ANONYMOUS, which allows you to log in to a public 7278 - IMAP server without having an account. To use ANONYMOUS, simply make 7279 - your username blank or <quote>anonymous</quote>. 7488 + yet to be integrated into the main tree). There is also support for the 7489 + pseudo-protocol ANONYMOUS, which allows you to log in to a public IMAP 7490 + server without having an account. To use ANONYMOUS, simply make your 7491 + username blank or <quote>anonymous</quote>. 7280 7492 </para> 7281 7493 7282 7494 <para> 7283 - SASL is a special super-authenticator, which selects among several protocols 7284 - (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most secure 7285 - method available on your host and the server. Using some of these methods 7286 - (including DIGEST-MD5 and possibly GSSAPI), your entire session will be 7287 - encrypted and invisible to those teeming network snoops. It is the best 7288 - option if you have it. To use it, you must have the Cyrus SASL library 7289 - installed on your system and compile Mutt with the <emphasis>--with-sasl</emphasis> flag. 7495 + SASL is a special super-authenticator, which selects among several 7496 + protocols (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the 7497 + most secure method available on your host and the server. Using some of 7498 + these methods (including DIGEST-MD5 and possibly GSSAPI), your entire 7499 + session will be encrypted and invisible to those teeming network 7500 + snoops. It is the best option if you have it. To use it, you must have 7501 + the Cyrus SASL library installed on your system and compile Mutt with 7502 + the <emphasis>--with-sasl</emphasis> flag. 7290 7503 </para> 7291 7504 7292 7505 <para> 7293 - Mutt will try whichever methods are compiled in and available on the server, 7294 - in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN. 7506 + Mutt will try whichever methods are compiled in and available on the 7507 + server, in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, 7508 + LOGIN. 7295 7509 </para> 7296 7510 7297 7511 <para> ··· 7302 7516 <listitem> 7303 7517 7304 7518 <para> 7305 - <link linkend="imap-user">$imap_user</link> - controls 7306 - the username under which you request authentication on the IMAP server, 7307 - for all authenticators. This is overridden by an explicit username in 7308 - the mailbox path (ie by using a mailbox name of the form 7519 + <link linkend="imap-user">$imap_user</link> - controls the username 7520 + under which you request authentication on the IMAP server, for all 7521 + authenticators. This is overridden by an explicit username in the 7522 + mailbox path (ie by using a mailbox name of the form 7309 7523 <literal>{user@host}</literal>). 7310 7524 </para> 7311 7525 </listitem> 7312 7526 <listitem> 7313 7527 7314 7528 <para> 7315 - <link linkend="imap-pass">$imap_pass</link> - a 7316 - password which you may preset, used by all authentication methods where 7317 - a password is needed. 7529 + <link linkend="imap-pass">$imap_pass</link> - a password which you may 7530 + preset, used by all authentication methods where a password is needed. 7318 7531 </para> 7319 7532 </listitem> 7320 7533 <listitem> 7321 7534 7322 7535 <para> 7323 - <link linkend="imap-authenticators">$imap_authenticators</link> - a colon-delimited list of IMAP 7324 - authentication methods to try, in the order you wish to try them. If 7325 - specified, this overrides Mutt's default (attempt everything, in the order 7326 - listed above). 7536 + <link linkend="imap-authenticators">$imap_authenticators</link> - a 7537 + colon-delimited list of IMAP authentication methods to try, in the order 7538 + you wish to try them. If specified, this overrides Mutt's default 7539 + (attempt everything, in the order listed above). 7327 7540 </para> 7328 7541 </listitem> 7329 7542 ··· 7343 7556 </para> 7344 7557 7345 7558 <para> 7346 - If the configuration variable 7347 - <link linkend="smtp-url">$smtp_url</link> is set, Mutt 7348 - will contact the given SMTP server to deliver messages; if it is unset, 7349 - Mutt will use the program specified by <link linkend="sendmail">$sendmail</link>. 7559 + If the configuration variable <link linkend="smtp-url">$smtp_url</link> 7560 + is set, Mutt will contact the given SMTP server to deliver messages; if 7561 + it is unset, Mutt will use the program specified by <link 7562 + linkend="sendmail">$sendmail</link>. 7350 7563 </para> 7351 7564 7352 7565 <para> ··· 7354 7567 </para> 7355 7568 7356 7569 <para> 7357 - The built-in SMTP support supports encryption (the <literal>smtps</literal> protocol 7358 - using SSL or TLS) as well as SMTP authentication using SASL. The authentication mechanisms 7359 - for SASL are specified in <link linkend="smtp-authenticators">$smtp_authenticators</link> 7360 - defaulting to an empty list which makes Mutt try all available methods 7361 - from most-secure to least-secure. 7570 + The built-in SMTP support supports encryption (the 7571 + <literal>smtps</literal> protocol using SSL or TLS) as well as SMTP 7572 + authentication using SASL. The authentication mechanisms for SASL are 7573 + specified in <link 7574 + linkend="smtp-authenticators">$smtp_authenticators</link> defaulting to 7575 + an empty list which makes Mutt try all available methods from 7576 + most-secure to least-secure. 7362 7577 </para> 7363 7578 7364 7579 </sect1> ··· 7381 7596 </cmdsynopsis> 7382 7597 7383 7598 <para> 7384 - If you happen to have accounts on multiple IMAP, POP and/or SMTP servers, 7385 - you may find managing all the authentication settings inconvenient and 7386 - error-prone. The <link linkend="account-hook"><command>account-hook</command></link> command may help. This hook works like 7387 - <link linkend="folder-hook"><command>folder-hook</command></link> but is invoked whenever Mutt needs to access a remote mailbox 7388 - (including inside the folder browser), not just when you open the 7389 - mailbox. This includes (for example) polling for new mail, storing Fcc 7390 - messages and saving messages to a folder. As a consequence, 7391 - <link linkend="account-hook"><command>account-hook</command></link> should only be used to set connection-related settings such 7392 - as passwords or tunnel commands but not settings such as sender 7393 - address or name (because in general it should be considered unpredictable 7394 - which <link linkend="account-hook"><command>account-hook</command></link> was last used). 7599 + If you happen to have accounts on multiple IMAP, POP and/or SMTP 7600 + servers, you may find managing all the authentication settings 7601 + inconvenient and error-prone. The <link 7602 + linkend="account-hook"><command>account-hook</command></link> command 7603 + may help. This hook works like <link 7604 + linkend="folder-hook"><command>folder-hook</command></link> but is 7605 + invoked whenever Mutt needs to access a remote mailbox (including inside 7606 + the folder browser), not just when you open the mailbox. This includes 7607 + (for example) polling for new mail, storing Fcc messages and saving 7608 + messages to a folder. As a consequence, <link 7609 + linkend="account-hook"><command>account-hook</command></link> should 7610 + only be used to set connection-related settings such as passwords or 7611 + tunnel commands but not settings such as sender address or name (because 7612 + in general it should be considered unpredictable which <link 7613 + linkend="account-hook"><command>account-hook</command></link> was last 7614 + used). 7395 7615 </para> 7396 7616 7397 7617 <para> ··· 7406 7626 </screen> 7407 7627 7408 7628 <para> 7409 - To manage multiple accounts with, for example, different values of 7410 - <link linkend="record">$record</link> or sender addresses, 7411 - <link linkend="folder-hook"><command>folder-hook</command></link> 7412 - has to be be used together with 7413 - the <link linkend="mailboxes"><command>mailboxes</command></link> command. 7629 + To manage multiple accounts with, for example, different values of <link 7630 + linkend="record">$record</link> or sender addresses, <link 7631 + linkend="folder-hook"><command>folder-hook</command></link> has to be be 7632 + used together with the <link 7633 + linkend="mailboxes"><command>mailboxes</command></link> command. 7414 7634 </para> 7415 7635 7416 7636 <example id="ex-multiaccount"> ··· 7425 7645 </example> 7426 7646 7427 7647 <para> 7428 - In example 7429 - <xref linkend="ex-multiaccount"/> the folders are defined using 7430 - <link linkend="mailboxes"><command>mailboxes</command></link> so Mutt polls them for new 7431 - mail. Each <link linkend="folder-hook"><command>folder-hook</command></link> triggers when 7432 - one mailbox below each IMAP account is opened and sets 7433 - <link linkend="folder">$folder</link> to the account's root 7434 - folder. Next, it sets <link linkend="record">$record</link> to 7435 - the <emphasis>INBOX/Sent</emphasis> folder below the newly 7436 - set <link linkend="folder">$folder</link>. Please notice that the 7437 - value the <quote>+</quote> 7438 - <link linkend="shortcuts">mailbox shortcut</link> refers to depends on 7439 - the <emphasis>current</emphasis> value 7440 - of <link linkend="folder">$folder</link> and therefore has to be set 7441 - separatedly per account. Setting other values 7442 - like <link linkend="from">$from</link> 7648 + In example <xref linkend="ex-multiaccount"/> the folders are defined 7649 + using <link linkend="mailboxes"><command>mailboxes</command></link> so 7650 + Mutt polls them for new mail. Each <link 7651 + linkend="folder-hook"><command>folder-hook</command></link> triggers 7652 + when one mailbox below each IMAP account is opened and sets <link 7653 + linkend="folder">$folder</link> to the account's root folder. Next, it 7654 + sets <link linkend="record">$record</link> to the 7655 + <emphasis>INBOX/Sent</emphasis> folder below the newly set <link 7656 + linkend="folder">$folder</link>. Please notice that the value the 7657 + <quote>+</quote> <link linkend="shortcuts">mailbox shortcut</link> 7658 + refers to depends on the <emphasis>current</emphasis> value of <link 7659 + linkend="folder">$folder</link> and therefore has to be set separatedly 7660 + per account. Setting other values like <link linkend="from">$from</link> 7443 7661 or <link linkend="signature">$signature</link> is analogous to setting 7444 7662 <link linkend="record">$record</link>. 7445 7663 </para> ··· 7450 7668 <title>Local Caching</title> 7451 7669 7452 7670 <para> 7453 - Mutt contains two types of local caching: <emphasis>(1)</emphasis> 7454 - the so-called <quote>header caching</quote> and <emphasis>(2)</emphasis> the 7455 - so-called <quote>body caching</quote> which are both described in this section. 7671 + Mutt contains two types of local caching: <emphasis>(1)</emphasis> the 7672 + so-called <quote>header caching</quote> and <emphasis>(2)</emphasis> the 7673 + so-called <quote>body caching</quote> which are both described in this 7674 + section. 7456 7675 </para> 7457 7676 7458 7677 <para> ··· 7467 7686 <para> 7468 7687 Mutt provides optional support for caching message headers for the 7469 7688 following types of folders: IMAP, POP, Maildir and MH. Header caching 7470 - greatly improves speed because for remote folders, headers 7471 - usually only need to be downloaded once. For Maildir and MH, reading the 7472 - headers from a single file is much faster than looking at possibly 7473 - thousands of single files (since Maildir and MH use one file per message.) 7689 + greatly improves speed because for remote folders, headers usually only 7690 + need to be downloaded once. For Maildir and MH, reading the headers from 7691 + a single file is much faster than looking at possibly thousands of 7692 + single files (since Maildir and MH use one file per message.) 7474 7693 </para> 7475 7694 7476 7695 <para> 7477 7696 Header caching can be enabled via the configure script and the 7478 - <emphasis>--enable-hcache</emphasis> option. It's not turned on 7479 - by default because external database libraries are required: one 7480 - of tokyocabinet, qdbm, gdbm or bdb must be present. 7697 + <emphasis>--enable-hcache</emphasis> option. It's not turned on by 7698 + default because external database libraries are required: one of 7699 + tokyocabinet, qdbm, gdbm or bdb must be present. 7481 7700 </para> 7482 7701 7483 7702 <para> 7484 - If enabled, <link 7485 - linkend="header-cache">$header_cache</link> can be 7486 - used to either point to a file or a directory. If set to point to 7487 - a file, one database file for all folders will be used (which may 7488 - result in lower performance), but one file per folder if it points 7489 - to a directory. 7703 + If enabled, <link linkend="header-cache">$header_cache</link> can be 7704 + used to either point to a file or a directory. If set to point to a 7705 + file, one database file for all folders will be used (which may result 7706 + in lower performance), but one file per folder if it points to a 7707 + directory. 7490 7708 </para> 7491 7709 7492 7710 </sect2> ··· 7502 7720 7503 7721 7504 7722 <para> 7505 - In addition to caching message headers only, Mutt can also cache 7506 - whole message bodies. This results in faster display of messages 7507 - for POP and IMAP folders because messages usually have to be 7508 - downloaded only once. 7723 + In addition to caching message headers only, Mutt can also cache whole 7724 + message bodies. This results in faster display of messages for POP and 7725 + IMAP folders because messages usually have to be downloaded only once. 7509 7726 </para> 7510 7727 7511 7728 <para> 7512 7729 For configuration, the variable <link linkend="message-cachedir" 7513 - >$message_cachedir</link> must point to a 7514 - directory. There, Mutt will create a hierarchy of subdirectories 7515 - named like: <literal>proto:user@hostname</literal> where 7516 - <literal>proto</literal> is either <quote>pop</quote> or <quote>imap.</quote> Within 7517 - there for each folder, Mutt stores messages in single files. 7518 - All files can be removed as needed if the consumed disk space 7519 - becomes an issue as Mutt will silently fetch missing items again. 7730 + >$message_cachedir</link> must point to a directory. There, Mutt will 7731 + create a hierarchy of subdirectories named like: 7732 + <literal>proto:user@hostname</literal> where <literal>proto</literal> is 7733 + either <quote>pop</quote> or <quote>imap.</quote> Within there for each 7734 + folder, Mutt stores messages in single files. All files can be removed 7735 + as needed if the consumed disk space becomes an issue as Mutt will 7736 + silently fetch missing items again. 7520 7737 </para> 7521 7738 7522 7739 </sect2> ··· 7532 7749 </para> 7533 7750 7534 7751 <para> 7535 - For body caches, Mutt can keep the local cache in sync with the 7536 - remote mailbox if the 7537 - <link linkend="message-cache-clean">$message_cache_clean</link> 7538 - variable is set. Cleaning means to remove messages from the cache which 7539 - are no longer present in the mailbox which only happens when other mail 7540 - clients or instances of Mutt using a different body cache location 7541 - delete messages (Mutt itself removes deleted messages from the cache 7542 - when syncing a mailbox). As cleaning can take a noticeable amount of time, 7543 - it should not be set in general but only occasionally. 7752 + For body caches, Mutt can keep the local cache in sync with the remote 7753 + mailbox if the <link 7754 + linkend="message-cache-clean">$message_cache_clean</link> variable is 7755 + set. Cleaning means to remove messages from the cache which are no 7756 + longer present in the mailbox which only happens when other mail clients 7757 + or instances of Mutt using a different body cache location delete 7758 + messages (Mutt itself removes deleted messages from the cache when 7759 + syncing a mailbox). As cleaning can take a noticeable amount of time, it 7760 + should not be set in general but only occasionally. 7544 7761 </para> 7545 7762 7546 7763 </sect2> ··· 7551 7768 <title>Exact Address Generation</title> 7552 7769 7553 7770 <para> 7554 - Mutt supports the <quote>Name &lt;user@host&gt;</quote> address syntax for reading and 7555 - writing messages, the older <quote>user@host (Name)</quote> syntax is only supported when 7556 - reading messages. The <emphasis>--enable-exact-address</emphasis> 7557 - switch can be given to configure to build it with write-support 7558 - for the latter syntax. <literal>EXACT_ADDRESS</literal> in the output of 7559 - <literal>mutt -v</literal> indicates whether it's supported. 7771 + Mutt supports the <quote>Name &lt;user@host&gt;</quote> address syntax 7772 + for reading and writing messages, the older <quote>user@host 7773 + (Name)</quote> syntax is only supported when reading messages. The 7774 + <emphasis>--enable-exact-address</emphasis> switch can be given to 7775 + configure to build it with write-support for the latter 7776 + syntax. <literal>EXACT_ADDRESS</literal> in the output of <literal>mutt 7777 + -v</literal> indicates whether it's supported. 7560 7778 </para> 7561 7779 7562 7780 </sect1> ··· 7579 7797 </para> 7580 7798 7581 7799 <para> 7582 - The chain selection screen is divided into two parts. In the 7583 - (larger) upper part, you get a list of remailers you may use. In 7584 - the lower part, you see the currently selected chain of remailers. 7800 + The chain selection screen is divided into two parts. In the (larger) 7801 + upper part, you get a list of remailers you may use. In the lower part, 7802 + you see the currently selected chain of remailers. 7585 7803 </para> 7586 7804 7587 7805 <para> 7588 - You can navigate in the chain using the <literal>&lt;chain-prev&gt;</literal> and 7589 - <literal>&lt;chain-next&gt;</literal> functions, which are by default bound to the left 7590 - and right arrows and to the <literal>h</literal> and <literal>l</literal> keys (think vi 7591 - keyboard bindings). To insert a remailer at the current chain 7592 - position, use the <literal>&lt;insert&gt;</literal> function. To append a remailer behind 7593 - the current chain position, use <literal>&lt;select-entry&gt;</literal> or <literal>&lt;append&gt;</literal>. 7594 - You can also delete entries from the chain, using the corresponding 7595 - function. Finally, to abandon your changes, leave the menu, or 7596 - <literal>&lt;accept&gt;</literal> them pressing (by default) the <literal>Return</literal> key. 7806 + You can navigate in the chain using the 7807 + <literal>&lt;chain-prev&gt;</literal> and 7808 + <literal>&lt;chain-next&gt;</literal> functions, which are by default 7809 + bound to the left and right arrows and to the <literal>h</literal> and 7810 + <literal>l</literal> keys (think vi keyboard bindings). To insert a 7811 + remailer at the current chain position, use the 7812 + <literal>&lt;insert&gt;</literal> function. To append a remailer behind 7813 + the current chain position, use <literal>&lt;select-entry&gt;</literal> 7814 + or <literal>&lt;append&gt;</literal>. You can also delete entries from 7815 + the chain, using the corresponding function. Finally, to abandon your 7816 + changes, leave the menu, or <literal>&lt;accept&gt;</literal> them 7817 + pressing (by default) the <literal>Return</literal> key. 7597 7818 </para> 7598 7819 7599 7820 <para> 7600 - Note that different remailers do have different capabilities, 7601 - indicated in the %c entry of the remailer menu lines (see 7602 - <link linkend="mix-entry-format">$mix_entry_format</link>). Most important is 7603 - the <quote>middleman</quote> capability, indicated by a capital <quote>M</quote>: This 7604 - means that the remailer in question cannot be used as the final 7605 - element of a chain, but will only forward messages to other 7606 - mixmaster remailers. For details on the other capabilities, please 7607 - have a look at the mixmaster documentation. 7821 + Note that different remailers do have different capabilities, indicated 7822 + in the %c entry of the remailer menu lines (see <link 7823 + linkend="mix-entry-format">$mix_entry_format</link>). Most important is 7824 + the <quote>middleman</quote> capability, indicated by a capital 7825 + <quote>M</quote>: This means that the remailer in question cannot be 7826 + used as the final element of a chain, but will only forward messages to 7827 + other mixmaster remailers. For details on the other capabilities, 7828 + please have a look at the mixmaster documentation. 7608 7829 </para> 7609 7830 7610 7831 </sect1> ··· 7668 7889 with every message sent. In a longer running mutt session, others can 7669 7890 make assumptions about your mailing habbits depending on the number of 7670 7891 messages sent. If this is not desired, the header can be manually 7671 - provided using <link 7672 - linkend="edit-headers">$edit_headers</link> (though not 7673 - recommended). 7892 + provided using <link linkend="edit-headers">$edit_headers</link> (though 7893 + not recommended). 7674 7894 </para> 7675 7895 7676 7896 </sect2> ··· 7749 7969 7750 7970 <listitem> 7751 7971 <para> 7752 - For remote folders (IMAP and POP) as well as folders using 7753 - one-file-per message storage (Maildir and MH), Mutt's 7754 - performance can be greatly improved using 7755 - <link linkend="header-caching">header caching</link>. 7972 + For remote folders (IMAP and POP) as well as folders using one-file-per 7973 + message storage (Maildir and MH), Mutt's performance can be greatly 7974 + improved using <link linkend="header-caching">header caching</link>. 7756 7975 using a single database per folder. 7757 7976 </para> 7758 7977 </listitem> 7759 7978 7760 7979 <listitem> 7761 7980 <para> 7762 - Mutt provides the <link linkend="read-inc">$read_inc</link> 7763 - and <link linkend="write-inc">$write_inc</link> 7764 - variables to specify at which rate to update progress 7765 - counters. If these values are too low, Mutt may spend more 7766 - time on updating the progress counter than it spends on 7767 - actually reading/writing folders. 7981 + Mutt provides the <link linkend="read-inc">$read_inc</link> and <link 7982 + linkend="write-inc">$write_inc</link> variables to specify at which rate 7983 + to update progress counters. If these values are too low, Mutt may spend 7984 + more time on updating the progress counter than it spends on actually 7985 + reading/writing folders. 7768 7986 </para> 7987 + 7769 7988 <para> 7770 - For example, when opening a maildir folder with a few 7771 - thousand messages, the default value for 7772 - <link linkend="read-inc">$read_inc</link> 7773 - may be too low. It can be tuned on on a folder-basis using 7774 - <link linkend="folder-hook"><command>folder-hook</command>s</link>: 7989 + For example, when opening a maildir folder with a few thousand messages, 7990 + the default value for <link linkend="read-inc">$read_inc</link> may be 7991 + too low. It can be tuned on on a folder-basis using <link 7992 + linkend="folder-hook"><command>folder-hook</command>s</link>: 7775 7993 </para> 7776 7994 7777 7995 <screen> ··· 7785 8003 </listitem> 7786 8004 </orderedlist> 7787 8005 7788 - <para>These settings work on a per-message basis. However, as messages may 7789 - greatly differ in size and certain operations are much faster than others, 7790 - even per-folder settings of the increment variables may not be 8006 + <para> 8007 + These settings work on a per-message basis. However, as messages may 8008 + greatly differ in size and certain operations are much faster than 8009 + others, even per-folder settings of the increment variables may not be 7791 8010 desirable as they produce either too few or too much progress updates. 7792 - Thus, Mutt allows to limit the number of progress updates per second it'll 7793 - actually send to the terminal using the 7794 - <link linkend="time-inc">$time_inc</link> variable.</para> 8011 + Thus, Mutt allows to limit the number of progress updates per second 8012 + it'll actually send to the terminal using the <link 8013 + linkend="time-inc">$time_inc</link> variable. 8014 + </para> 7795 8015 7796 8016 </sect1> 7797 8017 ··· 7799 8019 <title>Reading Messages from Remote Folders</title> 7800 8020 7801 8021 <para> 7802 - Reading messages from remote folders such as IMAP an POP can be 7803 - slow especially for large mailboxes since Mutt only caches a very 7804 - limited number of recently viewed messages (usually 10) per 7805 - session (so that it will be gone for the next session.) 8022 + Reading messages from remote folders such as IMAP an POP can be slow 8023 + especially for large mailboxes since Mutt only caches a very limited 8024 + number of recently viewed messages (usually 10) per session (so that it 8025 + will be gone for the next session.) 7806 8026 </para> 7807 8027 7808 8028 <para> 7809 - To improve performance and permanently cache whole messages, 7810 - please refer to Mutt's so-called 7811 - <link linkend="body-caching">body caching</link> for details. 8029 + To improve performance and permanently cache whole messages, please 8030 + refer to Mutt's so-called <link linkend="body-caching">body 8031 + caching</link> for details. 7812 8032 </para> 7813 8033 7814 8034 </sect1> ··· 7817 8037 <title>Searching and Limiting</title> 7818 8038 7819 8039 <para> 7820 - When searching mailboxes either via a search or a limit action, for 7821 - some patterns Mutt distinguishes between regular expression and string 8040 + When searching mailboxes either via a search or a limit action, for some 8041 + patterns Mutt distinguishes between regular expression and string 7822 8042 searches. For regular expressions, patterns are prefixed with 7823 - <quote>#</quote> and with <quote>=</quote> for string searches. 8043 + <quote>~</quote> and with <quote>=</quote> for string searches. 7824 8044 </para> 7825 8045 7826 8046 <para> ··· 7835 8055 For example, when limiting a large folder to all messages sent to or by 7836 8056 an author, it's much faster to search for the initial part of an e-mail 7837 8057 address via <literal>=Luser@</literal> instead of 7838 - <literal>#Luser@</literal>. This is especially true for searching 8058 + <literal>~Luser@</literal>. This is especially true for searching 7839 8059 message bodies since a larger amount of input has to be searched. 7840 8060 </para> 7841 8061 7842 8062 <para> 7843 8063 As for regular expressions, a lower case string search pattern makes 7844 8064 Mutt perform a case-insensitive search except for IMAP (because for IMAP 7845 - Mutt performs server-side searches which don't support case-insensivity). 8065 + Mutt performs server-side searches which don't support 8066 + case-insensivity). 7846 8067 </para> 7847 8068 7848 8069 </sect1> ··· 7856 8077 <title>Command-Line Options</title> 7857 8078 7858 8079 <para> 7859 - Running <literal>mutt</literal> with no arguments will make Mutt attempt to read your spool 7860 - mailbox. However, it is possible to read other mailboxes and 7861 - to send messages from the command line as well. 8080 + Running <literal>mutt</literal> with no arguments will make Mutt attempt 8081 + to read your spool mailbox. However, it is possible to read other 8082 + mailboxes and to send messages from the command line as well. 7862 8083 </para> 7863 8084 7864 8085 <table id="tab-commandline-options"> ··· 7943 8164 </cmdsynopsis> 7944 8165 7945 8166 <para> 7946 - Mutt also supports a <quote>batch</quote> mode to send prepared messages. Simply redirect 7947 - input from the file you wish to send. For example, 8167 + Mutt also supports a <quote>batch</quote> mode to send prepared 8168 + messages. Simply redirect input from the file you wish to send. For 8169 + example, 7948 8170 </para> 7949 8171 7950 8172 <screen> 7951 - mutt -s "data set for run #2" professor@bigschool.edu &lt; #/run2.dat</screen> 8173 + mutt -s "data set for run #2" professor@bigschool.edu &lt; ~/run2.dat</screen> 7952 8174 7953 8175 <para> 7954 - will send a message to <literal>&lt;professor@bigschool.edu&gt;</literal> with a subject 7955 - of <quote>data set for run #2</quote>. In the body of the message will be the contents 7956 - of the file <quote>#/run2.dat</quote>. 8176 + will send a message to 8177 + <literal>&lt;professor@bigschool.edu&gt;</literal> with a subject of 8178 + <quote>data set for run #2</quote>. In the body of the message will be 8179 + the contents of the file <quote>~/run2.dat</quote>. 7957 8180 </para> 7958 8181 7959 8182 <para> 7960 - All files passed with <literal>-a</literal> <emphasis>file</emphasis> will be attached as a MIME 7961 - part to the message. To attach a single or several files, use <quote>--</quote> to separate files and 7962 - recipient addresses: 8183 + All files passed with <literal>-a</literal> <emphasis>file</emphasis> 8184 + will be attached as a MIME part to the message. To attach a single or 8185 + several files, use <quote>--</quote> to separate files and recipient 8186 + addresses: 7963 8187 </para> 7964 8188 7965 8189 <screen>
+6 -8
doc/manual.xml.tail
··· 36 36 <title>Acknowledgements</title> 37 37 38 38 <para> 39 - Kari Hurtta <email>kari.hurtta@fmi.fi</email> 40 - co-developed the original MIME parsing code back in the ELM-ME days. 39 + Kari Hurtta <email>kari.hurtta@fmi.fi</email> co-developed the original 40 + MIME parsing code back in the ELM-ME days. 41 41 </para> 42 42 43 43 <para> ··· 95 95 <title>About This Document</title> 96 96 97 97 <para> 98 - This document was written in <ulink url="http://docbook.sourceforge.net">DocBook</ulink>, 99 - and then rendered using the <ulink url="http://xmlsoft.org/XSLT/">Gnome XSLT toolkit</ulink>. 98 + This document was written in <ulink 99 + url="http://docbook.sourceforge.net">DocBook</ulink>, and then rendered 100 + using the <ulink url="http://xmlsoft.org/XSLT/">Gnome XSLT 101 + toolkit</ulink>. 100 102 </para> 101 103 102 104 </sect1> ··· 104 106 </chapter> 105 107 106 108 </book> 107 - 108 - <!-- 109 - vim:ft=xml 110 - -->