diff options
| author | Eli Zaretskii | 2014-04-13 10:49:23 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2014-04-13 10:49:23 +0300 |
| commit | 834511891e138f284c6e11a2cab34d06670e7052 (patch) | |
| tree | 37dd47ceb1d24d0cd8253bfee292050bb964490f | |
| parent | ff252be0a8c1955801061d071d6c537ab46e53d8 (diff) | |
| download | emacs-834511891e138f284c6e11a2cab34d06670e7052.tar.gz emacs-834511891e138f284c6e11a2cab34d06670e7052.zip | |
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'.
| -rw-r--r-- | doc/emacs/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/emacs/display.texi | 33 | ||||
| -rw-r--r-- | lisp/ChangeLog | 6 | ||||
| -rw-r--r-- | lisp/frame.el | 10 |
4 files changed, 40 insertions, 14 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index 56daee10101..0b2359458ec 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog | |||
| @@ -1,3 +1,8 @@ | |||
| 1 | 2014-04-13 Eli Zaretskii <eliz@gnu.org> | ||
| 2 | |||
| 3 | * display.texi (Cursor Display): Explain better how to customize | ||
| 4 | 'blink-cursor-blinks'. | ||
| 5 | |||
| 1 | 2014-04-05 Glenn Morris <rgm@gnu.org> | 6 | 2014-04-05 Glenn Morris <rgm@gnu.org> |
| 2 | 7 | ||
| 3 | * trouble.texi (Checklist): Dribble files may contain passwords. | 8 | * trouble.texi (Checklist): Dribble files may contain passwords. |
diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi index d53c80acafd..03de755aff3 100644 --- a/doc/emacs/display.texi +++ b/doc/emacs/display.texi | |||
| @@ -1482,18 +1482,27 @@ pixels tall), or @code{nil} (no cursor at all). | |||
| 1482 | @vindex blink-cursor-mode | 1482 | @vindex blink-cursor-mode |
| 1483 | @vindex blink-cursor-blinks | 1483 | @vindex blink-cursor-blinks |
| 1484 | @vindex blink-cursor-alist | 1484 | @vindex blink-cursor-alist |
| 1485 | By default, the cursor stops blinking after 10 blinks. This can be | 1485 | By default, the cursor stops blinking after 10 blinks, if Emacs does |
| 1486 | changed by customizing the variable @code{blink-cursor-blinks}. To | 1486 | not get any input during that time; any input event restarts the |
| 1487 | disable cursor blinking altogether, change the variable | 1487 | count. You can customize the variable @code{blink-cursor-blinks} to |
| 1488 | @code{blink-cursor-mode} to @code{nil} (@pxref{Easy Customization}), | 1488 | control that: its value says how many times to blink without input |
| 1489 | or add the line @code{(blink-cursor-mode 0)} to your init file. | 1489 | before stopping. Setting that variable to a zero or negative value |
| 1490 | Alternatively, you can change how the cursor looks when it ``blinks | 1490 | will make the cursor blink forever. To disable cursor blinking |
| 1491 | off'' by customizing the list variable @code{blink-cursor-alist}. | 1491 | altogether, change the variable @code{blink-cursor-mode} to @code{nil} |
| 1492 | Each element in the list should have the form @code{(@var{on-type} | 1492 | (@pxref{Easy Customization}), or add the line |
| 1493 | . @var{off-type})}; this means that if the cursor is displayed as | 1493 | |
| 1494 | @var{on-type} when it blinks on (where @var{on-type} is one of the | 1494 | @lisp |
| 1495 | cursor types described above), then it is displayed as @var{off-type} | 1495 | (blink-cursor-mode 0) |
| 1496 | when it blinks off. | 1496 | @end lisp |
| 1497 | |||
| 1498 | @noindent | ||
| 1499 | to your init file. Alternatively, you can change how the cursor | ||
| 1500 | looks when it ``blinks off'' by customizing the list variable | ||
| 1501 | @code{blink-cursor-alist}. Each element in the list should have the | ||
| 1502 | form @code{(@var{on-type} . @var{off-type})}; this means that if the | ||
| 1503 | cursor is displayed as @var{on-type} when it blinks on (where | ||
| 1504 | @var{on-type} is one of the cursor types described above), then it is | ||
| 1505 | displayed as @var{off-type} when it blinks off. | ||
| 1497 | 1506 | ||
| 1498 | @vindex x-stretch-cursor | 1507 | @vindex x-stretch-cursor |
| 1499 | @cindex wide block cursor | 1508 | @cindex wide block cursor |
diff --git a/lisp/ChangeLog b/lisp/ChangeLog index f5f3208256e..704f7a6d8d8 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog | |||
| @@ -1,3 +1,9 @@ | |||
| 1 | 2014-04-13 Eli Zaretskii <eliz@gnu.org> | ||
| 2 | |||
| 3 | * frame.el (blink-cursor-blinks, blink-cursor-blinks-done): Doc fixes. | ||
| 4 | (blink-cursor-mode): Mention customization variables and the | ||
| 5 | effect of 'blink-cursor-blinks'. | ||
| 6 | |||
| 1 | 2014-04-12 Barry O'Reilly <gundaetiapo@gmail.com> | 7 | 2014-04-12 Barry O'Reilly <gundaetiapo@gmail.com> |
| 2 | 8 | ||
| 3 | * simple.el (undo): Prevent insertion of identity mapping into | 9 | * 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." | |||
| 1722 | :group 'cursor) | 1722 | :group 'cursor) |
| 1723 | 1723 | ||
| 1724 | (defcustom blink-cursor-blinks 10 | 1724 | (defcustom blink-cursor-blinks 10 |
| 1725 | "How many times to blink before using a solid cursor on NS and X. | 1725 | "How many times to blink before using a solid cursor on NS, X, and MS-Windows. |
| 1726 | Use 0 or negative value to blink forever." | 1726 | Use 0 or negative value to blink forever." |
| 1727 | :version "24.4" | 1727 | :version "24.4" |
| 1728 | :type 'integer | 1728 | :type 'integer |
| 1729 | :group 'cursor) | 1729 | :group 'cursor) |
| 1730 | 1730 | ||
| 1731 | (defvar blink-cursor-blinks-done 1 | 1731 | (defvar blink-cursor-blinks-done 1 |
| 1732 | "Number of blinks done since we started blinking on NS and X") | 1732 | "Number of blinks done since we started blinking on NS, X, and MS-Windows.") |
| 1733 | 1733 | ||
| 1734 | (defvar blink-cursor-idle-timer nil | 1734 | (defvar blink-cursor-idle-timer nil |
| 1735 | "Timer started after `blink-cursor-delay' seconds of Emacs idle time. | 1735 | "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 | |||
| 1807 | positive, and disable it otherwise. If called from Lisp, enable | 1807 | positive, and disable it otherwise. If called from Lisp, enable |
| 1808 | the mode if ARG is omitted or nil. | 1808 | the mode if ARG is omitted or nil. |
| 1809 | 1809 | ||
| 1810 | If the value of `blink-cursor-blinks' is positive (10 by default), | ||
| 1811 | the cursor stops blinking after that number of blinks, if Emacs | ||
| 1812 | gets no input during that time. | ||
| 1813 | |||
| 1814 | See also `blink-cursor-interval' and `blink-cursor-delay'. | ||
| 1815 | |||
| 1810 | This command is effective only on graphical frames. On text-only | 1816 | This command is effective only on graphical frames. On text-only |
| 1811 | terminals, cursor blinking is controlled by the terminal." | 1817 | terminals, cursor blinking is controlled by the terminal." |
| 1812 | :init-value (not (or noninteractive | 1818 | :init-value (not (or noninteractive |