Xserver.man: some editorial fixes for the manual

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").

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.

"[" and "]", showing optional arguments to options, should be typeset in roman.

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'

Originally from: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1041094

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Part-of: <https://gitlab.freedesktop.org/xorg/xserver/-/merge_requests/1875>
This commit is contained in:
Bjarni Ingi Gislason 2023-07-14 20:36:07 +00:00 committed by Alan Coopersmith
parent f544e0df2c
commit 056b447a33

View File

@ -101,7 +101,7 @@ specifies a file which contains a collection of authorization records used
to authenticate access. See also the \fIxdm\fP(1) and to authenticate access. See also the \fIxdm\fP(1) and
\fIXsecurity\fP(@miscmansuffix@) manual pages. \fIXsecurity\fP(@miscmansuffix@) manual pages.
.TP 8 .TP 8
.BI \-background\ none .B \-background none
Asks the driver not to clear the background on startup, Asks the driver not to clear the background on startup,
if the driver supports that. if the driver supports that.
May be useful for smooth transition with e.g.\& fbdev driver. May be useful for smooth transition with e.g.\& fbdev driver.
@ -110,7 +110,8 @@ show a previous user session.
.TP 8 .TP 8
.B \-br .B \-br
sets the default root window to solid black instead of the standard root weave 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 .TP 8
.B \-bs .B \-bs
disables backing store support on all screens. disables backing store support on all screens.
@ -162,18 +163,20 @@ disables DPMS (display power management services). The default state
is platform and configuration specific. is platform and configuration specific.
.TP 8 .TP 8
.BI "\-extension " extensionName .BI "\-extension " extensionName
disables named extension. If an unknown extension name is specified, disables named extension.
If an unknown extension name is specified,
a list of accepted extension names is printed. a list of accepted extension names is printed.
.TP 8 .TP 8
.BI "+extension " extensionName .BI "+extension " extensionName
enables named extension. If an unknown extension name is specified, enables named extension.
If an unknown extension name is specified,
a list of accepted extension names is printed. a list of accepted extension names is printed.
.TP 8 .TP 8
.B \-f \fIvolume\fP .B \-f \fIvolume\fP
sets beep (bell) volume (allowable range: 0\(en100). sets beep (bell) volume (allowable range: 0\(en100).
.TP 8 .TP 8
.B \-fakescreenfps \fFps\fP .B \-fakescreenfps \fIfps\fP
sets fake presenter screen default fps (allowable range: 1-600). sets fake presenter screen default fps (allowable range: 1\(en600).
.TP 8 .TP 8
.B \-fp \fIfontPath\fP .B \-fp \fIfontPath\fP
sets the search path for fonts. This path is a comma separated list sets the search path for fonts. This path is a comma separated list
@ -274,7 +277,8 @@ connected to the system.
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). pointer acceleration should take effect).
.TP 8 .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. causes the server to terminate at server reset, instead of continuing to run.
This overrides a previous This overrides a previous
.B \-noreset .B \-noreset
@ -303,7 +307,7 @@ pattern.
loads the specified extension at init. loads the specified extension at init.
This is a no-op for most implementations. This is a no-op for most implementations.
.TP 8 .TP 8
.B [+\-]xinerama .RB [ +\- ] xinerama
enables(+) or disables(\-) the XINERAMA extension. The default state is enables(+) or disables(\-) the XINERAMA extension. The default state is
platform and configuration specific. platform and configuration specific.
.SH SERVER DEPENDENT OPTIONS .SH SERVER DEPENDENT OPTIONS
@ -368,7 +372,8 @@ enables XDMCP and sends Query packets to the specified
enable XDMCP and broadcasts BroadcastQuery packets to the network. The enable XDMCP and broadcasts BroadcastQuery packets to the network. The
first responding display manager will be chosen for the session. first responding display manager will be chosen for the session.
.TP 8 .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. Enable XDMCP and multicast BroadcastQuery packets to the network.
The first responding display manager is chosen for the session. If an 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 that address. If no
@ -417,7 +422,8 @@ 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 relative path from the XKB base directory. The default XKB base directory is
.IR @projectroot@/lib/X11/xkb . .IR @projectroot@/lib/X11/xkb .
.TP 8 .TP 8
.BR [+\-]accessx " [ \fItimeout\fP [ \fItimeout_mask\fP [ \fIfeedback\fP [ \fIoptions_mask\fP ] ] ] ]" .RB [ +\- ] accessx " [ \fItimeout\fP [ \fItimeout_mask\fP [ \
\fIfeedback\fP [ \fIoptions_mask\fP ] ] ] ]"
enables(+) or disables(\-) AccessX key sequences. enables(+) or disables(\-) AccessX key sequences.
.TP 8 .TP 8
.B \-xkbdir \fIdirectory\fP .B \-xkbdir \fIdirectory\fP
@ -545,10 +551,10 @@ You can specify a special kind of font path in the form \fBcatalogue:<dir>\fR.
The directory specified after the catalogue: prefix will be scanned for symlinks The directory specified after the catalogue: prefix will be scanned for symlinks
and each symlink destination will be added as a local fontfile FPE. and each symlink destination will be added as a local fontfile FPE.
.PP .PP
The symlink can be suffixed by attributes such as \&'\fBunscaled\fR', which The symlink can be suffixed by attributes such as \&'\fBunscaled\fR',
will be passed through to the underlying fontfile FPE. The only exception is which will be passed through to the underlying fontfile FPE.
the newly introduced \&'\fBpri\fR' attribute, which will be used for ordering The only exception is the newly introduced \&'\fBpri\fR' attribute,
the font paths specified by the symlinks. which will be used for ordering the font paths specified by the symlinks.
An example configuration: An example configuration:
@ -562,8 +568,8 @@ An example configuration:
This will add /usr/share/X11/fonts/misc as the first FPE with the attribute 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 \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 attribute \&'unscaled' etc.
the following font path: This is functionally equivalent to setting the following font path:
.nf .nf
/usr/share/X11/fonts/misc:unscaled, /usr/share/X11/fonts/misc:unscaled,