Cosmetics.
[mymail.git] / mymail.1
1 .TH "MYMAIL" "0.9.8" "April 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 ... ]]
14
15 .SH "DESCRIPTION"
16
17 \fBmymail\fP is a command line utility to index mbox files, search for
18 mails based on sender, subject, etc. and generate result mbox files.
19
20 It is similar in spirit to other tools such as mu or notmuch, but is
21 overall simpler.
22
23 .SH "OPTIONS"
24 .TP
25 \fB-h\fR, \fB--help\fR
26 display help and exit
27 .TP
28 \fB-v\fR, \fB--version\fR
29 print the version number
30 .TP
31 \fB-q\fR, \fB--quiet\fR
32 do not write information during the search
33 .TP
34 \fB-t\fR, \fB--use-leading-time\fR
35 use the time stamp from the leading line of each mail and not the
36 Date: field
37 .TP
38 \fB-p <db filename pattern>\fR, \fB--db-pattern <db filename pattern>\fR
39 set the db filename pattern for recursive search
40 .TP
41 \fB-r <db root path>\fR, \fB--db-root <db root path>\fR
42 set the db root path for recursive search
43 .TP
44 \fB-l <db filename list>\fR, \fB--db-list <db filename list>\fR
45 set the semicolon-separated list of db files for search
46 .TP
47 \fB-m <mbox filename pattern>\fR, \fB--mbox-pattern <mbox filename pattern>\fR
48 set the mbox filename pattern for recursive search
49 .TP
50 \fB-s <search pattern>\fR, \fB--search <search pattern>\fR search for
51 matching mails in the db file. Multiple search requests can be
52 combined, and only mails fulfilling all of them will be extracted.
53 .TP
54 \fB-d <db filename>\fR, \fB--db-file-output <db filename>\fR
55 set the db filename for indexing
56 .TP
57 \fB-i\fR, \fB--index\fR
58 index mails in the mailboxes located recursively anywhere in the
59 directories following the options on the command lines
60 .TP
61 \fB-o <output filename>\fR, \fB--output <output filename>\fR set the
62 result mbox filename. If it is not set, the standard output is used
63 .TP
64 \fB-a <search key>\fR, \fB--default-search <search key>\fR
65 set the default search key. If a search request is not understood,
66 it is interpreted as the regexp with this default search key
67
68 .SH "ENVIRONMENT VARIABLES"
69
70 .TP
71 \fBMYMAIL_DB_PATTERN\fR
72 defaut value for the --db-pattern argument
73 .TP
74 \fBMYMAIL_DB_ROOT\fR
75 defaut value for the --db-root argument
76 .TP
77 \fBMYMAIL_DB_LIST\fR
78 defaut value for the --db-list argument
79 .TP
80 \fBMYMAIL_DB_FILE\fR
81 defaut value for the --db-file-output argument
82 .TP
83 \fBMYMAILRC \fR
84 configuration file, default is ${HOME}/.mymailrc
85
86 .SH "SEARCH CONDITIONS"
87
88 A search condition is either a time-related condition
89 ('today', 'yesterday', etc.), or a single-character key, followed by a
90 space and a regexp, which can itself contain spaces.
91
92 If it is prefaced by the character "!", a condition is negated and has
93 to be false for a mail to be selected.
94
95 .TP
96 \fBf <regexp>\fR (from)
97 selects mails whose leading line 'From', or fields From:, Sender:,
98 Reply-To:, or Return-Path: matches the regexp.
99 .TP
100 \fBt <regexp>\fR (to)
101 selects mails whose field To:, Cc:, or Bcc: matches the regexp.
102 .TP
103 \fBp <regexp>\fR (participant)
104 selects mails that would be selected by \fBf\fR or \fBt\fR.
105 .TP
106 \fBs <regexp>\fR (subject)
107 selects mails whose field Subject: matches the regexp.
108 .TP
109 \fBd <regexp>\fR (date)
110 selects mails whose field Date: matches the regexp.
111 .TP
112 \fBb <regexp>\fR (body)
113
114 selects mails whose body matches the regexp. Evaluating such a
115 condition requires to read the full mail from the original mboxes,
116 which can be slow. To speed things up, all the header conditions are
117 checked first.
118 .TP
119 \fB8h\fR, \fB24h\fR, \fB48h\fR, \fBweek\fR, \fBmonth\fR, \fBtrimester\fR,
120 and \fByear\fR selects mails received during the last 8, 24, 24, 48, 7
121 * 24 hours, 31 * 24 hours, 92 * 24 hours, and 365 * 24 hours respectively.
122 .TP
123 \fBtoday\fR
124 selects mails received since midnight.
125 .TP
126 \fByesterday\fR
127 selects mails received yesterday.
128 .TP
129 \fBmonday\fR, \fBtuesday\fR, ..., \fBsunday\fR
130 selects mails received the most recent such day of the week.
131
132 .SH "EXAMPLES"
133
134 The command
135
136 .P
137 .nf
138 .B mymail --db-file-output /tmp/mymail/2010-2011/mymail.db \e
139 .B \ \ \ \ \ \ \ --index \e
140 .B \ \ \ \ \ \ \ ~/archives/mails/2010 ~/archives/mails/2011
141
142 .fi
143 will index all the mbox files present in the directories
144 ~/archives/mails/2010 and ~/archives/mails/2011 (recursively) and
145 create an index file /tmp/mymail/2010-2011/mymail.db
146
147 And
148
149 .P
150 .nf
151 .B mymail --db-pattern '\.db$' --db-root /tmp/mymail \e
152 .B \ \ \ \ \ \ \ --output /tmp/mymail.mbox \e
153 .B \ \ \ \ \ \ \ --search 'p bob.something' \e
154 .B \ \ \ \ \ \ \ --search '!s spam' \e
155 .B \ \ \ \ \ \ \ --search 'month'
156
157 .fi
158 will search in all the database files *.db located (recursively) in
159 /tmp/mymail, for all the mails having "bob.something" as sender or
160 recipient, without "spam" in the subject, received over the last 31
161 days, and create an mbox file /tmp/mymail/mbox.
162
163 .SH "FILES"
164
165 The configuration file is by default ${HOME}/.mymailrc and can also be
166 specified through the MYMAILRC environment variable.
167
168 It allows to define aliases of search keys, such as:
169
170 .P
171 .nf
172 .B alias tod=today
173
174 .SH "BUGS"
175
176 The search in the mail bodies does not decode mimencoding mails, hence
177 will not catch patterns in encoded text.
178
179 The mbox format is not clear for multipart messages, since the 'From'
180 may not always be quoted properly, so mymail uses a strict regexp to
181 recognize such lines.
182
183 The date format for the Date: field is not standardized, and may not
184 be parsed properly. When that happens, the time stamp from the
185 leading 'From' line of the mail, which has a canonical form, is used.
186
187 .SH "AUTHOR"
188
189 Written by Francois Fleuret <francois@fleuret.org> and distributed
190 under the terms of the GNU General Public License version 3 as
191 published by the Free Software Foundation. This is free software: you
192 are free to change and redistribute it. There is NO WARRANTY, to the
193 extent permitted by law.