Initial commit.

diff --git a/mymail.1 b/mymail.1
new file mode 100644 (file)
index 0000000..f2ba3f5
--- /dev/null
+++ b/mymail.1
@@ -0,0 +1,54 @@
+.TH "MYMAIL" "0.9" "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
+\" 3.0 License.
+
+.SH "NAME"
+
+mymail \- A simple command line utility for dynamic pattern selection
+
+.SH "SYNOPSIS"
+
+\fBmymail\fP [\fIoptions\fR] [\fI<mbox dir1>\fR [\fI<mbox dir2>\fR ...]]
+
+.SH "DESCRIPTION"
+
+\fBmymail\fP is a command line utility for 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.
+
+.SH "EXAMPLES"
+
+To index all the mbox present in the directory ~/my_mboxes and create
+a db file /tmp/mymail.db
+
+.RS
+.EX
+mymail --index --db-file /tmp/mymail.db /tmp/my_mboxes
+.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
+
+.RS
+.EX
+mymail --search "p bob.something,!s spam" /tmp/mymail_2010.db /tmp/mymail_2011.db
+.EE
+.RE
+
+.SH "BUGS"
+
+None known, probably many.
+
+.SH "AUTHOR"
+
+Written by Francois Fleuret <francois@fleuret.org> and distributed
+under the terms of the GNU General Public License version 3 as
+published by the Free Software Foundation. This is free software: you
+are free to change and redistribute it. There is NO WARRANTY, to the
+extent permitted by law.