X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=mymail.git;a=blobdiff_plain;f=mymail.1;h=09fa3248f2d4a42e33e6aec5b6f597a9466cae72;hp=0c4c4c76045025cb9c774eaf095990b4ea6963ac;hb=HEAD;hpb=8e02182630fdf56886df35338e46d0768c31bbfa diff --git a/mymail.1 b/mymail.1 index 0c4c4c7..09fa324 100644 --- a/mymail.1 +++ b/mymail.1 @@ -1,4 +1,4 @@ -.TH "MYMAIL" "0.9.5" "February 2013" "Francois Fleuret" "User Commands" +.TH "MYMAIL" "0.9.10" "July 2014" "Francois Fleuret" "User Commands" \" This man page was written by Francois Fleuret \" 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 \fR, \fB--db-pattern \fR set the db filename pattern for recursive search .TP @@ -47,19 +51,23 @@ set the semicolon-separated list of db files for search \fB-m \fR, \fB--mbox-pattern \fR set the mbox filename pattern for recursive search .TP -\fB-s \fR, \fB--search \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 \fR, \fB--search \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 \fR, \fB--db-file-generate \fR +\fB-d \fR, \fB--db-file-output \fR set the db filename for indexing .TP \fB-i\fR, \fB--index\fR index mails in the mailboxes located recursively anywhere in the directories following the options on the command lines .TP -\fB-o \fR, \fB--output \fR set the -result mbox filename. If it is not set, the standard output is used +\fB-o \fR, \fB--output \fR +set the result mbox filename. If it is not set, the standard output is +used +.TP +\fB-n \fR, \fB--nb-mails-max \fR +set the maximum number of mails to extract (default is 250) .TP \fB-a \fR, \fB--default-search \fR set the default search key. If a search request is not understood, @@ -78,21 +86,23 @@ 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 +.TP +\fBMYMAILRC \fR +configuration file, default is ${HOME}/.mymailrc -.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 \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 \fR (to) @@ -109,23 +119,23 @@ selects mails whose field Date: matches the regexp. .TP \fBb \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. +\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 last midnight +selects mails received since midnight. .TP \fByesterday\fR -selects mails received between 48h and 24h ago. +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" @@ -133,7 +143,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 @@ -158,14 +168,29 @@ 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 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 used. .SH "AUTHOR"