Mercurial > emacs

--- a/lisp/ChangeLog	Sat Jul 25 08:50:51 2009 +0000
+++ b/lisp/ChangeLog	Sat Jul 25 09:31:05 2009 +0000
@@ -1,3 +1,25 @@
+2009-07-25  Eli Zaretskii  <eliz@gnu.org>
+
+	Fix Bug#3888:
+
+	* w32-vars.el (x-select-enable-clipboard): Doc fix.
+
+	* term/pc-win.el (x-display-name, x-colors)
+	(x-select-enable-clipboard, x-select-text): Doc fix.
+
+	* term/common-win.el (x-display-name, x-colors): Doc fix.
+
+	* term/ns-win.el (x-select-text, x-setup-function-keys, x-colors)
+	(xw-defined-colors): Doc fix.
+
+	* w32-fns.el (x-select-text, x-setup-function-keys)
+	(x-get-selection, x-set-selection): Doc fix.
+
+	* term/x-win.el (x-select-text, x-setup-function-keys)
+	(x-select-enable-clipboard, xw-defined-colors): Doc fix.
+
+	* select.el (x-set-selection): Doc fix.
+
 2009-07-25  Michael Albinus  <michael.albinus@gmx.de>

 	* net/zeroconf.el (zeroconf-init): Check for "GetVersionString"
--- a/lisp/select.el	Sat Jul 25 08:50:51 2009 +0000
+++ b/lisp/select.el	Sat Jul 25 09:31:05 2009 +0000
@@ -116,28 +116,28 @@

 (defun x-set-selection (type data)
   "Make an X Windows selection of type TYPE and value DATA.
-TYPE is a symbol specifying the selection type.  This is normally
-one of `PRIMARY', `SECONDARY', or `CLIPBOARD'; or nil, which is
-equivalent to `PRIMARY'.  (It can also be a string, which stands
-for the symbol with that name, but this usage is obsolete.)
+The argument TYPE (nil means `PRIMARY') says which selection, and
+DATA specifies the contents.  TYPE must be a symbol.  \(It can also
+be a string, which stands for the symbol with that name, but this
+is considered obsolete.)  DATA may be a string, a symbol, an
+integer (or a cons of two integers or list of two integers).

-DATA is a selection value.  It should be one of the following:
- - A vector of non-vector selection values.
- - A string.
- - An integer.
- - A cons cell of two markers pointing to the same buffer
-   (the data consists of the text between the markers).
- - An overlay (the data consists of the text within the overlay).
- - A buffer (the data consists of the text in the region).
-For the last three cases, the actual selection data is computed
-only when the selection is requested.  Thus, it includes any
-changes made to the buffer after `x-set-selection' is called.
+The selection may also be a cons of two markers pointing to the same buffer,
+or an overlay.  In these cases, the selection is considered to be the text
+between the markers *at whatever time the selection is examined*.
+Thus, editing done in the buffer after you specify the selection
+can alter the effective value of the selection.
+
+The data may also be a vector of valid non-vector selection values.

 The return value is DATA.

 Interactively, this command sets the primary selection.  Without
 prefix argument, it reads the selection in the minibuffer.  With
-prefix argument, it uses the text of the region as the selection value ."
+prefix argument, it uses the text of the region as the selection value.
+
+Note that on MS-Windows, primary and secondary selections set by Emacs
+are not available to other programs."
   (interactive (if (not current-prefix-arg)
 		   (list 'PRIMARY (read-string "Set text for pasting: "))
 		 (list 'PRIMARY (buffer-substring (region-beginning) (region-end)))))
--- a/lisp/term/common-win.el	Sat Jul 25 08:50:51 2009 +0000
+++ b/lisp/term/common-win.el	Sat Jul 25 09:31:05 2009 +0000
@@ -131,7 +131,9 @@
 				  initial-frame-alist)))

 (defvar x-display-name nil
-  "The name of the X display on which Emacs was started.
+  "The name of the window display on which Emacs was started.
+On X, the display name of individual X frames is recorded in the
+`display' frame parameter.")

 For the X display name of individual frames, see the `display'
 frame parameter.")
@@ -288,8 +290,10 @@
     "cyan" "medium spring green" "spring green" "green" "lawn green" "chartreuse"
     "yellow" "gold" "orange" "dark orange" "orange red" "red" "white" "white smoke"
     "gainsboro" "light grey" "gray" "dark grey" "dim gray" "black" )
-  "The list of X colors from the `rgb.txt' file.
-XConsortium: rgb.txt,v 10.41 94/02/20 18:39:36 rws Exp")
+  "List of basic colors available on color displays.
+For X, the list comes from the `rgb.txt' file,v 10.41 94/02/20.
+For Nextstep, this is a list of non-PANTONE colors returned by
+the operating system.")

 ;; arch-tag: 2a128601-99cc-401e-9dff-0ee6a36102ef
 ;;; common-win.el ends here
--- a/lisp/term/ns-win.el	Sat Jul 25 08:50:51 2009 +0000
+++ b/lisp/term/ns-win.el	Sat Jul 25 09:31:05 2009 +0000
@@ -309,7 +309,7 @@
 (defalias 'do-applescript 'ns-do-applescript)

 (defun x-setup-function-keys (frame)
-  "Set up function Keys for Nextstep for frame FRAME."
+  "Set up function keys on the graphical frame FRAME."
   (unless (terminal-parameter frame 'x-setup-function-keys)
     (with-selected-frame frame
       (setq interprogram-cut-function 'x-select-text
@@ -1003,7 +1003,19 @@
 (defvar ns-last-selected-text nil)

 (defun x-select-text (text &optional push)
-  "Put TEXT, a string, on the pasteboard."
+  "Select TEXT, a string, according to the window system.
+
+On X, put TEXT in the primary X selection.  For backward
+compatibility with older X applications, set the value of X cut
+buffer 0 as well, and if the optional argument PUSH is non-nil,
+rotate the cut buffers.  If `x-select-enable-clipboard' is
+non-nil, copy the text to the X clipboard as well.
+
+On Windows, make TEXT the current selection.  If
+`x-select-enable-clipboard' is non-nil, copy the text to the
+clipboard as well.  The argument PUSH is ignored.
+
+On Nextstep, put TEXT in the pasteboard; PUSH is ignored."
   ;; Don't send the pasteboard too much text.
   ;; It becomes slow, and if really big it causes errors.
   (ns-set-pasteboard text)
@@ -1113,12 +1125,13 @@
 (declare-function ns-list-colors "nsfns.m" (&optional frame))

 (defvar x-colors (ns-list-colors)
-  "The list of colors defined in non-PANTONE color files.")
+  "List of basic colors available on color displays.
+For X, the list comes from the `rgb.txt' file,v 10.41 94/02/20.
+For Nextstep, this is a list of non-PANTONE colors returned by
+the operating system.")

 (defun xw-defined-colors (&optional frame)
-  "Return a list of colors supported for a particular frame.
-The argument FRAME specifies which frame to try.
-The value may be different for frames on different Nextstep displays."
+  "Internal function called by `defined-colors'."
   (or frame (setq frame (selected-frame)))
   (let ((all-colors x-colors)
 	(this-color nil)
--- a/lisp/term/pc-win.el	Sat Jul 25 08:50:51 2009 +0000
+++ b/lisp/term/pc-win.el	Sat Jul 25 09:31:05 2009 +0000
@@ -181,9 +181,14 @@

 ;; From lisp/term/x-win.el
 (defvar x-display-name "pc"
-  "The display name specifying the MS-DOS display and frame type.")
+  "The name of the window display on which Emacs was started.
+On X, the display name of individual X frames is recorded in the
+`display' frame parameter.")
 (defvar x-colors (mapcar 'car msdos-color-values)
-  "The list of colors available on a PC display under MS-DOS.")
+  "List of basic colors available on color displays.
+For X, the list comes from the `rgb.txt' file,v 10.41 94/02/20.
+For Nextstep, this is a list of non-PANTONE colors returned by
+the operating system.")

 ;; From lisp/term/w32-win.el
 ;
@@ -196,12 +201,28 @@

 (defcustom x-select-enable-clipboard t
   "Non-nil means cutting and pasting uses the clipboard.
-This is the default on this system, since MS-Windows does not
-support other types of selections."
+This is in addition to, but in preference to, the primary selection.
+
+On MS-Windows, this is non-nil by default, since Windows does not
+support other types of selections.  \(The primary selection that is
+set by Emacs is not accessible to other programs on Windows.\)"
   :type 'boolean
   :group 'killing)

 (defun x-select-text (text &optional push)
+  "Select TEXT, a string, according to the window system.
+
+On X, put TEXT in the primary X selection.  For backward
+compatibility with older X applications, set the value of X cut
+buffer 0 as well, and if the optional argument PUSH is non-nil,
+rotate the cut buffers.  If `x-select-enable-clipboard' is
+non-nil, copy the text to the X clipboard as well.
+
+On Windows, make TEXT the current selection.  If
+`x-select-enable-clipboard' is non-nil, copy the text to the
+clipboard as well.  The argument PUSH is ignored.
+
+On Nextstep, put TEXT in the pasteboard; PUSH is ignored."
   (if x-select-enable-clipboard
       (w16-set-clipboard-data text))
   (setq x-last-selected-text text))
--- a/lisp/term/x-win.el	Sat Jul 25 08:50:51 2009 +0000
+++ b/lisp/term/x-win.el	Sat Jul 25 09:31:05 2009 +0000
@@ -255,7 +255,7 @@
 (defvar x-colors)

 (defun xw-defined-colors (&optional frame)
-  "Internal function called by `defined-colors', which see."
+  "Internal function called by `defined-colors'."
   (or frame (setq frame (selected-frame)))
   (let ((all-colors x-colors)
 	(this-color nil)
@@ -292,7 +292,7 @@
   "Keymap of possible alternative meanings for some keys.")

 (defun x-setup-function-keys (frame)
-  "Set up `function-key-map' on FRAME for the X window system."
+  "Set up `function-key-map' on the graphical frame FRAME."
   ;; Don't do this twice on the same display, or it would break
   ;; normal-erase-is-backspace-mode.
   (unless (terminal-parameter frame 'x-setup-function-keys)
@@ -1239,7 +1239,11 @@

 (defcustom x-select-enable-clipboard nil
   "Non-nil means cutting and pasting uses the clipboard.
-This is in addition to, but in preference to, the primary selection."
+This is in addition to, but in preference to, the primary selection.
+
+On MS-Windows, this is non-nil by default, since Windows does not
+support other types of selections.  \(The primary selection that is
+set by Emacs is not accessible to other programs on Windows.\)"
   :type 'boolean
   :group 'killing)

@@ -1249,11 +1253,19 @@
   :group 'killing)

 (defun x-select-text (text &optional push)
-  "Make TEXT, a string, the primary X selection.
-Also, set the value of X cut buffer 0, for backward compatibility
-with older X applications.
-gildea@stop.mail-abuse.org says it's not desirable to put kills
-in the clipboard."
+  "Select TEXT, a string, according to the window system.
+
+On X, put TEXT in the primary X selection.  For backward
+compatibility with older X applications, set the value of X cut
+buffer 0 as well, and if the optional argument PUSH is non-nil,
+rotate the cut buffers.  If `x-select-enable-clipboard' is
+non-nil, copy the text to the X clipboard as well.
+
+On Windows, make TEXT the current selection.  If
+`x-select-enable-clipboard' is non-nil, copy the text to the
+clipboard as well.  The argument PUSH is ignored.
+
+On Nextstep, put TEXT in the pasteboard; PUSH is ignored."
   ;; With multi-tty, this function may be called from a tty frame.
   (when (eq (framep (selected-frame)) 'x)
     ;; Don't send the cut buffer too much text.
--- a/lisp/w32-fns.el	Sat Jul 25 08:50:51 2009 +0000
+++ b/lisp/w32-fns.el	Sat Jul 25 09:31:05 2009 +0000
@@ -55,7 +55,7 @@
   "Keymap of possible alternative meanings for some keys.")

 (defun x-setup-function-keys (frame)
-  "Set up `function-key-map' on FRAME for w32."
+  "Set up `function-key-map' on the graphical frame FRAME."
   ;; Don't do this twice on the same display, or it would break
   ;; normal-erase-is-backspace-mode.
   (unless (terminal-parameter frame 'x-setup-function-keys)
@@ -294,9 +294,44 @@

 ;;; Fix interface to (X-specific) mouse.el
 (defun x-set-selection (type data)
+  "Make an X Windows selection of type TYPE and value DATA.
+The argument TYPE (nil means `PRIMARY') says which selection, and
+DATA specifies the contents.  TYPE must be a symbol.  \(It can also
+be a string, which stands for the symbol with that name, but this
+is considered obsolete.)  DATA may be a string, a symbol, an
+integer (or a cons of two integers or list of two integers).
+
+The selection may also be a cons of two markers pointing to the same buffer,
+or an overlay.  In these cases, the selection is considered to be the text
+between the markers *at whatever time the selection is examined*.
+Thus, editing done in the buffer after you specify the selection
+can alter the effective value of the selection.
+
+The data may also be a vector of valid non-vector selection values.
+
+The return value is DATA.
+
+Interactively, this command sets the primary selection.  Without
+prefix argument, it reads the selection in the minibuffer.  With
+prefix argument, it uses the text of the region as the selection value.
+
+Note that on MS-Windows, primary and secondary selections set by Emacs
+are not available to other programs."
   (put 'x-selections (or type 'PRIMARY) data))

 (defun x-get-selection (&optional type data-type)
+  "Return the value of an X Windows selection.
+The argument TYPE (default `PRIMARY') says which selection,
+and the argument DATA-TYPE (default `STRING') says
+how to convert the data.
+
+TYPE may be any symbol \(but nil stands for `PRIMARY').  However,
+only a few symbols are commonly used.  They conventionally have
+all upper-case names.  The most often used ones, in addition to
+`PRIMARY', are `SECONDARY' and `CLIPBOARD'.
+
+DATA-TYPE is usually `STRING', but can also be one of the symbols
+in `selection-converter-alist', which see."
   (get 'x-selections (or type 'PRIMARY)))

 ;; x-selection-owner-p is used in simple.el
@@ -418,9 +453,19 @@
   "Max number of characters to put in the cut buffer.")

 (defun x-select-text (text &optional push)
-  "Make TEXT the last selected text.
-If `x-select-enable-clipboard' is non-nil, copy the text to the system
-clipboard as well.  Optional PUSH is ignored on Windows."
+  "Select TEXT, a string, according to the window system.
+
+On X, put TEXT in the primary X selection.  For backward
+compatibility with older X applications, set the value of X cut
+buffer 0 as well, and if the optional argument PUSH is non-nil,
+rotate the cut buffers.  If `x-select-enable-clipboard' is
+non-nil, copy the text to the X clipboard as well.
+
+On Windows, make TEXT the current selection.  If
+`x-select-enable-clipboard' is non-nil, copy the text to the
+clipboard as well.  The argument PUSH is ignored.
+
+On Nextstep, put TEXT in the pasteboard; PUSH is ignored."
   (if x-select-enable-clipboard
       (w32-set-clipboard-data text))
   (setq x-last-selected-text text))
--- a/lisp/w32-vars.el	Sat Jul 25 08:50:51 2009 +0000
+++ b/lisp/w32-vars.el	Sat Jul 25 09:31:05 2009 +0000
@@ -149,7 +149,11 @@

 (defcustom x-select-enable-clipboard t
   "Non-nil means cutting and pasting uses the clipboard.
-This is in addition to the primary selection."
+This is in addition to, but in preference to, the primary selection.
+
+On MS-Windows, this is non-nil by default, since Windows does not
+support other types of selections.  \(The primary selection that is
+set by Emacs is not accessible to other programs on Windows.\)"
   :type 'boolean
   :group 'killing)