projects
/
mymail.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Added the documentation about --quiet and --output.
[mymail.git]
/
mymail.1
diff --git
a/mymail.1
b/mymail.1
index
f02cb71
..
fbb8898
100644
(file)
--- 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 <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,7
+10,7
@@
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 ...
]]
+\fBmymail\fP [\fIoptions\fR] [\fI<mbox dir1>\fR [\fI<mbox dir2>\fR ...
]|\fI<db file1>\fR [\fI<db file2>\fR ... ]]\n");
.SH "DESCRIPTION"
.SH "DESCRIPTION"
@@
-29,6
+29,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
@@
-47,6
+50,9
@@
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
\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"
.SH "ENVIRONMENT VARIABLES"
@@
-71,15
+77,22
@@
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 selects mails whose field From, From:, or Reply-To: matches the regexp.
+\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
.TP
-\fBt <regexp>\fR selects mails whose field To:, Cc:, or Bcc: matches the regexp.
+\fBp <regexp>\fR (participant) selects mails whose leading line From,
+or fields From:, Reply-To:, To:, Cc:, or Bcc: matches the regexp.
.TP
.TP
-\fB
p <regexp>\fR selects mails whose field From, From:, Reply-To:, To:, Cc:, or Bcc
: matches the regexp.
+\fB
s <regexp>\fR (subject) selects mails whose field Subject
: matches the regexp.
.TP
.TP
-\fB
s <regexp>\fR selects mails whose field Subject
: matches the regexp.
+\fB
d <regexp>\fR (date) selects mails whose field Date
: matches the regexp.
.TP
.TP
-\fBd <regexp>\fR selects mails whose field Date: matches the regexp.
+\fBb <regexp>\fR (body) selects mails whose body matches the
+regexp. This requires reading the original mboxes completely, which
+can be slow. Header conditions have to be fulfilled before checking
+the body ones, which may speed things up.
.SH "EXAMPLES"
.SH "EXAMPLES"
@@
-95,7
+108,7
@@
mymail --db-file /tmp/mymail/2010-2011/mymail.db --index ~/archives/mails/2010 ~
To search in all the database files *.db located (recursively) in
/tmp/mymail, for all the mails having bob.something as sender or
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 creat
ing
a result mbox
+recipient, without "spam" in the subject, and creat
e
a result mbox
file /tmp/mymail/mbox
.RS
file /tmp/mymail/mbox
.RS
@@
-106,7
+119,8
@@
mymail --db-pattern '\\.db$' --db-root /tmp/mymail --search 'p bob.something' --
.SH "BUGS"
.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"
.SH "AUTHOR"