X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=mymail.git;a=blobdiff_plain;f=mymail.1;h=03382d9177ef2e52f23692968047f3922f29fe82;hp=917e97c1c9cc1f11e022c0817b0d5d7d65033c0e;hb=19b2c9bdf74142b485066e405603cfd090e7045c;hpb=2831f08f7f231a5c6fba9ffc8ca918c6e26b67ac diff --git a/mymail.1 b/mymail.1 index 917e97c..03382d9 100644 --- a/mymail.1 +++ b/mymail.1 @@ -1,4 +1,4 @@ -.TH "MYMAIL" "0.9.1" "February 2013" "Francois Fleuret" "User Commands" +.TH "MYMAIL" "0.9.8" "April 2013" "Francois Fleuret" "User Commands" \" This man page was written by Francois Fleuret \" and is distributed under a Creative Commons Attribution-Share Alike @@ -10,16 +10,15 @@ mymail \- A simple command line utility for indexing and searching mbox files .SH "SYNOPSIS" -\fBmymail\fP [\fIoptions\fR] [\fI\fR [\fI\fR ... ]|\fI\fR [\fI\fR ... ]]\n"); +\fBmymail\fP [\fIoptions\fR] [\fI\fR [\fI\fR ... ]|\fI\fR [\fI\fR ... ]] .SH "DESCRIPTION" -\fBmymail\fP is a command line utility to index mbox files and perform -quick searches based on sender, subject, etc. +\fBmymail\fP is a command line utility to index mbox files, search for +mails based on sender, subject, etc. and generate result mbox files. -It is similar in spirit to other existing software such as mu or -notmuch, but does not use a real database backend to store and query -the index. +It is similar in spirit to other tools such as mu or notmuch, but is +overall simpler. .SH "OPTIONS" .TP @@ -29,6 +28,13 @@ display help and exit \fB-v\fR, \fB--version\fR print the version number .TP +\fB-q\fR, \fB--quiet\fR +do not write information during the search +.TP +\fB-t\fR, \fB--use-leading-time\fR +use the time stamp from the leading line of each mail and not the +Date: field +.TP \fB-p \fR, \fB--db-pattern \fR set the db filename pattern for recursive search .TP @@ -38,15 +44,26 @@ set the db root path for recursive search \fB-l \fR, \fB--db-list \fR set the semicolon-separated list of db files for search .TP -\fB-s \fR, \fB--search \fR -search for matching mails in the db file +\fB-m \fR, \fB--mbox-pattern \fR +set the mbox filename pattern for recursive search .TP -\fB-d \fR, \fB--db-file \fR +\fB-s \fR, \fB--search \fR search for +matching mails in the db file. Multiple search requests can be +combined, and only mails fulfilling all of them will be extracted. +.TP +\fB-d \fR, \fB--db-file-output \fR set the db filename for indexing .TP \fB-i\fR, \fB--index\fR index mails in the mailboxes located recursively anywhere in the directories following the options on the command lines +.TP +\fB-o \fR, \fB--output \fR set the +result mbox filename. If it is not set, the standard output is used +.TP +\fB-a \fR, \fB--default-search \fR +set the default search key. If a search request is not understood, +it is interpreted as the regexp with this default search key .SH "ENVIRONMENT VARIABLES" @@ -61,61 +78,98 @@ defaut value for the --db-root argument defaut value for the --db-list argument .TP \fBMYMAIL_DB_FILE\fR -defaut value for the --db-file argument +defaut value for the --db-file-output argument + +.SH "SEARCH CONDITIONS" -.SH "SEARCH SYNTAX" +A search condition is either a time-related condition +('today', 'yesterday', etc.), or a single-character key, followed by a +space and a regexp, which can itself contain spaces. -The search conditions take the form of a single letter followed by a -space and a regexp, which can itself contain spaces. If the condition -is prefaced by the character "!" it is negated, and has to be false -for a mail to be selected. +If it is prefaced by the character "!", a condition is negated and has +to be false for a mail to be selected. .TP -\fBf \fR (from) selects mails whose leading line From, or -fields From:, or Reply-To: matches the regexp. +\fBf \fR (from) +selects mails whose leading line 'From', or fields From:, Sender:, +Reply-To:, or Return-Path: matches the regexp. +.TP +\fBt \fR (to) +selects mails whose field To:, Cc:, or Bcc: matches the regexp. .TP -\fBt \fR (to) selects mails whose field To:, Cc:, or Bcc: matches the regexp. +\fBp \fR (participant) +selects mails that would be selected by \fBf\fR or \fBt\fR. .TP -\fBp \fR (participant) selects mails whose leading line From, -or fields From:, Reply-To:, To:, Cc:, or Bcc: matches the regexp. +\fBs \fR (subject) +selects mails whose field Subject: matches the regexp. .TP -\fBs \fR (subject) selects mails whose field Subject: matches the regexp. +\fBd \fR (date) +selects mails whose field Date: matches the regexp. .TP -\fBd \fR (date) selects mails whose field Date: matches the regexp. +\fBb \fR (body) +selects mails whose body matches the regexp. Evaluating such a +condition requires to read the original mboxes completely, which can +be slow. However, header conditions are checked first to read the +bodies only for mails which fulfill them entirely. .TP -\fBb \fR (body) selects mails whose body matches the -regexp. This requires reading the original mboxes completely, which -can be slow. Header conditions have to be fulfilled before checking -the body ones, which may speed things up. +\fB8h\fR, \fB24h\fR, \fB48h\fR, \fBweek\fR, \fBmonth\fR, \fBtrimester\fR, +and \fByear\fR selects mails received during the last 8, 24, 24, 48, 7 +* 24 hours, 31 * 24 hours, 92 * 24 hours, and 365 * 24 hours respectively. +.TP +\fBtoday\fR +selects mails received since midnight. +.TP +\fByesterday\fR +selects mails received yesterday. +.TP +\fBmonday\fR, \fBtuesday\fR, ..., \fBsunday\fR +selects mails received the most recent such day of the week. .SH "EXAMPLES" -To index all the mbox files present in the directories +The command + +.P +.nf +.B mymail --db-file-output /tmp/mymail/2010-2011/mymail.db \e +.B \ \ \ \ \ \ \ --index \e +.B \ \ \ \ \ \ \ ~/archives/mails/2010 ~/archives/mails/2011 + +.fi +will index all the mbox files present in the directories ~/archives/mails/2010 and ~/archives/mails/2011 (recursively) and -create a database file /tmp/mymail/2010-2011/mymail.db +create an index file /tmp/mymail/2010-2011/mymail.db -.RS -.EX -mymail --db-file /tmp/mymail/2010-2011/mymail.db --index ~/archives/mails/2010 ~/archives/mails/2011 -.EE -.RE +And -To search in all the database files *.db located (recursively) in -/tmp/mymail, for all the mails having bob.something as sender or -recipient, without "spam" in the subject, and create a result mbox -file /tmp/mymail/mbox +.P +.nf +.B mymail --db-pattern '\.db$' --db-root /tmp/mymail \e +.B \ \ \ \ \ \ \ --output /tmp/mymail.mbox \e +.B \ \ \ \ \ \ \ --search 'p bob.something' \e +.B \ \ \ \ \ \ \ --search '!s spam' \e +.B \ \ \ \ \ \ \ --search 'month' -.RS -.EX -mymail --db-pattern '\\.db$' --db-root /tmp/mymail --search 'p bob.something' --search '!s spam' > /tmp/mymail.mbox -.EE -.RE +.fi +will search in all the database files *.db located (recursively) in +/tmp/mymail, for all the mails having "bob.something" as sender or +recipient, without "spam" in the subject, received over the last 31 +days, and create an mbox file /tmp/mymail/mbox. .SH "BUGS" The search in the mail bodies does not decode mimencoding mails, hence will not catch patterns in encoded text. +The mbox format is not clear for multipart messages, since the 'From' +may not always be quoted properly, so mymail uses a strict regexp to +recognize such lines. + +The date format for the Date: field is not standardized, and may not +be parsed properly. When that happens, the time stamp from the +leading 'From' line of the mail, which has a canonical form, is be +used. + .SH "AUTHOR" Written by Francois Fleuret and distributed