changeset: 6696:3d87b0521a45
user: Kevin McCarthy <ke...@8t8.us>
date: Mon Jun 20 20:09:52 2016 -0700
link: http://dev.mutt.org/hg/mutt/rev/3d87b0521a45
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.
diffs (57 lines):
diff -r 069c7a655ad5 -r 3d87b0521a45 doc/manual.xml.head
--- a/doc/manual.xml.head Mon Jun 20 10:11:36 2016 +0200
+++ b/doc/manual.xml.head Mon Jun 20 20:09:52 2016 -0700
@@ -6071,6 +6071,14 @@
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 @@
</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 -r 069c7a655ad5 -r 3d87b0521a45 init.h
--- a/init.h Mon Jun 20 10:11:36 2016 +0200
+++ b/init.h Mon Jun 20 20:09:52 2016 -0700
@@ -2744,7 +2744,7 @@
** @ = 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 " "
},
