alx/mu4e
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

mu: update mu-index manpage for --lazy-check

Browse Source 
Describe the new --lazy-check option, and add some updated benchmarks.
This commit is contained in:
djcb
2016-07-24 12:31:22 +03:00
parent eb7888cdb1
commit 3eda6961af
1 changed files with 44 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
man/mu-index.1
View File

@ -1,4 +1,4 @@
.TH MU-INDEX 1 "September 2013" "User Manuals" .TH MU-INDEX 1 "July 2016" "User Manuals"
.SH NAME .SH NAME
@ -13,18 +13,16 @@ mu index \- index e-mail messages stored in Maildirs
\fBmu index\fR is the \fBmu\fR command for scanning the contents of Maildir \fBmu index\fR is the \fBmu\fR command for scanning the contents of Maildir
directories and storing the results in a Xapian database. The data can then be directories and storing the results in a Xapian database. The data can then be
queried using queried using
.BR mu-find(1) .BR mu-find(1)\.
\.
.B index \fBindex\fR understands Maildirs as defined by Daniel Bernstein for
understands Maildirs as defined by Daniel Bernstein for qmail(7). In addition, qmail(7). In addition, it understands recursive Maildirs (Maildirs
it understands recursive Maildirs (Maildirs within Maildirs), Maildir++. It within Maildirs), Maildir++. It can also deal with VFAT-based Maildirs
can also deal with VFAT-based Maildirs which use '!' as the separators instead which use '!' as the separators instead of ':'.
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
leaf-directory (\fIcur\fR and \fInew\fR) are ignored, as are the cache leaf-directory (\fIcur\fR and \fInew\fR) are ignored, as are the cache
directories for \fInotmuch\fR and \fIgnus\fR. directories for \fInotmuch\fR and \fIgnus\fR, and any dot-directory.
Symlinks are not followed. Symlinks are not followed.
@ -39,10 +37,14 @@ rebuild (with \fB--rebuild\fR). This can be useful to speed up things you have
some maildirs that never change. Note that you can still search for these 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 There also the \fB--lazy-check\fR which can greatly speed up indexing;
mail (tens of thousands of messages). Fortunately, such a full scan needs to be see below for details.
done only once; after that it suffices to index the changes, which goes much
faster. See the 'Note on performance' below for more information. The first run of \fBmu index\fR may take a few minutes if you have a
lot of 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 faster. See the 'Note on performance
(i,ii,iii)' below for more information.
The optional 'phase two' of the indexing-process is the removal of messages The optional 'phase two' of the indexing-process is the removal of messages
from the database for which there is no longer a corresponding file in the from the database for which there is no longer a corresponding file in the
@ -67,7 +69,6 @@ starts searching at \fI<maildir>\fR. By default, \fBmu\fR uses whatever the
.TP .TP
\fB\-\-my-address\fR=\fI<my-email-address>\fR \fB\-\-my-address\fR=\fI<my-email-address>\fR
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
@ -76,6 +77,16 @@ found in the address fields of a message which also has
(\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.
.TP
\fB\-\-lazy-check\fR
in lazy-check mode, \fBmu\fR does not consider messages for which the
time-stamp (ctime) of the directory they reside in has not changed
since the previous indexing run. This is much faster than the non-lazy
check, but won't update messages that have change (rather than having
been added or removed), since merely editing a message does not update
the directory time-stamp. Of course, you can run \fBmu-index\fR
occasionally without \fB\-\-lazy-check\fR, to pick up such messages.
.TP .TP
\fB\-\-nocleanup\fR \fB\-\-nocleanup\fR
disables the database cleanup that \fBmu\fR does by default after indexing. disables the database cleanup that \fBmu\fR does by default after indexing.
@ -105,7 +116,7 @@ size to (for example) 1000, which will reduce memory consumption, but also
substantially reduce the indexing performance. substantially reduce the indexing performance.
.TP .TP
\fB\-\-max-msg-size\fR=\fI<max msg size>\fR\ \fB\-\-max-msg-size\fR=\fI<max msg size>\fR
set the maximum size (in bytes) for messages. The default maximum set the maximum size (in bytes) for messages. The default maximum
(currently at 500Mb) should be enough in most cases, but if you (currently at 500Mb) should be enough in most cases, but if you
encounter warnings from \fBmu\fR about ignoring messsage because they encounter warnings from \fBmu\fR about ignoring messsage because they
@ -155,8 +166,8 @@ which is more than 30000 messages per second.
.SS A note on performance (ii) .SS A note on performance (ii)
As per June 2012, we did the same non-scientific benchmark, this time with an As per June 2012, we did the same non-scientific benchmark, this time with an
Intel) i5-2500 CPU @ 3.30GHz, an ext4 file system and a maildir with 22589 Intel i5-2500 CPU @ 3.30GHz, an ext4 file system and a maildir with 22589
messages. messages. We start without an existing database.
.nf .nf
$ sudo sh -c 'sync && echo 3 > /proc/sys/vm/drop_caches' $ sudo sh -c 'sync && echo 3 > /proc/sys/vm/drop_caches'
@ -176,10 +187,22 @@ already, goes much faster:
(more than 173000 messages per second) (more than 173000 messages per second)
In general, \fBmu\fR has been getting faster with each release, even with .SS A note on performance (iii)
relatively expensive new features such as text-normalization (for As per July 2016, we did the same non-scientific benchmark, again with
case-insensitve/accent-insensitive matching). The profiles are dominated by the Intel i5-2500 CPU @ 3.30GHz, an ext4 file system. This time, the
operations in the Xapian database now. maildir contains 72525 messages.
.nf
$ sudo sh -c 'sync && echo 3 > /proc/sys/vm/drop_caches'
$ time mu index --quiet
40,34s user 2,56s system 64% cpu 1:06,17 total
.fi
(about 1099 messages per second).
As shown, \fBmu\fR has been getting faster with each release, even
with relatively expensive new features such as text-normalization (for
case-insensitve/accent-insensitive matching). The profiles are
dominated by operations in the Xapian database now.
.SH FILES .SH FILES
By default, \fBmu index\fR stores its message database in \fI~/.mu/xapian\fR; By default, \fBmu index\fR stores its message database in \fI~/.mu/xapian\fR;