  LinEAK - Linux support for Easy Access and Internet Keyboards      
  Copyright (C) 2001,2002 Mark Smulders <Mark@PIRnet.nl>
  http://lineak.sourceforge.net


## Installation instructions:

  IMPORTANT NOTE: lineakd 0.3.3 and 0.3.4 are only compatible with
                  lineakconfig 0.3.1 or higher

  - download the lineakd-x.x.tar.gz into your homedir
  - unpack the source (eg. "tar zxvf lineakd-x.x.tar.gz")
  - cd into the directory (eg. "cd lineakd-x.x" )
  - run  "./configure"
  - run  "make"
  - as root run  "make install"

  (change back to your normal user)
  
  - IMPORTANT: if you are upgrading, please read the "Upgrading" notes below now !

  - run 'lineakd -l' to see a list of available keyboards.
  
  - to create a new configuration file for your keyboard run
      "lineakd -c TYPE" 
    where TYPE could be found from "lineakd -l" as mentioned above

  (a configuration file will now have been created as $HOME/.lineak/lineakd.conf)
  
  - add '/usr/local/bin/lineakd -b' to ~/.xsession if you use XSession
    or put it in the list of 'startup programs' of your Window Manager
    (i.e. Gnome or KDE)

  - bind commands to the keys by using lineakconfig, or edit the .conf file
    by hand and issue a SIGHUP signal (i.e. killall -HUP lineakd)

## Upgrading

  - lineakd 0.3.x can only be used w/ lineakconfig 0.3 or higher
  - follow the standard configure, make, make install procedure as
    described above.
  - it is recommended you create a new configuration file when upgrading.
    To do this use "lineakd -c TYPE" (TYPE can be found from "lineakd -l")
	If you used your old configuration file and you get errors about unknown
	type or config file errors, please create a new conf file before reporting
	the problem.

## Trouble shooting

  - if you have trouble running lineakd:
    * if lineakd is running, send it the TERM signal to stop it
	* open an X terminal (xterm, eterm, any) and run:
	     /usr/local/bin/lineakd -v
	* the information on the screen can help identify the problem.

## Reporting a bug/problem

  Run lineakd with --verbose (or -v) option (see also Trouble shooting)
  and enclose the output in your e-mail to me.


## Notes of attention:

  - when lineakd is run for the first time, it will create a directory
    in your homedir called ".lineak" where the configuration file is located
	(i.e. /home/user/.lineak/lineakd.conf )
	This file can be modified to suit your needs, or you can use (K)lineakconfig
	
  - keyboard definitions are located in lineakkb.def located in your sysconf dir
    (i.e. /usr/local/etc/lineakkb.def )
	If your keyboard is not supported, read "How to get your keyboard supported"
	on the project homepage (http://lineak.sf.net)
	As of version 0.3, lineak also supports a user definition file
	 ($HOME/.lineak/lineakkb.def)


## Known bugs

  - a key command can not include "quotes". If you need them, please drop the
    command into a separate file, chmod +x, and let the key call that file.

  - USB keyboards may not work or just partially. If possible, use PS/2 for the
    time being.

  - the SLEEP action has no functionality yet
  
  - due to the fact that not all IDE CD-ROM drives provide status info on the tray
    position, the following can occur:
	* if lineakd is started with the cdrom tray in open position, the eject button
	  has to be pressed twice the first time to close it.
	* if you opened the cdrom tray with the eject button and let the tray close
	  automatically after a while (hardware timer) or close it manually, the eject
	  button has to be pressed twice to open it again.
	  
  - trapping the X BadValue error (request_code 150, minor_code 9) may be not be
    system/version independant
	
  - not everything is platform independant yet. There may be some things specific to
    linux or X11 version
	
