ati.man & radeon.man: Improve man page formatting

More closely follow common style as described on
https://man7.org/linux/man-pages/man7/man-pages.7.html
and fix warnings raised by `mandoc -T lint` and `groff -rCHECKSTYLE=10`

Part-of: <https://gitlab.freedesktop.org/xorg/driver/xf86-video-ati/-/merge_requests/30>
This commit is contained in:
Alan Coopersmith
2025-06-01 11:45:41 -07:00
parent c610c03736
commit d0ddf971d0
2 changed files with 105 additions and 79 deletions

View File

@@ -1,8 +1,8 @@
.\" shorthand for double quote that works everywhere. .\" shorthand for double quote that works everywhere.
.ds q \N'34' .ds q \N'34'
.TH ATI __drivermansuffix__ __vendorversion__ .TH ATI __drivermansuffix__ 2010-12-02 __vendorversion__
.SH NAME .SH NAME
ati \- ATI video driver ati \- ATI video wrapper driver for Xorg
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B "Section \*qDevice\*q" .B "Section \*qDevice\*q"
@@ -13,20 +13,31 @@ ati \- ATI video driver
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
.B ati .B ati
is an __xservername__ wrapper driver for ATI video cards. It autodetects is an Xorg wrapper driver for ATI video cards.
whether your hardware has a Radeon, Rage 128, or Mach64 or earlier class of It autodetects whether your hardware has a
chipset, and loads the radeon(__drivermansuffix__), Radeon, Rage 128, or Mach64 or earlier class of chipset, and loads the
r128(__drivermansuffix__), or mach64 driver as .BR radeon (__drivermansuffix__),
appropriate. .BR r128 (__drivermansuffix__),
or
.B mach64
driver as appropriate.
.SH SUPPORTED HARDWARE .SH SUPPORTED HARDWARE
The The
.B ati .B ati
driver supports Radeon, Rage 128, and Mach64 and earlier chipsets by loading driver supports Radeon, Rage 128, and Mach64 and earlier chipsets by loading
those drivers. See those manpages for specific cards supported. those drivers.
See those manpages for specific cards supported.
.SH CONFIGURATION DETAILS .SH CONFIGURATION DETAILS
Please refer to __xconfigfile__(__filemansuffix__) for general configuration Please refer to
details, and the specific card driver for driver configuration details. .BR xorg.conf(__filemansuffix__)
for general configuration details,
and the specific card driver for driver configuration details.
.SH "SEE ALSO" .SH "SEE ALSO"
__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__), r128(__drivermansuffix__), radeon(__drivermansuffix__) .BR Xorg (__appmansuffix__),
.BR xorg.conf (__filemansuffix__),
.BR Xserver (__appmansuffix__),
.BR X (__miscmansuffix__),
.BR r128 (__drivermansuffix__),
.BR radeon (__drivermansuffix__)
.SH AUTHORS .SH AUTHORS
See the individual driver pages for authors. See the individual driver pages for authors.

View File

@@ -1,7 +1,7 @@
.ds q \N'34' .ds q \N'34'
.TH RADEON __drivermansuffix__ __vendorversion__ .TH RADEON __drivermansuffix__ 2024-09-29 __vendorversion__
.SH NAME .SH NAME
radeon \- ATI/AMD RADEON video driver radeon \- ATI/AMD RADEON video driver for Xorg
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B "Section \*qDevice\*q" .B "Section \*qDevice\*q"
@@ -12,14 +12,14 @@ radeon \- ATI/AMD RADEON video driver
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
.B radeon .B radeon
is an __xservername__ driver for ATI/AMD RADEON-based video cards with the is an Xorg driver for ATI/AMD RADEON-based video cards with the
following features: following features:
.PP .PP
.PD 0 .PD 0
.TP 2 .TP 2
\(bu \(bu
Full support for 8-, 15-, 16- and 24-bit pixel depths, and for 30-bit depth on Linux 3.16 Full support for 8-, 15-, 16- and 24-bit pixel depths,
and later; and for 30-bit depth on Linux 3.16 and later;
.TP .TP
\(bu \(bu
RandR 1.2 and RandR 1.3 support; RandR 1.2 and RandR 1.3 support;
@@ -37,7 +37,8 @@ only available on R/RV3xx, R/RV/RS4xx, R/RV5xx, and RS6xx/RS740);
.SH SUPPORTED HARDWARE .SH SUPPORTED HARDWARE
The The
.B radeon .B radeon
driver supports PCI, AGP, and PCIe video cards based on the following ATI/AMD chips driver supports PCI, AGP, and PCIe video cards based on
the following ATI/AMD chips
(note: list is non-exhaustive): (note: list is non-exhaustive):
.PP .PP
.PD 0 .PD 0
@@ -214,16 +215,18 @@ Radeon R9 series
MULLINS APUs MULLINS APUs
.PD .PD
.SH CONFIGURATION DETAILS .SH CONFIGURATION DETAILS
Please refer to __xconfigfile__(__filemansuffix__) for general configuration Please refer to
details. This section only covers configuration details specific to this .BR xorg.conf (__filemansuffix__)
driver. for general configuration details.
This section only covers configuration details specific to this driver.
.PP .PP
The following driver The following driver
.B Options .B Options
are supported: are supported:
.TP .TP
.BI "Option \*qSWcursor\*q \*q" boolean \*q .BI "Option \*qSWcursor\*q \*q" boolean \*q
Selects software cursor. The default is Selects software cursor.
The default is
.B off. .B off.
.TP .TP
.BI "Option \*qAccel\*q \*q" boolean \*q .BI "Option \*qAccel\*q \*q" boolean \*q
@@ -234,8 +237,8 @@ The default is
.TP .TP
.BI "Option \*qZaphodHeads\*q \*q" string \*q .BI "Option \*qZaphodHeads\*q \*q" string \*q
Specify the RandR output(s) to use with zaphod mode for a particular driver Specify the RandR output(s) to use with zaphod mode for a particular driver
instance. If you use this option you must use this option for all instances instance.
of the driver. If you use this option you must use this option for all instances of the driver.
.br .br
For example: For example:
.B .B
@@ -243,71 +246,81 @@ Option \*qZaphodHeads\*q \*qLVDS,VGA-0\*q
will assign xrandr outputs LVDS and VGA-0 to this instance of the driver. will assign xrandr outputs LVDS and VGA-0 to this instance of the driver.
.TP .TP
.BI "Option \*qColorTiling\*q \*q" "boolean" \*q .BI "Option \*qColorTiling\*q \*q" "boolean" \*q
The framebuffer can be addressed either in linear or tiled mode. Tiled mode can provide The framebuffer can be addressed either in linear or tiled mode.
significant performance benefits with 3D applications. Tiling will be disabled if the drm Tiled mode can provide significant performance benefits with 3D applications.
module is too old or if the current display configuration does not support it. On R600+ Tiling will be disabled if the drm module is too old or
this enables 1D tiling mode. if the current display configuration does not support it.
On R600+ this enables 1D tiling mode.
.br .br
The default value is The default value is
.B on .B on
for R/RV3XX, R/RV4XX, R/RV5XX, RS6XX, RS740, R/RV6XX, R/RV7XX, RS780, RS880, for R/RV3XX, R/RV4XX, R/RV5XX, RS6XX, RS740, R/RV6XX, R/RV7XX, RS780, RS880,
EVERGREEN, CAYMAN, ARUBA, Southern Islands, and Sea Islands and EVERGREEN, CAYMAN, ARUBA, Southern Islands, and Sea Islands and
.B off .B off
for R/RV/RS1XX, R/RV/RS2XX, RS3XX, and RS690/RS780/RS880 when fast fb feature is enabled. for R/RV/RS1XX, R/RV/RS2XX, RS3XX, and RS690/RS780/RS880
when fast fb feature is enabled.
.TP .TP
.BI "Option \*qColorTiling2D\*q \*q" "boolean" \*q .BI "Option \*qColorTiling2D\*q \*q" "boolean" \*q
The framebuffer can be addressed either in linear, 1D, or 2D tiled modes. 2D tiled mode can The framebuffer can be addressed either in linear, 1D, or 2D tiled modes.
provide significant performance benefits over 1D tiling with 3D applications. Tiling 2D tiled mode can provide significant performance benefits over
will be disabled if the drm module is too old or if the current display configuration 1D tiling with 3D applications.
does not support it. KMS ColorTiling2D is only supported on R600 and newer chips and requires Tiling will be disabled if the drm module is too old or
Mesa 9.0 or newer for R6xx-ARUBA, Mesa 9.2 or newer for Southern Islands, and Mesa if the current display configuration does not support it.
10.1 or newer for Sea Islands. KMS ColorTiling2D is only supported on R600 and newer chips and requires
Mesa 9.0 or newer for R6xx-ARUBA, Mesa 9.2 or newer for Southern Islands,
and Mesa 10.1 or newer for Sea Islands.
.br .br
The default value is The default value is
.B on .B on
for R/RV6XX, R/RV7XX, RS780, RS880, EVERGREEN, CAYMAN, ARUBA, Southern Islands, and for R/RV6XX, R/RV7XX, RS780, RS880, EVERGREEN, CAYMAN, ARUBA, Southern Islands,
Sea Islands. and Sea Islands.
.TP .TP
.BI "Option \*qDRI\*q \*q" integer \*q .BI "Option \*qDRI\*q \*q" integer \*q
Define the maximum level of DRI to enable. Valid values are 2 for DRI2 or 3 for DRI3. Define the maximum level of DRI to enable.
Valid values are 2 for DRI2 or 3 for DRI3.
The default is The default is
.B 3 for DRI3 .B 3 for DRI3
if the Xorg version is >= 1.18.3 and glamor is enabled, otherwise if the Xorg version is >= 1.18.3 and glamor is enabled, otherwise
.B 2 for DRI2. Note: .B 2 for DRI2.
Note:
DRI3 may not work correctly in all cases with EXA, enable at your own risk. DRI3 may not work correctly in all cases with EXA, enable at your own risk.
.TP .TP
.BI "Option \*qEnablePageFlip\*q \*q" boolean \*q .BI "Option \*qEnablePageFlip\*q \*q" boolean \*q
Enable DRI2 page flipping. The default is Enable DRI2 page flipping.
The default is
.B on. .B on.
Pageflipping is supported on all radeon hardware. Pageflipping is supported on all radeon hardware.
.TP .TP
.BI "Option \*qTearFree\*q \*q" boolean \*q .BI "Option \*qTearFree\*q \*q" boolean \*q
Set the default value of the per-output 'TearFree' property, which controls Set the default value of the per-output 'TearFree' property, which controls
tearing prevention using the hardware page flipping mechanism. TearFree is tearing prevention using the hardware page flipping mechanism.
on for any CRTC associated with one or more outputs with TearFree on. Two TearFree is on for any CRTC associated with one or more outputs with TearFree on.
separate scanout buffers need to be allocated for each CRTC with TearFree Two separate scanout buffers need to be allocated for each CRTC with TearFree on.
on. If this option is set, the default value of the property is 'on' or 'off' If this option is set, the default value of the property is 'on' or 'off'
accordingly. If this option isn't set, the default value of the property is accordingly.
.B auto, If this option isn't set, the default value of the property is
.BR auto ,
which means that TearFree is on for rotated outputs, outputs with RandR which means that TearFree is on for rotated outputs, outputs with RandR
transforms applied and for RandR 1.4 secondary outputs, otherwise off. transforms applied and for RandR 1.4 secondary outputs, otherwise off.
.TP .TP
.BI "Option \*qAccelMethod\*q \*q" "string" \*q .BI "Option \*qAccelMethod\*q \*q" "string" \*q
Chooses between available acceleration architectures. Valid values are Chooses between available acceleration architectures.
Valid values are
.B EXA .B EXA
(for pre-TAHITI GPUs) and (for pre-TAHITI GPUs) and
.B glamor .B glamor
(for R300 or higher). The default is (for R300 or higher).
The default is
.B glamor .B glamor
with R600 or newer (with Xorg >= 1.18.3, otherwise with TAHITI or newer), otherwise with R600 or newer (with Xorg >= 1.18.3, otherwise with TAHITI or newer),
otherwise
.B EXA. .B EXA.
.sp
.PP .PP
The following driver The following driver
.B Options .B Options
are supported for are supported for
.B glamor .BR glamor :
:
.TP .TP
.BI "Option \*qShadowPrimary\*q \*q" boolean \*q .BI "Option \*qShadowPrimary\*q \*q" boolean \*q
This option enables a so-called "shadow primary" buffer for fast CPU access to This option enables a so-called "shadow primary" buffer for fast CPU access to
@@ -317,77 +330,80 @@ of other (e.g. 3D, video) workloads.
Note in particular that enabling this option currently disables page flipping. Note in particular that enabling this option currently disables page flipping.
The default is The default is
.B off. .B off.
.PP .PP
The following driver The following driver
.B Options .B Options
are supported for are supported for
.B EXA .BR EXA :
:
.TP .TP
.BI "Option \*qEXAVSync\*q \*q" boolean \*q .BI "Option \*qEXAVSync\*q \*q" boolean \*q
This option attempts to avoid tearing by stalling the engine until the display This option attempts to avoid tearing by stalling the engine until the display
controller has passed the destination region. It reduces tearing at the cost controller has passed the destination region.
of performance and has been known to cause instability on some chips. It reduces tearing at the cost of performance and
has been known to cause instability on some chips.
The default is The default is
.B off. .B off.
.TP .TP
.BI "Option \*qEXAPixmaps\*q \*q" boolean \*q .BI "Option \*qEXAPixmaps\*q \*q" boolean \*q
Under KMS, to avoid thrashing pixmaps in/out of VRAM on low memory cards, Under KMS, to avoid thrashing pixmaps in/out of VRAM on low memory cards,
we use a heuristic based on VRAM amount to determine whether to allow EXA we use a heuristic based on VRAM amount to determine whether to allow EXA
to use VRAM for non-essential pixmaps. This option allows us to override the to use VRAM for non-essential pixmaps.
heuristic. The default is This option allows us to override the heuristic.
The default is
.B on .B on
with > 32MB VRAM, off with < 32MB or when fast fb feature is enabled for RS690/RS780/RS880. with > 32MB VRAM,
.B off
with < 32MB or when fast fb feature is enabled for RS690/RS780/RS880.
.TP .TP
.BI "Option \*qSwapbuffersWait\*q \*q" boolean \*q .BI "Option \*qSwapbuffersWait\*q \*q" boolean \*q
This option controls the behavior of glXSwapBuffers and glXCopySubBufferMESA This option controls the behavior of glXSwapBuffers and glXCopySubBufferMESA
calls by GL applications. If enabled, the calls will avoid tearing by making calls by GL applications.
sure the display scanline is outside of the area to be copied before the copy If enabled, the calls will avoid tearing by making sure the display scanline
occurs. If disabled, no scanline synchronization is performed, meaning tearing is outside of the area to be copied before the copy occurs.
will likely occur. Note that when enabled, this option can adversely affect If disabled, no scanline synchronization is performed,
meaning tearing will likely occur.
Note that when enabled, this option can adversely affect
the framerate of applications that render frames at less than refresh rate. the framerate of applications that render frames at less than refresh rate.
.IP .IP
The default value is The default value is
.B on. .B on.
.SH TEXTURED VIDEO ATTRIBUTES .SH TEXTURED VIDEO ATTRIBUTES
The driver supports the following X11 Xv attributes for Textured Video. The driver supports the following X11 Xv attributes for Textured Video.
You can use the "xvattr" tool to query/set those attributes at runtime. You can use the "xvattr" tool to query/set those attributes at runtime.
.TP .TP
.BI "XV_VSYNC" .B "XV_VSYNC"
XV_VSYNC is used to control whether textured adapter synchronizes XV_VSYNC is used to control whether textured adapter synchronizes
the screen update to the monitor vertical refresh to eliminate tearing. the screen update to the monitor vertical refresh to eliminate tearing.
It has two values: 'off'(0) and 'on'(1). The default is It has two values: 'off'(0) and 'on'(1). The default is
.B 'on'(1). .B 'on'(1).
.TP .TP
.BI "XV_CRTC" .B "XV_CRTC"
XV_CRTC is used to control which display controller (crtc) the textured XV_CRTC is used to control which display controller (crtc) the textured
adapter synchronizes the screen update with when XV_VSYNC is enabled. adapter synchronizes the screen update with when XV_VSYNC is enabled.
The default, 'auto'(-1), will sync to the display controller that more The default, 'auto'(-1), will sync to the display controller that more
of the video is on; when this is ambiguous, the display controller associated of the video is on; when this is ambiguous, the display controller associated
with the RandR primary output is preferred. This attribute is useful for with the RandR primary output is preferred.
things like clone mode where the user can best decide which display should be This attribute is useful for things like clone mode where the user
synced. can best decide which display should be synced.
The default is The default is
.B 'auto'(-1). .B 'auto'(-1).
.TP .TP
.BI "XV_BICUBIC" .B "XV_BICUBIC"
XV_BICUBIC is used to control whether textured adapter should apply XV_BICUBIC is used to control whether textured adapter should apply
a bicubic filter to smooth the output. It has three values: 'off'(0), 'on'(1) a bicubic filter to smooth the output. It has three values: 'off'(0), 'on'(1)
and 'auto'(2). 'off' means never apply the filter, 'on' means always apply and 'auto'(2).
\&'off' means never apply the filter, 'on' means always apply
the filter and 'auto' means apply the filter only if the X and Y the filter and 'auto' means apply the filter only if the X and Y
sizes are scaled to more than double to avoid blurred output. Bicubic sizes are scaled to more than double to avoid blurred output.
filtering is not currently compatible with other Xv attributes like hue, Bicubic filtering is not currently compatible with other Xv attributes like hue,
contrast, and brightness, and must be disabled to use those attributes. contrast, and brightness, and must be disabled to use those attributes.
The default is The default is
.B 'off'(0). .B 'off'(0).
.SH SEE ALSO .SH SEE ALSO
__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__) .BR Xorg (__appmansuffix__),
.BR xorg.conf (__filemansuffix__),
.BR Xserver (__appmansuffix__),
.BR X (__miscmansuffix__)
.IP " 1." 4 .IP " 1." 4
Wiki page: Wiki page:
.RS 4 .RS 4
@@ -418,7 +434,6 @@ Submit bugs & patches:
.RS 4 .RS 4
https://gitlab.freedesktop.org/xorg/driver/xf86-video-ati/ https://gitlab.freedesktop.org/xorg/driver/xf86-video-ati/
.RE .RE
.SH AUTHORS .SH AUTHORS
.nf .nf
Authors include: Authors include: