* mu.1: some small man improvement (still very much WIP)
This commit is contained in:
112
man/mu.1
112
man/mu.1
@ -7,14 +7,23 @@ mu \- index and search the contents of e-mail messages stored in Maildirs
|
|||||||
|
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
.B mu
|
.B mu
|
||||||
is a tool for indexing and searching e-mail messages stored in Maildirs. It
|
is a set of tools for indexing and searching e-mail messages stored in
|
||||||
does so by recursively scanning a Maildir directory tree and analyzing the
|
Maildirs. It does so by recursively scanning a Maildir directory tree and
|
||||||
e-mail messages found. The results of this analysis are then stored in a
|
analyzing the e-mail messages found. The results of this analysis are then
|
||||||
database. Using this database, you can quickly search for specific messages.
|
stored in a database. Using this database, you can quickly search for specific
|
||||||
|
messages.
|
||||||
|
|
||||||
|
.B mu
|
||||||
|
also offers functionality for creating maildirs.
|
||||||
|
|
||||||
|
The various tools are available as commands for a single
|
||||||
|
.B mu
|
||||||
|
executable.
|
||||||
|
|
||||||
.SH COMMANDS
|
.SH COMMANDS
|
||||||
.B mu
|
.B mu
|
||||||
offers the following commands.
|
offers the following commands:
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fBindex\fR
|
\fBindex\fR
|
||||||
for indexing (analyzing) the contents of your Maildirs, and storing the
|
for indexing (analyzing) the contents of your Maildirs, and storing the
|
||||||
@ -27,9 +36,13 @@ below for details). You can use \fBquery\fR and \fBsearch\fR as synonyms for
|
|||||||
\fBfind\fR.
|
\fBfind\fR.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
One can can run these command by either using \fBmu index\fR or \fBmu find\fR \
|
\fBcleanup\fR
|
||||||
from the command line, plus any parameters they take. In the following, we \
|
for removing messages from your database for which there is no corresponding
|
||||||
discusses these commands in detail.
|
message file anymore. This commonly happens when you delete or move messages.
|
||||||
|
|
||||||
|
.TP
|
||||||
|
\fBmkdir\fR
|
||||||
|
for creating Maildirs.
|
||||||
|
|
||||||
.SH THE INDEX COMMAND
|
.SH THE INDEX COMMAND
|
||||||
Using the
|
Using the
|
||||||
@ -47,7 +60,7 @@ leaf directory are ignored.
|
|||||||
|
|
||||||
Currently, symlinks are not followed.
|
Currently, symlinks are not followed.
|
||||||
|
|
||||||
Also, if there's a file called
|
If there is a file called
|
||||||
.B .noindex
|
.B .noindex
|
||||||
in a directory, the contents of that directory and any of its subdirectories
|
in a directory, the contents of that directory and any of its subdirectories
|
||||||
will be ignored. This can be useful to exclude certain directories from the
|
will be ignored. This can be useful to exclude certain directories from the
|
||||||
@ -55,24 +68,36 @@ indexing process, for example directories with spam-messages.
|
|||||||
|
|
||||||
The first run of
|
The first run of
|
||||||
.B mu index
|
.B mu index
|
||||||
can take some time; on the author's laptop using mu version 0.6, scans more
|
may take a few minutes if you have a lot of mail (ten thousands of messages).
|
||||||
than 1000 messages per second. Note that a full scan has to be done only once,
|
Note that a full scan has to be done only once, after that it suffices to
|
||||||
after that it suffices to index the changes, which goes much faster.
|
index the changes, which goes much faster.
|
||||||
|
|
||||||
.SS Indexing options
|
.SS Indexing options
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB\-m\fR, \fB\-\-maildir\fR=\fI<maildir>\fR
|
\fB\-m\fR, \fB\-\-maildir\fR=\fI<maildir>\fR start searching
|
||||||
start searching at Maildir \fB<maildir>\fR. By default,
|
at\fI<maildir>\fR. By default,
|
||||||
.B mu
|
.B mu
|
||||||
uses whatever
|
uses whatever the
|
||||||
.B MAILDIR
|
.B MAILDIR
|
||||||
is set to; if that is not set, it tries
|
environment variable is set to; if that is not set, it tries
|
||||||
.B ~/Maildir
|
.B ~/Maildir
|
||||||
|
\.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB\-r\fR, \fB\-\-reindex\fR
|
\fB\-r\fR, \fB\-\-reindex\fR
|
||||||
re-index all mails, even ones that are already in the database.
|
re-index all mails, even ones that are already in the database.
|
||||||
|
|
||||||
|
.TP
|
||||||
|
\fB\-u\fR, \fB\-\-cleanup\fR automatically clean up the database after
|
||||||
|
indexing. This is equivalent to calling the
|
||||||
|
.B cleanup
|
||||||
|
command after indexing. Please see the information for
|
||||||
|
.B cleanup
|
||||||
|
for details.
|
||||||
|
|
||||||
|
.TP
|
||||||
|
|
||||||
.B NOTE:
|
.B NOTE:
|
||||||
It is probably not a good idea to run multiple instances of
|
It is probably not a good idea to run multiple instances of
|
||||||
.B mu index
|
.B mu index
|
||||||
@ -102,10 +127,10 @@ will search for messages that match all of those words. So,
|
|||||||
will find all messages which have both "monkey" AND "banana" in one of those
|
will find all messages which have both "monkey" AND "banana" in one of those
|
||||||
fields.
|
fields.
|
||||||
|
|
||||||
|
.SH THE CLEANUP COMMAND
|
||||||
|
|
||||||
|
|
||||||
|
.SH THE MKDIR COMMAND
|
||||||
|
|
||||||
|
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
.B mu
|
.B mu
|
||||||
@ -144,57 +169,6 @@ which is the default.
|
|||||||
.B --debug, -d
|
.B --debug, -d
|
||||||
add a lot of logging for debugging purposes
|
add a lot of logging for debugging purposes
|
||||||
|
|
||||||
.SH CONFIGURATION
|
|
||||||
Instead of specifying the options on the command line, you can also specify
|
|
||||||
them in the
|
|
||||||
.B mu-conf
|
|
||||||
configuration file, in the mu home directory (by default,
|
|
||||||
.B ~/.mu
|
|
||||||
). The
|
|
||||||
.B General options
|
|
||||||
go in the section
|
|
||||||
.B [mu]
|
|
||||||
while the
|
|
||||||
.B mu-index
|
|
||||||
specific options go under
|
|
||||||
.B [mu-index].
|
|
||||||
For example, your configuration file could look something like this:
|
|
||||||
|
|
||||||
.nf
|
|
||||||
[mu]
|
|
||||||
debug=false
|
|
||||||
|
|
||||||
[mu-index]
|
|
||||||
maildir=~/MyMaildir
|
|
||||||
.fi
|
|
||||||
|
|
||||||
Note that command line arguments take precedence over the configuration file.
|
|
||||||
|
|
||||||
.SH MAILDIR SUPPORT
|
|
||||||
.B mu-index
|
|
||||||
supports an extended version of
|
|
||||||
.BR maildir(5)
|
|
||||||
; in particular, it supports (a) a tree of Maildirs (strictly, the maildir
|
|
||||||
specification does not allow this, but it is useful and widely supported), and
|
|
||||||
(b) it supports '!' in addition to ':' as separators in mail filenames, which
|
|
||||||
some e-mail programs (such as
|
|
||||||
.BR modest(1)
|
|
||||||
and the Maildir module in
|
|
||||||
.BR python(1)
|
|
||||||
use to support on VFAT filesystems, which don't allow ':' in filenames.
|
|
||||||
|
|
||||||
.B mu-index
|
|
||||||
ignores messages it cannot read or
|
|
||||||
.BR stat(2)
|
|
||||||
; but failure to read or stat will be logged. Files starting with '.' are
|
|
||||||
ignored, but directories are not. Thus, if there is a message
|
|
||||||
.B .dotdir/new/mymsg1234
|
|
||||||
it will be indexed. This allows indexing
|
|
||||||
.B Maildir++
|
|
||||||
directories, as used by
|
|
||||||
.I CourierIMAP
|
|
||||||
and
|
|
||||||
.I Dovecot
|
|
||||||
|
|
||||||
.B mu-index
|
.B mu-index
|
||||||
processes messages in
|
processes messages in
|
||||||
|
|||||||
Reference in New Issue
Block a user