mu4e.texi: update documentation

Use the new toggles.
This commit is contained in:
Dirk-Jan C. Binnema
2022-12-11 15:25:11 +02:00
parent 87fb2787be
commit a4698db84e

View File

@ -706,46 +706,46 @@ The main view looks something like the following:
Basics Basics
* [j]ump to some maildir * [j]ump to some maildir
* enter a [s]earch query * enter a [s]earch query
* [C]ompose a new message * [C]ompose a new message
Bookmarks Bookmarks
* [bu] Unread messages (13085/13085) * [bu] Unread messages (13085/13085)
* [bt] Today's messages * [bt] Today's messages
* [bw] Last 7 days (53/128) * [bw] Last 7 days (53/128)
* [bp] Messages with images (75/2441) * [bp] Messages with images (75/2441)
Maildirs Maildirs
* [ja] /archive (2101/18837) * [ja] /archive (2101/18837)
* [ji] /inbox (1/2) * [ji] /inbox (1/2)
* [jb] /bulk (33/35) * [jb] /bulk (33/35)
* [jB] /bulkarchive (179/2090) * [jB] /bulkarchive (179/2090)
* [jm] /mu (694/17687) * [jm] /mu (694/17687)
* [jn] /sauron * [jn] /sauron
* [js] /sent * [js] /sent
Misc Misc
* [;]Switch context * [;]Switch context
* [U]pdate email & database * [U]pdate email & database
* toggle [m]ail sending mode (currently direct) * toggle [m]ail sending mode (currently direct)
* [f]lush 1 queued mail * [f]lush 1 queued mail
* [N]ews * [N]ews
* [A]bout mu4e * [A]bout mu4e
* [H]elp * [H]elp
* [q]uit * [q]uit
Info Info
* last updated : Sat May 7 20:37:37 2022 * last updated : Sat May 7 20:37:37 2022
* database-path : /home/pam/.cache/mu/xapian * database-path : /home/pam/.cache/mu/xapian
* maildir : /home/pam/Maildir * maildir : /home/pam/Maildir
* in store : 86179 messages * in store : 86179 messages
* personal addresses : /.*example.com/, pam@fo * personal addresses : /.*example.com/, pam@fo
@end verbatim @end verbatim
@end cartouche @end cartouche
@ -950,10 +950,7 @@ M-left,\ previous query
M-right next query M-right next query
O change sort order O change sort order
P toggle threading P toggle search property
Q toggle full-search
V toggle skip-duplicates
W toggle include-related
marking marking
------- -------
@ -1037,14 +1034,14 @@ The header field used for sorting is indicated by ``@t{V}'' or
variable @code{mu4e-use-fancy-chars}}, indicating the sort order variable @code{mu4e-use-fancy-chars}}, indicating the sort order
(descending or ascending, respectively). (descending or ascending, respectively).
You can change the sort order by clicking the corresponding column with You can change the sort order by clicking the corresponding column with the
the mouse, or with @kbd{M-x mu4e-headers-change-sorting} (@key{O}); note mouse, or with @kbd{M-x mu4e-headers-change-sorting} (@key{O}); note that not
that not all fields can be used for sorting. You can toggle threading all fields can be used for sorting. You can toggle threading on/off through
on/off using @kbd{M-x mu4e-headers-toggle-threading} or @key{P}. For @kbd{M-x mu4e-headers-toggle-property} or @key{Pt}. For both of these functions,
both of these functions, unless you provide a prefix argument unless you provide a prefix argument (@key{C-u}), the current search is updated
(@key{C-u}), the current search is updated immediately using the new immediately using the new parameters. You can toggle full-search
parameters. You can toggle full-search (@ref{Searching}) using @kbd{M-x (@ref{Searching}) through @kbd{M-x mu4e-headers-toggle-property} as well; or
mu4e-headers-toggle-full-search} or @key{Q}. @key{Pf}.
Note that with threading enabled, the sorting is exclusively by date, Note that with threading enabled, the sorting is exclusively by date,
regardless of the column clicked. regardless of the column clicked.
@ -1274,6 +1271,9 @@ b search bookmark
B edit bookmark before search B edit bookmark before search
j jump to maildir j jump to maildir
O change sort order
P toggle search property
M-left previous query M-left previous query
M-right next query M-right next query
@ -1728,12 +1728,11 @@ order for this to work properly you need to pass your address to
executing a query for messages that happen to have the property of being in a executing a query for messages that happen to have the property of being in a
certain folder (maildir). certain folder (maildir).
Normally, queries return up to @code{mu4e-headers-results-limit} (default: Normally, queries return up to @code{mu4e-headers-results-limit} (default: 500)
500) results. That is usually more than enough, and makes things significantly results. That is usually more than enough, and makes things significantly
faster. Sometimes, however, you may want to show @emph{all} results; you can faster. Sometimes, however, you may want to show @emph{all} results; you can
enable this with @kbd{M-x mu4e-headers-toggle-full-search}, or by customizing enable this with @kbd{M-x mu4e-headers-toggle-property}, or by customizing the
the variable @code{mu4e-headers-full-search}. This applies to all search variable @code{mu4e-headers-full-search}. This applies to all search commands.
commands.
You can also influence the sort order and whether threads are shown or not; You can also influence the sort order and whether threads are shown or not;
see @ref{Sorting and threading}. see @ref{Sorting and threading}.
@ -3798,10 +3797,12 @@ completion.
Set @code{mu4e-cache-maildir-list} to @code{t} (make sure to read Set @code{mu4e-cache-maildir-list} to @code{t} (make sure to read
its docstring). its docstring).
@subsection How can I hide messages from the search results? @subsection How can I hide certain messages from the search results?
See the variable @code{mu4e-headers-hide-predicate}. See the variables @code{mu4e-headers-hide-predicate} and
@code{mu4e-headers-hide-enabled}. The latter can be toggled through
@code{mu4e-headers-toggle-property}.
For example, to filter out GMail's spam, set it to: For example, to filter out GMail's spam folder, set it to:
@lisp @lisp
(setq mu4e-headers-hide-predicate (setq mu4e-headers-hide-predicate
(lambda (msg) (lambda (msg)