Manual: Improve [un]mailboxes documentation. Closes #2204.

diff --git a/ChangeLog b/ChangeLog
index d3c1880a78a87d75be2918ec9aa2e825460e7e98..9fbd86806004a698d711d95b9d04f5ff17ee8f60 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,18 @@
+2007-11-05 14:52 +0100  Rocco Rutte  <pdmef@gmx.net>  (3bac5aa1af75)
+
+       * hg-commit: hg-commit: Exclude merges when writing ChangeLog
+
+2007-11-05 12:11 +0100  Ralf Wildenhues  <wildenhues@ins.uni-bonn.de>  (645fcdd66828)
+
+       * configure.ac, intl/Makefile.in, po/Makefile.in.in: Optionally define
+       $datarootdir on our own for autoconf <2.60 compatibility. While I'm
+       at it, fix two warnings in other files about ignoring datarootdir
+       with autoconf >2.60. Closes #2905.
+
+2007-11-04 13:19 -0800  Vsevolod Volkov  <vvv@mutt.org.ua>  (dc5ec6dbb278)
+
+       * ChangeLog, po/ru.po: Updated Russian translation
+
 2007-11-04 13:17 -0800  Ivan Vilata i Balaguer  <ivan@selidor.net>  (1f72281eb36c)
 
        * po/ca.po: Updated Catalan translation

diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index d6c422a69d103e254f5e3f3dcdf33fead5e6ef15..f709c2a90c9ac4f3bf0a766324031b8f1160cc65 100644 (file)
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -2495,10 +2495,10 @@ mailbox).
 </sect1>
 
 <sect1 id="mailboxes">
-<title>Defining mailboxes which receive mail</title>
+<title>Monitoring incomming mail</title>
 
 <para>
-Usage: <literal>&lsqb;un&rsqb;mailboxes</literal> &lsqb;!&rsqb;<emphasis>filename</emphasis> &lsqb; <emphasis>filename</emphasis> ... &rsqb;
+Usage: <literal>&lsqb;un&rsqb;mailboxes</literal> &lsqb;!&rsqb;<emphasis>folder</emphasis> &lsqb; <emphasis>folder</emphasis> ... &rsqb;
 </para>
 
 <para>
@@ -2508,6 +2508,15 @@ main menu status bar displays how many of these folders have
 new messages.
 </para>
 
+<para>
+<literal>folder</literal> can either be a local file or directory
+(Mbox/Mmdf or Maildir/Mh). If Mutt was built with POP and/or IMAP
+support, <literal>folder</literal> can also be a POP/IMAP folder
+URL. The URL syntax is described in <xref linkend="url-syntax"/>,
+POP and IMAP are described in <xref linkend="pop"/> and <xref linkend="imap"/>
+respectively.
+</para>
+
 <para>
 When changing folders, pressing <emphasis>space</emphasis> will cycle
 through folders with new mail.
@@ -2527,18 +2536,29 @@ tokens.
 </para>
 
 <para>
-<emphasis role="bold">Note:</emphasis> new mail is detected by comparing the last modification time to
-the last access time.  Utilities like <literal>biff</literal> or <literal>frm</literal> or any other
-program which accesses the mailbox might cause Mutt to never detect new mail
-for that mailbox if they do not properly reset the access time.  Backup
-tools are another common reason for updated access times.
+<emphasis role="bold">Note:</emphasis> the folders in the <literal>mailboxes</literal> command are resolved when
+the command is executed, so if these names contain <link linkend="shortcuts">shortcut characters</link> (such as ``='' and ``!''), any variable
+definition that affect these characters (like <link linkend="folder">&dollar;folder</link> and <link linkend="spoolfile">&dollar;spoolfile</link>)
+should be executed before the <literal>mailboxes</literal> command. If
+none of these shorcuts are used, a local path should be absolute as
+otherwise mutt tries to find it within the current working directory
+from where mutt was started which may not always be desired.
 </para>
 
 <para>
-<emphasis role="bold">Note:</emphasis> the filenames in the <literal>mailboxes</literal> command are resolved when
-the command is executed, so if these names contain <link linkend="shortcuts">shortcut characters</link> (such as ``='' and ``!''), any variable
-definition that affect these characters (like <link linkend="folder">&dollar;folder</link> and <link linkend="spoolfile">&dollar;spoolfile</link>)
-should be executed before the <literal>mailboxes</literal> command.
+For local folders, new mail is detected by comparing access and/or
+modification times of files and folders. The interval in which Mutt
+checks for new mail is defined by
+<link linkend="mail-check">&dollar;mail&lowbar;check</link>.
+</para>
+
+<para>
+Special care is required with Mbox and Mmdf
+folders as Mutt assumes such a folder has new mail if it wasn't
+accessed after it was last modified. Utilities like <literal>biff</literal> or
+<literal>frm</literal> or any other program which accesses the mailbox might cause
+Mutt to never detect new mail for that mailbox if they do not properly reset the
+access time.  Backup tools are another common reason for updated access times.
 </para>
 
 </sect1>