Rocco Rutte:
[apps/madmutt.git] / doc / manual.txt
index a635dc9..51caaf0 100644 (file)
@@ -3,7 +3,7 @@
 
                         by Michael Elkins <me@cs.hmc.edu> and others.
 
-                                     version devel-r353
+                                     version devel-r372
 
                                           A\bAb\bbs\bst\btr\bra\bac\bct\bt
 
 
             \t              tab
             <tab>           tab
+            <backtab>       backtab / shift-tab
             \r              carriage return
             \n              newline
             \e              escape
 
        _\b3_\b._\b5  _\bS_\be_\bt_\bt_\bi_\bn_\bg _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be_\bs _\bb_\ba_\bs_\be_\bd _\bu_\bp_\bo_\bn _\bm_\ba_\bi_\bl_\bb_\bo_\bx
 
-       Usage: folder-hook [!]_\br_\be_\bg_\be_\bx_\bp _\bc_\bo_\bm_\bm_\ba_\bn_\bd
-
        The Mutt-ng E-Mail Client                                                    20
 
+       Usage: folder-hook [!]_\br_\be_\bg_\be_\bx_\bp _\bc_\bo_\bm_\bm_\ba_\bn_\bd
+
        It is often desirable to change settings based on which mailbox you are read-
        ing.  The folder-hook command provides a method by which you can execute any
        configuration command.  _\br_\be_\bg_\be_\bx_\bp is a regular expression specifying in which
        The advantage with using function names directly is that the macros will work
        regardless of the current key bindings, so they are not dependent on the user
        having particular key definitions.  This makes them more robust and portable,
-       and also facilitates defining of macros in files used by more than one user
-       (eg. the system Muttngrc).
 
        The Mutt-ng E-Mail Client                                                    21
 
+       and also facilitates defining of macros in files used by more than one user
+       (eg. the system Muttngrc).
+
        Optionally you can specify a descriptive text after _\bs_\be_\bq_\bu_\be_\bn_\bc_\be, which is shown in
        the help screens.
 
 
           +\bo search (highlighting of words in the pager)
 
+       The Mutt-ng E-Mail Client                                                    22
+
           +\bo signature
 
           +\bo status (mode lines used to display info about the mailbox or message)
 
-       The Mutt-ng E-Mail Client                                                    22
-
           +\bo tilde (the ``~'' used to pad blank lines in the pager)
 
           +\bo tree (thread tree drawn in the message index and attachment menu)
        command for it to be removed.  The pattern ``*'' is a special token which means
        to clear the color index list of all entries.
 
+       The Mutt-ng E-Mail Client                                                    23
+
        Mutt-ng also recognizes the keywords _\bc_\bo_\bl_\bo_\br_\b0, _\bc_\bo_\bl_\bo_\br_\b1, ..., _\bc_\bo_\bl_\bo_\brN\bN-\b-1\b1 (N\bN being the
        number of colors supported by your terminal).  This is useful when you remap
        the colors for your display (for example by changing the color associated with
        _\bc_\bo_\bl_\bo_\br_\b2 for your xterm), since color names may then lose their normal meaning.
 
-       The Mutt-ng E-Mail Client                                                    23
-
        If your terminal does not support color, it is still possible change the video
        attributes through the use of the ``mono'' command:
 
             unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
             unignore posted-to:
 
+       The Mutt-ng E-Mail Client                                                    24
+
        _\b3_\b._\b9  _\bA_\bl_\bt_\be_\br_\bn_\ba_\bt_\bi_\bv_\be _\ba_\bd_\bd_\br_\be_\bs_\bs_\be_\bs
 
        Usage: [un]alternates _\br_\be_\bg_\be_\bx_\bp [ _\br_\be_\bg_\be_\bx_\bp ... ]
 
        With various functions, mutt will treat messages differently, depending on
-
-       The Mutt-ng E-Mail Client                                                    24
-
        whether you sent them or whether you received them from someone else.  For
        instance, when replying to a message that you sent to a different party, mutt
        will automatically suggest to send the response to the original message's
 
        You can use regular expressions with both commands.  To mark all messages sent
        to a specific bug report's address on mutt's bug tracking system as list mail,
+
+       The Mutt-ng E-Mail Client                                                    25
+
        for instance, you could say ``subscribe [0-9]*@bugs.guug.de''.  Often, it's
        sufficient to just give a portion of the list's e-mail address.
 
        Specify as much of the address as you need to to remove ambiguity.  For exam-
        ple, if you've subscribed to the Mutt-ng mailing list, you will receive mail
-
-       The Mutt-ng E-Mail Client                                                    25
-
        addressed to _\bm_\bu_\bt_\bt_\b-_\bu_\bs_\be_\br_\bs_\b@_\bm_\bu_\bt_\bt_\b._\bo_\br_\bg.  So, to tell Mutt-ng that this is a mailing
        list, you could add ``lists mutt-users'' to your initialization file.  To tell
        mutt that you are subscribed to it, add ``subscribe mutt-users'' to your ini-
        they do not properly reset the access time.  Backup tools are another common
        reason for updated access times.
 
+       The Mutt-ng E-Mail Client                                                    26
+
        N\bNo\bot\bte\be:\b: the filenames in the mailboxes command are resolved when the command is
        executed, so if these names contain _\bs_\bh_\bo_\br_\bt_\bc_\bu_\bt _\bc_\bh_\ba_\br_\ba_\bc_\bt_\be_\br_\bs (section 4.8  , page
        44) (such as ``='' and ``!''), any variable definition that affect these char-
        acters (like _\b$_\bf_\bo_\bl_\bd_\be_\br (section 6.3.64  , page 79) and _\b$_\bs_\bp_\bo_\bo_\bl_\bf_\bi_\bl_\be (section
-
-       The Mutt-ng E-Mail Client                                                    26
-
        6.3.295  , page 136)) should be executed before the mailboxes command.
 
        _\b3_\b._\b1_\b3  _\bU_\bs_\be_\br _\bd_\be_\bf_\bi_\bn_\be_\bd _\bh_\be_\ba_\bd_\be_\br_\bs
        ``unhdr_order *'' will clear all previous headers from the order list, thus
        removing the header order effects set by the system-wide startup file.
 
-            hdr_order From Date: From: To: Cc: Subject:
-
        The Mutt-ng E-Mail Client                                                    27
 
+            hdr_order From Date: From: To: Cc: Subject:
+
        _\b3_\b._\b1_\b5  _\bS_\bp_\be_\bc_\bi_\bf_\by _\bd_\be_\bf_\ba_\bu_\bl_\bt _\bs_\ba_\bv_\be _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
 
        Usage: save-hook [!]_\bp_\ba_\bt_\bt_\be_\br_\bn _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
 
        Usage: reply-hook [!]_\bp_\ba_\bt_\bt_\be_\br_\bn _\bc_\bo_\bm_\bm_\ba_\bn_\bd
 
+       The Mutt-ng E-Mail Client                                                    28
+
        Usage: send-hook [!]_\bp_\ba_\bt_\bt_\be_\br_\bn _\bc_\bo_\bm_\bm_\ba_\bn_\bd
 
        Usage: send2-hook [!]_\bp_\ba_\bt_\bt_\be_\br_\bn _\bc_\bo_\bm_\bm_\ba_\bn_\bd
 
-       The Mutt-ng E-Mail Client                                                    28
-
        These commands can be used to execute arbitrary configuration commands based
        upon recipients of the message.  _\bp_\ba_\bt_\bt_\be_\br_\bn is a regular expression matching the
        desired address.  _\bc_\bo_\bm_\bm_\ba_\bn_\bd is executed when _\br_\be_\bg_\be_\bx_\bp matches recipients of the
 
        Example:
 
+       The Mutt-ng E-Mail Client                                                    29
+
             message-hook ~A 'set pager=builtin'
             message-hook '~f freshmeat-news' 'set pager="less \"+/^  subject: .*\""'
 
-       The Mutt-ng E-Mail Client                                                    29
-
        _\b3_\b._\b2_\b0  _\bC_\bh_\bo_\bo_\bs_\bi_\bn_\bg _\bt_\bh_\be _\bc_\br_\by_\bp_\bt_\bo_\bg_\br_\ba_\bp_\bh_\bi_\bc _\bk_\be_\by _\bo_\bf _\bt_\bh_\be _\br_\be_\bc_\bi_\bp_\bi_\be_\bn_\bt
 
        Usage: crypt-hook _\bp_\ba_\bt_\bt_\be_\br_\bn _\bk_\be_\by_\bi_\bd
        same pattern specified in the score command for it to be removed.  The pattern
        ``*'' is a special token which means to clear the list of all score entries.
 
+       The Mutt-ng E-Mail Client                                                    30
+
        _\b3_\b._\b2_\b4  _\bS_\bp_\ba_\bm _\bd_\be_\bt_\be_\bc_\bt_\bi_\bo_\bn
 
        Usage: spam _\bp_\ba_\bt_\bt_\be_\br_\bn _\bf_\bo_\br_\bm_\ba_\bt
 
-       The Mutt-ng E-Mail Client                                                    30
-
        Usage: nospam _\bp_\ba_\bt_\bt_\be_\br_\bn
 
        Mutt-ng has generalized support for external spam-scoring filters.  By defining
        expression matches against for _\bs_\be_\ba_\br_\bc_\bh and _\bl_\bi_\bm_\bi_\bt functions. And it's what sort-
        ing by spam attribute will use as a sort key.
 
+       The Mutt-ng E-Mail Client                                                    31
+
        That's a pretty complicated example, and most people's actual environments will
        have only one spam filter. The simpler your configuration, the more effective
        mutt can be, especially when it comes to sorting.
 
-       The Mutt-ng E-Mail Client                                                    31
-
        Generally, when you sort by spam tag, mutt will sort _\bl_\be_\bx_\bi_\bc_\ba_\bl_\bl_\by -- that is, by
        ordering strings alphnumerically. However, if a spam tag begins with a number,
        mutt will sort numerically first, and lexically only when two numbers are equal
        be enclosed in quotes if they contain spaces or tabs.  You may also use the
        ``C'' escape sequences \\b\n\bn and \\b\t\bt for newline and tab, respectively.
 
-       _\bq_\bu_\ba_\bd_\bo_\bp_\bt_\bi_\bo_\bn variables are used to control whether or not to be prompted for cer-
-       tain actions, or to specify a default action.  A value of _\by_\be_\bs will cause the
-       action to be carried out automatically as if you had answered yes to the
-
        The Mutt-ng E-Mail Client                                                    32
 
-       question.  Similarly, a value of _\bn_\bo will cause the the action to be carried out
-       as if you had answered ``no.''  A value of _\ba_\bs_\bk_\b-_\by_\be_\bs will cause a prompt with a
+       _\bq_\bu_\ba_\bd_\bo_\bp_\bt_\bi_\bo_\bn variables are used to control whether or not to be prompted for cer-
+       tain actions, or to specify a default action.  A value of _\by_\be_\bs will cause the
+       action to be carried out automatically as if you had answered yes to the ques-
+       tion.  Similarly, a value of _\bn_\bo will cause the the action to be carried out as
+       if you had answered ``no.''  A value of _\ba_\bs_\bk_\b-_\by_\be_\bs will cause a prompt with a
        default answer of ``yes'' and _\ba_\bs_\bk_\b-_\bn_\bo will provide a default answer of ``no.''
 
        Prefixing a variable with ``no'' will unset it.  Example: set noaskbcc.
 
        Usage: ifdef _\bi_\bt_\be_\bm _\bc_\bo_\bm_\bm_\ba_\bn_\bd
 
+       The Mutt-ng E-Mail Client                                                    33
+
        Usage: ifndef _\bi_\bt_\be_\bm _\bc_\bo_\bm_\bm_\ba_\bn_\bd
 
        These commands allow testing for a variable, function or certain feature being
-
-       The Mutt-ng E-Mail Client                                                    33
-
        available or not respectively, before actually executing the command given.
 
        ifdef (short for ``if defined'') only executes the command upon availability
 
        _\b4_\b.  _\bA_\bd_\bv_\ba_\bn_\bc_\be_\bd _\bU_\bs_\ba_\bg_\be
 
-       _\b4_\b._\b1  _\bR_\be_\bg_\bu_\bl_\ba_\br _\bE_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn_\bs
-
-       All string patterns in Mutt-ng including those in more complex _\bp_\ba_\bt_\bt_\be_\br_\bn_\bs
-
        The Mutt-ng E-Mail Client                                                    34
 
-       (section 4.2  , page 36) must be specified using regular expressions (regexp)
-       in the ``POSIX extended'' syntax (which is more or less the syntax used by
-       egrep and GNU awk).  For your convenience, we have included below a brief
-       description of this syntax.
+       _\b4_\b._\b1  _\bR_\be_\bg_\bu_\bl_\ba_\br _\bE_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn_\bs
+
+       All string patterns in Mutt-ng including those in more complex _\bp_\ba_\bt_\bt_\be_\br_\bn_\bs (sec-
+       tion 4.2  , page 36) must be specified using regular expressions (regexp) in
+       the ``POSIX extended'' syntax (which is more or less the syntax used by egrep
+       and GNU awk).  For your convenience, we have included below a brief description
+       of this syntax.
 
        The search is case sensitive if the pattern contains at least one upper case
        letter, and case insensitive otherwise. Note that ``\'' must be quoted if used
              [:blank:]
                    Space or tab characters.
 
+       The Mutt-ng E-Mail Client                                                    35
+
              [:cntrl:]
                    Control characters.
 
-       The Mutt-ng E-Mail Client                                                    35
-
              [:digit:]
                    Numeric characters.
 
        A regular expression matching a single character may be followed by one of sev-
        eral repetition operators:
 
+       The Mutt-ng E-Mail Client                                                    36
+
              ?
                    The preceding item is optional and matched at most once.
 
-       The Mutt-ng E-Mail Client                                                    36
-
              *
                    The preceding item will be matched zero or more times.
 
                    Matches any word-constituent character (letter, digit, or under-
                    score).
 
+       The Mutt-ng E-Mail Client                                                    37
+
              \\W
                    Matches any character that is not word-constituent.
 
-       The Mutt-ng E-Mail Client                                                    37
-
              \\`
                    Matches the empty string at the beginning of a buffer (string).
 
 
        Default: '~/.mutt_certificates'
 
-       Availability: SSL or NSS or GNUTLS
+       Availability: SSL or GNUTLS
 
        This variable specifies the file where the certificates you trust are saved.
        When an unknown certificate is encountered, you are asked if you accept it or
 
        Default: ''
 
-       Availability: SSL or NSS
+       Availability: SSL
 
        The file which includes random data that is used to initialize SSL library
        functions.
 
        Default: yes
 
-       Availability: SSL or NSS
+       Availability: SSL
 
        This variables specifies whether to attempt to use SSLv2 in the SSL authentica-
        tion process.
 
        Default: yes
 
-       Availability: SSL or NSS or GNUTLS
+       Availability: SSL or GNUTLS
 
        This variables specifies whether to attempt to use SSLv3 in the SSL authentica-
        tion process.
 
        Default: yes
 
-       Availability: SSL or NSS or GNUTLS
+       Availability: SSL or GNUTLS
 
        This variables specifies whether to attempt to use TLSv1 in the SSL authentica-
        tion process.
 
        Default: yes
 
-       Availability: SSL or NSS
+       Availability: SSL
 
        If set to _\by_\be_\bs, Mutt-ng will use CA certificates in the system-wide certificate
 
            3.6   Keyboard macros .................................................. 20
            3.7   Using color and mono video attributes ............................ 21
            3.8   Ignoring (weeding) unwanted message headers ...................... 23
-           3.9   Alternative addresses ............................................ 23
+           3.9   Alternative addresses ............................................ 24
            3.10  Mailing lists .................................................... 24
            3.11  Using Multiple spool mailboxes ................................... 25
            3.12  Defining mailboxes which receive mail ............................ 25
            3.21  Adding key sequences to the keyboard buffer ...................... 29
            3.22  Executing functions .............................................. 29
            3.23  Message Scoring .................................................. 29
-           3.24  Spam detection ................................................... 29
+           3.24  Spam detection ................................................... 30
            3.25  Setting variables ................................................ 31
            3.26  Reading initialization commands from another file ................ 32
            3.27  Configuring features conditionally ............................... 32
            3.28  Removing hooks ................................................... 33
 
        4.  Advanced Usage ......................................................... 33
-           4.1   Regular Expressions .............................................. 33
+           4.1   Regular Expressions .............................................. 34
 
                                               i