summaryrefslogtreecommitdiff
path: root/hw/xfree86/exa
diff options
context:
space:
mode:
authorEric Anholt <anholt@FreeBSD.org>2006-06-21 09:30:59 -0700
committerEric Anholt <anholt@FreeBSD.org>2006-06-23 13:56:20 -0700
commit2cf1f39ca974c81a2f52d2f7509aa3d098a87176 (patch)
treecf27dc7b6cab9bbe1204a4c34d33612a4352c444 /hw/xfree86/exa
parentd67fd106968e371d8be3966ed5ecdd3c69f36e3a (diff)
Add a manpage for EXA.
Diffstat (limited to 'hw/xfree86/exa')
-rw-r--r--hw/xfree86/exa/Makefile.am12
-rw-r--r--hw/xfree86/exa/exa.man.pre40
2 files changed, 52 insertions, 0 deletions
diff --git a/hw/xfree86/exa/Makefile.am b/hw/xfree86/exa/Makefile.am
index 8e85e1ede..7f0a20e4c 100644
--- a/hw/xfree86/exa/Makefile.am
+++ b/hw/xfree86/exa/Makefile.am
@@ -14,3 +14,15 @@ libexa_la_SOURCES = \
libexa_la_LIBADD = \
../../../exa/libexa.la
+
+include $(top_srcdir)/cpprules.in
+
+drivermandir = $(DRIVER_MAN_DIR)
+driverman_DATA = exa.$(DRIVER_MAN_SUFFIX)
+CLEANFILES = $(driverman_DATA) exa.man
+
+exa.$(DRIVER_MAN_SUFFIX): exa.man
+ -rm -f exa.$(DRIVER_MAN_SUFFIX)
+ $(LN_S) exa.man exa.$(DRIVER_MAN_SUFFIX)
+
+EXTRA_DIST = exa.man.pre README
diff --git a/hw/xfree86/exa/exa.man.pre b/hw/xfree86/exa/exa.man.pre
new file mode 100644
index 000000000..ea41b90e4
--- /dev/null
+++ b/hw/xfree86/exa/exa.man.pre
@@ -0,0 +1,40 @@
+.\" shorthand for double quote that works everywhere.
+.ds q \N'34'
+.TH EXA __drivermansuffix__ __vendorversion__
+.SH NAME
+exa \- new 2D acceleration architecture for X.Org
+.SH DESCRIPTION
+.B EXA
+provides a simple API for video drivers to implement for 2D acceleration. It
+is a module loaded by drivers, and is not intended to be loaded on its own. See
+your driver's manual page for how to enable
+.B EXA
+.
+.PP
+The
+.B EXA
+architecture is designed to make accelerating the Render extension simple and
+efficient, and results in various performance tradeoffs compared to XAA. Some
+options are available for debugging performance issues or driver rendering
+problems. They are not intended for general use.
+.TP
+.BI "Option \*qEXANoComposite\*q \*q" boolean \*q
+Disables acceleration of the Composite operation, which is at the heart of
+the Render extension. Not related to the Composite extension. Default: No.
+.TP
+.BI "Option \*qEXANoUploadToScreen\*q \*q" boolean \*q
+Disables acceleration of uploading pixmap data to the freamebuffer. Default: No.
+.TP
+.BI "Option \*qEXANoDownloadFromScreen\*q \*q" boolean \*q
+Disables acceleration of downloading of pixmap data from the framebuffer.
+.B NOTE:
+Not usable with drivers which rely on DownloadFromScreen succeeding.
+Default: No.
+.TP
+.BI "Option \*qMigrationHeuristic\*q \*q" anystr \*q
+Chooses an alternate pixmap migration heuristic, for debugging purposes. The
+default is intended to be the best performing one for general use, though others
+may help with specific use cases. Available options include \*qalways\*q,
+\*qgreedy\*q, and \*qsmart\*q. Default: smart.
+.SH AUTHORS
+Authors include: Keith Packard, Eric Anholt, Zack Rusin, and Michel Dänzer