summaryrefslogtreecommitdiff
path: root/lisp/desktop.el
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2014-03-12 00:14:30 -0700
committerGlenn Morris <rgm@gnu.org>2014-03-12 00:14:30 -0700
commit464560055fa70476dc6db20c1c29e812cf05a8f9 (patch)
treec775ca9c30ab50ce4e383ff9ebb9d97cebafb725 /lisp/desktop.el
parent7195b84120e016e4a23c9559ac4eeb5d05ceb2b0 (diff)
downloademacs-464560055fa70476dc6db20c1c29e812cf05a8f9.tar.gz
Some doc edits related to desktop-restore-frames
* doc/emacs/misc.texi (Saving Emacs Sessions): Be briefer about desktop's handling of frames. The manual does not need to mention every option, nor should it just repeat the doc-strings. * lisp/desktop.el (desktop-restore-frames) (desktop-restore-in-current-display, desktop-restore-forces-onscreen) (desktop-restore-reuses-frames): Doc tweaks. * etc/NEWS: Related edits.
Diffstat (limited to 'lisp/desktop.el')
-rw-r--r--lisp/desktop.el27
1 files changed, 16 insertions, 11 deletions
diff --git a/lisp/desktop.el b/lisp/desktop.el
index dbddfb7c1d3..5e43c03ade7 100644
--- a/lisp/desktop.el
+++ b/lisp/desktop.el
@@ -387,15 +387,18 @@ modes are restored automatically; they should not be listed here."
:group 'desktop)
(defcustom desktop-restore-frames t
- "When non-nil, save frames to desktop file."
+ "When non-nil, save and restore the frame and window configuration.
+See related options `desktop-restore-reuses-frames',
+`desktop-restore-in-current-display', and `desktop-restore-forces-onscreen'."
:type 'boolean
:group 'desktop
:version "24.4")
(defcustom desktop-restore-in-current-display nil
- "If t, frames are restored in the current display.
-If nil, frames are restored, if possible, in their original displays.
-If `delete', frames on other displays are deleted instead of restored."
+ "Controls how restoring of frames treats displays.
+If t, restores frames into the current display.
+If nil, restores frames into their original displays (if possible).
+If `delete', deletes frames on other displays instead of restoring them."
:type '(choice (const :tag "Restore in current display" t)
(const :tag "Restore in original display" nil)
(const :tag "Delete frames in other displays" delete))
@@ -403,11 +406,13 @@ If `delete', frames on other displays are deleted instead of restored."
:version "24.4")
(defcustom desktop-restore-forces-onscreen t
- "If t, offscreen frames are restored onscreen instead.
-If `all', frames that are partially offscreen are also forced onscreen.
-NOTE: Checking of frame boundaries is only approximate and can fail
-to reliably detect frames whose onscreen/offscreen state depends on a
-few pixels, especially near the right / bottom borders of the screen."
+ "If t, restores frames that are fully offscreen onscreen instead.
+If `all', also restores frames that are partially offscreen onscreen.
+
+Note that checking of frame boundaries is only approximate.
+It can fail to reliably detect frames whose onscreen/offscreen state
+depends on a few pixels, especially near the right / bottom borders
+of the screen."
:type '(choice (const :tag "Only fully offscreen frames" t)
(const :tag "Also partially offscreen frames" all)
(const :tag "Do not force frames onscreen" nil))
@@ -416,8 +421,8 @@ few pixels, especially near the right / bottom borders of the screen."
(defcustom desktop-restore-reuses-frames t
"If t, restoring frames reuses existing frames.
-If nil, existing frames are deleted.
-If `keep', existing frames are kept and not reused."
+If nil, deletes existing frames.
+If `keep', keeps existing frames and does not reuse them."
:type '(choice (const :tag "Reuse existing frames" t)
(const :tag "Delete existing frames" nil)
(const :tag "Keep existing frames" :keep))