$cursor-blink(5)

[Home] [Commands] [Variables] [Macro-Dev] [Glossary]

NAME

$cursor-blink - Cursor blink rate $cursor-color - Cursor foreground color

SYNOPSIS

$cursor-blink integer; Default is 0

$cursor-color colorNum; Default is 0

0 <= colorNum <= n

DESCRIPTION

$cursor-blink sets the cursor's flash rate, i.e. the period in which the cursor is drawn, hidden and then redrawn. The default setting of 0 disables cursor blinking. When set to a none zero value the variable is split into two componants, the first 16 bits, or lower short, sets the cursor visible time in milliseconds, and the higher short sets the hidden time. If the hidden time is set to 0 then the cursor will be hidden for the same length of time it is visible.

The cursor blink rate can be setup in the platform section of user-setup(3).

$cursor-color sets the cursor's fore-ground color, and can greatly improve cursor visibility. colorNum is a integer palette number created using add-color(2), the default is 0. The first 8 bits, lowest byte, of $cursor-color is used to define the normal cursor colour, however the next 8 bits, bits 9 to 16, are used to define the cursor colour to use when the current buffer has over(2m) mode enabled; if the value is 0 (the default) then the normal cursor colour is used, otherwise it is the colour palette index.

PLATFORM

UNIX termcap interface does not support $cursor-color.

EXAMPLE

The following example sets the cursor visible time to 600 ms (0x258) and a hidden time to 200 ms (0xc8):