add docs

diff --git a/README.trash b/README.trash
new file mode 100644 (file)
index 0000000..7da2dd4
--- /dev/null
+++ b/README.trash
@@ -0,0 +1,74 @@
+Trash Folder Patch
+==================
+
+    Automatically move "deleted" emails to a trash bin
+
+Patch
+-----
+
+    To check if Mutt supports "Trash Folder", look for "patch-trash" in the
+    mutt version.
+
+    If IMAP is enabled, this patch will use it
+
+    Dependencies
+    * mutt-1.5.24
+    * IMAP support
+
+Introduction
+------------
+
+    In Mutt, when you "delete" an email it is first marked deleted. The email
+    isn't really gone until <sync-mailbox> is called. This happens when the
+    user leaves the folder, or the function is called manually.
+
+    After '<sync-mailbox>' has been called the email is gone forever.
+
+    The $trash variable defines a folder in which to keep old emails. As
+    before, first you mark emails for deletion. When <sync-mailbox> is called
+    the emails are moved to the trash folder.
+
+    The '$trash' path can be either a full directory, or be relative to the
+    $folder variable, like the 'mailboxes' command.
+
+    > Note
+    >
+    > Emails deleted from the trash folder are gone forever.
+
+Variables
+---------
+
+    Trash Variables
+
+    | Name  | Type   | Default |
+    |-------|--------|---------|
+    | trash | string | (none)  |
+
+Functions
+---------
+
+    Trash Functions
+
+    | Menus       | Default Key | Function          | Description                                                 |
+    |-------------|-------------|-------------------|-------------------------------------------------------------|
+    | index,pager | (none)      | '<purge-message>' | really delete the current entry, bypassing the trash folder |
+
+See Also
+--------
+
+    * NeoMutt project
+    * folder-hook
+
+Known Bugs
+----------
+
+    None
+
+Credits
+-------
+
+    * Cedric Duval <cedricduval@free.fr>
+    * Benjamin Kuperman <kuperman@acm.org>
+    * Paul Miller <paul@voltar.org>
+    * Richard Russon <rich@flatcap.org>
+

diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index b90908f001610306861479d3bc7440f848d5e17c..35a27758f56245f7bb341077a37bcd61610e1c6b 100644 (file)
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -8081,6 +8081,175 @@ please have a look at the mixmaster documentation.
 
 </sect1>
 
+<sect1 id="trash-folder">
+       <title>Trash Folder Patch</title>
+       <subtitle>Automatically move "deleted" emails to a trash bin</subtitle>
+
+       <sect2 id="trash-folder-patch">
+               <title>Patch</title>
+
+               <para>
+                       To check if Mutt supports <quote>Trash Folder</quote>, look for
+                       <quote>patch-trash</quote> in the mutt version.
+                       See: <xref linkend="mutt-patches"/>.
+               </para>
+
+               If IMAP is enabled, this patch will use it
+
+               <itemizedlist>
+                       <title>Dependencies:</title>
+                       <listitem><para>mutt-1.5.24</para></listitem>
+                       <listitem><para>IMAP support</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="trash-folder-intro">
+               <title>Introduction</title>
+
+               <para>
+               In Mutt, when you <quote>delete</quote> an email it is first marked
+               deleted.  The email isn't really gone until
+               <link linkend="index-map">&lt;sync-mailbox&gt;</link> is called.
+               This happens when the user leaves the folder, or the function is called
+               manually.
+               </para>
+
+               <para>
+               After <literal>&lt;sync-mailbox&gt;</literal> has been called the email is gone forever.
+               </para>
+
+               <para>
+               The <link linkend="trash">$trash</link> variable defines a folder in
+               which to keep old emails.  As before, first you mark emails for
+               deletion.  When &lt;sync-mailbox&gt; is called the emails are moved to
+               the trash folder.
+               </para>
+
+               <para>
+               The <literal>$trash</literal> path can be either a full directory,
+               or be relative to the <link linkend="folder">$folder</link>
+               variable, like the <literal>mailboxes</literal> command.
+               </para>
+
+               <note>
+               Emails deleted from the trash folder are gone forever.
+               </note>
+       </sect2>
+
+       <sect2 id="trash-folder-variables">
+               <title>Variables</title>
+               <table id="table-trash-variables">
+                       <title>Trash Variables</title>
+                       <tgroup cols="3">
+                               <thead>
+                                       <row>
+                                               <entry>Name</entry>
+                                               <entry>Type</entry>
+                                               <entry>Default</entry>
+                                       </row>
+                               </thead>
+                               <tbody>
+                                       <row>
+                                               <entry>trash</entry>
+                                               <entry>string</entry>
+                                               <entry>(none)</entry>
+                                       </row>
+                               </tbody>
+                       </tgroup>
+               </table>
+       </sect2>
+
+       <sect2 id="trash-folder-functions">
+               <title>Functions</title>
+               <table id="table-trash-functions">
+                       <title>Trash 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;purge-message&gt;</literal></entry>
+                                               <entry>really delete the current entry, bypassing the trash folder</entry>
+                                       </row>
+                               </tbody>
+                       </tgroup>
+               </table>
+       </sect2>
+
+<!--
+       <sect2 id="trash-folder-commands">
+               <title>Commands</title>
+               <para>None</para>
+       </sect2>
+
+       <sect2 id="trash-folder-colors">
+               <title>Colors</title>
+               <para>None</para>
+       </sect2>
+
+       <sect2 id="trash-folder-sort">
+               <title>Sort</title>
+               <para>None</para>
+       </sect2>
+-->
+
+       <sect2 id="trash-folder-muttrc">
+               <title>Muttrc</title>
+<screen>
+<emphasis role="comment"># Example Mutt config file for the 'trash' feature.
+ 
+# This feature defines a new 'trash' folder.
+# When mail is deleted it will be moved to this folder.
+ 
+# Folder in which to put deleted emails</emphasis>
+set trash='+Trash'
+set trash='/home/flatcap/Mail/Trash'
+ 
+<emphasis role="comment"># The default delete key 'd' will move an email to the 'trash' folder
+# Bind 'D' to REALLY delete an email</emphasis>
+bind index D purge-message
+ 
+<emphasis role="comment"># Note: Deleting emails from the 'trash' folder will REALLY delete them.
+ 
+# vim: syntax=muttrc</emphasis>
+</screen>
+       </sect2>
+
+       <sect2 id="trash-folder-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="folder-hook">folder-hook</link></para></listitem>
+               </itemizedlist>
+       </sect2>
+
+       <sect2 id="trash-folder-known-bugs">
+               <title>Known Bugs</title>
+               <para>None</para>
+       </sect2>
+
+       <sect2 id="trash-folder-credits">
+               <title>Credits</title>
+               <itemizedlist>
+               <listitem><para>Cedric Duval <email>cedricduval@free.fr</email></para></listitem>
+               <listitem><para>Benjamin Kuperman <email>kuperman@acm.org</email></para></listitem>
+               <listitem><para>Paul Miller <email>paul@voltar.org</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.trash b/doc/muttrc.trash
new file mode 100644 (file)
index 0000000..8ecf8f0
--- /dev/null
+++ b/doc/muttrc.trash
@@ -0,0 +1,16 @@
+# Example Mutt config file for the 'trash' feature.
+
+# This feature defines a new 'trash' folder.
+# When mail is deleted it will be moved to this folder.
+
+# Folder in which to put deleted emails
+set trash='+Trash'
+set trash='/home/flatcap/Mail/Trash'
+
+# The default delete key 'd' will move an email to the 'trash' folder
+# Bind 'D' to REALLY delete an email
+bind index D purge-message
+
+# Note: Deleting emails from the 'trash' folder will REALLY delete them.
+
+# vim: syntax=muttrc

diff --git a/doc/vimrc.trash b/doc/vimrc.trash
new file mode 100644 (file)
index 0000000..73b3137
--- /dev/null
+++ b/doc/vimrc.trash
@@ -0,0 +1,7 @@
+" Vim syntax file for the mutt trash patch
+
+syntax keyword muttrcVarStr     contained skipwhite trash                 nextgroup=muttrcVarEqualsIdxFmt
+
+syntax match muttrcFunction     contained "\<purge-message\>"
+
+" vim: syntax=vim