From 23b1583b1dbf8b2e070f3f4361b813d782c70eb2 Mon Sep 17 00:00:00 2001
From: Frederic Cambus <fcambus@cvs.openbsd.org>
Date: Thu, 17 Sep 2020 08:23:17 +0000
Subject: Document the WSDISPLAYIO_GETSCREENTYPE ioctl in wsdisplay.4.

OK jmc@, kn@, "go for it" kettenis@
---
 share/man/man4/wsdisplay.4 | 36 ++++++++++++++++++++++++++++++++++--
 1 file changed, 34 insertions(+), 2 deletions(-)

(limited to 'share/man')

diff --git a/share/man/man4/wsdisplay.4 b/share/man/man4/wsdisplay.4
index 6d4558ce6f2..2e867b442b9 100644
--- a/share/man/man4/wsdisplay.4
+++ b/share/man/man4/wsdisplay.4
@@ -1,4 +1,4 @@
-.\" $OpenBSD: wsdisplay.4,v 1.54 2019/05/25 11:02:19 otto Exp $
+.\" $OpenBSD: wsdisplay.4,v 1.55 2020/09/17 08:23:16 fcambus Exp $
 .\" $NetBSD: wsdisplay.4,v 1.5 2000/05/13 15:22:19 mycroft Exp $
 .\"
 .\" Copyright (c) 2005, Miodrag Vallat.
@@ -27,7 +27,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: May 25 2019 $
+.Dd $Mdocdate: September 17 2020 $
 .Dt WSDISPLAY 4
 .Os
 .Sh NAME
@@ -174,6 +174,38 @@ indicates the number of color map entries accessible through
 and
 .Dv WSDISPLAYIO_PUTCMAP .
 This call is likely to be unavailable on text-only displays.
+.It Dv WSDISPLAYIO_GETSCREENTYPE Fa "struct wsdisplay_screentype"
+Retrieve basic information about a screen.
+The returned structure is as follows:
+.Bd -literal -offset indent
+struct wsdisplay_screentype {
+        int idx;
+        int nidx;
+        char name[WSSCREEN_NAME_SIZE];
+        int ncols, nrows;
+        int fontwidth, fontheight;
+};
+.Ed
+.Pp
+The
+.Va idx
+field indicates the index of the screen.
+The
+.Va nidx
+field indicates the number of screens.
+The
+.Va name
+field contains a human readable string used to identify the screen.
+The 
+.Va ncols
+and
+.Va  nrows
+fields indicate the available number of columns and rows.
+The 
+.Va fontwidth
+and
+.Va fontheight
+fields indicate the dimensions of a character cell, in pixels.
 .It Dv WSDISPLAYIO_GETCMAP Fa "struct wsdisplay_cmap"
 Retrieve the current color map from the display.
 This call needs the
-- 
cgit v1.2.3