From: Kevin McCarthy <kevin@8t8.us>
Date: Tue, 21 Jun 2016 03:09:52 +0000 (-0700)
Subject: Add documentation to the "New Mail Detection" section of the manual.
X-Git-Tag: neomutt-20160822~102
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=87084e04383d2cf6b1a1d27cea0a3d7d30e02a72;p=neomutt

Add documentation to the "New Mail Detection" section of the manual.

Mention the behavior change with $mail_check_recent.

Add a section about $mail_check_stats.
---

diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index 57c45f305..27f3f6718 100644
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -6071,6 +6071,14 @@ linkend="imap-idle">$imap_idle</link> option is set, it'll use the IMAP
 IDLE extension if advertised by the server.
 </para>
 
+<para>
+The <link linkend="mail-check-recent">$mail_check_recent</link>
+option changes whether Mutt will notify you of new mail in an
+already visited mailbox.  When set (the default) it will only notify
+you of new mail received since the last time you opened the mailbox.
+When unset, Mutt will notify you of any new mail in the mailbox.
+</para>
+
 </sect2>
 
 <sect2 id="new-mail-polling">
@@ -6119,6 +6127,26 @@ to immediately open the next folder with unread mail (if any).
 
 </sect2>
 
+<sect2 id="calc-mailbox-counts">
+<title>Calculating Mailbox Message Counts</title>
+
+<para>
+If <link linkend="mail-check-stats">$mail_check_stats</link> is set,
+Mutt will periodically calculate the unread, flagged, and total
+message counts for each mailbox watched by the
+<command>mailboxes</command> command.  This calculation takes place at
+the same time as new mail polling, but is controlled by a separate
+timer: <link
+linkend="mail-check-stats-interval">$mail_check_stats_interval</link>.
+</para>
+
+<para>
+The sidebar can display these message counts.  See <link
+linkend="sidebar-format">$sidebar_format</link>.
+</para>
+
+</sect2>
+
 </sect1>
 
 <sect1 id="editing-threads">
diff --git a/init.h b/init.h
index 47b5647e6..add9e806f 100644
--- a/init.h
+++ b/init.h
@@ -2744,7 +2744,7 @@ struct option_t MuttVars[] = {
   ** @ = Only applicable to the current folder
   ** .pp
   ** In order to use %S, %N, %F, and %!, $$mail_check_stats must
-  ** be \fIset\fP.  When set, a useful value for this setting is
+  ** be \fIset\fP.  When thus set, a suggested value for this option is
   ** "%B%?F? [%F]?%* %?N?%N/?%S".
   */
   { "sidebar_indent_string", DT_STR, R_BOTH, UL &SidebarIndentString, UL "  " },