Initial commit.
[mymail.git] / mymail.1
1 .TH "MYMAIL" "0.9" "February 2013" "Francois Fleuret" "User Commands"
2
3 \" This man page was written by Francois Fleuret <francois@fleuret.org>
4 \" and is distributed under a Creative Commons Attribution-Share Alike
5 \" 3.0 License.
6
7 .SH "NAME"
8
9 mymail \- A simple command line utility for dynamic pattern selection
10
11 .SH "SYNOPSIS"
12
13 \fBmymail\fP [\fIoptions\fR] [\fI<mbox dir1>\fR [\fI<mbox dir2>\fR ...]]
14
15 .SH "DESCRIPTION"
16
17 \fBmymail\fP is a command line utility for to index mbox files and
18 perform quick searches based on sender, subject, etc.
19
20 It is similar in spirit to other existing software such as mu or
21 notmuch.
22
23 .SH "EXAMPLES"
24
25 To index all the mbox present in the directory ~/my_mboxes and create
26 a db file /tmp/mymail.db
27
28 .RS
29 .EX
30 mymail --index --db-file /tmp/mymail.db /tmp/my_mboxes
31 .EE
32 .RE
33
34 To search in /tmp/mymail_2010.db and /tmp/mymail_2011.db for all mails
35 having bob.something as sender or recipient, without "spam" in the
36 subject
37
38 .RS
39 .EX
40 mymail --search "p bob.something,!s spam" /tmp/mymail_2010.db /tmp/mymail_2011.db
41 .EE
42 .RE
43
44 .SH "BUGS"
45
46 None known, probably many.
47
48 .SH "AUTHOR"
49
50 Written by Francois Fleuret <francois@fleuret.org> and distributed
51 under the terms of the GNU General Public License version 3 as
52 published by the Free Software Foundation. This is free software: you
53 are free to change and redistribute it. There is NO WARRANTY, to the
54 extent permitted by law.