summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlan Coopersmith <alan.coopersmith@oracle.com>2025-07-12 14:47:16 -0700
committerAlan Coopersmith <alan.coopersmith@oracle.com>2025-07-12 14:47:16 -0700
commitb85bbe52e6c42d63e3b792af2dca053ac0b01e8b (patch)
tree0120acdcee3757ccbe6f8aca6e4a11e17c593a21
parentfddaa2084b9aac51a845ee1ede8c498cbc9330cf (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-trident/-/merge_requests/11>
-rw-r--r--man/trident.man93
1 files changed, 56 insertions, 37 deletions
diff --git a/man/trident.man b/man/trident.man
index d84150a..7e68f26 100644
--- a/man/trident.man
+++ b/man/trident.man
@@ -1,6 +1,6 @@
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
-.TH TRIDENT __drivermansuffix__ __vendorversion__
+.TH TRIDENT 4 2024-05-19 __vendorversion__
.SH NAME
trident \- Trident video driver
.SH SYNOPSIS
@@ -13,9 +13,13 @@ trident \- Trident video driver
.fi
.SH DESCRIPTION
.B trident
-is an __xservername__ driver for Trident video cards. The driver is
-accelerated, and provides support for the following framebuffer depths:
-1, 4, 8, 15, 16, and 24. Multi-head configurations are supported.
+is an
+.B Xorg
+driver for Trident video cards.
+The driver is accelerated,
+and provides support for the following framebuffer depths:
+1, 4, 8, 15, 16, and 24.
+Multi-head configurations are supported.
The XvImage extension is supported on TGUI96xx and greater cards.
.SH SUPPORTED HARDWARE
The
@@ -40,45 +44,54 @@ CyberBlade/e4, CyberBladeXP, CyberBladeAi1/XP, BladeXP
8900C, 8900D, 9000, 9200CXr, Cyber9320, 9400CXi, 9440AGi
These cards have been ported but need further testing and may not work.
.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 (5)
+for general configuration details.
+This section only covers configuration details specific to this driver.
.PP
The following driver
.B Options
are supported:
.TP
.BI "Option \*qSWCursor\*q \*q" boolean \*q
-Enable or disable the SW cursor. Default: off.
+Enable or disable the SW cursor.
+Default: off.
.TP
.BI "Option \*qNoAccel\*q \*q" boolean \*q
-Disable or enable acceleration. Default: acceleration is enabled.
+Disable or enable acceleration.
+Default: acceleration is enabled.
.TP
.BI "Option \*qPciRetry\*q \*q" boolean \*q
-Enable or disable PCI retries. Default: off.
+Enable or disable PCI retries.
+Default: off.
.TP
.BI "Option \*qCyberShadow\*q \*q" boolean \*q
-For Cyber chipsets only, turn off shadow registers. If you only see
-a partial display - this may be the option for you. Default: on.
+For Cyber chipsets only, turn off shadow registers.
+If you only see a partial display - this may be the option for you.
+Default: on.
.TP
.BI "Option \*qCyberStretch\*q \*q" boolean \*q
-For Cyber chipsets only, turn on stretching. When the resolution is lower
-than the LCD's screen, this option will stretch the graphics mode to
-fill the entire LCD. Default: off.
+For Cyber chipsets only, turn on stretching.
+When the resolution is lower than the LCD's screen,
+this option will stretch the graphics mode to fill the entire LCD.
+Default: off.
.TP
.BI "Option \*qShadowFB\*q \*q" boolean \*q
-Enable or disable use of the shadow framebuffer layer. Default: off.
+Enable or disable use of the shadow framebuffer layer.
+Default: off.
.TP
.BI "Option \*qVideoKey\*q \*q" integer \*q
This sets the default pixel value for the YUV video overlay key.
Default: undefined.
.TP
.BI "Option \*qTVChipset\*q \*q" string \*q
-This sets the TV chipset. Options are CH7005 or VT1621.
+This sets the TV chipset.
+Options are CH7005 or VT1621.
Default: off.
.TP
.BI "Option \*qTVSignal\*q \*q" integer \*q
-This sets the TV signalling. Options are 0 for NTSC or 1 for PAL.
+This sets the TV signalling.
+Options are 0 for NTSC or 1 for PAL.
Default: undefined.
.TP
.BI "Option \*qNoPciBurst\*q \*q" boolean \*q
@@ -87,26 +100,26 @@ Default: off.
.TP
.BI "Option \*qXvHsync\*q \*q" integer \*q
Override the default Horizontal-sync value for the Xv extension.
-This is used to center the Xv image on the screen. By default the values
-are assigned based on the video card.
+This is used to center the Xv image on the screen.
+By default the values are assigned based on the video card.
Default: 0.
.TP
.BI "Option \*qXvVsync\*q \*q" integer \*q
Override the default Vertical-sync value for the Xv extension.
-This is used to center the Xv image on the screen. By default the values
-are assigned based on the video card.
+This is used to center the Xv image on the screen.
+By default the values are assigned based on the video card.
Default: 0.
.TP
.BI "Option \*qXvBskew\*q \*q" integer \*q
Override the default Bottom skew value for the Xv extension.
-This is used to extend the Xv image on the screen at the bottom. By
-default the values are assigned based on the video card.
+This is used to extend the Xv image on the screen at the bottom.
+By default the values are assigned based on the video card.
Default: 0.
.TP
.BI "Option \*qXvRskew\*q \*q" integer \*q
Override the default Right skew value for the Xv extension.
-This is used to extend the Xv image on the screen at the right. By
-default the values are assigned based on the video card.
+This is used to extend the Xv image on the screen at the right.
+By default the values are assigned based on the video card.
Default: 0.
.TP
.BI "Option \*qDisplay\*q \*q" string \*q
@@ -120,19 +133,25 @@ Inform driver to expect 1400x1050 display instead of a 1280x1024.
Default: off.
.TP
.BI "Option \*qGammaBrightness\*q \*q" string \*q
-Set display gamma value and brightness. \*q\fIstring\fP\*q is
-\*q\fIgamma\fP, \fIbrightness\fP\*q, where \fIgamma\fP is a floating
-point value greater than 0 and less or equal to 10. \fIbrightness\fP is
-an integer value greater or equal to 0 and less than 128.
-Default: gamma and brightness control is turned off.
+Set display gamma value and brightness.
+\*q\fIstring\fP\*q is \*q\fIgamma\fP, \fIbrightness\fP\*q,
+where \fIgamma\fP is a floating point value greater than 0 and
+less or equal to 10, and \fIbrightness\fP is
+an integer value greater or equal to 0 and less than 128.
+Default: gamma and brightness control is turned off.
Note: This is not supported on all chipsets.
+.TP
.BI "Option \*qAccelMethod\*q \*q" string \*q
-Choose acceleration architecture, currently only "EXA". XAA was the old
-(but stable) XFree86 based acceleration architecture, but is no longer available.
-EXA is a newer and
-simpler acceleration architecture designed to better accelerate the X Render
-extension. Default: "EXA".
+Choose acceleration architecture, currently only "EXA".
+XAA was the old (but stable) XFree86 based acceleration architecture,
+but is no longer available.
+EXA is a newer and simpler acceleration architecture designed to
+better accelerate the X Render extension.
+Default: "EXA".
.SH "SEE ALSO"
-__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__)
+.BR Xorg (1),
+.BR Xserver (1),
+.BR xorg.conf (5),
+.BR X (7)
.SH AUTHOR
Author: Alan Hourihane, EXA for Blade chips by Jesse Barnes