summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorAlan Coopersmith <alan.coopersmith@sun.com>2006-08-24 16:53:08 -0700
committerAlan Coopersmith <alan.coopersmith@sun.com>2006-08-24 16:53:08 -0700
commit2633eaf8824828433a0eb9c9f3c4263b50342473 (patch)
tree738d6a5fcf4cd913d6b05e3ea1d52033d0e9d3cc /README
parent02ffb657b023d9b2a2c6c1d2417da8dcb96aa4b2 (diff)
Try to capture the insanity of xtrans in a short README document
Diffstat (limited to 'README')
-rw-r--r--README13
1 files changed, 13 insertions, 0 deletions
diff --git a/README b/README
index 8b13789..551f129 100644
--- a/README
+++ b/README
@@ -1 +1,14 @@
+xtrans is a library of code that is shared among various X packages to handle
+network protocol transport in a modular fashion, allowing a single place to
+add new transport types. It is used by the X server, libX11, libICE, the
+X font server, and related components.
+It is however, *NOT* a shared library, but code which each consumer includes and
+builds it's own copy of with various #ifdef flags to make each copy slightly
+different. To support this in the modular build system, this package simply
+installs the C source files into $(prefix)/include/X11/Xtrans and installs a
+pkg-config file and an autoconf m4 macro file with the flags needed to use it.
+
+Documentation of the xtrans API can be found in the xorg-docs package, in
+PostScript format in xorg-docs/hardcopy/xtrans/Xtrans.PS.gz and in the original
+troff format in xorg-docs/specs/xtrans/Xtrans.mm . \ No newline at end of file