diff options
| author | Stefan Kangas | 2024-02-01 09:08:19 +0100 |
|---|---|---|
| committer | Stefan Kangas | 2024-02-01 09:14:27 +0100 |
| commit | 5ce02c91bc128f390bcf0beb82e37a3fa7f251ba (patch) | |
| tree | 7ff524fa4da4cd5d2d02eb6a87b2e1654b5b0945 | |
| parent | 2f98b13ed0522ef37c7bb2ca37f24b1be2f9fde5 (diff) | |
| download | emacs-5ce02c91bc128f390bcf0beb82e37a3fa7f251ba.tar.gz emacs-5ce02c91bc128f390bcf0beb82e37a3fa7f251ba.zip | |
Improve `desktop-save-mode` docstring
* lisp/desktop.el (desktop-save-mode): Improve docstring.
| -rw-r--r-- | lisp/desktop.el | 21 |
1 files changed, 15 insertions, 6 deletions
diff --git a/lisp/desktop.el b/lisp/desktop.el index 56841b49595..9100d825547 100644 --- a/lisp/desktop.el +++ b/lisp/desktop.el | |||
| @@ -163,13 +163,22 @@ Used at desktop read to provide backward compatibility.") | |||
| 163 | (define-minor-mode desktop-save-mode | 163 | (define-minor-mode desktop-save-mode |
| 164 | "Toggle desktop saving (Desktop Save mode). | 164 | "Toggle desktop saving (Desktop Save mode). |
| 165 | 165 | ||
| 166 | When Desktop Save mode is enabled, the state of Emacs is saved from | 166 | When Desktop Save mode is enabled, the state of Emacs is saved from one |
| 167 | one session to another. In particular, Emacs will save the desktop when | 167 | session to another. The saved Emacs \"desktop configuration\" includes the |
| 168 | it exits (this may prompt you; see the option `desktop-save'). The next | 168 | buffers, their file names, major modes, buffer positions, window and frame |
| 169 | time Emacs starts, if this mode is active it will restore the desktop. | 169 | configuration, and some important global variables. |
| 170 | 170 | ||
| 171 | To manually save the desktop at any time, use the command `\\[desktop-save]'. | 171 | To enable this feature for future sessions, customize `desktop-save-mode' |
| 172 | To load it, use `\\[desktop-read]'. | 172 | to t, or add this line in your init file: |
| 173 | |||
| 174 | (desktop-save-mode 1) | ||
| 175 | |||
| 176 | When this mode is enabled, Emacs will save the desktop when it exits | ||
| 177 | (this may prompt you, see the option `desktop-save'). The next time | ||
| 178 | Emacs starts, if this mode is active it will restore the desktop. | ||
| 179 | |||
| 180 | To manually save the desktop at any time, use the command \\[desktop-save]. | ||
| 181 | To load it, use \\[desktop-read]. | ||
| 173 | 182 | ||
| 174 | Once a desktop file exists, Emacs will auto-save it according to the | 183 | Once a desktop file exists, Emacs will auto-save it according to the |
| 175 | option `desktop-auto-save-timeout'. | 184 | option `desktop-auto-save-timeout'. |