README
1libkeybinder
2============
3
4:Author: Ulrik Sverdrup <ulrik.sverdrup@gmail.com>
5
6**keybinder** is a library for registering global keyboard shortcuts.
7Keybinder works with GTK-based applications using the X Window System.
8
9The library contains:
10
11* A C library, ``libkeybinder``
12* Gobject-Introspection (gir) generated bindings
13* Lua bindings, ``lua-keybinder``
14* Python bindings, ``python-keybinder``
15* An ``examples`` directory with programs in C, Lua, Python and Vala.
16
17
18Compile and Installation Notes
19------------------------------
20
21The package ``keybinder`` compiles against GTK+ 2 while the package
22``keybinder-3.0`` compiles against GTK+ 3. The two packages can be
23installed in parallel.
24
25Both packages support generating gobject-introspection (gir) bindings,
26even if these bindings are more relevant for the future, hence the GTK+
273 package. For ``keybinder-3.0``, the gir bindings are strongly
28 recommended over any other language bindings.
29
30``keybinder`` includes ``python-keybinder`` which are static python
31(PyGTK 2) bindings. If you don't have the neccessary dependencies, and
32don't want to build the python bindings, you have to explicitly disable
33them using the ``--disable-python`` option with configure.
34
35``keybinder`` and ``keybinder-3.0`` include experimental static lua
36bindings. It is possible you need to tell configure where Lua includes
37are to be found using (adjusting the path appropriately)::
38
39 ./configure CPPFLAGS=-I/usr/include/lua5.1
40
41If you want to compile with reduced library linking, configure using::
42
43 CC="cc -Wl,--as-needed" ./configure
44
45Build Requirements
46------------------
47
48 * GTK+ 3.0 (``keybinder-3.0``) or GTK+ 2.20 (``keybinder``)
49 * gobject-introspection
50 * gtk-doc 1.14
51 * Python 2.5, pygobject 2.15.3, pygobject-codegen-2.0 for
52 ``python-keybinder``
53
54History
55-------
56
57This library originates in `Tomboy`_ and has been widely reused without
58having a separate release. This package has taken the python bindings
59from the `Deskbar Applet`_ project, and broken it out to a standalone
60project. The library was subsequently rewritten in major parts.
61
62The module is licenced under the GNU General Public License v2 (or at
63your option, any later version), see the included file COPYING for
64details.
65
66.. _Tomboy: http://projects.gnome.org/tomboy/
67.. _`Deskbar Applet`: http://projects.gnome.org/deskbar-applet/
68
69.. vim: ft=rst tw=72
70