Documentation/VGA-softcursor.txt: convert to ReST markup

- Fix document title;
- use quote blocks where needed;
- use monotonic fonts for config options and file names;
- adjust whitespaces and blank lines;
- add it to the user's book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab 2016-09-23 16:26:03 -03:00
parent 77514391ee
commit 27641b953c

View File

@ -1,39 +1,66 @@
Software cursor for VGA by Pavel Machek <pavel@atrey.karlin.mff.cuni.cz> Software cursor for VGA
======================= and Martin Mares <mj@atrey.karlin.mff.cuni.cz> =======================
Linux now has some ability to manipulate cursor appearance. Normally, you by Pavel Machek <pavel@atrey.karlin.mff.cuni.cz>
and Martin Mares <mj@atrey.karlin.mff.cuni.cz>
Linux now has some ability to manipulate cursor appearance. Normally, you
can set the size of hardware cursor (and also work around some ugly bugs in can set the size of hardware cursor (and also work around some ugly bugs in
those miserable Trident cards--see #define TRIDENT_GLITCH in drivers/video/ those miserable Trident cards [#f1]_. You can now play a few new tricks:
vgacon.c). You can now play a few new tricks: you can make your cursor look you can make your cursor look
like a non-blinking red block, make it inverse background of the character it's like a non-blinking red block, make it inverse background of the character it's
over or to highlight that character and still choose whether the original over or to highlight that character and still choose whether the original
hardware cursor should remain visible or not. There may be other things I have hardware cursor should remain visible or not. There may be other things I have
never thought of. never thought of.
The cursor appearance is controlled by a "<ESC>[?1;2;3c" escape sequence The cursor appearance is controlled by a ``<ESC>[?1;2;3c`` escape sequence
where 1, 2 and 3 are parameters described below. If you omit any of them, where 1, 2 and 3 are parameters described below. If you omit any of them,
they will default to zeroes. they will default to zeroes.
Parameter 1 specifies cursor size (0=default, 1=invisible, 2=underline, ..., first Parameter
8=full block) + 16 if you want the software cursor to be applied + 32 if you specifies cursor size::
want to always change the background color + 64 if you dislike having the
background the same as the foreground. Highlights are ignored for the last two
flags.
The second parameter selects character attribute bits you want to change 0=default
(by simply XORing them with the value of this parameter). On standard VGA, 1=invisible
the high four bits specify background and the low four the foreground. In both 2=underline,
groups, low three bits set color (as in normal color codes used by the console) ...
and the most significant one turns on highlight (or sometimes blinking--it 8=full block
depends on the configuration of your VGA). + 16 if you want the software cursor to be applied
+ 32 if you want to always change the background color
+ 64 if you dislike having the background the same as the
foreground.
The third parameter consists of character attribute bits you want to set. Highlights are ignored for the last two flags.
Bit setting takes place before bit toggling, so you can simply clear a bit by
including it in both the set mask and the toggle mask. second parameter
selects character attribute bits you want to change
(by simply XORing them with the value of this parameter). On standard
VGA, the high four bits specify background and the low four the
foreground. In both groups, low three bits set color (as in normal
color codes used by the console) and the most significant one turns
on highlight (or sometimes blinking -- it depends on the configuration
of your VGA).
third parameter
consists of character attribute bits you want to set.
Bit setting takes place before bit toggling, so you can simply clear a
bit by including it in both the set mask and the toggle mask.
.. [#f1] see ``#define TRIDENT_GLITCH`` in ``drivers/video/vgacon.c``.
Examples: Examples:
========= =========
To get normal blinking underline, use: echo -e '\033[?2c' To get normal blinking underline, use::
To get blinking block, use: echo -e '\033[?6c'
To get red non-blinking block, use: echo -e '\033[?17;0;64c' echo -e '\033[?2c'
To get blinking block, use::
echo -e '\033[?6c'
To get red non-blinking block, use::
echo -e '\033[?17;0;64c'