xfree86: .BI style: monitor section in xorg.conf man page

The xorg.conf manual uses the following convention in most of its
sections:

bold = text to be copied literally to the config file,
italic = a symbolic name to be substituted by a true value.

Some configuration keywords seem to have been changed into generic
options.  Prepending Option to the manual entry swapped the
bold-italic logic.  This patch restores the convention in the monitor
section and consists of

-.BI "Option " "\*qPreferredMode\*q  " \*qstring\*q
+.BI "Option \*qPreferredMode\*q \*q" name \*q

modifications.

Plus a few minor changes (Modes → Mode) and a typo fix.

Signed-off-by: Servaas Vandenberghe
Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
vdb@picaros.org 2011-08-31 07:23:01 +02:00 committed by Peter Hutterer
parent 4b4caecb7d
commit c7163fdd30

View File

@ -1449,7 +1449,7 @@ driver plus the identifier of a monitor section, one associates a monitor
section with an output by adding an option to the Device section in the section with an output by adding an option to the Device section in the
following format: following format:
.B Option \*qMonitor-outputname\*q \*qmonitorsection\*q .BI "Option \*qMonitor-" outputname "\*q \*q" monitorsection \*q
(for example, (for example,
.B Option \*qMonitor-VGA\*q \*qVGA monitor\*q .B Option \*qMonitor-VGA\*q \*qVGA monitor\*q
@ -1465,7 +1465,7 @@ modes available.
When modes are specified explicitly in the When modes are specified explicitly in the
.B Monitor .B Monitor
section (with the section (with the
.BR Modes , .BR Mode ,
.BR ModeLine , .BR ModeLine ,
or or
.B UseModes .B UseModes
@ -1614,7 +1614,7 @@ mentioned above doubles this value.
This entry is a more compact version of the This entry is a more compact version of the
.B Mode .B Mode
entry, and it also can be used to specify video modes for the monitor. entry, and it also can be used to specify video modes for the monitor.
is a single line format for specifying video modes. This is a single line format for specifying video modes.
In most cases this isn't necessary because the built\-in set of VESA In most cases this isn't necessary because the built\-in set of VESA
standard modes will be sufficient. standard modes will be sufficient.
.PP .PP
@ -1669,61 +1669,61 @@ The
and and
.B VScan .B VScan
options mentioned above in the options mentioned above in the
.B Modes .B Mode
entry description can also be used here. entry description can also be used here.
.RE .RE
.TP 7 .TP 7
.BI "Option " "\*qDPMS\*q " \*qbool\*q .BI "Option \*qDPMS\*q \*q" bool \*q
This option controls whether the server should enable the DPMS extension This option controls whether the server should enable the DPMS extension
for power management for this screen. The default is to enable the for power management for this screen. The default is to enable the
extension. extension.
.TP 7 .TP 7
.BI "Option " "\*qSyncOnGreen\*q " \*qbool\*q .BI "Option \*qSyncOnGreen\*q \*q" bool \*q
This option controls whether the video card should drive the sync signal This option controls whether the video card should drive the sync signal
on the green color pin. Not all cards support this option, and most on the green color pin. Not all cards support this option, and most
monitors do not require it. The default is off. monitors do not require it. The default is off.
.TP 7 .TP 7
.BI "Option " "\*qPrimary\*q " \*qbool\*q .BI "Option \*qPrimary\*q \*q" bool \*q
This optional entry specifies that the monitor should be treated as the primary This optional entry specifies that the monitor should be treated as the primary
monitor. (RandR 1.2-supporting drivers only) monitor. (RandR 1.2-supporting drivers only)
.TP 7 .TP 7
.BI "Option " "\*qPreferredMode\*q " \*qstring\*q .BI "Option \*qPreferredMode\*q \*q" name \*q
This optional entry specifies a mode to be marked as the preferred initial mode This optional entry specifies a mode to be marked as the preferred initial mode
of the monitor. of the monitor.
(RandR 1.2-supporting drivers only) (RandR 1.2-supporting drivers only)
.TP 7 .TP 7
.BI "Option " "\*qPosition\*q " "\*qx y\*q" .BI "Option \*qPosition\*q \*q" x " " y \*q
This optional entry specifies the position of the monitor within the X This optional entry specifies the position of the monitor within the X
screen. screen.
(RandR 1.2-supporting drivers only) (RandR 1.2-supporting drivers only)
.TP 7 .TP 7
.BI "Option " "\*qLeftOf\*q " \*qoutput\*q .BI "Option \*qLeftOf\*q \*q" output \*q
This optional entry specifies that the monitor should be positioned to the This optional entry specifies that the monitor should be positioned to the
left of the output (not monitor) of the given name. left of the output (not monitor) of the given name.
(RandR 1.2-supporting drivers only) (RandR 1.2-supporting drivers only)
.TP 7 .TP 7
.BI "Option " "\*qRightOf\*q " \*qoutput\*q .BI "Option \*qRightOf\*q \*q" output \*q
This optional entry specifies that the monitor should be positioned to the This optional entry specifies that the monitor should be positioned to the
right of the output (not monitor) of the given name. right of the output (not monitor) of the given name.
(RandR 1.2-supporting drivers only) (RandR 1.2-supporting drivers only)
.TP 7 .TP 7
.BI "Option " "\*qAbove\*q " \*qoutput\*q .BI "Option \*qAbove\*q \*q" output \*q
This optional entry specifies that the monitor should be positioned above the This optional entry specifies that the monitor should be positioned above the
output (not monitor) of the given name. output (not monitor) of the given name.
(RandR 1.2-supporting drivers only) (RandR 1.2-supporting drivers only)
.TP 7 .TP 7
.BI "Option " "\*qBelow\*q " \*qoutput\*q .BI "Option \*qBelow\*q \*q" output \*q
This optional entry specifies that the monitor should be positioned below the This optional entry specifies that the monitor should be positioned below the
output (not monitor) of the given name. output (not monitor) of the given name.
(RandR 1.2-supporting drivers only) (RandR 1.2-supporting drivers only)
.TP 7 .TP 7
.BI "Option " "\*qEnable\*q " \*qbool\*q .BI "Option \*qEnable\*q \*q" bool \*q
This optional entry specifies whether the monitor should be turned on This optional entry specifies whether the monitor should be turned on
at startup. By default, the server will attempt to enable all connected at startup. By default, the server will attempt to enable all connected
monitors. monitors.
(RandR 1.2-supporting drivers only) (RandR 1.2-supporting drivers only)
.TP 7 .TP 7
.BI "Option " "\*qDefaultModes\*q " \*qbool\*q .BI "Option \*qDefaultModes\*q \*q" bool \*q
This optional entry specifies whether the server should add supported default This optional entry specifies whether the server should add supported default
modes to the list of modes offered on this monitor. By default, the server modes to the list of modes offered on this monitor. By default, the server
will add default modes; you should only disable this if you can guarantee will add default modes; you should only disable this if you can guarantee
@ -1731,21 +1731,21 @@ that EDID will be available at all times, or if you have added custom modelines
which the server can use. which the server can use.
(RandR 1.2-supporting drivers only) (RandR 1.2-supporting drivers only)
.TP 7 .TP 7
.BI "Option " "\*qMinClock\*q " \*qfrequency\*q .BI "Option \*qMinClock\*q \*q" frequency \*q
This optional entry specifies the minimum dot clock, in kHz, that is supported This optional entry specifies the minimum dot clock, in kHz, that is supported
by the monitor. by the monitor.
.TP 7 .TP 7
.BI "Option " "\*qMaxClock\*q " \*qfrequency\*q .BI "Option \*qMaxClock\*q \*q" frequency \*q
This optional entry specifies the maximum dot clock, in kHz, that is supported This optional entry specifies the maximum dot clock, in kHz, that is supported
by the monitor. by the monitor.
.TP 7 .TP 7
.BI "Option " "\*qIgnore\*q " \*qbool\*q .BI "Option \*qIgnore\*q \*q" bool \*q
This optional entry specifies that the monitor should be ignored entirely, This optional entry specifies that the monitor should be ignored entirely,
and not reported through RandR. This is useful if the hardware reports the and not reported through RandR. This is useful if the hardware reports the
presence of outputs that don't exist. presence of outputs that don't exist.
(RandR 1.2-supporting drivers only) (RandR 1.2-supporting drivers only)
.TP 7 .TP 7
.BI "Option " "\*qRotate\*q " \*qrotation\*q .BI "Option \*qRotate\*q \*q" rotation \*q
This optional entry specifies the initial rotation of the given monitor. This optional entry specifies the initial rotation of the given monitor.
Valid values for rotation are \*qnormal\*q, \*qleft\*q, \*qright\*q, and Valid values for rotation are \*qnormal\*q, \*qleft\*q, \*qright\*q, and
\*qinverted\*q. \*qinverted\*q.