xenocara/driver/xf86-video-glint/man/glint.man
2012-06-02 15:55:58 +00:00

133 lines
4.4 KiB
Groff

.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH GLINT __drivermansuffix__ __vendorversion__
.SH NAME
glint \- GLINT/Permedia video driver
.SH SYNOPSIS
.nf
.B "Section \*qDevice\*q"
.BI " Identifier \*q" devname \*q
.B " Driver \*qglint\*q"
\ \ ...
.B EndSection
.fi
.SH DESCRIPTION
.B glint
is an __xservername__ driver for 3Dlabs & Texas Instruments GLINT/Permedia based video
cards. The driver is rather fully accelerated, and provides support for the
following framebuffer depths: 8, 15 (may give bad results with FBDev support),
16, 24 (32 bpp recommended, 24 bpp has problems), 30, and an 8+24 overlay mode.
.SH SUPPORTED HARDWARE
The
.B glint
driver supports 3Dlabs (GLINT MX, GLINT 500TX, GLINT 300SX, GLINT GAMMA,
GLINT DELTA, GLINT GAMMA2, Permedia, Permedia 2, Permedia 2v, Permedia 3, R3,
R4) and Texas Instruments (Permedia, Permedia 2) chips.
.SH CONFIGURATION DETAILS
Please refer to __xconfigfile__(__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
names may optionally be specified in the config file
.B \*qDevice\*q
section, and will override the auto-detection:
.PP
.RS 4
"ti_pm2", "ti_pm", "r4", "pm3", "pm2v", "pm2", "pm", "300sx", "500tx", "mx",
"gamma", "gamma2", "delta"
.RE
.PP
The driver will try to auto-detect the amount of video memory present for all
chips. If it's not detected correctly, the actual amount of video memory should
be specified with a
.B VideoRam
entry in the config file
.B \*qDevice\*q
section.
.PP
Additionally, you may need to specify the bus ID of your card with a
.B BusID
entry in the config file
.B \*qDevice\*q
section, especially with FBDev support.
.PP
The following driver
.B Options
are supported:
.TP
.BI "Option \*qUseFlatPanel\*q \*q" boolean \*q
Enable the FlatPanel feature on the Permedia3. Default: off.
.TP
.BI "Option \*qSWCursor\*q \*q" boolean \*q
Enable or disable the SW cursor. Default: off.
This option disables the
.B HWCursor
option and vice versa.
.TP
.BI "Option \*qNoAccel\*q \*q" boolean \*q
Disable or enable acceleration. Default: acceleration is enabled.
.TP
.BI "Option \*qOverlay\*q"
Enable 8+24 overlay mode. Only appropriate for depth 24, 32 bpp.
.RB ( Note:
This hasn't been tested with FBDev support and probably won't work.)
Recognized values are: "8,24", "24,8". Default: off.
.TP
.BI "Option \*qPciRetry\*q \*q" boolean \*q
Enable or disable PCI retries.
.RB ( Note:
This doesn't work with Permedia2 based cards for Amigas.) Default: off.
.TP
.BI "Option \*qShadowFB\*q \*q" boolean \*q
Enable or disable use of the shadow framebuffer layer.
.RB ( Note:
This disables hardware acceleration.) Default: off.
.TP
.BI "Option \*qUseFBDev\*q \*q" boolean \*q
Enable or disable use of an OS-specific fb interface (which is not supported
on all OSs). See fbdevhw(__drivermansuffix__) for further information.
Default: off.
.ig
.TP
.BI "Option \*qRGBbits\*q \*q" integer \*q
Each gun of the RGB triple can have either 8 or 10 bits. Default: 8
..
.TP
.BI "Option \*qBlockWrite\*q \*q" boolean \*q
Enable or disable block writes for the various Permedia 2 chips. This improves
acceleration in general, but disables it for some special cases. Default: off.
.TP
.BI "Option \*qFireGL3000\*q \*q" boolean \*q
If you have a card of the same name, turn this on. Default: off.
.TP
The Permedia 2 xv driver supports some additional options:
.TP
.BI "Option \*qDevice\*q \*q" string \*q
A path to the Permedia 2 kernel driver. This is required for Xv support.
.TP
.BI "Option \*qInputBuffers\*q \*q" integer \*q
Sets the number of buffers for incoming data. Minimum of 1, max of 2.
.TP
.BI "Option \*qInputFramesPerSec\*q \*q" integer \*q
Expected frames per second for incoming data.
.TP
.BI "Option \*qInputEncoding\*q \*q" string \*q
The encoding that input data will have.
.TP
.BI "Option \*qOutputBuffers\*q \*q" integer \*q
This should probably set the number of buffers for outgoing data. It actually
does nothing.
.TP
.BI "Option \*qOutputFramesPerSec\*q \*q" integer \*q
Expected frames per second for outgoing data.
.TP
.BI "Option \*qOutputEncoding\*q \*q" string \*q
The encoding to put output data in.
.SH "SEE ALSO"
__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__)
.SH AUTHORS
Authors include: Alan Hourihane, Dirk Hohndel, Stefan Dirsch, Michel Dänzer,
Sven Luther