* updates to the man pages

man/mu-bookmarks.5

@@ -1,16 +1,16 @@
-.TH MU-BOOKMARKS 5 "November 2010" "User Manuals"
+.TH MU-BOOKMARKS 5 "April 2011" "User Manuals"
 
 .SH NAME 
 
-bookmarks \- file with bookmarks (shortcuts) for mu
+bookmarks \- file with bookmarks (shortcuts) for mu search expressions
 
 .SH DESCRIPTION
 
 Bookmarks are named shortcuts for search queries. They allow using a
-convenient name for oft-used queries.
+convenient name for often-used queries.
 
-\fBmu\fR supports bookmarks stored in a file called \fBbookmarks\fR in the
+\fBmu\fR supports bookmarks stored in a file called \fBbookmarks\fR in the mu
-mu home directory (typically, \fI~/.mu/\fR).
+home directory (so typically, this would be \fI~/.mu/bookmarks\fR).
 
 The bookmarks file is a typical key=value \fB.ini\fR-file, which is best shown
 by means of an example:
@@ -23,7 +23,7 @@ by means of an example:
 
 The \fB[mu]\fR group header is required.
 
-For practical uses of bookmarks, see mu-find(1) or mug(1).
+For practical uses of bookmarks, see mu-find(1).
 
 .SH LOCATION
 
@@ -37,4 +37,4 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
 
 .SH "SEE ALSO"
 
-mu(1) mu-find(1) mug(1)
+mu(1) mu-find(1)

man/mu-cfind.1

@@ -1,10 +1,9 @@
-.TH MU CFIND 1 "March 2011" "User Manuals"
+.TH MU CFIND 1 "April 2011" "User Manuals"
 
 .SH NAME 
 
-mu cfind \- find contacts in the
+mu cfind \- find contacts in the \fBmu\fR database and export them for use in
-.B mu
+other programs.
-database and/or export
 
 .SH SYNOPSIS
 
@@ -14,8 +13,8 @@ database and/or export
 
 \fBmu cfind\fR is the \fBmu\fR command for finding \fIcontacts\fR (name and
 e-mail address of people who were either the sender or receiver of
-mail). There are different output formats for the contacts to enable importing
+mail). There are different output formats available, for importing the
-them into other tools.
+contacts into various tools.
 
 .SH SEARCHING CONTACTS
 
@@ -47,7 +46,7 @@ The regular expressions are Perl-compatible (as per the PCRE-library).
 .SH OPTIONS
 
 .TP
-\fB\-\-format\fR=\fIplain|mutt|wl|org-contact|bbdb|csv\fR
+\fB\-\-format\fR=\fIplain|mutt-alias|mutt-ab|wl|org-contact|bbdb|csv\fR
 set the output format to the given value. The following are available:
 
 .nf
@@ -91,10 +90,8 @@ Now, in mutt, you can easily search for e-mail address using the
 
 .SH BUGS
 
-Please report bugs if you find them:
+Please report bugs if you find them at
-.BR http://code.google.com/p/mu0/issues/list
+\fBhttp://code.google.com/p/mu0/issues/list\fR.
-If you have specific messages which are not matched correctly, please attach
-them (appropriately censored of course).
 
 .SH AUTHOR
 
@@ -102,4 +99,4 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
 
 .SH "SEE ALSO"
 
-.BR mu(1) mu-index(1) mu-find(1)
+.BR mu(1) mu-index(1) mu-find(1) pcrepattern(3)

man/mu-cleanup.1

@@ -1,4 +1,4 @@
-.TH MU CLEANUP 1 "January 2011" "User Manuals"
+.TH MU CLEANUP 1 "April 2011" "User Manuals"
 
 .SH NAME 
 
@@ -10,9 +10,10 @@ mu cleanup \- clean up the mu database
 
 .SH DESCRIPTION
 
-\fBcleanup\fR  removes messages for which no corresponding file can
+\fBcleanup\fR removes messages from the database for which no corresponding
-be found, from the database. This is done automatically when running
+file can be found in the file system. This is done automatically when running
-\fBmu index\fR (unless \fB\-\-nocleanup\fR was specified).
+\fBmu index\fR (unless \fB\-\-nocleanup\fR was specified), but \fBmu cleanup\fR
+can be used to do the cleanup explicitely.
 
 \fBmu cleanup\fR does not remove messages that are outside the currently
 specified Maildir, as long as they still exist. The command only takes global
@@ -42,6 +43,4 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
 
 .SH "SEE ALSO"
 
-.BR maildir(5)
+.BR maildir(5) mu-index(1) mu(1)
-.BR mu-index(1)
-.BR mu(1)

man/mu-easy.1

@@ -1,4 +1,4 @@
-.TH MU-EASY 1 "March 2010" "User Manuals"
+.TH MU-EASY 1 "April 2011" "User Manuals"
 
 .SH NAME 
 
@@ -8,8 +8,8 @@ mu easy \- a quick introduction to mu
 
 \fBmu\fR is a set of tools for dealing with e-mail messages in Maildirs. There
 are many options, which are all described in the man pages for the various
-sub-commands. This man pages jumps over all the details and gives examples of
+sub-commands. This man pages jumps over all of the details and gives examples
-the more common use cases. If the use cases described here do not precisely do
+of some common use cases. If the use cases described here do not precisely do
 what you want, please check the more extensive information in the man page
 about the sub-command you are using -- for example, the mu-index or mu-find
 man pages.
@@ -20,6 +20,7 @@ Maildir-format. If you don't do so, you can still use the other commands, but
 you won't be able to index/search your mail.
 
 .SH INDEXING YOUR E-MAIL
+
 Before you can search e-mails, you'll first need to index them:
 
 .nf
@@ -31,24 +32,24 @@ the speed of your computer, hard drive etc. Usually, indexing should be able to
 reach a speed of a few hundred messages per second.
 
 \fBmu index\fR guesses the top-level Maildir to do its job; if it guesses
-wrong, you can use the \fI--maildir\fR option to specify the top-level
+wrongly, you can use the \fI--maildir\fR option to specify the top-level
 directory that should be processed. See the \fBmu-index\fR man page for more
-detail.
+details.
 
 Normally, \fBmu index\fR visits all the directories under the top-level
 Maildir; however, you can exclude certain directories (say, the 'trash'
 or 'spam' folders) by creating a file called \fI.noindex\fR in the directory.
-When \fBmu\fR sees such a file, it will excluded this directory and its
+When \fBmu\fR sees such a file, it will exclude this directory and its
-sub-directories.
+sub-directories from indexing.
 
 .SH SEARCHING YOUR E-MAIL
 
-After you have indexed your mail,you can search it. Normally, the search
+After you have indexed your mail, you can start searching it. By default, the
-results are to standard output, but the output can also be in the form of
+search results are printed on standard output. Alternatively, the output can
-Maildir with symbolic links to the found messages. This enables integration
+take the form of Maildir with symbolic links to the found messages. This
-with e-mail clients; see the \fBmu-find\fR man page for details, the syntax of
+enables integration with e-mail clients; see the \fBmu-find\fR man page for
-the search parameters and so on. Here, we just give some examples for common
+details, the syntax of the search parameters and so on. Here, we just give
-cases.
+some examples for common cases.
 
 First, let's search for all messages sent to Julius Caesar regarding fruit:
 
@@ -63,8 +64,8 @@ This should return something like:
 .fi
 
 This means there is a message to 'julius' with 'fruit' somewhere in the
-message. In this case, it's a message from John Milton. Note that the display
+message. In this case, it's a message from John Milton. Note that the date
-of the date depends on your system locale.
+format depends on your the language/locale you are using.
 
 How do we know that the message was sent to Julius Caesar? Well, it's not
 visible from the results above, because the default fields that are shown are
@@ -165,9 +166,10 @@ Get all message we got in the last two weeks about emacs:
 
 .SH DISPLAYING MESSAGES
 
-We might also want to display complete messages. This can be done using \fBmu
+We might also want to display the complete messages instead of the header
-view\fR command. Note that this command does not use the database; you simply
+information. This can be done using \fBmu view\fR command. Note that this
-provide the path to a message.
+command does not use the database; you simply provide it the path to a
+message.
 
 Therefore, if you want to display some message from a search query, you'll
 need its path. To get the path (think \fBl\fRocation) for our first example we
@@ -197,6 +199,31 @@ We can now display this message:
      [...]
 .fi
 
+.SH FINDING CONTACTS
+
+While \fBmu find\fR searches for messages, there is also \fBmu cfind\fR to
+find \fIcontacts\fR, that is, names + addresses. Without any search
+expression, \fBmu cfind\fR lists all of your contacts.
+
+.nf
+  \fB$ mu cfind julius\fR 
+.fi
+
+will find all contacts with 'julius' in either name or e-mail address. Note
+that \fBmu cfind\fR accepts a regular expression.
+
+\fBmu cfind\fR also supports a \fI--format=\fR-parameter, which sets the
+output to some specific format, so the results can be imported into another
+program. For example, to export your contact information to a \fBmutt\fR
+address book file, you can use something like:
+
+.nf
+  \fB$ mu cfind --format=mutt-alias > ~/mutt-aliases \fR 
+.fi
+
+Then, you can use them in \fBmutt\fR if you add something like \fBsource
+~/mutt-aliases\fR to your \fImuttrc\fR.
+
 .SH AUTHOR
 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
 

man/mu-extract.1

@@ -1,4 +1,4 @@
-.TH MU EXTRACT 1 "February 2011" "User Manuals"
+.TH MU EXTRACT 1 "April 2011" "User Manuals"
 
 .SH NAME 
 
@@ -14,10 +14,12 @@ mu extract\- display and save message parts (attachments)
 attachments) from mail messages. It works on message files, and does not
 require the message to be indexed.
 
-For attachments, the file name specified in the mail message is used (if
+For attachments, the file name used for saving is the name of the attachment
-any). If there is no name, or when saving other mime-parts, a name is used
+in the message. If there is no such name, or when saving other mime-parts, a
-derived from the message-id of the message. Without any options, \fBmu
+name derived from the message-id of the message.
-extract\fR simply outputs the list of MIME-parts in the message.
+
+Without any options, \fBmu extract\fR simply outputs the list of MIME-parts in
+the message.
 
 .SH OPTIONS
 
@@ -46,14 +48,13 @@ overwrite existing files with the same name; by default overwriting is not
 allowed.
 
 .TP
-\fB\-\-play\fR
+\fB\-\-play\fR Try to 'play' (open) the attachment with the default
-Try to 'play' (open) the attachment with the corresponding
+application for the particular file type. Depends on the \fBxdg-open\fR
-application. Depends on the \fBxdg-open\fR utility.
+utility.
-
 
 .SH BUGS
-Please report bugs if you find them:
 
+Please report bugs if you find them:
 .BR http://code.google.com/p/mu0/issues/list
 
 .SH AUTHOR

man/mu.1

@@ -1,8 +1,8 @@
-.TH MU 1 "November 2010" "User Manuals"
+.TH MU 1 "April 2011" "User Manuals"
 
 .SH NAME 
 
-mu \- a set of tools to deal with Maildirs; in particular to index and search
+mu \- a set of tools to deal with Maildirs, in particular to index and search
 e-mail messages.
 
 .SH SYNOPSIS
@@ -21,18 +21,22 @@ e-mail messages.
 
 .B mu extract [options] <file> [<parts>]
 
+.B mu cfind [options] [<expr>]
+
+
 .SH DESCRIPTION
 
 \fBmu\fR is a set of tools for dealing with Maildirs and the e-mail messages
 in them.
 
 \fBmu\fRs main function is to enable searching of e-mail messages. It does so
-by scanning a Maildir directory tree and analyzing the e-mail messages found
+by periodically scanning a Maildir directory tree and analyzing the e-mail
-('indexing'). The results of this analysis are stored in a database, which can
+messages found ('indexing'). The results of this analysis are stored in a
-then be queried.
+database, which can then be queried.
 
 In addition to indexing and searching, \fBmu\fR also offers functionality for
-viewing messages, extracting attachments and creating maildirs.
+viewing messages, extracting attachments and creating maildirs, and searching
+and exporting contact information.
 
 \fBmu\fR can be used from the command line or can be integrated with various
 e-mail clients.
@@ -66,6 +70,15 @@ parameters. See
 .BR mu-find(1)
 \.
 
+
+.TP
+\fBcfind\fR
+for finding contacts (names + e-mail addresses) matching a certain expression,
+and exporting the results in various formats for use in other programs.
+.BR mu-cfind(1)
+\.
+
+
 .TP
 \fBview\fR
 for displaying e-mail messages. See
@@ -146,5 +159,5 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
 
 .SH "SEE ALSO"
 
-.BR mu-index(1) mu-cleanup(1) mu-find(1) mu-mkdir(1) mu-view(1)
+.BR mu-index(1) mu-cleanup(1) mu-find(1) mu-cfind(1) mu-mkdir(1) mu-view(1)
 .BR mu-extract(1) mu-easy(1) mu-bookmarks(5)