X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=mymail.1;h=82b35b5ae7c4692bd0ef09abd48a0c3062fe92a6;hb=6c8770e146420bb7651c8e10e279402f45ff1c3d;hp=877a9f74a5fd7a0d886a2325f46f9b55f9a89bc3;hpb=e8944d6196c9685d81e41f14e57994d6563c43f2;p=mymail.git diff --git a/mymail.1 b/mymail.1 index 877a9f7..82b35b5 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.2" "February 2013" "Francois Fleuret" "User Commands" \" This man page was written by Francois Fleuret \" and is distributed under a Creative Commons Attribution-Share Alike @@ -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 @@ -38,8 +41,9 @@ 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-s \fR, \fB--search \fR -search for matching mails in the db file +\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 set the db filename for indexing @@ -47,6 +51,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 +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 .SH "ENVIRONMENT VARIABLES" @@ -72,43 +83,72 @@ for a mail to be selected. .TP \fBf \fR (from) selects mails whose leading line From, or -fields From:, or Reply-To: matches the regexp. +fields From:, Sender:, Reply-To:, or Return-Path: matches the regexp. .TP \fBt \fR (to) selects mails whose field To:, Cc:, or Bcc: matches the regexp. .TP -\fBp \fR (participant) selects mails whose leading line From, -or fields From:, Reply-To:, To:, Cc:, or Bcc: matches the regexp. +\fBp \fR (participant) selects mails that would be selected by \fBf\fR or \fBt\fR. .TP \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, \fBmonth\fR, and +\fByear\fR selects mails received during the last 8, 24, 24, 7 * 24 +hours, 31 * 24 hours, and 365 * 24 hours respectively. +.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"