Andreas Krennmair:

[apps/madmutt.git] / doc / manual.sgml.head

diff --git a/doc/manual.sgml.head b/doc/manual.sgml.head
index 3c4095b..3397b32 100644 (file)
--- a/doc/manual.sgml.head
+++ b/doc/manual.sgml.head
@@ -13,7 +13,7 @@
 
 <sect>Introduction
 <p>
 
 <sect>Introduction
 <p>

-<bf/Mutt/ is a small but very powerful text-based MIME mail client.  Mutt is
+<bf/Mutt-ng/ is a small but very powerful text-based MIME mail client.  Mutt-ng 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
 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


@@ -26,15 +26,11 @@ add other new features. Features specific to Mutt-ng will be discussed in
 an extra section. Don't be confused when most of the documentation talk about
 Mutt and not Mutt-ng, Mutt-ng contains all Mutt-ng features, plus many more.
 
 an extra section. Don't be confused when most of the documentation talk about
 Mutt and not Mutt-ng, Mutt-ng contains all Mutt-ng features, plus many more.
 

-<sect1>Mutt Home Page
-<p>
-<htmlurl url="http://www.mutt.org/"
-name="http://www.mutt.org/">

 
 <sect1>Mutt-ng Home Page
 <p>
 
 <sect1>Mutt-ng Home Page
 <p>

-<htmlurl url="http://mutt-ng.berlios.de/"
-name="http://mutt-ng.berlios.de/">
+<htmlurl url="http://www.muttng.org/"
+name="http://www.muttng.org">

 
 <sect1>Mailing Lists
 <p>
 
 <sect1>Mailing Lists
 <p>


@@ -1713,6 +1709,51 @@ If the filename ends with a vertical bar (|), then <em/filename/ is
 considered to be an executable program from which to read input (eg.
 <tt>source ~/bin/myscript|</tt>).
 
 considered to be an executable program from which to read input (eg.
 <tt>source ~/bin/myscript|</tt>).
 

+<sect1>Configuring features conditionaly<label id="ifdef">
+<p>
+Usage: <tt/ifdef/ <em/item/ <em/command/
+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
+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.
+
+Examples follow.
+
+To only source a file with IMAP related settings only if IMAP support is
+compiled in, use:
+<tscreen><verb>
+ifdef feature_imap 'source ~/.mutt-ng/imap_setup'
+# or
+# ifdef imap_user 'source ~/.mutt-ng/imap_setup'
+# or
+# ...
+</verb></tscreen>
+
+To exit mutt-ng directly if no NNTP support is compiled in:
+<tscreen><verb>
+ifndef feature_nntp 'push q'
+# or
+# ifndef newsrc 'push q'
+# or
+# ...
+</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:
+<tscreen><verb>
+ifdef imap_mail_check 'set imap_mail_check=300'
+</tscreen></verb>
+

 <sect1>Removing hooks<label id="unhook">
 <p>
 Usage: <tt/unhook/ &lsqb; * | <em/hook-type/ &rsqb;
 <sect1>Removing hooks<label id="unhook">
 <p>
 Usage: <tt/unhook/ &lsqb; * | <em/hook-type/ &rsqb;


@@ -2176,7 +2217,7 @@ pattern is translated at the time the hook is declared, so the value of
 <ref id="default_hook" name="&dollar;default&lowbar;hook"> that is in effect
 at that time will be used.
 
 <ref id="default_hook" name="&dollar;default&lowbar;hook"> that is in effect
 at that time will be used.
 

-<sect1>Usingg the sidebar<label id="sidebar">
+<sect1>Using the sidebar<label id="sidebar">

 <p>
 The sidebar, a feature specific to Mutt-ng, allows you to use a mailbox listing 
 which looks very similar to the ones you probably know from GUI mail clients.
 <p>
 The sidebar, a feature specific to Mutt-ng, allows you to use a mailbox listing 
 which looks very similar to the ones you probably know from GUI mail clients.


@@ -2200,6 +2241,7 @@ mailboxes INBOX \
 You can also specify the colors for mailboxes with new mails by using:
 <tscreen><verb>
 color sidebar_new red black
 You can also specify the colors for mailboxes with new mails by using:
 <tscreen><verb>
 color sidebar_new red black

+color sidebar white black

 </verb></tscreen>
 
 The available functions are:
 </verb></tscreen>
 
 The available functions are:


@@ -2418,9 +2460,6 @@ either by misconfigured software or bad behaviour from some
 correspondents. This allows to clean your mailboxes formats) from these
 annoyances which make it hard to follow a discussion.
 
 correspondents. This allows to clean your mailboxes formats) from these
 annoyances which make it hard to follow a discussion.
 

-If you want to use these functions with IMAP, you need to compile Mutt
-with the <em/--enable-imap-edit-threads/ configure flag.
-

 <sect2>Linking threads
 <p>
 
 <sect2>Linking threads
 <p>
 


@@ -2543,15 +2582,10 @@ name="&dollar;imap&lowbar;list&lowbar;subscribed"> variable.
 
 Polling for new mail on an IMAP server can cause noticeable delays. So, you'll
 want to carefully tune the
 
 Polling for new mail on an IMAP server can cause noticeable delays. So, you'll
 want to carefully tune the

-<ref id="mail_check" name="&dollar;mail&lowbar;check">
+<ref id="imap_mail_check" name="&dollar;imap&lowbar;mail&lowbar;check">

 and
 <ref id="timeout" name="&dollar;timeout">
 and
 <ref id="timeout" name="&dollar;timeout">

-variables. Personally I use
-<tscreen><verb>
-set mail_check=90
-set timeout=15
-</verb></tscreen>
-with relatively good results over my slow modem line.
+variables.

 
 Note that if you are using mbox as the mail store on UW servers prior to
 v12.250, the server has been reported to disconnect a client if another client
 
 Note that if you are using mbox as the mail store on UW servers prior to
 v12.250, the server has been reported to disconnect a client if another client


@@ -2564,7 +2598,7 @@ As of version 1.2, mutt supports browsing mailboxes on an IMAP
 server. This is mostly the same as the local file browser, with the
 following differences:
 <itemize>
 server. This is mostly the same as the local file browser, with the
 following differences:
 <itemize>

-<item>In lieu of file permissions, mutt displays the string "IMAP",
+<item>Instead of file permissions, mutt displays the string "IMAP",

   possibly followed by the symbol "+", indicating
   that the entry contains both messages and subfolders. On
   Cyrus-like servers folders will often contain both messages and
   possibly followed by the symbol "+", indicating
   that the entry contains both messages and subfolders. On
   Cyrus-like servers folders will often contain both messages and