summaryrefslogtreecommitdiff
path: root/Software/LibXklavier.mdwn
diff options
context:
space:
mode:
authorJoe Rayhawk <jrayhawk@freedesktop.org>2013-05-17 22:33:44 -0700
committerJoe Rayhawk <jrayhawk@freedesktop.org>2013-05-17 22:33:44 -0700
commit6bf6871a7ca942920d9b8e26632c7e1562f99ae7 (patch)
tree0504a0daec6e7d66833f55819f2927b0b5616005 /Software/LibXklavier.mdwn
parentf788ca5b9e111807fa0368be9108d7aa9403b8a0 (diff)
moin2mdwn: convert page Software/LibXklavier
Diffstat (limited to 'Software/LibXklavier.mdwn')
-rw-r--r--Software/LibXklavier.mdwn34
1 files changed, 34 insertions, 0 deletions
diff --git a/Software/LibXklavier.mdwn b/Software/LibXklavier.mdwn
new file mode 100644
index 00000000..4e4bb8f8
--- /dev/null
+++ b/Software/LibXklavier.mdwn
@@ -0,0 +1,34 @@
+
+
+## General info
+
+libxklavier is a library providing high-level API for X Keyboard Extension known as XKB. This library is indended to support XFree86 and other commercial X servers. It is useful for creating XKB-related software (layout indicators etc).
+
+The current features are:
+
+ * Reading XKB configuration registry information (for XFree86)
+ * Configuring XKB
+ * Application-defined callbacks for many XKB-related events
+ * Support for per-window switching etc.
+Requirements:
+
+ * Proper support of XKB on X server and X client side
+ * Any version of X.Org or XFree86 4.3 or above with support of multiple layouts and base.xml/xorg.xml/xfree.xml configuration registry present
+
+## Documentation
+
+The API documentation can be found [[here|http://xlibs.freedesktop.org/xkbdesc/doc]].
+
+Short document regarding "Why multiple layouts rock" is recommended for reading - available [[in PDF format|http://xlibs.freedesktop.org/xkbdesc/xkbconfig.pdf]] and [[in OOo format|http://xlibs.freedesktop.org/xkbdesc/xkbconfig.sxw]].
+
+Some problems of XKB (and XFree implementation) are listed here: [[in PDF format|http://xlibs.freedesktop.org/xkbdesc/antixkb.pdf]] and [[in OOo format|http://xlibs.freedesktop.org/xkbdesc/antixkb.sxw]].
+## Files
+
+The released files are located at [[Sourceforge web site|http://sourceforge.net/projects/gswitchit/files/libxklavier/]].
+
+The anonymous CVS repo at freedesktop.org: :pserver:[[anoncvs@cvs.freedesktop.org|mailto:anoncvs@cvs.freedesktop.org]]:/cvs/xklavier
+
+
+## X servers support
+
+The library is designed to be usable with any X server with proper implementation of XKB extenstion. So far, it was only tested on XFree86 XKB implementation. The author is interested in supporting other X servers as well. He would be very grateful for any information/patches/feedback regarding usage of libxklavier on platforms other than XOrg/XFree86.