1 The ntp Distribution Base Directory
3 This directory and its subdirectories contain the Network Time Protocol
4 Version 4 (NTP) distribution for Unix and Windows/NT systems. This release
5 may still work on VxWorks, too.
7 The contents of the base directory are given in this file. The contents of
8 subdirectories are given in the README files in each subdirectory.
10 A complete explanation of the configure, compile and install process, as
11 well as setting up an NTP subnet, is in the HTML pages in the ./html/
12 directory. For more information on NTP and how to get a working setup,
15 For Windows/NT, visit html/hints/winnt .
17 The base directory ./ contains the autoconfiguation files, source
18 directories and related stuff:
20 COPYRIGHT Excerpt from the HTML file ./html/copyright.html. This file
21 specifies copyright conditions, together with a list of
22 major authors and electric addresses.
24 INSTALL Generic installation instructions for autoconf-based programs.
25 Unless you really know what you are doing, you should read the
26 directions in the HTML pages, starting with ./html/index.htm.
28 NEWS What's new in this release.
32 README.cvs Instructions for folks who use the CVS-repository
35 README.des If you *need* DES support.
37 README.hackers Notes to folks who want to hack on the code.
39 TODO List of items the NTP developers are working on.
41 WHERE-TO-START Hints on what to read in order to get a working
44 Makefile.am Automake file configuration file. Edit only if you have the
45 GNU automake and autoconf utilities installed.
47 Makefile.in Autoconf make file template for Unix.
49 acconfig.h Autoconf template header file. Edit only if you
50 have the GNU automake and autoconf utilities installed.
52 adjtimed Directory containing the sources for the adjtime daemon
53 for HP/UX systems prior to HP-UX 10.0.
55 authstuff Directory containing sources for miscellaneous programs
56 to test, calibrate and certify the cryptographic
57 mechanisms for DES and MD5 based authentication. These
58 programs do not include the cryptographic routines
59 themselves, so are free of U.S. export restrictions.
61 build A script to build the distribution in A.`config.guess`
62 subdirectory (more or less).
64 clockstuff Directory containing sources for miscellaneous programs
65 to test certain auxiliary programs used with some kernel
66 configurations, together with a program to calculate
67 propagation delays for use with radio clocks and
68 national time dissemination services such as WWV/WWVH,
71 conf Directory containing a motley collection of
72 configuration files for various systems. For example only.
74 config.guess Script used to identify the machine architecture and
77 config.h.in Configuration file generated automatically from
78 configure.in. Do not edit.
80 configure Script used to configure the distribution. See the HTML pages
81 (./html/index.htm) for a complete description of the options
84 configure.in Master configuration template. Edit only if you have the
85 GNU automake and autoconf utilities installed.
87 dot.emacs C-mode indentation rules for code "Just the way Dave likes it".
89 flock_build (UDel only) Build the distribution on a number of
92 html Directory containing a complete set of documentation on
93 building and configuring a NTP server or client. The
94 documentation is in the form of HTML files suitable for
95 browsing and contains links to additional documentation
96 at various web sites. If a browser is unavailable, an
97 ordinary text editor can be used.
99 include Directory containing include header files used by most
100 programs in the distribution.
102 install-sh Script to install a program, script or data file.
104 kernel Directory containing sources for kernel programs such as
105 line disciplines and STREAMS modules used with the CHU
106 decoder and precision PPS signals.
108 libntp Directory containing library source code used by most
109 programs in the distribution.
111 librsaref Staging directory for RSAREF.
113 ntp_update Update an NTP CVS tree.
115 ntpdate Directory containing sources for a program to set the
116 local machine time from one or more remote machines
117 running NTP. Operates like rdate, but much more accurate.
119 ntpq Directory containing sources for a utility program to
120 query local and remote NTP peers for state variables and
121 related timekeeping information. This program conforms
122 to Appendix A of the NTP Version 3 Specification RFC 1305.
124 ntptrace Directory containing sources for a utility program that
125 can be used to reveal the chain of NTP peers from a
126 designated peer to the primary server at the root of the
129 parse Directory containing files belonging to the generic
130 parse reference clock driver. For reasonably simple
131 clocks it is possible to get away with about 3-4Kb of
132 code. additionally the SunOS 4.x/Solaris 5.3 streams
133 module for parse squats here.
135 patches Directory containing patches already applied to this
136 distribution. These are included for record and to help
137 in possible porting problems.
139 scripts Directory containing scripts to build the configuration
140 files in this directory and then the makefiles used in
141 various dependent directories. the subdirectories
142 monitoring and support hold various perl and shell
143 scripts for visualizing synchronization and daemon startup.
145 stamp.h.in Configuration file generated automatically from configure.in.
148 util Directory containing sources for various utility and
151 David L. Mills (mills@udel.edu)