README revision 54359
1231200SmmThe ntp Distribution Base Directory 2231200Smm 3231200SmmThis directory and its subdirectories contain the Network Time Protocol 4231200SmmVersion 4 (NTP) distribution for Unix and Windows/NT systems. This release 5231200Smmmay still work on VxWorks, too. 6231200Smm 7231200SmmThe contents of the base directory are given in this file. The contents of 8231200Smmsubdirectories are given in the README files in each subdirectory. 9231200Smm 10231200SmmA complete explanation of the configure, compile and install process, as 11231200Smmwell as setting up an NTP subnet, is in the HTML pages in the ./html/ 12231200Smmdirectory. For more information on NTP and how to get a working setup, 13231200Smmread WHERE-TO-START. 14231200Smm 15231200SmmFor Windows/NT, visit html/hints/winnt . 16231200Smm 17231200SmmThe base directory ./ contains the autoconfiguation files, source 18231200Smmdirectories and related stuff: 19231200Smm 20231200SmmCOPYRIGHT Excerpt from the HTML file ./html/copyright.html. This file 21231200Smm specifies copyright conditions, together with a list of 22231200Smm major authors and electric addresses. 23231200Smm 24231200SmmINSTALL Generic installation instructions for autoconf-based programs. 25231200Smm Unless you really know what you are doing, you should read the 26231200Smm directions in the HTML pages, starting with ./html/index.htm. 27231200Smm 28231200SmmNEWS What's new in this release. 29231200Smm 30231200SmmREADME This file. 31231200Smm 32231200SmmREADME.cvs Instructions for folks who use the CVS-repository 33231200Smm version of NTP. 34231200Smm 35231200SmmREADME.des If you *need* DES support. 36231200Smm 37231200SmmREADME.hackers Notes to folks who want to hack on the code. 38231200Smm 39231200SmmTODO List of items the NTP developers are working on. 40231200Smm 41231200SmmWHERE-TO-START Hints on what to read in order to get a working 42231200Smm configuration. 43231200Smm 44231200SmmMakefile.am Automake file configuration file. Edit only if you have the 45231200Smm GNU automake and autoconf utilities installed. 46231200Smm 47231200SmmMakefile.in Autoconf make file template for Unix. 48231200Smm 49231200Smmacconfig.h Autoconf template header file. Edit only if you 50231200Smm have the GNU automake and autoconf utilities installed. 51231200Smm 52231200Smmadjtimed Directory containing the sources for the adjtime daemon 53231200Smm for HP/UX systems prior to HP-UX 10.0. 54 55authstuff 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. 60 61build A script to build the distribution in A.`config.guess` 62 subdirectory (more or less). 63 64clockstuff 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, 69 WWVB and CHU. 70 71conf Directory containing a motley collection of 72 configuration files for various systems. For example only. 73 74config.guess Script used to identify the machine architecture and 75 operating system. 76 77config.h.in Configuration file generated automatically from 78 configure.in. Do not edit. 79 80configure Script used to configure the distribution. See the HTML pages 81 (./html/index.htm) for a complete description of the options 82 available. 83 84configure.in Master configuration template. Edit only if you have the 85 GNU automake and autoconf utilities installed. 86 87dot.emacs C-mode indentation rules for code "Just the way Dave likes it". 88 89flock_build (UDel only) Build the distribution on a number of 90 different platforms. 91 92html 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. 98 99include Directory containing include header files used by most 100 programs in the distribution. 101 102install-sh Script to install a program, script or data file. 103 104kernel Directory containing sources for kernel programs such as 105 line disciplines and STREAMS modules used with the CHU 106 decoder and precision PPS signals. 107 108libntp Directory containing library source code used by most 109 programs in the distribution. 110 111librsaref Staging directory for RSAREF. 112 113ntp_update Update an NTP CVS tree. 114 115ntpdate 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. 118 119ntpq 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. 123 124ntptrace 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 127 timekeeping subnet. 128 129parse 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. 134 135patches Directory containing patches already applied to this 136 distribution. These are included for record and to help 137 in possible porting problems. 138 139scripts 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. 144 145stamp.h.in Configuration file generated automatically from configure.in. 146 Do not edit. 147 148util Directory containing sources for various utility and 149 testing programs. 150 151David L. Mills (mills@udel.edu) 15221 June 1998 153