X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=mymail.git;a=blobdiff_plain;f=mymail.1;h=2cc4d0e4fe212ec82799d61f1b949153ff47c17a;hp=2bb8d4357c4dc1d9c5bf3c8fb8c4e2dfdfe49fa7;hb=ed9a958f95d7436aa585bc57a5e4761e8120be02;hpb=622b0a6df1bcb8e072facf472e4568609ab2a321

diff --git a/mymail.1 b/mymail.1
index 2bb8d43..2cc4d0e 100644
--- a/mymail.1
+++ b/mymail.1
@@ -1,4 +1,4 @@
-.TH "MYMAIL" "0.9" "February 2013" "Francois Fleuret" "User Commands"
+.TH "MYMAIL" "0.9.1" "February 2013" "Francois Fleuret" "User Commands"
 
 \" This man page was written by Francois Fleuret <francois@fleuret.org>
 \" and is distributed under a Creative Commons Attribution-Share Alike
@@ -10,12 +10,12 @@ mymail \- A simple command line utility for indexing and searching mbox files
 
 .SH "SYNOPSIS"
 
-\fBmymail\fP [\fIoptions\fR] [\fI<mbox dir1>\fR [\fI<mbox dir2>\fR ...]]
+\fBmymail\fP [\fIoptions\fR] [\fI<mbox dir1>\fR [\fI<mbox dir2>\fR ... ]|\fI<db file1>\fR [\fI<db file2>\fR ... ]]\n");
 
 .SH "DESCRIPTION"
 
-\fBmymail\fP is a command line utility for to index mbox files and
-perform quick searches based on sender, subject, etc.
+\fBmymail\fP is a command line utility to index mbox files and perform
+quick searches based on sender, subject, etc.
 
 It is similar in spirit to other existing software such as mu or
 notmuch, but does not use a real database backend to store and query
@@ -29,6 +29,9 @@ display help and exit
 \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
@@ -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
+.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"
 
@@ -71,15 +81,32 @@ 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.
+\fBf <regexp>\fR (from) selects mails whose leading line From, or
+fields From:, or Reply-To: matches the regexp.
+.TP
+\fBt <regexp>\fR (to) selects mails whose field To:, Cc:, or Bcc: matches the regexp.
+.TP
+\fBp <regexp>\fR (participant) selects mails whose leading line From,
+or fields From:, Reply-To:, To:, Cc:, or Bcc: matches the regexp.
+.TP
+\fBs <regexp>\fR (subject) selects mails whose field Subject: matches the regexp.
+.TP
+\fBd <regexp>\fR (date) selects mails whose field Date: matches the regexp.
+.TP
+\fBb <regexp>\fR (body) selects mails whose body matches the
+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
-\fBt <regexp>\fR selects mails whose field To:, Cc:, or Bcc: matches the regexp.
+\fB8h\fR selects mails received during the last 8 hours.
 .TP
-\fBp <regexp>\fR selects mails whose field From, From:, Reply-To:, To:, Cc:, or Bcc: matches the regexp.
+\fBtoday\fR, \fB24h\fR, \fBweek\fR, and \fBmonth\fR selects mails received during the last 24, 7 * 24 hours or 31 * 24 hours.
 .TP
-\fBs <regexp>\fR selects mails whose field Subject: matches the regexp.
+\fByesterday\fR selects mails received between 48h and 24h ago.
 .TP
-\fBd <regexp>\fR selects mails whose field Date: matches the regexp.
+\fBmonday\fR, \fBtuesday\fR, ..., \fBsunday\fR selects mails received
+the most recent such day
 
 .SH "EXAMPLES"
 
@@ -95,7 +122,7 @@ mymail --db-file /tmp/mymail/2010-2011/mymail.db --index ~/archives/mails/2010 ~
 
 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 creating a result mbox
+recipient, without "spam" in the subject, and create a result mbox
 file /tmp/mymail/mbox
 
 .RS
@@ -106,7 +133,8 @@ mymail --db-pattern '\\.db$' --db-root /tmp/mymail --search 'p bob.something' --
 
 .SH "BUGS"
 
-None known, probably many.
+The search in the mail bodies does not decode mimencoding mails, hence
+will not catch patterns in encoded text.
 
 .SH "AUTHOR"