XLibre/xf86-video-r128
1
0
Fork 0
mirror of https://github.com/X11Libre/xf86-video-r128.git synced 2026-03-23 17:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve man page formatting

Browse Source 
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`

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Part-of: <https://gitlab.freedesktop.org/xorg/driver/xf86-video-r128/-/merge_requests/17>
This commit is contained in:
Alan Coopersmith
2025-06-01 14:43:27 -07:00
parent bc21fcdffa
commit 09c736ee70
1 changed files with 64 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

112
man/r128.man
View File

@@ -1,8 +1,8 @@
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH R128 __drivermansuffix__ __vendorversion__
.TH R128 __drivermansuffix__ 2024-05-14 __vendorversion__
.SH NAME
r128 \- ATI Rage 128 video driver
r128 - ATI Rage 128 video driver for Xorg
.SH SYNOPSIS
.nf
.B "Section \*qDevice\*q"
@@ -13,26 +13,26 @@ r128 \- ATI Rage 128 video driver
.fi
.SH DESCRIPTION
.B r128
is an __xservername__ driver for ATI Rage 128 based video cards. It contains
full support for 8, 15, 16 and 24 bit pixel depths, hardware
is an Xorg driver for ATI Rage 128 based video cards.
It contains full support for 8, 15, 16 and 24 bit pixel depths, hardware
acceleration of drawing primitives, hardware cursor, video modes up to
1800x1440 @ 70Hz, doublescan modes (e.g., 320x200 and 320x240), gamma
correction at all pixel depths, a fully programming dot clock and robust
text mode restoration for VT switching. Dualhead is supported on M3/M4
mobile chips.
text mode restoration for VT switching.
Dualhead is supported on M3/M4 mobile chips.
.SH SUPPORTED HARDWARE
The
.B r128
driver supports all ATI Rage 128 based video cards including the Rage
Fury AGP 32MB, the XPERT 128 AGP 16MB and the XPERT 99 AGP 8MB.
Fury AGP 32MB, the XPERT 128 AGP 16MB, and the XPERT 99 AGP 8MB.
.SH CONFIGURATION DETAILS
Please refer to __xconfigfile__(__filemansuffix__) for general configuration
details. This section only covers configuration details specific to this
driver.
Please refer to
.BR xorg.conf (__filemansuffix__)
for general configuration details.
This section only covers configuration details specific to this driver.
.PP
The driver auto-detects all device information necessary to initialize
the card. However, if you have problems with auto-detection, you can
specify:
The driver auto-detects all device information necessary to initialize the card.
However, if you have problems with auto-detection, you can specify:
.PP
.RS 4
VideoRam - in kilobytes
@@ -49,39 +49,45 @@ In addition, the following driver
are supported:
.TP
.BI "Option \*qSWcursor\*q \*q" boolean \*q
Selects software cursor. The default is
Selects software cursor.
The default is
.B off.
.TP
.BI "Option \*qNoAccel\*q \*q" boolean \*q
Enables or disables all hardware acceleration. The default is to
Enables or disables all hardware acceleration.
The default is to
.B enable
hardware acceleration.
.TP
.BI "Option \*qEnablePageFlip\*q \*q" boolean \*q
Enable page flipping for 3D acceleration. This will increase performance
but not work correctly in some rare cases, hence the default is
Enable page flipping for 3D acceleration.
This will increase performance but not work correctly in some rare cases,
hence the default is
.B off.
.TP
.BI "Option \*qRenderAccel\*q \*q" boolean \*q
Enables or disables hardware Render acceleration. It is only supported when
using EXA acceleration and DRI. The default is to
Enables or disables hardware Render acceleration.
It is only supported when using EXA acceleration and DRI.
The default is to
.B enable
Render acceleration.
.TP
.BI "Option \*qAccelMethod\*q \*q" "string" \*q
Chooses between available acceleration architectures. The only valid option is
Chooses between available acceleration architectures.
The only valid option is
.BR EXA .
XAA was the traditional acceleration architecture, but support for it has
been removed from the Xorg server and this driver.
XAA was the traditional acceleration architecture,
but support for it has been removed from the Xorg server and this driver.
EXA is a newer acceleration architecture with better performance for
the Render and Composite extensions. The default is
the Render and Composite extensions.
The default is
.BR EXA .
.TP
.BI "Option \*qVideoKey\*q \*q" integer \*q
This overrides the default pixel value for the YUV video overlay key.
The default value is
.B undefined.
.sp
.PP
The following
.B Options
@@ -96,55 +102,65 @@ The default depends on the device.
.BI "Option \*qPanelWidth\*q \*q" integer \*q
.TP
.BI "Option \*qPanelHeight\*q \*q" integer \*q
Override the flat panel dimensions in pixels. They are used to program the flat panel
registers and normally determined using the video card BIOS. If the wrong dimensions
are used, the system may hang.
Override the flat panel dimensions in pixels.
They are used to program the flat panel registers
and normally determined using the video card BIOS.
If the wrong dimensions are used, the system may hang.
.TP
.BI "Option \*qUseFBDev\*q \*q" boolean \*q
Enable or disable use of an OS-specific framebuffer device interface
(which is not supported on all OSs). See fbdevhw(__drivermansuffix__)
(which is not supported on all OSs).
See
.BR fbdevhw (__drivermansuffix__)
for further information.
Default:
.BI on
for PowerPC,
.BI off
Default:
.B on
for PowerPC,
.B off
for other architectures.
.TP
.BI "Option \*qDMAForXv\*q \*q" boolean \*q
Try or don't try to use DMA for Xv image transfers. This will reduce CPU
usage when playing big videos like DVDs, but may cause instabilities.
Try or don't try to use DMA for Xv image transfers.
This will reduce CPU usage when playing big videos like DVDs,
but may cause instabilities.
Default: off.
.sp
.PP
The following additional
.B Options
are supported:
.TP
.BI "Option \*qShowCache\*q \*q" boolean \*q
Enable or disable viewing offscreen cache memory. A
development debug option. Default: off.
Enable or disable viewing offscreen cache memory.
A development debug option.
Default: off.
.TP
.BI "Option \*qVGAAccess\*q \*q" boolean \*q
Tell the driver if it can do legacy VGA IOs to the card. This is
necessary for properly resuming consoles when in VGA text mode, but
shouldn't be if the console is using radeonfb or some other graphic
mode driver. Some platforms like PowerPC have issues with those, and they aren't
necessary unless you have a real text mode in console. The default is
Tell the driver if it can do legacy VGA IOs to the card.
This is necessary for properly resuming consoles when in VGA text mode,
but shouldn't be if the console is using radeonfb or some other graphic
mode driver.
Some platforms like PowerPC have issues with those,
and they aren't necessary unless you have a real text mode in console.
The default is
.B off
on PowerPC and SPARC and
.B on
on other architectures.
.sp
.PP
.B Dualhead Note:
.B Dualhead Note:
The video BIOS on some laptops interacts strangely with dualhead.
This can result in flickering and problems changing modes on crtc2.
If you experience these problems try toggling your laptop's video
output switch (e.g., fn-f7, etc.) prior to starting X or switch to
another VT and back.
output switch (e.g., fn-f7, etc.) prior to starting X,
or switch to another VT and back.
.sp
.SH "SEE ALSO"
__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__)
.BR Xorg (__appmansuffix__),
.BR xorg.conf (__filemansuffix__),
.BR Xserver (__appmansuffix__),
.BR X (__miscmansuffix__)
.SH AUTHORS
.nf
Rickard E. (Rik) Faith \fIfaith@precisioninsight.com\fP