From: Richard Russon <rich@flatcap.org>
Date: Tue, 2 Aug 2016 09:16:16 +0000 (+0100)
Subject: docs: limit-current-thread
X-Git-Tag: neomutt-20160822~24^2~13
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f63eb45acf7519a431261319d7ee39475d96e806;p=neomutt

docs: limit-current-thread
---

diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index 24925681d..3ddaa1e66 100644
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -9948,6 +9948,128 @@ bind index,pager y edit-label
   </sect2>
 </sect1>
 
+<sect1 id="limit-current-thread">
+  <title>Limit-Current-Thread Patch</title>
+  <subtitle>Focus on one Email Thread</subtitle>
+
+  <sect2 id="limit-current-thread-patch">
+    <title>Patch</title>
+
+    <para>
+      To check if Mutt supports <quote>limit-current-thread</quote>, look for
+      <quote>patch-limit-current-thread</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="limit-current-thread-intro">
+    <title>Introduction</title>
+
+    <para>
+      This patch adds a new way of using the
+      <link linkend="tuning-search">Limit Command</link>.
+      The <literal>&lt;limit-current-thread&gt;</literal>
+      function restricts the view to just the current thread.
+      Setting the limit (the <literal>l</literal> key) to
+      <quote>all</quote> will restore the full email list.
+    </para>
+
+  </sect2>
+
+<!--
+  <sect2 id="limit-current-thread-variables">
+    <title>Variables</title>
+    <para>None</para>
+  </sect2>
+-->
+  <sect2 id="limit-current-thread-functions">
+    <title>Functions</title>
+
+    <para>
+      Limit-current-thread adds the following function to Mutt.
+      By default, it is not bound to a key.
+    </para>
+
+    <table id="table-limit-current-thread-functions">
+      <title>Limit-Current-Thread Functions</title>
+      <tgroup cols="3">
+        <thead>
+          <row>
+            <entry>Menus</entry>
+            <entry>Function</entry>
+            <entry>Description</entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry>index</entry>
+            <entry><literal>&lt;limit-current-thread&gt;</literal></entry>
+            <entry>Limit view to current thread</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+
+  </sect2>
+<!--
+  <sect2 id="limit-current-thread-commands">
+    <title>Commands</title>
+    <para>None</para>
+  </sect2>
+
+  <sect2 id="limit-current-thread-colors">
+    <title>Colors</title>
+    <para>None</para>
+  </sect2>
+
+  <sect2 id="limit-current-thread-sort">
+    <title>Sort</title>
+    <para>None</para>
+  </sect2>
+-->
+
+  <sect2 id="limit-current-thread-muttrc">
+    <title>Muttrc</title>
+
+<screen>
+<emphasis role="comment"># Example Mutt config file for the 'limit-current-thread' patch.
+ 
+# Limit view to current thread</emphasis>
+bind index &lt;esc&gt;L limit-current-thread
+ 
+<emphasis role="comment"># vim: syntax=muttrc</emphasis>
+</screen>
+  </sect2>
+
+  <sect2 id="limit-current-thread-see-also">
+    <title>See Also</title>
+
+    <itemizedlist>
+      <listitem><para><ulink url="http://www.neomutt.org/">NeoMutt Project</ulink></para></listitem>
+    </itemizedlist>
+  </sect2>
+
+  <sect2 id="limit-current-thread-known-bugs">
+    <title>Known Bugs</title>
+    <para>None</para>
+  </sect2>
+
+  <sect2 id="limit-current-thread-credits">
+    <title>Credits</title>
+    <itemizedlist>
+    <listitem><para>David Sterba <email>dsterba@suse.cz</email></para></listitem>
+    <listitem><para>Richard Russon <email>rich@flatcap.org</email></para></listitem>
+    </itemizedlist>
+  </sect2>
+</sect1>
+
 <sect1 id="sidebar">
   <title>Sidebar</title>
   <subtitle>Overview of mailboxes</subtitle>
diff --git a/doc/muttrc.limit-current-thread b/doc/muttrc.limit-current-thread
new file mode 100644
index 000000000..5d32cf5cc
--- /dev/null
+++ b/doc/muttrc.limit-current-thread
@@ -0,0 +1,6 @@
+# Example Mutt config file for the 'limit-current-thread' patch.
+ 
+# Limit view to current thread
+bind index <esc>L limit-current-thread
+ 
+# vim: syntax=muttrc