Cosmetics.
[mymail.git] / mymail.1
index cd76dc1..82ce908 100644 (file)
--- a/mymail.1
+++ b/mymail.1
@@ -1,4 +1,4 @@
-.TH "MYMAIL" "0.9.6" "March 2013" "Francois Fleuret" "User Commands"
+.TH "MYMAIL" "0.9.8" "April 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
@@ -51,7 +51,7 @@ set the mbox filename pattern for recursive search
 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-generate <db filename>\fR
+\fB-d <db filename>\fR, \fB--db-file-output <db filename>\fR
 set the db filename for indexing
 .TP
 \fB-i\fR, \fB--index\fR
@@ -78,21 +78,20 @@ defaut value for the --db-root argument
 defaut value for the --db-list argument
 .TP
 \fBMYMAIL_DB_FILE\fR
-defaut value for the --db-file argument
+defaut value for the --db-file-output argument
 
-.SH "SEARCH SYNTAX"
+.SH "SEARCH CONDITIONS"
 
-The search conditions take the form of a key which is a single letter,
-followed by a space and a regexp, which can itself contain spaces. If
-the condition is prefaced by the character "!" it is negated, and has
-to be false for a mail to be selected.
+A search condition is either a time-related condition
+('today', 'yesterday', etc.), or a single-character key, followed by a
+space and a regexp, which can itself contain spaces.
 
-The time-based conditions use as reference the time indicated in the
-heading From line, and not in the Date: field.
+If it is prefaced by the character "!", a condition is negated and has
+to be false for a mail to be selected.
 
 .TP
 \fBf <regexp>\fR (from)
-selects mails whose leading line From, or fields From:, Sender:,
+selects mails whose leading line 'From', or fields From:, Sender:,
 Reply-To:, or Return-Path: matches the regexp.
 .TP
 \fBt <regexp>\fR (to)
@@ -133,7 +132,7 @@ The command
 
 .P
 .nf
-.B mymail --db-file /tmp/mymail/2010-2011/mymail.db \e
+.B mymail --db-file-output /tmp/mymail/2010-2011/mymail.db \e
 .B \ \ \ \ \ \ \ --index \e
 .B \ \ \ \ \ \ \ ~/archives/mails/2010 ~/archives/mails/2011
 
@@ -163,9 +162,14 @@ days, and create an mbox file /tmp/mymail/mbox.
 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 use for
-testing).
+The mbox format is not clear for multipart messages, since the 'From'
+may not always be quoted properly, so mymail uses a strict regexp to
+recognize such lines.
+
+The date format for the Date: field is not standardized, and may not
+be parsed properly. When that happens, the time stamp from the
+leading 'From' line of the mail, which has a canonical form, is be
+used.
 
 .SH "AUTHOR"