The xntp3 Distribution Base Directory

This directory and its subdirectories contain the Network Time Protocol
Version 3 (NTP) distribution for Unix systems. The contents of the base
directory are given in this file. The contents of subdirectories are
given in the README files in each subdirectory.

A complete explanation of the configure, compile and install process, as
well as setting up an NTP subnet, is in the HTML pages in the ./html
directory. For more information on NTP and how to get a working setup,
read WHERE-TO-START.

Note that the ./doc, ./hints and ./gadget directories in previous
releases prior to xntp3.5 are gone. The ./doc and ./hints directories
have been replaced with the ./html directory, which contains a complete
set of documentation in HTML format. In addition, the information in the
PORTING and RELNOTES has been incorporated in the HTML documentation.
The ./gadget directory has been replaced by a compressed tar archive
available via the documentation pages.

Note that in this release the ./compilers, ./machines and ./refclocks
directories and Config.local.dist file in previous releases are gone.
They have been replaced by files used by the new autoconfigure feature,
which uses the GNU automake-1.0 and autoconf-2.10 utilities. These
utilities are used only to construct the distribution itself and are not
neccesary to compile and install the software.

The base directory ./ contains the autoconfiguation files, source
directories and related stuff:

COPYRIGHT       link to the HTML file ./html/copyright.html. This file
          specifies copyright conditions, together with a list of major
          authors and electric addresses.

INSTALL hints for compiling and installing the software. Unless you
          really know what you are doing, you should read the directions
          in the HTML pages.

Makefile.am make file configuration file. Edit only if you have the GNU
          utilities installed.

Makefile.in make file template for Unix. Do not edit.

README  this file.

TAGS            used by Unix utilities.

TODO            used by system developers.

WHERE-TO-START hints on what to read in order to get a working
          configuration.

acconfig.h configuration template header file. Edit only if you have the
          GNU utilities installed.

adjtimed        directory containing the sources for the adjtime daemon
          for HP/UX systems prior to HP-UX 10.0.

authstuff       directory containing sources for miscellaneous programs
          to test, calibrate and certify the cryptographic mechanisms
          for DES and MD5 based authentication. These programs do not
          include the cryptographic routines themselves, so are free of
          U.S. export restrictions.

clockstuff directory containing sources for miscellaneous programs to
          test certain auxiliary programs used with some kernel
          configurations, together with a program to calculate
          propagation delays for use with radio clocks and national time
          dissemination services such as WWV/WWVH, WWVB and CHU.

conf            directory containing a motley collection of
          configuration files for various systems. For example only.

config.guess script used to identify the machine architecture and
          operating system.

config.h.in configuration file generated automatically from
          configure.in. Do not edit.

configure script used to configure the distribution. See the HTML pages
          for a complete description of the options available.

configure.in master configuration template. Edit only if you have the
          GNU utilities installed.

html            directory containing a complete set of documentation on
          building and configuring a NTP server or client. The
          documentation is in the form of HTML files suitable for
          browsing and contains links to additional documentation at
          various web sites. If a browser is unavailable, an ordinary
          text editor can be used.

include directory containing include header files used by most programs
          in the distribution.

install-sh script to install a program, script or data file.

kernel  directory containing sources for kernel programs such as line
          disciplines and STREAMS modules used with the CHU decoder and
          precision PPS signals.

lib             directory containing library source code used by most
          programs in the distribution.

libntp  directory containing library source code used by most programs
          in the distribution.

ntpdate directory containing sources for a program to set the local
          machine time from one or more remote machines running NTP.
          Operates like rdate, but much more accurate.

ntpq            directory containing sources for a utility program to
          query local and remote NTP peers for state variables and
          related timekeeping information. This program conforms to
          Appendix A of the NTP Version 3 Specification RFC 1305.

ntptrace        directory containing sources for a utility program that
          can be used to reveal the chain of NTP peers from a designated
          peer to the primary server at the root of the timekeeping
          subnet.

parse   directory containing files belonging to the generic parse
          reference clock driver. For reasonably simple clocks it is
          possible to get away with about 3-4Kb of code. additionally
          the SunOS 4.x/Solaris 5.3 streams module for parse squats
          here.

patches directory containing patches already applied to this
          distribution. These are included for record and to help in
          possible porting problems.
scripts directory containing scripts to build the configuration files in
          this directory and then the makefiles used in various
          dependent directories. the subdirectories monitoring and
          support hold various perl and shell scripts for visualizing
          synchronization and daemon startup.

stamp.h.in configuration file generated automatically from configure.in.
          Do not edit.

util            directory containing sources for various utility and
          testing programs.

xntpd   directory containing sources for the NTP Version 3 daemon.

xntpdc  directory containing sources for a utility program to query
          local and remote NTP peers for state variables and related
          timekeeping information. This program is specific to this
          implementation of NTP Version 3 and does not conform to
          Appendix A of the NTP Version 3 Specification RFC 1305.

David L. Mills (mills@udel.edu)
12 June 1996
