From 1b29c92e5a96be51f4a16728a73485eb4daf6563 Mon Sep 17 00:00:00 2001
From: pdmef <pdmef@e385b8ad-14ed-0310-8656-cc95a2468c6d>
Date: Sun, 24 Jul 2005 12:38:14 +0000
Subject: [PATCH] Rocco Rutte: - documentation update, see
 <http://mutt-ng.berlios.de/manual/> too

git-svn-id: svn://svn.berlios.de/mutt-ng/trunk@340 e385b8ad-14ed-0310-8656-cc95a2468c6d
---
 doc/manual.sgml.head | 55 +++++++++++++++----------
 doc/manual.sgml.tail | 12 ++++--
 doc/manual.txt       | 95 ++++++++++++++++++++++++++------------------
 3 files changed, 99 insertions(+), 63 deletions(-)

diff --git a/doc/manual.sgml.head b/doc/manual.sgml.head
index de7e84c..f11b711 100644
--- a/doc/manual.sgml.head
+++ b/doc/manual.sgml.head
@@ -739,12 +739,13 @@ See also the <ref id="postpone" name="&dollar;postpone"> quad-option.
 <sect1>Reading news via NNTP<label id="reading_news">
 <p>
 
-If compiled with ``--enable-nntp'' option, Mutt-ng can read news from newsserver
-via NNTP.  You can open a newsgroup with function ``change-newsgroup''
-(default: i).  Default newsserver can be obtained from <em/NNTPSERVER/
-environment variable.  Like other news readers, info about subscribed
-newsgroups is saved in file by <ref id="newsrc" name="&dollar;newsrc">
-variable.  Article headers are cached and can be loaded from file when
+If compiled with ``--enable-nntp'' option, Mutt-ng can read news from 
+newsserver via NNTP.  You can open a newsgroup with function 
+``change-newsgroup'' (default: i).  Default newsserver can be obtained 
+from <em/NNTPSERVER/ environment variable.  Like other news readers, 
+info about subscribed newsgroups is saved in file by <ref 
+id="nntp_newsrc" name="&dollar;nntp&lowbar;newsrc"> variable. Article 
+headers are cached and can be loaded from file when
 newsgroup entered instead loading from newsserver.
 
 <sect>Configuration
@@ -1747,24 +1748,34 @@ considered to be an executable program from which to read input (eg.
 
 <sect1>Configuring features conditionally<label id="ifdef">
 <p>
-Usage: <tt/ifdef/ <em/item/ <em/command/
+Usage: <tt/ifdef/ <em/item/ <em/command/<newline>
 Usage: <tt/ifndef/ <em/item/ <em/command/
 
-These command allows to test if a variable, function or certain feature
-is available or not respectively, before actually executing the command.
-<tt/ifdef/ (short for ``if defined) handles commands if upon
+<p>
+These commands allow testing for a variable, function or certain feature
+being available or not respectively, before actually executing the 
+command given.
+
+<p>
+<tt/ifdef/ (short for ``if defined'') only executes the command upon
 availability while <tt/ifndef/ (short for ``if not defined'') does if
 not. The <em/command/ 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.
+<p>
+All names of variables, functions and menus may be tested. Additionally, the
+following compile-features may be tested when prefixed with 
+'<tt/feature_/':
+<tt/ncurses/, <tt/slang/, <tt/iconv/, <tt/idn/, <tt/dotlock/, 
+<tt/standalone/, <tt/pop/, <tt/nntp/, <tt/imap/, <tt/ssl/, <tt/gnutls/, 
+<tt/sasl/, <tt/sasl2/, <tt/libesmtp/, <tt/compressed/, <tt/color/,
+<tt/classic_pgp/, <tt/classic_smime/, <tt/gpgme/, <tt/header_cache/,
+<tt/gdbm/, <tt/qdbm/ and <tt/db4/.
 
+<p>
 Examples follow.
 
-To only source a file with IMAP related settings only if IMAP support is
+<p>
+To only source a file with IMAP related settings if IMAP support is
 compiled in, use:
 <tscreen><verb>
 ifdef feature_imap 'source ~/.mutt-ng/imap_setup'
@@ -1774,6 +1785,7 @@ ifdef feature_imap 'source ~/.mutt-ng/imap_setup'
 # ...
 </verb></tscreen>
 
+<p>
 To exit mutt-ng directly if no NNTP support is compiled in:
 <tscreen><verb>
 ifndef feature_nntp 'push q'
@@ -1783,11 +1795,12 @@ ifndef feature_nntp 'push q'
 # ...
 </verb></tscreen>
 
-To only set the <ref id="imap_mail_check"
-name="&lt;&dollar;imap&lowbar;mail&lowbar;check"> when the system's SVN
-is recent enough to have it:
+<p>
+To only set the <ref id="imap_mail_check" 
+name="&dollar;imap&lowbar;mail&lowbar;check"> variable if
+the system's mutt-ng is aware of it, use:
 <tscreen><verb>
-ifdef imap_mail_check 'set imap_mail_check=300'
+ifdef imap_mail_check 'set imap_mail_check=500'
 </verb></tscreen>
 
 <sect1>Removing hooks<label id="unhook">
@@ -2559,7 +2572,7 @@ You can also specify different username for each folder, i.e.:
 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
-<ref id="pop_checkinterval" name="&dollar;pop&lowbar;checkinterval">
+<ref id="pop_mail_check" name="&dollar;pop&lowbar;mail&lowbar;check">
 variable, which defaults to every 60 seconds.
 
 If Mutt-ng was compiled with SSL support (by running the <em/configure/
diff --git a/doc/manual.sgml.tail b/doc/manual.sgml.tail
index 0a0a1c4..947e365 100644
--- a/doc/manual.sgml.tail
+++ b/doc/manual.sgml.tail
@@ -338,7 +338,7 @@ Kari Hurtta
 <htmlurl url="mailto:kari.hurtta@fmi.fi" name="&lt;kari.hurtta@fmi.fi&gt;">
 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 <htmlurl url="mailto:vikasa@writeme.com" name="&lt;vikasa@writeme.com&gt;">,<newline>
 Francois Berjon <htmlurl url="mailto:Francois.Berjon@aar.alcatel-alsthom.fr" name="&lt;Francois.Berjon@aar.alcatel-alsthom.fr&gt;">,<newline>
@@ -381,11 +381,17 @@ Allain Thivillon <htmlurl url="mailto:Allain.Thivillon@alma.fr" name="&lt;Allain
 Gero Treuner <htmlurl url="mailto:gero@faveve.uni-stuttgart.de" name="&lt;gero@faveve.uni-stuttgart.de&gt;">,<newline>
 Vsevolod Volkov <htmlurl url="mailto:vvv@lucky.net" name="&lt;vvv@lucky.net&gt;">,<newline>
 Ken Weinert <htmlurl url="mailto:kenw@ihs.com" name="&lt;kenw@ihs.com&gt;">
-Andreas Krennmair <htmlurl url="mailto:ak@synflood.at" name="&lt;ak@synflood.at&gt;">
-Nico Golde <htmlurl url="mailto:nico@ngolde.de" name="&lt;nico@ngolde.de&gt;">
+
+Mutt-ng is developed by the following people:
+
+Andreas Krennmair <htmlurl url="mailto:ak@synflood.at" name="&lt;ak@synflood.at&gt;"><newline>
+Nico Golde <htmlurl url="mailto:nico@ngolde.de" name="&lt;nico@ngolde.de&gt;"<newline>
 Rocco Rutte <htmlurl url="mailto:pdmef@cs.tu-berlin.de" name="&lt;pdmef@cs.tu-berlin.de&gt;">
 
+The following people have been very helpful to the development of  Mutt-ng:
 
+Iain Lea <htmlurl url="mailto:iain@bricbrac.de" name="&lt;iain@bricbrac.de&gt;"><newline>
+Andreas Kneib <htmlurl url="mailto:akneib@gmx.net" name="&lt;akneib@gmx.net&gt;">
 
 <sect1>About this document
 <p>
diff --git a/doc/manual.txt b/doc/manual.txt
index 8f11ccd..e87de1e 100644
--- 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 _N_N_T_P_S_E_R_V_E_R envi-
        ronment variable.  Like other news readers, info about subscribed newsgroups is
-       saved in file by _$_n_e_w_s_r_c (section , page ) variable.  Article headers are
-       cached and can be loaded from file when newsgroup entered instead loading from
-       newsserver.
+       saved in file by _$_n_n_t_p___n_e_w_s_r_c (section 6.3.155  , page 103) variable. Article
+       headers are cached and can be loaded from file when newsgroup entered instead
+       loading from newsserver.
 
        _3_.  _C_o_n_f_i_g_u_r_a_t_i_o_n
 
@@ -1712,26 +1712,30 @@
 
        _3_._2_7  _C_o_n_f_i_g_u_r_i_n_g _f_e_a_t_u_r_e_s _c_o_n_d_i_t_i_o_n_a_l_l_y
 
-       Usage: ifdef _i_t_e_m _c_o_m_m_a_n_d Usage: ifndef _i_t_e_m _c_o_m_m_a_n_d
+       Usage: ifdef _i_t_e_m _c_o_m_m_a_n_d
 
-       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 _i_t_e_m _c_o_m_m_a_n_d
+
+       These commands allow testing for a variable, function or certain feature being
 
        The Mutt-ng E-Mail Client                                                    33
 
-       (short for ``if not defined'') does if not. The _c_o_m_m_a_n_d 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 _c_o_m_m_a_n_d 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.
 
-       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
@@ -1747,10 +1751,10 @@
             # or
             # ...
 
-       To only set the _<_$_i_m_a_p___m_a_i_l___c_h_e_c_k (section 6.3.98  , page 87) when the system's
-       SVN is recent enough to have it:
+       To only set the _$_i_m_a_p___m_a_i_l___c_h_e_c_k (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'
 
        _3_._2_8  _R_e_m_o_v_i_n_g _h_o_o_k_s
 
@@ -1765,14 +1769,15 @@
 
        _4_._1  _R_e_g_u_l_a_r _E_x_p_r_e_s_s_i_o_n_s
 
-       All string patterns in Mutt-ng including those in more complex _p_a_t_t_e_r_n_s (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 _p_a_t_t_e_r_n_s
 
        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: ``\\''.
@@ -1822,15 +1827,14 @@
              [:cntrl:]
                    Control characters.
 
+       The Mutt-ng E-Mail Client                                                    35
+
              [: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.
@@ -1880,11 +1884,11 @@
              ?
                    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 Mutt-ng E-Mail Client                                                    36
-
              +
                    The preceding item will be matched one or more times.
 
@@ -1935,11 +1939,11 @@
              \\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).
 
-       The Mutt-ng E-Mail Client                                                    37
-
              \\'
                    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
-       by the _$_p_o_p___c_h_e_c_k_i_n_t_e_r_v_a_l (section , page ) variable, which defaults to every
-       60 seconds.
+       by the _$_p_o_p___m_a_i_l___c_h_e_c_k (section 6.3.207  , page 115) variable, which defaults
+       to every 60 seconds.
 
        If Mutt-ng was compiled with SSL support (by running the _c_o_n_f_i_g_u_r_e script with
        the _-_-_w_i_t_h_-_s_s_l flag), connections to POP3 servers can be encrypted. This natu-
@@ -5517,8 +5521,8 @@
        Availability: NNTP
 
        This variable controls how many news articles to cache per newsgroup (if
-       caching is enabled, see _$_n_e_w_s___c_a_c_h_e___d_i_r (section , page )) and how many news
-       articles to show in the ``index'' menu.
+       caching is enabled, see _$_n_n_t_p___c_a_c_h_e___d_i_r (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 _$_n_n_t_p___c_o_n_t_e_x_t (section 6.3.147  ,
        page 101), all older ones will be removed/not shown in the index.
@@ -8446,7 +8450,7 @@
        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>,
 
@@ -8530,8 +8534,21 @@
 
        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>
 
        _7_._2  _A_b_o_u_t _t_h_i_s _d_o_c_u_m_e_n_t
 
-- 
2.20.1