diff options
author | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2009-05-22 15:48:51 +0000 |
---|---|---|
committer | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2009-05-22 15:48:51 +0000 |
commit | 3b8800decdad9eecbc06d3830acd65755f850543 (patch) | |
tree | 07c8e0b4728144dd82661441db514590f3652d2a /proto/xcb-proto/README | |
parent | b3b0dd6fd0009539e7f99ae63e0c181e241ac74e (diff) |
initial import of xcb-proto 1.4
Diffstat (limited to 'proto/xcb-proto/README')
-rw-r--r-- | proto/xcb-proto/README | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/proto/xcb-proto/README b/proto/xcb-proto/README new file mode 100644 index 000000000..22d7debca --- /dev/null +++ b/proto/xcb-proto/README @@ -0,0 +1,47 @@ +About xcb-proto +=============== + +xcb-proto provides the XML-XCB protocol descriptions that libxcb uses to +generate the majority of its code and API. We provide them separately +from libxcb to allow reuse by other projects, such as additional +language bindings, protocol dissectors, or documentation generators. + +This separation between the XCB transport layer and the +automatically-generated protocol layer also makes it far easier to write +new extensions. With the Xlib infrastructure, client-side support for +new extensions requires significant duplication of effort. With XCB and +the XML-XCB protocol descriptions, client-side support for a new +extension requires only an XML description of the extension, and not a +single line of code. + +Python libraries: xcb-proto also contains language-independent Python +libraries that are used to parse an XML description and create objects +used by Python code generators in individual language bindings. These +libraries are installed into $(prefix)/lib/pythonX.X/site-packages. If +this location is not on your system's Python path, scripts that import +them will fail with import errors. In this case you must add the +install location to your Python path by creating a file with a `.pth' +extension in a directory that _is_ on the Python path, and put the +path to the install location in that file. For example, on my system +there is a file named 'local.pth' in /usr/lib/python2.5/site-packages, +which contains '/usr/local/lib/python2.5/site-packages'. Note that +this is only necessary on machines where XCB is being built. + +Please report any issues you find to the freedesktop.org bug tracker, +at: + + <https://bugs.freedesktop.org/enter_bug.cgi?product=XCB> + +Discussion about XCB occurs on the XCB mailing list: + + <mailto:xcb at lists.freedesktop.org> + <http://lists.freedesktop.org/mailman/listinfo/xcb> + +You can obtain the latest development versions of XCB using GIT. +For anonymous checkouts, use: + + git clone git://anongit.freedesktop.org/git/xcb/proto + +For developers, use: + + git clone git+ssh://git.freedesktop.org/git/xcb/proto |