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

* mu4e.texi: some updates to the docs

Browse Source
This commit is contained in:
djcb
2013-08-24 11:17:00 +03:00
parent 6a098c7be3
commit 2446b4d4a3
1 changed files with 34 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
mu4e/mu4e.texi
View File

@ -327,8 +327,8 @@ in @command{emacs}.
You may need to restart @command{emacs}, so it can find @t{mu4e} in its You may need to restart @command{emacs}, so it can find @t{mu4e} in its
@code{load-path}. If, even after restarting, @command{emacs} cannot find @code{load-path}. If, even after restarting, @command{emacs} cannot find
@t{mu4e}, you may need to add to your @code{load-path} explicitly; check where @t{mu4e}, you may need to add it to your @code{load-path} explicitly; check
@t{mu4e} is installed, and add something like the following to your where @t{mu4e} is installed, and add something like the following to your
configuration before trying again: configuration before trying again:
@lisp @lisp
;; the exact path may differ -- check it ;; the exact path may differ -- check it
@ -370,12 +370,12 @@ should be able to provide you with the details.
@section Indexing your messages @section Indexing your messages
After you have succeeded in @ref{Getting mail}, we need to @emph{index} the After you have succeeded in @ref{Getting mail}, we need to @emph{index} the
messages. That is - we need to scan the message in the maildir and store the messages. That is - we need to scan the messages in the maildir and store the
information about the mails into a special database. We can do that from information about them in a special database. We can do that from @t{mu4e} --
@t{mu4e} -- @ref{Main view}, but the first time, it is a good idea to run @ref{Main view}, but the first time, it is a good idea to run it from the
it from the command line, to make sure everything works correctly. command line, which makes it easier to verify that everything works correctly.
Assuming that your maildir is at @file{~/Maildir}, we give the following Assuming that your maildir is at @file{~/Maildir}, we issue the following
command: command:
@example @example
$ mu index --maildir=~/Maildir $ mu index --maildir=~/Maildir
@ -389,7 +389,7 @@ information while doing so.
The indexing process may take a few minutes the first time you do it (for The indexing process may take a few minutes the first time you do it (for
thousands of e-mails); afterwards it is much faster, since @t{mu} only scans thousands of e-mails); afterwards it is much faster, since @t{mu} only scans
messages that are new or have changed. Indexing is discussed in full detail in messages that are new or have changed. Indexing is discussed in full detail in
the @t{mu-index} man page. the @t{mu-index} man-page.
After the indexing process has finished, you can quickly test if everything After the indexing process has finished, you can quickly test if everything
worked, by trying some command-line searches, for example worked, by trying some command-line searches, for example
@ -397,10 +397,10 @@ worked, by trying some command-line searches, for example
$ mu find hello $ mu find hello
@end example @end example
which should list all messages that match @t{hello}. For more examples of which lists all messages that match @t{hello}. For more examples of searches,
searches, see @ref{Queries}, or check the @t{mu-find} and @t{mu-easy} man see @ref{Queries}, or check the @t{mu-find} and @t{mu-easy} man pages. If all
pages. If all of this worked well, we are well on our way setting up @t{mu}; of this worked well, we are well on our way setting things up; the next step
the next step is to do some basic configuration for @t{mu4e}. is to do some basic configuration for @t{mu4e}.
@node Basic configuration @node Basic configuration
@section Basic configuration @section Basic configuration
@ -423,7 +423,6 @@ of it. If not, you can add it:
with @t{MU4E-PATH} replaced with the actual path. with @t{MU4E-PATH} replaced with the actual path.
@node Folders @node Folders
@section Folders @section Folders
@ -443,8 +442,8 @@ runtime. This allows for dynamically changing them depending on context. See
mu4e-refile-folder "/archive") ;; saved messages mu4e-refile-folder "/archive") ;; saved messages
@end lisp @end lisp
@code{mu4e-maildir} takes an actual filesystem-path, the other folder names Note, @code{mu4e-maildir} takes an actual filesystem-path, the other folder
are all relative to @code{mu4e-maildir}. names are all relative to @code{mu4e-maildir}.
@node Retrieval and indexing @node Retrieval and indexing
@section Retrieval and indexing @section Retrieval and indexing
@ -832,11 +831,11 @@ q,z leave the headers buffer
@node Marking messages @node Marking messages
@section Marking messages @section Marking messages
When processing messages, the first step is to @emph{mark} them for a certain You can @emph{mark} messages for a certain action, such as deletion or
action, such as deletion or move. Then, after one or more messages are marked, move. After one or more messages are marked, you can then execute
you execute (@code{mu4e-mark-execute-all}, @key{x}) these actions. This (@code{mu4e-mark-execute-all}, @key{x}) these actions. This two-step
two-step mark-execute sequence is similar to what e.g. @t{dired} does. This is mark-execute sequence is similar to what e.g. @t{dired} does. It is how
how @t{mu4e} tries to be as quick as possible, while avoiding accidents. @t{mu4e} tries to be as quick as possible, while avoiding accidents.
The mark/unmark commands support the @emph{region} (i.e., ``selection'') -- The mark/unmark commands support the @emph{region} (i.e., ``selection'') --
so, for example, if you select some messages and press @key{DEL}, all messages so, for example, if you select some messages and press @key{DEL}, all messages
@ -923,8 +922,8 @@ headers-view to the message-view and vice-versa with
@chapter The message view @chapter The message view
After selecting a message in the @ref{Headers view}, it appears in a message After selecting a message in the @ref{Headers view}, it appears in a message
view window: the message headers, followed by the message body. Its major view window, which shows the message headers, followed by the message
mode is @code{mu4e-view-mode}. body. Its major mode is @code{mu4e-view-mode}.
@menu @menu
* Overview:MSGV Overview. * Overview:MSGV Overview.
@ -1091,9 +1090,10 @@ directory (@file{~/}); you can change this using the variable
For more flexibility, @code{mu4e-attachment-dir} can also be a user-provided For more flexibility, @code{mu4e-attachment-dir} can also be a user-provided
function. This function receives two parameters: the file-name and the 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 as found in the e-mail message@footnote{sadly, often
mime-type, even if a better type is available} of the attachment, either or @t{application/octet-stream} is used for the mime-type, even if a better type
both of which can be @t{nil}. For example: is available} of the attachment, either or both of which can be @t{nil}. For
example:
@lisp @lisp
(setq mu4e-attachment-dir (setq mu4e-attachment-dir
@ -1438,7 +1438,7 @@ mml-secure-message-encrypt-pgp}, @kbd{M-x mml-secure-message-sign-pgp}.
The support for encryption and signing is @emph{independent} of the support The support for encryption and signing is @emph{independent} of the support
for their counterparts, decrypting and signature verification (as discussed in for their counterparts, decrypting and signature verification (as discussed in
@ref{MSGV Crypto}). Even if your @t{mu4e} does have support for the latter @ref{MSGV Crypto}). Even if your @t{mu4e} does not have support for the latter
two, you can still sign/encrypt messages. two, you can still sign/encrypt messages.
Currently, decryption and signature verification only works for PGP/MIME; Currently, decryption and signature verification only works for PGP/MIME;
@ -1471,8 +1471,8 @@ $ touch ~/Maildir/queue/.noindex
The file created by the @command{touch} command tells @t{mu} to ignore this The file created by the @command{touch} command tells @t{mu} to ignore this
directory for indexing, which makes sense since it contains @t{smtpmail} directory for indexing, which makes sense since it contains @t{smtpmail}
meta-data rather than 'normal' messages; see the @t{mu-mkdir} and @t{mu-index} meta-data rather than normal messages; see the @t{mu-mkdir} and @t{mu-index}
man pages for details. man-pages for details.
@emph{Warning}: when you switch on queued-mode, your messages @emph{won't} @emph{Warning}: when you switch on queued-mode, your messages @emph{won't}
reach their destination until you switch it off again; so, be careful not to reach their destination until you switch it off again; so, be careful not to
@ -3283,12 +3283,12 @@ another variable:
@node Saving outgoing messages @node Saving outgoing messages
@section Saving outgoing messages @section Saving outgoing messages
Like @code{mu4e-refile-folder}, the variable @code{mu4e-sent-folder} can Like @code{mu4e-refile-folder}, the variable @code{mu4e-sent-folder} can also
also be set to a function, in order to dynamically determine the save be set to a function, in order to dynamically determine the save folder. One
folder. One might, for example, wish to automatically put messages going might, for example, wish to automatically put messages going to mailing lists
to mailing lists into the trash (because you'll receive them back from into the trash (because you'll receive them back from the list anyway). If you
the list). If you have set up the variable @code{my-mu4e-mailing-lists} have set up the variable @code{my-mu4e-mailing-lists} as mentioned, you can
as above, you can use the following function to determine a save folder: use the following function to determine a save folder:
@lisp @lisp
(defun my-mu4e-sent-folder-function (msg) (defun my-mu4e-sent-folder-function (msg)