* mu4e: update documentation

mu4e/mu4e-vars.el

@@ -49,14 +49,21 @@ path."
   :safe 'stringp)
 
 (defcustom mu4e-maildir (expand-file-name "~/Maildir")
-  "Your Maildir directory."
+  "The file system path to your Maildir."
   :type 'directory
   :safe 'stringp
   :group 'mu4e)
 
 (defcustom mu4e-get-mail-command "true"
   "Shell command to run to retrieve new mail.
-Common values are \"offlineimap\" and \"fetchmail\"."
+Common values are \"offlineimap\" and \"fetchmail\", but you use
+arbitrary shell-commands.
+
+If you set it to \"true\" (the default), the command won't don't
+anything, which is useful if you get your mail without the need to
+explicitly run any scripts, for example when running yout own
+mail-server.
+"
   :type 'string
   :group 'mu4e
   :safe 'stringp)
@@ -86,9 +93,10 @@ better with e.g. offlineimap."
 
 (defcustom mu4e-attachment-dir (expand-file-name "~/")
   "Default directory for saving attachments.
-This can be either a string, or a function that takes a filename
-FNAME and MIMETYPE as arguments, and returns the attachment
-dir. Note, either or both of the arguments may be `nil'."
+This can be either a string (a file system path), or a function
+that takes a filename and the mime-type as arguments, and returns
+the attachment dir. See Info node `(mu4e) Opening and saving
+attachments' for details."
   :type 'directory
   :group 'mu4e
   :safe 'stringp)
@@ -301,17 +309,19 @@ re-edited, and is nil otherwise."
 
 
 (defcustom mu4e-maildir-shortcuts nil
-  "A list of maildir shortcuts.
-This enables quickly going to the particular maildir (folder), or
-quickly moving messages to them (i.e., archiving or refiling). The
-list contains elements of the form (maildir . shortcut), where
-MAILDIR is a maildir (such as \"/archive/\"), and shortcut a single
-shortcut character. With this, in the header buffer and view buffer
-you can execute `mu4e-mark-for-move-quick' (or 'm', by default) or
+  "A list of maildir shortcuts. This makes it possible to quickly
+go to a particular maildir (folder), or quickly moving messages to
+them (e.g., for archiving or refiling). The list contains elements
+of the form (maildir . shortcut), where MAILDIR is a maildir (such
+as \"/archive/\"), and shortcut is a single character.
+
+You can use these shortcuts in the headers and view buffers, for
+example with `mu4e-mark-for-move-quick' (or 'm', by default) or
 `mu4e-jump-to-maildir' (or 'j', by default), followed by the
-designated shortcut character for the maildir. Unlike in search
-queries, folder names with spaces in them must NOT be quoted, since
-mu4e does this automatically for you."
+designated shortcut character for the maildir.
+
+Unlike in search queries, folder names with spaces in them must NOT
+be quoted, since mu4e does this automatically for you."
   :type '(repeat (cons (string :tag "Maildir") character))
   :group 'mu4e-folders)
 
@@ -577,23 +587,9 @@ Furthermore, the property `:sortable' determines whether we can
 sort by this field.  This can be either a boolean (nil or t), or a
 symbol for /another/ field. For example, the `:human-date' field
 uses `:date' for that.
-")
 
-(defvar mu4e-custom-header-info nil
-  "A list like `mu4e-custom-header-info', but for custom headers.
-I.e. user-specified headers. Each of the list items is a property
-list with :name (the full-name, as displayed in the message
-view), :shortname (the name as displayed in the headers
-view), :help (some help information, which shows up in the
-tooltip). Furthermore, there are two special fields:
-:headers-func and :message-func, and the values should be functions
-that take a MSG property list as argument, and return a string as
-result.
-Note, :sortable does not work for custom header fields.")
-
-
-
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+Note, `:sortable' does not work for custom header fields.")
+ ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
@@ -619,8 +615,12 @@ Note, :sortable does not work for custom header fields.")
 
 (defvar mu4e~contacts-for-completion nil
   "List of contacts (ie. 'name <e-mail>').
-This is used by the completion functions in mu4e-compose, and
-filled when mu4e starts.")
+This is used by the completion functions in mu4e-compose, filled
+when mu4e starts.")
+
+(defvar mu4e~contact-list nil
+  "List of contacts, where each contact is a plist
+  (:name NAME :mail EMAIL :tstamp TIMESTAMP :freq FREQUENCY).")
 
 (defvar mu4e~server-props nil
   "Properties we receive from the mu4e server process.

mu4e/mu4e.texi

@@ -63,12 +63,12 @@ Some of @t{mu4e}'s highlights:
 
 @itemize
 @item Fully search-based: there are no folders@footnote{that is, instead of
-folders, you can use queries that match all messages in a folder}, only
+folders, you use queries that match messages in a particular folder}, only
 queries
 @item Fully documented, with example configurations
 @item User-interface optimized for speed, with quick key strokes for common actions
 @item Support for non-English languages (so ``angstrom'' will match ``Angström'')
-@item Asynchronous; heavy actions don't block @command{emacs}@footnote{currently,
+@item Asynchronous: heavy actions don't block @command{emacs}@footnote{currently,
 the only exception to this is @emph{sending mail}; there are solutions for
 that though - see the @ref{FAQ}}
 @item Support for crypto
@@ -514,12 +514,12 @@ for example, when using Gmail-over-@abbr{IMAP}, this interferes with Gmail's
 handling of the sent messages folder, and you may end up with duplicate
 messages.
 
-You can use the the variable @code{mu4e-sent-messages-behavior} to customize
-what happens with sent messages. The default is the symbol @code{sent} which,
-as mentioned, causes the message to be copied to your sent-messages
-folder. Other possible values are the symbols @code{trash} (the sent message
-is moved to the trash-folder (@code{mu4e-trash-folder}), and @code{delete} to
-simply discard the sent message altogether (so GMail can deal with it).
+You can use the variable @code{mu4e-sent-messages-behavior} to customize what
+happens with sent messages. The default is the symbol @code{sent} which, as
+mentioned, causes the message to be copied to your sent-messages folder. Other
+possible values are the symbols @code{trash} (the sent message is moved to the
+trash-folder (@code{mu4e-trash-folder}), and @code{delete} to simply discard
+the sent message altogether (so GMail can deal with it).
 
 For Gmail-over-@abbr{IMAP}, you could add the following to your settings:
 @verbatim
@@ -579,9 +579,9 @@ correctly, and then shows you the @t{mu4e} main view. Its major mode is
 @code{mu4e-main-mode}.
 
 @menu
-* MV Overview::
+* Overview:MV Overview.
 * Basic actions::
-* MV Bookmarks::
+* Bookmarks:MV Bookmarks.
 * Miscellaneous::
 @end menu
 
@@ -682,11 +682,11 @@ if you have actually set up mail-queuing. @ref{Queuing mail}
 
 The headers view shows the results of a query. The topline shows the names of
 the fields. Below that, there is a line with those fields, for each matching
-message, followed by a footer line. The major-mode for the the headers view is
+message, followed by a footer line. The major-mode for the headers view is
 @code{mu4e-headers-mode}.
 
 @menu
-* HV Overview::
+* Overview:HV Overview.
 * Keybindings::
 * Marking messages::
 * Sort order and threading::
@@ -927,13 +927,13 @@ view window: the message headers, followed by the message body. Its major
 mode is @code{mu4e-view-mode}.
 
 @menu
-* MSGV Overview::
-* MSGV Keybindings::
+* Overview:MSGV Overview.
+* Keybindings:MSGV Keybindings.
 * Opening and saving attachments::
 * Viewing images inline::
 * Displaying rich-text messages::
-* MSGV Crypto::
-* MSGV Actions::
+* Crypto:MSGV Crypto.
+* Actions:MSGV Actions.
 @end menu
 
 @node MSGV Overview
@@ -1591,13 +1591,12 @@ or, unless you have a really old Xapian
 date:2w.. emacs
 @end verbatim
 
-@item Get messages from the the @emph{Mu} mailing list:
+@item Get messages from the @emph{Mu} mailing list:
 @verbatim
 list:mu-discuss.googlegroups.com
 @end verbatim
 
-@item Get messages with a subject soccer, Socrates, society, ...; note that the '*'
-wildcard can only appear as the term's rightmost character:
+@item Get messages with a subject soccer, Socrates, society, ...; note that the '*'-wildcard can only appear as a term's rightmost character:
 @verbatim
 subject:soc*
 @end verbatim
@@ -2937,7 +2936,7 @@ instead -- see
 @section Reading messages
 
 @enumerate
-@item @emph{How can I show attached images in my message view buffers?} See
+@item @emph{How can I view attached images in my message view buffers?} See
 @ref{Viewing images inline}.
 @item @emph{How can I word-wrap long lines in when viewing a
 message?} You can toggle between wrapped and non-wrapped states using
@@ -3491,7 +3490,7 @@ MIME-type, if any) and @t{:size} (the size in bytes, if any).
 
 As an example of the communication between @t{mu4e} and @command{mu}, let's
 look at the @t{ping-pong}-sequence. When @t{mu4e} starts, it sends a command
-@t{ping} to the the @t{mu server} backend, to learn about its version. @t{mu
+@t{ping} to the @t{mu server} backend, to learn about its version. @t{mu
 server} then responds with a @t{pong} s-expression to provide this information
 (this is implemented in @file{mu-cmd-server.c}).