Improve man page formatting

More closely follow common style as described on
https://man7.org/linux/man-pages/man7/man-pages.7.html
and fix warnings raised by `mandoc -T lint` and `groff -rCHECKSTYLE=10`

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Part-of: <https://gitlab.freedesktop.org/xorg/driver/xf86-video-wsfb/-/merge_requests/11>
This commit is contained in:
Alan Coopersmith
2025-07-12 16:30:52 -07:00
committed by Enrico Weigelt, metux IT consult
parent 4674a44545
commit ad841a6bf9

View File

@@ -28,7 +28,7 @@
.\"
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH WSFB __drivermansuffix__ __vendorversion__
.TH WSFB 4 2012-01-01 __vendorversion__
.SH NAME
wsfb \- video driver for wsdisplay framebuffer device
.SH SYNOPSIS
@@ -41,15 +41,16 @@ wsfb \- video driver for wsdisplay framebuffer device
.fi
.SH DESCRIPTION
.B wsfb
is an __xservername__ driver for OpenBSD and NetBSD
wsdisplay framebuffer devices.
This is a non-accelerated driver.
is an
.BR Xorg (1)
driver for OpenBSD and NetBSD wsdisplay framebuffer devices.
This is a non-accelerated driver.
The following framebuffer depths are supported: 1, 8, 16 and 24, given
that the wsdisplay device underneath supports them.
.br
.PP
A StaticGray monochrome visual is provided for depth 1,
all visual types are supported for depth 8 and a TrueColor visual is
supported for the other depths.
all visual types are supported for depth 8,
and a TrueColor visual is supported for the other depths.
Multi-head configurations are supported.
.SH SUPPORTED HARDWARE
The
@@ -57,14 +58,16 @@ The
driver supports all hardware where a wsdisplay framebuffer driver
is available on OpenBSD and NetBSD.
On OpenBSD, currently this includes OpenBSD/macppc, OpenBSD/sgi,
OpenBSD/sparc, OpenBSD/sparc64 and OpenBSD/alpha on TGA graphics cards.
It also supports NetBSD/i386 using wsdisplay on vesafb(4).
OpenBSD/sparc, OpenBSD/sparc64, and OpenBSD/alpha on TGA graphics cards.
It also supports NetBSD/i386 using wsdisplay on
.BR vesafb (4).
.SH CONFIGURATION DETAILS
Please refer to __xconfigfile__(__filemansuffix__) for general configuration
details.
Please refer to
.BR xorg.conf (5)
for general configuration details.
This section only covers configuration details specific to this driver.
.PP
For this driver it is not required to specify modes in the
For this driver it is not required to specify modes in the
.B Screen
section of the configuration file.
The
@@ -73,7 +76,7 @@ driver picks up the currently used video mode from the framebuffer
driver and uses it.
Video modes specifications in the configuration file are ignored.
.PP
The following driver options are supported in the
The following driver options are supported in the
.B Device
section:
.TP
@@ -84,19 +87,26 @@ Default for NetBSD: \fI/dev/ttyE0\fP.
.TP
.BI "Option \*qShadowFB\*q \*q" boolean \*q
Enable or disable use of the shadow framebuffer layer.
See shadowfb(__drivermansuffix__) for further information.
See
.BR shadowfb (4)
for further information.
Default: on for depths were it is supported, off otherwise.
.br
ShadowFB is currently not supported on monochrome displays.
.TP
.BI "Option \*qRotate\*q \*q" string \*q
Enable rotation of the display. The supported values are "CW" (clockwise,
90 degrees), "UD" (upside down, 180 degrees) and "CCW" (counter clockwise,
270 degrees).
Enable rotation of the display.
The supported values are "CW" (clockwise, 90 degrees),
"UD" (upside down, 180 degrees), and "CCW" (counter clockwise, 270 degrees).
Implies use of the shadow framebuffer layer.
Default: off.
.SH "SEE ALSO"
__xservername__(1), __xconfigfile__(__filemansuffix__), xorgconfig(1), Xserver(1),
X(__miscmansuffix__), wsdisplay(__drivermansuffix__)
.BR Xorg (1),
.BR xorgconfig (1),
.BR Xserver (1),
.BR wsdisplay (4),
.BR xorg.conf (5),
.BR X (7)
.SH AUTHORS
Authors include: Matthieu Herrb, Gerd Knorr, Michel Dänzer, Geert Uytterhoeven
Authors include:
Matthieu Herrb, Gerd Knorr, Michel Dänzer, Geert Uytterhoeven