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 820dddf..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
 
 \" This man page was written by Francois Fleuret <francois@fleuret.org>
 \" and is distributed under a Creative Commons Attribution-Share Alike


@@ -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-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
 \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


@@ -79,6 +82,9 @@ defaut value for the --db-list argument
 .TP
 \fBMYMAIL_DB_FILE\fR
 defaut value for the --db-file-output argument
 .TP
 \fBMYMAIL_DB_FILE\fR
 defaut value for the --db-file-output argument

+.TP
+\fBMYMAILRC \fR
+configuration file, default is ${HOME}/.mymailrc

 
 .SH "SEARCH CONDITIONS"
 
 
 .SH "SEARCH CONDITIONS"
 


@@ -113,18 +119,20 @@ 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
 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, \fBtrimester\fR,
-and \fByear\fR selects mails received during the last 8, 24, 24, 48, 7
-* 24 hours, 31 * 24 hours, 92 * 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
 .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 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"
 
 
 .SH "EXAMPLES"
 


@@ -160,7 +168,7 @@ days, and create an mbox file /tmp/mymail/mbox.
 .SH "FILES"
 
 The configuration file is by default ${HOME}/.mymailrc and can also be
 .SH "FILES"
 
 The configuration file is by default ${HOME}/.mymailrc and can also be

-specificied through the MYMAILRC environment variable.
+specified through the MYMAILRC environment variable.

 
 It allows to define aliases of search keys, such as:
 
 
 It allows to define aliases of search keys, such as:
 


@@ -179,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
 
 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"
 
 
 .SH "AUTHOR"