mymail.1

   1 .TH "MYMAIL" "0.9.1" "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 ... ]|\fI<db file1>\fR [\fI<db file2>\fR ... ]]\n");
  14
  15 .SH "DESCRIPTION"
  16
  17 \fBmymail\fP is a command line utility to index mbox files and perform
  18 quick searches based on sender, subject, etc.
  19
  20 It is similar in spirit to other existing software such as mu or
  21 notmuch, but does not use a real database backend to store and query
  22 the index.
  23
  24 .SH "OPTIONS"
  25 .TP
  26 \fB-h\fR, \fB--help\fR
  27 display help and exit
  28 .TP
  29 \fB-v\fR, \fB--version\fR
  30 print the version number
  31 .TP
  32 \fB-q\fR, \fB--quiet\fR
  33 do not write information during the search
  34 .TP
  35 \fB-p <db filename pattern>\fR, \fB--db-pattern <db filename pattern>\fR
  36 set the db filename pattern for recursive search
  37 .TP
  38 \fB-r <db root path>\fR, \fB--db-root <db root path>\fR
  39 set the db root path for recursive search
  40 .TP
  41 \fB-l <db filename list>\fR, \fB--db-list <db filename list>\fR
  42 set the semicolon-separated list of db files for search
  43 .TP
  44 \fB-s <search pattern>\fR, \fB--search <search pattern>\fR
  45 search for matching mails in the db file
  46 .TP
  47 \fB-d <db filename>\fR, \fB--db-file <db filename>\fR
  48 set the db filename for indexing
  49 .TP
  50 \fB-i\fR, \fB--index\fR
  51 index mails in the mailboxes located recursively anywhere in the
  52 directories following the options on the command lines
  53 .TP
  54 \fB-o <output filename>\fR, \fB--output <output filename>\fR
  55 set the db filename pattern for recursive search
  56
  57 .SH "ENVIRONMENT VARIABLES"
  58
  59 .TP
  60 \fBMYMAIL_DB_PATTERN\fR
  61 defaut value for the --db-pattern argument
  62 .TP
  63 \fBMYMAIL_DB_ROOT\fR
  64 defaut value for the --db-root argument
  65 .TP
  66 \fBMYMAIL_DB_LIST\fR
  67 defaut value for the --db-list argument
  68 .TP
  69 \fBMYMAIL_DB_FILE\fR
  70 defaut value for the --db-file argument
  71
  72 .SH "SEARCH SYNTAX"
  73
  74 The search conditions take the form of a single letter followed by a
  75 space and a regexp, which can itself contain spaces. If the condition
  76 is prefaced by the character "!" it is negated, and has to be false
  77 for a mail to be selected.
  78
  79 .TP
  80 \fBf <regexp>\fR (from) selects mails whose leading line From, or
  81 fields From:, or Reply-To: matches the regexp.
  82 .TP
  83 \fBt <regexp>\fR (to) selects mails whose field To:, Cc:, or Bcc: matches the regexp.
  84 .TP
  85 \fBp <regexp>\fR (participant) selects mails whose leading line From,
  86 or fields From:, Reply-To:, To:, Cc:, or Bcc: matches the regexp.
  87 .TP
  88 \fBs <regexp>\fR (subject) selects mails whose field Subject: matches the regexp.
  89 .TP
  90 \fBd <regexp>\fR (date) selects mails whose field Date: matches the regexp.
  91 .TP
  92 \fBb <regexp>\fR (body) selects mails whose body matches the
  93 regexp. This requires reading the original mboxes completely, which
  94 can be slow. Header conditions have to be fulfilled before checking
  95 the body ones, which may speed things up.
  96
  97 .SH "EXAMPLES"
  98
  99 To index all the mbox files present in the directories
 100 ~/archives/mails/2010 and ~/archives/mails/2011 (recursively) and
 101 create a database file /tmp/mymail/2010-2011/mymail.db
 102
 103 .RS
 104 .EX
 105 mymail --db-file /tmp/mymail/2010-2011/mymail.db --index ~/archives/mails/2010 ~/archives/mails/2011
 106 .EE
 107 .RE
 108
 109 To search in all the database files *.db located (recursively) in
 110 /tmp/mymail, for all the mails having bob.something as sender or
 111 recipient, without "spam" in the subject, and create a result mbox
 112 file /tmp/mymail/mbox
 113
 114 .RS
 115 .EX
 116 mymail --db-pattern '\\.db$' --db-root /tmp/mymail --search 'p bob.something' --search '!s spam' > /tmp/mymail.mbox
 117 .EE
 118 .RE
 119
 120 .SH "BUGS"
 121
 122 The search in the mail bodies does not decode mimencoding mails, hence
 123 will not catch patterns in encoded text.
 124
 125 .SH "AUTHOR"
 126
 127 Written by Francois Fleuret <francois@fleuret.org> and distributed
 128 under the terms of the GNU General Public License version 3 as
 129 published by the Free Software Foundation. This is free software: you
 130 are free to change and redistribute it. There is NO WARRANTY, to the
 131 extent permitted by law.