diff options
| author | Thomas Roessler <roessler@does-not-exist.org> | 1999-08-24 15:35:25 +0000 |
|---|---|---|
| committer | Thomas Roessler <roessler@does-not-exist.org> | 1999-08-24 15:35:25 +0000 |
| commit | 1e245ea2f27cf4fec65e5ee330511f35f4ab0beb (patch) | |
| tree | 9daf727f24e0373c947666efc984f96906aeadf4 /doc | |
| parent | f903172e50b896b1ffd5577aca6998d8db4c5d78 (diff) | |
Remove some auto-built files from the repository.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual.sgml | 5460 | ||||
| -rw-r--r-- | doc/muttrc.man | 3281 |
2 files changed, 0 insertions, 8741 deletions
diff --git a/doc/manual.sgml b/doc/manual.sgml deleted file mode 100644 index 54f5e400..00000000 --- a/doc/manual.sgml +++ /dev/null @@ -1,5460 +0,0 @@ -<!doctype linuxdoc system> - -<article> - -<title>The Mutt E-Mail Client -<author>by Michael Elkins <htmlurl url="mailto:me@cs.hmc.edu" name="<me@cs.hmc.edu>"> -<date>version 0.96.4 -<abstract> -``All mail clients suck. This one just sucks less.'' -me, circa 1995 -</abstract> - -<sect>Introduction -<p> -<bf/Mutt/ is a small but very powerful text-based MIME mail client. Mutt is -highly configurable, and is well suited to the mail power user with advanced -features like key bindings, keyboard macros, mail threading, regular -expression searches and a powerful pattern matching language for selecting -groups of messages. - -<sect1>Mutt Home Page -<p> -<htmlurl url="http://www.mutt.org/" -name="http://www.mutt.org/"> - -<sect1>Mailing Lists -<p> -To subscribe to one of the following mailing lists, send a message with the -word <em/subscribe/ in the subject to -<tt/list-name/<em/-request/<tt/@mutt.org/. - -<itemize> -<item><htmlurl url="mailto:mutt-announce-request@mutt.org" -name="mutt-announce@mutt.org"> -- low traffic list for announcements -<item><htmlurl url="mailto:mutt-users-request@mutt.org" -name="mutt-users@mutt.org"> -- help, bug reports and feature requests -<item><htmlurl url="mailto:mutt-dev-request@mutt.org" name="mutt-dev@mutt.org"> -- development mailing list -</itemize> - -<bf/Note:/ all messages posted to <em/mutt-announce/ are automatically -forwarded to <em/mutt-users/, so you do not need to be subscribed to both -lists. - -<sect1>Software Distribution Sites -<p> -<itemize> -<item><htmlurl url="ftp://ftp.guug.de/pub/mutt/" -name="ftp://ftp.guug.de/pub/mutt/"> -</itemize> - -<sect1>IRC -<p> -Visit channel <em/#mutt/ on <htmlurl url="http://www.dal.net" name="DALnet -(www.dal.net)"> to chat with other people interested in Mutt. - -<sect1>USENET -<p> -See the newsgroup <htmlurl url="news:comp.mail.mutt" name="comp.mail.mutt">. - -<sect1>Copyright -<p> -Mutt is Copyright (C) 1996-8 Michael R. Elkins <me@cs.hmc.edu> - -This program is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - -<sect>Getting Started -<p> - -This section is intended as a brief overview of how to use Mutt. There are -many other features which are described elsewhere in the manual. There -is even more information available in the Mutt FAQ and various web -pages. See the <htmlurl url="http://www.mutt.org/mutt/" -name="Mutt Page"> for more details. - -The keybindings described in this section are the defaults as distributed. -Your local system administrator may have altered the defaults for your site. -You can always type ``?'' in any menu to display the current bindings. - -The first thing you need to do is invoke mutt, simply by typing mutt -at the command line. There are various command-line options, see -either the mutt man page or the <ref id="commandline" name="reference">. - -<sect1>Moving Around in Menus -<p> - -Information is presented in menus, very similar to ELM. Here is a table -showing the common keys used to navigate menus in Mutt. - -<tscreen><verb> -j or Down next-entry move to the next entry -k or Up previous-entry move to the previous entry -z or PageDn page-down go to the next page -Z or PageUp page-up go to the previous page -= or Home first-entry jump to the first entry -* or End last-entry jump to the last entry -q quit exit the current menu -? help list all keybindings for the current menu -</verb></tscreen> - -<sect1>Editing Input Fields<label id="editing"> -<p> -Mutt has a builtin line editor which is used as the primary way to input -textual data such as email addresses or filenames. The keys used to move -around while editing are very similar to those of Emacs. - -<tscreen><verb> -^A or <Home> bol move to the start of the line -^B or <Left> backward-char move back one char -^D or <Delete> delete-char delete the char under the cursor -^E or <End> eol move to the end of the line -^F or <Right> forward-char move forward one char -^K kill-eol delete to the end of the line -^U kill-line delete entire line -^W kill-word kill the word in front of the cursor -<Up> history-up recall previous string from history -<Down> history-down recall next string from history -<BackSpace> backspace kill the char in front of the cursor -^G n/a abort -<Tab> n/a complete filename (only when prompting for a file) -<Return> n/a finish editing -</verb></tscreen> - -You can remap the <em/editor/ functions using the <ref id="bind" name="bind"> -command. For example, to make the <em/Delete/ key delete the character in -front of the cursor rather than under, you could use - -<tt/bind editor <delete> backspace/ - -<sect1>Reading Mail - The Index and Pager -<p> - -Similar to many other mail clients, there are two modes in which mail is -read in Mutt. The first is the index of messages in the mailbox, which is -called the ``index'' in Mutt. The second mode is the display of the -message contents. This is called the ``pager.'' - -The next few sections describe the functions provided in each of these -modes. - -<sect2>The Message Index -<p> - -<tscreen><verb> -c change to a different mailbox -ESC c change to a folder in read-only mode -C copy the current message to another mailbox -ESC C decode a message and copy it to a folder -ESC s decode a message and save it to a folder -D delete messages matching a pattern -d delete the current message -F mark as important -l show messages matching a pattern -N mark message as new -o change the current sort method -O reverse sort the mailbox -q save changes and exit -s save-message -t toggle the tag on a message -ESC t toggle tag on entire message thread -u undelete-message -v view-attachments -x abort changes and exit -<Return> display-message -<Tab> jump to the next new message -@ show the author's full e-mail address -$ save changes to mailbox -/ search -ESC / search-reverse -^L clear and redraw the screen -^T tag messages matching a pattern -^U undelete messages matching a pattern -</verb></tscreen> - -<sect3>Status Flags -<p> - -In addition to who sent the message and the subject, a short summary of -the disposition of each message is printed beside the message number. -Zero or more of the following ``flags'' may appear, which mean: - -<p> -<tscreen><verb> -D message is deleted -K contains a PGP public key -M requires mailcap to view -N message is new -O message is old -P message is PGP encrypted -r message has been replied to -S message is PGP signed -! message is flagged -* message is tagged -</verb></tscreen> - -Some of the status flags can be turned on or off using -<itemize> -<item><bf/set-flag/ (default: w) -<item><bf/clear-flag/ (default: W) -</itemize> - -<p> -Furthermore, the following flags reflect who the message is addressed -to. They can be customized with the -<ref id="to_chars" name="$to_chars"> variable. - -<p> -<tscreen><verb> -+ message is to you and you only -T message is to you, but also to or cc'ed to others -C message is cc'ed to you -F message is from you -</verb></tscreen> - -<sect2>The Pager -<p> - -By default, Mutt uses its builtin pager to display the body of messages. -The pager is very similar to the Unix program <em/less/ though not nearly as -featureful. - -<tscreen><verb> -<Return> go down one line -<Space> display the next page (or next message if at the end of a message) -- go back to the previous page -n display the next message -? show keybindings -/ search for a regular expression (pattern) -\ toggle search pattern coloring -</verb></tscreen> - -In addition, many of the functions from the <em/index/ are available in -the pager, such as <em/delete-message/ or <em/copy-message/ (this is one -advantage over using an external pager to view messages). - -Also, the internal pager supports a couple other advanced features. For -one, it will accept and translate the ``standard'' nroff sequences for -bold and underline. These sequences are a series of either the letter, -backspace (^H), the letter again for bold or the letter, backspace, -``_'' for denoting underline. Mutt will attempt to display these -in bold and underline respectively if your terminal supports them. If -not, you can use the bold and underline <ref id="color" name="color"> -objects to specify a color or mono attribute for them. - -Additionally, the internal pager supports the ANSI escape sequences for -character attributes. Mutt translates them into the correct color and -character settings. The sequences Mutt supports are: - -<p> -<tscreen><verb> -ESC [ Ps;Ps;Ps;...;Ps m -where Ps = -0 All Attributes Off -1 Bold on -4 Underline on -5 Blink on -7 Reverse video on -3x Foreground color is x -4x Background color is x - -Colors are -0 black -1 red -2 green -3 yellow -4 blue -5 magenta -6 cyan -7 white -</verb></tscreen> - -Mutt uses these attributes for handling text/enriched messages, and they -can also be used by an external <ref id="auto_view" name="autoview"> -script for highlighting purposes. <bf/Note:/ If you change the colors for your -display, for example by changing the color associated with color2 for -your xterm, then that color will be used instead of green. - -<sect2>Threaded Mode<label id="threads"> -<p> -When the mailbox is <ref id="sort" name="sorted"> by <em/threads/, there are -a few additional functions available in the <em/index/ and <em/pager/ modes. - -<tscreen><verb> -^D delete-thread delete all messages in the current thread -^U undelete-thread undelete all messages in the current thread -^N next-thread jump to the start of the next thread -^P previous-thread jump to the start of the previous thread -^R read-thread mark the current thread as read -ESC d delete-subthread delete all messages in the current subthread -ESC u undelete-subthread undelete all messages in the current subthread -ESC n next-subthread jump to the start of the next subthread -ESC p previous-subthread jump to the start of the previous subthread -ESC r read-subthread mark the current subthread as read -ESC t tag-thread toggle the tag on the current thread -ESC v collapse-thread toggle collapse for the current thread -ESC V collapse-all toggle collapse for all threads -</verb></tscreen> - -<bf/Note:/ Collapsing a thread displays only the first message -in the thread and hides the others. This is useful when threads -contain so many messages that you can only see a handful of threads on -the screen. See %M in <ref id="index_format"name="$index_format">. -For example, you could use "%?M?(#%03M)&(%4l)?" in <ref -id="index_format"name="$index_format"> to optionally -display the number of hidden messages if the thread is collapsed. - -See also: <ref id="strict_threads" name="$strict_threads">. - -<sect2>Miscellaneous Functions -<p><bf/create-alias/<label id="create-alias"> (default: a)<newline> - -Creates a new alias based upon the current message (or prompts for a -new one). Once editing is complete, an <ref id="alias" name="alias"> -command is added to the file specified by the <ref id="alias_file" -name="$alias_file"> variable for future use. <bf/Note:/ -Specifying an <ref id="alias_file" name="$alias_file"> -does not add the aliases specified there-in, you must also <ref -id="source" name="source"> the file. - -<p><bf/display-headers/<label id="display-headers"> (default: h)<newline> - -Toggles the weeding of message header fields specified by <ref id="ignore" -name="ignore"> commands. - -<p><bf/edit/<label id="edit-messaage"> (default: e)<newline> - -This command (available in the ``index'' and ``pager'') allows you to -edit the current message. Once editing is complete, the <em/Compose/ menu -is shown. You can now re-send the message or write the edited message -to any folder using the ``write-fcc'' function. - -<p><bf/enter-command/<label id="enter-command"> (default: ``:'')<newline> - -This command is used to execute any command you would normally put in a -configuration file. A common use is to check the settings of variables, or -in conjunction with <ref id="macro" name="macros"> to change settings on the -fly. - -<p><bf/extract-keys/<label id="extract-keys"> (default: ^K)<newline> - -This command extracts PGP public keys from the current or tagged -message(s) and adds them to your PGP public key ring. - -<p><bf/forget-passphrase/<label id="forget-passphrase"> (default: -^F)<newline> - -This command wipes the PGP passphrase from memory. It is useful, if -you misspelled the passphrase. - -<p><bf/list-reply/<label id="list-reply"> (default: L)<newline> - -Reply to the current or tagged message(s) by extracting any addresses which -match the addresses given by the <ref id="lists" name="lists"> command. -Using this when replying to messages posted to mailing lists help avoid -duplicate copies being sent to the author of the message you are replying -to. - -<bf/pipe-message/<label id="pipe-message"> (default: |)<newline> - -Asks for an external Unix command and pipes the current or -tagged message(s) to it. The variables <ref id="pipe_decode" -name="$pipe_decode">, <ref id="pipe_split" -name="$pipe_split">, <ref id="pipe_sep" -name="$pipe_sep"> and <ref id="wait_key" -name="$wait_key"> control the exact behaviour of this -function. - -<bf/shell-escape/<label id="shell-escape"> (default: !)<newline> - -Asks for an external Unix command and executes it. The <ref -id="wait_key" name="$wait_key"> can be used to control -whether Mutt will wait for a key to be pressed when the command returns -(presumably to let the user read the output of the command), based on -the return status of the named command. - -<bf/toggle-quoted/<label id="toggle-quoted"> (default: T)<newline> - -The <em/pager/ uses the <ref id="quote_regexp" -name="$quote_regexp"> variable to detect quoted text when -displaying the body of the message. This function toggles the display -of the quoted material in the message. It is particularly useful when -are interested in just the response and there is a large amount of -quoted text in the way. - -<bf/skip-quoted/<label id="skip-quoted"> (default: S)<newline> - -This function will go to the next line of non-quoted text which come -after a line of quoted text in the internal pager. - -<sect1>Sending Mail -<p> - -The following bindings are available in the <em/index/ for sending -messages. - -<tscreen><verb> -m compose compose a new message -r reply reply to sender -g group-reply reply to all recipients -L list-reply reply to mailing list address -f forward forward message -b bounce bounce (remail) message -ESC k mail-key mail a PGP public key to someone -</verb></tscreen> - -Bouncing a message sends the message as is to the recipient you -specify. Forwarding a message allows you to add comments or -modify the message you are forwarding. These items are discussed -in greater detail in the next chapter <ref id="forwarding_mail" -name="``Forwarding and Bouncing Mail''">. - -Mutt will then enter the <em/compose/ menu and prompt you for the -recipients to place on the ``To:'' header field. Next, it will ask -you for the ``Subject:'' field for the message, providing a default if -you are replying to or forwarding a message. See also <ref id="askcc" -name="$askcc">, <ref id="askbcc" name="$askbcc">, <ref -id="autoedit" name="$autoedit">, and <ref id="fast_reply" -name="$fast_reply"> for changing how Mutt asks these -questions. - -Mutt will then automatically start your <ref id="editor" -name="$editor"> on the message body. If the <ref id="edit_headers" -name="$edit_headers"> variable is set, the headers will be at -the top of the message in your editor. Any messages you are replying -to will be added in sort order to the message, with appropriate <ref -id="attribution" name="$attribution">, <ref id="indent_string" -name="$indent_string"> and <ref id="post_indent_string" -name="$post_indent_string">. When forwarding a -message, if the <ref id="mime_forward" name="$mime_forward"> -variable is unset, a copy of the forwarded message will be included. If -you have specified a <ref id="signature" name="$signature">, it -will be appended to the message. - -Once you have finished editing the body of your mail message, you are -returned to the <em/compose/ menu. The following options are available: - -<tscreen><verb> -a attach-file attach a file -A attach-message attach message(s) to the message -ESC k attach-key attach a PGP public key -d edit-description edit description on attachment -D detach-file detach a file -T edit-to edit the To field -c edit-cc edit the Cc field -b edit-bcc edit the Bcc field -y send-message send the message -s edit-subject edit the Subject -f edit-fcc specify an ``Fcc'' mailbox -p pgp-menu select PGP options (``i'' version only) -P postpone-message postpone this message until later -q quit quit (abort) sending the message -w write-fcc write the message to a folder -i ispell check spelling (if available on your system) -^F forget-passphrase whipe PGP passphrase from memory -</verb></tscreen> - -<bf/Note:/ The attach-message function will prompt you for a folder to -attach messages from. You can now tag messages in that folder and they -will be attached to the message you are sending. Note that certain -operations like composing a new mail, replying, forwarding, etc. are -not permitted when you are in that folder. The %r in <ref -id="status_format" name="$status_format"> will change to -a 'A' to indicate that you are in attach-message mode. - -<sect2>Editing the message header<label id="edit_headers"> -<p> -When editing the header of your outgoing message, there are a couple of -special features available. - -If you specify<newline> -<tt/Fcc:/ <em/filename/<newline> -Mutt will pick up <em/filename/ -just as if you had used the <em/edit-fcc/ function in the <em/compose/ menu. - -You can also attach files to your message by specifying<newline> -<tt/Attach:/ <em/filename/ [ <em/description/ ]<newline> -where <em/filename/ is the file to attach and <em/description/ is an -optional string to use as the description of the attached file. - -When replying to messages, if you remove the <em/In-Reply-To:/ field from -the header field, Mutt will not generate a <em/References:/ field, which -allows you to create a new message thread. - -Also see <ref id="edit_headers" name="edit_headers">. - -<sect2>Using Mutt with PGP - -<p> -If you want to use PGP, you can specify - -<tt/Pgp:/ [ <tt/E/ | <tt/S/ | <tt/S<id/> ] <newline> - -``E'' encrypts, ``S'' signs and -``S<id>'' signs with the given key, setting <ref -id="pgp_sign_as" name="$pgp_sign_as"> permanently. - -If you have told mutt to PGP encrypt a message, it will guide you -through a key selection process when you try to send the message. -Mutt will not ask you any questions about keys which have a -certified user ID matching one of the message recipients' mail -addresses. However, there may be situations in which there are -several keys, weakly certified user ID fields, or where no matching -keys can be found. - -In these cases, you are dropped into a menu with a list of keys from -which you can select one. When you quit this menu, or mutt can't -find any matching keys, you are prompted for a user ID. You can, as -usually, abort this prompt using <tt/^G/. When you do so, mutt will -return to the compose screen. - -Once you have successfully finished the key selection, the message -will be encrypted using the selected public keys, and sent out. - -Most fields of the entries in the key selection menu (see also <ref -id="pgp_entry_format" name="$pgp_entry_format">) -have obvious meanings. But some explanations on the capabilities, flags, -and validity fields are in order. - -The flags sequence (%f) will expand to one of the following flags: -<tscreen><verb> -R The key has been revoked and can't be used. -X The key is expired and can't be used. -d You have marked the key as disabled. -c There are unknown critical self-signature - packets. -</verb></tscreen> - -The capabilities field (%c) expands to a two-character sequence -representing a key's capabilities. The first character gives -the key's encryption capabilities: A minus sign (<bf/-/) means -that the key cannot be used for encryption. A dot (<bf/./) means that -it's marked as a signature key in one of the user IDs, but may -also be used for encryption. The letter <bf/e/ indicates that -this key can be used for encryption. - -The second character indicates the key's signing capabilities. Once -again, a ``<bf/-/'' implies ``not for signing'', ``<bf/./'' implies -that the key is marked as an encryption key in one of the user-ids, and -``<bf/s/'' denotes a key which can be used for signing. - -Finally, the validity field (%t) indicates how well-certified a user-id -is. A question mark (<bf/?/) indicates undefined validity, a minus -character (<bf/-/) marks an untrusted association, a space character -means a partially trusted association, and a plus character (<bf/+/) -indicates complete validity. - -<sect2>Sending anonymous messages via mixmaster. - -<p> -You may also have configured mutt to co-operate with Mixmaster, an -anonymous remailer. Mixmaster permits you to send your messages -anonymously using a chain of remailers. - -To use it, you'll have to obey certain restrictions. Most -important, you cannot ues the <tt/Cc/ and <tt/Bcc/ headers. To tell -Mutt to use mixmaster, you have to select a remailer chain, using -the mix function on the compose menu. - -The chain selection screen is divided into two parts. In the -(larger) upper part, you get a list of remailers you may use. In -the lower part, you see the currently selected chain of remailers. - -You can navigate in the chain using the <tt/chain-prev/ and -<tt/chain-next/ functions, which are by default bound to the left -and right arrows and to the <tt/h/ and <tt/l/ keys (think vi -keyboard bindings). To insert a remailer at the current chain -position, use the <tt/insert/ function. To append a remailer behind -the current chain position, use <tt/select-entry/ or <tt/append/. -You can also delete entries from the chain, using the corresponding -function. Finally, to abandon your changes, leave the menu, or -<tt/accept/ them pressing (by default) the <tt/Return/ key. - -Note that different remailers do have different capabilities, -indicated in the %c entry of the remailer menu lines (see -<ref id="mix_entry_format" -name="$mix_etry_format">). Most important is -the ``middleman'' capability, indicated by a capital ``M'': This -means that the remailer in question cannot be used as the final -element of a chain, but will only forward messages to other -mixmaster remailers. For details on the other capabilities, please -have a look at the mixmaster documentation. - -<sect1>Forwarding and Bouncing Mail<label id="forwarding_mail"> -<p> - -Bouncing and forwarding let you send an existing message to recipients -that you specify. Bouncing a message uses the <ref id="sendmail" -name="sendmail"> command to send a copy to alternative addresses as if -they were the message's original recipients. Forwarding a message, on -the other hand, allows you to modify the message before it is resent -(for example, by adding your own comments). - -The following keys are bound by default: - -<tscreen><verb> -f forward forward message -b bounce bounce (remail) message -</verb></tscreen> - -Forwarding can be done by including the original message in the new -message's body (surrounded by indicating lines) or including it as a MIME -attachment, depending on the value of the <ref id="mime_forward" -name="$mime_forward"> variable. Decoding of attachments, -like in the pager, can be controlled by the <ref id="forward_decode" -name="$forward_decode"> and <ref id="mime_forward_decode" -name="$mime_forward_decode"> variables, -respectively. The desired forwarding format may depend on the content, -therefore <em/$mime_forward/ is a quadoption which, for -example, can be set to ``ask-no''. - -The inclusion of headers is controlled by the current setting of the -<ref id="weed" name="$weed"> variable, unless <ref -id="mime_forward" name="mime_forward"> is set. - -Editing the message to forward follows the same procedure as sending or -replying to a message does. - -<sect1>Postponing Mail<label id="postponing_mail"> -<p> - -At times it is desirable to delay sending a message that you have -already begun to compose. When the <em/postpone-message/ function is -used in the <em/compose/ menu, the body of your message and attachments -are stored in the mailbox specified by the <ref id="postponed" -name="$postponed"> variable. This means that you can recall the -message even if you exit Mutt and then restart it at a later time. - -Once a message is postponed, there are several ways to resume it. From the -command line you can use the ``-p'' option, or if you <em/compose/ a new -message from the <em/index/ or <em/pager/ you will be prompted if postponed -messages exist. If multiple messages are currently postponed, the -<em/postponed/ menu will pop up and you can select which message you would -like to resume. - -<bf/Note:/ If you postpone a reply to a message, the reply setting of -the message is only updated when you actually finish the message and -send it. Also, you must be in the same folder with the message you -replied to for the status of the message to be updated. - -See also the <ref id="postpone" name="$postpone"> quad-option. - -<sect>Configuration -<p> - -While the default configuration (or ``preferences'') make Mutt -usable right out of the box, it is often desirable to tailor Mutt to -suit your own tastes. When Mutt is first invoked, it will attempt to -read the ``system'' configuration file (defaults set by your local -system administrator), unless the ``-n'' <ref id="commandline" -name="command line"> option is specified. This file is typically -<tt>/usr/local/share/mutt/Muttrc</tt> or <tt>/etc/Muttrc</tt>. Mutt -will next look for a file named <tt>.muttrc</tt> in your home -directory. If this file does not exist and your home directory has -a subdirectory named <tt/.mutt/, mutt try to load a file named -<tt>.mutt/muttrc</tt>. - -<tt>.muttrc</tt> is the file where you will usually place your <ref - id="commands" name="commands"> to configure Mutt. - -In addition, mutt supports version specific configuration files that are -parsed instead of the default files as explained above. For instance, if -your system has a <tt/Muttrc-0.88/ file in the system configuration -directory, and you are running version 0.88 of mutt, this file will be -sourced instead of the <tt/Muttrc/ file. The same is true of the user -configuration file, if you have a file <tt/.muttrc-0.88.6/ in your home -directory, when you run mutt version 0.88.6, it will source this file -instead of the default <tt/.muttrc/ file. The version number is the -same which is visible using the ``-v'' <ref id="commandline" -name="command line"> switch or using the <tt/show-version/ key (default: -V) from the index menu. - -<sect1>Syntax of Initialization Files -<p> - -An initialization file consists of a series of <ref id="commands" -name="commands">. Each line of the file may contain one or more commands. -When multiple commands are used, they must be separated by a semicolon (;). -<tscreen><verb> -set realname='Mutt user' ; ignore x- -</verb></tscreen> -The hash mark, or pound sign -(``#''), is used as a ``comment'' character. You can use it to -annotate your initialization file. All text after the comment character -to the end of the line is ignored. For example, - -<tscreen><verb> -my_hdr X-Disclaimer: Why are you listening to me? # This is a comment -</verb></tscreen> - -Single quotes (') and double quotes (&dquot;) can be used to quote strings -which contain spaces or other special characters. The difference between -the two types of quotes is similar to that of many popular shell programs, -namely that a single quote is used to specify a literal string (one that is -not interpreted for shell variables or quoting with a backslash [see -next paragraph]), while double quotes indicate a string for which -should be evaluated. For example, backtics are evaluated inside of double -quotes, but <bf/not/ for single quotes. - -\ quotes the next character, just as in shells such as bash and zsh. -For example, if want to put quotes ``&dquot;'' inside of a string, you can use -``\'' to force the next character to be a literal instead of interpreted -character. -<tscreen><verb> -set realname="Michael \"MuttDude\" Elkins" -</verb></tscreen> - -``\\'' means to insert a literal ``\'' into the line. -``\n'' and ``\r'' have their usual C meanings of linefeed and -carriage-return, respectively. - -A \ at the end of a line can be used to split commands over -multiple lines, provided that the split points don't appear in the -middle of command names. - -It is also possible to substitute the output of a Unix command in an -initialization file. This is accomplished by enclosing the command in -backquotes (``). For example, -<tscreen><verb> -my_hdr X-Operating-System: `uname -a` -</verb></tscreen> -The output of the Unix command ``uname -a'' will be substituted before the -line is parsed. Note that since initialization files are line oriented, only -the first line of output from the Unix command will be substituted. - -UNIX environments can be accessed like the way it is done in shells like -sh and bash: Prepend the name of the environment by a ``$dollar;''. For -example, -<tscreen><verb> -set record=+sent_on_$HOSTNAME -</verb></tscreen> - -The commands understood by mutt are explained in the next paragraphs. -For a complete list, see the <ref id="commands" name="command reference">. - -<sect1>Defining/Using aliases<label id="alias"> -<p> - -Usage: <tt/alias/ <em/key/ <em/address/ [ , <em/address/, ... ] - -It's usually very cumbersome to remember or type out the address of someone -you are communicating with. Mutt allows you to create ``aliases'' which map -a short string to a full address. - -<bf/Note:/ if you want to create an alias for a group (by specifying more than -one address), you <bf/must/ separate the addresses with a comma (``,''). - -To remove an alias or aliases: - -<tt/unalias/ <em/addr/ [ <em/addr/ <em/.../ ] - -<tscreen><verb> -alias muttdude me@cs.hmc.edu (Michael Elkins) -alias theguys manny, moe, jack -</verb></tscreen> - -Unlike other mailers, Mutt doesn't require aliases to be defined -in a special file. The <tt/alias/ command can appear anywhere in -a configuration file, as long as this file is <ref id="source" -name="sourced">. Consequently, you can have multiple alias files, or -you can have all aliases defined in your muttrc. - -On the other hand, the <ref id="create-alias" name="create-alias"> -function can use only one file, the one pointed to by the <ref -id="alias_file" name="$alias_file"> variable (which is -<tt>˜/.muttrc</tt> by default). This file is not special either, -in the sense that Mutt will happily append aliases to any file, but in -order for the new aliases to take effect you need to explicitly <ref -id="source" name="source"> this file too. - -For example: - -<tscreen><verb> -source /usr/local/share/Mutt.aliases -source ~/.mail_aliases -set alias_file=~/.mail_aliases -</verb></tscreen> - -To use aliases, you merely use the alias at any place in mutt where mutt -prompts for addresses, such as the <em/To:/ or <em/Cc:/ prompt. You can -also enter aliases in your editor at the appropriate headers if you have the -<ref id="edit_headers" name="$edit_headers"> variable set. - -In addition, at the various address prompts, you can use the tab character -to expand a partial alias to the full alias. If there are multiple matches, -mutt will bring up a menu with the matching aliases. In order to be -presented with the full list of aliases, you must hit tab with out a partial -alias, such as at the beginning of the prompt or after a comma denoting -multiple addresses. - -In the alias menu, you can select as many aliases as you want with the -<em/select-entry/ key (default: RET), and use the <em/exit/ key -(default: q) to return to the address prompt. - -<sect1>Changing the default key bindings<label id="bind"> -<p> -Usage: <tt/bind/ <em/map/ <em/key/ <em/function/ - -This command allows you to change the default key bindings (operation -invoked when pressing a key). - -<em/map/ specifies in which menu the binding belongs. The currently -defined maps are: - -<itemize> -<item>generic -<item>alias -<item>attach -<item>browser -<item>editor -<item>index -<item>compose -<item>pager -<item>pgp -<item>postpone -</itemize> - -<em/key/ is the key (or key sequence) you wish to bind. To specify a -control character, use the sequence <em/\Cx/, where <em/x/ is the -letter of the control character (for example, to specify control-A use -``\Ca''). Note that the case of <em/x/ as well as <em/\C/ is -ignored, so that <em/\CA, \Ca, \cA/ and <em/\ca/ are all -equivalent. An alternative form is to specify the key as a three digit -octal number prefixed with a ``\'' (for example <em/\177/ is -equivalent to <em/\c?/). - -In addition, <em/key/ may consist of: - -<tscreen><verb> -\t tab -<Tab> tab -\r carriage return -\n newline -\e escape -<esc> escape -<up> up arrow -<down> down arrow -<left> left arrow -<right> right arrow -<pageup> Page Up -<pagedown> Page Down -<backspace> Backspace -<delete> Delete -<insert> Insert -<enter> Enter -<home> Home -<end> End -<Space> Space bar -<f1> function key 1 -<f10> function key 10 -</verb></tscreen> - -<em/key/ does not need to be enclosed in quotes unless it contains a -space (`` ''). - -<em/function/ specifies which action to take when <em/key/ is pressed. -For a complete list of functions, see the <ref id="functions" -name="reference">. The special funct |