Correct a few typos &/ spellos. Start new sentences on a new line.
This commit is contained in:
heas
parent
bd7049448e
commit
8bb92045b9
|
|
@ -1,4 +1,4 @@
|
|||
.\" $NetBSD: wsdisplay.4,v 1.19 2003/06/27 18:54:09 wiz Exp $
|
||||
.\" $NetBSD: wsdisplay.4,v 1.20 2004/01/20 18:31:18 heas Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 1999 Matthias Drochner.
|
||||
.\" Copyright (c) 2002 Ben Harris.
|
||||
|
|
@ -56,29 +56,32 @@ The
|
|||
.Nm
|
||||
driver is an abstraction layer for display devices within the
|
||||
.Xr wscons 4
|
||||
framework. It attaches to the hardware specific display device
|
||||
driver and and makes it available as text terminal or graphics
|
||||
interface.
|
||||
framework.
|
||||
It attaches to the hardware specific display device driver and makes it
|
||||
available as a text terminal or graphics interface.
|
||||
.Pp
|
||||
A display device can have the ability to display characters on it
|
||||
(without help of an X server), either directly by hardware or through
|
||||
(without the help of an X server), either directly by hardware or through
|
||||
software putting pixel data into the display memory.
|
||||
Such displays are called
|
||||
.Dq emulating ,
|
||||
the
|
||||
.Nm
|
||||
driver will connect a terminal emulation module and provide a
|
||||
tty-like software interface. In contrary, non-emulating displays can only
|
||||
be used by special programs like X servers.
|
||||
driver will connect a terminal emulation module and provide a tty-like
|
||||
software interface.
|
||||
In contrary, non-emulating displays can only be used by special programs
|
||||
like X servers.
|
||||
.Pp
|
||||
The
|
||||
.Em console
|
||||
locator in the configuration line refers to the device's use as output
|
||||
part of the operating system console. A device specification containing
|
||||
a positive value here will only match if the device is in use as system
|
||||
console. (The console device selection in early system startup is not
|
||||
influenced.) This way, the console device can be connected to a known
|
||||
wsdisplay device instance. (Naturally, only
|
||||
locator in the configuration line refers to the device's use as the output
|
||||
part of the operating system console.
|
||||
A device specification containing a positive value here will only match if
|
||||
the device is in use as the system console.
|
||||
(The console device selection in early system startup is not influenced.)
|
||||
This way, the console device can be connected to a known wsdisplay device
|
||||
instance.
|
||||
(Naturally, only
|
||||
.Dq emulating
|
||||
display devices are usable as console.)
|
||||
.Pp
|
||||
|
|
@ -86,8 +89,8 @@ The
|
|||
.Em kbdmux
|
||||
locator in the configuration line refers to the
|
||||
.Xr wsmux 4
|
||||
that will be used to get keyboard events. If this locator is -1 no
|
||||
mux will be used.
|
||||
that will be used to get keyboard events.
|
||||
If this locator is -1 no mux will be used.
|
||||
.Pp
|
||||
The logical unit of an independent contents displayed on a display
|
||||
(sometimes referred to as
|
||||
|
|
@ -95,7 +98,8 @@ The logical unit of an independent contents displayed on a display
|
|||
) is called a
|
||||
.Dq screen
|
||||
here. If the underlying device driver supports it, multiple screens can
|
||||
be used on one display. (As of this writing, only the
|
||||
be used on one display.
|
||||
(As of this writing, only the
|
||||
.Xr vga 4
|
||||
and the
|
||||
.Tn VAX
|
||||
|
|
@ -125,11 +129,13 @@ The following
|
|||
.Xr ioctl 2
|
||||
calls are provided by the
|
||||
.Nm
|
||||
driver or by devices which use it. Their definitions are found in
|
||||
driver or by devices which use it.
|
||||
Their definitions are found in
|
||||
.Aq Pa dev/wscons/wsconsio.h .
|
||||
.Bl -tag -width Dv
|
||||
.It Dv WSDISPLAYIO_GTYPE Pq Li int
|
||||
Retrieve the type of the display. The list of types is in
|
||||
Retrieve the type of the display.
|
||||
The list of types is in
|
||||
.Aq Pa dev/wscons/wsconsio.h .
|
||||
.It Dv WSDISPLAYIO_GINFO Pq Li "struct wsdisplay_fbinfo"
|
||||
Retrieve basic information about a framebuffer display.
|
||||
|
|
@ -147,7 +153,8 @@ The
|
|||
.Va height
|
||||
and
|
||||
.Va width
|
||||
members are counted in pixels. The
|
||||
members are counted in pixels.
|
||||
The
|
||||
.Va depth
|
||||
member indicates the number of bits per pixel, and
|
||||
.Va cmsize
|
||||
|
|
@ -157,7 +164,8 @@ and
|
|||
.Dv WSDISPLAYIO_PUTCMAP .
|
||||
This call is likely to be unavailable on text-only displays.
|
||||
.It Dv WSDISPLAYIO_GETCMAP Pq Li "struct wsdisplay_cmap"
|
||||
Retrieve the current color map from the display. This call needs the
|
||||
Retrieve the current color map from the display.
|
||||
This call needs the
|
||||
following structure set up beforehand:
|
||||
.Bd -literal -offset indent
|
||||
struct wsdisplay_cmap {
|
||||
|
|
@ -173,7 +181,8 @@ The
|
|||
.Va index
|
||||
and
|
||||
.Va count
|
||||
members specify the range of color map entries to retrieve. The
|
||||
members specify the range of color map entries to retrieve.
|
||||
The
|
||||
.Va red ,
|
||||
.Va green ,
|
||||
and
|
||||
|
|
@ -182,11 +191,13 @@ members should each point to an array of
|
|||
.Va count
|
||||
.Li u_char Ns s .
|
||||
On return, these will be filled in with the appropriate entries from the
|
||||
color map. On all displays that support this call, values range from 0
|
||||
for minimum intensity to 255 for maximum intensity, even if the display
|
||||
does not use eight bits internally to represent intensity.
|
||||
color map.
|
||||
On all displays that support this call, values range from 0 for minimum
|
||||
intensity to 255 for maximum intensity, even if the display does not use
|
||||
eight bits internally to represent intensity.
|
||||
.It Dv WSDISPLAYIO_PUTCMAP Pq Li "struct wsdisplay_cmap"
|
||||
Change the display's color map. The argument structure is the same as for
|
||||
Change the display's color map.
|
||||
The argument structure is the same as for
|
||||
.Dv WSDISPLAYIO_GETCMAP ,
|
||||
but
|
||||
.Va red ,
|
||||
|
|
@ -196,7 +207,8 @@ and
|
|||
are taken as pointers to the values to use to set the color map.
|
||||
This call is not available on displays with fixed color maps.
|
||||
.It Dv WSDISPLAYIO_GVIDEO Pq Li int
|
||||
Get the current state of the display's video output. Possible values are:
|
||||
Get the current state of the display's video output.
|
||||
Possible values are:
|
||||
.Bl -tag -width Dv
|
||||
.It Dv WSDISPLAYIO_VIDEO_OFF
|
||||
The display is blanked.
|
||||
|
|
@ -204,11 +216,13 @@ The display is blanked.
|
|||
The display is enabled.
|
||||
.El
|
||||
.It Dv WSDISPLAYIO_SVIDEO Pq Li int
|
||||
Set the state of the display's video output. See
|
||||
Set the state of the display's video output.
|
||||
See
|
||||
.Dv WSDISPLAYIO_GVIDEO
|
||||
above for possible values.
|
||||
.It Dv WSDISPLAYIO_GCURPOS Pq Li "struct wsdisplay_curpos"
|
||||
Retrieve the current position of the hardware cursor. The returned structure
|
||||
Retrieve the current position of the hardware cursor.
|
||||
The returned structure
|
||||
is as follows:
|
||||
.Bd -literal -offset indent
|
||||
struct wsdisplay_curpos {
|
||||
|
|
@ -227,9 +241,10 @@ This call is not available on displays without a hardware cursor.
|
|||
Set the current cursor position. The argument structure, and its semantics,
|
||||
are the same as for
|
||||
.Dv WSDISPLAYIO_GCURPOS .
|
||||
This call is not avilable on displays without a hardware cursor.
|
||||
This call is not available on displays without a hardware cursor.
|
||||
.It Dv WSDISPLAYIO_GCURMAX Pq Li "struct wsdisplay_curpos"
|
||||
Retrieve the maximum size of cursor supported by the display. The
|
||||
Retrieve the maximum size of cursor supported by the display.
|
||||
The
|
||||
.Va x
|
||||
and
|
||||
.Va y
|
||||
|
|
@ -237,8 +252,8 @@ members of the returned structure indicate the maximum number of pixel rows
|
|||
and columns, respectively, in a hardware cursor on this display.
|
||||
This call is not available on displays without a hardware cursor.
|
||||
.It Dv WSDISPLAYIO_GCURSOR Pq Li "struct wsdisplay_cursor"
|
||||
Retrieve some or all of the hardware cursor's attributes. The argument
|
||||
structure is as follows:
|
||||
Retrieve some or all of the hardware cursor's attributes.
|
||||
The argument structure is as follows:
|
||||
.Bd -literal -offset indent
|
||||
struct wsdisplay_cursor {
|
||||
u_int which;
|
||||
|
|
@ -273,8 +288,9 @@ Get
|
|||
.Va hot ,
|
||||
which indicates the location of the
|
||||
.Dq hot spot
|
||||
within the cursor. This is the point on the cursor whose position on the
|
||||
display is treated as being the position of the cursor by other calls.
|
||||
within the cursor.
|
||||
This is the point on the cursor whose position on the display is treated
|
||||
as being the position of the cursor by other calls.
|
||||
Its location is counted in pixels from the top-right corner of the cursor.
|
||||
.It Dv WSDISPLAYIO_CURSOR_DOCMAP
|
||||
Get
|
||||
|
|
@ -287,7 +303,8 @@ here need not have its
|
|||
.Va index
|
||||
and
|
||||
.Va count
|
||||
members initialized. They will be set to 0 and 2 respectively by the call.
|
||||
members initialized.
|
||||
They will be set to 0 and 2 respectively by the call.
|
||||
This means that
|
||||
.Va cmap . Ns Va red ,
|
||||
.Va cmap . Ns Va green ,
|
||||
|
|
@ -302,9 +319,9 @@ and
|
|||
.Va mask .
|
||||
These are, respectively, the dimensions of the cursor in pixels, the
|
||||
bitmap of set pixels in the cursor and the bitmap of opaque pixels in
|
||||
the cursor. The format in which these bitmaps are returned, and hence
|
||||
the amount of space that must be provided by the application, are
|
||||
device-dependent.
|
||||
the cursor.
|
||||
The format in which these bitmaps are returned, and hence the amount of
|
||||
space that must be provided by the application, are device-dependent.
|
||||
.It Dv WSDISPLAYIO_CURSOR_DOALL
|
||||
Get all of the above.
|
||||
.El
|
||||
|
|
@ -317,8 +334,8 @@ which are pointers should be initialized to
|
|||
if not otherwise used.
|
||||
This call is not available on displays without a hardware cursor.
|
||||
.It Dv WSDISPLAYIO_SCURSOR Pq Li "struct wsdisplay_cursor"
|
||||
Set some or all of the hardware cursor's attributes. The argument structure
|
||||
is the same as for
|
||||
Set some or all of the hardware cursor's attributes.
|
||||
The argument structure is the same as for
|
||||
.Dv WSDISPLAYIO_GCURSOR .
|
||||
The
|
||||
.Va which
|
||||
|
|
@ -328,7 +345,8 @@ It should contain the logical OR of the following flags:
|
|||
.It Dv WSDISPLAYIO_CURSOR_DOCUR
|
||||
If
|
||||
.Va enable
|
||||
is zero, hide the cursor. Otherwise, display it.
|
||||
is zero, hide the cursor.
|
||||
Otherwise, display it.
|
||||
.It Dv WSDISPLAYIO_CURSOR_DOPOS
|
||||
Set the cursor's position on the display to
|
||||
.Va pos ,
|
||||
|
|
@ -365,7 +383,8 @@ Do all of the above.
|
|||
.Pp
|
||||
This call is not available on displays without a hardware cursor.
|
||||
.It Dv WSDISPLAYIO_GMODE Pq Li u_int
|
||||
Get the current mode of the display. Possible results include:
|
||||
Get the current mode of the display.
|
||||
Possible results include:
|
||||
.Bl -tag -width Dv
|
||||
.It Dv WSDISPLAYIO_MODE_EMUL
|
||||
The display is in emulating (text) mode.
|
||||
|
|
@ -374,7 +393,8 @@ The display is in mapped (graphics) mode.
|
|||
.El
|
||||
.Pp
|
||||
.It Dv WSDISPLAYIO_SMODE Pq Li u_int
|
||||
Set the current mode of the display. For possible arguments, see
|
||||
Set the current mode of the display.
|
||||
For possible arguments, see
|
||||
.Dv WSDISPLAYIO_GMODE .
|
||||
.El
|
||||
.Sh FILES
|
||||
|
|
|
|||
Loading…
Reference in New Issue