Properly document simple searches and its "secret" keywords. Closes #2136.

diff --git a/ChangeLog b/ChangeLog
index 38954636d28430c005383155dd109cd77e5a159e..baf3b40c3bd44f308a4d202b810d500acb6343d0 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2007-11-13 13:31 +0100  Rocco Rutte  <pdmef@gmx.net>  (7a4a154eefa5)
+
+       * wcwidth.c: Fix compiler warnings in new wcwidth.c (too large values
+       for 'unsigned short')
+
+2007-11-13 11:53 +0100  Rocco Rutte  <pdmef@gmx.net>  (9e0bcfee7478)
+
+       * ChangeLog, hg-commit: hg-commit: Run 'make validate' in doc/ if
+       manual.xml is present
+
 2007-11-13 11:50 +0100  Rocco Rutte  <pdmef@gmx.net>  (4ded279d93bb)
 
        * doc/manual.xml.head, init.h: Document that %f in $index_format is

diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index 7129a7d206a7dd392f2af365737d1cb878ae4a7c..967ec4f700cf99006c09a277bdc88a7c526568d5 100644 (file)
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -3817,7 +3817,7 @@ they may or may not be available in stock libraries on various systems.
 </sect1>
 
 <sect1 id="patterns">
-<title>Patterns</title>
+<title>Patterns: Searching, Limiting and Tagging</title>
 
 <para>
 Many of Mutt's commands allow you to specify a pattern to match
@@ -3938,6 +3938,58 @@ This example matches all mails which only has recipients from Germany.
 
 </sect2>
 
+<sect2>
+<title>Simple Patterns</title>
+
+<para>
+Mutt supports two versions of so called ``simple searches'' which are
+issued if the pattern entered for searching, limiting and similar
+operations does not actually contain a pattern modifier.
+</para>
+
+<para>
+The first type is by checking whether the query string equals
+a keyword case-insensitively from <xref linkend="tab-simplesearch-keywords"/>:
+If that is the case, Mutt will use the shown pattern modifier instead.
+If a keyword would conflict with your search keyword, you need to turn
+it into a regular expression to avoid matching the keyword table. For
+example, if you want to find all messages matching ``<literal>flag</literal>''
+(using <link linkend="simple-search">&dollar;simple&lowbar;search</link>,
+see below but not meaning flagged messages) simply search for
+``<literal>&lsqb;f&rsqb;lag</literal>''.
+</para>
+
+<table id="tab-simplesearch-keywords">
+<title>Simple search keywords</title>
+<tgroup cols="2">
+<thead>
+<row><entry>Keyword</entry><entry>Pattern modifier</entry></row>
+</thead>
+<tbody>
+<row><entry>all</entry><entry>~A</entry></row>
+<row><entry>.</entry><entry>~A</entry></row>
+<row><entry>&circ;</entry><entry>~A</entry></row>
+<row><entry>del</entry><entry>~D</entry></row>
+<row><entry>flag</entry><entry>~F</entry></row>
+<row><entry>new</entry><entry>~N</entry></row>
+<row><entry>old</entry><entry>~O</entry></row>
+<row><entry>repl</entry><entry>~Q</entry></row>
+<row><entry>read</entry><entry>~R</entry></row>
+<row><entry>tag</entry><entry>~T</entry></row>
+<row><entry>unread</entry><entry>~U</entry></row>
+</tbody>
+</tgroup>
+</table>
+
+<para>
+The second type of simple search is to build a complex search
+pattern using <link linkend="simple-search">&dollar;simple&lowbar;search</link>
+as a template. Mutt will insert your query properly quoted and search
+for the composed complex query.
+</para>
+
+</sect2>
+
 <sect2>
 <title>Complex Patterns</title>