X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=mymail.git;a=blobdiff_plain;f=mymail.1;h=0c4c4c76045025cb9c774eaf095990b4ea6963ac;hp=b79b4b917830c4329817c067fe98d8fd6c217dbd;hb=8e02182630fdf56886df35338e46d0768c31bbfa;hpb=248736d0d3900bce18c1c6afd9f3dc2d93df2cae diff --git a/mymail.1 b/mymail.1 index b79b4b9..0c4c4c7 100644 --- a/mymail.1 +++ b/mymail.1 @@ -1,4 +1,4 @@ -.TH "MYMAIL" "0.9.2" "February 2013" "Francois Fleuret" "User Commands" +.TH "MYMAIL" "0.9.5" "February 2013" "Francois Fleuret" "User Commands" \" This man page was written by Francois Fleuret \" and is distributed under a Creative Commons Attribution-Share Alike @@ -31,6 +31,10 @@ print the version number \fB-q\fR, \fB--quiet\fR do not write information during the search .TP +\fB-t\fR, \fB--use-leading-time\fR +use the time stamp from the leading line of each mail and not the +Date: field +.TP \fB-p \fR, \fB--db-pattern \fR set the db filename pattern for recursive search .TP @@ -40,11 +44,14 @@ set the db root path for recursive search \fB-l \fR, \fB--db-list \fR set the semicolon-separated list of db files for search .TP +\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. .TP -\fB-d \fR, \fB--db-file \fR +\fB-d \fR, \fB--db-file-generate \fR set the db filename for indexing .TP \fB-i\fR, \fB--index\fR @@ -54,9 +61,9 @@ directories following the options on the command lines \fB-o \fR, \fB--output \fR set the result mbox filename. If it is not set, the standard output is used .TP -\fB-a \fR, \fB--default-search \fR -set the default search field. If a search request is not understood, -it is interpreted as the regexp with this default search field +\fB-a \fR, \fB--default-search \fR +set the default search key. If a search request is not understood, +it is interpreted as the regexp with this default search key .SH "ENVIRONMENT VARIABLES" @@ -75,10 +82,13 @@ defaut value for the --db-file argument .SH "SEARCH SYNTAX" -The search conditions take the form of 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. +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. + +The time-based conditions use as reference the time indicated in the +heading From line, and not in the Date: field. .TP \fBf \fR (from) @@ -103,39 +113,46 @@ 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. .TP -\fB8h\fR, \fBtoday\fR, \fB24h\fR, \fBweek\fR, \fBmonth\fR, and +\fB8h\fR, \fB24h\fR, \fB48h\fR, \fBweek\fR, \fBmonth\fR, and \fByear\fR -selects mails received during the last 8, 24, 24, 7 * 24 hours, 31 * +selects mails received during the last 8, 24, 24, 48, 7 * 24 hours, 31 * 24 hours, and 365 * 24 hours respectively. .TP +\fBtoday\fR +selects mails received since last midnight +.TP \fByesterday\fR selects mails received between 48h and 24h ago. .TP \fBmonday\fR, \fBtuesday\fR, ..., \fBsunday\fR -selects mails received the most recent such day of the week +selects mails received the most recent such day of the week. .SH "EXAMPLES" The command +.P .nf .B mymail --db-file /tmp/mymail/2010-2011/mymail.db \e -.B --index \e -.B ~/archives/mails/2010 ~/archives/mails/2011 +.B \ \ \ \ \ \ \ --index \e +.B \ \ \ \ \ \ \ ~/archives/mails/2010 ~/archives/mails/2011 +.fi will index all the mbox files present in the directories ~/archives/mails/2010 and ~/archives/mails/2011 (recursively) and create an index file /tmp/mymail/2010-2011/mymail.db And +.P .nf .B mymail --db-pattern '\.db$' --db-root /tmp/mymail \e -.B --output /tmp/mymail.mbox \e -.B --search 'p bob.something' \e -.B --search '!s spam' \e -.B --search 'month' +.B \ \ \ \ \ \ \ --output /tmp/mymail.mbox \e +.B \ \ \ \ \ \ \ --search 'p bob.something' \e +.B \ \ \ \ \ \ \ --search '!s spam' \e +.B \ \ \ \ \ \ \ --search 'month' +.fi will search in all the database files *.db located (recursively) in /tmp/mymail, for all the mails having "bob.something" as sender or recipient, without "spam" in the subject, received over the last 31 @@ -147,8 +164,8 @@ 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 have to -test). +" lines are not always quoted properly (at least the ones I use for +testing). .SH "AUTHOR"