From adda7c4307676809026dc5296e39d4c4543a9ddf Mon Sep 17 00:00:00 2001
From: jmmv <jmmv@NetBSD.org>
Date: Fri, 30 Jul 2004 14:00:18 +0000
Subject: [PATCH] Document the WSDISPLAY_BORDER_COLOR, WSDISPLAY_CHARFUNCS,
 WSDISPLAY_CUSTOM_BORDER, WSDISPLAY_CUSTOM_OUTPUT and WSDISPLAY_DEFAULTSCREENS
 kernel options.

Also document the WSDISPLAYIO_{GET,PUT}WSCHAR ioctls.
---
 share/man/man4/wsdisplay.4 | 91 ++++++++++++++++++++++++++++++++++++--
 1 file changed, 87 insertions(+), 4 deletions(-)

diff --git a/share/man/man4/wsdisplay.4 b/share/man/man4/wsdisplay.4
index f966091e72c2..115822ff4709 100644
--- a/share/man/man4/wsdisplay.4
+++ b/share/man/man4/wsdisplay.4
@@ -1,7 +1,8 @@
-.\" $NetBSD: wsdisplay.4,v 1.24 2004/07/29 22:29:37 jmmv Exp $
+.\" $NetBSD: wsdisplay.4,v 1.25 2004/07/30 14:00:18 jmmv Exp $
 .\"
 .\" Copyright (c) 1999 Matthias Drochner.
 .\" Copyright (c) 2002 Ben Harris.
+.\" Copyright (c) 2004 Julio M. Merino Vidal.
 .\" All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
@@ -25,7 +26,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd July 29, 2004
+.Dd July 30, 2004
 .Os
 .Dt WSDISPLAY 4
 .Sh NAME
@@ -49,8 +50,11 @@
 .Cd "wsdisplay0 at smg0"
 (VAXstation small monochrome display)
 .Cd "wsdisplay* at ... kbdmux N"
-.Cd options WSDISPLAY_DEFAULTSCREENS=N
+.Cd options WSDISPLAY_BORDER_COLOR=WSCOL_XXX
 .Cd options WSDISPLAY_CHARFUNCS
+.Cd options WSDISPLAY_CUSTOM_BORDER
+.Cd options WSDISPLAY_CUSTOM_OUTPUT
+.Cd options WSDISPLAY_DEFAULTSCREENS=N
 .Sh DESCRIPTION
 The
 .Nm
@@ -124,7 +128,52 @@ will also create (at autoconfiguration time)
 .Ar n
 initial screens of the display driver's default type with
 the system's default terminal emulator.
-.Sh IOCTLS
+.Ss Kernel options
+The following kernel options are available to configure the behavior of the
+.Nm
+driver:
+.Bl -tag -width xxxxxxxx
+.It Cd options WSDISPLAY_BORDER_COLOR=WSCOL_XXX
+Sets the border color at boot time.
+Possible values are defined in
+.Pa src/sys/dev/wscons/wsdisplayvar.h .
+Defaults to
+.Sq WSCOL_BLACK .
+.It Cd options WSDISPLAY_CHARFUNCS
+Enables the
+.Dv WSDISPLAYIO_GETWSCHAR
+and
+.Dv WSDISPLAYIO_PUTWSCHAR
+ioctls.
+These are mainly used by the
+.Sq selection
+mode of
+.Xr wsmoused 8 .
+.It Cd options WSDISPLAY_CUSTOM_BORDER
+Enables the
+.Dv WSDISPLAYIO_GBORDER
+and
+.Dv WSDISPLAYIO_SBORDER
+ioctls, which allow the customization of the border color from userland
+(after boot).
+See
+.Xr wsconsctl 8 .
+.It Cd options WSDISPLAY_CUSTOM_OUTPUT
+Enables the
+.Dv WSDISPLAYIO_GMSGATTRS
+and
+.Dv WSDISPLAYIO_SMSGATTRS
+ioctls, which allow the customization of the console output and kernel
+messages from userland (after boot).
+See
+.Xr wsconsctl 8 .
+.It Cd options WSDISPLAY_DEFAULTSCREENS=N
+Sets the number of virtual screens to allocate at boot time.
+Useful for small root filesystems where the
+.Xr wsconscfg 8
+utility is not wanted.
+.El
+.Ss Ioctls
 The following
 .Xr ioctl 2
 calls are provided by the
@@ -444,6 +493,40 @@ This number corresponds to an ANSI standard color.
 Set the color of the screen border, if applicable.
 This number corresponds to an ANSI standard color.
 Not all drivers support this feature.
+.It Dv WSDISPLAYIO_GETWSCHAR Pq Li struct wsdisplay_char
+Gets a single character from the screen, specified by its position.
+The structure used is as follows:
+.Bd -literal -offset indent
+struct wsdisplay_char {
+	int row, col;
+	uint16_t letter;
+	uint8_t background, foreground;
+	char flags;
+};
+.Ed
+.Pp
+The
+.Va row
+and
+.Va col
+parameters are used as input; the rest of the structure is filled by the
+ioctl and is returned to you.
+.Va letter
+is the ASCII code of the letter found at the specified position,
+.Va background
+and
+.Va foreground
+are its colors and
+.Va flags
+is a combination of
+.Sq WSDISPLAY_CHAR_BRIGHT
+and/or
+.Sq WSDISPLAY_CHAR_BLINK .
+.It Dv WSDISPLAYIO_PUTWSCHAR Pq Li struct wsdisplay_char
+Puts a character on the screen.
+The structure has the same meaning as described in
+.Dv WSDISPLAY_GETWSCHAR ,
+although all of its fields are treated as input.
 .El
 .Sh FILES
 .Bl -item