ultrix man page for mu-cfind

MU-CFIND(1)                                                   General Commands Manual                                                  MU-CFIND(1)

NAME
       mu_cfind - find contacts in the mu database and export them for use in other programs.

SYNOPSIS
       mu cfind [options] [<pattern>]

DESCRIPTION
       mu  cfind  is the mu command for finding contacts (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.

SEARCHING CONTACTS
       When you index your messages (see mu index), mu creates a list of unique e-mail addresses found and the accompanying name. In case the same
       e-mail address is used with different names, the most recent non-empty name is used.

       mu cfind starts a search for contacts that match a regular expression. For example:

          $ mu cfind '@gmail.com'

       would find all contacts with a gmail-address, while

          $ mu cfind Mary

       would find all contact with Mary in either name or e-mail address.

       If you do not specify any search expression, mu cfind will return the full list of contacts.

       The regular expressions are Perl-compatible (as per the PCRE-library).

OPTIONS
       --format=plain|mutt-alias|mutt-ab|wl|org-contact|bbdb|csv
              sets the output format to the given value. The following are available:

              | --format=   | description                       |
              |-------------+-----------------------------------|
              | plain       | default, simple list              |
              | mutt-alias  | mutt alias-format                 |
              | mutt-ab     | mutt external address book format |
              | wl          | wanderlust addressbook format     |
              | org-contact | org-mode org-contact format       |
              | bbdb        | BBDB format                       |
              | csv         | comma-separated values            |

RETURN VALUE
       mu  cfind  returns 0 upon successful completion -- that is, at least one contact was found. Anything else leads to a non-zero return value,
       for example:

       | code | meaning                        |
       |------+--------------------------------|
       |    0 | ok                             |
       |    1 | general error                  |
       |    2 | no matches (for 'mu cfind')    |

INTEGRATION WITH MUTT
       You can use mu cfind as an external address book server for mutt. For this to work, add the following to your muttrc:

          set query_command = "mu cfind --format=mutt-ab '%s'"

       Now, in mutt, you can easily search for e-mail address using the query-command, which is (by default) accessible by pressing Q.

ENCODING
       mu cfind output is encoded according to the current locale except for --format=bbdb. This is hard-coded to UTF-8, and as such specified  in
       the output-file, so emacs/bbdb can handle it correctly without guessing.

BUGS
       Please report bugs if you find them at http://code.google.com/p/mu0/issues/list.

AUTHOR
       Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>

SEE ALSO
       mu(1) mu-index(1) mu-find(1) pcrepattern(3)

User Manuals                                                         May 2011                                                          MU-CFIND(1)