Changeset 5302:933e57dff004 for doc

Show
Ignore:
Timestamp:
2007-11-15 02:22:11 (12 months ago)
Author:
Rocco Rutte <pdmef@…>
Branch:
HEAD
Message:

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

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • doc/manual.xml.head

    r5299 r5302  
    38183818 
    38193819<sect1 id="patterns"> 
    3820 <title>Patterns</title> 
     3820<title>Patterns: Searching, Limiting and Tagging</title> 
    38213821 
    38223822<para> 
     
    39403940 
    39413941<sect2> 
     3942<title>Simple Patterns</title> 
     3943 
     3944<para> 
     3945Mutt supports two versions of so called ``simple searches'' which are 
     3946issued if the pattern entered for searching, limiting and similar 
     3947operations does not actually contain a pattern modifier. 
     3948</para> 
     3949 
     3950<para> 
     3951The first type is by checking whether the query string equals 
     3952a keyword case-insensitively from <xref linkend="tab-simplesearch-keywords"/>: 
     3953If that is the case, Mutt will use the shown pattern modifier instead. 
     3954If a keyword would conflict with your search keyword, you need to turn 
     3955it into a regular expression to avoid matching the keyword table. For 
     3956example, if you want to find all messages matching ``<literal>flag</literal>'' 
     3957(using <link linkend="simple-search">&dollar;simple&lowbar;search</link>, 
     3958see below but not meaning flagged messages) simply search for 
     3959``<literal>&lsqb;f&rsqb;lag</literal>''. 
     3960</para> 
     3961 
     3962<table id="tab-simplesearch-keywords"> 
     3963<title>Simple search keywords</title> 
     3964<tgroup cols="2"> 
     3965<thead> 
     3966<row><entry>Keyword</entry><entry>Pattern modifier</entry></row> 
     3967</thead> 
     3968<tbody> 
     3969<row><entry>all</entry><entry>~A</entry></row> 
     3970<row><entry>.</entry><entry>~A</entry></row> 
     3971<row><entry>&circ;</entry><entry>~A</entry></row> 
     3972<row><entry>del</entry><entry>~D</entry></row> 
     3973<row><entry>flag</entry><entry>~F</entry></row> 
     3974<row><entry>new</entry><entry>~N</entry></row> 
     3975<row><entry>old</entry><entry>~O</entry></row> 
     3976<row><entry>repl</entry><entry>~Q</entry></row> 
     3977<row><entry>read</entry><entry>~R</entry></row> 
     3978<row><entry>tag</entry><entry>~T</entry></row> 
     3979<row><entry>unread</entry><entry>~U</entry></row> 
     3980</tbody> 
     3981</tgroup> 
     3982</table> 
     3983 
     3984<para> 
     3985The second type of simple search is to build a complex search 
     3986pattern using <link linkend="simple-search">&dollar;simple&lowbar;search</link> 
     3987as a template. Mutt will insert your query properly quoted and search 
     3988for the composed complex query. 
     3989</para> 
     3990 
     3991</sect2> 
     3992 
     3993<sect2> 
    39423994<title>Complex Patterns</title> 
    39433995