* update mu-find, mu-index manpages

This commit is contained in:
Dirk-Jan C. Binnema
2010-11-12 21:00:03 +02:00
parent 367b97095a
commit 04c4432067
2 changed files with 31 additions and 13 deletions

View File

@ -1,4 +1,4 @@
.TH MU FIND 1 "September 2010" "User Manuals" .TH MU FIND 1 "November 2010" "User Manuals"
.SH NAME .SH NAME
@ -12,11 +12,13 @@ database
.SH DESCRIPTION .SH DESCRIPTION
\fBmu find\fR is the \fBmu\fR sub-command for searching e-mails there were \fBmu find\fR is the \fBmu\fR sub-command for searching e-mails that were
store earlier using stored earlier using
.BR mu-index(1) .BR mu-index(1)
\. \.
.SH SEARCHING MAIL
The \fBfind\fR command starts a search for messages in the database that match The \fBfind\fR command starts a search for messages in the database that match
the search pattern. the search pattern.
@ -27,16 +29,18 @@ are treated as if there were a logical \fBAND\fR between them.
If you want to make your own constructions (using \fBAND\fR, \fBOR\fR, If you want to make your own constructions (using \fBAND\fR, \fBOR\fR,
\fBNOT\fR etc., you have to put quotes around them so \fBmu\fR can consider \fBNOT\fR etc., you have to put quotes around them so \fBmu\fR can consider
them as a unit; for example to find mails with oranges OR mandarins in the them as a unit; for example to find mails with oranges OR mandarins in the
subject-field, you'd use: subject-field, you can use:
.nf .nf
mu find 'subject:orange OR subject:mandarin' mu find 'subject:orange OR subject:mandarin'
.fi .fi
\fBmu find\fR does not distinguish between uppercase or lowercase for search \fBmu find\fR does not distinguish between uppercase or lowercase for search
terms. terms.
\fBmu\fR relies on the Xapian database for its searching capabilities, so it \fBmu\fR relies on the Xapian database for its searching capabilities, so it
offers all the search functionality that Xapian offers; please refer to: offers all the search functionality that Xapian offers; for all the details, see:
\fIhttp://xapian.org/docs/queryparser.html\fR \fIhttp://xapian.org/docs/queryparser.html\fR
@ -50,8 +54,13 @@ would do in an internet search engine. For example,
.fi .fi
will find all message that contain both 'monkey' and 'banana'. Matching is will find all message that contain both 'monkey' and 'banana'. Matching is
case-insensitive and recognizes various forms of a word such as plurals; this case-insensitive and accent-insensitive; thus
is all courtesy of Xapian.
.nf
mu find Mönkey BÄNANA
.fi
yields the same results as the example above.
\fBmu\fR also recognizes prefixes for specific fields in a messages; for \fBmu\fR also recognizes prefixes for specific fields in a messages; for
example: example:
@ -73,23 +82,31 @@ search fields and their abbreviations:
msgid,i Message-ID msgid,i Message-ID
.fi .fi
For clarity, this man-page uses the longer versions.
The Maildir field describes the directory path starting \fBafter\fR the The Maildir field describes the directory path starting \fBafter\fR the
Maildir-base path, and before the \fI/cur/\fR or \fI/new/\fR part. So for Maildir-base path, and before the \fI/cur/\fR or \fI/new/\fR part. So for
example, if there's a message with the file name example, if there's a message with the file name
\fI~/Maildir/lists/running/cur/1234.213:2,\fR, you could find it (and all the \fI~/Maildir/lists/running/cur/1234.213:2,\fR, you could find it (and all the
other messages in the same maildir) with: other messages in the same maildir) with:
.nf .nf
mu find maildir:/lists/running mu find maildir:/lists/running
.fi .fi
Note the starting '/'. If you want to match mails in the 'root' maildir, you Note the starting '/'. If you want to match mails in the 'root' maildir, you
can do with a single '/': can do with a single '/':
.nf .nf
mu find maildir:/ mu find maildir:/
.fi .fi
(and of course you can use the \fBm:\fR shortcut instead of \fBmaildir:\fR)
.SH OPTIONS
.SS Find options Note, some of the important options are described in the \fBmu(1)\fR man-page
and not here, as they apply to multiple mu-commands.
The \fBfind\fR-command has various options that influence the way \fBmu\fR The \fBfind\fR-command has various options that influence the way \fBmu\fR
displays the results. If you don't specify anything, the defaults are displays the results. If you don't specify anything, the defaults are
@ -262,8 +279,8 @@ macro index <F9> "<change-folder-readonly>~/Maildir/search" \
.TP .TP
\fBWanderlust\fR \fBWanderlust\fR
If you use Wanderlust for \fBemacs\fR, the following definitons can be used; If you use the Wanderlust e-mail client for \fBemacs\fR, the following
typing 'Q' will start a query. definitions can be used; typing 'Q' will start a query.
.nf .nf
;; mu integration for Wanderlust ;; mu integration for Wanderlust
@ -292,7 +309,6 @@ typing 'Q' will start a query.
(message "Query failed"))) (message "Query failed")))
.fi .fi
.SH BUGS .SH BUGS
Please report bugs if you find them: Please report bugs if you find them:

View File

@ -52,6 +52,9 @@ more), \fBmu index\fR will terminate immediately.
.SH OPTIONS .SH OPTIONS
Note, some of the important options are described in the \fBmu(1)\fR man-page
and not here, as they apply to multiple mu-commands.
.TP .TP
\fB\-m\fR, \fB\-\-maildir\fR=\fI<maildir>\fR \fB\-m\fR, \fB\-\-maildir\fR=\fI<maildir>\fR
starts searching at \fI<maildir>\fR. By default, \fBmu\fR uses whatever the starts searching at \fI<maildir>\fR. By default, \fBmu\fR uses whatever the
@ -103,7 +106,6 @@ with \fB\-\-maildir\fR=~/MyMaildir and \fB\-\-maildir\fR=~/MyMaildir/foo, as
this may lead to unexpected results when searching with the the 'maildir:' this may lead to unexpected results when searching with the the 'maildir:'
search parameter (see below). search parameter (see below).
.SS A note on performance .SS A note on performance
As a non-scientific benchmark, a simple test on the authors machine (a As a non-scientific benchmark, a simple test on the authors machine (a
Thinkpad X61s laptop using Linux 2.6.31 and an ext3 file system) with no Thinkpad X61s laptop using Linux 2.6.31 and an ext3 file system) with no
@ -157,7 +159,7 @@ continued use of \fBmu\fR without the need for any manual maintenance of log
files. files.
To store these files elsewhere from their default location, one can use the To store these files elsewhere from their default location, one can use the
\fI\-\-muhome\fR option, as discussed in the \fBGENERAL OPTIONS\fR section. \fI\-\-muhome\fR option, as discussed in the \fBmu\fR-manpage.
.SH ENVIRONMENT .SH ENVIRONMENT