Now use db_filename_regexp_string for recursive search of db files.

[mymail.git] / mymail.1

diff --git a/mymail.1 b/mymail.1
index f2ba3f5..abfd077 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,24 +20,43 @@ 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
+\fBt <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.
+.TP
+\fBd <regexp>\fR selects mails whose field Date: matches the regexp.
+
 .SH "EXAMPLES"
 
-To index all the mbox present in the directory ~/my_mboxes and create
-a db file /tmp/mymail.db
+To index all the mbox files present in the directory ~/archives/mails/2010
+(recursively) and create a data-base file /tmp/mymail/2010/mymail.db
 
 .RS
 .EX
-mymail --index --db-file /tmp/mymail.db /tmp/my_mboxes
+mymail --index --db-file /tmp/mymail/2010/mymail.db ~/archives/mails/2010
 .EE
 .RE
 
-To search in /tmp/mymail_2010.db and /tmp/mymail_2011.db for all mails
-having bob.something as sender or recipient, without "spam" in the
-subject
+To search in all the data-base files mymail.db located (recursively)
+in /tmp/mymail, for all the mails having bob.something as sender or
+recipient, without "spam" in the subject, and creating a result mbox
+file /tmp/mymail/mbox
 
 .RS
 .EX
-mymail --search "p bob.something,!s spam" /tmp/mymail_2010.db /tmp/mymail_2011.db
+mymail --db-file mymail.db --db-root /tmp/mymail --search 'p bob.something' --search '!s spam' > /tmp/mymail.mbox
 .EE
 .RE