summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlan Coopersmith <alan.coopersmith@oracle.com>2025-06-01 14:54:16 -0700
committerAlan Coopersmith <alan.coopersmith@oracle.com>2025-06-01 14:54:16 -0700
commit2c07686dde0a79aaca88e7404e53724eaa54ddc5 (patch)
tree199e431c383025c622e9f29b2421fb6850bd53db
parent49d50f1fdeb4dc81895fec81be9fae1dc78e5974 (diff)
Improve man page formattingHEADmaster
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-rendition/-/merge_requests/5>
-rw-r--r--man/rendition.man86
1 files changed, 48 insertions, 38 deletions
diff --git a/man/rendition.man b/man/rendition.man
index afeee91..68a9a8c 100644
--- a/man/rendition.man
+++ b/man/rendition.man
@@ -1,8 +1,8 @@
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
-.TH RENDITION __drivermansuffix__ __vendorversion__
+.TH RENDITION __drivermansuffix__ 2009-01-09 __vendorversion__
.SH NAME
-rendition \- Rendition video driver
+rendition \- Rendition video driver for Xorg
.SH SYNOPSIS
.nf
.B "Section \*qDevice\*q"
@@ -12,28 +12,31 @@ rendition \- Rendition video driver
.B EndSection
.fi
.SH DESCRIPTION
-.B rendition
-is an __xservername__ driver for Rendition/Micron based video cards. The driver
-supports following framebuffer depths: 8, 15 (Verite V1000 only), 16
-and 24. Acceleration and multi-head configurations are
-not supported yet, but are work in progress.
+.B rendition
+is an Xorg driver for Rendition/Micron based video cards.
+The driver supports following framebuffer depths:
+8, 15 (Verite V1000 only), 16, and 24.
+Acceleration and multi-head configurations are not supported.
.SH SUPPORTED HARDWARE
The
.B rendition
-driver supports PCI and AGP video cards based on the following Rendition/Micron chips:
+driver supports PCI and AGP video cards based on
+the following Rendition/Micron chips:
.TP 12
.B V1000
Verite V1000 based cards.
.TP 12
.B V2100
-Verite V2100 based cards. Diamond Stealth II S220 is the only known such card.
+Verite V2100 based cards.
+Diamond Stealth II S220 is the only known such card.
.TP 12
.B V2200
Verite V2200 based cards.
.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 the chipset type, but the following
.B ChipSet
@@ -45,9 +48,9 @@ section, and will override the auto-detection:
"v1000", "v2x00".
.RE
.PP
-The driver will auto-detect the amount of video memory present for all
-chips. If the amount of memory is detected incorrectly, the actual amount
-of video memory should be specified with a
+The driver will auto-detect the amount of video memory present for all chips.
+If the amount of memory is detected incorrectly,
+the actual amount of video memory should be specified with a
.B VideoRam
entry in the config file
.B \*qDevice\*q
@@ -58,54 +61,61 @@ The following driver
are supported:
.TP
.BI "Option \*qSWCursor\*q \*q" boolean \*q
-Disables use of the hardware cursor. Default: use HW-cursor.
+Disables use of the hardware cursor.
+Default: use HW-cursor.
.TP
.BI "Option \*qOverclockMem\*q \*q" boolean \*q
Increases the Mem/Sys clock to 125MHz/60MHz from standard 110MHz/50MHz.
Default: Not overclocked.
.TP
.BI "Option \*qDacSpeed\*q \*q" MHz \*q
-Run the memory at a higher clock. Useful on some cards with display glitches
-at higher resolutions. But adds the risk to damage the hardware. Use with
-caution.
+Run the memory at a higher clock.
+Useful on some cards with display glitches at higher resolutions,
+but adds risk to damage the hardware.
+.B Use with caution.
.TP
.BI "Option \*qFramebufferWC\*q \*q" boolean \*q
If writecombine is disabled in BIOS, and you add this option in configuration
-file, then the driver will try to request writecombined access to the
-framebuffer. This can drastically increase the performance on unaccelerated
-server. Requires that "MTRR"-support is compiled into the OS-kernel.
+file, then the driver will try to request writecombined access to the
+framebuffer.
+This can drastically increase the performance on unaccelerated server.
+Requires that "MTRR"-support is compiled into the OS-kernel.
Default: Disabled for V1000, enabled for V2100/V2200.
.TP
.BI "Option \*qNoDDC\*q \*q" boolean \*q
-Disable probing of DDC-information from your monitor. This information is not
-used yet and is only there for informational purposes.
-Safe to disable if you experience problems
-during startup of X-server.
+Disable probing of DDC-information from your monitor.
+This information is not used yet and is only there for informational purposes.
+Safe to disable if you experience problems during startup of X-server.
Default: Probe DDC.
.TP
.BI "Option \*qShadowFB\*q \*q" boolean \*q
If this option is enabled, the driver will cause the CPU to do each drawing
operation first into a shadow frame buffer in system virtual memory and then
-copy the result into video memory. If this option is not active, the CPU will
-draw directly into video memory. Enabling this option is beneficial for those
+copy the result into video memory.
+If this option is not active, the CPU will draw directly into video memory.
+Enabling this option is beneficial for those
systems where reading from video memory is, on average, slower than the
-corresponding read/modify/write operation in system virtual memory. This is
-normally the case for PCI or AGP adapters, and, so, this option is enabled by
-default unless acceleration is enabled.
+corresponding read/modify/write operation in system virtual memory.
+This is normally the case for PCI or AGP adapters,
+and, so, this option is enabled by default unless acceleration is enabled.
Default: Enabled unless acceleration is used.
.TP
-.BI "Option \*qRotate\*q \*qCW\*q"
-.TP
-.BI "Option \*qRotate\*q \*qCCW\*q"
-Rotate the display clockwise or counterclockwise. This mode is unaccelerated.
+.B "Option \*qRotate\*q \*qCW\*q"
+.TQ
+.B "Option \*qRotate\*q \*qCCW\*q"
+Rotate the display clockwise or counterclockwise.
+This mode is unaccelerated.
Default: no rotation.
-.TP
.SH "Notes"
For the moment the driver defaults to not request write-combine for any chipset
-as there has been indications of problems with it. Use
+as there has been indications of problems with it.
+Use
.B "Option \*qMTRR\*q"
to let the driver request write-combining of memory access on the video board.
.SH "SEE ALSO"
-__xservername__(1), __xconfigfile__(__filemansuffix__), Xserver(1), X(__miscmansuffix__)
+.BR Xorg (1),
+.BR xorg.conf (__filemansuffix__),
+.BR Xserver (1),
+.BR X (__miscmansuffix__)
.SH AUTHORS
Authors include: Marc Langenbach, Dejan Ilic