X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=mymail.git;a=blobdiff_plain;f=mymail.1;h=c6b00b3368e42a598309f32ff52d66f9b1ae2a10;hp=f2ba3f513ece8a5f03fac908691953c270746b23;hb=86519a92de7bf6a3f869c95f6716093c711c0747;hpb=e0b1323602f5c99f3da6d4d20396b73ddb59d81f diff --git a/mymail.1 b/mymail.1 index f2ba3f5..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 @@ -6,44 +6,149 @@ .SH "NAME" -mymail \- A simple command line utility for dynamic pattern selection +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" -\fBmymail\fP is a command line utility for to index mbox files and -perform quick searches based on sender, subject, etc. +\fBmymail\fP is a command line utility to index mbox files and perform +quick searches based on sender, subject, etc. It is similar in spirit to other existing software such as mu or -notmuch. +notmuch, but does not use a real database backend to store and query +the index. + +.SH "OPTIONS" +.TP +\fB-h\fR, \fB--help\fR +display help and exit +.TP +\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 +\fB-r \fR, \fB--db-root \fR +set the db root path for recursive search +.TP +\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 +.TP +\fB-d \fR, \fB--db-file \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 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" + +.TP +\fBMYMAIL_DB_PATTERN\fR +defaut value for the --db-pattern argument +.TP +\fBMYMAIL_DB_ROOT\fR +defaut value for the --db-root argument +.TP +\fBMYMAIL_DB_LIST\fR +defaut value for the --db-list argument +.TP +\fBMYMAIL_DB_FILE\fR +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. + +.TP +\fBf \fR (from) selects mails whose leading line From, or +fields From:, or Reply-To: 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. +.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, 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 present in the directory ~/my_mboxes and create -a db file /tmp/mymail.db +The command .RS .EX -mymail --index --db-file /tmp/mymail.db /tmp/my_mboxes +mymail --db-file /tmp/mymail/2010-2011/mymail.db \\ + --index \\ + ~/archives/mails/2010 ~/archives/mails/2011 .EE .RE -To search in /tmp/mymail_2010.db and /tmp/mymail_2011.db for all mails -having bob.something as sender or recipient, without "spam" in the -subject +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 --search "p bob.something,!s spam" /tmp/mymail_2010.db /tmp/mymail_2011.db +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"