Changed indentation to avoid a gcc warning.

[mymail.git] / mymail.1

diff --git a/mymail.1 b/mymail.1
index 03382d9..09fa324 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.10" "July 2014" "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
@@ -35,6 +35,10 @@ do not write information during the search
 use the time stamp from the leading line of each mail and not the
 Date: field
 .TP
+\fB-f\fR, \fB--do-not-discard-mails-from-the-future\fR
+keep mails with a date (more than 24h) in the future, which are
+discarded by default
+.TP
 \fB-p <db filename pattern>\fR, \fB--db-pattern <db filename pattern>\fR
 set the db filename pattern for recursive search
 .TP
@@ -47,9 +51,9 @@ set the semicolon-separated list of db files for search
 \fB-m <mbox filename pattern>\fR, \fB--mbox-pattern <mbox filename pattern>\fR
 set the mbox filename pattern for recursive search
 .TP
-\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.
+\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-output <db filename>\fR
 set the db filename for indexing
@@ -58,8 +62,12 @@ 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
-\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
+\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,
@@ -79,6 +87,9 @@ defaut value for the --db-list 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"
 
@@ -108,13 +119,14 @@ 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, \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.
+\fB1h\fR, \fB2h\fR, \fB4h\fR, \fB8h\fR, \fB24h\fR, \fB48h\fR, \fBweek\fR, \fB2weeks\fR, \fBmonth\fR, \fBtrimester\fR, \fBsemester\fR, and \fByear\fR
+select mails received during the last
+1, 2, 4, 8, 24, 48, 7 * 24 hours, 14 * 24 hours, 31 * 24 hours, 92 *
+24 hours, 185 * 24 hours, and 365 * 24 hours respectively.
 .TP
 \fBtoday\fR
 selects mails received since midnight.
@@ -123,7 +135,7 @@ selects mails received since midnight.
 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"
 
@@ -156,6 +168,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
@@ -167,8 +190,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"