From: Francois Fleuret <francois@fleuret.org>
Date: Wed, 6 Feb 2013 18:26:47 +0000 (+0100)
Subject: Added an EXAMPLES section.
X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=commitdiff_plain;h=6bbb61e4cab435504f1ad5928d13a7efa9f99d64;p=mymail.git

Added an EXAMPLES section.
---

diff --git a/mymail.1 b/mymail.1
index 2cc4d0e..adfe684 100644
--- a/mymail.1
+++ b/mymail.1
@@ -110,27 +110,37 @@ the most recent such day
 
 .SH "EXAMPLES"
 
-To index all the mbox files present in the directories
-~/archives/mails/2010 and ~/archives/mails/2011 (recursively) and
-create a database file /tmp/mymail/2010-2011/mymail.db
+The command
 
 .RS
 .EX
-mymail --db-file /tmp/mymail/2010-2011/mymail.db --index ~/archives/mails/2010 ~/archives/mails/2011
+mymail --db-file /tmp/mymail/2010-2011/mymail.db \\
+       --index \\
+       ~/archives/mails/2010 ~/archives/mails/2011
 .EE
 .RE
 
-To search in all the database files *.db located (recursively) in
-/tmp/mymail, for all the mails having bob.something as sender or
-recipient, without "spam" in the subject, and create a result mbox
-file /tmp/mymail/mbox
+will index all the mbox files present in the directories
+~/archives/mails/2010 and ~/archives/mails/2011 (recursively) and
+create an index file /tmp/mymail/2010-2011/mymail.db
+
+And
 
 .RS
 .EX
-mymail --db-pattern '\\.db$' --db-root /tmp/mymail --search 'p bob.something' --search '!s spam' > /tmp/mymail.mbox
+mymail --db-pattern '\.db$' --db-root /tmp/mymail \\
+       --output /tmp/mymail.mbox \\
+       --search 'p bob.something' \\
+       --search '!s spam' \\
+       --search 'month'
 .EE
 .RE
 
+will search in all the database files *.db located (recursively) in
+/tmp/mymail, for all the mails having "bob.something" as sender or
+recipient, without "spam" in the subject, received over the last 31
+days, and create an mbox file /tmp/mymail/mbox.
+
 .SH "BUGS"
 
 The search in the mail bodies does not decode mimencoding mails, hence