Added the -n option to set the maximum number of mails to extract.

[mymail.git] / mymail.1

diff --git a/mymail.1 b/mymail.1
index 6caa8ea..7e48dcc 100644 (file)
--- a/mymail.1
+++ b/mymail.1
@@ -1,4 +1,4 @@
-.TH "MYMAIL" "0.9.8" "April 2013" "Francois Fleuret" "User Commands"
+.TH "MYMAIL" "0.9.9" "June 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
@@ -61,6 +61,9 @@ directories following the options on the command lines
 \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-n <max number of mails>\fR, \fB--nb-mails-max <max number of mails>\fR set the
+maximum number of mails to extract (default is 250)
+.TP
 \fB-a <search key>\fR, \fB--default-search <search key>\fR
 set the default search key. If a search request is not understood,
 it is interpreted as the regexp with this default search key
@@ -78,7 +81,10 @@ 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-generate argument
+defaut value for the --db-file-output argument
+.TP
+\fBMYMAILRC \fR
+configuration file, default is ${HOME}/.mymailrc
 
 .SH "SEARCH CONDITIONS"
 
@@ -107,24 +113,26 @@ selects mails whose field Subject: matches the regexp.
 selects mails whose field Date: matches the regexp.
 .TP
 \fBb <regexp>\fR (body)
+
 selects mails whose body matches the regexp. Evaluating 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.
+condition requires to read the full mail from the original mboxes,
+which can be slow. To speed things up, all the header conditions are
+checked first.
 .TP
-\fB8h\fR, \fB24h\fR, \fB48h\fR, \fBweek\fR, \fBmonth\fR, and
-\fByear\fR
-selects mails received during the last 8, 24, 24, 48, 7 * 24 hours, 31 *
-24 hours, and 365 * 24 hours respectively.
+\fB8h\fR, \fB24h\fR, \fB48h\fR, \fBweek\fR, \fBmonth\fR, \fBtrimester\fR, and \fByear\fR
+
+select mails received during the last 8, 24, 48, 7 * 24 hours, 31 *
+24 hours, 92 * 24 hours, and 365 * 24 hours respectively.
 .TP
 \fBtoday\fR
+
 selects mails received since midnight.
 .TP
 \fByesterday\fR
 selects mails received yesterday.
 .TP
 \fBmonday\fR, \fBtuesday\fR, ..., \fBsunday\fR
-selects mails received the most recent such day of the week.
+select mails received the most recent such day of the week.
 
 .SH "EXAMPLES"
 
@@ -132,7 +140,7 @@ The command
 
 .P
 .nf
-.B mymail --db-file-generate /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
 
@@ -157,6 +165,17 @@ will search in all the database files *.db located (recursively) in
 recipient, without "spam" in the subject, received over the last 31
 days, and create an mbox file /tmp/mymail/mbox.
 
+.SH "FILES"
+
+The configuration file is by default ${HOME}/.mymailrc and can also be
+specified through the MYMAILRC environment variable.
+
+It allows to define aliases of search keys, such as:
+
+.P
+.nf
+.B alias tod=today
+
 .SH "BUGS"
 
 The search in the mail bodies does not decode mimencoding mails, hence
@@ -168,8 +187,7 @@ 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.
+leading 'From' line of the mail, which has a canonical form, is used.
 
 .SH "AUTHOR"