Bug#1120415: Xserver.1: Some remarks and a patch with editorial changes for this man page
Package: xserver-common
Version: 2:21.1.20-1
Severity: minor
Tags: patch
>From "/usr/share/doc/debian/bug-reporting.txt.gz":
Don't file bugs upstream
If you file a bug in Debian, don't send a copy to the upstream software
maintainers yourself, as it is possible that the bug exists only in
Debian. If necessary, the maintainer of the package will forward the
bug upstream.
-.-
I do not send reports upstream if I have to get an account there.
The Debian maintainers have one already.
If I get a negative (or no) response from upstream, I send henceforth
bugs to Debian.
-.-
* 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=0 -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?
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
an.tmac:<stdin>:104: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split the argument.
troff:<stdin>:117: warning: ignoring escape character before '+'
troff:<stdin>:174: warning: cannot select font 'F'
troff:<stdin>:525: warning: [page 6, 9.3i]: cannot adjust line in b adjust mode; overset by 91.563n
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
an.tmac:<stdin>:104: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split the argument.
troff:<stdin>:117: warning: ignoring escape character before '+'
troff:<stdin>:174: warning: cannot select font 'F'
troff:<stdin>:525: warning [page 1, line 464]: cannot break line in l adjust mode; overset by 144n
troff:<stdin>:571: warning [page 1, line 509, diversion 'an*paragraph-tag', line 1]: cannot break line in l adjust mode; overset by 5n
* 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: forky/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.16.12+deb14+1-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 xserver-common depends on:
ii x11-common 1:7.7+26
ii x11-xkb-utils 7.7+9
ii xkb-data 2.42-1
Versions of packages xserver-common recommends:
ii xauth 1:1.1.2-1.1
pn xfonts-base <none>
xserver-common suggests no packages.
-- no debconf information
Input file is Xserver.1
Output from "mandoc -T lint Xserver.1": (shortened list)
3 STYLE: input text line longer than 80 bytes:
1 WARNING: undefined escape, printing literally: \+
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Output from
test-nroff -mandoc -t -ww -z Xserver.1: (shortened list)
1 Use macro '.B' for one argument or split the argument.
1 .BI is for at least 2 arguments, got 1
1 cannot break line in l adjust mode; overset by 144n
1 cannot break line in l adjust mode; overset by 5n
1 cannot select font 'F'
1 ignoring escape character before '+'
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Change '-' (\-) to '\(en' (en-dash) for a (numeric) range.
GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.
Xserver.1:128:sets key-click volume (allowable range: 0-100).
Xserver.1:172:sets beep (bell) volume (allowable range: 0-100).
Xserver.1:175:sets fake presenter screen default fps (allowable range: 1-600).
-.-.
Reduce space between words.
Xserver.1:112:pattern. This is the default unless -retro or -wr is specified.
Xserver.1:164:disables named extension. If an unknown extension name is specified,
Xserver.1:168:enables named extension. If an unknown extension name is specified,
Xserver.1:371:Enable XDMCP and multicast BroadcastQuery packets to the network.
-.-.
Change - to \- if it shall be printed as a minus sign.
Xserver.1:306:enables(+) or disables(-) the XINERAMA extension. The default state is
Xserver.1:420:enables(+) or disables(-) AccessX key sequences.
-.-.
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.
112:pattern. This is the default unless -retro or -wr is specified.
254:.B -retro
258:servers, this implies -zap.
305:.B [+-]xinerama
306:enables(+) or disables(-) the XINERAMA extension. The default state is
419:.BR [+-]accessx " [ \fItimeout\fP [ \fItimeout_mask\fP [ \fIfeedback\fP [ \fIoptions_mask\fP ] ] ] ]"
420:enables(+) or disables(-) AccessX key sequences.
-.-.
Strings longer than 3/4 of a standard line length (80).
Use "\:" to split the string at the end of an output line, for example a
long URL (web address).
This is a groff extension.
525 /usr/share/fonts/X11/misc,/usr/share/fonts/X11/cyrillic,/usr/share/fonts/X11/100dpi/:unscaled,/usr/share/fonts/X11/75dpi/:unscaled,/usr/share/fonts/X11/Type1,/usr/share/fonts/X11/100dpi,/usr/share/fonts/X11/75dpi,built-ins .
-.-.
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.
57:devices (e.g. \fI/dev/mouse\fP) is restricted. Where applicable, the
81:sets pointer acceleration (i.e. the ratio of how much is reported to how much
273:sets pointer acceleration threshold in pixels (i.e. after how many pixels
468:contain either an Internet hostname (e.g. expo.lcs.mit.edu)
-.-.
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"
[List of affected lines removed.]
-.-.
Split lines longer than 80 characters (fill completly
an A4 sized page line on a terminal)
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.
Line 26, length 84
Asks the driver not to clear the background on startup, if the driver supports that.
Line 118, length 81
Allow connections from clients with an endianess different to that of the server.
Line 122, length 84
Prohibit connections from clients with an endianess different to that of the server.
Line 419, length 101
.BR [+-]accessx " [ \fItimeout\fP [ \fItimeout_mask\fP [ \fIfeedback\fP [ \fIoptions_mask\fP ] ] ] ]"
Line 525, length 224
/usr/share/fonts/X11/misc,/usr/share/fonts/X11/cyrillic,/usr/share/fonts/X11/100dpi/:unscaled,/usr/share/fonts/X11/75dpi/:unscaled,/usr/share/fonts/X11/Type1,/usr/share/fonts/X11/100dpi,/usr/share/fonts/X11/75dpi,built-ins .
Line 571, length 88
.IR /usr/share/fonts/X11/misc , /usr/share/fonts/X11/75dpi , /usr/share/fonts/X11/100dpi
Longest line is number 525 with 224 characters
-.-.
Do not use more than two space characters between sentences or (better)
only a new line character.
112:pattern. This is the default unless -retro or -wr is specified.
164:disables named extension. If an unknown extension name is specified,
168:enables named extension. If an unknown extension name is specified,
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
[List of affected lines removed.]
-.-
Use a hyphen between a number and the unit (name) "bit",
see "man-pages(7)", item "Terms to avoid".
148:none (no fonts), or 16 (16 bit fonts only).
-.-.
Use a character "\(->" instead of plain "->" or "\->".
546: 75dpi:unscaled:pri=20 \-> /usr/share/X11/fonts/75dpi
547: ghostscript:pri=60 \-> /usr/share/fonts/default/ghostscript
548: misc:unscaled:pri=10 \-> /usr/share/X11/fonts/misc
549: type1:pri=40 \-> /usr/share/X11/fonts/Type1
550: type1:pri=50 \-> /usr/share/fonts/default/Type1
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
[List of affected lines removed.]
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
Xserver.1:533:.SH "FONTPATH.D"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
an.tmac:<stdin>:104: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split the argument.
troff:<stdin>:117: warning: ignoring escape character before '+'
troff:<stdin>:174: warning: cannot select font 'F'
troff:<stdin>:525: warning: [page 6, 9.3i]: cannot adjust line in b adjust mode; overset by 91.563n
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-.-
Tables:
Put data, that are wider than the header in a centered last column,
in a "T{...\nT}" block.
Table headers, that are wider than any data in the corresponding column,
do not need to be centered, so left adjustment (l, L) is sufficient.
--- Xserver.1 2025-11-08 19:11:49.567169534 +0000
+++ Xserver.1.new 2025-11-09 01:50:12.776834416 +0000
@@ -54,7 +54,7 @@ The X server may also be started directl
method is usually reserved for testing and is not recommended for
normal operation. On some platforms, the user must have special
permission to start the X server, often because access to certain
-devices (e.g. \fI/dev/mouse\fP) is restricted. Where applicable, the
+devices (e.g.\& \fI/dev/mouse\fP) is restricted. Where applicable, the
X server notifies systemd when it is ready to process requests.
.PP
When the X server starts up, it typically takes over the display. If
@@ -78,7 +78,7 @@ NAMES section of the \fIX\fP(7) manual p
specify which display number clients should try to use.
.TP 8
.B \-a \fInumber\fP
-sets pointer acceleration (i.e. the ratio of how much is reported to how much
+sets pointer acceleration (i.e.\& the ratio of how much is reported to how much
the user actually moved the pointer).
.TP 8
.B \-ac
@@ -101,7 +101,7 @@ specifies a file which contains a collec
to authenticate access. See also the \fIxdm\fP(1) and
\fIXsecurity\fP(7) manual pages.
.TP 8
-.BI \-background\ none
+.B \-background\ none
Asks the driver not to clear the background on startup, if the driver supports that.
May be useful for smooth transition with eg. fbdev driver.
For security reasons this is not the default as the screen contents might
@@ -109,12 +109,12 @@ show a previous user session.
.TP 8
.B \-br
sets the default root window to solid black instead of the standard root weave
-pattern. This is the default unless -retro or -wr is specified.
+pattern. This is the default unless \-retro or \-wr is specified.
.TP 8
.B \-bs
disables backing store support on all screens.
.TP 8
-.B \+byteswappedclients
+.B +byteswappedclients
Allow connections from clients with an endianess different to that of the server.
This is the default unless \fB\-byteswappedclients\fP is specified.
.TP 8
@@ -125,7 +125,7 @@ Prohibit connections from clients with a
turns off key-click.
.TP 8
.B c \fIvolume\fP
-sets key-click volume (allowable range: 0-100).
+sets key-click volume (allowable range: 0\(en100).
.TP 8
.B \-cc \fIclass\fP
sets the visual class for the root window of color screens.
@@ -145,7 +145,7 @@ ignored when using \-displayfd.
.B \-deferglyphs \fIwhichfonts\fP
specifies the types of fonts for which the server should attempt to use
deferred glyph loading. \fIwhichfonts\fP can be all (all fonts),
-none (no fonts), or 16 (16 bit fonts only).
+none (no fonts), or 16 (16-bit fonts only).
.TP 8
.B \-dpi \fIresolution\fP
sets the resolution for all screens, in dots per inch.
@@ -160,19 +160,19 @@ default state is platform and configurat
disables DPMS (display power management services). The default state
is platform and configuration specific.
.TP 8
-.BI \-extension extensionName
-disables named extension. If an unknown extension name is specified,
+.BI \-extension " extensionName"
+disables named extension. If an unknown extension name is specified,
a list of accepted extension names is printed.
.TP 8
-.BI +extension extensionName
-enables named extension. If an unknown extension name is specified,
+.BI +extension " extensionName"
+enables named extension. If an unknown extension name is specified,
a list of accepted extension names is printed.
.TP 8
.B \-f \fIvolume\fP
-sets beep (bell) volume (allowable range: 0-100).
+sets beep (bell) volume (allowable range: 0\(en100).
.TP 8
-.B \-fakescreenfps \fFps\fP
-sets fake presenter screen default fps (allowable range: 1-600).
+.B \-fakescreenfps \fIfps\fR
+sets fake presenter screen default fps (allowable range: 1\(en600).
.TP 8
.B \-fp \fIfontPath\fP
sets the search path for fonts. This path is a comma separated list
@@ -251,11 +251,11 @@ turns off auto-repeat.
.B r
turns on auto-repeat.
.TP 8
-.B -retro
+.B \-retro
starts the server with the classic stipple and cursor visible. The default
is to start with a black root window, and to suppress display of the cursor
until the first time an application calls XDefineCursor(). For kdrive
-servers, this implies -zap.
+servers, this implies \-zap.
.TP 8
.B \-s \fIminutes\fP
sets screen-saver timeout time in minutes.
@@ -270,7 +270,7 @@ used to limit the server to expose only
connected to the system.
.TP 8
.B \-t \fInumber\fP
-sets pointer acceleration threshold in pixels (i.e. after how many pixels
+sets pointer acceleration threshold in pixels (i.e.\& after how many pixels
pointer acceleration should take effect).
.TP 8
.B \-terminate \fI[delay]\fP
@@ -302,8 +302,8 @@ pattern.
loads the specified extension at init.
This is a no-op for most implementations.
.TP 8
-.B [+-]xinerama
-enables(+) or disables(-) the XINERAMA extension. The default state is
+.B [+\-]xinerama
+enables(+) or disables(\-) the XINERAMA extension. The default state is
platform and configuration specific.
.SH SERVER DEPENDENT OPTIONS
Some X servers accept the following options:
@@ -368,7 +368,7 @@ enable XDMCP and broadcasts BroadcastQue
first responding display manager will be chosen for the session.
.TP 8
.B \-multicast [\fIaddress\fP [\fIhop count\fP]]
-Enable XDMCP and multicast BroadcastQuery packets to the network.
+Enable XDMCP and multicast BroadcastQuery packets to the network.
The first responding display manager is chosen for the session. If an
address is specified, the multicast is sent to that address. If no
address is specified, the multicast is sent to the default XDMCP IPv6
@@ -416,8 +416,8 @@ located in the XKB base directory or a s
relative path from the XKB base directory. The default XKB base directory is
.IR /usr/lib/X11/xkb .
.TP 8
-.BR [+-]accessx " [ \fItimeout\fP [ \fItimeout_mask\fP [ \fIfeedback\fP [ \fIoptions_mask\fP ] ] ] ]"
-enables(+) or disables(-) AccessX key sequences.
+.BR [+\-]accessx " [ \fItimeout\fP [ \fItimeout_mask\fP [ \fIfeedback\fP [ \fIoptions_mask\fP ] ] ] ]"
+enables(+) or disables(\-) AccessX key sequences.
.TP 8
.B \-xkbdir \fIdirectory\fP
base directory for keyboard layout files. This option is not available
@@ -465,7 +465,7 @@ If no other authorization mechanism is b
this list initially consists of the host on which the server is running as
well as any machines listed in the file \fI/etc/X\fBn\fI.hosts\fR, where
\fBn\fP is the display number of the server. Each line of the file should
-contain either an Internet hostname (e.g. expo.lcs.mit.edu)
+contain either an Internet hostname (e.g.\& expo.lcs.mit.edu)
or a complete name in the format
\fIfamily\fP:\fIname\fP as described in the \fIxhost\fP(1) manual page.
There should be no leading or trailing spaces on any lines. For example:
@@ -522,7 +522,10 @@ the X server uses when trying to open a
by the \fIfont path\fP.
.LP
The default font path is
-/usr/share/fonts/X11/misc,/usr/share/fonts/X11/cyrillic,/usr/share/fonts/X11/100dpi/:unscaled,/usr/share/fonts/X11/75dpi/:unscaled,/usr/share/fonts/X11/Type1,/usr/share/fonts/X11/100dpi,/usr/share/fonts/X11/75dpi,built-ins .
+/usr/share/fonts/X11/misc,/usr/share/fonts/X11/cyrillic,\e
+/usr/share/fonts/X11/100dpi/:unscaled,\e
+/usr/share/fonts/X11/75dpi/:unscaled,/usr/share/fonts/X11/Type1,\e
+/usr/share/fonts/X11/100dpi,/usr/share/fonts/X11/75dpi,built-ins
.LP
A special kind of directory can be specified using the \fBcatalogue\fP:
prefix. Directories specified this way can contain symlinks pointing to the
@@ -543,11 +546,11 @@ the font paths specified by the symlinks
An example configuration:
.nf
- 75dpi:unscaled:pri=20 \-> /usr/share/X11/fonts/75dpi
- ghostscript:pri=60 \-> /usr/share/fonts/default/ghostscript
- misc:unscaled:pri=10 \-> /usr/share/X11/fonts/misc
- type1:pri=40 \-> /usr/share/X11/fonts/Type1
- type1:pri=50 \-> /usr/share/fonts/default/Type1
+ 75dpi:unscaled:pri=20 \(-> /usr/share/X11/fonts/75dpi
+ ghostscript:pri=60 \(-> /usr/share/fonts/default/ghostscript
+ misc:unscaled:pri=10 \(-> /usr/share/X11/fonts/misc
+ type1:pri=40 \(-> /usr/share/X11/fonts/Type1
+ type1:pri=50 \(-> /usr/share/fonts/default/Type1
.fi
This will add /usr/share/X11/fonts/misc as the first FPE with the attribute
@@ -567,8 +570,11 @@ the following font path:
.TP 30
.I /etc/X\fBn\fP.hosts
Initial access control list for display number \fBn\fP
+.TP 0
+.IR /usr/share/fonts/X11/misc , /usr/share/fonts/X11/75dpi ,
+.sp -\n[PD]u
.TP 30
-.IR /usr/share/fonts/X11/misc , /usr/share/fonts/X11/75dpi , /usr/share/fonts/X11/100dpi
+.I /usr/share/fonts/X11/100dpi
Bitmap font directories
.TP 30
.IR /usr/share/fonts/X11/TTF , /usr/share/fonts/X11/Type1
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
-.-
For general input conventions consult the man page "nroff(7)" (item
"Input conventions") or the Texinfo manual about the same item.
-.-
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)
-.-
Reply to: