procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve desktop-save-mode docstring

Browse source 
* 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
1 changed files with 15 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

21
lisp/desktop.el
View file

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