alx/mu4e
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

* small doc improvements

Browse Source
This commit is contained in:
djcb
2012-04-30 17:48:07 +03:00
parent fd48ca002c
commit 48a01ae814
2 changed files with 37 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
emacs/mu4e.texi
View File

@ -39,7 +39,7 @@ later. It is built on top of the @t{mu} e-mail search engine, and it focuses
on quickly dealing with large amounts of e-mail. on quickly dealing with large amounts of e-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 the daily use. It also shows how you can customize configuration, and explains its daily use. It also shows how you can customize
@t{mu4e} for your needs. @t{mu4e} for your needs.
At the end of the manual, there are a number of example configurations, which At the end of the manual, there are a number of example configurations, which
@ -95,8 +95,8 @@ and are acted upon.
Under the hood, @t{mu4e} is fully search-based, similar to programs such as Under the hood, @t{mu4e} is fully search-based, similar to programs such as
@t{notmuch}@footnote{@url{http://notmuchmail.org}}, @t{notmuch}@footnote{@url{http://notmuchmail.org}},
@t{md}@footnote{@url{https://github.com/nicferrier/md}} and @t{md}@footnote{@url{https://github.com/nicferrier/md}} and
@t{sup}@footnote{@url{http://sup.rubyforge.org/}}. The user-interface is quite @t{sup}@footnote{@url{http://sup.rubyforge.org/}}. @t{mu4e}'s user-interface
different. is quite different from those programs though.
@t{mu4e}'s mail handling (deleting, moving etc.) is inspired by @t{mu4e}'s mail handling (deleting, moving etc.) is inspired by
@emph{Wanderlust}@footnote{@url{http://www.gohome.org/wl/}} (another @emph{Wanderlust}@footnote{@url{http://www.gohome.org/wl/}} (another
@ -105,26 +105,27 @@ emacs-based e-mail client), @t{mutt}@footnote{@url{http://www.mutt.org/}} and
@t{mu4e} tries to keep all the 'state' in your maildirs, so you can easily @t{mu4e} tries to keep all the 'state' in your maildirs, so you can easily
switch between clients, synchronize over @abbr{IMAP} or backup with @t{rsync} switch between clients, synchronize over @abbr{IMAP} or backup with @t{rsync}
-- if you delete the database, you won't lose any information. -- if you delete the database, you won't lose any information, and there is no
@emph{lock-in}.
@node What mu4e does and does not do @node What mu4e does and does not do
@section What mu4e does and does not do @section What mu4e does and does not do
@t{mu}, and, by extension, @t{mu4e}, do @emph{not} deal with getting your @t{mu} and @t{mu4e} do @emph{not} deal with getting your e-mail messages from
e-mail messages from a mail server. That task is delegated to other tools, a mail server. That task is delegated to other tools, such as
such as @t{offlineimap}@footnote{@url{http://offlineimap.org/}}, @t{offlineimap}@footnote{@url{http://offlineimap.org/}},
@t{isync}@footnote{@url{http://isync.sourceforge.net/}} or @t{isync}@footnote{@url{http://isync.sourceforge.net/}} or
@t{fetchmail}@footnote{@url{http://www.fetchmail.info/}}. As long as the @t{fetchmail}@footnote{@url{http://www.fetchmail.info/}}. As long as the
messages end up in a Maildir, @t{mu4e}/@t{mu} are happy to deal with them. messages end up in a Maildir, @t{mu4e} and @t{mu} are happy to deal with them.
@t{mu4e} also does @emph{not} implement sending of messages; instead, it @t{mu4e} also does @emph{not} implement sending of messages; instead, it
depends on the true-and-tested @emph{smtpmail}, which is part of @t{emacs}. In depends on the tried-and-tested @inforef{Top,smtpmail,smtpmail}, which is part
addition, @t{mu4e} piggybacks on Gnus' message editor; @inforef{Top,Gnus of @t{emacs}. In addition, @t{mu4e} piggybacks on Gnus' message editor;
message editor,message}. @inforef{Top,Gnus message editor,message}.
Thus, many of the traditional things an e-mail client needs to do, are Thus, many of the things an e-mail client traditional needs to do, are
subcontracted to other tools. This leaves @t{mu4e} to concentrate on what it delegated to other tools. This leaves @t{mu4e} to concentrate on what it does
does best: quickly getting you the mails you looking for, and handle them as best: quickly getting you the mails you looking for, and handle them as
efficiently as possible. efficiently as possible.
@ -153,21 +154,22 @@ After these steps, @t{mu4e} should be ready to go.
@t{mu4e} is part of @t{mu} - by installing the latter, the former will @t{mu4e} is part of @t{mu} - by installing the latter, the former will
be installed as well. be installed as well.
At the time of writing, there are no distribution packages for @t{mu4e} At the time of writing, there are no distribution packages for @t{mu4e} yet,
yet, so we are assuming installation from source packages. so we are assuming installation from source packages.
First, you need make sure you have the necessary dependencies. On a Debian or First, you need make sure you have the necessary dependencies. On a Debian or
Ubuntu system, you can get these with: Ubuntu system, you can get these with:
@example @example
sudo apt-get install libgmime-2.4-dev libxapian-dev sudo apt-get install libgmime-2.4-dev libxapian-dev
# emacs if you don't have it yet # emacs if you don't have it yet, mu4e works with GNU-Emacs 23 and 24
sudo apt-get install emacs23 sudo apt-get install emacs23
# optional # optional
sudo apt-get install guile-2.0-dev html2text xdg-utils sudo apt-get install guile-2.0-dev html2text xdg-utils
@end example @end example
Installation follows the normal sequence of: Installation follows the normal sequence of:
@example @example
$ tar xvfz mu-<version>.tar.gz # use the specific version $ tar xvfz mu-<version>.tar.gz # use the specific version
$ cd mu-<version> $ cd mu-<version>
@ -755,10 +757,12 @@ For more information about actions and how to define your own, see
For displaying messages, @t{mu4e} normally prefers the plain-text version for For displaying messages, @t{mu4e} normally prefers the plain-text version for
messages consisting of both a plain-text and an html (rich-text) version of messages consisting of both a plain-text and an html (rich-text) version of
its body-text. If there is only an html-version, or if the plaint-text version its body-text.
is too short in 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 If there is only an html-version, or if the plain-text version is too short in
Emacs built-in @code{html2text} function, but if you set the variable 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
built-in @code{html2text} function, but if you set the variable
@code{mu4e-html2text-command} to some external program, that program will be @code{mu4e-html2text-command} to some external program, that program will be
used. This program is expected to take html from standard input and write used. 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.
@ -771,8 +775,16 @@ set up with something like the following in your initialization files:
(setq mu4e-html2text-command "html2text -utf8 -width 72") (setq mu4e-html2text-command "html2text -utf8 -width 72")
@end lisp @end lisp
Normally, @t{mu4e} prefers the text-version of an e-mail message to determine An alternative to this is to use the Python @t{python-html2text} package;
the message body. You can change this by setting @code{mu4e-view-prefer-html}. after installing that, you can tell @t{mu4e} to use it with something like:
@lisp
(setq mu4e-html2text-command "html2markdown | grep -v '&nbsp_place_holder;'")
@end lisp
As mentioned, by default @t{mu4e} prefers the text-version of an e-mail
message over the html version. You can change this by setting
@code{mu4e-view-prefer-html} to @t{t}.
@node Editor view @node Editor view
@section Editor view @section Editor view

3
www/index.org
View File

@ -36,7 +36,6 @@
of your data, and doing all kinds of statistics of your data, and doing all kinds of statistics
- fully documented (man pages, info pages) - fully documented (man pages, info pages)
#+html:<a href="mu4e-splitview.png" border="0"><img src="mu4e-splitview-small.png" align="right" margin="10px"/></a>
** News ** News
- 2012-04-06: released [[http://code.google.com/p/mu0/downloads/detail?name%3Dmu-0.9.8.3.tar.gz][mu-0.9.8.3]], with many improvements, fixes. See the - 2012-04-06: released [[http://code.google.com/p/mu0/downloads/detail?name%3Dmu-0.9.8.3.tar.gz][mu-0.9.8.3]], with many improvements, fixes. See the
@ -61,6 +60,8 @@
** Development & download ** Development & download
#+html:<a href="mu4e-splitview.png" border="0"><img src="mu4e-splitview-small.png" align="right" margin="10px"/></a>
Some Linux-distributions already provide pre-built mu packages; if there's no Some Linux-distributions already provide pre-built mu packages; if there's no
packagage for your distribution, or if you want the latest release, you can packagage for your distribution, or if you want the latest release, you can
[[http://code.google.com/p/mu0/downloads/list][download mu source packages]] from Google Code. In case you find a bug, or have [[http://code.google.com/p/mu0/downloads/list][download mu source packages]] from Google Code. In case you find a bug, or have