Table of Contents
=================

1.   Requirements
1.1  Software when using the daemon
1.2  Software needed to compile
1.3  How to build
1.4  Build Problems
2.   Installation
3.   Running
3.1  Systray program
3.2  Daemon
4.   Problems
4.1. "Daemon already running"
4.2. Crashes
4.3. USB
4.4. Some keys don't work for a user


1. Requirements
===============

1.1 Software when using the daemon
----------------------------------
* aumix
* eject
* evolution
* kcalc
* konqueror
* xmms
+ other software for which keyman is preconfigured for

1.2 Software needed to compile
------------------------------
* make
* gcc (the compiler collection)
* X11 development files
* QT (threaded version) + development files
* kde + development files
* libtool
* xerces + development files
* kernel header files (for inputdev plugin and input tunnel)
  (usually installed under /usr/include/linux)

1.3 How to build
------------------
Configure project
  ./configure
Build project
  make
Build binary archive package
  make package_bin
Build deb (Debian) package
  * debian packages are build from a clean tree
  * become root (su or sudo or whatever you like)
    ./debian/rules binary
  * the result is a debian package in the folder above the source folder
Build rpm (SuSE) package
  make package_rpm
Build source archive
  make package_src

All packages are built in the directory above the top level directory except
the rpm package which can be found in /usr/src/packages/RPMS/<arch> where
"<arch>" is something like "i586" (look at the output when building).


1.4 Build Problems
------------------
SuSE 9.1 ships a version of make that is not fully functional (GNU make version
3.80 has bugs which are known). In any case try an online update.
If you get "missing separator":
  Make tries to re-configure the package because some *.in files have
  changed. In that case just run "./configure" in the top-level directory.
If you get "memory exhausted":
   Download the latest cvs version.
      (It makes me wonder BTW why it did work on the other SuSE9.1 installation
       - maybe they fixed that problem by using the online update/patching
       system)
	In general this shouldn't happen as a workaround is integrated in the
   respective Makefiles.


2. Installation
===============
see INSTALL


3. Running
==========

3.1 Systray program
-------------------
Start systray program
   If you have installed the package a KDE-Menu Entry should have been created.
   Start the systray Application by selecting the "Keyman" entry.
   Otherwise run it manually by executing "kkeymansystray".
   The systray program takes care of starting the daemon automagically.


3.2 Server
----------
start server program
	a) with default (configurated) plugin
      * keymanserver
   b) with kde gui plugin
      * keymanserver --plugin /usr/share/keyman/plugins/kde-gui.so
   c) with console plugin
      * keymanserver --plugin /usr/share/cherry/plugins/console.so
To end the server
   press control+c (in case of the console plugin)
or type
	keymanserver --quit (console or kde-gui)


4. Problems
===========

4.1. "Server already running"
-----------------------------
If you see a message saying that the daemon is already running although the
daemon is actually not running, delete the file "/tmp/KeymanSocket_<UserName>".

4.2. Crashes
------------
If you installed the binary version and you get crashes, then this might be
due to differences in the installed packages on the build machine and your
machine. In this case try building from source.

4.3. USB
--------
If you want to use the additional keys of your CyMotion Linux keyboard with
USB, you have to recompile the kernel-module "hid".
For further instructions on how to recompile parts of your kernel, please see
documentation included in your distribution or visit www.kernel.org
Apply cymolin/kernel/drivers/usb/input/hid-input.c.diff to
/usr/src/linux/drivers/usb/input/hid-input.c before compiling.

Example:
cd /usr/src/linux/drivers/usb/input
patch hid-input.c < $HOME/cymolin/kernel/hid-input.c.diff

If you want to use a "normal" CyMotion Master Solar or a
CyMotion Master XPress, you also have to apply
cymolin/kernel/drivers/usb/input/hid-core.c.diff

And don't forget to copy your changed hid-module to the appropriate
location and do a "rmmod hid" and a "modprobe hid" or simply
reboot your system

4.4. Some keys don't work for a user
------------------------------------
* check wether the keys are configured correctly
* check wether the user is in the group "keyman"
