Package: libxxf86vm-dev
Version: 1:1.1.4-1+b4
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with a new version
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z < "man
page"
[Use
grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' <file>
to find (most) trailing spaces.]
["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).
[The fate of "test-nroff" was decided in groff bug #55941.]
* What was the outcome of this action?
an.tmac:<stdin>:442: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks and further material, if a diff-file exist, are in the
attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.21-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages libxxf86vm-dev depends on:
ii libx11-dev 2:1.8.12-1
ii libxxf86vm1 1:1.1.4-1+b4
ii x11proto-dev [x11proto-xf86vidmode-dev] 2024.1-1
libxxf86vm-dev recommends no packages.
libxxf86vm-dev suggests no packages.
-- no debconf information
Input file is XF86VM.3
Output from "mandoc -T lint XF86VM.3": (shortened list)
1 input text line longer than 80 bytes: XF86VidModeQueryExte...
-.-.
Output from
test-nroff -mandoc -t -ww -z XF86VM.3: (shortened list)
1 Use macro '.B' for one argument or split argument.
1 .RB is for at least 2 arguments, got 1
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
259:.ZN -lXxf86vm
-.-.
Add a "\&" (or a comma (Oxford comma)) after an abbreviation
or use English words
(man-pages(7)).
Abbreviation points should be marked as such and protected against being
interpreted as an end of sentence, if they are not, and that independent
of the current place on the line.
291:provided the requested settings are valid (e.g. they don't exceed the
330:If the specified mode can be used by the server (i.e. meets all the
-.-.
Wrong distance (not two spaces) between sentences in the input file.
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.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
Mark a final abbreviation point as such by suffixing it with "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
340:video mode. The
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Add "\:" to split the string for the output, "\<newline>" in the source.
[List of affected lines removed.]
Line 22, length 611
XF86VidModeQueryExtension, XF86VidModeQueryVersion,
XF86VidModeSetClientVersion, XF86VidModeGetModeLine,
XF86VidModeGetAllModeLines, XF86VidModeAddModeLine, XF86VidModeDeleteModeLine,
XF86VidModeModModeLine, XF86VidModeValidateModeLine, XF86VidModeSwitchMode,
XF86VidModeSwitchToMode, XF86VidModeLockModeSwitch, XF86VidModeGetMonitor,
XF86VidModeGetViewPort, XF86VidModeSetViewPort, XF86VidModeGetDotClocks,
XF86VidModeGetGamma, XF86VidModeSetGamma, XF86VidModeGetGammaRamp,
XF86VidModeSetGammaRamp, XF86VidModeGetGammaRampSize, XF86VidModeGetPermissions
\- Extension library for the XFree86-VidMode X extension
Longest line is number 22 with 611 characters
-.-.
Split a punctuation mark from a single argument for a two-font macro
355:.RB Note:
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
424:Xorg(1), xorg.conf(5), XFlush(3), XSetErrorHandler(3), xvidtune(1)
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
XF86VM.3:335:invalid (as defined in \fIxf86.h\fP)
XF86VM.3:339:is called, the server will change the video mode to next (or
previous)
-.-.
Add lines to use the CR font for groff instead of CW.
.if t \{\
. ie \\n(.g .ft CR
. el .ft CW
.\}
12:.ft CW
-.-.
Section headings (.SH and .SS) do not need quoting their arguments.
260:.SS "MODELINE FUNCTIONS"
336:.SS "MODE SWITCH FUNCTIONS"
363:.SS "MONITOR FUNCTIONS"
393:.SS "VIEWPORT FUNCTIONS"
400:.SS "OTHER FUNCTIONS"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:355: misuse, warning: .RB is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- XF86VM.3 2025-04-12 15:07:24.666154938 +0000
+++ XF86VM.3.new 2025-04-12 15:32:23.501882797 +0000
@@ -9,17 +9,31 @@
.RS
.nf
.sp 1
-.ft CW
+.if t \{\
+. ie \\n(.g .ft CR
+. el .ft CW
+.\}
..
.de EE
.ft
.sp 1
.fi
+.if t .ft R
.RE
..
.TH XF86VIDMODE 3 "libXxf86vm 1.1.4" "X Version 11"
.SH NAME
-XF86VidModeQueryExtension, XF86VidModeQueryVersion,
XF86VidModeSetClientVersion, XF86VidModeGetModeLine,
XF86VidModeGetAllModeLines, XF86VidModeAddModeLine, XF86VidModeDeleteModeLine,
XF86VidModeModModeLine, XF86VidModeValidateModeLine, XF86VidModeSwitchMode,
XF86VidModeSwitchToMode, XF86VidModeLockModeSwitch, XF86VidModeGetMonitor,
XF86VidModeGetViewPort, XF86VidModeSetViewPort, XF86VidModeGetDotClocks,
XF86VidModeGetGamma, XF86VidModeSetGamma, XF86VidModeGetGammaRamp,
XF86VidModeSetGammaRamp, XF86VidModeGetGammaRampSize, XF86VidModeGetPermissions
\- Extension library for the XFree86-VidMode X extension
+XF86VidModeQueryExtension, XF86VidModeQueryVersion,
+XF86VidModeSetClientVersion, XF86VidModeGetModeLine,
+XF86VidModeGetAllModeLines, XF86VidModeAddModeLine,
+XF86VidModeDeleteModeLine, XF86VidModeModModeLine,
+XF86VidModeValidateModeLine, XF86VidModeSwitchMode,
+XF86VidModeSwitchToMode, XF86VidModeLockModeSwitch, XF86VidModeGetMonitor,
+XF86VidModeGetViewPort, XF86VidModeSetViewPort, XF86VidModeGetDotClocks,
+XF86VidModeGetGamma, XF86VidModeSetGamma, XF86VidModeGetGammaRamp,
+XF86VidModeSetGammaRamp, XF86VidModeGetGammaRampSize,
+XF86VidModeGetPermissions \- Extension library for the XFree86-VidMode X
+extension
.SH SYNOPSIS
.nf
@@ -256,8 +270,8 @@ These functions provide an interface to
which allows the video modes to be
queried and adjusted dynamically and mode switching to be controlled.
Applications that use these functions must be linked with
-.ZN -lXxf86vm
-.SS "MODELINE FUNCTIONS"
+.ZN \-lXxf86vm
+.SS MODELINE FUNCTIONS
The
.ZN XF86VidModeGetModeLine
function is used to query the settings for the currently selected
@@ -288,7 +302,7 @@ The first element of the array correspon
The
.ZN XF86VidModeModModeLine
function can be used to change the settings of the current video mode
-provided the requested settings are valid (e.g. they don't exceed the
+provided the requested settings are valid (e.g.\& they don't exceed the
capabilities of the monitor).
.PP
To add a mode to the list of available modes, the
@@ -327,13 +341,13 @@ be deleted.
The validity of a mode can be checked with the
.ZN XF86VidModeValidateModeLine
function.
-If the specified mode can be used by the server (i.e. meets all the
+If the specified mode can be used by the server (i.e.\& meets all the
constraints placed upon a mode by the combination of the server, card,
and monitor) the function returns
.ZN MODE_OK ,
otherwise it returns a value indicating the reason why the mode is
invalid (as defined in \fIxf86.h\fP)
-.SS "MODE SWITCH FUNCTIONS"
+.SS MODE SWITCH FUNCTIONS
When the function
.ZN XF86VidModeSwitchMode
is called, the server will change the video mode to next (or previous)
@@ -352,7 +366,7 @@ or
.ZN XF86VidModeSwitchToMode
functions or from one of the mode switch key sequences.
.PP
-.RB Note:
+.BR Note :
Because of the asynchronous nature of the X protocol, a call to
.ZN XFlush
is needed if the application wants to see the mode change immediately.
@@ -360,7 +374,7 @@ To be informed of the execution status o
custom error handler should be installed using
.ZN XSetErrorHandler
before calling the mode switching function.
-.SS "MONITOR FUNCTIONS"
+.SS MONITOR FUNCTIONS
Information known to the server about the monitor is returned by the
.ZN XF86VidModeGetMonitor
function. The
@@ -390,14 +404,14 @@ and
.ZN vsync
fields point to dynamically allocated storage that should be freed
by the caller.
-.SS "VIEWPORT FUNCTIONS"
+.SS VIEWPORT FUNCTIONS
The
.ZN XF86VidModeGetViewPort
and
.ZN XF86VidModeSetViewPort
functions can be used to, respectively, query and change the location
of the upper left corner of the viewport into the virtual screen.
-.SS "OTHER FUNCTIONS"
+.SS OTHER FUNCTIONS
The
.ZN XF86VidModeQueryVersion
function can be used to determine the version of the extension
@@ -421,6 +435,10 @@ XF86VidModeGetPermissions
functions need to be documented. In the meantime, check the source
code for information about how to use them.
.SH SEE ALSO
-Xorg(1), xorg.conf(5), XFlush(3), XSetErrorHandler(3), xvidtune(1)
+.BR Xorg (1),
+.BR xorg.conf (5),
+.BR XFlush (3),
+.BR XSetErrorHandler (3),
+.BR xvidtune (1)
.SH AUTHORS
Kaleb Keithley, Jon Tombs, David Dawes, and Joe Moss
Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)
[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>
To find trailing space use
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
It should also check its input files for too long (> 80) lines.
This is just a simple quality control measure.
The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
"git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")
Not beginning each input sentence on a new line.
Line length and patch size should thus be reduced.
The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.
See man-pages(7), item "semantic newline".
-.-
The difference between the formatted output of the original and patched file
can be seen with:
nroff -mandoc <file1> > <out1>
nroff -mandoc <file2> > <out2>
diff -d -u <out1> <out2>
and for groff, using
\"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - \"
instead of 'nroff -mandoc'
Add the option '-t', if the file contains a table.
Read the output from 'diff -d -u ...' with 'less -R' or similar.
-.-.
If 'man' (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -b -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-
