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

* mu4e: documentation updates

This commit is contained in:
djcb 2012-10-03 12:53:24 +03:00
parent f9c9e790a6
commit 85e146063f
1 changed files with 42 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
mu4e/mu4e.texi
View File

@ -80,7 +80,7 @@ the only exception to this is @emph{sending mail}}
This manual goes through the installation of @t{mu4e}, discusses the basic This manual goes through the installation of @t{mu4e}, discusses the basic
configuration, and explains its daily use. It also shows you how you can configuration, and explains its daily use. It also shows you how you can
customize @t{mu4e} for your needs. customize @t{mu4e} for your needs.
At the end of the manual, there are some example configurations, which should At the end of the manual, there are some example configurations, which should
help you to get up to speed quickly. help you to get up to speed quickly.
@ -243,7 +243,7 @@ require you to have @t{autotools} installed:
@example @example
# get from git (alternatively, use a github tarball) # get from git (alternatively, use a github tarball)
$ git clone git://github.com/djcb/mu.git $ git clone git://github.com/djcb/mu.git
$ cd mu $ cd mu
$ autoreconf -i && ./configure && make $ autoreconf -i && ./configure && make
@ -381,7 +381,7 @@ the changes take effect.
A simple setup could look something like: A simple setup could look something like:
@lisp @lisp
(setq (setq
mu4e-get-mail-command "offlineimap" ;; or fetchmail, or ... mu4e-get-mail-command "offlineimap" ;; or fetchmail, or ...
mu4e-update-interval 300) ;; update every 5 minutes mu4e-update-interval 300) ;; update every 5 minutes
@end lisp @end lisp
@ -390,7 +390,7 @@ It is possible to get notifications when the indexing process does any updates
- for example when receiving new mail. See @code{mu4e-index-updated-hook} and - for example when receiving new mail. See @code{mu4e-index-updated-hook} and
the tips on its use in the @ref{FAQ - Frequently Anticipated Questions}. the tips on its use in the @ref{FAQ - Frequently Anticipated Questions}.
Now that we have setup Now that we have setup
The next step is telling @t{mu4e} how we want to send mail. The next step is telling @t{mu4e} how we want to send mail.
@node Sending mail @node Sending mail
@ -448,10 +448,10 @@ And that's it! We should now be ready to go.
@section Running mu4e @section Running mu4e
After following the steps in this chapter, we should now have a working After following the steps in this chapter, we should now have a working
@t{mu4e} setup. Great! @t{mu4e} setup. Great!
In the next chapters, we walk through the various views in @t{mu4e}. In the next chapters, we walk through the various views in @t{mu4e}.
@c @menu @c @menu
@c * Main view:: This is where we start @c * Main view:: This is where we start
@c * Headers view:: Lists of message headers @c * Headers view:: Lists of message headers
@ -969,17 +969,34 @@ For the marking commands, please refer to @ref{Marking messages}.
@node Opening and saving attachments @node Opening and saving attachments
@section Opening and saving attachments @section Opening and saving attachments
By default, when opening attachments, @t{mu4e} uses the the By default, @t{mu4e} uses the @t{xdg-open}-program
@t{xdg-open}-program @footnote{@url{http://portland.freedesktop.org/wiki/}} or @footnote{@url{http://portland.freedesktop.org/wiki/}} or (on MacOS) the
(on MacOS) the @t{open} program. If you want to use another program, you can @t{open} program for opening attachments. If you want to use another program,
specify this by setting the @t{MU_PLAY_PROGRAM} environment variable. you do so by setting the @t{MU_PLAY_PROGRAM} environment variable to the
program to be used.
When extracting (saving) attachments (with @key{e}), the default directory for When extracting (saving) attachments (with @key{e}), the default directory for
saving them is your home directory (@file{~/}); you can change this using the saving them is your home directory (@file{~/}); you can change this using the
variable @code{mu4e-attachment-dir}, for example: variable @code{mu4e-attachment-dir}, for example:
@lisp @lisp
(setq mu4e-attachment-dir (file-name-expand "~/Downloads")) (setq mu4e-attachment-dir "~/Downloads")
@end lisp
For more flexibility, @code{mu4e-attachment-dir} can also be a user-provided
function. This function receives two parameters: the file-name and the
mime-type@footnote{sadly, often @t{application/octet-stream} is used for the
mime-type, even if a better type is available} of the attachment, either or
both of which can be @t{nil}. For example:
@lisp
(setq mu4e-attachment-dir
(lambda (fname mtype)
(cond
;; docfiles go to ~/Desktop
((and fname (string-match "\\.doc$" fname)) "~/Desktop")
;; other cases ...
(t "~/Downloads")))) ;; everything else
@end lisp @end lisp
If you want to extract multiple attachments at once, you can do so by If you want to extract multiple attachments at once, you can do so by
@ -991,13 +1008,13 @@ shortcut for @emph{all} attachments.
@section Viewing images inline @section Viewing images inline
It is possible to show images inline in the message view buffer if you run It is possible to show images inline in the message view buffer if you run
emacs in GUI-mode. You can enable this by setting the variable @t{emacs} in GUI-mode. You can enable this by setting the variable
@code{mu4e-view-show-images} to @t{t}. @code{mu4e-view-show-images} to @t{t}.
Since emacs does not always handle images correctly, this is not enabled by Since @t{emacs} does not always handle images correctly, this is not enabled
default. Note, if you are using a (pre-) release of emacs 24 and build it by default. Note, if you are using @t{emacs} 24 and build it yourself, you
yourself, you probable want to build it with @emph{Imagemagick} support -- in probable want to build it with @emph{Imagemagick} support -- in that case,
that case, also make sure you call @code{imagemagick-register-types} in your also make sure you call @code{imagemagick-register-types} in your
configuration, so it is used for images. configuration, so it is used for images.
@lisp @lisp
@ -1017,22 +1034,22 @@ its body-text.
If there is only an html-version, or if the plain-text version is too short in If there is only an html-version, or if the plain-text version is too short in
comparison with the html part, @t{mu4e} tries to convert the html into comparison with the html part, @t{mu4e} tries to convert the html into
plain-text for display. The default way to do that is to use the Emacs plain-text for display. The default way to do that is to use the @t{emacs}
built-in @code{html2text} function, but if you set the variable built-in @code{html2text} function. However, you can set the variable
@code{mu4e-html2text-command} to some external program, that program is @code{mu4e-html2text-command} to some external program, which is then used
used. This program is expected to take html from standard input and write instead. This program is expected to take html from standard input and write
plain text in @t{utf-8} encoding on standard output. plain text in @t{utf-8} encoding on standard output.
An obvious choice for this is the program that is actually @emph{called} An obvious choice for this is the program that is actually @emph{called}
@t{html2text}@footnote{@url{http://www.mbayer.de/html2text/}}, which you could @t{html2text}@footnote{@url{http://www.mbayer.de/html2text/}}, which you can
set up with something like the following in your initialization files: set up with something like the following in your initialization files:
@lisp @lisp
(setq mu4e-html2text-command "html2text -utf8 -width 72") (setq mu4e-html2text-command "html2text -utf8 -width 72")
@end lisp @end lisp
An alternative to this is to use the Python @t{python-html2text} package; An alternative to this is the Python @t{python-html2text} package; after
after installing that, you can tell @t{mu4e} to use it with something like: installing that, you can tell @t{mu4e} to use it with something like:
@lisp @lisp
(setq mu4e-html2text-command (setq mu4e-html2text-command
@ -1461,7 +1478,7 @@ definition of the default bookmarks is instructive here:
"A list of pre-defined queries; these show up in the main "A list of pre-defined queries; these show up in the main
screen. Each of the list elements is a three-element list of the screen. Each of the list elements is a three-element list of the
form (QUERY DESCRIPTION KEY), where QUERY is a string with a mu form (QUERY DESCRIPTION KEY), where QUERY is a string with a mu
query, DESCRIPTION is a short description of the query (this query, DESCRIPTION is a short description of the query (this
shows up in the UI), and KEY is a shortcut key for the query.") shows up in the UI), and KEY is a shortcut key for the query.")
@end lisp @end lisp
@ -2884,4 +2901,4 @@ Note, @t{mu} itself keeps a log as well, you can find this it in
@include fdl.texi @include fdl.texi
@bye @bye