<<< Date Index >>>     <<< Thread Index >>>

[PATCH] Document history more verbosely (was: [patch] space avoids recording in history)



Hi,

* Paul Walker [06-07-05 10:43:22 +0100] wrote:

Sorry to be a pain, but I didn't see any doc updates in that patch. Did
someone update the docs to reflect this when it was committed?

No, not yet.

Attached is a patch documenting how the history works. I've also tried to add more subsections so that the user can actually find things from the table of contents straight away.

If there's need to further tune the patch for inclusion, I can push the branch out to my public mutt git tree in case somebody wants to help...

  bye, Rocco
--
:wq!
diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index 206960c..cceb054 100644
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -229,10 +229,15 @@ showing the common keys used to navigate
 <sect1 id="editing">
 <title>Editing Input Fields</title>
 
+<sect2 id="editing-intro">
+<title>Introduction</title>
+
 <para>
 Mutt has a builtin line editor which is used as the primary way to input
 textual data such as email addresses or filenames.  The keys used to move
-around while editing are very similar to those of Emacs.
+around while editing are very similar to those of Emacs, see the
+following table for a full reference of available functions, their
+default key bindings and short descriptions.
 </para>
 
 <para>
@@ -279,10 +284,36 @@ command.  For example, to make the <emph
 front of the cursor rather than under, you could use
 </para>
 
+<screen>
+bind editor &lt;delete&gt; backspace
+</screen>
+
+</sect2>
+
+<sect2 id="editing-history">
+<title>Builtin History</title>
+
+<para>
+The editor's builtin history size is controlled by the
+<link linkend="history">&dollar;history</link> variable: the history
+contains this many items to be cycled with the
+<literal>history-up</literal> and/or <literal>history-down</literal>
+commands at any time.
+</para>
+
+<para>
+When recording items into the history, mutt ensures that repeated
+commands are ignored. It also mimics the behaviour of some shells by
+ignoring items starting with a space.
+</para>
+
 <para>
-<literal>bind editor &lt;delete&gt; backspace</literal>
+The latter feature can be useful in macros to not clobber the history's
+valuable entries with unwanted entries.
 </para>
 
+</sect2>
+
 </sect1>
 
 <sect1 id="reading">