DESCRIPTION

     clockspeed-conf installs supervise skeletons in order to run a clockspeed
     client under djb daemontools supervise control.

     It makes two supervise skeletons, one for clockspeed (DIR-speed) and the
     other for clockadjust (DIR-adjust).  The former runs clockspeed to keep
     your clock running evenly, the latter queries a time-keeping server in
     certain intervals.  It does not symlink the resulting service directories
     into svscans central directory (often called /service/). You can inspect
     and change the new services before doing so manually.

     Options:

     acct    Account to run clockadjust - clockspeed-conf installs the DIR-
             adjust/run script to drop root privileges and setuid acct.  Sug-
             gested username is 'clockspeed'.

     logacct
             Account to run multilog - clockspeed-conf installs the DIR-
             adjust/log/run script to drop root privileges and setuid acct.
             Suggested username is 'log'.

     DIR     Basedir to install supervise skeleton - clockspeed-conf installs
             the run and log scripts into DIR-adjust and DIR-speed. Suggested
             DIR is /var/service/clockspeed.  The resulting trees must be sym-
             linked to the /service directory as expected by svscan.

     protocol
             Time network protocol to be used for synchronizing - allowed val-
             ues are 'tai' or 'ntp'.

     timeserver-ip
             IP address of a suitable timeserver. See
             http://www.eecis.udel.edu/~mills/ntp/clock2a.html for public ntp
             timeservers.  Note that most administrators appreciate a short
             notice via email when you are using their server for synchroniz-
             ing.

ENVIRONMENT

     CLOCKSPEED_INSTALLATION
             The CLOCKSPEED_INSTALLATION environment variable is a convenience
             switch to hint the clockspeed-conf where to look for the clock-
             speed binaries and the adjust sockets.  Defaults to 'DJB'.
             Allowed values are 'DJB', 'FreeBSD_PORT' and 'custom'.
             DJB:    clockspeed binary is expected at /usr/local/clock-
                     speed/bin, adjust and atto are expected at
                     /usr/local/clockspeed/etc
             FreeBSD_PORT:
                     clockspeed binary is expected at /usr/local/bin, adjust
                     and atto are expected at /usr/local/etc/clockspeed/
             custom:

     BINDIR  Required if CLOCKSPEED_INSTALLATION is set to 'custom'.

     ADJUST_LOGDIR
             defaults to 'main'. clockspeed-adjust will log its output to
             DIR/clockspeed-adjust/log/ADJUST_LOGDIR/current.

     VA      if defined, ADJUST_LOGDIR will default to 'clockspeed-adjust'
             instead of 'main'

EXAMPLES

     The following examples are shown as given to the shell:

     Configure clockspeed run for djb a standard installation. It expects a
     timeserver at ip 10.20.30.40 running taiclockd for synchronisation.
     clockspeed binary is expected in /usr/local/clockspeed/bin/, clockspeed
     adjust socket is expected in /usr/local/clockspeed/etc/ .

           clockspeed-conf clockspeed log /var/service/clockspeed tai 10.20.30.40

     Configure clockspeed run for FreeBSD ports installation from
     /usr/ports/sysutils/clockspeed.  The timeserver to synchronize to is
     expected to be an ntp/xntp server at 10.10.10.123.  Logging of the adjust
     service is done to /var/service/clockspeed-adjust/log/clockspeed-
     adjust/current.

           env CLOCKSPEED_INSTALLATION="FreeBSD_PORT" VA=yes clockspeed-conf
           clockspeed log /var/service/clockspeed ntp 10.10.10.123
     (in one line)

SEE ALSO

     clockspeed(1) taiclockd(1) taiclockd-conf(8) supervise(8) hier(1)
     http://cr.yp.to/ http://foo42.de/devel/sysutils/clockspeed-conf/

NOTES

     On FreeBSD systems don't forget to read /usr/local/share/doc/clock-
     speed/INSTALL-FreeBSD for leapsecond support.  Short summary:
           cd /usr/src/share/zoneinfo
           make -DLEAPSECONDS clean all install; make clean

     Inspect DIR-adjust/env. There you can reconfigure global settings.  Espe-
     cially SERVER_IP may be tuned if you opt for another timeserver after a
     while. The env/* settings will not be overwritten on future calls of
     clockspeed-conf

     Inspect DIR-adjust/run, DIR-adjust/log/run and DIR-speed/run if they are
     appropriate for your setup. You may change them and finally you MUST sym-
     link them into the service directory for activation. The typical commands
     to run are
           ln -s DIR-speed /service/
           ln -s DIR-adjust /service/

BSD                              May 16, 2001                              BSD