summaryrefslogtreecommitdiff
path: root/lisp
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2014-04-13 10:49:23 +0300
committerEli Zaretskii <eliz@gnu.org>2014-04-13 10:49:23 +0300
commit834511891e138f284c6e11a2cab34d06670e7052 (patch)
tree37dd47ceb1d24d0cd8253bfee292050bb964490f /lisp
parentff252be0a8c1955801061d071d6c537ab46e53d8 (diff)
downloademacs-834511891e138f284c6e11a2cab34d06670e7052.tar.gz
Improve documentation of blink-cursor-mode and its customization variables.
lisp/frame.el (blink-cursor-blinks, blink-cursor-blinks-done): Doc fixes. (blink-cursor-mode): Mention customization variables and the effect of 'blink-cursor-blinks'. doc/emacs/display.texi (Cursor Display): Explain better how to customize 'blink-cursor-blinks'.
Diffstat (limited to 'lisp')
-rw-r--r--lisp/ChangeLog6
-rw-r--r--lisp/frame.el10
2 files changed, 14 insertions, 2 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index f5f3208256e..704f7a6d8d8 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,9 @@
+2014-04-13 Eli Zaretskii <eliz@gnu.org>
+
+ * frame.el (blink-cursor-blinks, blink-cursor-blinks-done): Doc fixes.
+ (blink-cursor-mode): Mention customization variables and the
+ effect of 'blink-cursor-blinks'.
+
2014-04-12 Barry O'Reilly <gundaetiapo@gmail.com>
* simple.el (undo): Prevent insertion of identity mapping into
diff --git a/lisp/frame.el b/lisp/frame.el
index 7b0a0a80082..f081df788ec 100644
--- a/lisp/frame.el
+++ b/lisp/frame.el
@@ -1722,14 +1722,14 @@ left untouched. FRAME nil or omitted means use the selected frame."
:group 'cursor)
(defcustom blink-cursor-blinks 10
- "How many times to blink before using a solid cursor on NS and X.
+ "How many times to blink before using a solid cursor on NS, X, and MS-Windows.
Use 0 or negative value to blink forever."
:version "24.4"
:type 'integer
:group 'cursor)
(defvar blink-cursor-blinks-done 1
- "Number of blinks done since we started blinking on NS and X")
+ "Number of blinks done since we started blinking on NS, X, and MS-Windows.")
(defvar blink-cursor-idle-timer nil
"Timer started after `blink-cursor-delay' seconds of Emacs idle time.
@@ -1807,6 +1807,12 @@ With a prefix argument ARG, enable Blink Cursor mode if ARG is
positive, and disable it otherwise. If called from Lisp, enable
the mode if ARG is omitted or nil.
+If the value of `blink-cursor-blinks' is positive (10 by default),
+the cursor stops blinking after that number of blinks, if Emacs
+gets no input during that time.
+
+See also `blink-cursor-interval' and `blink-cursor-delay'.
+
This command is effective only on graphical frames. On text-only
terminals, cursor blinking is controlled by the terminal."
:init-value (not (or noninteractive