From: Francois Fleuret <francois@fleuret.org>
Date: Sat, 9 Feb 2013 10:33:56 +0000 (+0100)
Subject: Update.
X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=mymail.git;a=commitdiff_plain;h=248736d0d3900bce18c1c6afd9f3dc2d93df2cae

Update.
---

diff --git a/mymail.1 b/mymail.1
index 82b35b5..b79b4b9 100644
--- a/mymail.1
+++ b/mymail.1
@@ -10,16 +10,15 @@ mymail \- A simple command line utility for indexing and searching mbox files
 
 .SH "SYNOPSIS"
 
-\fBmymail\fP [\fIoptions\fR] [\fI<mbox dir1>\fR [\fI<mbox dir2>\fR ... ]|\fI<db file1>\fR [\fI<db file2>\fR ... ]]\n");
+\fBmymail\fP [\fIoptions\fR] [\fI<mbox dir1>\fR [\fI<mbox dir2>\fR ... ]|\fI<db file1>\fR [\fI<db file2>\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
@@ -56,7 +55,7 @@ directories following the options on the command lines
 result mbox filename. If it is not set, the standard output is used
 .TP
 \fB-a <search field>\fR, \fB--default-search <search field>\fR
-set the default search field: If a search request is not understood,
+set the default search field. If a search request is not understood,
 it is interpreted as the regexp with this default search field
 
 .SH "ENVIRONMENT VARIABLES"
@@ -82,43 +81,47 @@ is prefaced by the character "!" it is negated, and has to be false
 for a mail to be selected.
 
 .TP
-\fBf <regexp>\fR (from) selects mails whose leading line From, or
-fields From:, Sender:, Reply-To:, or Return-Path: matches the regexp.
+\fBf <regexp>\fR (from)
+selects mails whose leading line From, or fields From:, Sender:,
+Reply-To:, or Return-Path: matches the regexp.
 .TP
-\fBt <regexp>\fR (to) selects mails whose field To:, Cc:, or Bcc: matches the regexp.
+\fBt <regexp>\fR (to)
+selects mails whose field To:, Cc:, or Bcc: matches the regexp.
 .TP
-\fBp <regexp>\fR (participant) selects mails that would be selected by \fBf\fR or \fBt\fR.
+\fBp <regexp>\fR (participant)
+selects mails that would be selected by \fBf\fR or \fBt\fR.
 .TP
-\fBs <regexp>\fR (subject) selects mails whose field Subject: matches the regexp.
+\fBs <regexp>\fR (subject)
+selects mails whose field Subject: matches the regexp.
 .TP
-\fBd <regexp>\fR (date) selects mails whose field Date: matches the regexp.
+\fBd <regexp>\fR (date)
+selects mails whose field Date: matches the regexp.
 .TP
-\fBb <regexp>\fR (body) selects mails whose body matches the
-regexp. Evaluatin 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.
+\fBb <regexp>\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
 \fB8h\fR, \fBtoday\fR, \fB24h\fR, \fBweek\fR, \fBmonth\fR, and
-\fByear\fR selects mails received during the last 8, 24, 24, 7 * 24
-hours, 31 * 24 hours, and 365 * 24 hours respectively.
+\fByear\fR
+selects mails received during the last 8, 24, 24, 7 * 24 hours, 31 *
+24 hours, and 365 * 24 hours respectively.
 .TP
-\fByesterday\fR selects mails received between 48h and 24h ago.
+\fByesterday\fR
+selects mails received between 48h and 24h ago.
 .TP
-\fBmonday\fR, \fBtuesday\fR, ..., \fBsunday\fR selects mails received
-the most recent such day
+\fBmonday\fR, \fBtuesday\fR, ..., \fBsunday\fR
+selects mails received the most recent such day of the week
 
 .SH "EXAMPLES"
 
 The command
 
-.RS
-.EX
-mymail --db-file /tmp/mymail/2010-2011/mymail.db \\
-       --index \\
-       ~/archives/mails/2010 ~/archives/mails/2011
-.EE
-.RE
+.nf
+.B mymail --db-file /tmp/mymail/2010-2011/mymail.db \e
+.B        --index \e
+.B        ~/archives/mails/2010 ~/archives/mails/2011
 
 will index all the mbox files present in the directories
 ~/archives/mails/2010 and ~/archives/mails/2011 (recursively) and
@@ -126,15 +129,12 @@ create an index file /tmp/mymail/2010-2011/mymail.db
 
 And
 
-.RS
-.EX
-mymail --db-pattern '\.db$' --db-root /tmp/mymail \\
-       --output /tmp/mymail.mbox \\
-       --search 'p bob.something' \\
-       --search '!s spam' \\
-       --search 'month'
-.EE
-.RE
+.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'
 
 will search in all the database files *.db located (recursively) in
 /tmp/mymail, for all the mails having "bob.something" as sender or