From b9488a12e4dc3ab5a3e15859d19f9251f0e8f242 Mon Sep 17 00:00:00 2001
From: Richard Russon <rich@flatcap.org>
Date: Tue, 2 Aug 2016 10:17:45 +0100
Subject: [PATCH] docs: quasi-delete

---
 doc/manual.xml.head     | 120 ++++++++++++++++++++++++++++++++++++++++
 doc/muttrc.quasi-delete |   7 +++
 doc/vimrc.quasi-delete  |   5 ++
 3 files changed, 132 insertions(+)
 create mode 100644 doc/muttrc.quasi-delete
 create mode 100644 doc/vimrc.quasi-delete

diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index 8fab50e0d..d0ba1c20f 100644
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -11580,6 +11580,126 @@ color progress white red
   </sect2>
 </sect1>
 
+<sect1 id="quasi-delete">
+  <title>Quasi-Delete Patch</title>
+  <subtitle>Mark emails that should be hidden, but not deleted</subtitle>
+
+  <sect2 id="quasi-delete-patch">
+    <title>Patch</title>
+
+    <para>
+      To check if Mutt supports <quote>Quasi-Delete</quote>, look for
+      <quote>patch-quasi-delete</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="quasi-delete-intro">
+    <title>Introduction</title>
+
+        <para>
+    The <quote>quasi-delete</quote> function marks an email that should be
+    hidden from the index, but NOT deleted.
+        </para>
+
+        <para>
+    On its own, this patch isn't very useful.  It forms a useful part of
+    the notmuch plugin.
+        </para>
+  </sect2>
+
+<!--
+  <sect2 id="quasi-delete-variables">
+    <title>Variables</title>
+    <para>None</para>
+  </sect2>
+-->
+
+  <sect2 id="quasi-delete-functions">
+    <title>Functions</title>
+    <table id="table-quasi-delete-functions">
+      <title>Quasi-Delete Functions</title>
+      <tgroup cols="4">
+        <thead>
+          <row>
+            <entry>Menus</entry>
+            <entry>Default Key</entry>
+            <entry>Function</entry>
+            <entry>Description</entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry>index,pager</entry>
+            <entry>(none)</entry>
+            <entry><literal>&lt;quasi-delete&gt;</literal></entry>
+            <entry>delete from mutt, don't touch on disk</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+  </sect2>
+
+<!--
+  <sect2 id="quasi-delete-commands">
+    <title>Commands</title>
+    <para>None</para>
+  </sect2>
+
+  <sect2 id="quasi-delete-colors">
+    <title>Colors</title>
+    <para>None</para>
+  </sect2>
+
+  <sect2 id="quasi-delete-sort">
+    <title>Sort</title>
+    <para>None</para>
+  </sect2>
+-->
+
+  <sect2 id="quasi-delete-muttrc">
+    <title>Muttrc</title>
+<screen>
+<emphasis role="comment"># Example Mutt config file for the 'quasi-delete' feature.
+ 
+# The 'quasi-delete' function marks an email that should be hidden
+# from the index, but NOT deleted.</emphasis>
+bind index,pager Q quasi-delete
+ 
+<emphasis role="comment"># vim: syntax=muttrc</emphasis>
+</screen>
+  </sect2>
+
+  <sect2 id="quasi-delete-see-also">
+    <title>See Also</title>
+
+    <itemizedlist>
+      <listitem><para><ulink url="http://www.neomutt.org/">NeoMutt Project</ulink></para></listitem>
+      <listitem><para><link linkend="notmuch">notmuch patch</link></para></listitem>
+    </itemizedlist>
+  </sect2>
+
+  <sect2 id="quasi-delete-known-bugs">
+    <title>Known Bugs</title>
+    <para>None</para>
+  </sect2>
+
+  <sect2 id="quasi-delete-credits">
+    <title>Credits</title>
+    <itemizedlist>
+    <listitem><para>Karel Zak <email>kzak@redhat.com</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.quasi-delete b/doc/muttrc.quasi-delete
new file mode 100644
index 000000000..67031ffbb
--- /dev/null
+++ b/doc/muttrc.quasi-delete
@@ -0,0 +1,7 @@
+# Example Mutt config file for the 'quasi-delete' feature.
+
+# The 'quasi-delete' function marks an email that should be hidden
+# from the index, but NOT deleted.
+bind index,pager Q quasi-delete
+
+# vim: syntax=muttrc
diff --git a/doc/vimrc.quasi-delete b/doc/vimrc.quasi-delete
new file mode 100644
index 000000000..f8a69e758
--- /dev/null
+++ b/doc/vimrc.quasi-delete
@@ -0,0 +1,5 @@
+" Vim syntax file for the mutt quasi-delete patch
+
+syntax match muttrcFunction     contained "\<quasi-delete\>"
+
+" vim: syntax=vim
-- 
2.40.0