From: Francois Fleuret <francois@fleuret.org>
Date: Sat, 2 Feb 2013 23:26:17 +0000 (+0100)
Subject: Updated the usage and man page.
X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=mymail.git;a=commitdiff_plain;h=622b0a6df1bcb8e072facf472e4568609ab2a321

Updated the usage and man page.
---

diff --git a/mymail.1 b/mymail.1
index abfd077..2bb8d43 100644
--- a/mymail.1
+++ b/mymail.1
@@ -18,7 +18,50 @@ mymail \- A simple command line utility for indexing and searching mbox files
 perform quick searches based on sender, subject, etc.
 
 It is similar in spirit to other existing software such as mu or
-notmuch.
+notmuch, but does not use a real database backend to store and query
+the index.
+
+.SH "OPTIONS"
+.TP
+\fB-h\fR, \fB--help\fR
+display help and exit
+.TP
+\fB-v\fR, \fB--version\fR
+print the version number
+.TP
+\fB-p <db filename pattern>\fR, \fB--db-pattern <db filename pattern>\fR
+set the db filename pattern for recursive search
+.TP
+\fB-r <db root path>\fR, \fB--db-root <db root path>\fR
+set the db root path for recursive search
+.TP
+\fB-l <db filename list>\fR, \fB--db-list <db filename list>\fR
+set the semicolon-separated list of db files for search
+.TP
+\fB-s <search pattern>\fR, \fB--search <search pattern>\fR
+search for matching mails in the db file
+.TP
+\fB-d <db filename>\fR, \fB--db-file <db filename>\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
+
+.SH "ENVIRONMENT VARIABLES"
+
+.TP
+\fBMYMAIL_DB_PATTERN\fR
+defaut value for the --db-pattern argument
+.TP
+\fBMYMAIL_DB_ROOT\fR
+defaut value for the --db-root argument
+.TP
+\fBMYMAIL_DB_LIST\fR
+defaut value for the --db-list argument
+.TP
+\fBMYMAIL_DB_FILE\fR
+defaut value for the --db-file argument
 
 .SH "SEARCH SYNTAX"
 
@@ -28,7 +71,7 @@ is prefaced by the character "!" it is negated, and has to be false
 for a mail to be selected.
 
 .TP
-\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.
+\fBf <regexp>\fR selects mails whose field From, From:, or Reply-To: matches the regexp.
 .TP
 \fBt <regexp>\fR selects mails whose field To:, Cc:, or Bcc: matches the regexp.
 .TP
@@ -40,23 +83,24 @@ for a mail to be selected.
 
 .SH "EXAMPLES"
 
-To index all the mbox files present in the directory ~/archives/mails/2010
-(recursively) and create a data-base file /tmp/mymail/2010/mymail.db
+To 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
 
 .RS
 .EX
-mymail --index --db-file /tmp/mymail/2010/mymail.db ~/archives/mails/2010
+mymail --db-file /tmp/mymail/2010-2011/mymail.db --index ~/archives/mails/2010 ~/archives/mails/2011
 .EE
 .RE
 
-To search in all the data-base files mymail.db located (recursively)
-in /tmp/mymail, for all the mails having bob.something as sender or
+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 creating a result mbox
 file /tmp/mymail/mbox
 
 .RS
 .EX
-mymail --db-file mymail.db --db-root /tmp/mymail --search 'p bob.something' --search '!s spam' > /tmp/mymail.mbox
+mymail --db-pattern '\\.db$' --db-root /tmp/mymail --search 'p bob.something' --search '!s spam' > /tmp/mymail.mbox
 .EE
 .RE
 
diff --git a/mymail.c b/mymail.c
index f3fc8d5..21ad5ea 100644
--- a/mymail.c
+++ b/mymail.c
@@ -165,20 +165,24 @@ void print_usage(FILE *out) {
   print_version(out);
   fprintf(out, "Written by Francois Fleuret <francois@fleuret.org>.\n");
   fprintf(out, "\n");
-  fprintf(out, "Usage: mymail [options] [<mbox dir1> [<mbox dir2> ...]]\n");
+  fprintf(out, "Usage: mymail [options] [<mbox dir1> [<mbox dir2> ...]|<db file1> [<db file2> ...]]\n");
   fprintf(out, "\n");
   fprintf(out, " -h, --help\n");
   fprintf(out, "         show this help\n");
   fprintf(out, " -v, --version\n");
   fprintf(out, "         print the version number\n");
-  fprintf(out, " -i, --index\n");
-  fprintf(out, "         index mails\n");
+  fprintf(out, " -p <db filename pattern>, --db-pattern <db filename pattern>\n");
+  fprintf(out, "         set the db filename pattern for recursive search\n");
+  fprintf(out, " -r <db root path>, --db-root <db root path>\n");
+  fprintf(out, "         set the db root path for recursive search\n");
+  fprintf(out, " -l <db filename list>, --db-list <db filename list>\n");
+  fprintf(out, "         set the semicolon-separated list of db files for search\n");
   fprintf(out, " -s <search pattern>, --search <search pattern>\n");
-  fprintf(out, "         search for matching mails in the data-base file\n");
+  fprintf(out, "         search for matching mails in the db file\n");
   fprintf(out, " -d <db filename>, --db-file <db filename>\n");
-  fprintf(out, "         set the data-base file\n");
-  fprintf(out, " -r <db root path>, --db-root <db root path>\n");
-  fprintf(out, "         set the data-base root path for recursive search\n");
+  fprintf(out, "         set the db filename for indexing\n");
+  fprintf(out, " -i, --index\n");
+  fprintf(out, "         index mails\n");
 }
 
 /*********************************************************************/