Update.

[mymail.git] / mymail.1

diff --git a/mymail.1 b/mymail.1
index 917e97c..c6b00b3 100644 (file)
--- a/mymail.1
+++ b/mymail.1
@@ -29,6 +29,9 @@ display help and exit
 \fB-v\fR, \fB--version\fR
 print the version number
 .TP
 \fB-v\fR, \fB--version\fR
 print the version number
 .TP

+\fB-q\fR, \fB--quiet\fR
+do not write information during the search
+.TP

 \fB-p <db filename pattern>\fR, \fB--db-pattern <db filename pattern>\fR
 set the db filename pattern for recursive search
 .TP
 \fB-p <db filename pattern>\fR, \fB--db-pattern <db filename pattern>\fR
 set the db filename pattern for recursive search
 .TP


@@ -47,6 +50,13 @@ set the db filename for indexing
 \fB-i\fR, \fB--index\fR
 index mails in the mailboxes located recursively anywhere in the
 directories following the options on the command lines
 \fB-i\fR, \fB--index\fR
 index mails in the mailboxes located recursively anywhere in the
 directories following the options on the command lines

+.TP
+\fB-o <output filename>\fR, \fB--output <output filename>\fR
+set the db filename pattern for recursive search
+.TP
+\fB-a <search field>\fR, \fB--default-search <search field>\fR
+set the default search field: If a search request is not understood,
+it is interpreted as the regexp with this default search field

 
 .SH "ENVIRONMENT VARIABLES"
 
 
 .SH "ENVIRONMENT VARIABLES"
 


@@ -84,38 +94,62 @@ or fields From:, Reply-To:, To:, Cc:, or Bcc: matches the regexp.
 \fBd <regexp>\fR (date) selects mails whose field Date: matches the regexp.
 .TP
 \fBb <regexp>\fR (body) selects mails whose body matches the
 \fBd <regexp>\fR (date) selects mails whose field Date: matches the regexp.
 .TP
 \fBb <regexp>\fR (body) selects mails whose body matches the

-regexp. This requires reading the original mboxes completely, which
-can be slow. Header conditions have to be fulfilled before checking
-the body ones, which may speed things up.
+regexp. Evaluatin such a condition requires to read the original
+mboxes completely, which can be slow. However, header conditions are
+checked first to read the bodies only for mails which fulfill them
+entirely.
+.TP
+\fB8h\fR, \fBtoday\fR, \fB24h\fR, \fBweek\fR, and \fBmonth\fR selects
+mails received respectively during the last 8, 24, 24, 7 * 24 hours or
+31 * 24 hours.
+.TP
+\fByesterday\fR selects mails received between 48h and 24h ago.
+.TP
+\fBmonday\fR, \fBtuesday\fR, ..., \fBsunday\fR selects mails received
+the most recent such day

 
 .SH "EXAMPLES"
 
 
 .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
 
 .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
 
 .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
 
 .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
 
 .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
 will not catch patterns in encoded text.
 
 .SH "BUGS"
 
 The search in the mail bodies does not decode mimencoding mails, hence
 will not catch patterns in encoded text.
 

+The mbox format is not clear for multipart messages, since the ^"From
+" lines are not always quoted properly (at least the ones I have to
+test).
+

 .SH "AUTHOR"
 
 Written by Francois Fleuret <francois@fleuret.org> and distributed
 .SH "AUTHOR"
 
 Written by Francois Fleuret <francois@fleuret.org> and distributed