README
======

PBButtons is a programm suite to support laptop specific functions and
make them available again under Linux. Basically it was developed to
support the special hotkeys of an Apple iBook, Powerbook or TiBook but
since version 0.5 the design has been changed to support all kind of
laptop or notebook. 

                         (c) 2002 Matthias Grimm

With this programms the keys for the display brightness, the volume of
speaker and headphone, the mute key and the eject key will do their job
as expected.

This package contains a PBButtons Client: PowerPrefs.

This client is a quick hack to port PowerPrefs to the new pbbuttonsd 
daemon version >0.5.0. It doesn't support all of the new functions and
will be reworked in the future.

This client for pbbuttonsd makes some options easy adjustable through a
GTK Userinterface. Following options could directly be changed:

    - trackpad mode
      How the trackpad is configured.
      
    - keyboard mode
      How the keyboard is configured
      
    - dosleep
      switches sleepmode temporarly off, for eg. long term compiler runs. 
      Only the onBattery profile will be changed.
      
    - dodim
      switches display dimming temporarely off. This option is indipendent
      from dosleep. Only the onBattery profile will be changed.
      
    - blank screen
      on sleep request only the display will be switched off. Only the
      onBattery profile will be changed.

    - snoozedelay
      Should the snooze key react immediatly or delayed. 

    - ejectdelay
      Should the eject-CD key react immediatly or delayed. 
      
    - mixerdelay
      Should the sound routines be initalized on startup or later.

    - brightness
      controlls the current display brightness
      
    - master volume
      controls the current master volume

Each option gets immediatly active after changing it.
In addition to the options some functions could be triggered:

    - mute
      same as pressing the mute-key.
      
    - sleep
      put the machine in sleep mode except screen blanking is enabled
      or the machine doesn't support sleep.
      
    - save config
      the current configuration will be saved to disk. The old config file
      will be overwritten.


REQUIREMENTS
============
To use this programe, you need some additional parts:
1. an laptop or notebook supported by pbbuttonsd
2. the GTK and GLib libraries,
3. a runnning PBButtons daemon, named pbbuttonsd (>= 0.5.0), available as
   separate package,


COMPILE & INSTALL
=================
To compile this client the library libpbb.a is nessecary. This library
is part of the daemon package pbbuttonsd and is available as static library
only. This may be changed in the future.

If you use precompiled packages you could skip this paragraph except you
want to develop your own PBButton's client.

The library should be installed in a common lib directory which the linker
already knows about. The header file must also be placed in usual places.
This will all done automatically during the daemon's normal installation
process. If you have got an precompiled package of the daemon pbbuttonsd,
please check if the package includes the library.
   
For the other details about compiling and installing of PowerPrefs please
see INSTALL.


LEGAL NOTICE
============

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.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; see the file COPYING.  If not, write to
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.


CREDITS
=======

This program wouldn't exists if not some people wrote other programs
from which I learned how special things worked. I can't name all of
them so I picked those out, whose programs I could call the 'parents'
of PBButtons:

  keyevd       from Joseph P. Garcia <jpgarcia@execpc.com>
  ikeyd        from Stefan Pfetzing <dreamind@dreamind.de>
  pmud         from Stephan Leempurg <sleemburg@jvc.nl>
  snooze       from Paul Mackerras <paulus@linuxcare.com> and
                    Stephan Leemburg <sleemburg@jvc.nl>
  trackpad     from Ben Herrenschmidt <benh@kernel.crashing.org>
  fnset        from Jimi X <jimix@watson.ibm.com>

Also thanks to all unknown developers, who make my little program
possible.


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

The daemon 'pbbuttonsd' gets its input directly from the keboard event handler.
Consequently the keys are always active. It doesn't matter if X11 is in front
or if you are working on a console or which X11 window has the focus. You
can always use the hotkeys and get the appropriate reaction.

The client contained in this package gives the user the option to change pbbuttons'
and systems behaviour on the fly.

Some parameters are configurable via the command line. Please read the man page
for details.

  Enjoy
    Matthias Grimm