Bug#1041094: Xserver.1: some remarks and editorial fixes for the manual
Package: xserver-common
Version: 2:21.1.7-3
Severity: minor
Tags: patch
Dear Maintainer,
here are some notes and editrorial fixes for the man page.
The patch is in the attachment.
-.-.
The difference between the formatted outputs can be seen with:
nroff -man -t <file1> > <out1>
nroff -man -t <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"groff -man -t -Z" instead of "nroff -man"
Read the output of "diff -u" with "less -R" or similar.
-.-.
If "man" (man-db) is used to check the manual,
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 -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Change '-' (\-) to '\(en' (en-dash) for a numeric range.
Xserver.1:121:sets key-click volume (allowable range: 0-100).
Xserver.1:165:sets beep (bell) volume (allowable range: 0-100).
Xserver.1:168:sets fake presenter screen default fps (allowable range: 1-600).
-.-.
Mark a full stop (.) and the exclamation mark (!) with "\&",
if it does not mean an end of a sentence.
This is a preventive action,
the paragraph could be reshaped, e.g., after changes.
When typing, one does not always notice when the line wraps after the
period.
There are too many examples of input lines in manual pages,
that end with an abbreviation point.
This marking is robust, and independent of the position on the line.
It corresponds to "\ " in TeX, and to "@:" in Texinfo.
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
106:May be useful for smooth transition with eg. fbdev driver.
266:sets pointer acceleration threshold in pixels (i.e. after how many pixels
406:X servers that support the XKEYBOARD (a.k.a. \*qXKB\*q) extension accept the
461:contain either an Internet hostname (e.g. expo.lcs.mit.edu)
-.-.
Change - to \- if it shall be printed as a minus sign.
Xserver.1:299:enables(+) or disables(-) the XINERAMA extension. The default state is
Xserver.1:413:enables(+) or disables(-) AccessX key sequences.
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.
112:pattern. This is the default unless -retro or -wr is specified.
247:.B -retro
251:servers, this implies -zap.
-.-.
Strings longer than 3/4 of a standard line length (80)
527 /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 comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7).
Abbreviation points should be 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
266:sets pointer acceleration threshold in pixels (i.e. after how many pixels
461:contain either an Internet hostname (e.g. expo.lcs.mit.edu)
-.-.
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.
N.B
The number of lines affected is too large to be in the patch.
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
106:May be useful for smooth transition with eg. fbdev driver.
112:pattern. This is the default unless -retro or -wr is specified.
157:disables named extension. If an unknown extension name is specified,
161:enables named extension. If an unknown extension name is specified,
250:until the first time an application calls XDefineCursor(). For kdrive
260:seat to run on. Takes a string identifying a seat in a platform
261:specific syntax. On platforms which support this feature this may be
266:sets pointer acceleration threshold in pixels (i.e. after how many pixels
275:the delay. At the end of this grace period if no client is
406:X servers that support the XKEYBOARD (a.k.a. \*qXKB\*q) extension accept the
461:contain either an Internet hostname (e.g. expo.lcs.mit.edu)
530:prefix. Directories specified this way can contain symlinks pointing to the
531:real font directories. See the FONTPATH.D section for details.
541:will be passed through to the underlying fontfile FPE. The only exception is
557:the attribute 'unscaled' etc. This is functionally equivalent to setting
-.-.
Split lines longer than 100 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Xserver.1: line 412 length 101
.BR [+-]accessx " [ \fItimeout\fP [ \fItimeout_mask\fP [ \fIfeedback\fP [ \fIoptions_mask\fP ] ] ] ]"
Xserver.1: line 527 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 .
-.-.
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.
157:disables named extension. If an unknown extension name is specified,
161:enables named extension. If an unknown extension name is specified,
-.-.
Protect a period (.) or a apostrophe (') with '\&' from becoming a
control character, if it could end up at the start of a line
(by splitting the line into more lines).
540:The symlink can be suffixed by attributes such as '\fBunscaled\fR', which
542:the newly introduced '\fBpri\fR' attribute, which will be used for ordering
557:the attribute 'unscaled' etc. This is functionally equivalent to setting
-.-.
"[" and "]", showing optional arguments to options, should be typeset in roman.
412:.BR [+-]accessx " [ \fItimeout\fP [ \fItimeout_mask\fP [ \fIfeedback\fP [ \fIoptions_mask\fP ] ] ] ]"
-.-.
Output from "test-nroff -man -b -ww -z -rCHECKSTYLE=3":
[ "test-groff" is a developmental version of "groff" ]
Input file is ./Xserver.1
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z -rSTYLECHECK=3":
an.tmac:<stdin>:104: style: .BI expects at least 2 arguments, got 1
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':524: macro 'B'
troff: backtrace: file '<stdin>':167
troff:<stdin>:167: warning: cannot select font 'F'
troff: backtrace: file '<stdin>':527
troff:<stdin>:527: warning [page 6, 8.5i]: cannot break line
-.-.
-- System Information:
Debian Release: trixie/sid
APT prefers testing-proposed-updates
APT policy: (500, 'testing-proposed-updates'), (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.3.7-1 (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+23
ii x11-xkb-utils 7.7+7
ii xkb-data 2.38-2
Versions of packages xserver-common recommends:
ii xauth 1:1.1.2-1
pn xfonts-base <none>
xserver-common suggests no packages.
-- no debconf information
--- Xserver.1 2023-07-13 21:08:31.000000000 +0000
+++ Xserver.1.new 2023-07-14 20:12:36.000000000 +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,15 +101,16 @@ 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.
+May be useful for smooth transition with e.g.\& fbdev driver.
For security reasons this is not the default as the screen contents might
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.
@@ -118,7 +119,7 @@ disables backing store support on all sc
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.
@@ -153,19 +154,21 @@ 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 \fIps\fP
+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
@@ -244,11 +247,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.
@@ -263,10 +266,11 @@ 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
+.BR \-terminate " ["\c
+.IR delay ]
causes the server to terminate at server reset, instead of continuing to run.
This overrides a previous
.B \-noreset
@@ -295,8 +299,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
+.RB [ +\- ] 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:
@@ -360,7 +364,8 @@ enables XDMCP and sends Query packets to
enable XDMCP and broadcasts BroadcastQuery packets to the network. The
first responding display manager will be chosen for the session.
.TP 8
-.B \-multicast [\fIaddress\fP [\fIhop count\fP]]
+.BR \-multicast " ["\c
+.IR address " [" "hop count" ]]
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
@@ -403,14 +408,15 @@ data (not that it is very private, being
Yet another XDMCP specific value, this one allows the display manager to
identify each display so that it can locate the shared key.
.SH XKEYBOARD OPTIONS
-X servers that support the XKEYBOARD (a.k.a. \*qXKB\*q) extension accept the
+X servers that support the XKEYBOARD (a.k.a.\& \*qXKB\*q) extension accept the
following options. All layout files specified on the command line must be
located in the XKB base directory or a subdirectory, and specified as the
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.
+.RB [ +\- ] 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
@@ -458,7 +464,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:
@@ -524,7 +530,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,\:\
+/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 .
.LP
A special kind of directory can be specified using the \fBcatalogue\fP:
prefix. Directories specified this way can contain symlinks pointing to the
@@ -537,10 +546,10 @@ You can specify a special kind of font p
The directory specified after the catalogue: prefix will be scanned for symlinks
and each symlink destination will be added as a local fontfile FPE.
.PP
-The symlink can be suffixed by attributes such as '\fBunscaled\fR', which
-will be passed through to the underlying fontfile FPE. The only exception is
-the newly introduced '\fBpri\fR' attribute, which will be used for ordering
-the font paths specified by the symlinks.
+The symlink can be suffixed by attributes such as \&'\fBunscaled\fR',
+which will be passed through to the underlying fontfile FPE.
+The only exception is the newly introduced \&'\fBpri\fR' attribute,
+which will be used for ordering the font paths specified by the symlinks.
An example configuration:
@@ -554,8 +563,8 @@ An example configuration:
This will add /usr/share/X11/fonts/misc as the first FPE with the attribute
\N'39'unscaled', second FPE will be /usr/share/X11/fonts/75dpi, also with
-the attribute 'unscaled' etc. This is functionally equivalent to setting
-the following font path:
+the attribute \&'unscaled' etc.
+This is functionally equivalent to setting the following font path:
.nf
/usr/share/X11/fonts/misc:unscaled,
@@ -570,7 +579,7 @@ the following font path:
.I /etc/X\fBn\fP.hosts
Initial access control list for display number \fBn\fP
.TP 30
-.IR /usr/share/fonts/X11/misc , /usr/share/fonts/X11/75dpi , /usr/share/fonts/X11/100dpi
+.IR /usr/share/fonts/X11/misc ,\: /usr/share/fonts/X11/75dpi ,\: /usr/share/fonts/X11/100dpi
Bitmap font directories
.TP 30
.IR /usr/share/fonts/X11/TTF , /usr/share/fonts/X11/Type1
Reply to: