Flesh out the manual page, add an examples section, and correct some of the
English.
This commit is contained in:
parent
2aacd1b595
commit
7fe5a79110
|
@ -1,4 +1,4 @@
|
||||||
.\" $NetBSD: wsconsctl.8,v 1.3 1999/02/03 21:05:14 augustss Exp $
|
.\" $NetBSD: wsconsctl.8,v 1.4 1999/06/28 21:48:13 agc Exp $
|
||||||
.\"
|
.\"
|
||||||
.\" Copyright (c) 1998 The NetBSD Foundation, Inc.
|
.\" Copyright (c) 1998 The NetBSD Foundation, Inc.
|
||||||
.\" All rights reserved.
|
.\" All rights reserved.
|
||||||
|
@ -70,48 +70,111 @@ command displays or sets various wscons system driver variables.
|
||||||
If a list of variables is present on the command line, then
|
If a list of variables is present on the command line, then
|
||||||
.Nm
|
.Nm
|
||||||
prints the current value of those variables for the specified device.
|
prints the current value of those variables for the specified device.
|
||||||
If the
|
.Bl -tag -width Ds
|
||||||
.Fl a
|
.It Fl a
|
||||||
flag is specified, all variables for the device are printed.
|
is used to specify all variables for the device.
|
||||||
If the
|
.It Fl w
|
||||||
.Fl w
|
|
||||||
flag is specified
|
|
||||||
.Nm
|
.Nm
|
||||||
attempts to set or modify the specified variables to the given values.
|
attempts to set or modify the specified variables to the given values.
|
||||||
To set a variable the value is specified with an equal sign like
|
The value can be specified as either an absolute value, by using the
|
||||||
.Bd -literal -offset indent -compact
|
.Ar =
|
||||||
bell.pitch=1200
|
symbol
|
||||||
.Ed
|
or as a relative value, by using the
|
||||||
To modify a variable the value is specified like
|
.Ar +=
|
||||||
.Bd -literal -offset indent -compact
|
symbol. See the
|
||||||
bell.pitch+=200
|
.Ar EXAMPLES
|
||||||
.Ed
|
section for more details.
|
||||||
Not all variables can be modified.
|
.It Fl f Ar file
|
||||||
|
is used to specify an alternative control device.
|
||||||
|
.It Fl n
|
||||||
|
suppresses the printing of the variable name in the output -
|
||||||
|
only the value will appear.
|
||||||
|
.It Fl k
|
||||||
|
selects the keyboard portion of the device (this is the default).
|
||||||
|
.It Fl d
|
||||||
|
selects the display portion of the device.
|
||||||
|
.It Fl m
|
||||||
|
selects the mouse portion of the device.
|
||||||
|
.El
|
||||||
.Pp
|
.Pp
|
||||||
The
|
The
|
||||||
.Fl f
|
.Nm
|
||||||
flag can be used to give an alternative control device.
|
utility can be used to view and modify aspects of the keyboard,
|
||||||
|
display and mouse, using the standard, machine-independent
|
||||||
|
workstation console device driver
|
||||||
|
.Xr wscons 4 .
|
||||||
.Pp
|
.Pp
|
||||||
The
|
The keyboard type can be modified, the keyboard bell's pitch,
|
||||||
.Fl n
|
period and duration
|
||||||
flag suppresses printing of the variable name.
|
can be modified,
|
||||||
|
the
|
||||||
|
.Ar typematic
|
||||||
|
value can be changed, and the keyboard encoding can be modified
|
||||||
|
to switch keys, should the user find a keyboard's default layout
|
||||||
|
difficult to use.
|
||||||
|
The keyboard types and other relevant definitions,
|
||||||
|
can all be found in the
|
||||||
|
.Ar /usr/include/dev/wscons/wsconsio.h
|
||||||
|
file.
|
||||||
.Pp
|
.Pp
|
||||||
The
|
The mouse types are defined in the
|
||||||
.Fl k
|
.Ar /usr/include/dev/wscons/wsconsio.h
|
||||||
flag selects the keyboard portion of the device.
|
file.
|
||||||
If no flag out of
|
|
||||||
.Fl kdm
|
|
||||||
is given
|
|
||||||
.Fl k
|
|
||||||
is the default.
|
|
||||||
.Pp
|
.Pp
|
||||||
The
|
The keyboard types, and the height, width,
|
||||||
.Fl d
|
depth (bits per pixel), color map size, and colormap
|
||||||
flag selects the display portion of the device.
|
are defined in the
|
||||||
|
.Ar /usr/include/dev/wscons/wsconsio.h
|
||||||
|
file. There are also definitions relating to video
|
||||||
|
control and cursor control, which are not applicable to
|
||||||
|
all display types, and to text emulation and graphics
|
||||||
|
(mapped) modes.
|
||||||
.Pp
|
.Pp
|
||||||
The
|
There are currently keyboard encodings for the following
|
||||||
.Fl m
|
countries: user-defined, US, German, Danish, Italian,
|
||||||
flag selects the mouse portion of the device.
|
French, British and Japanese.
|
||||||
|
.Sh EXAMPLES
|
||||||
|
The following are just a few examples of
|
||||||
|
.Nm
|
||||||
|
and its functionality.
|
||||||
|
.Pp
|
||||||
|
.Dl wsconsctl -w encoding=uk
|
||||||
|
.Pp
|
||||||
|
Sets a UK keyboard encoding.
|
||||||
|
.Pp
|
||||||
|
.Dl wsconsctl -w map+="keysym Caps_Lock = Control_L"
|
||||||
|
.Pp
|
||||||
|
Modifies the current keyboard encoding so that, when the
|
||||||
|
.Ar Caps Lock
|
||||||
|
key is pressed, the same encoding sequence as
|
||||||
|
.Ar Left Control
|
||||||
|
is sent.
|
||||||
|
For a full list of keysyms, and keycodes, please refer
|
||||||
|
to the
|
||||||
|
.Ar /usr/include/dev/wscons/wsksymdef.h
|
||||||
|
file.
|
||||||
|
.Pp
|
||||||
|
.Dl wsconsctl -w encoding=us.swapctrlcaps
|
||||||
|
.Pp
|
||||||
|
sets a US keyboard encoding, with the
|
||||||
|
.Ar Caps Lock
|
||||||
|
and
|
||||||
|
.Ar Left Control
|
||||||
|
keys swapped. The
|
||||||
|
.Ar .swapctrlcaps
|
||||||
|
encoding does not work for all national keyboard encodings.
|
||||||
|
For most purposes, the ability to set the value returned
|
||||||
|
by the
|
||||||
|
.Ar Caps Lock
|
||||||
|
key is enough - see the previous example for details.
|
||||||
|
.Pp
|
||||||
|
.Dl wsconsctl -w bell.pitch=1200
|
||||||
|
.Pp
|
||||||
|
Sets the bell pitch to be 1200, whilst
|
||||||
|
.Pp
|
||||||
|
.Dl wsconsctl -w bell.pitch+=200
|
||||||
|
.Pp
|
||||||
|
adds 200 to the current pitch of the bell.
|
||||||
.Sh FILES
|
.Sh FILES
|
||||||
.Bl -tag -width /dev/wsmouse0
|
.Bl -tag -width /dev/wsmouse0
|
||||||
.It Pa /dev/wskbd0
|
.It Pa /dev/wskbd0
|
||||||
|
@ -122,6 +185,7 @@ mouse control device
|
||||||
display control device
|
display control device
|
||||||
.El
|
.El
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
|
.Xr pckbd 4 ,
|
||||||
.Xr wscons 4 ,
|
.Xr wscons 4 ,
|
||||||
.Xr wsconscfg 8 ,
|
.Xr wsconscfg 8 ,
|
||||||
.Xr wsfontload 8
|
.Xr wsfontload 8
|
||||||
|
|
Loading…
Reference in New Issue