Cosmetics.

[mymail.git] / mymail.1

diff --git a/mymail.1 b/mymail.1
index a3b09ca..95b83f0 100644 (file)
--- a/mymail.1
+++ b/mymail.1
@@ -1,4 +1,4 @@
-.TH "MYMAIL" "0.9.1" "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 <francois@fleuret.org>
 \" and is distributed under a Creative Commons Attribution-Share Alike
 
 \" This man page was written by Francois Fleuret <francois@fleuret.org>
 \" and is distributed under a Creative Commons Attribution-Share Alike


@@ -10,16 +10,15 @@ mymail \- A simple command line utility for indexing and searching mbox files
 
 .SH "SYNOPSIS"
 
 
 .SH "SYNOPSIS"
 

-\fBmymail\fP [\fIoptions\fR] [\fI<mbox dir1>\fR [\fI<mbox dir2>\fR ... ]|\fI<db file1>\fR [\fI<db file2>\fR ... ]]\n");
+\fBmymail\fP [\fIoptions\fR] [\fI<mbox dir1>\fR [\fI<mbox dir2>\fR ... ]|\fI<db file1>\fR [\fI<db file2>\fR ... ]]

 
 .SH "DESCRIPTION"
 
 
 .SH "DESCRIPTION"
 

-\fBmymail\fP is a command line utility to index mbox files and perform
-quick searches based on sender, subject, etc.
+\fBmymail\fP is a command line utility to index mbox files, search for
+mails based on sender, subject, etc. and generate result mbox files.

 
 

-It is similar in spirit to other existing software such as mu or
-notmuch, but does not use a real database backend to store and query
-the index.
+It is similar in spirit to other tools such as mu or notmuch, but is
+overall simpler.

 
 .SH "OPTIONS"
 .TP
 
 .SH "OPTIONS"
 .TP


@@ -29,6 +28,9 @@ display help and exit
 \fB-v\fR, \fB--version\fR
 print the version number
 .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-p <db filename pattern>\fR, \fB--db-pattern <db filename pattern>\fR
 set the db filename pattern for recursive search
 .TP


@@ -38,15 +40,26 @@ set the db root path for recursive search
 \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-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
+\fB-m <mbox filename pattern>\fR, \fB--mbox-pattern <mbox filename pattern>\fR
+set the mbox filename pattern for recursive search
+.TP
+\fB-s <search pattern>\fR, \fB--search <search pattern>\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
 .TP

-\fB-d <db filename>\fR, \fB--db-file <db filename>\fR
+\fB-d <db filename>\fR, \fB--db-file-generate <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
 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
+result mbox filename. If it is not set, the standard output is used
+.TP
+\fB-a <search field>\fR, \fB--default-search <search field>\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"
 
 
 .SH "ENVIRONMENT VARIABLES"
 


@@ -71,51 +84,79 @@ is prefaced by the character "!" it is negated, and has to be false
 for a mail to be selected.
 
 .TP
 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.
+\fBf <regexp>\fR (from)
+selects mails whose leading line From, or fields From:, Sender:,
+Reply-To:, or Return-Path: matches the regexp.
+.TP
+\fBt <regexp>\fR (to)
+selects mails whose field To:, Cc:, or Bcc: matches the regexp.

 .TP
 .TP

-\fBt <regexp>\fR (to) selects mails whose field To:, Cc:, or Bcc: matches the regexp.
+\fBp <regexp>\fR (participant)
+selects mails that would be selected by \fBf\fR or \fBt\fR.

 .TP
 .TP

-\fBp <regexp>\fR (participant) selects mails whose leading line From,
-or fields From:, Reply-To:, To:, Cc:, or Bcc: matches the regexp.
+\fBs <regexp>\fR (subject)
+selects mails whose field Subject: matches the regexp.

 .TP
 .TP

-\fBs <regexp>\fR (subject) selects mails whose field Subject: matches the regexp.
+\fBd <regexp>\fR (date)
+selects mails whose field Date: matches the regexp.

 .TP
 .TP

-\fBd <regexp>\fR (date) selects mails whose field Date: matches the regexp.
+\fBb <regexp>\fR (body)
+selects mails whose body matches the regexp. Evaluating 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
 .TP

-\fBb <regexp>\fR (body) selects mails whose body matches the
-regexp. This requires reading the original mboxes completely, which
-can be slow. Althout other conditions have to be fulfilled before
-checking the body ones, which may speed things up.
+\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 of the week

 
 .SH "EXAMPLES"
 
 
 .SH "EXAMPLES"
 

-To index all the mbox files present in the directories
+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
+
+.fi
+will index all the mbox files present in the directories

 ~/archives/mails/2010 and ~/archives/mails/2011 (recursively) and
 ~/archives/mails/2010 and ~/archives/mails/2011 (recursively) and

-create a database file /tmp/mymail/2010-2011/mymail.db
+create an index file /tmp/mymail/2010-2011/mymail.db

 
 

-.RS
-.EX
-mymail --db-file /tmp/mymail/2010-2011/mymail.db --index ~/archives/mails/2010 ~/archives/mails/2011
-.EE
-.RE
+And

 
 

-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
+.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'

 
 

-.RS
-.EX
-mymail --db-pattern '\\.db$' --db-root /tmp/mymail --search 'p bob.something' --search '!s spam' > /tmp/mymail.mbox
-.EE
-.RE
+.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
+days, and create an mbox file /tmp/mymail/mbox.

 
 .SH "BUGS"
 
 The search in the mail bodies does not decode mimencoding mails, hence
 will not catch patterns in encoded text.
 
 
 .SH "BUGS"
 
 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"
 
 Written by Francois Fleuret <francois@fleuret.org> and distributed
 .SH "AUTHOR"
 
 Written by Francois Fleuret <francois@fleuret.org> and distributed