534a0be65cbf44893fb6507eee88a9899d5fcd7a
[framework/uifw/xorg/xcb/xcb-util.git] / README
1 About XCB util
2 ==============
3
4 The xcb-util module provides a number of libraries which sit on top of
5 libxcb, the core X protocol library, and some of the extension
6 libraries. These experimental libraries provide convenience functions
7 and interfaces which make the raw X protocol more usable. Some of the
8 libraries also provide client-side code which is not strictly part of
9 the X protocol but which have traditionally been provided by Xlib.
10
11 These libraries are currently included, roughly ordered by maturity:
12
13 render-util: Convenience functions for the Render extension.
14 aux: Convenient access to connection setup and some core requests.
15 atom: Standard core X atom constants and atom caching.
16 property: Callback X property-change handling.
17 icccm: Both client and window-manager helpers for ICCCM.
18 keysyms: Standard X key constants and conversion to/from keycodes.
19 event: Callback X event handling.
20 image: Port of Xlib's XImage and XShmImage functions.
21
22 If you find any of these libraries useful, please let us know what
23 you're using and why you aren't in a mental hospital yet. We'd welcome
24 patches/suggestions for enhancement and new libraries; Please report any
25 issues you find to the freedesktop.org bug tracker, at:
26
27         <https://bugs.freedesktop.org/enter_bug.cgi?product=XCB>
28
29 Discussion about XCB occurs on the XCB mailing list:
30
31         <mailto:xcb at lists.freedesktop.org>
32         <http://lists.freedesktop.org/mailman/listinfo/xcb>
33
34 You can obtain the latest development versions of XCB using GIT.
35 For anonymous checkouts, use:
36
37         git clone git://anongit.freedesktop.org/git/xcb/util
38
39 For developers, use:
40
41         git clone git+ssh://git.freedesktop.org/git/xcb/util