diff options
author | Aaron Campbell <aaron@cvs.openbsd.org> | 2000-07-02 21:00:45 +0000 |
---|---|---|
committer | Aaron Campbell <aaron@cvs.openbsd.org> | 2000-07-02 21:00:45 +0000 |
commit | 1770191eb5e22a091b21ba50cc8c8c3af40e04cf (patch) | |
tree | 9e895639fc963684999d38ec763d397314cd9ec4 /usr.sbin | |
parent | e872f17e5df74f8be629e09cc2414e360c91797c (diff) |
OpenBSD'ify these man pages.
Diffstat (limited to 'usr.sbin')
-rw-r--r-- | usr.sbin/wsconscfg/wsconscfg.8 | 86 | ||||
-rw-r--r-- | usr.sbin/wsfontload/wsfontload.8 | 71 |
2 files changed, 97 insertions, 60 deletions
diff --git a/usr.sbin/wsconscfg/wsconscfg.8 b/usr.sbin/wsconscfg/wsconscfg.8 index f3c3dc677be..5e04bf38f83 100644 --- a/usr.sbin/wsconscfg/wsconscfg.8 +++ b/usr.sbin/wsconscfg/wsconscfg.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: wsconscfg.8,v 1.1 2000/07/02 01:25:24 mickey Exp $ +.\" $OpenBSD: wsconscfg.8,v 1.2 2000/07/02 21:00:43 aaron Exp $ .\" $NetBSD: wsconscfg.8,v 1.5 1999/05/15 14:45:06 drochner Exp $ .\" .Dd January 12, 1999 @@ -8,7 +8,7 @@ .Nm wsconscfg .Nd configure virtual terminals on a wscons display .Sh SYNOPSIS -.Nm +.Nm wsconscfg .Op Fl f Ar <ctldev> .Op Fl d Op Fl F .Op Fl k @@ -19,15 +19,16 @@ .Sh DESCRIPTION The .Nm -tool allows to create and delete virtual terminals on display devices -controlled by the wscons terminal framework if the underlying display hardware -driver supports multiple screens. Further it controls the assignment of -keyboards to displays. +tool allows the creation and removal of virtual terminals on display devices +controlled by the wscons terminal framework, as long as the underlying display +hardware driver supports multiple screens. +Further, it controls the assignment of keyboards to displays. +.Pp The .Ar index -argument specifies which virtual terminal is to be configured; the allowed -numbers are from 0 to an implementation-specified value (currently 7, allowing -for 8 virtual terminals on a display). +argument specifies which virtual terminal is to be configured. +The allowed numbers are from 0 to an implementation-specified value +(currently 7, allowing for 8 virtual terminals on a display). In keyboard configuration mode, it specifies the .Xr wskbd 8 device to attach or detach. @@ -35,18 +36,21 @@ Without further option arguments, a virtual terminal is created with implementation specific properties and a default terminal emulation variant selected at kernel compile time. .Pp -The options are: -.Bl -tag -width xxxxxxxxx +The options are as follows: +.Bl -tag -width Fl .It Fl f Ar ctldev Specify the control device of the wscons display to operate on. Default is .Pa /dev/ttyEcfg . .It Fl d -Delete the specified terminal. A terminal opened by a program will not be -deleted unless the +Delete the specified terminal. +Any specified terminal that is currently open by a program will not be deleted +unless the .Fl F -option is applied. Terminals used by the operating system console or a -graphics program (X server) cannot be deleted. With the +option is also given. +Terminals used by the operating system console or a graphics program (X server) +cannot be deleted. +With the .Fl k flag, the keyboard specified by .Dq index @@ -60,20 +64,24 @@ will be detached from the wscons display. Force deleting of a terminal even if it is in use by a user space program. .It Fl k Do keyboard related operations instead of virtual screen configuration. -Without other flags, a keyboard will be attached to the display device. The +Without other flags, a keyboard will be attached to the display device. +The .Dq index argument can be omitted, in this case the first free keyboard will be used. .It Fl m Do multiplexor related operations instead of virtual screen configuration. Without other flags, a multiplexor will be attached to the display device. .It Fl t Ar type -Specify a screen type to use. Screen types refer to display format, colour -depth and other low-level display properties. Valid +Specify a screen type to use. +Screen types refer to display format, color depth, and other low-level +display properties. +Valid .Ar type arguments are defined by the underlying display device driver. .It Fl e Ar emul -Specify the terminal emulation to use for the virtual terminal. The set of -available terminal emulations is determined at kernel compile time. See +Specify the terminal emulation to use for the virtual terminal. +The set of available terminal emulations is determined at kernel compile time. +See .Xr wscons 4 for details. .El @@ -85,29 +93,43 @@ utility will be invoked in system startup by the script, controlled by the .Pa /etc/wscons.conf configuration file. -.Sh FILES -.Pa /etc/wscons.conf .Sh EXAMPLES +The following examples demonstrate the functionality of +.Nm wsconscfg . +.Pp .Dl wsconscfg -t 80x50 -e vt100 1 .Pp -Configure screen 1 (i.e. the second), it will get the type +Configure screen 1 (i.e., the second) for type .Dq 80x50 -and use the VT100 terminal emulation. (Note: +and VT100 terminal emulation. +(Note: .Dq 80x50 is a screen type offered by the .Xr vga 4 -display driver. In this particular case, an 8x8-font must be loaded -before to make the screen useful. See -.Xr wsfontload 8 .) +display driver. +In this particular case, an 8x8-font must be loaded beforehand to make the +screen useful. +See +.Xr wsfontload 8 . ) .Pp .Dl wsconscfg -k .Pp Connect the first unconnected keyboard to the display. -.Sh BUGS -There should be an easy way to get a list of the screen types available -on a display, and of the emulations supported by the kernel. +.Sh FILES +.Bl -tag -width /etc/wscons.conf -compact +.It Pa /etc/wscons.conf +wscons configuration file +.El .Sh SEE ALSO .Xr wscons 4 , -.Xr wskbd 8 , .Xr wsconsctl 8 , -.Xr wsfontload 8 +.Xr wsfontload 8 , +.Xr wskbd 8 +.Sh HISTORY +The +.Nm +program appeared in +.Ox 2.8 . +.Sh BUGS +There should be an easy way to get a list of the screen types available +on a display, and of the emulations supported by the kernel. diff --git a/usr.sbin/wsfontload/wsfontload.8 b/usr.sbin/wsfontload/wsfontload.8 index 1f9c154bb2d..4a55c965e99 100644 --- a/usr.sbin/wsfontload/wsfontload.8 +++ b/usr.sbin/wsfontload/wsfontload.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: wsfontload.8,v 1.1 2000/07/02 01:29:44 mickey Exp $ +.\" $OpenBSD: wsfontload.8,v 1.2 2000/07/02 21:00:44 aaron Exp $ .\" $NetBSD: wsfontload.8,v 1.5 1999/04/06 04:54:22 cgd Exp $ .\" .Dd January 13, 1999 @@ -8,9 +8,9 @@ .Nm wsfontload .Nd load a font bitmap into a wscons display device .Sh SYNOPSIS -.Nm "" +.Nm wsfontload .Bk -words -.Op Fl f Ar ctldev +.Op Fl f Ar file .Ek .Bk -words .Op Fl w Ar width @@ -35,7 +35,7 @@ The .Nm utility loads a font bitmap to a wscons device if the device driver -supports this. +supports it. The font gets assigned a name in this process which it can be referred to by later for use on a display screen. The font is loaded from the specified @@ -46,28 +46,31 @@ if .Ar fontfile is not provided. .Pp -The options are: +The options are as follows: .Bl -tag -width xxxxxxxxxxx -.It Fl f Ar ctldev +.It Fl f Ar file Specify the control device of the wscons display to operate on. Default is .Pa /dev/ttyEcfg . .It Fl w Ar width -Sets the width of a font character in pixels. Default is 8. +Sets the width of a font character in pixels. +Default is 8. .It Fl h Ar height -Sets the width of a font character in pixels. Default is 16. +Sets the height of a font character in pixels. +Default is 16. .It Fl e Ar encoding -Sets the encoding of the font. This can be either a symbolic abbreviation -or a numeric value. Currently recognized abbreviations are +Sets the encoding of the font. +This can be either a symbolic abbreviation or a numeric value. +Currently recognized abbreviations are .Dq iso for ISO-8859-1 encoding, .Dq ibm -for IBM encoded fonts and -.Dq pcvt -for the custom encoding of the supplemental fonts which came with -the BSD +for IBM encoded fonts, and .Dq pcvt -console driver. Per default, +for the custom encoding of the supplemental fonts which came with the BSD +.Xr pcvt 4 +console driver. +Per default, .Dq iso is assumed. .It Fl N Ar name @@ -76,11 +79,11 @@ In none is given, the .Ar fontfile name is used to create one. .It Fl b -Specifies that the font data is ordered right-to-left bit wise. The default -is left-to-right. +Specifies that the font data is ordered right-to-left bit wise. +The default is left-to-right. .It Fl B -Specifies that the font data is ordered right-to-left byte wise. The default -is left-to-right. +Specifies that the font data is ordered right-to-left byte wise. +The default is left-to-right. .El .Pp Typically, the @@ -91,26 +94,38 @@ script, controlled by the .Pa /etc/wscons.conf configuration file. .Pp -No font files are provided with the wscons framework. The fonts installed by +No font files are provided with the wscons framework. +The fonts installed by .Xr pcvt 4 can be used instead, as can raw font files from other operating system distributions. -.Sh FILES -.Pa /etc/wscons.conf .Sh EXAMPLES +The following examples demonstrate the functionality of +.Nm wsfontload . +.Pp .Dl wsfontload -N myname -h 8 -e ibm /usr/share/pcvt/fonts/vt220l.808 .Pp Load the IBM-encoded 8x8-font from the .Xr pcvt 4 -distribution. This (or another 8x8-font) is necessary to use the -50-line screen type on +distribution. +This (or another 8x8-font) is necessary to use the 50-line screen type on .Xr vga 4 displays. -.Sh BUGS -Many features are missing. -.Pp -There is no way ro remove a loaded font. +.Sh FILES +.Bl -tag -width /etc/wscons.conf -compact +.It Pa /etc/wscons.conf +wscons configuration file +.El .Sh SEE ALSO .Xr wscons 4 , .Xr wsconscfg 8 , .Xr wsconsctl 8 +.Sh HISTORY +The +.Nm +program appeared in +.Ox 2.8 . +.Sh BUGS +Many features are missing. +.Pp +There is no way to remove a loaded font. |