PACKAGE OVERVIEW

This is the readme file for the digitools package. This package is a
combination of the previous programs asusfan and setpanel. Included
in this package are the following tools:

- digifan; allows fan speed control 
            (formerly asusfan)

- digipanel; allows control of the LED display, and volume knob controls
             the soundcard master mixer channel
            (formerly part of setpanel)

- digiradio; allows control of the in-built radio
            (formerly part of setpanel)

- digiwake; allows for Wake-On-CIR (wake on remote) with existing
            versions of LIRC that support the digimatrix. This program
            just needs to be run after lircd, and the digimatrix will
            power on when pressing the music/(on/off) button on the
            remote control.

Some of these programs have slightly different parameter syntax than
the previous ancestors, but all syntax can be found with:

  digipanel -h
  digifan -h
  digiradio -h
  digiwake -h

so be mindful that your scripts using these programs may need to be 
updated from those that used the legacy ancestors.

Note that all programs need to be run as root, since all access raw
memory addresses. Notable inclusions from their ancestors include
daemon-mode management, so that only one instance of the daemons
will run at any time. This means that starting another instance of
e.g. digifan will stop the previous instance, rather than compete
with it.

WARNING

A final program, ozedit, replicates and extends the dangerous "hardware
hacking" component of setpanel, that was accessible via the -m flag.
Using this, it is quite possible to damage the oz263 chip, so consider
yourself warned.

BUILDING & INSTALLING INSTRUCTIONS

To build, simply enter the directory and run the command:

  make

which will build all the machine code, and make symlinks. If you
wish to install, then you should edit the Makefile, and edit
the first two lines that specify the installation location, which
defaults to /usr/local/sbin. You should edit this to your preference,
or accept the default. Then install by becoming root (if not already)
and running the command:

  make install

which will copy the executable and all symlinks to the desired location.
If you wish to uninstall, type the command:

  make uninstall

from within the source directory (assuming you keep any modifications to
Makefile regarding the desired installation path the same) and the
program will be removed.

LEGACY BUILD & INSTALLING INSTRUCTIONS

If for some reason you would like to make the program have the original
package names, you can run the commands:

  make
  make oldsymlinks
  make oldinstall

and it will create and install symlinks pointing to asusfan and setpanel
as well as digiwake and digipanel. Note that this setpanel will only
have the functionality of digipanel, not the original setpanel (which
is split amongst the 3 programs digipanel, digiradio and ozedit). To
uninstall from this configuration, simply type:

  make olduninstall

and those legacy program symlinks will be removed.

DISTRIBUTION INSTRUCTIONS

To create tarballs for distribution, issue the command:

  make dist

which assumes that tar is available, with the capability to create gzip and
bzip2 archives with -z and -j flags respectively.

AUTHOR'S NOTE

This package was primarily written so that the ASUS Digimatrix could
be fully supported automatically in the GeeXboX multimedia OS, and no 
warranty or guarantee of usability or warranty is offered or suggested. 

