Files
xf86-video-mga/man/mga.man
Alan Coopersmith 983cff1eb9 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`

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Part-of: <https://gitlab.freedesktop.org/xorg/driver/xf86-video-mga/-/merge_requests/16>
2025-12-15 17:31:22 +01:00

190 lines
5.8 KiB
Groff

.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH MGA __drivermansuffix__ 2024-05-14 __vendorversion__
.SH NAME
mga \- Matrox video driver for Xorg
.SH SYNOPSIS
.nf
.B "Section \*qDevice\*q"
.BI " Identifier \*q" devname \*q
.B " Driver \*qmga\*q"
\ \ ...
.B EndSection
.fi
.SH DESCRIPTION
.B mga
is an Xorg driver for Matrox video cards.
The driver is fully accelerated,
and provides support for the following framebuffer depths:
8, 15, 16, 24, and an 8+24 overlay mode.
All visual types are supported for depth 8,
and both TrueColor and DirectColor visuals are supported for the other depths,
except 8+24 mode which supports PseudoColor, GrayScale, and TrueColor.
Multi\-card configurations are supported.
XVideo is supported on G200 and newer systems, with either
.B TexturedVideo
or video overlay.
The second head of dual-head cards is supported for the G450 and G550.
.SH "SUPPORTED HARDWARE"
The
.B mga
driver supports PCI and AGP video cards based on the following Matrox chips.
They are listed in approximate chronological order of production
(with the most recent chipsets listed last), so consult this list when you
are unsure whether your card is meant when references are made to \(oqG200
and later\(cq chips, for example.
.TP
.B MGA2064W
.TQ
.B MGA1064SG
Mystique
.TP
.B MGA2164W
Millennium II
.TP
.B G100
Productiva G100
.TP
.B G200
Millennium G200 and Mystique G200
.TP
.B G400
Millennium G400, Millennium G400 MAX, Millennium G450, and Marvel G450 eTV
.TP
.B G550
Millennium G550 and Millennium G550 Dual DVI
.SH "CONFIGURATION DETAILS"
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
names may optionally be specified in the config file
.B \*qDevice\*q
section, and will override the auto-detection:
.PP
.RS 4
"mga2064w", "mga1064sg", "mga2164w", "mga2164w agp", "mgag100", "mgag200",
"mgag200 pci", "mgag400", "mgag550".
.RE
.PP
The G450 is Chipset "mgag400" with ChipRev 0x80.
.PP
The driver will auto-detect the amount of video memory present for all
chips except the Millennium II.
In the Millennium II case it defaults to 4096\ kBytes.
When using a Millennium II,
the actual amount of video memory should be specified with a
.B VideoRam
entry in the config file
.B \*qDevice\*q
section.
.PP
The following driver
.B Options
are supported:
.TP
.BI "Option \*qColorKey\*q \*q" integer \*q
Set the colormap index used for the transparency key for the depth 8 plane
when operating in 8+24 overlay mode.
The value must be in the range 2\(en255.
Default: 255.
.TP
.BI "Option \*qHWCursor\*q \*q" boolean \*q
Enable or disable the HW cursor.
Default: on.
.TP
.BI "Option \*qMGASDRAM\*q \*q" boolean \*q
Specify whether G100, G200 or G400 cards have SDRAM.
The driver attempts to auto-detect this based on the card's PCI subsystem ID.
This option may be used to override that auto-detection.
The
.B mga
driver is not able to auto-detect the presence of of SDRAM on secondary
heads in multihead configurations so this option will often need to be
specified in multihead configurations.
Default: auto-detected.
.TP
.BI "Option \*qNoAccel\*q \*q" boolean \*q
Disable or enable acceleration.
Default: acceleration is enabled.
.TP
.BI "Option \*qAccelMethod\*q \*q" "string" \*q
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 X server and this driver.
EXA is a newer acceleration architecture with better performance for
the Render and Composite extensions,
but the rendering code for it is newer and possibly unstable.
The default is
.BR EXA .
.TP
.B "Option \*qOverclockMem\*q"
Set clocks to values used by some commercial X Servers
(G100, G200 and G400 only).
Default: off.
.TP
.BI "Option \*qPciRetry\*q \*q" boolean \*q
Enable or disable PCI retries.
Default: off.
.TP
.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
.BI "Option \*qShadowFB\*q \*q" boolean \*q
Enable or disable use of the shadow framebuffer layer.
Default: off.
.TP
.BI "Option \*qSyncOnGreen\*q \*q" boolean \*q
Enable or disable combining the sync signals with the green signal.
Default: off.
.TP
.BI "Option \*qUseFBDev\*q \*q" boolean \*q
Enable or disable use of an OS\-specific fb interface (and is not supported
on all OSs).
See
.BR fbdevhw (__drivermansuffix__)
for further information.
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 \*qTexturedVideo\*q \*q" boolean \*q
This has XvImage support use the texture engine rather than the video
overlay.
This option is only supported by G200 and later chips,
and only at 16 and 32 bits per pixel.
Default: off.
.TP
.BI "Option \*qOldDmaInit\*q \*q" boolean \*q
This forces the driver to use the old DMA initialization path for DRI.
Use this option only to support a older version of the DRI driver with
a newer DRM (version 3.2 or later).
This option also disables the use of direct rendering on PCI cards.
Default: off.
.TP
.BI "Option \*qForcePciDma\*q \*q" boolean \*q
This forces the use of PCI DMA even if AGP DMA could be used.
This option is primarily intended for testing purposes, but it could also
be used on systems with a buggy or poorly function AGP implementation.
Default: off.
.SH "SEE ALSO"
.BR Xorg (__appmansuffix__),
.BR xorg.conf (__filemansuffix__),
.BR Xserver (__appmansuffix__),
.BR X (__miscmansuffix__)
.SH AUTHORS
Authors include: Radoslaw Kapitan, Mark Vojkovich, and also David Dawes, Guy
Desbief, Dirk Hohndel, Doug Merritt, Andrew E. Mileski, Andrew van der Stock,
Leonard N. Zubkoff, Andrew C. Aitchison.