eekboard - an easy to use virtual keyboard toolkit -*- outline -*-

eekboard is a virtual keyboard software package, including a set of
tools to implement desktop virtual keyboards.

* How to build

** Dependencies

REQUIRED: GLib2, GTK, GConf2, PangoCairo, libxklavier, libcroco
OPTIONAL: fakekey, CSPI, Clutter, Clutter-Gtk, Vala, gobject-introspection

** Build from git repo

  $ git clone git://github.com/ueno/eekboard.git
  $ cd eekboard
  $ ./autogen.sh --prefix=/usr --enable-gtk-doc
  $ make
  $ sudo make install

** Build from tarball

  $ ./configure --prefix=/usr
  $ make
  $ sudo make install

* How to test

eekboard currently includes 4 tools to implement your own virtual
keyboard.

** eekboard-server

eekboard-server is a D-Bus server which is responsible for drawing
interactive on-screen keyboards.  Since it has a D-Bus service
activation entry, you will not need to start it manually, but you can
do that with:

  $ eekboard-server &

** eekboard-desktop-client

eekboard-desktop-client is a client of eekboard-server.  It listens
desktop events (keyboard change, focus in/out, and keystroke) and
generates key events when some keys are pressed on the on-screen
keyboard.  It can be started with:

  $ eekboard-desktop-client

** eekboard-xml

eekboard-xml is a tool to manipulate XML keyboard description used by
eekboard-client tool and in the eekboard library.

To dump the current system keyboard layout into an XML file:

  $ eekboard-xml --dump > keyboard.xml

You can display the dumped layout with:

  $ eekboard-xml --load keyboard.xml

** eekboard-client

eekboard-client is a simple test client of eekboard-server.  To upload
the keyboard description to the server, display it, and listen
key events.

  $ eekboard-client --set-keyboard keyboard.xml --show-keyboard --listen
  KeyPressed XXXXX
  KeyReleased XXXXX

* Documentation

See file:docs/reference/eek/html/index.html