X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=mymail.git;a=blobdiff_plain;f=mymail.1;h=c6b00b3368e42a598309f32ff52d66f9b1ae2a10;hp=18fc287daf3588d8219bf38c16951137df92a781;hb=86519a92de7bf6a3f869c95f6716093c711c0747;hpb=e46b2c9e8a690c4767e07a3f992ec58716a50086 diff --git a/mymail.1 b/mymail.1 index 18fc287..c6b00b3 100644 --- a/mymail.1 +++ b/mymail.1 @@ -1,4 +1,4 @@ -.TH "MYMAIL" "0.9" "February 2013" "Francois Fleuret" "User Commands" +.TH "MYMAIL" "0.9.1" "February 2013" "Francois Fleuret" "User Commands" \" This man page was written by Francois Fleuret \" and is distributed under a Creative Commons Attribution-Share Alike @@ -10,7 +10,7 @@ mymail \- A simple command line utility for indexing and searching mbox files .SH "SYNOPSIS" -\fBmymail\fP [\fIoptions\fR] [\fI\fR [\fI\fR ...]] +\fBmymail\fP [\fIoptions\fR] [\fI\fR [\fI\fR ... ]|\fI\fR [\fI\fR ... ]]\n"); .SH "DESCRIPTION" @@ -29,6 +29,9 @@ display help and exit \fB-v\fR, \fB--version\fR print the version number .TP +\fB-q\fR, \fB--quiet\fR +do not write information during the search +.TP \fB-p \fR, \fB--db-pattern \fR set the db filename pattern for recursive search .TP @@ -47,6 +50,13 @@ set the db filename for indexing \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 db filename pattern for recursive search +.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 .SH "ENVIRONMENT VARIABLES" @@ -82,33 +92,63 @@ or fields From:, Reply-To:, To:, Cc:, or Bcc: matches the regexp. \fBs \fR (subject) selects mails whose field Subject: matches the regexp. .TP \fBd \fR (date) selects mails whose field Date: matches the regexp. +.TP +\fBb \fR (body) selects mails whose body matches the +regexp. Evaluatin 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. +.TP +\fB8h\fR, \fBtoday\fR, \fB24h\fR, \fBweek\fR, and \fBmonth\fR selects +mails received respectively during the last 8, 24, 24, 7 * 24 hours or +31 * 24 hours. +.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 .SH "EXAMPLES" -To index all the mbox files present in the directories -~/archives/mails/2010 and ~/archives/mails/2011 (recursively) and -create a database file /tmp/mymail/2010-2011/mymail.db +The command .RS .EX -mymail --db-file /tmp/mymail/2010-2011/mymail.db --index ~/archives/mails/2010 ~/archives/mails/2011 +mymail --db-file /tmp/mymail/2010-2011/mymail.db \\ + --index \\ + ~/archives/mails/2010 ~/archives/mails/2011 .EE .RE -To 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, and create a result mbox -file /tmp/mymail/mbox +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 .RS .EX -mymail --db-pattern '\\.db$' --db-root /tmp/mymail --search 'p bob.something' --search '!s spam' > /tmp/mymail.mbox +mymail --db-pattern '\.db$' --db-root /tmp/mymail \\ + --output /tmp/mymail.mbox \\ + --search 'p bob.something' \\ + --search '!s spam' \\ + --search 'month' .EE .RE +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 +days, and create an mbox file /tmp/mymail/mbox. + .SH "BUGS" -None known, probably many. +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). .SH "AUTHOR"