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