README revision 54359
154359SrobertoThe ntp Distribution Base Directory 254359Sroberto 354359SrobertoThis directory and its subdirectories contain the Network Time Protocol 454359SrobertoVersion 4 (NTP) distribution for Unix and Windows/NT systems. This release 554359Srobertomay still work on VxWorks, too. 654359Sroberto 754359SrobertoThe contents of the base directory are given in this file. The contents of 854359Srobertosubdirectories are given in the README files in each subdirectory. 954359Sroberto 1054359SrobertoA complete explanation of the configure, compile and install process, as 1154359Srobertowell as setting up an NTP subnet, is in the HTML pages in the ./html/ 1254359Srobertodirectory. For more information on NTP and how to get a working setup, 1354359Srobertoread WHERE-TO-START. 1454359Sroberto 1554359SrobertoFor Windows/NT, visit html/hints/winnt . 1654359Sroberto 1754359SrobertoThe base directory ./ contains the autoconfiguation files, source 1854359Srobertodirectories and related stuff: 1954359Sroberto 2054359SrobertoCOPYRIGHT Excerpt from the HTML file ./html/copyright.html. This file 2154359Sroberto specifies copyright conditions, together with a list of 2254359Sroberto major authors and electric addresses. 2354359Sroberto 2454359SrobertoINSTALL Generic installation instructions for autoconf-based programs. 2554359Sroberto Unless you really know what you are doing, you should read the 2654359Sroberto directions in the HTML pages, starting with ./html/index.htm. 2754359Sroberto 2854359SrobertoNEWS What's new in this release. 2954359Sroberto 3054359SrobertoREADME This file. 3154359Sroberto 3254359SrobertoREADME.cvs Instructions for folks who use the CVS-repository 3354359Sroberto version of NTP. 3454359Sroberto 3554359SrobertoREADME.des If you *need* DES support. 3654359Sroberto 3754359SrobertoREADME.hackers Notes to folks who want to hack on the code. 3854359Sroberto 3954359SrobertoTODO List of items the NTP developers are working on. 4054359Sroberto 4154359SrobertoWHERE-TO-START Hints on what to read in order to get a working 4254359Sroberto configuration. 4354359Sroberto 4454359SrobertoMakefile.am Automake file configuration file. Edit only if you have the 4554359Sroberto GNU automake and autoconf utilities installed. 4654359Sroberto 4754359SrobertoMakefile.in Autoconf make file template for Unix. 4854359Sroberto 4954359Srobertoacconfig.h Autoconf template header file. Edit only if you 5054359Sroberto have the GNU automake and autoconf utilities installed. 5154359Sroberto 5254359Srobertoadjtimed Directory containing the sources for the adjtime daemon 5354359Sroberto for HP/UX systems prior to HP-UX 10.0. 5454359Sroberto 5554359Srobertoauthstuff Directory containing sources for miscellaneous programs 5654359Sroberto to test, calibrate and certify the cryptographic 5754359Sroberto mechanisms for DES and MD5 based authentication. These 5854359Sroberto programs do not include the cryptographic routines 5954359Sroberto themselves, so are free of U.S. export restrictions. 6054359Sroberto 6154359Srobertobuild A script to build the distribution in A.`config.guess` 6254359Sroberto subdirectory (more or less). 6354359Sroberto 6454359Srobertoclockstuff Directory containing sources for miscellaneous programs 6554359Sroberto to test certain auxiliary programs used with some kernel 6654359Sroberto configurations, together with a program to calculate 6754359Sroberto propagation delays for use with radio clocks and 6854359Sroberto national time dissemination services such as WWV/WWVH, 6954359Sroberto WWVB and CHU. 7054359Sroberto 7154359Srobertoconf Directory containing a motley collection of 7254359Sroberto configuration files for various systems. For example only. 7354359Sroberto 7454359Srobertoconfig.guess Script used to identify the machine architecture and 7554359Sroberto operating system. 7654359Sroberto 7754359Srobertoconfig.h.in Configuration file generated automatically from 7854359Sroberto configure.in. Do not edit. 7954359Sroberto 8054359Srobertoconfigure Script used to configure the distribution. See the HTML pages 8154359Sroberto (./html/index.htm) for a complete description of the options 8254359Sroberto available. 8354359Sroberto 8454359Srobertoconfigure.in Master configuration template. Edit only if you have the 8554359Sroberto GNU automake and autoconf utilities installed. 8654359Sroberto 8754359Srobertodot.emacs C-mode indentation rules for code "Just the way Dave likes it". 8854359Sroberto 8954359Srobertoflock_build (UDel only) Build the distribution on a number of 9054359Sroberto different platforms. 9154359Sroberto 9254359Srobertohtml Directory containing a complete set of documentation on 9354359Sroberto building and configuring a NTP server or client. The 9454359Sroberto documentation is in the form of HTML files suitable for 9554359Sroberto browsing and contains links to additional documentation 9654359Sroberto at various web sites. If a browser is unavailable, an 9754359Sroberto ordinary text editor can be used. 9854359Sroberto 9954359Srobertoinclude Directory containing include header files used by most 10054359Sroberto programs in the distribution. 10154359Sroberto 10254359Srobertoinstall-sh Script to install a program, script or data file. 10354359Sroberto 10454359Srobertokernel Directory containing sources for kernel programs such as 10554359Sroberto line disciplines and STREAMS modules used with the CHU 10654359Sroberto decoder and precision PPS signals. 10754359Sroberto 10854359Srobertolibntp Directory containing library source code used by most 10954359Sroberto programs in the distribution. 11054359Sroberto 11154359Srobertolibrsaref Staging directory for RSAREF. 11254359Sroberto 11354359Srobertontp_update Update an NTP CVS tree. 11454359Sroberto 11554359Srobertontpdate Directory containing sources for a program to set the 11654359Sroberto local machine time from one or more remote machines 11754359Sroberto running NTP. Operates like rdate, but much more accurate. 11854359Sroberto 11954359Srobertontpq Directory containing sources for a utility program to 12054359Sroberto query local and remote NTP peers for state variables and 12154359Sroberto related timekeeping information. This program conforms 12254359Sroberto to Appendix A of the NTP Version 3 Specification RFC 1305. 12354359Sroberto 12454359Srobertontptrace Directory containing sources for a utility program that 12554359Sroberto can be used to reveal the chain of NTP peers from a 12654359Sroberto designated peer to the primary server at the root of the 12754359Sroberto timekeeping subnet. 12854359Sroberto 12954359Srobertoparse Directory containing files belonging to the generic 13054359Sroberto parse reference clock driver. For reasonably simple 13154359Sroberto clocks it is possible to get away with about 3-4Kb of 13254359Sroberto code. additionally the SunOS 4.x/Solaris 5.3 streams 13354359Sroberto module for parse squats here. 13454359Sroberto 13554359Srobertopatches Directory containing patches already applied to this 13654359Sroberto distribution. These are included for record and to help 13754359Sroberto in possible porting problems. 13854359Sroberto 13954359Srobertoscripts Directory containing scripts to build the configuration 14054359Sroberto files in this directory and then the makefiles used in 14154359Sroberto various dependent directories. the subdirectories 14254359Sroberto monitoring and support hold various perl and shell 14354359Sroberto scripts for visualizing synchronization and daemon startup. 14454359Sroberto 14554359Srobertostamp.h.in Configuration file generated automatically from configure.in. 14654359Sroberto Do not edit. 14754359Sroberto 14854359Srobertoutil Directory containing sources for various utility and 14954359Sroberto testing programs. 15054359Sroberto 15154359SrobertoDavid L. Mills (mills@udel.edu) 15254359Sroberto21 June 1998 153