From a8f20ddfab407e696eee2d33564a0fc62e39d39a Mon Sep 17 00:00:00 2001 From: djcb Date: Sun, 21 Oct 2012 16:02:06 +0300 Subject: [PATCH] * man: fix some troff formatting issues (thanks to Maciek Borzecki) --- man/mu-cfind.1 | 26 +++++++++++++------------- man/mu-find.1 | 4 ++-- man/mu-index.1 | 12 ++++++------ man/mu-remove.1 | 2 +- 4 files changed, 22 insertions(+), 22 deletions(-) diff --git a/man/mu-cfind.1 b/man/mu-cfind.1 index 4e6591d3..6bf6b2e6 100644 --- a/man/mu-cfind.1 +++ b/man/mu-cfind.1 @@ -1,4 +1,4 @@ -.TH MU CFIND 1 "July 2012" "User Manuals" +.TH MU CFIND 1 "October 2012" "User Manuals" .SH NAME @@ -12,9 +12,9 @@ database and export them for use in other programs. .SH DESCRIPTION \fBmu cfind\fR is the \fBmu\fR command for finding \fIcontacts\fR (name and -e-mail address of people who were either sender or receiver of mail). There -are different output formats available, for importing the contacts into -other programs. +e-mail address of people who were either an e-mail's sender or +receiver). There are different output formats available, for importing the +contacts into other programs. .SH SEARCHING CONTACTS @@ -36,12 +36,12 @@ would find all contacts with a gmail-address, while $ mu cfind Mary .fi -would find all contact with Mary in either name or e-mail address. +lists all contacts with Mary in either name or e-mail address. -If you do not specify any search expression, \fBmu cfind\fR will return the -full list of contacts. Note, \fBmu cfind\fR uses does not directly use the -database, but uses a cache file with e-mail addresses that is populated during -the indexing process. +If you do not specify any search expression, \fBmu cfind\fR returns the full +list of contacts. Note, \fBmu cfind\fR uses does not directly use the +database, but uses a cache file with e-mail addresses, which is populated +during the indexing process. The regular expressions are Perl-compatible (as per the PCRE-library). @@ -100,18 +100,18 @@ example: You can use \fBmu cfind\fR as an external address book server for \fBmutt\fR. For this to work, add the following to your \fImuttrc\fR: -.sh +.nf set query_command = "mu cfind --format=mutt-ab '%s'" -.si +.fi -Now, in mutt, you can easily search for e-mail address using the +Now, in mutt, you can easily search for e-mail addresses using the \fBquery\fR-command, which is (by default) accessible by pressing \fBQ\fR. .SH ENCODING \fBmu cfind\fR output is encoded according to the current locale except for \fI--format=bbdb\fR. This is hard-coded to UTF-8, and as such specified in the -output-file, so emacs/bbdb can handle it correctly without guessing. +output-file, so emacs/bbdb can handle things correctly, without guessing. .SH BUGS diff --git a/man/mu-find.1 b/man/mu-find.1 index 842f673c..79f5dc84 100644 --- a/man/mu-find.1 +++ b/man/mu-find.1 @@ -51,7 +51,7 @@ characters. All match. In general, \fBmu\fR tries to be 'eager' in matching, as filtering out unwanted results is usually preferrable over non matching messages. -A wildcard search is a search where a \fB*\fR matches the last \fIn\R +A wildcard search is a search where a \fB*\fR matches the last \fIn\fR character(s) in some string. The string must always start with one or more characters before the wildcards. Since version 0.9.6, \fBmu\fR also supports wildcard searches for all fields except maildirs and paths. So, to get all @@ -427,7 +427,7 @@ use a bookmarked search query. Using this option, a query from your bookmark file will be prepended to other search queries. See mu-bookmarks(1) for the details of the bookmarks file. -.T +.TP \fB\-t\fR, \fB\-\-threads\fR show messages in 'threaded' format -- that is, with indentation and arrows showing the conversation threads in the list of matching messages. diff --git a/man/mu-index.1 b/man/mu-index.1 index 81931116..3d7ea7bb 100644 --- a/man/mu-index.1 +++ b/man/mu-index.1 @@ -134,7 +134,7 @@ existing database, and a maildir with 27273 messages: $ sudo sh -c 'sync && echo 3 > /proc/sys/vm/drop_caches' $ time mu index --quiet 66,65s user 6,05s system 27% cpu 4:24,20 total -.si +.fi (about 103 messages per second) A second run, which is the more typical use case when there is a database @@ -144,7 +144,7 @@ already, goes much faster: $ sudo sh -c 'sync && echo 3 > /proc/sys/vm/drop_caches' $ time mu index --quiet 0,48s user 0,76s system 10% cpu 11,796 total -.si +.fi (more than 56818 messages per second) Note that each of test flushes the caches first; a more common use case might @@ -153,8 +153,8 @@ quite 'warm' in that case: .nf $ time mu index --quiet -0,33s user 0,40s system 80% cpu 0,905 total -.si + 0,33s user 0,40s system 80% cpu 0,905 total +.fi which is more than 30000 messages per second. @@ -167,7 +167,7 @@ messages. $ sudo sh -c 'sync && echo 3 > /proc/sys/vm/drop_caches' $ time mu index --quiet 27,79s user 2,17s system 48% cpu 1:01,47 total -.si +.fi (about 813 messages per second) A second run, which is the more typical use case when there is a database @@ -177,7 +177,7 @@ already, goes much faster: $ sudo sh -c 'sync && echo 3 > /proc/sys/vm/drop_caches' $ time mu index --quiet 0,13s user 0,30s system 19% cpu 2,162 total -.si +.fi (more than 173000 messages per second) diff --git a/man/mu-remove.1 b/man/mu-remove.1 index 7637c807..a3a9bfc2 100644 --- a/man/mu-remove.1 +++ b/man/mu-remove.1 @@ -2,7 +2,7 @@ .SH NAME -\fBmu remove\fR is the \fBmu\R command to remove messages from the database. +\fBmu remove\fR is the \fBmu\fR command to remove messages from the database. .SH SYNOPSIS