
README
======

lsadb is a small utility to scan the devices on the ADB-Bus and
print out some information about the devices found.

This tool is not very usefull on computers without an ADB-Bus.
That are mostly Apple Macintosh Computers. So please don't try
to use this utillity on an i386 machine.


LEGAL NOTICE
============
Copyright 2002-2005 Matthias Grimm (matthiasgrimm@users.sourceforge.net).

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version
2 of the License, or (at your option) any later version.


INSTALL
=======

First of all the program has to be compiled. This is a rather simple
job because it is a simple program. It needs no libraries other than
the standard ones comming with a working gcc.

1. unpack the archive in an directory of your choice with following
   commands:
                  tar -xvf lsadb.tgz

   After that you will find following files in the same directory:

     lsadb.c      - The programm code
     lsadb.h      - Some header information needed by lsadb.c
     lsadb.1      - the man page (Thanks to Viral <viral@debian.org>)
     Makefile     - Makefile to compile the programm
     README       - This text

2. Now type: make

3. After some seconds you will find another executable file lsadb
   in your directory

4. Copy the manfile lsadb.1 to /usr/local/man/man1

5. That's it. That wasn't very difficult, was it.


HOW IT WORKS
============

lsadb opens the device file /dev/adb, which has to be user read/writable
if you want to execute this program with normal user rights and you
always should. It is bad style and sometimes a little bit dangerous to
work as root.

After the /dev/adb has been opened, each device on the bus is tested and
every returned information with additional comments is printed in the
terminal window.

The output should look like something like the following, depending on
your devices at the ADB-Bus. This is the output from my PowerBook G3 (Pismo):

Devices connected to the ADB-Bus: (PMU: 12)

  D R  raw data                  decoded data
-------------------------------------------------------------------------------------
  2.3: [62 c4]                   Encode Device
                                 Apple Macintosh PowerBook G3 Keyboard (ISO layout)
                                 Exceptional Event enabled
                                 Service Request enabled
    2: [ff ff]                   Qualifier: (not all must be supported)
                                  Fn-key   Delete   Caps-Lock   Reset      Control
                                  Shift    Option   Apple       Num-Lock   Scroll-Lock
                                  Scroll-Lock-LED   Caps-Lock-LED   Num-Lock-LED
    1: [05 01]                   Special keys need Fn Key
    0: [a4 ff]                   scancode0 24 released
                                 scancode1 7f released

  3.3: [23 04]                   Relative-Position Device
                                 Extended Mouse Protokoll
                                 Exceptional Event disabled
                                 Service Request enabled
    2: [08 44 03 00 00 00 00 00]
    1: [74 70 61 64 01 90 03 02] Mouse type:   tpad
                                 resolution:   400 dpi
                                 Device class: Trackpad
                                 buttons:      2
    0:

  7.3: [67 1f]                   Misc. Device
                                 Powerbook G3 (Pismo) Button Device
                                 Exceptional Event enabled
                                 Service Request enabled
    2:
    1:
    0:


FUTURE DEVELOPMENT
==================

At the moment the program has often difficulties to identify devices by name.
It is not easy to get all the nessecary information about type, name and special
features. So I ask for your help to bann the text "unknown device" from this
program.

If you are willing to push Linux forward, please send me (to joker@cymes.de)
the output of the program on your machine and a short description of the not
identified devices. So I could complete the database and release new versions.
I will only use the sent information for this purpose, nothing else.

  Thank you and enjoy
    Matthias Grimm

