add docs

diff --git a/README.fmemopen b/README.fmemopen
new file mode 100644 (file)
index 0000000..42f0a10
--- /dev/null
+++ b/README.fmemopen
@@ -0,0 +1,47 @@
+Fmemopen Patch
+==============
+
+    Replace some temporary files with memory buffers
+
+Patch
+-----
+
+    To check if Mutt supports "fmemopen", look for "patch-fmemopen" in the mutt
+    version.
+
+    Dependencies
+    * mutt-1.5.24
+    * 'open_memstream()', 'fmemopen()' from glibc
+
+Introduction
+------------
+
+    The "fmemopen" patch speeds up some searches.
+
+    This patch changes a few places where Mutt creates temporary files. It
+    replaces them with in-memory buffers. This should improve the performance
+    when searching the header or body using the $thorough_search option.
+
+    There are no user-configurable parts.
+
+    This patch depends on 'open_memstream()' and 'fmemopen()'. They are
+    provided by glibc. Without them, Mutt will simply create temporary files.
+
+See Also
+--------
+
+    * NeoMutt project
+    * Compile-Time Features
+    * 'fmemopen(3)'
+
+Known Bugs
+----------
+
+    None
+
+Credits
+-------
+
+    * Julius Plenz <plenz@cis.fu-berlin.de>
+    * Richard Russon <rich@flatcap.org>
+

diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index b90908f001610306861479d3bc7440f848d5e17c..807a95bd3a5cc6925a1a07289c264aedb14638a1 100644 (file)
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -8081,6 +8081,109 @@ please have a look at the mixmaster documentation.
 
 </sect1>
 
+<sect1 id="fmemopen">
+       <title>Fmemopen Patch</title>
+       <subtitle>Replace some temporary files with memory buffers</subtitle>
+
+       <sect2 id="fmemopen-patch">
+               <title>Patch</title>
+
+               <para>
+                       To check if Mutt supports <quote>fmemopen</quote>, look for
+                       <quote>patch-fmemopen</quote> in the mutt version.
+                       See: <xref linkend="mutt-patches"/>.
+               </para>
+
+               <itemizedlist>
+                       <title>Dependencies:</title>
+                       <listitem><para>mutt-1.5.24</para></listitem>
+                       <listitem><para><literal>open_memstream()</literal>, <literal>fmemopen()</literal> from glibc</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="fmemopen-intro">
+               <title>Introduction</title>
+
+        <para>
+               The <quote>fmemopen</quote> patch speeds up some searches.
+        </para>
+
+        <para>
+               This patch changes a few places where Mutt creates temporary files.
+               It replaces them with in-memory buffers.  This should improve the
+               performance when searching the header or body using the
+               <link linkend="thorough-search">$thorough_search</link> option.
+        </para>
+
+        <para>
+               There are no user-configurable parts.
+        </para>
+
+        <para>
+               This patch depends on <literal>open_memstream()</literal> and
+               <literal>fmemopen()</literal>.  They are provided by glibc.  Without
+               them, Mutt will simply create temporary files.
+        </para>
+       </sect2>
+
+<!--
+       <sect2 id="fmemopen-variables">
+               <title>Variables</title>
+               <para>None</para>
+       </sect2>
+
+       <sect2 id="fmemopen-functions">
+               <title>Functions</title>
+               <para>None</para>
+       </sect2>
+
+       <sect2 id="fmemopen-commands">
+               <title>Commands</title>
+               <para>None</para>
+       </sect2>
+
+       <sect2 id="fmemopen-colors">
+               <title>Colors</title>
+               <para>None</para>
+       </sect2>
+
+       <sect2 id="fmemopen-sort">
+               <title>Sort</title>
+               <para>None</para>
+       </sect2>
+-->
+
+       <sect2 id="fmemopen-muttrc">
+               <title>Muttrc</title>
+               <para>None</para>
+       </sect2>
+
+       <sect2 id="fmemopen-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="compile-time-features">Compile-Time Features</link></para></listitem>
+                       <listitem><para><literal>fmemopen(3)</literal></para></listitem>
+               </itemizedlist>
+       </sect2>
+
+       <sect2 id="fmemopen-known-bugs">
+               <title>Known Bugs</title>
+               <para>None</para>
+       </sect2>
+
+       <sect2 id="fmemopen-credits">
+               <title>Credits</title>
+               <itemizedlist>
+               <listitem><para>Julius Plenz <email>plenz@cis.fu-berlin.de</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.fmemopen b/doc/muttrc.fmemopen
new file mode 100644 (file)
index 0000000..e69de29