Improve desktop-save-mode docstring

* lisp/desktop.el (desktop-save-mode): Improve docstring.
This commit is contained in:
Stefan Kangas 2024-02-01 09:08:19 +01:00
parent 2f98b13ed0
commit 5ce02c91bc

View file

@ -163,13 +163,22 @@ Used at desktop read to provide backward compatibility.")
(define-minor-mode desktop-save-mode
"Toggle desktop saving (Desktop Save mode).
When Desktop Save mode is enabled, the state of Emacs is saved from
one session to another. In particular, Emacs will save the desktop when
it exits (this may prompt you; see the option `desktop-save'). The next
time Emacs starts, if this mode is active it will restore the desktop.
When Desktop Save mode is enabled, the state of Emacs is saved from one
session to another. The saved Emacs \"desktop configuration\" includes the
buffers, their file names, major modes, buffer positions, window and frame
configuration, and some important global variables.
To manually save the desktop at any time, use the command `\\[desktop-save]'.
To load it, use `\\[desktop-read]'.
To enable this feature for future sessions, customize `desktop-save-mode'
to t, or add this line in your init file:
(desktop-save-mode 1)
When this mode is enabled, Emacs will save the desktop when it exits
(this may prompt you, see the option `desktop-save'). The next time
Emacs starts, if this mode is active it will restore the desktop.
To manually save the desktop at any time, use the command \\[desktop-save].
To load it, use \\[desktop-read].
Once a desktop file exists, Emacs will auto-save it according to the
option `desktop-auto-save-timeout'.