mu4e: update docs for mu4e-get-mail-command

There seems to be some confusion making people setting it to `t` rather
than the literal string "true". Make it even clearer in the doc.
This commit is contained in:
djcb 2016-02-07 14:10:43 +02:00
parent 14cbca7595
commit 0019a00569
2 changed files with 8 additions and 7 deletions

View File

@ -60,10 +60,10 @@ link."
Common values are \"offlineimap\", \"fetchmail\" or \"mbsync\", but Common values are \"offlineimap\", \"fetchmail\" or \"mbsync\", but
arbitrary shell-commands can be used. arbitrary shell-commands can be used.
When set to \"true\" (the default), the command simply finishes When set to the literal string \"true\" (the default), the
succesfully (running the 'true' command) without retrieving any command simply finishes succesfully (running the 'true' command)
mail. This can be useful when mail is already retrieved in another without retrieving any mail. This can be useful when mail is
way." already retrieved in another way."
:type 'string :type 'string
:group 'mu4e :group 'mu4e
:safe 'stringp) :safe 'stringp)

View File

@ -3574,9 +3574,10 @@ some soundfile, change as needed):
somehow?} Yes - set @code{mu4e-headers-auto-update} to @code{nil}. somehow?} Yes - set @code{mu4e-headers-auto-update} to @code{nil}.
@item @emph{I don't use @t{offlineimap}, @t{fetchmail} etc., I get my mail @item @emph{I don't use @t{offlineimap}, @t{fetchmail} etc., I get my mail
through my own mailserver. What should I use for through my own mailserver. What should I use for
@code{mu4e-get-mail-command}}? Use @t{"true"} (or don't do anything, it's the @code{mu4e-get-mail-command}}? Use the literal string @t{"true"} (or
default). This makes getting mail a no-op, but the messages are still don't do anything, it's the default) which then uses @t{/bin/true} (a
re-indexed. command that does nothing and always succeeds). This makes getting mail
a no-op, but the messages are still re-indexed.
@item @emph{How can I re-index my messages without getting new mail?} @item @emph{How can I re-index my messages without getting new mail?}
Use @kbd{M-x mu4e-update-index} Use @kbd{M-x mu4e-update-index}
@item @emph{When I try to run @t{mu index} while @t{mu4e} is running I get @item @emph{When I try to run @t{mu index} while @t{mu4e} is running I get