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-vesa/-/merge_requests/16>
This commit is contained in:
Alan Coopersmith
2025-07-12 15:32:19 -07:00
committed by Enrico Weigelt, metux IT consult
parent 9ac5156b65
commit 3824ba73ee

View File

@@ -1,6 +1,6 @@
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH VESA __drivermansuffix__ __vendorversion__
.TH VESA 4 2009-01-09 __vendorversion__
.SH NAME
vesa \- Generic VESA video driver
.SH SYNOPSIS
@@ -13,22 +13,25 @@ vesa \- Generic VESA video driver
.fi
.SH DESCRIPTION
.B vesa
is an __xservername__ driver for generic VESA video cards. It can drive most
VESA-compatible video cards, but only makes use of the basic standard
VESA core that is common to these cards. The driver supports depths 8, 15
16 and 24.
is an
.B Xorg
driver for generic VESA video cards.
It can drive most VESA-compatible video cards, but only makes use of
the basic standard VESA core that is common to these cards.
The driver supports depths 8, 15, 16, and 24.
.SH SUPPORTED HARDWARE
The
.B vesa
driver supports most VESA-compatible video cards. There are some known
exceptions, and those should be listed here.
driver supports most VESA-compatible video cards.
There are some known exceptions, and those should be listed here.
.SH CONFIGURATION DETAILS
Please refer to
.BR __xconfigfile__ (__filemansuffix__)
.BR xorg.conf (5)
for general configuration details.
This section only covers configuration details specific to this driver.
.PP
The driver auto-detects the presence of VESA-compatible hardware. The
The driver auto-detects the presence of VESA-compatible hardware.
The
.B ChipSet
name may optionally be specified in the config file
.B \*qDevice\*q
@@ -43,8 +46,9 @@ The following driver
are supported:
.TP
.BI "Option \*qShadowFB\*q \*q" boolean \*q
Enable or disable use of the shadow framebuffer layer. Default: on.
Enable or disable use of the shadow framebuffer layer.
Default: on.
.IP
This option is recommended for performance reasons.
.TP
.BI "Option \*qModeSetClearScreen\*q \*q" boolean \*q
@@ -54,11 +58,10 @@ that the newly set video mode is bogus
if they are asked to clear the screen during mode setting.
If you experience problems try to turn this option off.
Default: on.
.SH "SEE ALSO"
.BR __xservername__ (__appmansuffix__),
.BR __xconfigfile__ (__filemansuffix__),
.BR Xserver (__appmansuffix__),
.BR X (__miscmansuffix__)
.BR Xorg (1),
.BR Xserver (1),
.BR xorg.conf (5),
.BR X (7)
.SH AUTHORS
Authors include: Paulo Ce\'sar Pereira de Andrade.