* some improvements to the mu4e documentation

This commit is contained in:
djcb 2012-04-21 17:47:14 +03:00
parent 565017dac0
commit 3a4d4f80ff
1 changed files with 18 additions and 8 deletions

View File

@ -36,9 +36,10 @@ Welcome to @t{mu4e}!
@t{mu4e} (@emph{mu-for-emacs}) is an e-mail client for GNU Emacs (version 23 @t{mu4e} (@emph{mu-for-emacs}) is an e-mail client for GNU Emacs (version 23
and later). It is built on top of the @t{mu} e-mail search engine. This manual and later). It is built on top of the @t{mu} e-mail search engine. This manual
describes how to set up and use @t{mu4e}. describes how to install and use @t{mu4e}.
This manual has been updated for @t{mu}/@t{mu4e} version @emph{@value{mu4e-version}}. This manual has been updated for @t{mu}/@t{mu4e} version
@emph{@value{mu4e-version}}.
@menu @menu
* Introduction:: * Introduction::
@ -455,7 +456,6 @@ ones. @xref{Bookmarks}. In short, you can view the list of messages matching a
bookmark by pressing @key{b} followed by the shortcut for this bookmark. If bookmark by pressing @key{b} followed by the shortcut for this bookmark. If
you'd like to edit the bookmarked query first, use @key{B}. you'd like to edit the bookmarked query first, use @key{B}.
@subsection Miscellaneous @subsection Miscellaneous
Finally, there are some @emph{Misc} actions: Finally, there are some @emph{Misc} actions:
@ -480,7 +480,6 @@ message.
This looks something like the following: This looks something like the following:
@verbatim @verbatim
---------------------------------------------------------------------------------- ----------------------------------------------------------------------------------
Date Flgs From/To Subject Date Flgs From/To Subject
@ -575,6 +574,11 @@ have marked messages, normally you will be asked what to do with those marks
on the message at point. You can specify these actions using the variable on the message at point. You can specify these actions using the variable
@code{mu4e-headers-actions}. Refer to @ref{Actions} for details. @code{mu4e-headers-actions}. Refer to @ref{Actions} for details.
@t{mu4e} defines some default actions - one is @t{capture} - @key{a c} will
'capture' the current message. Next, when you're editing some message, you can
include the previously captured message as an attachment, using
@code{mu4e-insert-captured-message-as-attachment}.
@subsection Split view @subsection Split view
Using the @emph{Split view} means viewing the @ref{Headers view} and the Using the @emph{Split view} means viewing the @ref{Headers view} and the
@ -1535,6 +1539,10 @@ when viewing a message?} Yes -- see the documentation on
between the two states with @key{w} and @key{h}, respectively. between the two states with @key{w} and @key{h}, respectively.
@item @emph{Is there context-sensitive help available?} Yes - pressing @key{H} @item @emph{Is there context-sensitive help available?} Yes - pressing @key{H}
in most cases should point you to the right spot in this manual. in most cases should point you to the right spot in this manual.
@item @emph{How can I set @t{mu4e} as the default e-mail client in emacs?}
See @ref{Setting the default emacs mail program}.
@item @emph{How can I perform custom actions on messages and attachments?} See
@ref{Actions}.
@end itemize @end itemize
@node Known issues / missing features @node Known issues / missing features
@ -1552,12 +1560,15 @@ you can manipulate a number of consecutive messages at once by selecting
them, and then using one of the manipulation commands, such as them, and then using one of the manipulation commands, such as
@code{mu4e-mark-for-move} or @code{mu4e-mark-for-delete}. @code{mu4e-mark-for-move} or @code{mu4e-mark-for-delete}.
@item @emph{No support for crypto when reading mail}. Currently, you cannot @item @emph{No support for crypto when reading mail}. Currently, you cannot
conveniently read encrypted mail or check signatures (it should be possible conveniently read encrypted mail or check signatures. For outgoing messages,
with e.g. EPA though, @inforef{Top, EasyPG Assistant, epa}.) For outgoing it should work though, using the built-in mechanisms.
messages, it should work though, using the built-in mechanisms.
@item @emph{One cannot influence the sorting of messages}. Messages are sorted @item @emph{One cannot influence the sorting of messages}. Messages are sorted
according to thread, then descending by date. It would be nice if it could be according to thread, then descending by date. It would be nice if it could be
sorted in other ways as well. sorted in other ways as well.
@item @emph{@t{mu4e} gets confused when there are multiple windows showing the
headers.}. Yes -- don't do that.
@item @emph{Messages in the sent-folder do not include the attachments you
sent.} Same for the drafts-folder.
@item @emph{The key-bindings are @emph{somewhat} hard-coded} That is, the main @item @emph{The key-bindings are @emph{somewhat} hard-coded} That is, the main
menu assumes the default key-bindings, as do the clicks-on-bookmarks. menu assumes the default key-bindings, as do the clicks-on-bookmarks.
@item @emph{Attachments are not accessible in draft/sent messages}. Currently, @item @emph{Attachments are not accessible in draft/sent messages}. Currently,
@ -1701,7 +1712,6 @@ using @code{M-x mu4e-show-log}.
@node The message s-expression @node The message s-expression
@section The message s-expression @section The message s-expression
A typical message s-expression could look something like the following: A typical message s-expression could look something like the following:
@lisp @lisp