Update.

[mymail.git] / mymail.1

diff --git a/mymail.1 b/mymail.1
index f2ba3f5..92dbb56 100644 (file)
--- a/mymail.1
+++ b/mymail.1
@@ -6,7 +6,7 @@
 
 .SH "NAME"
 
-mymail \- A simple command line utility for dynamic pattern selection
+mymail \- A simple command line utility for indexing and searching mbox files
 
 .SH "SYNOPSIS"
 
@@ -20,6 +20,22 @@ perform quick searches based on sender, subject, etc.
 It is similar in spirit to other existing software such as mu or
 notmuch.
 
+.SH "SEARCH SYNTAX"
+
+The search conditions take the form of a single letter followed by a
+space and a regexp, which can itself contain spaces. If the condition
+is prefaced by the character "!" it is negated, and has to be false
+for a mail to be selected.
+
+.TP
+\fBf <regexp>\fR selects mails whose field From, From:, or Reply-To: matches the regexp. Since the initial "From " line contains the date, this search criterion can be used to restrict to a certain year or month.
+.TP
+\fBd <regexp>\fR selects mails whose field To:, Cc:, or Bcc: matches the regexp.
+.TP
+\fBp <regexp>\fR selects mails whose field From, From:, Reply-To:, To:, Cc:, or Bcc: matches the regexp.
+.TP
+\fBs <regexp>\fR selects mails whose field Subject: matches the regexp.
+
 .SH "EXAMPLES"
 
 To index all the mbox present in the directory ~/my_mboxes and create