Cosmetics.

[mymail.git] / mymail.1

diff --git a/mymail.1 b/mymail.1
index 2cc4d0e..82b35b5 100644 (file)
--- a/mymail.1
+++ b/mymail.1
@@ -1,4 +1,4 @@
-.TH "MYMAIL" "0.9.1" "February 2013" "Francois Fleuret" "User Commands"
+.TH "MYMAIL" "0.9.2" "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
 
 \" This man page was written by Francois Fleuret <francois@fleuret.org>
 \" and is distributed under a Creative Commons Attribution-Share Alike


@@ -41,8 +41,9 @@ set the db root path for recursive search
 \fB-l <db filename list>\fR, \fB--db-list <db filename list>\fR
 set the semicolon-separated list of db files for search
 .TP
 \fB-l <db filename list>\fR, \fB--db-list <db filename list>\fR
 set the semicolon-separated list of db files for search
 .TP

-\fB-s <search pattern>\fR, \fB--search <search pattern>\fR
-search for matching mails in the db file
+\fB-s <search pattern>\fR, \fB--search <search pattern>\fR search for
+matching mails in the db file. Multiple search requests can be
+combined, and only mails fulfilling all of them will be extracted.

 .TP
 \fB-d <db filename>\fR, \fB--db-file <db filename>\fR
 set the db filename for indexing
 .TP
 \fB-d <db filename>\fR, \fB--db-file <db filename>\fR
 set the db filename for indexing


@@ -51,8 +52,8 @@ set the db filename for indexing
 index mails in the mailboxes located recursively anywhere in the
 directories following the options on the command lines
 .TP
 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
+\fB-o <output filename>\fR, \fB--output <output filename>\fR set the
+result mbox filename. If it is not set, the standard output is used

 .TP
 \fB-a <search field>\fR, \fB--default-search <search field>\fR
 set the default search field: If a search request is not understood,
 .TP
 \fB-a <search field>\fR, \fB--default-search <search field>\fR
 set the default search field: If a search request is not understood,


@@ -82,12 +83,11 @@ for a mail to be selected.
 
 .TP
 \fBf <regexp>\fR (from) selects mails whose leading line From, or
 
 .TP
 \fBf <regexp>\fR (from) selects mails whose leading line From, or

-fields From:, or Reply-To: matches the regexp.
+fields From:, Sender:, Reply-To:, or Return-Path: matches the regexp.

 .TP
 \fBt <regexp>\fR (to) selects mails whose field To:, Cc:, or Bcc: matches the regexp.
 .TP
 .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.
+\fBp <regexp>\fR (participant) selects mails that would be selected by \fBf\fR or \fBt\fR.

 .TP
 \fBs <regexp>\fR (subject) selects mails whose field Subject: matches the regexp.
 .TP
 .TP
 \fBs <regexp>\fR (subject) selects mails whose field Subject: matches the regexp.
 .TP


@@ -99,9 +99,9 @@ mboxes completely, which can be slow. However, header conditions are
 checked first to read the bodies only for mails which fulfill them
 entirely.
 .TP
 checked first to read the bodies only for mails which fulfill them
 entirely.
 .TP

-\fB8h\fR selects mails received during the last 8 hours.
-.TP
-\fBtoday\fR, \fB24h\fR, \fBweek\fR, and \fBmonth\fR selects mails received during the last 24, 7 * 24 hours or 31 * 24 hours.
+\fB8h\fR, \fBtoday\fR, \fB24h\fR, \fBweek\fR, \fBmonth\fR, and
+\fByear\fR selects mails received during the last 8, 24, 24, 7 * 24
+hours, 31 * 24 hours, and 365 * 24 hours respectively.

 .TP
 \fByesterday\fR selects mails received between 48h and 24h ago.
 .TP
 .TP
 \fByesterday\fR selects mails received between 48h and 24h ago.
 .TP


@@ -110,32 +110,46 @@ 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