From 11f25adeffa4b9e2ce767028e2f7adb8178fd0c4 Mon Sep 17 00:00:00 2001
From: "Richard M. Stallman" <rms@gnu.org>
Date: Tue, 27 Aug 2002 18:40:30 +0000
Subject: Describe blink-cursor-alist and new values for cursor-type.

---
 lispref/frames.texi | 40 ++++++++++++++++++++++++++++++++--------
 1 file changed, 32 insertions(+), 8 deletions(-)

(limited to 'lispref')

diff --git a/lispref/frames.texi b/lispref/frames.texi
index 2bd97ffbf8e..909c2bc0ed6 100644
--- a/lispref/frames.texi
+++ b/lispref/frames.texi
@@ -516,14 +516,24 @@ in this frame.  Its value is @code{color}, @code{grayscale} or
 @code{mono}.
 
 @item cursor-type
-The way to display the cursor.  The legitimate values are @code{bar},
-@code{box}, and @code{(bar . @var{width})}.  The symbol @code{box}
-specifies an ordinary black box overlaying the character after point;
-that is the default.  The symbol @code{bar} specifies a vertical bar
-between characters as the cursor.  @code{(bar . @var{width})}
-specifies a bar @var{width} pixels wide.  The symbol @code{hbar}
-specifies a horizontal bar, an underscore-like cursor.  @code{(hbar .
-@var{width})} specifiles a horizontal bar @var{width} pixels high.
+How to display the cursor.  Legitimate values are:
+
+@table @code
+@item box
+Display a filled box.  (This is the default.)
+@item hollow
+Display a hollow box.
+@item nil
+Don't display a cursor.
+@item bar
+Display a vertical bar between characters.
+@item (bar . @var{width})
+Display a vertical bar @var{width} pixels wide between characters.
+@item hbar
+Display a horizontal bar.
+@item (bar . @var{width})
+Display a horizontal bar @var{width} pixels high.
+@end table
 
 @vindex cursor-type
 The buffer-local variable @code{cursor-type} overrides the value of
@@ -587,6 +597,20 @@ it and see if it works.)
 @end ignore
 @end table
 
+@defvar blink-cursor-alist
+This variable specifies how to blink the cursor.  Each element has the
+form @code{(@var{on-state} . @var{off-state})}.  Whenever the cursor
+type equals @var{on-state} (comparing using @code{equal}), Emacs uses
+@var{off-state} to specify what the cursor looks like when it blinks
+``off''.  Both @var{on-state} and @var{off-state} should be suitable
+values for the @code{cursor-type} frame parameter.
+
+There are various defaults for how to blink each type of cursor,
+if the type is not mentioned as an @var{on-state} here.  Changes
+in this variable do not take effect immediately, because the variable
+is examined only when you specify a cursor type for a frame.
+@end defvar
+
 @node Size and Position
 @subsection Frame Size And Position
 @cindex size of frame
-- 
cgit v1.2.1