Rocco Rutte:

[apps/madmutt.git] / doc / manual.txt

diff --git a/doc/manual.txt b/doc/manual.txt
index e6b7aa8..e87de1e 100644 (file)
--- a/doc/manual.txt
+++ b/doc/manual.txt
@@ -721,9 +721,9 @@
        newsserver via NNTP.  You can open a newsgroup with function ``change-news-
        group'' (default: i).  Default newsserver can be obtained from _\bN_\bN_\bT_\bP_\bS_\bE_\bR_\bV_\bE_\bR envi-
        ronment variable.  Like other news readers, info about subscribed newsgroups is
        newsserver via NNTP.  You can open a newsgroup with function ``change-news-
        group'' (default: i).  Default newsserver can be obtained from _\bN_\bN_\bT_\bP_\bS_\bE_\bR_\bV_\bE_\bR envi-
        ronment variable.  Like other news readers, info about subscribed newsgroups is

-       saved in file by _\b$_\bn_\be_\bw_\bs_\br_\bc (section , page ) variable.  Article headers are
-       cached and can be loaded from file when newsgroup entered instead loading from
-       newsserver.
+       saved in file by _\b$_\bn_\bn_\bt_\bp_\b__\bn_\be_\bw_\bs_\br_\bc (section 6.3.155  , page 103) variable. Article
+       headers are cached and can be loaded from file when newsgroup entered instead
+       loading from newsserver.

 
        _\b3_\b.  _\bC_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn
 
 
        _\b3_\b.  _\bC_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn
 


@@ -1712,26 +1712,30 @@
 
        _\b3_\b._\b2_\b7  _\bC_\bo_\bn_\bf_\bi_\bg_\bu_\br_\bi_\bn_\bg _\bf_\be_\ba_\bt_\bu_\br_\be_\bs _\bc_\bo_\bn_\bd_\bi_\bt_\bi_\bo_\bn_\ba_\bl_\bl_\by
 
 
        _\b3_\b._\b2_\b7  _\bC_\bo_\bn_\bf_\bi_\bg_\bu_\br_\bi_\bn_\bg _\bf_\be_\ba_\bt_\bu_\br_\be_\bs _\bc_\bo_\bn_\bd_\bi_\bt_\bi_\bo_\bn_\ba_\bl_\bl_\by
 

-       Usage: ifdef _\bi_\bt_\be_\bm _\bc_\bo_\bm_\bm_\ba_\bn_\bd Usage: ifndef _\bi_\bt_\be_\bm _\bc_\bo_\bm_\bm_\ba_\bn_\bd
+       Usage: ifdef _\bi_\bt_\be_\bm _\bc_\bo_\bm_\bm_\ba_\bn_\bd

 
 

-       These command allows to test if a variable, function or certain feature is
-       available or not respectively, before actually executing the command.  ifdef
-       (short for ``if defined) handles commands if upon availability while ifndef
+       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
 
 
        The Mutt-ng E-Mail Client                                                    33
 

-       (short for ``if not defined'') does if not. The _\bc_\bo_\bm_\bm_\ba_\bn_\bd may be any valid frac-
-       tion of a configuration file.
+       available or not respectively, before actually executing the command given.
+
+       ifdef (short for ``if defined'') only executes the command upon availability
+       while ifndef (short for ``if not defined'') does if not. The _\bc_\bo_\bm_\bm_\ba_\bn_\bd may be any
+       valid fraction of a configuration file.

 
 

-       All names of variables and functions may be tested. Additionally, the following
-       compile-features may be tested when prefixed with 'feature_': ncurses, slang,
-       iconv, idn, dotlock, standalone, pop, nntp, imap, ssl, gnutls, sasl, sasl2,
-       libesmtp, compressed, color, classic_pgp, classic_smime, gpgme, header_cache.
+       All names of variables, functions and menus may be tested. Additionally, the
+       following compile-features may be tested when prefixed with 'feature_':
+       ncurses, slang, iconv, idn, dotlock, standalone, pop, nntp, imap, ssl, gnutls,
+       sasl, sasl2, libesmtp, compressed, color, classic_pgp, classic_smime, gpgme,
+       header_cache, gdbm, qdbm and db4.

 
        Examples follow.
 
 
        Examples follow.
 

-       To only source a file with IMAP related settings only if IMAP support is com-
-       piled in, use:
+       To only source a file with IMAP related settings if IMAP support is compiled
+       in, use:

 
             ifdef feature_imap 'source ~/.mutt-ng/imap_setup'
             # or
 
             ifdef feature_imap 'source ~/.mutt-ng/imap_setup'
             # or


@@ -1747,10 +1751,10 @@
             # or
             # ...
 
             # or
             # ...
 

-       To only set the _\b<_\b$_\bi_\bm_\ba_\bp_\b__\bm_\ba_\bi_\bl_\b__\bc_\bh_\be_\bc_\bk (section 6.3.98  , page 87) when the system's
-       SVN is recent enough to have it:
+       To only set the _\b$_\bi_\bm_\ba_\bp_\b__\bm_\ba_\bi_\bl_\b__\bc_\bh_\be_\bc_\bk (section 6.3.98  , page 87) variable if the
+       system's mutt-ng is aware of it, use:

 
 

-            ifdef imap_mail_check 'set imap_mail_check=300'
+            ifdef imap_mail_check 'set imap_mail_check=500'

 
        _\b3_\b._\b2_\b8  _\bR_\be_\bm_\bo_\bv_\bi_\bn_\bg _\bh_\bo_\bo_\bk_\bs
 
 
        _\b3_\b._\b2_\b8  _\bR_\be_\bm_\bo_\bv_\bi_\bn_\bg _\bh_\bo_\bo_\bk_\bs
 


@@ -1765,14 +1769,15 @@
 
        _\b4_\b._\b1  _\bR_\be_\bg_\bu_\bl_\ba_\br _\bE_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn_\bs
 
 
        _\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.
+       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
 
 
        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.
+

        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
        for a regular expression in an initialization command: ``\\''.
        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
        for a regular expression in an initialization command: ``\\''.


@@ -1822,15 +1827,14 @@
              [:cntrl:]
                    Control characters.
 
              [:cntrl:]
                    Control characters.
 

+       The Mutt-ng E-Mail Client                                                    35
+

              [:digit:]
                    Numeric characters.
 
              [:graph:]
              [:digit:]
                    Numeric characters.
 
              [:graph:]

-                   Characters that are both printable and visible.  (A space is
-
-       The Mutt-ng E-Mail Client                                                    35
-
-                   printable, but not visible, while an ``a'' is both.)
+                   Characters that are both printable and visible.  (A space is print-
+                   able, but not visible, while an ``a'' is both.)

 
              [:lower:]
                    Lower-case alphabetic characters.
 
              [:lower:]
                    Lower-case alphabetic characters.


@@ -1880,11 +1884,11 @@
              ?
                    The preceding item is optional and matched at most once.
 
              ?
                    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.
 
              *
                    The preceding item will be matched zero or more times.
 

-       The Mutt-ng E-Mail Client                                                    36
-

              +
                    The preceding item will be matched one or more times.
 
              +
                    The preceding item will be matched one or more times.
 


@@ -1935,11 +1939,11 @@
              \\W
                    Matches any character that is not word-constituent.
 
              \\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).
 
              \\`
                    Matches the empty string at the beginning of a buffer (string).
 

-       The Mutt-ng E-Mail Client                                                    37
-

              \\'
                    Matches the empty string at the end of a buffer.
 
              \\'
                    Matches the empty string at the end of a buffer.
 


@@ -2497,8 +2501,8 @@
 
        Polling for new mail is more expensive over POP3 than locally. For this reason
        the frequency at which Mutt-ng will check for mail remotely can be controlled
 
        Polling for new mail is more expensive over POP3 than locally. For this reason
        the frequency at which Mutt-ng will check for mail remotely can be controlled

-       by the _\b$_\bp_\bo_\bp_\b__\bc_\bh_\be_\bc_\bk_\bi_\bn_\bt_\be_\br_\bv_\ba_\bl (section , page ) variable, which defaults to every
-       60 seconds.
+       by the _\b$_\bp_\bo_\bp_\b__\bm_\ba_\bi_\bl_\b__\bc_\bh_\be_\bc_\bk (section 6.3.207  , page 115) variable, which defaults
+       to every 60 seconds.

 
        If Mutt-ng was compiled with SSL support (by running the _\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\be script with
        the _\b-_\b-_\bw_\bi_\bt_\bh_\b-_\bs_\bs_\bl flag), connections to POP3 servers can be encrypted. This natu-
 
        If Mutt-ng was compiled with SSL support (by running the _\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\be script with
        the _\b-_\b-_\bw_\bi_\bt_\bh_\b-_\bs_\bs_\bl flag), connections to POP3 servers can be encrypted. This natu-


@@ -5458,7 +5462,7 @@
        This variable, when _\bs_\be_\bt, makes the thread tree narrower, allowing deeper
        threads to fit on the screen.
 
        This variable, when _\bs_\be_\bt, makes the thread tree narrower, allowing deeper
        threads to fit on the screen.
 

-       _\b6_\b._\b3_\b._\b1_\b4_\b3  _\bn_\bn_\bt_\bp_\b__\ba_\bs_\bk_\b__\bf_\bo_\bl_\bl_\bo_\bw_\b__\bu_\bp
+       _\b6_\b._\b3_\b._\b1_\b4_\b3  _\bn_\bn_\bt_\bp_\b__\ba_\bs_\bk_\b__\bf_\bo_\bl_\bl_\bo_\bw_\bu_\bp_\b__\bt_\bo

 
        Type: boolean
 
 
        Type: boolean
 


@@ -5517,8 +5521,8 @@
        Availability: NNTP
 
        This variable controls how many news articles to cache per newsgroup (if
        Availability: NNTP
 
        This variable controls how many news articles to cache per newsgroup (if

-       caching is enabled, see _\b$_\bn_\be_\bw_\bs_\b__\bc_\ba_\bc_\bh_\be_\b__\bd_\bi_\br (section , page )) and how many news
-       articles to show in the ``index'' menu.
+       caching is enabled, see _\b$_\bn_\bn_\bt_\bp_\b__\bc_\ba_\bc_\bh_\be_\b__\bd_\bi_\br (section 6.3.145  , page 100)) and how
+       many news articles to show in the ``index'' menu.

 
        If there're more articles than defined with _\b$_\bn_\bn_\bt_\bp_\b__\bc_\bo_\bn_\bt_\be_\bx_\bt (section 6.3.147  ,
        page 101), all older ones will be removed/not shown in the index.
 
        If there're more articles than defined with _\b$_\bn_\bn_\bt_\bp_\b__\bc_\bo_\bn_\bt_\be_\bx_\bt (section 6.3.147  ,
        page 101), all older ones will be removed/not shown in the index.


@@ -8060,10 +8064,28 @@
        Default: 'M%?n?AIL&ail?'
 
        Controls the format of the X11 icon title, as long as _\b$_\bx_\bt_\be_\br_\bm_\b__\bs_\be_\bt_\b__\bt_\bi_\bt_\bl_\be_\bs (sec-
        Default: 'M%?n?AIL&ail?'
 
        Controls the format of the X11 icon title, as long as _\b$_\bx_\bt_\be_\br_\bm_\b__\bs_\be_\bt_\b__\bt_\bi_\bt_\bl_\be_\bs (sec-

-       tion 6.3.336  , page 146) is _\bs_\be_\bt. This string is identical in formatting to the
+       tion 6.3.337  , page 146) is _\bs_\be_\bt. This string is identical in formatting to the

        one used by ``_\b$_\bs_\bt_\ba_\bt_\bu_\bs_\b__\bf_\bo_\br_\bm_\ba_\bt (section 6.3.302  , page 137)''.
 
        one used by ``_\b$_\bs_\bt_\ba_\bt_\bu_\bs_\b__\bf_\bo_\br_\bm_\ba_\bt (section 6.3.302  , page 137)''.
 

-       _\b6_\b._\b3_\b._\b3_\b3_\b6  _\bx_\bt_\be_\br_\bm_\b__\bs_\be_\bt_\b__\bt_\bi_\bt_\bl_\be_\bs
+       _\b6_\b._\b3_\b._\b3_\b3_\b6  _\bx_\bt_\be_\br_\bm_\b__\bl_\be_\ba_\bv_\be
+
+       Type: string
+
+       Default: ''
+
+       If _\b$_\bx_\bt_\be_\br_\bm_\b__\bs_\be_\bt_\b__\bt_\bi_\bt_\bl_\be_\bs (section 6.3.337  , page 146) is _\bs_\be_\bt, this string will be
+       used to set the title when leaving mutt-ng. For terminal-based programs,
+       there's no easy and portable way to read the current title so mutt-ng cannot
+       read it upon startup and restore it when exiting.
+
+       Based on the xterm FAQ, the following might work:
+
+       The Mutt-ng E-Mail Client                                                   148
+
+       set xterm_leave = '`test x$DISPLAY != x && xprop -id $WINDOWID | grep WM_NAME |
+       cut -d ''' -f 2`'
+
+       _\b6_\b._\b3_\b._\b3_\b3_\b7  _\bx_\bt_\be_\br_\bm_\b__\bs_\be_\bt_\b__\bt_\bi_\bt_\bl_\be_\bs

 
        Type: boolean
 
 
        Type: boolean
 


@@ -8073,16 +8095,14 @@
        you're in an appropriate terminal). The default must be _\bu_\bn_\bs_\be_\bt to force in the
        validity checking.
 
        you're in an appropriate terminal). The default must be _\bu_\bn_\bs_\be_\bt to force in the
        validity checking.
 

-       _\b6_\b._\b3_\b._\b3_\b3_\b7  _\bx_\bt_\be_\br_\bm_\b__\bt_\bi_\bt_\bl_\be
-
-       The Mutt-ng E-Mail Client                                                   148
+       _\b6_\b._\b3_\b._\b3_\b3_\b8  _\bx_\bt_\be_\br_\bm_\b__\bt_\bi_\bt_\bl_\be

 
        Type: string
 
        Default: 'Mutt-ng with %?m?%m messages&no messages?%?n? [%n New]?'
 
        Controls the format of the title bar of the xterm provided that
 
        Type: string
 
        Default: 'Mutt-ng with %?m?%m messages&no messages?%?n? [%n New]?'
 
        Controls the format of the title bar of the xterm provided that

-       _\b$_\bx_\bt_\be_\br_\bm_\b__\bs_\be_\bt_\b__\bt_\bi_\bt_\bl_\be_\bs (section 6.3.336  , page 146) has been _\bs_\be_\bt. This string is
+       _\b$_\bx_\bt_\be_\br_\bm_\b__\bs_\be_\bt_\b__\bt_\bi_\bt_\bl_\be_\bs (section 6.3.337  , page 146) has been _\bs_\be_\bt. This string is

        identical in formatting to the one used by ``_\b$_\bs_\bt_\ba_\bt_\bu_\bs_\b__\bf_\bo_\br_\bm_\ba_\bt (section 6.3.302  ,
        page 137)''.
 
        identical in formatting to the one used by ``_\b$_\bs_\bt_\ba_\bt_\bu_\bs_\b__\bf_\bo_\br_\bm_\ba_\bt (section 6.3.302  ,
        page 137)''.
 


@@ -8100,6 +8120,8 @@
        tings for this menu will affect the default bindings for all menus (except as
        noted).
 
        tings for this menu will affect the default bindings for all menus (except as
        noted).
 

+       The Mutt-ng E-Mail Client                                                   149
+

             bottom-page                L   move to the bottom of the page
             current-bottom     not bound   move current entry to bottom of page
             current-middle     not bound   move current entry to middle of page
             bottom-page                L   move to the bottom of the page
             current-bottom     not bound   move current entry to bottom of page
             current-middle     not bound   move current entry to middle of page


@@ -8130,9 +8152,6 @@
             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
             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

-
-       The Mutt-ng E-Mail Client                                                   149
-

             what-key           not bound   display the keycode for a key press
 
        _\b6_\b._\b4_\b._\b2  _\bi_\bn_\bd_\be_\bx
             what-key           not bound   display the keycode for a key press
 
        _\b6_\b._\b4_\b._\b2  _\bi_\bn_\bd_\be_\bx


@@ -8431,7 +8450,7 @@
        Kari Hurtta <kari.hurtta@fmi.fi> co-developed the original MIME parsing code
        back in the ELM-ME days.
 
        Kari Hurtta <kari.hurtta@fmi.fi> co-developed the original MIME parsing code
        back in the ELM-ME days.
 

-       The following people have been very helpful to the development of Mutt-ng:
+       The following people have been very helpful to the development of Mutt:

 
        Vikas Agnihotri <vikasa@writeme.com>,
 
 
        Vikas Agnihotri <vikasa@writeme.com>,
 


@@ -8515,8 +8534,21 @@
 
        Vsevolod Volkov <vvv@lucky.net>,
 
 
        Vsevolod Volkov <vvv@lucky.net>,
 

-       Ken Weinert <kenw@ihs.com> Andreas Krennmair <ak@synflood.at> Nico Golde
-       <nico@ngolde.de> Rocco Rutte <pdmef@cs.tu-berlin.de>
+       Ken Weinert <kenw@ihs.com>
+
+       Mutt-ng is developed by the following people:
+
+       Andreas Krennmair <ak@synflood.at>
+
+       Nico Golde <nico@ngolde.de>
+
+       Rocco Rutte <pdmef@cs.tu-berlin.de>
+
+       The following people have been very helpful to the development of  Mutt-ng:
+
+       Iain Lea <iain@bricbrac.de>
+
+       Andreas Kneib <akneib@gmx.net>

 
        _\b7_\b._\b2  _\bA_\bb_\bo_\bu_\bt _\bt_\bh_\bi_\bs _\bd_\bo_\bc_\bu_\bm_\be_\bn_\bt
 
 
        _\b7_\b._\b2  _\bA_\bb_\bo_\bu_\bt _\bt_\bh_\bi_\bs _\bd_\bo_\bc_\bu_\bm_\be_\bn_\bt