Dear Maintainer,
here are some notes and editorial fixes for the man page.
-.-.
The difference between the formatted outputs can be seen with:
nroff -man <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"groff -man -Z" instead of "nroff -man"
Add the option "-t", if the file contains a table.
-.-.
Output from "mandoc -T lint vesa.4":
mandoc: vesa.4:51:66: STYLE: whitespace at end of input line
-.-.
Wrong distance between sentences.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
50:Clear the screen on mode set. Some BIOSes seem to be broken in the
52:clear the screen during mode setting. If you experience problems try
53:to turn this option off. Default: on.
-.-.
The name of a man page is set in bold type and the section in roman (see
man-pages(7)).
26:Please refer to xorg.conf(5) for general configuration
56:Xorg(1), xorg.conf(5), Xserver(1), X(7)
-.-.
Output from "test-nroff -man -b -ww -z -rCHECKSTYLE=3":
[ "test-groff" is a developmental version of "groff" ]
Input file is ./vesa.4
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z -rSTYLECHECK=3":
troff: backtrace: file '<stdin>':51
troff:<stdin>:51: warning: trailing space in the line
-.-.
--- vesa.4 2023-07-08 01:47:15.000000000 +0000
+++ vesa.4.new 2023-07-08 02:04:38.000000000 +0000
@@ -23,9 +23,10 @@ The
driver supports most VESA-compatible video cards. There are some known
exceptions, and those should be listed here.
.SH CONFIGURATION DETAILS
-Please refer to xorg.conf(5) for general configuration
-details. This section only covers configuration details specific to this
-driver.
+Please refer to
+.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
.B ChipSet
@@ -47,12 +48,17 @@ Enable or disable use of the shadow fram
This option is recommended for performance reasons.
.TP
.BI "Option \*qModeSetClearScreen\*q \*q" boolean \*q
-Clear the screen on mode set. Some BIOSes seem to be broken in the
-sense 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.
+Clear the screen on mode set.
+Some BIOSes seem to be broken in the sense
+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"
-Xorg(1), xorg.conf(5), Xserver(1), X(7)
+.BR Xorg (1),
+.BR xorg.conf (5),
+.BR Xserver (1),
+.BR X (7)
.SH AUTHORS
Authors include: Paulo Ce\'sar Pereira de Andrade.