Andreas Krennmair:
[apps/madmutt.git] / doc / manual.txt
index dd79de5..0b9b62f 100644 (file)
@@ -1,6 +1,6 @@
   The Mutt E-Mail Client
   by Michael Elkins <me@cs.hmc.edu>
-  version 1.5.7
+  version 1.5.8
 
   ``All mail clients suck.  This one just sucks less.'' -me, circa 1995
   ______________________________________________________________________
 
   \e[1m1.4.  IRC\e[0m
 
-  Visit channel \e[4m#mutt\e[24m on OpenProjects.Net (www.openprojects.net) to chat
+  Visit channel \e[4m#mutt\e[24m on irc.freenode.net (www.freenode.net) to chat
   with other people interested in Mutt.
 
   \e[1m1.5.  USENET\e[0m
   \e[1mlist-reply \e[22m(default: L)
 
   Reply to the current or tagged message(s) by extracting any addresses
-  which match the addresses given by the ``lists or subscribe''
-  commands, but also honor any Mail-Followup-To header(s) if the
-  ``$honor_followup_to'' configuration variable is set.  Using this when
-  replying to messages posted to mailing lists helps avoid duplicate
-  copies being sent to the author of the message you are replying to.
+  which match the regular expressions given by the ``lists or
+  subscribe'' commands, but also honor any Mail-Followup-To header(s) if
+  the ``$honor_followup_to'' configuration variable is set.  Using this
+  when replying to messages posted to mailing lists helps avoid
+  duplicate copies being sent to the author of the message you are
+  replying to.
 
   \e[1mpipe-message \e[22m(default: |)
 
   the alternates command: It takes a list of regular expressions, each
   of which can identify an address under which you receive e-mail.
 
-  To remove a regular expression from this list, use the unalternates
-  command.
+  The unalternates command can be used to write exceptions to alternates
+  patterns. If an address matches something in an alternates command,
+  but you nonetheless do not think it is from you, you can list a more
+  precise pattern under an unalternates command.
+
+  To remove a regular expression from the alternates list, use the
+  unalternates command with exactly the same \e[4mregexp\e[24m.  Likewise, if the
+  \e[4mregexp\e[24m for a alternates command matches an entry on the unalternates
+  list, that unalternates entry will be removed. If the \e[4mregexp\e[24m for
+  unalternates is ``*'', \e[4mall\e[24m \e[4mentries\e[24m on alternates will be removed.
 
   \e[1m3.10.  Mailing lists\e[0m
 
   initialization file.  To tell mutt that you are subscribed to it, add
   ``subscribe mutt-users'' to your initialization file instead.  If you
   also happen to get mail from someone whose address is \e[4mmutt-\e[0m
-  \e[4musers@example.com\e[24m, you could use ``lists mutt-users@mutt.org'' or
-  ``subscribe mutt-users@mutt.org'' to match only mail from the actual
+  \e[4musers@example.com\e[24m, you could use ``lists mutt-users@mutt\\.org'' or
+  ``subscribe mutt-users@mutt\\.org'' to match only mail from the actual
   list.
 
   The ``unlists'' command is used to remove a token from the list of
   known and subscribed mailing-lists. Use ``unlists *'' to remove all
   tokens.
-
   To remove a mailing list from the list of subscribed mailing lists,
   but keep it on the list of known mailing lists, use ``unsubscribe''.
 
   See ``Message Matching in Hooks'' for information on the exact format
   of \e[4mpattern\e[24m.
 
-  Example: fcc-hook aol.com$ +spammers
+  Example: fcc-hook [@.]aol\\.com$ +spammers
 
   The above will save a copy of all messages going to the aol.com domain
   to the `+spammers' mailbox by default.  Also see the ``fcc-save-hook''
   This command can be used to execute any function. Functions are listed
   in the ``function reference''.  ``exec function'' is equivalent to
   ``push <function>''.
+
   \e[1m3.23.  Message Scoring\e[0m
 
   Usage: score \e[4mpattern\e[24m \e[4mvalue\e[0m
   For example, suppose I use DCC, SpamAssassin, and PureMessage. I might
   define these spam settings:
 
-       spam "X-DCC-.*-Metrics:.*(....)=many"         "90+/DCC-%1"
-       spam "X-Spam-Status: Yes"                     "90+/SA"
-       spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
-       set spam_separator=", "
+  spam "X-DCC-.*-Metrics:.*(....)=many"         "90+/DCC-%1"
+  spam "X-Spam-Status: Yes"                     "90+/SA"
+  spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
+  set spam_separator=", "
 
   If I then received a message that DCC registered with ``many'' hits
   under the ``Fuz2'' checksum, and that PureMessage registered with a
         and ``=]''.  For example, the name ``e'' might be used to
         represent all of ``è'' ``é'' and ``e''.  In this case, \e[1m[[=e=]]\e[0m
         is a regexp that matches any of ``è'', ``é'' and ``e''.
+
   A regular expression matching a single character may be followed by
   one of several repetition operators:
 
   Example: To select any messages two weeks around January 15, 2001,
   you'd use the following pattern:
 
-       Limit to messages matching: ~d 15/1/2001*2w
+  Limit to messages matching: ~d 15/1/2001*2w
 
   \e[1mRelative\e[22m.  This type of date is relative to the current date, and may
   be specified as:
   rest of the macro to abort it's execution.  Mutt will stop "eating"
   the macro when it encounters the ``end-cond'' operator;  after this
   operator the rest of the macro will be executed as normal.
-
   \e[1m4.4.  Using Hooks\e[0m
 
   A \e[4mhook\e[24m is a concept borrowed from the EMACS editor which allows you to
   send-hook and the my_hdr directive:
 
        send-hook . 'unmy_hdr From:'
-       send-hook ~Cb@b.b my_hdr from: c@c.c
+       send-hook ~C'^b@b\.b$' my_hdr from: c@c.c
 
   \e[1m4.4.1.  Message Matching in Hooks\e[0m
 
 
   which would execute the given command when sending mail to
   \e[4mme@cs.hmc.edu\e[24m.
-
   However, it is not required that you write the pattern to match using
   the full searching language.  You can still specify a simple \e[4mregular\e[0m
   \e[4mexpression\e[24m like the other hooks, in which case Mutt will translate
   trying to reply directly to the author in private, since most mail
   clients will automatically reply to the address given in the ``Reply-
   To'' field.  Mutt uses the ``$reply_to'' variable to help decide which
-  address to use.  If set, you will be prompted as to whether or not you
-  would like to use the address given in the ``Reply-To'' field, or
-  reply directly to the address given in the ``From'' field.  When
-  unset, the ``Reply-To'' field will be used when present.
+  address to use.  If set to \e[4mask-yes\e[24m or \e[4mask-no\e[24m, you will be prompted as
+  to whether or not you would like to use the address given in the
+  ``Reply-To'' field, or reply directly to the address given in the
+  ``From'' field.  When set to \e[4myes\e[24m, the ``Reply-To'' field will be used
+  when present.
 
   The ``X-Label:'' header field can be used to further identify mailing
   lists or list subject matter (or just to annotate messages
 
   Some examples:
 
-       account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
-       account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
-       account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'
+  account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
+  account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
+  account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'
 
   \e[1m4.13.  Start a WWW Browser on URLs (EXTERNAL)\e[0m
 
   Where the Description is the description or filename given for the
   attachment, and the Encoding is one of 7bit/8bit/quoted-print-
   able/base64/binary.
-
   If Mutt cannot deal with a MIME type, it will display a message like:
 
        [-- image/gif is unsupported (use 'v' to view this part) --]
 
   A comment line consists of a # character followed by anything you
   want.
-
   A blank line is blank.
 
   A definition line consists of a content type, a view command, and any
        text/*; more
 
   This is the simplest form of a mailcap file.
+
   \e[1m5.3.2.  Secure use of mailcap\e[0m
 
   The interpretion of shell meta-characters embedded in MIME parameters
         Mutt will expand this to the value of the specified parameter
         from the Content-Type: line of the mail message.  For instance,
         if Your mail message contains:
+
           Content-Type: text/plain; charset=iso-8859-1
 
      then Mutt will expand %{charset} to iso-8859-1.  The default meta-
   Specifies the number of seconds to wait for the ````$sendmail''''
   process to finish before giving up and putting delivery in the
   background.
-
   Mutt interprets the value of this variable as follows:
 
      >\b>0\b0 number of seconds to wait for sendmail to finish before
   %?<sequence_char>?<optional_string>?
 
   where \e[4msequence_char\e[24m is a character from the table above, and
-  \e[4moptional_string\e[24m is the string you would like printed if \e[4mstatus_char\e[24m is
-  nonzero.  \e[4moptional_string\e[24m \e[1mmay \e[22mcontain other sequence as well as normal
-  text, but you may \e[1mnot \e[22mnest optional strings.
+  \e[4moptional_string\e[24m is the string you would like printed if \e[4msequence_char\e[0m
+  is nonzero.  \e[4moptional_string\e[24m \e[1mmay \e[22mcontain other sequences as well as
+  normal text, but you may \e[1mnot \e[22mnest optional strings.
 
   Here is an example illustrating how to optionally print the number of
   new messages in a mailbox: %?n?%n new messages.?
   tag-prefix                 ;   apply next command to tagged entries
   tag-prefix-cond    not bound   apply next function ONLY to tagged messages
   top-page                   H   move to the top of the page
+  what-key           not bound   display the keycode for a key press
 
   \e[1m6.4.2.  index\e[0m