XLibre/xf86-video-voodoo
1
0
Fork 0
mirror of https://github.com/X11Libre/xf86-video-voodoo.git synced 2026-03-24 01:25:25 +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-voodoo/-/merge_requests/10>
This commit is contained in:
Alan Coopersmith
2025-07-12 15:53:12 -07:00
committed by Enrico Weigelt, metux IT consult
parent e2ac2877e7
commit ffe253c110
1 changed files with 41 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
man/voodoo.man
View File

@@ -1,6 +1,6 @@
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH VOODOO __drivermansuffix__ __vendorversion__
.TH VOODOO 4 2009-01-09 __vendorversion__
.SH NAME
voodoo \- Voodoo video driver
.SH SYNOPSIS
@@ -12,60 +12,71 @@ voodoo \- Voodoo video driver
.B EndSection
.fi
.SH DESCRIPTION
.B voodoo
is an __xservername__ driver for Voodoo 1 and Voodoo 2 series video adapters.
.B voodoo
is an
.BR Xorg (1)
driver for Voodoo 1 and Voodoo 2 series video adapters.
On the Voodoo 1 the driver uses a shadow buffer in system memory as
the video adapter has only 3D acceleration. Selected portions of the shadow
framebuffer are copied out to the Voodoo board at the right time. Because
of this, the speed of the driver is very dependent on the CPU. Processors
nowadays are actually rather fast at moving data so we get very good speed
anyway as the shadow framebuffer is in cached RAM.
the video adapter has only 3D acceleration.
Selected portions of the shadow framebuffer are copied out
to the Voodoo board at the right time.
Because of this, the speed of the driver is very dependent on the CPU.
Processors nowadays are actually rather fast at moving data so we get
very good speed anyway as the shadow framebuffer is in cached RAM.
.PP
The Voodoo2 has 16bpp acceleration and the driver provides accelerated
versions of most operations except angled lines and stipples. Accelerated
alpha blending with the Render extension is also supported as is DGA.
versions of most operations except angled lines and stipples.
Accelerated alpha blending with the Render extension is also supported,
as is DGA.
.PP
This driver supports 16bpp modes currently. The video hardware supports
image conversion from 24bpp to 16bpp but the hardware is 16bpp only.
This driver supports 16bpp modes currently.
The video hardware supports image conversion from 24bpp to 16bpp
but the hardware is 16bpp only.
.PP
The Voodoo 1 series cards can go up to 800x600 resolution while the
The Voodoo 1 series cards can go up to 800x600 resolution, while the
Voodoo 2 can reach 1024x768 providing it has at least 2Mb of frame
buffer memory. 1024x768 2D mode does not require two cards configured in
buffer memory.
1024x768 2D mode does not require two cards configured in
scan-line interleave mode (SLI).
.PP
Multihead and Xinerama configurations are supported. SLI configurations will
be treated as multiple video cards.
Multihead and Xinerama configurations are supported.
SLI configurations will be treated as multiple video cards.
.PP
Limited support for DPMS screen saving is available. The "standby" and
"suspend" modes are just painting the screen black. The "off" mode turns
the Voodoo board off and thus works correctly.
Limited support for DPMS screen saving is available.
The "standby" and "suspend" modes are just painting the screen black.
The "off" mode turns the Voodoo board off and thus works correctly.
.PP
This driver does not support a virtual screen size different from the
display size. This is a hardware limitation. 3D rendering is also not
supported.
display size.
This is a hardware limitation. 3D rendering is also not supported.
.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 \*qShadowFB\*q \*q" boolean \*q
Enables a shadow buffer in main memory. This turns off acceleration but for
Enables a shadow buffer in main memory.
This turns off acceleration but for
otherwise unaccelerated operations can improve performance materially.
Default: off for voodoo2, on for voodoo1.
.TP
.BI "Option \*qNoAccel\*q \*q" boolean \*q
Disables acceleration if set. Unless debugging this option should only
be set if ShadowFB is enabled.
Default: off for voodoo2, on for voodoo1.
Disables acceleration if set.
Unless debugging this option should only be set if ShadowFB is enabled.
Default: off for voodoo2, on for voodoo1.
.SH "BUGS"
The driver interacts badly with the
sstfb frame buffer driver as there is insufficient information to restore
the chip to its previous state.
the chip to its previous state.
.SH "SEE ALSO"
__xservername__(1), __xconfigfile__(__filemansuffix__), Xserver(1), X(__miscmansuffix__)
.BR Xorg (1),
.BR Xserver (1),
.BR xorg.conf (5),
.BR X (7)
.SH AUTHORS
Authors: Alan Cox, Ghozlane Toumi, Henrik Harmsen.