From 39ad685e1de8bd5fb4d91fe460849562046b7533 Mon Sep 17 00:00:00 2001 From: "Dirk-Jan C. Binnema" Date: Thu, 26 May 2011 23:39:54 +0300 Subject: [PATCH] * update documentation --- NEWS | 7 ++++--- man/mu.1 | 7 ++++--- www/cheatsheet.org | 25 +++++++++++++++++++++---- 3 files changed, 29 insertions(+), 10 deletions(-) diff --git a/NEWS b/NEWS index 9831be9c..4ad1f8c6 100644 --- a/NEWS +++ b/NEWS @@ -13,10 +13,11 @@ - fix progress info in 'mu index' - 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 - - support colorized output for some sub-commands (view and cfind). Disabled - by default, use --color to enable, or set env MU_COLORS to non-empty + - support colorized output for some sub-commands (view, cfind and + extract). Disabled by default, use --color to enable, or set env + MU_COLORS to non-empty - update documentation, add more examples - + ** Release 0.9.5 <2011-04-25 Mon> - bug fix for infinite loop in Maildir detection diff --git a/man/mu.1 b/man/mu.1 index 774ad964..6b81fc03 100644 --- a/man/mu.1 +++ b/man/mu.1 @@ -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 \fBls\fR-command). -Instead of the \fI--color\fR/, you can also set the \fBMU_COLORS\fR environment -variable to non-empty to enable colors. +Instead of the \fI--color\fR/, you can also set the \fBMU_COLORS\fR +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 diff --git a/www/cheatsheet.org b/www/cheatsheet.org index 9bcf2464..909a8b92 100644 --- a/www/cheatsheet.org +++ b/www/cheatsheet.org @@ -55,8 +55,7 @@ #+end_src - -** Find contacts +** Finding contacts Contacts (names + email addresses) are cached separately, and can be 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= 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 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 useful if you have maildirs with spaces in their names. - For further processing, also the ~--format=(xml|json|sexp)~ may be - interesting. + For further processing, also the ~--format=(xml|json|sexp)~ can be useful. For + 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