contrib/ntp/scripts/support/README

   1 The bin and etc directories contain several scripts (sh and perl) that
   2 should ease startup and configuration of NTP sites.
   3
   4         bin/monl is a monitoring script that prints out new, current and
   5                  old customers of an NTP timeserver when monitoring is
   6                  in effect.
   7                  monl has following options:
   8                  -i <regexp> (regular expression matchin IP addres to be ignored
   9                  -d <directory> where the current state is kept (default /tmp)
  10                  -v debug output
  11                  -n do not translate IP addresses into hostnames
  12                  <host> host to be analyzed
  13
  14                  monl uses xntpdc for information gathering and is thus
  15                  limited to the NTP version xntpdc is compiled for.
  16
  17         bin/mvstats moves compresses and removes statistics files (useful mainly
  18                     for reference servers
  19
  20         etc/install creates the locally needed directories for NTP (if not residung in /etc)
  21
  22         etc/rc   starts up daemon with configuration file and key file
  23         etc/cron cron called monitor statistic (uses bin/monl)
  24         etc/crontab crontab prototype for reference time servers
  25         etc/setup   sh script sourced by the other scripts for variable setup
  26
  27 YOU MUST EDIT THESE FILES TO REFLECT YOUR LOCAL SETUP !
  28
  29 READ THIS BEFORE USING THE STARTUP SCRIPTS
  30
  31 The startupscript etc/rc has been written for Suns and HPs. They are not
  32 guaranteed to work elsewhere. Following assumptions have been made:
  33
  34         All NTP related files reside in ONE directory having following structure:
  35
  36                 bin/*   -       all executables (daemon, control, date, scripts)
  37                 etc/*   -       startup scripts and cron scripts
  38                 conf/*  -       NTP configuration files
  39
  40 The variable NTPROOT (etc/rc, etc/install) must be edited to reflect
  41 the NTP directory (e.g. /usr/local/NTP)
  42
  43 NTP config files are located via Suns arch command and have the name
  44 conf/`arch`.`arch -k`.
  45 These are the default configurations (usually clients). If a file with the name
  46 conf/`arch`.`arch -k`.`hostname` is present this file will be preferred (Reference host,
  47 gateway). If the arch command is not available no-arch is used. The arch command
  48 is usually a shell script which echoes a string unique the the current machine
  49 architecture.
  50
  51 The tickadj command has its own conf/tickconf file which is used to set host
  52 specific tickadj values. The line with DEFAULT specifies the default tickadj
  53 parameters, all other lines consists of <hostname> <hostid>
  54 <tickadj parameters>. These lines need only be entered if the specified host
  55 needs parameters different from the default parameters.
  56
  57 Reference clock support is provided for DCF77. If you need to initialize
  58 certain things for reference clock support (e.g. loading STREAMS modules),
  59 you need to edit etc/rc.
  60
  61 The current config files of Erlangen are included in the conf directory.
  62 They are just for reference, but might help you a bit in setting up a
  63 synchronisation network.
  64
  65 The advantage of keeping all config files centralized is the easier
  66 administration.
  67
  68 We replicate the NTP directory via NFS and rdist.
  69
  70 When you have set up the local config files (YOUR OWN!) you can call
  71 <NTPROOT>/etc/rc for daemon startup.
  72
  73 For more information: time@informatik.uni-erlangen.de