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

* update mu-cfind documention, fix typo in mu-find manpage

Browse Source
This commit is contained in:
Dirk-Jan C. Binnema
2011-03-05 09:42:35 +02:00
parent b6cfe6f748
commit afbaedd942
2 changed files with 29 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
man/mu-cfind.1
View File

@ -12,14 +12,17 @@ database and/or export
.SH DESCRIPTION .SH DESCRIPTION
\fBmu cfind\fR is the \fBmu\fR command for finding contacts (i.e., people who \fBmu cfind\fR is the \fBmu\fR command for finding \fIcontacts\fR (name and
were either the sender or receiver of mail). 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
them into other tools.
.SH SEARCHING CONTACTS .SH SEARCHING CONTACTS
When you index your messages (see \fBmu index\fR), \fBmu\fR creates a list of When you index your messages (see \fBmu index\fR), \fBmu\fR creates a list of
all unique e-mail addresses found, and the accompanying name. In case the same unique e-mail addresses found, and the accompanying name. In case the same
e-mail address is used with different names, the most recent one is used. e-mail address is used with different names, the most recent non-empty name is
used.
\fBmu cfind\fR starts a search for contacts that match a \fIregular \fBmu cfind\fR starts a search for contacts that match a \fIregular
expression\fR. For example: expression\fR. For example:
@ -36,16 +39,31 @@ would find all contacts with a gmail-address, while
would find all contact with Mary in either name or e-mail address. would find all contact 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.
The regular expressions are Perl-compatible (as per the PCRE-library).
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-\-format\fR= \fB\-\-format\fR=\fIplain|mutt|wl|org-contact|bbdb|csv\fR
set the file access mode for the new maildir(s) as in \fBchmod(1)\fR. set the output format to the given value. The following are available:
.nf
| --format= | description |
|-------------+-------------------------------|
| plain | default, simple list |
| mutt | mutt alias-format |
| wl | wanderlust addressbook format |
| org-contact | org-mode org-contact format |
| bbdb | BBDB format |
| csv | comma-separated values |
.fi
.SH RETURN VALUE .SH RETURN VALUE
\fBmu find\fR return 0 upon successful completion; if it the a search was \fBmu cfind\fR returns 0 upon successful completion; if it the a search was
performed, there needs to be a least one match. Anything else leads to a performed, there needs to be a least one match. Anything else leads to a
non-zero return value, for example: non-zero return value, for example:
@ -70,5 +88,4 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO" .SH "SEE ALSO"
.BR mu(1) .BR mu(1) mu-index(1) mu-find(1)
.BR mu-index(1)

2
man/mu-find.1
View File

@ -471,7 +471,7 @@ definitions can be used; typing 'Q' will start a query.
.SH RETURN VALUE .SH RETURN VALUE
\fBmu find\fR return 0 upon successful completion; if it the a search was \fBmu find\fR returns 0 upon successful completion; if it the a search was
performed, there needs to be a least one match. Anything else leads to a performed, there needs to be a least one match. Anything else leads to a
non-zero return value, for example: non-zero return value, for example: