docs: timeout

diff --git a/README.timeout b/README.timeout
new file mode 100644 (file)
index 0000000..3b96a1c
--- /dev/null
+++ b/README.timeout
@@ -0,0 +1,41 @@
+Timeout Patch
+=============
+
+    Run a command periodically
+
+Patch
+-----
+
+    To check if Mutt supports "Timeout", look for "patch-timeout" in the mutt
+    version.
+
+    Dependencies
+    * mutt-1.6.2
+
+Introduction
+------------
+
+    This patch implements a new hook that is called periodically when Mutt
+    checks for new mail. This hook is called every `$timeout` seconds.
+
+Commands
+--------
+
+    timeout-hook .  MUTT-COMMAND
+
+See Also
+--------
+
+    * $timeout
+
+Known Bugs
+----------
+
+    None
+
+Credits
+-------
+
+    * Armin Wolfermann <armin@wolfermann.org>
+    * Richard Russon <rich@flatcap.org>
+

diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index c97c415699c965e71ad503345dd29d7ce155a0d6..563701554a7f058b30b2eabb1ea6f42b949466db 100644 (file)
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -13180,6 +13180,88 @@ color status brightwhite default 'Mutt: ([^ ]+)' 1
   </sect2>
 </sect1>
 
+<sect1 id="timeout-hook">
+  <title>Timeout Patch</title>
+  <subtitle>Run a command periodically</subtitle>
+
+  <sect2 id="timeout-patch">
+    <title>Patch</title>
+
+    <para>
+      To check if Mutt supports <quote>timeout</quote>, look for
+      <quote>patch-timeout</quote> in the mutt version.
+      See: <xref linkend="mutt-patches"/>.
+    </para>
+
+    <itemizedlist>
+      <title>Dependencies:</title>
+      <listitem><para>mutt-1.6.2</para></listitem>
+    </itemizedlist>
+
+    <para>This patch is part of the <ulink url="http://www.neomutt.org/">NeoMutt Project</ulink>.</para>
+  </sect2>
+
+  <sect2 id="timeout-intro">
+    <title>Introduction</title>
+
+    <para>
+      This patch implements a new hook that is called periodically when Mutt
+      checks for new mail. This hook is called every <literal>$timeout</literal> seconds.
+    </para>
+  </sect2>
+
+  <sect2 id="timeout-commands">
+    <title>Commands</title>
+    <cmdsynopsis>
+      <command>timeout-hook</command>
+      <arg choice="plain">
+        <replaceable class="parameter">.</replaceable>
+      </arg>
+      <arg choice="plain">
+        <replaceable class="parameter">MUTT-COMMAND</replaceable>
+      </arg>
+    </cmdsynopsis>
+  </sect2>
+
+  <sect2 id="timeout-muttrc">
+    <title>Muttrc</title>
+<screen>
+<emphasis role="comment"># This is a complete list of timeout configuration.
+
+# --------------------------------------------------------------------------
+# COMMANDS - shown with an example arguments
+# --------------------------------------------------------------------------
+
+# After $timeout seconds of inactivity, run this mutt command</emphasis>
+timeout-hook . 'exec sync-mailbox'
+
+<emphasis role="comment"># vim: syntax=muttrc</emphasis>
+</screen>
+  </sect2>
+
+  <sect2 id="timeout-see-also">
+    <title>See Also</title>
+
+    <itemizedlist>
+      <listitem><para><ulink url="http://www.neomutt.org/">NeoMutt Project</ulink></para></listitem>
+      <listitem><para><link linkend="timeout">$timeout</link></para></listitem>
+    </itemizedlist>
+  </sect2>
+
+  <sect2 id="timeout-known-bugs">
+    <title>Known Bugs</title>
+    <para>None</para>
+  </sect2>
+
+  <sect2 id="timeout-credits">
+    <title>Credits</title>
+    <itemizedlist>
+    <listitem><para>Armin Wolfermann <email>armin@wolfermann.org</email></para></listitem>
+    <listitem><para>Richard Russon <email>rich@flatcap.org</email></para></listitem>
+    </itemizedlist>
+  </sect2>
+</sect1>
+
 <sect1 id="tls-sni">
   <title>TLS-SNI Patch</title>
   <subtitle>Negotiate with a server for a TSL/SSL certificate</subtitle>

diff --git a/doc/muttrc.timeout b/doc/muttrc.timeout
new file mode 100644 (file)
index 0000000..911d92a
--- /dev/null
+++ b/doc/muttrc.timeout
@@ -0,0 +1,10 @@
+# This is a complete list of timeout configuration.
+
+# --------------------------------------------------------------------------
+# COMMANDS - shown with an example arguments
+# --------------------------------------------------------------------------
+
+# After $timeout seconds of inactivity, run this mutt command
+timeout-hook . 'exec sync-mailbox'
+
+# vim: syntax=muttrc

diff --git a/doc/vimrc.timeout b/doc/vimrc.timeout
new file mode 100644 (file)
index 0000000..d94c40a
--- /dev/null
+++ b/doc/vimrc.timeout
@@ -0,0 +1,5 @@
+" Vim syntax file for the mutt timeout patch
+
+syntax keyword muttrcCommand    timeout-hook
+
+" vim: syntax=vim