diff options
Diffstat (limited to 'sys')
| -rw-r--r-- | sys/arch/i386/isa/pcvt/Util/pcvtdoc/pcvt.4 | 417 |
1 files changed, 176 insertions, 241 deletions
diff --git a/sys/arch/i386/isa/pcvt/Util/pcvtdoc/pcvt.4 b/sys/arch/i386/isa/pcvt/Util/pcvtdoc/pcvt.4 index c9ce747b680..0e310a9c024 100644 --- a/sys/arch/i386/isa/pcvt/Util/pcvtdoc/pcvt.4 +++ b/sys/arch/i386/isa/pcvt/Util/pcvtdoc/pcvt.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pcvt.4,v 1.23 2000/09/11 01:25:53 aaron Exp $ +.\" $OpenBSD: pcvt.4,v 1.24 2000/10/05 14:25:59 aaron Exp $ .\" .\" Copyright (c) 1992, 1995 Hellmuth Michaelis, Brian Dunford-Shore, .\" Joerg Wunsch and Holger Veit. @@ -58,7 +58,6 @@ see below .Pc .Pp -device .Em vt0 at .Em isa? @@ -69,20 +68,21 @@ irq .Sh DESCRIPTION .Ss Overview The -.Nm pcvt +.Nm driver provides a virtual screen system with several additional features not available in .Xr pc 4 -standard console device driver. Besides the ability of handling -multiple virtual screens, +standard console device driver. +Besides the ability of handling multiple virtual screens, probably the most important is an emulation of a wide range of DEC VT-220 .if t \(tm .if n (TM) -functionality. See +functionality. +See .Sx Features for a detailed description. - +.Pp .Sy Note: As of .Ox 2.6 , @@ -94,7 +94,6 @@ See the flag in .Xr scon 1 to toggle between this mode and the old mode. - .Ss VT Keys Despite the complexity of options, if installed in a normal .Ox @@ -102,21 +101,23 @@ configuration with the default options, on a standard i386 architecture system, you can use multiple virtual terminals. The key sequence used to move among virtual terminals are, at least on a North American keyboard, -.Em CTRL+ALT+Fn, +.Em CTRL+ALT+Fn , where .Em n can be from one to four on the standard system or higher if you -have created additional /dev/ttyC* entries. - -One can also cycle through all available screens by using -.Em ALT+F12 - +have created additional +.Pa /dev/ttyC* +entries. +.Pp To use the scrollback feature, press .Em LEFT_SHIFT+PGUP/PGDN -(more info further) - +(more info further on this further down). .Ss Features -.Bl -bullet +The +.Nm +driver includes the following features: +.Pp +.Bl -bullet -compact .It Almost full DEC VT220 .if t \(tm @@ -140,19 +141,16 @@ VT220 downloadable character set supported when run on EGA/VGA .It VT220 user defined keys for each virtual terminal .It -Optional function key label support -.if t \('a -.if n 'a -la Hewlett-Packard -.It Display function codes functionality .It -Support for MDA, CGA, EGA and VGA display adaptors +Support for MDA, CGA, EGA, and VGA display adaptors .It -Support for 132 column operation on VGA chipsets +Support for 132 column operation on some VGA chipsets .It Scrollback buffer .It +Console mouse support +.It X Window Support for XFree86 >= 1.2 using the pccons model, or for XFree86 >= 2.0 using the syscons model .Po @@ -161,9 +159,10 @@ requires to be configured .Pc .El - +.Pp What it cannot: -.Bl -bullet +.Pp +.Bl -bullet -compact .It No double wide/high characters .It @@ -180,53 +179,51 @@ No 8-bit controls Only limited AT-keyboard .Pq 84 keys support -.Pq yet -.It -Help you to make money... .El - .Ss Configuration The -.Nm pcvt +.Nm driver has been designed to be highly configurable in order to satisfy -everyone's needs. The preferred way for those configurations is to -provide appropriate +everyone's needs. +The preferred way for those configurations is to provide appropriate .Em option -lines within the config file, possibly overriding the built-in default -values. Therefore it is possible to compile several distinct kernels +lines within the config file, possibly overriding the built-in default values. +Therefore it is possible to compile several distinct kernels with different driver behaviour on a single machine. - +.Pp The following list gives a short overview of the available configuration -options. Refer to the file +options. +Refer to the file .Pa arch/i386/isa/pcvt/pcvt_hdr.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 -is substituted. If an option value is given as 0, this options is -deactivated. Any other value is substituted by 1, too. If an option -is omitted, a built-in default is assumed. - +is substituted. +If an option value is given as 0, this options is 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 - +.Pp .It Em PCVT_NSCREENS Defines the number of virtual screens. .br Default: 8 - +.Pp .It Em PCVT_SCREENSAVER Enables the built-in screensaver feature. .br Default: on - +.Pp .It Em PCVT_PRETTYSCRNS -If enabled, a blinking-star screensaver is used. If disabled, the screen -is simply blanked +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 Default: off - +.Pp .It Em PCVT_CTRL_ALT_DEL If enabled, the key combination .Aq Em Ctrl @@ -239,19 +236,20 @@ Default: off (To change this, check , set value of .Em machdep.kbdreset to 1) - +.Pp .It Em PCVT_USEKBDSEC Do NOT override a security lock for the keyboard. .br Default: on - +.Pp .It Em PCVT_24LINESDEF If enabled, the 25-line modi .Po VT emulation with 25 lines .Pc defaults to 24 lines only to provide a better compatibility to the -original DEV VT220 (TM). Thus it should be possible to use the +original DEV VT220 (TM). +Thus it should be possible to use the terminal information for those terminals without further changes. Note that this is a startup option; it is possible to toggle between the 24- and 25-lines' display by the @@ -259,45 +257,42 @@ the 24- and 25-lines' display by the utility. .br Default: off - +.Pp .It Em PCVT_META_ESC If enabled, a sequence composed of .Aq Em esc , followed by the normal key code is emitted if a key is pressed with the .Aq Em Alt -key modifier. If disabled, then normal key code with the value +key modifier. +If disabled, then normal key code with the value .Em 0x80 added is sent. .br 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 +debugging purposes or as a workaround for hardware problems. +They are found in .Pa arch/i386/isa/pcvt/pcvt_hdr.h along with their documentation. - .Ss Internal Functions The functionality described below may be accessed via .Xr ioctl 2 system calls with a file descriptor opened on a device node related to the -.Nm pcvt +.Nm 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; @@ -307,31 +302,31 @@ 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 -KBD_TPD1000 for 1000 ms, in steps of 250 ms. The typematic repeat -rates are +KBD_TPD1000 for 1000 ms, in steps of 250 ms. +The typematic repeat rates are KBD_TPM300, specifying 30.0 characters per second through -KBD_TPM20 for 2.0 characters per second. The intermediate values -are: 30.0, 26.7, 24.0, 21.8, 20.0, 18.5, 17.1, 16.0, 15.0, 13.3, +KBD_TPM20 for 2.0 characters per second. +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 - -Again take a pointer to int as its argument. They manipulate the +.Pp +Again take a pointer to int as its argument. +They manipulate the driver's 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 @@ -339,29 +334,29 @@ get LED state, and set LED state manipulate the keyboard indicators, but do not influence the driver's 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 These functions should be used in a same manner to get/set the driver's internal LED flags. - - +.Pp +.Pp .Em Keyboard remapping - +.Pp One important feature of the -.Nm pcvt +.Nm 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, @@ -370,11 +365,13 @@ set new key assignment values, and .It KBDGOKEY get original key assignment values .El - -Arrange those functions. They take a pointer to a +.Pp +Arrange those functions. +They take a pointer to a .Em struct kbd_ovlkey -argument as described below. In addition, - +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 its argument which @@ -397,11 +394,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, @@ -437,102 +434,39 @@ 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 - -.Em Mouse emulation - -The mouse emulator -.Pq if configured in -fakes a three-button mouse using the Mouse Systems protocol. The first -.Nm pcvt -device node not used by a virtual screen is the mouse device. I.\& e., -for the default value of 8 virtual screens, -.Pa /dev/ttyC0 -through -.Pa /dev/ttyC7 -would refer to the virtual screens, and -.Pa /dev/ttyC8 -were the mouse emulator device. The mouse emulation is turned on by -pressing the -.Aq Em NumLock -key. The pointer is moved by the numerical keypad keys, into the -obvious directions. The pointer is initially moved in single steps, -and is accelerated after an adjustable time -.Pq default: 500 ms -by about 6 times. The mouse buttons are emulated by three normal -keys, by default the function keys -.Aq Em \&F1 , -.Aq Em \&F2 , -and -.Aq Em \&F3 . -There are two selectable flavors available: normal and -.Dq sticky -buttons. Normal buttons behave as expected. -.Dq Sticky -buttons are notified as button-press on the first keypress. They -.Dq stick -until the key is pressed again -.Pq or another button-emulating key instead . -Button presses and releases are notified to the user by a simple -.Dq pling , -or -.Dq plong , -respectively, generated from the PC's built-in speaker. - -The following commands control the emulation. - -.Bl -tag -width 20n -offset indent -compact -.It KBDMOUSEGET -get the current definitions, and -.It KBDMOUSESET -set new definitions. -.El - -Both accept a -.Li struct mousedefs * -as the third argument to the ioctl call: -.Bd -literal -struct mousedefs { - int leftbutton; /* (PC) scan code for "left button" key */ - int middlebutton; /* (PC) scan code for "mid button" key */ - int rightbutton; /* (PC) scan code for "right button" key */ - int stickybuttons; /* if true, the buttons are "sticky" */ - int acceltime; /* timeout in microseconds to start pointer */ - /* movement acceleration */ - /* defaults to: scan(F1), scan(F2), scan(F3), false, 500000 */ -}; -.Ed - - +.Pp .Em Downloadable character set interface - +.Pp EGA and VGA video adaptors provide the capability of downloadable -software fonts. Since the +software fonts. +Since the .Sq native character set 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 These functions are used to manipulate the driver's information about a -downloaded font. They take pointers to a +downloaded font. +They take pointers to a .Em struct vgafontattr as their arguments: .Bd -literal @@ -544,14 +478,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: @@ -563,14 +497,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_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 , @@ -585,15 +519,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 its argument: .Bd -literal struct cursorshape { @@ -603,18 +536,19 @@ 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 -to one certain screen. Their argument is a pointer to the structure: +to one certain screen. +Their argument is a pointer to the structure: .Bd -literal struct screeninfo { int adaptor_type; /* type of video adaptor installed */ @@ -647,57 +581,58 @@ struct screeninfo { /* currently ignored on write */ }; .Ed - +.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 VGA adaptors. Any unsupported numbers cause the ioctl -to fail with +or a value of 132. +Note that setting the number of columns to 132 is +only supported on VGA adaptors. +Any unsupported numbers cause the ioctl to fail with .Va errno .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 0 through 63 (with 63 representing the brightest value for a base color). Thus, these adaptors map each color code to a color of a .Dq palette -out of 262144 colors. The commands - +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 - -establish an interface to these palette registers. Their argument is -a pointer to: +.Pp +establish an interface to these palette registers. +Their argument is a pointer to: .Bd -literal struct vgapel { unsigned idx; /* index into palette, 0 .. 255 valid */ 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 its -major and minor revision numbers. the call is taking a pointer to the -following structure as its argument: +major and minor revision numbers. +The call is taking a pointer to the following structure as its argument: .El - +.Pp .Bd -literal struct pcvtid { #define PCVTIDNAMELN 16 /* driver id - string length */ @@ -709,15 +644,14 @@ 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 its -compile time options. the call is taking a pointer to the following -structure as its argument: +compile time options. +The call is taking a pointer to the following structure as its argument: .El - +.Pp .Bd -literal struct pcvtinfo { u_int opsys; /* PCVT_xxx(x)BSD */ @@ -735,30 +669,29 @@ 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 - +.Nm +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 - -taking a pointer to an integer as its argument. Despite of its command name, -this is available on +.Pp +taking a pointer to an integer as its argument. +Despite of its command name, this is available on .Em any kind of adaptor if configured in by the .Xr config 8 option .Dq PCVT_SCREENSAVER - +.Pp .Em Scrollback buffer - +.Pp It is often useful to be able to review text that has already scrolled off the screen. By default, 8 pages of scrollback buffer are available by navigating with the @@ -771,45 +704,49 @@ To increase the number of pages stored, see the .Fl b option for .Xr scon 1 . - +.Pp Scrollback support was added in .Ox 2.6 . - +.Pp .Em Compatibility commands for USL-style VT's - +.Pp Release 3.00 of this -.Nm pcvt +.Nm driver supports a subset of the USL-style commands used to control -the virtual terminal interface. This feature is mainly intended to -allow +the virtual terminal interface. +This feature is mainly intended to allow .Em XFree86 , release 2.0 or higher, to switch between virtual screens even when -running an X server. They are ugly with respect to the implied semantics +running an X server. +They are ugly with respect to the implied semantics .Pq i.\& e., they break Berkeley semantics -and are therefore not recommended for common use. See the file +and are therefore not recommended for common use. +See the file .Pa i386/include/pcvt_ioctl.h for their documentation. - .Sh FILES -.Bl -tag -width /usr/include/machine/pcvt_ioctl.h +.Bl -tag -width /sys/arch/i386/isa/pcvt/pcvt_hdr.h -compact .It Pa /usr/include/machine/pcvt_ioctl.h -Definitions for .Xr ioctl 2 -function calls +function call definitions .It Pa /dev/ttyC? +individual virtual terminal devices .It Pa /dev/console -Device nodes to access the +device node for +.Nm +access +.It Pa /dev/pcvtctl +.Xr moused 8 +communication device +.It Pa /sys/arch/i386/isa/pcvt/pcvt_hdr.h +documents the various compile-time options to tailor .Nm pcvt -driver -.It Pa arch/i386/isa/pcvt/pcvt_hdr.h -.Pq relative to the kernel source tree -Documents the various compile-time options to tailor -.Nm pcvt . .Sh HISTORY The -.Nm pcvt -driver has been developed for and contributed to 386BSD release 0.1. Since -release 3.00 explicit support is provided for NetBSD 0.9. It is expected +.Nm +driver has been developed for and contributed to 386BSD release 0.1. +Since release 3.00 explicit support is provided for NetBSD 0.9. +It is expected that no further development on pcvt is done for 386BSD 0.1 after release 3.00, in fact, 386BSD support was dropped with release 3.20. .Sh AUTHORS @@ -825,8 +762,7 @@ Brian Dunford-Shore .if t J\(:org Wunsch .Pq joerg_wunsch@uriah.sax.de .br -.It This driver is based on several people's previous -.It work, notably by : +.It "This driver is based on several people's previous work, notably by:" William Jolitz' and Don Ahn's .Xr pc 4 implementation @@ -847,10 +783,10 @@ Holger Veit .Xr config 8 , .Xr ispcvt 8 .Sh BUGS -Certainly existent. See the file +Certainly existent. +See the file .Pa BugList in the Documentation directory for an up-to-date list. - .Ss Tested Video Boards .Bd -literal Manufacturer Chipset Monitor @@ -864,7 +800,6 @@ NoName Hercules W86855AF Mono Kyocera (Mainboard) WD90C11 Sony Color unknown ET3000 NEC 3D .Ed - .Ss Tested Keyboards .Bd -literal Manufacturer Type Layout @@ -878,7 +813,7 @@ Tatung AT German There is absolutely NO support for the ancient PC-keyboards .Pq they had 83 keys . - +.Pp There is only limited support for AT-keyboards .Bo they have 84 keys, and a separate numeric keypad, @@ -889,5 +824,5 @@ the current design of the keyboard driver there is no .Pq full support for national keyboards because of the lack of an ALtGr key. - +.Pp MF-keyboards are fully supported, 101- and 102-key versions. |