Bug#919143: xorg.conf.5: Some formatting and word corrections in the manual
Package: xserver-xorg-core
Version: 2:1.20.3-1
Severity: minor
Tags: patch
Dear Maintainer,
see man-pages(7) for a style manual.
--- xorg.conf.5 2018-10-25 18:15:23.000000000 +0000
+++ xorg.conf.5.new 2019-01-13 06:12:18.000000000 +0000
@@ -14,8 +14,11 @@ than one way, the highest precedence mec
mechanisms is ordered from highest precedence to lowest. Note that not
all parameters can be supplied via all methods. The available command
line options and environment variables (and some defaults) are
-described in the Xserver(1) and
-Xorg(1) manual pages. Most configuration file
+described in the
+.BR Xserver (1)
+and
+.BR Xorg (1)
+manual pages. Most configuration file
parameters, with their defaults, are described below. Driver and module
specific configuration parameters are described in the relevant driver
or module manual page.
@@ -50,11 +53,11 @@ server is started as a normal user:
.PP
where
.I <cmdline>
-is a relative path (with no \(lq..\(rq components) specified with the
+is a relative path (with no \(lq..\&\(rq components) specified with the
.B \-config
command line option,
.B $XORGCONFIG
-is the relative path (with no \(lq..\(rq components) specified by that
+is the relative path (with no \(lq..\&\(rq components) specified by that
environment variable, and
.I <hostname>
is the machine's hostname as reported by
@@ -109,7 +112,7 @@ directories when the server is started a
.PP
where
.I <cmdline>
-is a relative path (with no \(lq..\(rq components) specified with the
+is a relative path (with no \(lq..\&\(rq components) specified with the
.B \-configdir
command line option.
.PP
@@ -379,7 +382,6 @@ is a number used to order the fontfile F
.I gscript:pri=60 -> /usr/share/fonts/default/ghostscript
.I misc:unscaled:pri=10 \-> /usr/share/X11/fonts/misc
.fi
-.PP
.RE
.RE
.RE
@@ -560,9 +562,14 @@ extension) to connect from another host.
Default: off.
.TP 7
.BI "Option \*qAllowMouseOpenFail\*q \*q" boolean \*q
-This tells the mousedrv(4) and vmmouse(4)
+This tells the
+.BR mousedrv (4)
+and
+.BR vmmouse (4)
drivers to not report failure if the mouse device can't be opened/initialised.
-It has no effect on the evdev(4) or other drivers.
+It has no effect on the
+.BR evdev (4)
+or other drivers.
Default: false.
.TP 7
.BI "Option \*qBlankTime\*q \*q" time \*q
@@ -574,7 +581,7 @@ is in minutes.
This is equivalent to the Xorg server's
.B \-s
flag, and the value can be changed at run\-time with
-.BR xset(1).
+.BR xset (1).
Default: 10 minutes.
.TP 7
.BI "Option \*qStandbyTime\*q \*q" time \*q
@@ -583,7 +590,7 @@ sets the inactivity timeout for the
phase of DPMS mode.
.I time
is in minutes, and the value can be changed at run\-time with
-.BR xset(1).
+.BR xset (1).
Default: 10 minutes.
This is only suitable for VESA DPMS compatible monitors, and may not be
supported by all video drivers.
@@ -597,7 +604,7 @@ sets the inactivity timeout for the
phase of DPMS mode.
.I time
is in minutes, and the value can be changed at run\-time with
-.BR xset(1).
+.BR xset (1).
Default: 10 minutes.
This is only suitable for VESA DPMS compatible monitors, and may not be
supported by all video drivers.
@@ -611,7 +618,7 @@ sets the inactivity timeout for the
phase of DPMS mode.
.I time
is in minutes, and the value can be changed at run\-time with
-.BR xset(1).
+.BR xset (1).
Default: 10 minutes.
This is only suitable for VESA DPMS compatible monitors, and may not be
supported by all video drivers.
@@ -644,9 +651,9 @@ The default value is
.BR "typical" ,
which will setup up a typical subset of
the GLXFBConfigs provided by the driver as GLX visuals. Other options are
-.BR "minimal" ,
+.BR minimal ,
which will set up the minimal set allowed by the GLX specification and
-.BR "all"
+.B all
which will setup GLX visuals for all GLXFBConfigs.
.TP 7
.BI "Option \*qUseDefaultFontPath\*q \*q" boolean \*q
@@ -730,7 +737,7 @@ instruction, the standard name is case-s
"lib" prefix, or the ".a", ".o", or ".so" suffixes.
.PP
The second form of entry is a
-.BR SubSection,
+.BR SubSection ,
with the subsection name being the module name, and the contents of the
.B SubSection
being
@@ -785,7 +792,7 @@ it.
Entries in this section are listed as Option statements with the name of
the extension as the first argument, and a boolean value as the second.
The extension name is case\-sensitive, and matches the form shown in the output
-of \*qXorg -extension ?\*q.
+of \*qXorg \-extension ?\*q.
.PP
.RS 7
Example: the MIT-SHM extension can be disabled with the following entry:
@@ -794,7 +801,7 @@ Example: the MIT-SHM extension can be di
.nf
.B "Section \*qExtensions\*q"
.B " Option \*qMIT-SHM\*q \*qDisable\*q"
-.B "EndSection"
+.B EndSection
.fi
.RE
.RE
@@ -806,7 +813,7 @@ Recent X servers employ HAL or udev back
and input hotplugging. It is usually not
necessary to provide
.B InputDevice
-sections in the xorg.conf if hotplugging is in use (i.e. AutoAddDevices is
+sections in the xorg.conf if hotplugging is in use (i.e., AutoAddDevices is
enabled). If hotplugging is enabled,
.B InputDevice
sections using the
@@ -843,7 +850,7 @@ sections have the following format:
.BI " Driver \*q" inputdriver \*q
.I " options"
.I " ..."
-.B "EndSection"
+.B EndSection
.fi
.RE
.PP
@@ -885,7 +892,6 @@ and
.BR mousedrv (4)
on other platforms.
.PP
-.PP
.B InputDevice
sections recognise some driver\-independent
.BR Options ,
@@ -898,11 +904,11 @@ Always add the device to the ServerLayou
the server. This affects implied layouts as well as explicit layouts
specified in the configuration and/or on the command line.
.TP 7
-.BI "Option \*qCorePointer\*q"
+.B "Option \*qCorePointer\*q"
Deprecated, see
.B Floating
.TP 7
-.BI "Option \*qCoreKeyboard\*q"
+.B "Option \*qCoreKeyboard\*q"
Deprecated, see
.B Floating
.TP 7
@@ -928,7 +934,7 @@ and
.B SendCoreEvents,
are the inverse of option
.B Floating
-(i.e.
+(i.e.,
.B SendCoreEvents \*qon\*q
is equivalent to
.B Floating \*qoff\*q
@@ -950,8 +956,10 @@ respectively. The identity matrix is "1
.SS POINTER ACCELERATION
For pointing devices, the following options control how the pointer
is accelerated or decelerated with respect to physical device motion. Most of
-these can be adjusted at runtime, see the xinput(1) man page for details. Only
-the most important acceleration options are discussed here.
+these can be adjusted at runtime, see the
+.BR xinput (1)
+man page for details.
+Only the most important acceleration options are discussed here.
.TP 7
.BI "Option \*qAccelerationProfile\*q \*q" integer \*q
Select the profile. In layman's terms, the profile constitutes the "feeling" of
@@ -962,7 +970,7 @@ is constructed. This is mainly a matter
.RS 6
.nf
.B " 0 classic (mostly compatible)"
-.B "-1 none (only constant deceleration is applied)"
+.B "\-1 none (only constant deceleration is applied)"
.B " 1 device-dependent"
.B " 2 polynomial (polynomial function)"
.B " 3 smooth linear (soft knee, then linear)"
@@ -1004,7 +1012,7 @@ profiles to suit the users needs. The
.B simple
and
.B limited
-profiles use it directly (i.e. they accelerate by the factor), for other
+profiles use it directly (i.e., they accelerate by the factor), for other
profiles it should hold that a higher acceleration factor leads to a faster
pointer. Typically, 1 is unaccelerated and values up to 5 are sensible.
.TP 7
@@ -1035,7 +1043,7 @@ sections have the following format:
.I " ..."
.I " options"
.I " ..."
-.B "EndSection"
+.B EndSection
.fi
.RE
.PP
@@ -1079,13 +1087,13 @@ attribute. For example:
.nf
.B "Section \*qInputClass\*q"
.B " Identifier \*qMy Class\*q"
-.B " # product string must contain example and
-.B " # either gizmo or gadget
-.B " MatchProduct \*qexample\*q
-.B " MatchProduct \*qgizmo|gadget\*q
-.B " NoMatchDriver \*qdrivername\*q
-.I " ..."
-.B "EndSection"
+.B " # product string must contain example and"
+.B " # either gizmo or gadget"
+.B " MatchProduct \*qexample\*q"
+.B " MatchProduct \*qgizmo\^|\^gadget\*q"
+.B " NoMatchDriver \*qdrivername\*q"
+.I " \&.\|.\|.\&"
+.B EndSection
.fi
.RE
.TP 7
@@ -1224,7 +1232,7 @@ sections have the following format:
.BI " Identifier \*q" name \*q
.I " entries"
.I " ..."
-.B "EndSection"
+.B EndSection
.fi
.RE
.PP
@@ -1268,10 +1276,10 @@ For example:
.nf
.B "Section \*qOutputClass\*q"
.B " Identifier \*qMy Class\*q"
-.B " # kernel driver must be either foo or bar
-.B " MatchDriver \*qfoo|bar\*q
-.I " ..."
-.B "EndSection"
+.B " # kernel driver must be either foo or bar"
+.B " MatchDriver \*qfoo\^|\^bar\*q"
+.I " \&.\|.\|.\&"
+.B EndSection
.fi
.RE
.TP 7
@@ -1331,7 +1339,7 @@ sections have the following format:
.BI " Driver \*q" driver \*q
.I " entries"
.I " ..."
-.B "EndSection"
+.B EndSection
.fi
.RE
.PP
@@ -1404,7 +1412,7 @@ section is required for each head, and t
parameter determines which head each of the
.B Device
sections applies to.
-The legal values of
+The valid values of
.I number
range from 0 to one less than the total number of heads per entity.
Most drivers require that the primary screen (0) be present.
@@ -1464,7 +1472,7 @@ For details, see the appropriate driver
.BI "VideoRam " "mem"
This optional entry specifies the amount of video ram that is installed
on the graphics board.
-This is measured in kBytes.
+This is measured in kilobytes.
In most cases this is not required because the Xorg server probes
the graphics board to determine this quantity.
The driver-specific documentation should indicate when it might be needed.
@@ -1495,7 +1503,7 @@ when the driver-specific documentation r
Only apply this
.B Device
section if X server was started with
-.B -seat
+.B \-seat
.I seat\-id
option.
.TP 7
@@ -1542,7 +1550,7 @@ sections have the following format:
.BI " Identifier \*q" name \*q
.I " entries"
.I " ..."
-.B "EndSection"
+.B EndSection
.fi
.RE
.PP
@@ -1619,7 +1627,7 @@ is added to the end of the line.
The data given here is used by the Xorg server to determine if video
modes are within the specifications of the monitor.
This information should be available in the monitor's handbook.
-If this entry is omitted, a default range of 28\-33kHz is used.
+If this entry is omitted, a default range of 28\(en33\ kHz is used.
.TP 7
.BI "VertRefresh " "vertrefresh\-range"
gives the range(s) of vertical refresh frequencies supported by the
@@ -1638,7 +1646,7 @@ is added to the end of the line.
The data given here is used by the Xorg server to determine if video
modes are within the specifications of the monitor.
This information should be available in the monitor's handbook.
-If this entry is omitted, a default range of 43\-72Hz is used.
+If this entry is omitted, a default range of 43\(en72\ Hz is used.
.TP 7
.BI "DisplaySize " "width height"
This optional entry gives the width and height, in millimetres, of the
@@ -1659,7 +1667,7 @@ Not all drivers are capable of using thi
Include the set of modes listed in the
.B Modes
section called
-.IR modesection\-id.
+.IR modesection\-id .
This makes all of the modes defined in that section available for use by
this monitor.
.TP 7
@@ -1908,7 +1916,7 @@ sections have the following format:
.BI " Identifier \*q" name \*q
.I " entries"
.I " ..."
-.B "EndSection"
+.B EndSection
.fi
.RE
.PP
@@ -1957,12 +1965,12 @@ sections have the following format:
.BI " Monitor \*q" monid \*q
.I " entries"
.I " ..."
-.BI " SubSection \*qDisplay\*q"
+.B " SubSection \*qDisplay\*q"
.I " entries"
-.I " ...
+.I " \&.\|.\|.\&"
.B " EndSubSection"
-.I " ..."
-.B "EndSection"
+.I " \&.\|.\|.\&"
+.B EndSection
.fi
.RE
.PP
@@ -2000,14 +2008,17 @@ section in the config file.
.BI "GPUDevice \*q" device\-id \*q
This entry specifies the
.B Device
-section to be used as a secondary GPU device for this screen. When multiple graphics cards are
-present, this is what ties a specific secondary card to a screen. The
+section to be used as a secondary GPU device for this screen.
+When multiple graphics cards are present, this is what ties a specific
+secondary card to a screen.
+The
.I device\-id
must match the
.B Identifier
of a
.B Device
-section in the config file. This can be specified up to 4 times for a single screen.
+section in the config file.
+This can be specified up to 4 times for a single screen.
.TP 7
.BI "Monitor \*q" monitor\-id \*q
specifies which monitor description is to be used for this screen.
@@ -2043,7 +2054,7 @@ sparse 32 bit framebuffer layout.
Only apply this
.B Screen
section if X server was started with
-.B -seat
+.B \-seat
.I seat\-id
option.
.TP 7
@@ -2057,7 +2068,7 @@ Some are driver\-specific and are descri
Others are driver\-independent, and will eventually be described here.
.\" XXX These should really be in an xaa man page.
.TP 7
-.BI "Option \*qAccel\*q"
+.B "Option \*qAccel\*q"
Enables 2D hardware acceleration.
This option is on by default, but it may be necessary to turn it off if
there are bugs in the driver.
@@ -2155,7 +2166,7 @@ This entry specifies the framebuffer for
.B Display
subsection is to be used for.
This entry is only needed when providing depth 24 configurations that allow
-a choice between a 24 bpp packed framebuffer format and a 32bpp sparse
+a choice between a 24\ bpp packed framebuffer format and a 32\ bpp sparse
framebuffer format.
In most cases this entry should not be used.
.TP 7
@@ -2166,7 +2177,7 @@ formats.
This may also be specified from the command line with the
.B \-weight
option (see
-.BR Xorg(1)).
+.BR Xorg (1)).
.TP 7
.BI "Virtual " "xdim ydim"
This optional entry specifies the virtual screen resolution to be used.
@@ -2217,7 +2228,7 @@ built-in VESA standard modes.
.BI "Visual \*q" visual\-name \*q
This optional entry sets the default root visual type.
This may also be specified from the command line (see the
-.BR Xserver(1)
+.BR Xserver (1)
man page).
The visual types available for depth 8 are (default is
.BR PseudoColor ):
@@ -2324,7 +2335,7 @@ sections have the following format:
.I " ..."
.I " options"
.I " ..."
-.B "EndSection"
+.B EndSection
.fi
.RE
.PP
@@ -2446,7 +2457,7 @@ and core keyboard devices respectively.
Only apply this
.B ServerLayout
section if X server was started with
-.B -seat
+.B \-seat
.I seat\-id
option.
.TP 7
@@ -2493,7 +2504,7 @@ section for a dual headed configuration
.B " InputDevice \*qMouse 1\*q \*qCorePointer\*q"
.B " InputDevice \*qMouse 2\*q \*qSendCoreEvents\*q"
.B " Option \*qBlankTime\*q \*q5\*q"
-.B "EndSection"
+.B EndSection
.fi
.RE
.SH "DRI SECTION"
@@ -2513,7 +2524,6 @@ entry and multiple
.B Option
flags.
The data therein is not used in this release.
-.PP
.SH "SEE ALSO"
General:
.BR X (7),
-- System Information:
Debian Release: buster/sid
APT prefers stable-updates
APT policy: (500, 'stable-updates'), (500, 'proposed-updates'), (500, 'testing'), (500, 'stable')
Architecture: amd64 (x86_64)
Kernel: Linux 4.9.144-1 (SMP w/2 CPU cores)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE=is_IS.iso88591 (charmap=ISO-8859-1)
Shell: /bin/sh linked to /bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages xserver-xorg-core depends on:
ii keyboard-configuration 1.188
ii libaudit1 1:2.8.4-2
ii libbsd0 0.9.1-1
ii libc6 2.28-4
ii libdbus-1-3 1.12.12-1
ii libdrm2 2.4.95-1
ii libegl1 1.1.0-1
ii libegl1-mesa 18.2.8-2
ii libepoxy0 1.5.3-0.1
ii libgbm1 18.2.8-2
ii libgcrypt20 1.8.4-4
ii libgl1 1.1.0-1
ii libpciaccess0 0.14-1
ii libpixman-1-0 0.36.0-1
ii libselinux1 2.8-1+b1
ii libsystemd0 240-2
ii libudev1 240-2
ii libunwind8 1.2.1-8
ii libxau6 1:1.0.8-1+b2
ii libxdmcp6 1:1.1.2-3
ii libxfont2 1:2.0.3-1
ii libxshmfence1 1.3-1
ii udev 240-2
ii xserver-common 2:1.20.3-1
Versions of packages xserver-xorg-core recommends:
ii libgl1-mesa-dri 18.2.8-2
pn libpam-systemd <none>
Versions of packages xserver-xorg-core suggests:
ii xfonts-100dpi 1:1.0.4+nmu1
ii xfonts-75dpi 1:1.0.4+nmu1
pn xfonts-scalable <none>
-- no debconf information
--
Bjarni I. Gislason
Reply to: