===================                 Updated:
                                Inputlibs in LibGII                 20010728
                                ===================


=========
linux-kbd
=========

Description
+++++++++++

Puts the Linux console into mediumraw mode and reads keyboard events from
it. Generates evKey* events.

Arguments
+++++++++

Required:
None.

Optional.
<filename>
        * <filename> - which tty to open, the default is /dev/tty.

Environment variables
+++++++++++++++++++++

GII_CTRLALT_VTSWITCH - use Ctrl-Alt-Fn to switch VTs. The default is Alt-Fn.


===========
linux-mouse
===========

Description
+++++++++++

Opens a file (usually a device file or pipe) and reads mouse protocol data
from it. Generates evPtr* events.

Arguments
+++++++++

Required:
None.

Optional:
<mousetype>[,<file>[,<opts>]]
        * <mousetype> - What kind of mouse is attached. The following mousetypes
                are supported:
                + ms            Two button Microsoft compatible mice.
                + ms3|mman+     Serial Intellimouse or compatible. Supports
                                four buttons for mice like the Logitech
                                MouseMan+.
                + msc           MouseSystems compatible (used in most 3-button
                                mice)
                + logi          Used in older Logitech serial mice.
                + mm            MM series mice.
                + sun           Sun mice. same as 'msc' protocol, but only 3
                                bytes per packet.
                + mman          MouseMan protocol.
                + bm            Non-PS/2 busmouse.
                + ps2           PS/2 mice (most non-serial mice use this
                                protocol)
                + imps2         PS/2 IntelliMouse and compatible.
                + mmanps2       PS/2 Logitech MouseMan+ and compatible.

                Most of the strings supported by GPM, SVGAlib and XFree can
                be given as mousetypes.
                You may also specify 'auto' as the mousetype. In that case
                we first try to read ~/.ggi/input/linux-mouse and then
                $sysconfdir/ggi/input/linux-mouse. In the first file found
                we look for the following entries:
                mouse <mousetype>
                mdev <file>
                If none of the files are found we first try to autodetect
                the mouse, and as a last resort we try parsing
                /etc/vga/libvga.config to find out the necessary info.

        * <file> - The file to read from. Defaults to /dev/mouse

        * <opts> - Override parameters for the mousetype, has the format:
                [b<baud>][r<rts>][d<dtr>]
                b specifies <baud> as the baudrate
                d and r turns off dtr/rts respectively if 0, and turns it on
                if >0.


=====
mouse
=====

Description
+++++++++++

Reads mouse protocol data from the specified file descriptor. This mainly
designed to be opened automaticly by input-linux-mouse, but can also be used
stand alone. Generates evPtr* events.

Arguments
+++++++++

Required:
<fd>,<prot>
        * <fd>   - specifies the file descriptor to read from.
        * <prot> - specifies the mouse-protocol to use. Supported are the same
                as for linux-mouse, except that 'auto' is not supported.
                Also note that some of the mousetypes in linux-mouse uses the
                same protocol.


===========
linux-evdev
===========

Description
+++++++++++

Reads events from the Linux event interface (/dev/input/eventX) and converts
them to LibGII events.

Arguments
+++++++++

Required:
None.

Optional:
<device>
        * <device> - Specify the device to use, the default is
                /dev/input/event0.

==============
DirectX (Win32)
==============

Description
+++++++++++

Used for Win32 DirectX port of libGGI.  This target cannot be used
without the DirectX display target, which loads this automatically

Arguments
+++++++++

Required:
None.

Environment variables
+++++++++++++++++++++
None


===
tcp
===

Description
+++++++++++

Reads events from a TCP-socket who's peer end is the filter-tcp filter,
also included in LibGII. The filter-tcp filter takes the same arguments
as the tcp inputlib, and anyone of the sublibs can be the listening end.

Arguments
+++++++++

Required:
<host>:<port>
	* <host> - The hostname to connect to. If this is set to "listen"
		the sublib will enter listening mode and wait for the
		corresponding sublib to connect.
	* <port> - The port to connect to/listen on.

Optional:
None.


=====
lk201
=====

Description
+++++++++++

The lk201 and lk401 devices are keyboards made by Digital Equipment
Corporation for some of there older micro computer systems and terminals.

They connect via a 4 pin RJ connector, which carries 11.8V (+/- 6%), GND,
and two bidirectional async RS423 (RS232 Compatible) serial lines, which are
Receive and Transmit.

The pins are as follows (looking on to the male (lk201 side) connector):
   -------------------
  | "    "    "    "  |
  | L    V    G    D  |
  | K    +    N    E  |
  | ->        D    C  |
  | D             ->  |
  | E              L  |
  | C              K  |
   --               --
     |             |
      --         --
        |       |
         -------

For more information, as well as the diagram from where this picture was
taken from, see: http://www.mit.edu/~mcmahill/NetBSD/pmax/LK201/lk201.html

This input driver sets up the keyboard and reads keyboard data from from the
specified serial port, and generates evKey* events for the respective key
actions.

Arguments
+++++++++

Required:
None, if serial port is specified in environment variable.

Optional:
<filename>
        * <filename> - 	file name of the serial port to open (ie
			/dev/ttyS1). Overrides GII_LK201_OPTIONS.

Environment variables
+++++++++++++++++++++

GII_LK201_OPTIONS - file name of serial port.

Bugs/TODO
+++++++++

- Key repeat messages are not sent, which can annoy users who want to use the
  cursor keys.

- Handle setting of keyclick and bell, which can also annoy users.