Fix Typos.

Are log files now stored in ~/.mu/log/mu.log rather than ~/.mu/mu.log?
This commit is contained in:
Stephen Eglen
2013-06-03 23:15:28 +01:00
parent 62501372de
commit fcbe03e501

View File

@ -19,7 +19,7 @@ queried using
.B index .B index
understands Maildirs as defined by Daniel Bernstein for qmail(7). In addition, understands Maildirs as defined by Daniel Bernstein for qmail(7). In addition,
it understands recursive Maildirs (Maildirs within Maildirs), Maildir++. It it understands recursive Maildirs (Maildirs within Maildirs), Maildir++. It
can also deal with VFAT-based Maildirs which use '!' as the seperators instead can also deal with VFAT-based Maildirs which use '!' as the separators instead
of ':' as used by \fITinymail\fR/\fIModest\fR and some other e-mail programs. of ':' as used by \fITinymail\fR/\fIModest\fR and some other e-mail programs.
E-mail messages which are not stored in something resembling a maildir E-mail messages which are not stored in something resembling a maildir
@ -40,7 +40,7 @@ some maildirs that never change. Note that you can still search for these
messages, this only affects updating the database. messages, this only affects updating the database.
The first run of \fBmu index\fR may take a few minutes if you have a lot of The first run of \fBmu index\fR may take a few minutes if you have a lot of
mail (ten thousands of messages). Fortunately, such a full scan needs to be mail (tens of thousands of messages). Fortunately, such a full scan needs to be
done only once; after that it suffices to index the changes, which goes much done only once; after that it suffices to index the changes, which goes much
faster. See the 'Note on performance' below for more information. faster. See the 'Note on performance' below for more information.
@ -49,9 +49,9 @@ from the database for which there is no longer a corresponding file in the
Maildir. If you do not want this, you can use \fB\-n\fR, \fB\-\-nocleanup\fR. Maildir. If you do not want this, you can use \fB\-n\fR, \fB\-\-nocleanup\fR.
When \fBmu index\fR catches one of the signals \fBSIGINT\fR, \fBSIGHUP\fR or When \fBmu index\fR catches one of the signals \fBSIGINT\fR, \fBSIGHUP\fR or
\fBSIGTERM\fR (e.g,, when you press Ctrl-C during the indexing process), it \fBSIGTERM\fR (e.g., when you press Ctrl-C during the indexing process), it
tries to shutdown gracefully; it tries to save and commit data, and close the tries to shutdown gracefully; it tries to save and commit data, and close the
database etc. If it receives another signal (e.g,, when pressing Ctrl-C once database etc. If it receives another signal (e.g., when pressing Ctrl-C once
more), \fBmu index\fR will terminate immediately. more), \fBmu index\fR will terminate immediately.
.SH OPTIONS .SH OPTIONS
@ -71,7 +71,7 @@ starts searching at \fI<maildir>\fR. By default, \fBmu\fR uses whatever the
specifies that some e-mail address is 'my-address' (\fB\-\-my-address\fR can specifies that some e-mail address is 'my-address' (\fB\-\-my-address\fR can
be used multiple times). This is used by \fBmu cfind\fR -- any e-mail address be used multiple times). This is used by \fBmu cfind\fR -- any e-mail address
found in the address fields of a message which also has found in the address fields of a message which also has
\fI<my-email-address>\fR in one of its address fields, is considered a \fI<my-email-address>\fR in one of its address fields is considered a
\fIpersonal\fR e-mail address. This allows you, for example, to filter out \fIpersonal\fR e-mail address. This allows you, for example, to filter out
(\fBmu cfind --personal\fR) addresses which were merely seen in mailing list (\fBmu cfind --personal\fR) addresses which were merely seen in mailing list
messages. messages.
@ -113,14 +113,14 @@ increase this. Note that the reason for having a maximum size is that big
message require big memory allocations, which may lead to problems. message require big memory allocations, which may lead to problems.
.B NOTE: .B NOTE:
It is not recommended tot mix maildirs and sub-maildirs within the hierarchy It is not recommended to mix maildirs and sub-maildirs within the hierarchy
in the same database; for example, it's better not to index both with in the same database; for example, it's better not to index both with
\fB\-\-maildir\fR=~/MyMaildir and \fB\-\-maildir\fR=~/MyMaildir/foo, as this \fB\-\-maildir\fR=~/MyMaildir and \fB\-\-maildir\fR=~/MyMaildir/foo, as this
may lead to unexpected results when searching with the the 'maildir:' search may lead to unexpected results when searching with the 'maildir:' search
parameter (see below). parameter (see below).
.SS A note on performance (i) .SS A note on performance (i)
As a non-scientific benchmark, a simple test on the authors machine (a As a non-scientific benchmark, a simple test on the author's machine (a
Thinkpad X61s laptop using Linux 2.6.35 and an ext3 file system) with no Thinkpad X61s laptop using Linux 2.6.35 and an ext3 file system) with no
existing database, and a maildir with 27273 messages: existing database, and a maildir with 27273 messages:
@ -141,7 +141,7 @@ already, goes much faster:
.fi .fi
(more than 56818 messages per second) (more than 56818 messages per second)
Note that each of test flushes the caches first; a more common use case might Note that each test flushes the caches first; a more common use case might
be to run \fBmu index\fR when new mail has arrived; the cache may stay be to run \fBmu index\fR when new mail has arrived; the cache may stay
quite 'warm' in that case: quite 'warm' in that case:
@ -207,7 +207,7 @@ been specified explicitly with \fB\-\-maildir\fR=\fI<maildir>\fR. If
.SH RETURN VALUE .SH RETURN VALUE
\fBmu index\fR return 0 upon successful completion, and any other number \fBmu index\fR return 0 upon successful completion, and any other number
greater than 2 signals an error, for example: greater than 0 signals an error:
.nf .nf
| code | meaning | | code | meaning |