[Intel-gfx] [PATCH 2/2] man: Put option defaults on separate indented line
Dan Nicholson
dbn.lists at gmail.com
Wed Nov 26 18:57:24 CET 2008
The groff .IP macro is used to put the option defaults in a new indented
paragraph so they are separated from the explanations.
Signed-off-by: Dan Nicholson <dbn.lists at gmail.com>
---
man/intel.man | 60 +++++++++++++++++++++++++++++++++++++++++---------------
1 files changed, 44 insertions(+), 16 deletions(-)
diff --git a/man/intel.man b/man/intel.man
index b36cd15..46bf906 100644
--- a/man/intel.man
+++ b/man/intel.man
@@ -57,15 +57,19 @@ The following driver
are supported
.TP
.BI "Option \*qNoAccel\*q \*q" boolean \*q
-Disable or enable acceleration. Default: acceleration is enabled.
+Disable or enable acceleration.
+.IP
+Default: acceleration is enabled.
.TP
.BI "Option \*qSWCursor\*q \*q" boolean \*q
-Disable or enable software cursor. Default: software cursor is disable
-and a hardware cursor is used for configurations where the hardware cursor
-is available.
+Disable or enable software cursor.
+.IP
+Default: software cursor is disable and a hardware cursor is used for
+configurations where the hardware cursor is available.
.TP
.BI "Option \*qColorKey\*q \*q" integer \*q
This sets the default pixel value for the YUV video overlay key.
+.IP
Default: undefined.
.TP
.BI "Option \*qCacheLines\*q \*q" integer \*q
@@ -73,6 +77,7 @@ This allows the user to change the amount of graphics memory used for
2D acceleration and video when XAA acceleration is enabled. Decreasing this
amount leaves more for 3D textures. Increasing it can improve 2D performance
at the expense of 3D performance.
+.IP
Default: depends on the resolution, depth, and available video memory. The
driver attempts to allocate space for at 3 screenfuls of pixmaps plus an
HD-sized XV video. The default used for a specific configuration can be found
@@ -83,16 +88,19 @@ This option controls whether the framebuffer compression feature is enabled.
If possible, the front buffer will be allocated in a tiled format and compressed
periodically to save memory bandwidth and power.
This option is only available on mobile chipsets.
+.IP
Default: enabled on supported configurations.
.TP
.BI "Option \*qTiling\*q \*q" boolean \*q
This option controls whether memory buffers are allocated in tiled mode. In
most cases (especially for complex rendering), tiling dramatically improves
performance.
+.IP
Default: enabled.
.TP
.BI "Option \*qDRI\*q \*q" boolean \*q
Disable or enable DRI support.
+.IP
Default: DRI is enabled for configurations where it is supported.
.PP
@@ -102,19 +110,23 @@ are supported for the i810 and i815 chipsets:
.TP
.BI "Option \*qDDC\*q \*q" boolean \*q
Disable or enable DDC support.
+.IP
Default: enabled.
.TP
.BI "Option \*qDac6Bit\*q \*q" boolean \*q
Enable or disable 6-bits per RGB for 8-bit modes.
+.IP
Default: 8-bits per RGB for 8-bit modes.
.TP
.BI "Option \*qXvMCSurfaces\*q \*q" integer \*q
This option enables XvMC. The integer parameter specifies the number of
surfaces to use. Valid values are 6 and 7.
+.IP
Default: XvMC is disabled.
.TP
.BI "VideoRam " integer
This option specifies the amount of system memory to use for graphics, in KB.
+.IP
The default is 8192 if AGP allocable memory is < 128 MB, 16384 if < 192 MB,
24576 if higher. DRI require at least a value of 16384. Higher values may give
better 3D performance, at expense of available system memory.
@@ -132,6 +144,7 @@ other drivers.
.TP
.BI "Option \*qXVideo\*q \*q" boolean \*q
Disable or enable XVideo support.
+.IP
Default: XVideo is enabled for configurations where it is supported.
.TP
.BI "Option \*qXvPreferOverlay\*q \*q" boolean \*q
@@ -141,6 +154,7 @@ it due to it syncing to vblank in the absence of compositing. While most
XV-using applications have options to select which XV adaptor to use, this
option can be used to place the overlay first for applications which don't
have options for selecting adaptors.
+.IP
Default: Textured video adaptor is preferred.
.TP
.BI "Option \*qLegacy3D\*q \*q" boolean \*q
@@ -148,7 +162,9 @@ Enable support for the non-GEM mode of the 3D driver on i830 and newer.
This will allocate a large static area for older Mesa to use for its texture
pool. On systems with a working GEM environment, this can be disabled to
increase the memory pool available to other graphics tasks.
+.IP
Default for i830 and newer: Enabled.
+.IP
Default for i810: this option is not used.
.TP
.BI "Option \*qPageFlip\*q \*q" boolean \*q
@@ -158,7 +174,9 @@ no benefit without corresponding support in the Mesa 3D driver and may not give
the full benefit without triple buffering (see
.B "Option \*qTripleBuffer\*q"
).
+.IP
Default for i810: The option is not used.
+.IP
Default for i830 and above: Disabled (This option is currently unstable).
.TP
.BI "Option \*qTripleBuffer\*q \*q" boolean \*q
@@ -168,23 +186,28 @@ no benefit without corresponding support in the Mesa 3D driver and may not give
any benefit without page flipping either (see
.B "Option \*qPageFlip\*q"
).
+.IP
Default for i810: The option is not used.
+.IP
Default for i830 and above: Disabled.
.TP
.BI "Option \*qAccelMethod\*q \*q" string \*q
Choose acceleration architecture, either "XAA" or "EXA". XAA is the old
XFree86 based acceleration architecture. EXA is a newer and simpler
acceleration architecture designed to better accelerate the X Render extension.
+.IP
Default: "EXA".
.TP
.BI "Option \*qModeDebug\*q \*q" boolean \*q
Enable printing of additional debugging information about modesetting to
the server log.
+.IP
Default: Disabled
.TP
.BI "Option \*qFallbackDebug\*q \*q" boolean \*q
Enable printing of debugging information on acceleration fallbacks to the
server log.
+.IP
Default: Disabled
.TP
.BI "Option \*qForceEnablePipeA\*q \*q" boolean \*q
@@ -204,31 +227,36 @@ within the X server. This option instead selects the physical format
/ sequencing of the digital bits sent to the display. Setting the
frame buffer color depth is really a matter of preference by the user,
while setting the pixel format here is a requirement of the connected
-hardware. Leaving this unset implies the default value of false,
-which is almost always going to be right choice. If your
-LVDS-connected display on the other hand is extremely washed out
-(e.g. white on a lighter white), trying this option might clear the
-problem.
+hardware.
+.IP
+Leaving this unset implies the default value of false, which is almost
+always going to be right choice. If your LVDS-connected display on the
+other hand is extremely washed out (e.g. white on a lighter white),
+trying this option might clear the problem.
.TP
.BI "Option \*qLVDSFixedMode\*q \*q" boolean \*q
Use a fixed set of timings for the LVDS output, independent of normal
-xorg specified timings. The default value if left unspecified is
-true, which is what you want for a normal LVDS-connected LCD type of
-panel. If you are not sure about this, leave it at its default, which
-allows the driver to automatically figure out the correct fixed panel
-timings. See further in the section about LVDS fixed timing for more
-information.
+xorg specified timings.
+.IP
+The default value if left unspecified is true, which is what you want
+for a normal LVDS-connected LCD type of panel. If you are not sure about
+this, leave it at its default, which allows the driver to automatically
+figure out the correct fixed panel timings. See further in the section
+about LVDS fixed timing for more information.
.TP
.BI "Option \*qXvMC\*q \*q" boolean \*q
Enable XvMC driver. Current support MPEG2 MC on 915/945 and G33 series.
User should provide absolute path to libIntelXvMC.so in XvMCConfig file.
+.IP
Default: Disabled.
.TP
.BI "Option \*qForceSDVODetect\*q \*q" boolean \*q
Instead of depending on SDVO detect status bit to initialize SDVO outputs,
this option trys to ignore that status bit and try to probe on all SDVO
ports anyway. Try this if some output is not detected on your ADD2 card.
-Use of this option will slow down your startup time. Default: Disabled.
+Use of this option will slow down your startup time.
+.IP
+Default: Disabled.
.SH OUTPUT CONFIGURATION
On 830M and better chipsets, the driver supports runtime configuration of
--
1.5.6.5
More information about the Intel-gfx
mailing list