Prompt cosmetics.

[mymail.git] / mymail.1

diff --git a/mymail.1 b/mymail.1
index 62d6def..c6b00b3 100644 (file)
--- a/mymail.1
+++ b/mymail.1
@@ -53,6 +53,10 @@ 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-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"
 


@@ -95,11 +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 selects mails received during the last 24 hours.
-.TP
-\fBweek\fR selects mails received during the last 7*24 hours.
+\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
 .TP
 \fByesterday\fR selects mails received between 48h and 24h ago.
 .TP


@@ -108,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