* update documentation

This commit is contained in:
Dirk-Jan C. Binnema 2011-05-26 23:39:54 +03:00
parent 132f0d4b01
commit 39ad685e1d
3 changed files with 29 additions and 10 deletions

7
NEWS
View File

@ -13,10 +13,11 @@
- fix progress info in 'mu index' - fix progress info in 'mu index'
- display the references for a message using the 'r' character (mu find) - display the references for a message using the 'r' character (mu find)
- remove --summary-len/-k, instead use --summary for mu view and mu find, and - remove --summary-len/-k, instead use --summary for mu view and mu find, and
- support colorized output for some sub-commands (view and cfind). Disabled - support colorized output for some sub-commands (view, cfind and
by default, use --color to enable, or set env MU_COLORS to non-empty extract). Disabled by default, use --color to enable, or set env
MU_COLORS to non-empty
- update documentation, add more examples - update documentation, add more examples
** Release 0.9.5 <2011-04-25 Mon> ** Release 0.9.5 <2011-04-25 Mon>
- bug fix for infinite loop in Maildir detection - bug fix for infinite loop in Maildir detection

View File

@ -104,10 +104,11 @@ colors will only shown when output goes to a sufficiently capable terminal
(this roughly mirrors the \fI--color=auto\fR of the GNU-version of the (this roughly mirrors the \fI--color=auto\fR of the GNU-version of the
\fBls\fR-command). \fBls\fR-command).
Instead of the \fI--color\fR/, you can also set the \fBMU_COLORS\fR environment Instead of the \fI--color\fR/, you can also set the \fBMU_COLORS\fR
variable to non-empty to enable colors. environment variable to non-empty to enable colors.
Currently. only \fBmu view\fR and \fBmu cfind\fB support colors. Currently, \fBmu find\fR, \fBmu view\fR, \fBmu cfind\fR and \fBmu extract\fR
support colors.
.SH DATABASE AND FILE .SH DATABASE AND FILE

View File

@ -55,8 +55,7 @@
#+end_src #+end_src
** Finding contacts
** Find contacts
Contacts (names + email addresses) are cached separately, and can be Contacts (names + email addresses) are cached separately, and can be
searched with =mu cfind= (after your messages have been indexed): searched with =mu cfind= (after your messages have been indexed):
@ -104,7 +103,19 @@
Do not confuse the '.*' regular expression in =mu extract= (and =mu cfind= Do not confuse the '.*' regular expression in =mu extract= (and =mu cfind=
with the '*' wildcard in =mu find=. with the '*' wildcard in =mu find=.
** Getting more colorful output
Some of the =mu= commands, such as =mu find=, =mu cfind= and =mu view=
support colorized output. By default this is turned off, but you can enable
it with =--color=, or setting the =MU_COLORS= environment variable to
non-empty.
#+begin_src sh
$ mu find --color capibara
#+end_src
(since =mu= version 0.9.6)
** Further processing of matched messages ** Further processing of matched messages
If you need to process the results of your queries with some other program, If you need to process the results of your queries with some other program,
@ -120,8 +131,14 @@
Note that we use ='l'=, so the returned message paths will be quoted. This is Note that we use ='l'=, so the returned message paths will be quoted. This is
useful if you have maildirs with spaces in their names. useful if you have maildirs with spaces in their names.
For further processing, also the ~--format=(xml|json|sexp)~ may be For further processing, also the ~--format=(xml|json|sexp)~ can be useful. For
interesting. example,
#+begin_src sh
$ mu find --format=xml pancake
#+end_src
will give you a list of pancake-related messages in XML-format.
** Integration with mail clients ** Integration with mail clients