summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDirk-Jan C. Binnema <djcb@djcbsoftware.nl>2011-05-26 23:39:54 +0300
committerDirk-Jan C. Binnema <djcb@djcbsoftware.nl>2011-05-26 23:39:54 +0300
commit39ad685e1de8bd5fb4d91fe460849562046b7533 (patch)
tree8a9c4e2d148ddba305116eb6b29dd0e7e073397c
parent132f0d4b0149aabfd19b5bc44870b76e64c0df50 (diff)
* update documentation
-rw-r--r--NEWS7
-rw-r--r--man/mu.17
-rw-r--r--www/cheatsheet.org25
3 files changed, 29 insertions, 10 deletions
diff --git a/NEWS b/NEWS
index 9831be9..4ad1f8c 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 774ad96..6b81fc0 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 9bcf246..909a8b9 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