mirror of https://github.com/djcb/mu.git
Merge pull request #86 from tarsius/cleanup
* fix defcustom types and improve their doc-strings
This commit is contained in:
commit
b92d826808
|
@ -67,9 +67,7 @@ test-mu-util
|
|||
mu4e-meta.el
|
||||
mu4e.pdf
|
||||
texinfo.tex
|
||||
/emacs/mdate-sh
|
||||
/emacs/stamp-vti
|
||||
/emacs/version.texi
|
||||
texi.texi
|
||||
*.tex
|
||||
*.pdf
|
||||
/www/auto/*
|
||||
|
@ -80,3 +78,4 @@ configure.lineno
|
|||
/mu4e/stamp-vti
|
||||
/mu4e/version.texi
|
||||
/guile/tests/test-mu-guile
|
||||
/lib/doxyfile
|
||||
|
|
|
@ -90,17 +90,19 @@
|
|||
:group 'mu4e)
|
||||
|
||||
(defcustom mu4e-sent-messages-behavior 'sent
|
||||
"Determines what mu4e does with sent messages - this is a symbol
|
||||
which can be either:
|
||||
"Determines what mu4e does with sent messages.
|
||||
|
||||
* 'sent --> move the sent message to the Sent-folder (`mu4e-sent-folder')
|
||||
* 'trash --> move the sent message to the Trash-folder (`mu4e-trash-folder')
|
||||
* 'delete --> delete the sent message.
|
||||
This is one of the symbols:
|
||||
* `sent' move the sent message to the Sent-folder (`mu4e-sent-folder')
|
||||
* `trash' move the sent message to the Trash-folder (`mu4e-trash-folder')
|
||||
* `delete' delete the sent message.
|
||||
|
||||
Note, when using GMail/IMAP, you should set this to either 'trash
|
||||
or 'delete, since GMail already takes care of keeping copies in the
|
||||
sent folder."
|
||||
:type 'symbol
|
||||
:type '(choice (const sent :tag "move message to mu4e-sent-folder")
|
||||
(const sent :tag "move message to mu4e-trash-folder")
|
||||
(const sent :tag "delete message"))
|
||||
:safe 'symbolp
|
||||
:group 'mu4e-compose)
|
||||
|
||||
|
|
|
@ -51,12 +51,19 @@
|
|||
(:flags . 6)
|
||||
(:from . 22)
|
||||
(:subject . nil))
|
||||
"A list of header fields to show in the headers buffer, and their
|
||||
respective widths in characters. A width of `nil' means
|
||||
'unrestricted', and this is best reserved fo the rightmost (last)
|
||||
field. For the complete list of available headers, see
|
||||
`mu4e-header-info'."
|
||||
:type (list 'symbol)
|
||||
"A list of header fields to show in the headers buffer.
|
||||
Each element has the form (HEADER . WIDTH), where HEADER is one
|
||||
of the available headers (see `mu4e-header-info') and WIDTH is
|
||||
the respective width in characters. A width of `nil' means
|
||||
'unrestricted', and this is best reserved for the
|
||||
rightmost (last) field."
|
||||
:type `(repeat (cons (choice ,@(mapcar (lambda (h)
|
||||
(list 'const :tag
|
||||
(plist-get (cdr h) :help)
|
||||
(car h)))
|
||||
mu4e-header-info))
|
||||
(choice (integer :tag "width")
|
||||
(const :tag "unrestricted width" nil))))
|
||||
:group 'mu4e-headers)
|
||||
|
||||
(defcustom mu4e-headers-date-format "%x"
|
||||
|
|
|
@ -31,13 +31,15 @@
|
|||
(require 'mu4e-message)
|
||||
|
||||
(defcustom mu4e-headers-leave-behavior 'ask
|
||||
"What to do when user leaves the headers view (e.g. quits,
|
||||
refreshes or does a new search). Value is one of the following
|
||||
symbols:
|
||||
- ask (ask the user whether to ignore the marks)
|
||||
- apply (automatically apply the marks before doing anything else)
|
||||
- ignore (automatically ignore the marks without asking)."
|
||||
:type 'symbol
|
||||
"What to do when user leaves the headers view.
|
||||
That is when he e.g. quits, refreshes or does a new search.
|
||||
Value is one of the following symbols:
|
||||
- `ask' ask user whether to ignore the marks
|
||||
- `apply' automatically apply the marks before doing anything else
|
||||
- `ignore' automatically ignore the marks without asking"
|
||||
:type '(choice (const ask :tag "ask user whether to ignore marks")
|
||||
(const apply :tag "apply marks without asking")
|
||||
(const ignore :tag "ignore marks without asking"))
|
||||
:group 'mu4e-headers)
|
||||
|
||||
(defvar mu4e-headers-show-target t
|
||||
|
|
|
@ -35,10 +35,9 @@
|
|||
|
||||
(defcustom mu4e-mu-home nil
|
||||
"Location of the mu homedir, or nil for the default."
|
||||
:type 'directory
|
||||
:group 'mu4e
|
||||
:type '(choice (const :tag "Default location" nil)
|
||||
(const :tag "Specify location" string))
|
||||
(directory :tag "Specify location"))
|
||||
:safe 'stringp)
|
||||
|
||||
(defcustom mu4e-mu-binary (executable-find "mu")
|
||||
|
@ -49,15 +48,14 @@ PATH, you can specify the full path."
|
|||
:safe 'stringp)
|
||||
|
||||
(defcustom mu4e-maildir (expand-file-name "~/Maildir")
|
||||
"Your Maildir directory; by default, mu4e assumes
|
||||
~/Maildir."
|
||||
"Your Maildir directory."
|
||||
:type 'directory
|
||||
:safe 'stringp
|
||||
:group 'mu4e)
|
||||
|
||||
(defcustom mu4e-get-mail-command "true"
|
||||
"Shell command to run to retrieve new mail; e.g. 'offlineimap' or
|
||||
'fetchmail'."
|
||||
"Shell command to run to retrieve new mail.
|
||||
Common values are \"offlineimap\" and \"fetchmail\"."
|
||||
:type 'string
|
||||
:group 'mu4e
|
||||
:safe 'stringp)
|
||||
|
@ -107,10 +105,11 @@ personal message. This is used when indexing messages."
|
|||
:group 'mu4e)
|
||||
|
||||
(defcustom mu4e-search-results-limit 500
|
||||
"Maximum number of search results (or -1 for unlimited). Since
|
||||
limiting search results speeds up searches significantly, it's
|
||||
useful to limit this. Note, to ignore the limit, use a prefix
|
||||
argument (C-u) before invoking the search."
|
||||
"Maximum number of search results.
|
||||
Use -1 for no limit. Since limiting search results speeds up
|
||||
searches significantly, it's useful to limit this. Note, to
|
||||
ignore the limit, use a prefix argument (C-u) before invoking the
|
||||
search."
|
||||
:type '(choice (const :tag "Unlimited" -1)
|
||||
(integer :tag "Limit"))
|
||||
:group 'mu4e)
|
||||
|
@ -501,8 +500,7 @@ headers)."
|
|||
(:from-or-to .
|
||||
( :name "From/To"
|
||||
:shortname "From/To"
|
||||
:help "Sender of the message if it's not me; otherwise
|
||||
the recipient"
|
||||
:help "Sender of the message if it's not me; otherwise the recipient"
|
||||
:sortable nil))
|
||||
(:maildir .
|
||||
( :name "Maildir"
|
||||
|
@ -539,13 +537,14 @@ headers)."
|
|||
:shortname "T"
|
||||
:help "Recipient of the message"
|
||||
:sortable t)))
|
||||
"An alist of all possible header fields and information about
|
||||
them.; this is used in the UI (the column headers in the header
|
||||
list, and the fields the message view). Most fields should be
|
||||
self-explanatory. A special one is `:from-or-to', which is equal to
|
||||
`:from' unless `:from' matches `mu4e-user-mail-address-regexp', in
|
||||
which case it will be equal to `:to'.")
|
||||
"An alist of all possible header fields and information about them.
|
||||
This is used in the UI (the column headers in the header list,
|
||||
and the fields the message view).
|
||||
|
||||
Most fields should be self-explanatory. A special one is
|
||||
`:from-or-to', which is equal to `:from' unless `:from' matches
|
||||
`mu4e-user-mail-address-regexp', in which case it will be equal
|
||||
to `:to'.")
|
||||
|
||||
(defvar mu4e-custom-header-info nil
|
||||
"A list like `mu4e-custom-header-info', but for
|
||||
|
|
|
@ -51,8 +51,8 @@
|
|||
|
||||
(defcustom mu4e-view-fields
|
||||
'(:from :to :cc :subject :flags :date :maildir :tags :attachments :signature)
|
||||
"Header fields to display in the message view buffer. For the
|
||||
complete list of available headers, see `mu4e-header-info'."
|
||||
"Header fields to display in the message view buffer.
|
||||
For the complete list of available headers, see `mu4e-header-info'."
|
||||
:type (list 'symbol)
|
||||
:group 'mu4e-view)
|
||||
|
||||
|
@ -69,14 +69,14 @@ contact."
|
|||
|
||||
(defcustom mu4e-view-date-format "%c"
|
||||
"Date format to use in the message view, in the format of
|
||||
`format-time-string'."
|
||||
`format-time-string'."
|
||||
:type 'string
|
||||
:group 'mu4e-view)
|
||||
|
||||
(defcustom mu4e-view-image-max-width 800
|
||||
"The maximum width for images to display; this is only effective
|
||||
if you're using an emacs with Imagemagick support, and
|
||||
`mu4e-show-image' is non-nil."
|
||||
"The maximum width for images to display.
|
||||
This is only effective if you're using an emacs with Imagemagick
|
||||
support, and `mu4e-show-image' is non-nil."
|
||||
:group 'mu4e-view)
|
||||
|
||||
(defcustom mu4e-view-scroll-to-next t
|
||||
|
|
Loading…
Reference in New Issue