emacs
/
mu
mirror of https://github.com/djcb/mu.git
1
0
Fork 0
Code Issues Releases Wiki Activity

mu4e: update documentation

This commit is contained in:
Dirk-Jan C. Binnema 2022-12-31 18:37:56 +02:00
parent ba5026e7dc
commit 7073d2af85
1 changed files with 68 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
mu4e/mu4e.texi
View File

@ -104,8 +104,13 @@ Appendices
* Tips and Tricks:: Useful tips * Tips and Tricks:: Useful tips
* How it works:: Some notes about the implementation of @t{mu4e} * How it works:: Some notes about the implementation of @t{mu4e}
* Debugging:: How to debug problems in @t{mu4e} * Debugging:: How to debug problems in @t{mu4e}
* GNU Free Documentation License:: The license of this manual * GNU Free Documentation License:: The license of this manual
@c Indices
@c * Command Index:: An item for each standard command name.
@c * Variable Index:: An item for each variable documented in this manual.
@c * Concept Index:: An item for concepts and other general subjects.
@end menu @end menu
@node Introduction @node Introduction
@ -381,7 +386,8 @@ following command:
You can add some e-mail addresses, so @t{mu} recognizes them as yours: You can add some e-mail addresses, so @t{mu} recognizes them as yours:
@example @example
$ mu init --maildir=~/Maildir --my-address=jim@@example.com --my-address=bob@@example.com $ mu init --maildir=~/Maildir --my-address=jim@@example.com \
--my-address=bob@@example.com
@end example @end example
@t{mu} remembers the maildir and your addresses and uses them when @t{mu} remembers the maildir and your addresses and uses them when
@ -689,7 +695,7 @@ correctly, and then shows you the @t{mu4e} main view. Its major mode is
@menu @menu
* Overview: MV Overview. What is the main view * Overview: MV Overview. What is the main view
* Basic actions::What can we do * Basic actions::What can we do
* Bookmarks: MV Bookmarks. Jumping to other places * Bookmarks and Maildirs: Bookmarks and Maildirs. Jumping to other places
* Miscellaneous::Notes * Miscellaneous::Notes
@end menu @end menu
@ -710,18 +716,18 @@ The main view looks something like the following:
Bookmarks Bookmarks
* [bu] Unread messages (13085/13085) * [bu] Unread messages (13085/+3/13085)
* [bt] Today's messages * [bt] Today's messages
* [bw] Last 7 days (53/128) * [bw] Last 7 days (53/+3/128)
* [bp] Messages with images (75/2441) * [bp] Messages with images (75/-2/2441)
Maildirs Maildirs
* [ja] /archive (2101/18837) * [ja] /archive (2101/0/18837)
* [ji] /inbox (1/2) * [ji] /inbox (8/+2/10)
* [jb] /bulk (33/35) * [jb] /bulk (33/+0/35)
* [jB] /bulkarchive (179/2090) * [jB] /bulkarchive (179/+0/2090)
* [jm] /mu (694/17687) * [jm] /mu (694/+1/17687)
* [jn] /sauron * [jn] /sauron
* [js] /sent * [js] /sent
@ -729,6 +735,7 @@ The main view looks something like the following:
* [;]Switch context * [;]Switch context
* [U]pdate email & database * [U]pdate email & database
* [R]eset query-results baseline
* toggle [m]ail sending mode (currently direct) * toggle [m]ail sending mode (currently direct)
* [f]lush 1 queued mail * [f]lush 1 queued mail
@ -739,12 +746,12 @@ The main view looks something like the following:
Info Info
* last updated : Sat May 7 20:37:37 2022 * last-updated : Sat Dec 31 16:43:56 2022
* baseline : Sat Dec 31 15:57:12 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@@example.com
@end verbatim @end verbatim
@end cartouche @end cartouche
@ -768,10 +775,10 @@ you for a search query, and after entering one, shows the results in the
the @ref{Editor view} to write a new message. the @ref{Editor view} to write a new message.
@end itemize @end itemize
@node MV Bookmarks @node Bookmarks and Maildirs
@section Bookmarks @section Bookmarks and Maildirs
The next item in the Main view is @emph{Bookmarks}. The next two items in the Main view are @emph{Bookmarks} and @emph{Maildirs}.
Bookmarks are predefined queries with a descriptive name and a Bookmarks are predefined queries with a descriptive name and a
shortcut --- in the example above, we see the default bookmarks. You shortcut --- in the example above, we see the default bookmarks. You
@ -779,8 +786,20 @@ can view the list of messages matching a certain bookmark by pressing
@key{b} followed by the bookmark's shortcut. If you'd like to edit the @key{b} followed by the bookmark's shortcut. If you'd like to edit the
bookmarked query first before invoking it, use @key{B}. bookmarked query first before invoking it, use @key{B}.
Next to each bookmark there is the number of (unread/all) messages Next to each bookmark there is the number of (unread/delta/all) messages that
that match. match.
The ``unread'' and ``all'' have their obvious meaning; the @emph{delta} is the
difference in unread messages since ``baseline'', which is the state at some
point in the past. This delta is useful to quickly see what changed since the
last time you looked.
By default, the baseline is automatically reset when switching to the main view
explicitly; otherwise the baseline can be reset with
@code{mu4e-reset-baseline-query-results}, which is bound to @kbd{R} in the
main-view, and @kbd{C-c C-R} throughout @t{mu4e}. You can customize the behavior
using @var{mu4e-main-hide-baseline-delta} and
@var{mu4e-main-auto-reset-baseline}.
Bookmarks are stored in the variable @code{mu4e-bookmarks}; you can add Bookmarks are stored in the variable @code{mu4e-bookmarks}; you can add
your own and/or replace the default ones; @xref{Bookmarks}. For your own and/or replace the default ones; @xref{Bookmarks}. For
@ -801,6 +820,9 @@ useful if you have bookmarks for slow queries. Note that
the common case where the query function involves some user input, the common case where the query function involves some user input,
which would be disruptive in this case. which would be disruptive in this case.
The Maildirs item is very similar to Bookmarks, when you consider maildirs here
as being special kind of bookmark that matches some Maildir.
@node Miscellaneous @node Miscellaneous
@section Miscellaneous @section Miscellaneous
@ -810,6 +832,8 @@ Finally, there are some @emph{Misc} (miscellaneous) actions:
@code{mu4e-get-mail-command}, and afterwards updates the @t{mu} @code{mu4e-get-mail-command}, and afterwards updates the @t{mu}
database; see @ref{Indexing your messages} and @ref{Getting mail} for database; see @ref{Indexing your messages} and @ref{Getting mail} for
details. details.
@item @t{[R]eset query-results baseline} this reset the current 'baseline'
for query and updates the screen; see @ref{Bookmarks and Maildirs}.
@item @t{toggle [m]ail sending mode (direct)} toggles between sending @item @t{toggle [m]ail sending mode (direct)} toggles between sending
mail directly, and queuing it first (for example, when you are offline), mail directly, and queuing it first (for example, when you are offline),
and @t{[f]lush queued mail} flushes any queued mail. This item is and @t{[f]lush queued mail} flushes any queued mail. This item is
@ -983,7 +1007,9 @@ a execute some custom action on a header
| pipe message through shell command | pipe message through shell command
C-+,C-- increase / decrease the number of headers shown C-+,C-- increase / decrease the number of headers shown
H get help H get help
C-c C-r reset query results baseline
C-S-u update mail & reindex C-S-u update mail & reindex
C-c C-u update mail & reindex
q leave the headers buffer q leave the headers buffer
@end verbatim @end verbatim
@ -1044,11 +1070,10 @@ immediately using the new parameters. You can toggle full-search
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.
If you want to change the defaults for these settings, you can use the If you want to change the defaults for these settings, you can use the variables
variables @code{mu4e-headers-sort-field} and @var{mu4e-search-sort-field} and @var{mu4e-search-show-threads}, as well as
@code{mu4e-headers-show-threads}, as well as @code{mu4e-search-change-sorting} to change the sorting of the current search
@code{mu4e-headers-change-sorting} to change the sorting of the current results.
search results.
@node HV Custom headers @node HV Custom headers
@section Custom headers @section Custom headers
@ -2073,17 +2098,17 @@ also match this extra search pattern. @key{\} takes you back to the previous
query, so, effectively `widens' the search. Technically, narrowing the results query, so, effectively `widens' the search. Technically, narrowing the results
of query @t{x} with expression @t{y} implies doing a search @t{(x) AND (y)}. of query @t{x} with expression @t{y} implies doing a search @t{(x) AND (y)}.
Note that messages that were not in your original search results because Note that messages that were not in your original search results because of
of @code{mu4e-headers-results-limit} may show up in the narrowed query. @var{mu4e-search-results-limit} may show up in the narrowed query.
@subsection Including related messages @subsection Including related messages
@anchor{Including related messages} @anchor{Including related messages}
It can be useful to not only show the messages that directly match a certain It can be useful to not only show the messages that directly match a certain
query, but also include messages that are related to these messages. That is, query, but also include messages that are related to these messages. That is,
messages that belong to the same discussion threads are included in the messages that belong to the same discussion threads are included in the results,
results, just like e.g. Gmail does it. You can enable this behavior by setting just like e.g. Gmail does it. You can enable this behavior by setting
@code{mu4e-headers-include-related} to @code{t}, and you can toggle between @var{mu4e-search-include-related} to @code{t}, and you can toggle between
including/not-including with @key{W}. including/not-including with @key{W}.
Be careful though when e.g. deleting ranges of messages from a certain Be careful though when e.g. deleting ranges of messages from a certain
@ -2097,8 +2122,8 @@ Another useful feature is skipping of @emph{duplicate messages}. When you have
copies of messages, there's usually little value in including more than one in copies of messages, there's usually little value in including more than one in
search results. A common reason for having multiple copies of messages is the search results. A common reason for having multiple copies of messages is the
combination of Gmail and @t{offlineimap}, since that is the way the labels / combination of Gmail and @t{offlineimap}, since that is the way the labels /
virtual folders in Gmail are represented. You can enable skipping duplicates virtual folders in Gmail are represented. You can enable skipping duplicates by
by setting @code{mu4e-headers-skip-duplicates} to @code{t}, and you can toggle setting @var{mu4e-search-skip-duplicates} to @code{t}, and you can toggle
between the skipping/not skipping with @key{V}. between the skipping/not skipping with @key{V}.
Note, messages are considered duplicates when they have the same Note, messages are considered duplicates when they have the same
@ -4634,6 +4659,18 @@ it on all the time. By default, the log only maintains the most recent
@include fdl.texi @include fdl.texi
@c @node Command Index
@c @unnumbered Command and Function Index
@c @printindex fn
@c @node Variable Index
@c @unnumbered Variable Index
@c @printindex vr
@c @node Concept Index
@c @unnumbered Concept Index
@c @printindex cp
@bye @bye
@c Local Variables: @c Local Variables: