/contrib/ntp/README
https://bitbucket.org/freebsd/freebsd-head/ · #! · 148 lines · 105 code · 43 blank · 0 comment · 0 complexity · 7dd379b684be69bcbe5b611c7c832e1c MD5 · raw file
- Submit patches, bug reports, and enhancement requests via
- http://bugs.ntp.org
- The ntp Distribution Base Directory
- This directory and its subdirectories contain the Network Time Protocol
- Version 4 (NTP) distribution for Unix and Windows/NT systems. This release
- may still work on VxWorks, too.
- 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.
- For Windows/NT, visit html/build/hints/winnt.html .
- The base directory ./ contains the autoconfiguration files, source
- directories and related stuff:
- COPYRIGHT Excerpt from the HTML file ./html/copyright.html. This file
- specifies copyright conditions, together with a list of
- major authors and electric addresses.
- INSTALL Generic installation instructions for autoconf-based programs.
- Unless you really know what you are doing, you should read the
- directions in the HTML pages, starting with ./html/index.html.
- NEWS What's new in this release.
- README This file.
- README.bk Instructions for folks who use the BitKeeper-repository
- version of NTP.
- README.hackers Notes to folks who want to hack on the code.
- TODO List of items the NTP developers are working on.
- WHERE-TO-START Hints on what to read in order to get a working
- configuration.
- Makefile.am Automake file configuration file. Edit only if you have the
- GNU automake and autoconf utilities installed.
- Makefile.in Autoconf make file template for Unix.
- 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.
- build A script to build the distribution in A.`config.guess`
- subdirectory (more or less).
- 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
- (./html/index.html) for a complete description of the options
- available.
- configure.in Master configuration template. Edit only if you have the
- GNU automake and autoconf utilities installed.
- dot.emacs C-mode indentation rules for code "Just the way Dave likes it".
- flock_build (UDel only) Build the distribution on a number of
- different platforms.
- 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.
- 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.
- David L. Mills (mills@udel.edu)
- 21 June 1998