-.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 <francois@fleuret.org>
\" and is distributed under a Creative Commons Attribution-Share Alike
.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<mbox dir1>\fR [\fI<mbox dir2>\fR ...]]
+\fBmymail\fP [\fIoptions\fR] [\fI<mbox dir1>\fR [\fI<mbox dir2>\fR ... ]|\fI<db file1>\fR [\fI<db file2>\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 <db filename pattern>\fR, \fB--db-pattern <db filename pattern>\fR
+set the db filename pattern for recursive search
+.TP
+\fB-r <db root path>\fR, \fB--db-root <db root path>\fR
+set the db root path for recursive search
+.TP
+\fB-l <db filename list>\fR, \fB--db-list <db filename list>\fR
+set the semicolon-separated list of db files for search
+.TP
+\fB-s <search pattern>\fR, \fB--search <search pattern>\fR
+search for matching mails in the db file
+.TP
+\fB-d <db filename>\fR, \fB--db-file <db filename>\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 <output filename>\fR, \fB--output <output filename>\fR
+set the db filename pattern for recursive search
+
+.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 <regexp>\fR (from) selects mails whose leading line From, or
+fields From:, or Reply-To: matches the regexp.
+.TP
+\fBt <regexp>\fR (to) selects mails whose field To:, Cc:, or Bcc: matches the regexp.
+.TP
+\fBp <regexp>\fR (participant) selects mails whose leading line From,
+or fields From:, Reply-To:, To:, Cc:, or Bcc: matches the regexp.
+.TP
+\fBs <regexp>\fR (subject) selects mails whose field Subject: matches the regexp.
+.TP
+\fBd <regexp>\fR (date) selects mails whose field Date: matches the regexp.
+.TP
+\fBb <regexp>\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 selects mails received during the last 8 hours.
+.TP
+\fBtoday\fR, \fB24h\fR selects mails received during the last 24 hours.
+.TP
+\fBweek\fR selects mails received during the last 7*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
+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
.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
+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
.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 --search 'p bob.something' --search '!s spam' > /tmp/mymail.mbox
.EE
.RE
.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.
.SH "AUTHOR"
projects / mymail.git / blobdiff