add docs

diff --git a/README.quasi-delete b/README.quasi-delete
new file mode 100644 (file)
index 0000000..f010c5b
--- /dev/null
+++ b/README.quasi-delete
@@ -0,0 +1,49 @@
+Quasi-Delete Patch
+==================
+
+    Mark emails that should be hidden, but not deleted
+
+Patch
+-----
+
+    To check if Mutt supports "Quasi-Delete", look for "patch-quasi-delete" in
+    the mutt version.
+
+    Dependencies
+    * mutt-1.5.24
+
+Introduction
+------------
+
+    The "quasi-delete" function marks an email that should be hidden from the
+    index, but NOT deleted.
+
+    On its own, this patch isn't very useful. It forms a useful part of the
+    notmuch plugin.
+
+Functions
+---------
+
+    Quasi-Delete Functions
+
+    | Menus       | Default Key | Function         | Description                           |
+    |-------------|-------------|------------------|---------------------------------------|
+    | index,pager | (none)      | '<quasi-delete>' | delete from mutt, don't touch on disk |
+
+See Also
+--------
+
+    * NeoMutt project
+    * notmuch patch
+
+Known Bugs
+----------
+
+    None
+
+Credits
+-------
+
+    * Karel Zak <kzak@redhat.com>
+    * Richard Russon <rich@flatcap.org>
+

diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index b90908f001610306861479d3bc7440f848d5e17c..85ce4c02dcee2cd48dfc355fbfd9d41ad6a5f7ad 100644 (file)
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -8081,6 +8081,126 @@ please have a look at the mixmaster documentation.
 
 </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.5.24</para></listitem>
+               </itemizedlist>
+
+               <para>This patch is part of the <ulink url="https://github.com/neomutt/neomutt/wiki">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="https://github.com/neomutt/neomutt/wiki">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>
+
 </chapter>
 
 <chapter id="security">

diff --git a/doc/muttrc.quasi-delete b/doc/muttrc.quasi-delete
new file mode 100644 (file)
index 0000000..67031ff
--- /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 (file)
index 0000000..f8a69e7
--- /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