mu4e: server: improve docstrings

This commit is contained in:
Dirk-Jan C. Binnema
2021-11-10 21:30:54 +02:00
parent 4c0d8572d8
commit 0cbd18e7a5

View File

@ -34,24 +34,28 @@
If not set, use the defaults, based on the XDG Base Directory If not set, use the defaults, based on the XDG Base Directory
Specification. Specification.
Important: any changes to `mu4e-mu-home' only take affect Changes to this value only take effect after (re)starting the mu
after (re)starting the mu session." session."
:group 'mu4e :group 'mu4e
:type '(choice (const :tag "Default location" nil) :type '(choice (const :tag "Default location" nil)
(directory :tag "Specify location")) (directory :tag "Specify location"))
:safe 'stringp) :safe 'stringp)
(defcustom mu4e-mu-binary (executable-find "mu") (defcustom mu4e-mu-binary (executable-find "mu")
"Name of the mu-binary to use. "Path to the mu-binary to use.
If it cannot be found in your PATH, you can specify the full
path." Changes to this value only take effect after (re)starting the mu
session."
:type 'file :type 'file
:group 'mu4e :group 'mu4e
:safe 'stringp) :safe 'stringp)
(defcustom mu4e-mu-debug nil (defcustom mu4e-mu-debug nil
"Whether to run the mu binary in debug-mode. "Whether to run the mu binary in debug-mode.
Setting this to t increases the amount of information in the log." Setting this to t increases the amount of information in the log.
Changes to this value only take effect after (re)starting the mu
session."
:type 'boolean :type 'boolean
:group 'mu4e) :group 'mu4e)
@ -61,10 +65,13 @@ Setting this to t increases the amount of information in the log."
(defcustom mu4e-change-filenames-when-moving nil (defcustom mu4e-change-filenames-when-moving nil
"Change message file names when moving them. "Change message file names when moving them.
When moving messages to different folders, normally mu/mu4e keep When moving messages to different folders, normally mu/mu4e keep
the base filename the same (the flags-part of the filename may the base filename the same (the flags-part of the filename may
change still). With this option set to non-nil, mu4e instead change still). With this option set to non-nil, mu4e instead
changes the filename. This latter behavior works better with some changes the filename.
This latter behavior works better with some
IMAP-synchronization programs such as mbsync; the default works IMAP-synchronization programs such as mbsync; the default works
better with e.g. offlineimap." better with e.g. offlineimap."
:type 'boolean :type 'boolean