Xserver.man: Fix some textual and formatting issues

Protect . if not end of sentence

Protect an aphostrophe (', 0x27), if it can become a control character

Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a name
for an option.

Adjust space between sentences or protect the indicator.

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

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 2017-07-22 01:15:46 +00:00 committed by Alan Coopersmith
parent d7b7789cac
commit f544e0df2c

View File

@ -31,7 +31,7 @@
Xserver \- X Window System display server Xserver \- X Window System display server
.SH SYNOPSIS .SH SYNOPSIS
.B X .B X
[option ...] [option \&...\&]
.SH DESCRIPTION .SH DESCRIPTION
.I X .I X
is the generic name for the X Window System display server. It is is the generic name for the X Window System display server. It is
@ -54,7 +54,7 @@ The X server may also be started directly by the user, though this
method is usually reserved for testing and is not recommended for method is usually reserved for testing and is not recommended for
normal operation. On some platforms, the user must have special normal operation. On some platforms, the user must have special
permission to start the X server, often because access to certain 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. X server notifies systemd when it is ready to process requests.
.PP .PP
When the X server starts up, it typically takes over the display. If When the X server starts up, it typically takes over the display. If
@ -78,7 +78,7 @@ NAMES section of the \fIX\fP(@miscmansuffix@) manual page to learn how to
specify which display number clients should try to use. specify which display number clients should try to use.
.TP 8 .TP 8
.B \-a \fInumber\fP .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). the user actually moved the pointer).
.TP 8 .TP 8
.B \-ac .B \-ac
@ -102,14 +102,15 @@ 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 .BI \-background\ none
Asks the driver not to clear the background on startup, if the driver supports that. Asks the driver not to clear the background on startup,
May be useful for smooth transition with eg. fbdev driver. if the driver supports that.
May be useful for smooth transition with e.g.\& fbdev driver.
For security reasons this is not the default as the screen contents might For security reasons this is not the default as the screen contents might
show a previous user session. 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.
@ -161,11 +162,11 @@ 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
@ -254,8 +255,8 @@ turns on auto-repeat.
.B \-retro .B \-retro
starts the server with the classic stipple and cursor visible. The default 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 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 until the first time an application calls XDefineCursor().
servers, this implies -zap. For kdrive servers, this implies \-zap.
.TP 8 .TP 8
.B \-s \fIminutes\fP .B \-s \fIminutes\fP
sets screen-saver timeout time in minutes. sets screen-saver timeout time in minutes.
@ -264,13 +265,13 @@ sets screen-saver timeout time in minutes.
disables save under support on all screens. disables save under support on all screens.
.TP 8 .TP 8
.B \-seat \fIseat\fP .B \-seat \fIseat\fP
seat to run on. Takes a string identifying a seat in a platform seat to run on. Takes a string identifying a seat in a platform
specific syntax. On platforms which support this feature this may be specific syntax. On platforms which support this feature this may be
used to limit the server to expose only a specific subset of devices used to limit the server to expose only a specific subset of devices
connected to the system. connected to the system.
.TP 8 .TP 8
.B \-t \fInumber\fP .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). pointer acceleration should take effect).
.TP 8 .TP 8
.B \-terminate \fI[delay]\fP .B \-terminate \fI[delay]\fP
@ -410,7 +411,7 @@ data (not that it is very private, being on the command line!).
Yet another XDMCP specific value, this one allows the display manager to Yet another XDMCP specific value, this one allows the display manager to
identify each display so that it can locate the shared key. identify each display so that it can locate the shared key.
.SH XKEYBOARD OPTIONS .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 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 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
@ -465,7 +466,7 @@ If no other authorization mechanism is being used,
this list initially consists of the host on which the server is running as 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 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 \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 or a complete name in the format
\fIfamily\fP:\fIname\fP as described in the \fIxhost\fP(1) manual page. \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: There should be no leading or trailing spaces on any lines. For example:
@ -534,8 +535,8 @@ The default font path is
@default_font_path@ . @default_font_path@ .
.LP .LP
A special kind of directory can be specified using the \fBcatalogue\fP: A special kind of directory can be specified using the \fBcatalogue\fP:
prefix. Directories specified this way can contain symlinks pointing to the prefix. Directories specified this way can contain symlinks pointing to the
real font directories. See the FONTPATH.D section for details. real font directories. See the FONTPATH.D section for details.
.LP .LP
The font path can be set with the \fB\-fp\fP option or by \fIxset\fP(1) The font path can be set with the \fB\-fp\fP option or by \fIxset\fP(1)
after the server has started. after the server has started.
@ -544,9 +545,9 @@ 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', which
will be passed through to the underlying fontfile FPE. The only exception is 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 newly introduced \&'\fBpri\fR' attribute, which will be used for ordering
the font paths specified by the symlinks. the font paths specified by the symlinks.
An example configuration: An example configuration:
@ -561,7 +562,7 @@ 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. This is functionally equivalent to setting
the following font path: the following font path:
.nf .nf