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 indexing and searching mbox files
  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 "SEARCH SYNTAX"
  24
  25 The search conditions take the form of a single letter followed by a
  26 space and a regexp, which can itself contain spaces. If the condition
  27 is prefaced by the character "!" it is negated, and has to be false
  28 for a mail to be selected.
  29
  30 .TP
  31 \fBf <regexp>\fR selects mails whose field From, From:, or Reply-To: matches the regexp. Since the initial "From " line contains the date, this search criterion can be used to restrict to a certain year or month.
  32 .TP
  33 \fBd <regexp>\fR selects mails whose field To:, Cc:, or Bcc: matches the regexp.
  34 .TP
  35 \fBp <regexp>\fR selects mails whose field From, From:, Reply-To:, To:, Cc:, or Bcc: matches the regexp.
  36 .TP
  37 \fBs <regexp>\fR selects mails whose field Subject: matches the regexp.
  38
  39 .SH "EXAMPLES"
  40
  41 To index all the mbox files present in the directory ~/archives/mails/2010
  42 (recursively) and create a data-base file /tmp/mymail/2010/mymail.db
  43
  44 .RS
  45 .EX
  46 mymail --index --db-file /tmp/mymail/2010/mymail.db ~/archives/mails/2010
  47 .EE
  48 .RE
  49
  50 To search in all the data-base files mymail.db located (recursively)
  51 in /tmp/mymail, for all the mails having bob.something as sender or
  52 recipient, without "spam" in the subject, and creating a result mbox
  53 file /tmp/mymail/mbox
  54
  55 .RS
  56 .EX
  57 mymail --db-file mymail.db --db-root /tmp/mymail --search 'p bob.something' --search '!s spam' > /tmp/mymail.mbox
  58 .EE
  59 .RE
  60
  61 .SH "BUGS"
  62
  63 None known, probably many.
  64
  65 .SH "AUTHOR"
  66
  67 Written by Francois Fleuret <francois@fleuret.org> and distributed
  68 under the terms of the GNU General Public License version 3 as
  69 published by the Free Software Foundation. This is free software: you
  70 are free to change and redistribute it. There is NO WARRANTY, to the
  71 extent permitted by law.