aboutsummaryrefslogtreecommitdiff
path: root/share/man/man4/pcvt.4
diff options
context:
space:
mode:
authorRuslan Ermilov <ru@FreeBSD.org>2000-11-10 17:46:15 +0000
committerRuslan Ermilov <ru@FreeBSD.org>2000-11-10 17:46:15 +0000
commit726b61ab5fe782694f2bb648dafb316e1857335b (patch)
treed2e5d99341877d16e00411e70c7896f1ebf17207 /share/man/man4/pcvt.4
parentad736bbc897e0990877a55bb107384df25f46e17 (diff)
downloadsrc-726b61ab5fe782694f2bb648dafb316e1857335b.tar.gz
src-726b61ab5fe782694f2bb648dafb316e1857335b.zip
Notes
Diffstat (limited to 'share/man/man4/pcvt.4')
-rw-r--r--share/man/man4/pcvt.4184
1 files changed, 85 insertions, 99 deletions
diff --git a/share/man/man4/pcvt.4 b/share/man/man4/pcvt.4
index f5633e6449c2..61a234ec27c8 100644
--- a/share/man/man4/pcvt.4
+++ b/share/man/man4/pcvt.4
@@ -51,9 +51,8 @@ The
.Nm pcvt
driver provides a virtual screen handling system.
Probably most important is an emulation of a wide range
-of DEC VT-220
-.if t \(tm
-.if n (TM)
+of DEC
+.Tn VT-220
functionality.
See
.Sx Features
@@ -65,16 +64,14 @@ driver requires the keyboard driver
.Nm atkbd
to be also configured in the kernel.
.Ss Features
-.Bl -bullet
+.Bl -bullet -compact
.It
-Almost full DEC VT220
-.if t \(tm
-.if n (TM)
+Almost full DEC
+.Tn VT220
functionality
.Po
-moving towards VT320
-.if t \(tm
-.if n (TM)
+moving towards
+.Tn VT320
.Pc
.It
Completely independent virtual terminals for MDA/HGC/CGA/EGA and VGA
@@ -90,9 +87,7 @@ VT220 downloadable character set supported when run on EGA/VGA
VT220 user defined keys for each virtual terminal
.It
Optional function key label support
-.if t \('a
-.if n 'a
-la Hewlett-Packard terminals
+\('a la Hewlett-Packard terminals
.It
Display function codes functionality
.It
@@ -107,9 +102,10 @@ requires
to be defined
.Pc
.El
-
+.Pp
What it cannot:
-.Bl -bullet
+.Pp
+.Bl -bullet -compact
.It
No double wide/high characters
.It
@@ -149,13 +145,13 @@ provide appropriate
.Em options
lines within the config file, possibly overriding the built-in default
values.
-
+.Pp
The following list gives a short overview of the available configuration
options.
Refer to the file
.Pa i386/isa/pcvt/pcvt_conf.h
in the kernel source tree for detailed documentation.
-
+.Pp
Note: the following conventions apply to all the Boolean options.
If an option is given with no value, a value of 1
.Pq activated
@@ -165,14 +161,13 @@ deactivated.
Any other value is substituted by 1, too.
If an option
is omitted, a built-in default is assumed.
-
+.Pp
.Bl -tag -width indent -compact
-
.It Em PCVT_NSCREENS
Defines the number of virtual screens.
-.br
+.It No
Default: 8
-
+.Pp
.It Em PCVT_VT220KEYB
If activated, a keyboard layout resembling a DEC VT200 (TM) is generated.
If deactivated, a mixture between VT220 and HP is used.
@@ -183,36 +178,36 @@ and
in the
.Nm pcvt
documentation directory for a full description.
-.br
+.It No
Default: off
-
+.Pp
.It Em PCVT_SCREENSAVER
Enables the builtin screensaver feature.
-.br
+.It No
Default: on
-
+.Pp
.It Em PCVT_PRETTYSCRNS
If enabled, a blinking-star screensaver is used.
If disabled, the screen
is simply blanked
.Pq which might be useful for energy-saving monitors .
-.br
+.It No
Default: on
-
+.Pp
.It Em PCVT_CTRL_ALT_DEL
If enabled, the key combination
.Aq Em Ctrl
.Aq Em Alt
.Aq Em Del
invokes a CPU reset.
-.br
+.It No
Default: off
-
+.Pp
.It Em PCVT_USEKBDSEC
Do NOT override a security lock for the keyboard.
-.br
+.It No
Default: on
-
+.Pp
.It Em PCVT_24LINESDEF
If enabled, the 25-line modi
.Po
@@ -225,9 +220,9 @@ Note that this is a startup option; it is possible to toggle between
the 24- and 25-lines' display by the
.Xr scon 1
utility.
-.br
+.It No
Default: off
-
+.Pp
.It Em PCVT_META_ESC
If enabled, a sequence composed of
.Aq Em esc ,
@@ -237,10 +232,10 @@ key modifier.
If disabled, then normal key code with the value
.Em 0x80
added is sent.
-.br
+.It No
Default: off
.El
-
+.Pp
Note that there are further options available which are mainly used for
debugging purposes or as a workaround for hardware problems.
They are found in
@@ -254,15 +249,15 @@ related to the
.Nm pcvt
driver.
To make use of them, a program should contain the following line:
-
+.Pp
.Dl #include <machine/pcvt_ioctl.h>
-
+.Pp
Any parameter definitions cited below can be found in that file.
-
+.Pp
.Em Keyboard related functions
-
+.Pp
Three functions are related to basic keyboard hardware:
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It KBDRESET
reset keyboard, set defaults;
@@ -272,7 +267,7 @@ the values is stored to;
.It KBDSTPMAT
set current typematic value, similar to above command.
.El
-
+.Pp
Symbolic values are available for the appropriate constants.
To specify the initial typematic delay time, they are
KBD_TPD250 for 250 ms through
@@ -285,21 +280,19 @@ The intermediate values
are: 30.0, 26.7, 24.0, 21.8, 20.0, 18.5, 17.1, 16.0, 15.0, 13.3,
12.0, 10.9, 10.0, 9.2, 8.6, 8.0, 7.5, 6.7, 6.0, 5.5, 5.0, 4.6, 4.3,
4.0, 3.7, 3.3, 3.0, 2.7, 2.5, 2.3, 2.1, 2.0 characters per second.
-
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It KBDGREPSW
get key repetition switch, and
.It KBDSREPSW
set key repetition switch
.El
-
+.Pp
again take a pointer to int as argument.
They manipulate the
drivers internal keyboard repetition flag, possible values are:
KBD_REPEATOFF or KBD_REPEATON.
-
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It KBDGLEDS
get LED state, and
@@ -307,29 +300,28 @@ get LED state, and
set LED state manipulate the keyboard indicators, but do not influence
the drivers idea of lock key state.
.El
-
+.Pp
The int where the argument points to
may have the values
KBD_SCROLLLOCK, KBD_NUMLOCK, KBD_CAPSLOCK, which may be used in any
conjunction.
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It KBDGLOCK
gets state of SCROLL,NUM,CAPS, and
.It KBDSLOCK
sets state of SCROLL,NUM,CAPS + LEDs
.El
-
+.Pp
should be used in a same manner to get/set the drivers internal
LED flags.
-
-
+.Pp
.Em Keyboard remapping
-
+.Pp
One important feature of the
.Nm pcvt
driver is its ability to overload the built in key definition.
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It KBDGCKEY
get current key values,
@@ -338,13 +330,13 @@ set new key assignment values, and
.It KBDGOKEY
get original key assignment values
.El
-
+.Pp
arrange those functions.
The take a pointer to a
.Em struct kbd_ovlkey
as argument as described below.
In addition,
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It KBDRMKEY
removes a key assignment, taking a pointer to an int as argument which
@@ -367,11 +359,11 @@ struct kbd_ovlkey /* complete definition of a key */
char altgr[KBDMAXOVLKEYSIZE+1]; /* emitted string, altgr */
};
.Ed
-
+.Pp
The appropriate values for the
.Em type
field are:
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It KBD_NONE
no function, key is disabled,
@@ -407,20 +399,20 @@ or
.Dq Enter
keys.
.El
-
+.Pp
The
.Em subtype
field contains one of the values
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It KBD_SUBT_STR
key is bound to a string, or
.It KBD_SUBT_FNC
key is bound to a function.
.El
-
+.Pp
.Em Downloadable character set interface
-
+.Pp
EGA and VGA video adaptors provide the capability of downloadable
software fonts.
Since the
@@ -429,14 +421,14 @@ of any IBM-compatible PC video board does not allow the full interpretation
of DEC multinational character set or ISO Latin-1
.Pq ISO 8859-1 ,
this might be very useful for a U**X environment.
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It VGASETFONTATTR
set font attr, and
.It VGAGETFONTATTR
get font attr
.El
-
+.Pp
are used to manipulate the drivers information about a downloaded
font.
The take a pointer to a
@@ -451,14 +443,14 @@ struct vgafontattr {
int screen_scanlines; /* Scanlines per screen - 1 byte */
};
.Ed
-
+.Pp
Each character of each font is to be downloaded with
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It VGALOADCHAR
load vga char,
.El
-
+.Pp
taking a pointer to
.Em struct vgaloadchar
as its argument:
@@ -470,14 +462,14 @@ struct vgaloadchar {
u_char char_table[32]; /* VGA character shape table */
};
.Ed
-
+.Pp
The field
.Em character_set
takes the values
CH_SET0, CH_SET1, CH_SET2, CH_SET3 on EGA's or VGA's. Since VGA's
might have up to eight simultaneously loaded fonts, they can take
CH_SET4, CH_SET5, CH_SET6, or CH_SET7, too.
-
+.Pp
Note that there's a dependence between the font size
and a possible screen height
.Pq in character rows ,
@@ -492,15 +484,14 @@ Font size
8 x 16 not 25
applicable
.Ed
-
-
+.Pp
.Em General screen manipulation commands
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It VGACURSOR
sets cursor shape,
.El
-
+.Pp
taking a pointer to the following structure as argument:
.Bd -literal
struct cursorshape {
@@ -510,14 +501,14 @@ struct cursorshape {
int end; /* end scanline, range 0... Character Height - 1 */
};
.Ed
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It VGASETSCREEN
set screen info, and
.It VGAGETSCREEN
get screen info,
.El
-
+.Pp
provide an interface to some general driver internal variables
which might modify the behaviour of the screens,
or which might simply be used to force the driver to switch
@@ -558,18 +549,18 @@ struct screeninfo {
/* currently ignored on write */
};
.Ed
-
+.Pp
Its field
.Em pure_vt_mode
may take the values M_HPVT for a mixed VTxxx and HP Mode, with function
key labels and a status line, or M_PUREVT for only VTxxx sequences
recognized, with no labels.
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It VGASETCOLMS
sets the number of columns for the current screen,
.El
-
+.Pp
its parameter is a pointer to an integer containing either a value of 80,
or a value of 132.
Note that setting the number of columns to 132 is only supported on
@@ -579,9 +570,9 @@ Any unsupported numbers cause the ioctl to fail with
.Pq see Xr intro 2
being set to
.Em EINVAL .
-
+.Pp
.Em VGA color palette interface
-
+.Pp
Only on VGA adaptors, there's a color palette register at the output.
It is responsible for the red, green and blue output voltage provided
for each of the 256 internal color codes, each lying in the range of
@@ -590,14 +581,14 @@ Thus, these adaptors map each color code to a color of a
.Dq palette
out of 262144 colors.
The commands
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It VGAREADPEL
read VGA palette entry, and
.It VGAWRITEPEL
write VGA palette entry
.El
-
+.Pp
establish an interface to these palette registers.
Their argument is
a pointer to:
@@ -607,17 +598,15 @@ struct vgapel {
unsigned r, g, b; /* RGB values, masked by VGA_PMASK (63) */
};
.Ed
-
-
+.Pp
.Em Driver identification
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It VGAPCVTID
returns information if the current compiled in driver is pcvt and it's
major and minor revision numbers. the call is taking a pointer to the
following structure as argument:
.El
-
.Bd -literal
struct pcvtid {
#define PCVTIDNAMELN 16 /* driver id - string length */
@@ -629,15 +618,13 @@ struct pcvtid {
#define PCVTIDMINOR 00
};
.Ed
-
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It VGAPCVTINFO
returns information if the current compiled in driver is pcvt and it's
compile time options. the call is taking a pointer to the following
structure as argument:
.El
-
.Bd -literal
struct pcvtinfo {
u_int opsys; /* PCVT_xxx(x)BSD */
@@ -659,21 +646,20 @@ struct pcvtinfo {
u_long compile_opts; /* PCVT_xxxxxxxxxxxxxxx */
};
.Ed
-
-
+.Pp
.Em Screen saver
-
+.Pp
Depending on the configuration of a
.Nm pcvt
driver, their might be a simple screen saver available.
It is controlled
by the command
-
+.Pp
.Bl -tag -width 20n -offset indent -compact
.It VGASCREENSAVER
set timeout for screen saver in seconds; 0 turns it off,
.El
-
+.Pp
taking a pointer to an integer as argument.
Despite of its command name,
this is available on
@@ -682,9 +668,9 @@ kind of adaptor if configured in by the
.Xr config 8
option
.Dq PCVT_SCREENSAVER
-
+.Pp
.Em Compatibility commands for USL-style VT's
-
+.Pp
.Nm pcvt
supports a subset of the USL-style commands used to control
the virtual terminal interface.
@@ -697,7 +683,6 @@ They are ugly with respect to the implied semantics
See the file
.Pa i386/include/pcvt_ioctl.h
for their documentation.
-
.Sh FILES
.Bl -tag -width /usr/include/machine/pcvt_ioctl.h
.It Pa /usr/include/machine/pcvt_ioctl.h
@@ -730,14 +715,15 @@ Written by
with much help from
.An Brian Dunford-Shore Aq brian@morpheus.wustl.edu
and
-.An Joerg Wunsch Aq joerg@FreeBSD.org
+.An J\(:org Wunsch Aq joerg@FreeBSD.org
.Pp
This driver is based on several people's previous work, notably
the historic
.Xr pccons 4
implementation by
-.An William Jolitz and Don Ahn Aq ljolitz@cardio.ucsf.edu
-.br
+.An William Jolitz Aq ljolitz@cardio.ucsf.edu
+and
+.An Don Ahn ,
and the keyboard mapping code from
.An Holger Veit Aq veit@first.gmd.de.
.Sh SEE ALSO