CONTENTS

  - Uptime Client

  - Upclient.conf

  - Redhat init.d script


UPTIME CLIENT

  UNIX: installation requires these, hopefully easy, steps:

  Mandatory:
  0. Change directory to src/
  1. If you'd like to change the path and/or name to/of the config
     file, pull Makefile in your favourite editor and change the
     CONFIGFILE variable.
  2. Browse through upclient.h if you see anything that applies
     to you.
  1. Type "make"
  2. Choose a target that pleases you most
  3. Type "make <platform name>"
  4. Copy the conf/upclient.conf to some place and edit it to your liking.
     chmod 600 that config file!! Or else, others might read your
     AuthKey! See section ``Upclient.conf'' for more info.

  Optional:
  1. Edit scripts/upchk script to your liking or Karl Kornel's alternative
     for upchk: script/clientchk.
  2. Edit scripts/{redhat,debian}/upclient file to your liking and install
     it according to directions found under "init.d script"
  3. Copy all necessary files to some nice place (upchk, upclient.rc
     and upclient)

  Very optional:
  1. Run the upclient binary (-:
  2. Run it as root on BSD systems to be able to send the idle time.


  BEOS: installation for the BeOS platform:

  1. Read the Unix install steps

  2. Fire up the upclient with "upclient &" so that it will stay
     alive if you close the shell.


  WINDOWS: installation for Windows NT4/2000:

  1. Get the free Borland C++ 5.5 compiler:
     http://www.borland.com/bcppbuilder/freecompiler/

  2. Compile the client:
     bcc32 -DPLATFORM_WINNT -DCONFIGFILE="\"C:\\Program Files\\Upclient\\upclient.conf\"" upclient.c

  3. Place the conf/upclient.conf in C:\Program Files\Upclient\ and run
     the upclient.exe and all should work.


UPCLIENT.CONF

  IMPORTANT: chmod 600 that config file!! Or else, others might read
  your AuthKey and use it to fake your uptime, destroy the world or
  copy all your illegal mp3 cd's!

  IMPORTANT: no username, password and host id are required since
  Uptimes Protocol version 4.2. You should only provide the AuthKey
  in upclient.conf, that's all.

  upclient.conf's rules:
  1.  Each empty line is ignored
      Am empty line is: optional whitespace followed by a newline.

  2.  Each comment line is ignored
      A comment line is: optional whitespace, the comment sign ``#'',
      the comment itself, a final newline.

  3.  A rule consists of a ``key'', a ``='' sign, one ``value'', a
      comment and finally a newline.

  ex:
    # This is a comment
    PidFile    = /home/sjors/.upclient.pid  # Pid file location


REDHAT INIT.D SCRIPT

  This init.d startup file assumes two things:

  1. The upclient is installed in /usr/sbin
  2. The upclient will write the pid file into /var/run/upclient.pid

  To add the rc startup file, do the following:

  cp scripts/redhat/upclient /etc/rc.d/init.d/
  chkconfig --add upclient
