README
1
2Submit patches, bug reports, and enhancement requests via
3
4 http://bugs.ntp.org
5
6 The ntp Distribution Base Directory
7
8This directory and its subdirectories contain the Network Time Protocol
9Version 4 (NTP) distribution for Unix and Windows/NT systems. This release
10may still work on VxWorks, too.
11
12The contents of the base directory are given in this file. The contents of
13subdirectories are given in the README files in each subdirectory.
14
15A complete explanation of the configure, compile and install process, as
16well as setting up an NTP subnet, is in the HTML pages in the ./html/
17directory. For more information on NTP and how to get a working setup,
18read WHERE-TO-START.
19
20For Windows/NT, visit html/build/hints/winnt.html .
21
22The base directory ./ contains the autoconfiguration files, source
23directories and related stuff:
24
25COPYRIGHT Excerpt from the HTML file ./html/copyright.html. This file
26 specifies copyright conditions, together with a list of
27 major authors and electric addresses.
28
29INSTALL Generic installation instructions for autoconf-based programs.
30 Unless you really know what you are doing, you should read the
31 directions in the HTML pages, starting with ./html/index.html.
32
33NEWS What's new in this release.
34
35README This file.
36
37README.bk Instructions for folks who use the BitKeeper-repository
38 version of NTP.
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
52adjtimed Directory containing the sources for the adjtime daemon
53 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.html) 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
111ntpdate Directory containing sources for a program to set the
112 local machine time from one or more remote machines
113 running NTP. Operates like rdate, but much more accurate.
114
115ntpq Directory containing sources for a utility program to
116 query local and remote NTP peers for state variables and
117 related timekeeping information. This program conforms
118 to Appendix A of the NTP Version 3 Specification RFC 1305.
119
120ntptrace Directory containing sources for a utility program that
121 can be used to reveal the chain of NTP peers from a
122 designated peer to the primary server at the root of the
123 timekeeping subnet.
124
125parse Directory containing files belonging to the generic
126 parse reference clock driver. For reasonably simple
127 clocks it is possible to get away with about 3-4Kb of
128 code. additionally the SunOS 4.x/Solaris 5.3 streams
129 module for parse squats here.
130
131patches Directory containing patches already applied to this
132 distribution. These are included for record and to help
133 in possible porting problems.
134
135scripts Directory containing scripts to build the configuration
136 files in this directory and then the makefiles used in
137 various dependent directories. the subdirectories
138 monitoring and support hold various perl and shell
139 scripts for visualizing synchronization and daemon startup.
140
141stamp.h.in Configuration file generated automatically from configure.in.
142 Do not edit.
143
144util Directory containing sources for various utility and
145 testing programs.
146
147David L. Mills (mills@udel.edu)
14821 June 1998
149
README.bk
README.hackers
1Notes to hackers.
2
3See README.patches for information about submitting patches.
4
5---
6
7Dave likes this code indented formatted in a consistent way.
8The file "dot.emacs" has the emacs C-mode indentation style that Dave likes.
9
10---
11
12NTP4 uses ANSI C. Some folks are blessed with a pre-ansi C compiler. We
13support them by using "ansi2knr" in the Makefiles, which is automatically
14detected and selected by the configure process.
15
16For ansi2knr to work, we MUST define functions as follows:
17
18type stuff
19function_name ( actual parameters )
20
21While the whitespace is optional, the function name MUST start at column 0.
22
23---
24
25We'd like to see *all* system function declarations live in include/l_stdlib.h
26and NEVER appear in the .c files.
27
28---
29
README.patches
1See README.hackers for notes on coding styles.
2
3The master copy of this information can be found at:
4
5 http://support.ntp.org/Dev/MaintainerIssues#How_to_work_on_a_bug_using_BitKe
6
7If you are going to patch both ntp-stable and ntp-dev
8please do it this way:
9
10 > cd ntp-stable
11 > (make and test your changes to ntp-stable first)
12 > (commit your changes to ntp-stable)
13 > cd ../ntp-dev
14 > bk pull ../ntp-stable (get your changes from ntp-stable)
15 > (resolve any problems and test your changes)
16 > (commit your changes to ntp-dev)
17
18With the current release of bitkeeper it is *much* easier to move changes
19from ntp-stable to ntp-dev than it is to move changes from ntp-dev to
20ntp-stable.
21
22If you make your changes in the above order and then submit them,
23it will be trivial to apply your patches.
24
25Otherwise, it will be much more difficult to apply your patches.
26
27You are pretty much done now if your repos are on pogo.udel.edu.
28
29If these patches are for a bugzilla issue, mark the issue as Resolved/READY
30with a comment of "Please pick up the patches in pogo:/wherever"
31
32---
33
34Please read (and follow) the previous section if you want to submit
35patches for both ntp-stable and ntp-dev.
36
37If you cannot easily get your patches to pogo, you may submit patches
38via the 'bk send' command:
39
40 > cd REPO
41 > bk citool (or bk ci ... ; bk commit ... )
42 > bk pull # make sure your repo is up-to-date
43 > bk send -d -ubk://www.ntp.org/home/bk/REPO - > file-containing-the-patch
44 > bk receive -vv -a < file-containing-the-patch
45 # Sanity check.
46
47 # Open a bugzilla item at <http://bugzilla.ntp.org>
48
49 # After the bug is opened, visit the bug and attach file-containing-the-patch
50
README.refclocks
1This is a list of the #define REFCLK_* stuff.
2
3If you want to add a new refclock let us know and we'll assign you a number.
4
5Should this list also include the name of the party responsible for the
6refclock?
7
8LOCALCLOCK 1 /* external (e.g., lockclock) */
9GPS_TRAK 2 /* TRAK 8810 GPS Receiver */
10WWV_PST 3 /* PST/Traconex 1020 WWV/H */
11SPECTRACOM 4 /* Spectracom (generic) Receivers */
12TRUETIME 5 /* TrueTime (generic) Receivers */
13IRIG_AUDIO 6 /* IRIG-B/W audio decoder */
14CHU_AUDIO 7 /* CHU audio demodulator/decoder */
15PARSE 8 /* generic driver (usually DCF77,GPS,MSF) */
16GPS_MX4200 9 /* Magnavox MX4200 GPS */
17GPS_AS2201 10 /* Austron 2201A GPS */
18GPS_ARBITER 11 /* Arbiter 1088A/B/ GPS */
19IRIG_TPRO 12 /* KSI/Odetics TPRO-S IRIG */
20ATOM_LEITCH 13 /* Leitch CSD 5300 Master Clock */
21MSF_EES 14 /* EES M201 MSF Receiver */
22GPSTM_TRUE 15 /* OLD TrueTime GPS/TM-TMD Receiver */
23IRIG_BANCOMM 16 /* Bancomm GPS/IRIG Interface */
24GPS_DATUM 17 /* Datum Programmable Time System */
25NIST_ACTS 18 /* NIST Auto Computer Time Service */
26WWV_HEATH 19 /* Heath GC1000 WWV/WWVH Receiver */
27GPS_NMEA 20 /* NMEA based GPS clock */
28GPS_VME 21 /* TrueTime GPS-VME Interface */
29ATOM_PPS 22 /* 1-PPS Clock Discipline */
30PTB_ACTS NIST_ACTS
31USNO NIST_ACTS
32GPS_HP 26 /* HP 58503A Time/Frequency Receiver */
33ARCRON_MSF 27 /* ARCRON MSF radio clock. */
34SHM 28 /* clock attached thru shared memory */
35PALISADE 29 /* Trimble Navigation Palisade GPS */
36ONCORE 30 /* Motorola UT Oncore GPS */
37GPS_JUPITER 31 /* Rockwell Jupiter GPS receiver */
38CHRONOLOG 32 /* Chrono-log K WWVB receiver */
39DUMBCLOCK 33 /* Dumb localtime clock */
40ULINK 34 /* Ultralink M320 WWVB receiver */
41PCF 35 /* Conrad parallel port radio clock */
42WWV_AUDIO 36 /* WWV/H audio demodulator/decoder */
43FG 37 /* Forum Graphic GPS */
44HOPF_SERIAL 38 /* hopf DCF77/GPS serial line receiver */
45HOPF_PCI 39 /* hopf DCF77/GPS PCI receiver */
46JJY 40 /* JJY receiver */
47TT560 41 /* TrueTime 560 IRIG-B decoder */
48ZYFER 42 /* Zyfer GPStarplus receiver */
49RIPENCC 43 /* RIPE NCC Trimble driver */
50??????? 44 Claas Hilbrecht (20020711)
51
README.versions
1
2NTP uses A.B.C - style release numbers.
3
4At the moment:
5
6 A is 4, for ntp V4.
7 B is the major release number.
8 C is the minor release number. Even numbers are 'stable' releases and
9 odd numbers are "development" releases.
10
11Following the release number may be the letter 'p' followed by a number.
12This indicates a point (or patch) release.
13
14Release candidates have -RC in the release number.
15
16Here are some recent versions numbers as an example:
17
18 4.2.2 A production release (from the ntp-stable repository)
19 4.2.2p2 A production release (from the ntp-stable repository)
20 4.2.3p12 A development release
21 4.2.3p15-rc1 A release candidate for 4.2.4
22
23Note that after the ntp-dev repo produces a production release it will
24be copied into the ntp-stable and the cycle will repeat.
25
26Feel free to suggest improvements...
27
28
readme.y2kfixes
1
2AT&T Freeware Year 2000 Certification
3====================================
4
5This is the "readme" file for the freeware application which has
6been certified by AT&T Labs as part of the "Freeware Y2K
7Certification Project".
8
9DISCLAIMER
10----------
11 For its own internal business purposes AT&T Labs has
12 assessed various programs obtained from the Internet for
13 Year-2000 (Y2K) readiness that were not sufficiently certified
14 for AT&T's needs. As a service to the computing community
15 AT&T Labs is freely releasing this information to the
16 public as a series of "Y2K Application Updates", one update
17 for what AT&T Labs considers an "application".
18
19 For use outside of AT&T, AT&T Labs is not certifying this
20 information is correct, that any software, including repairs
21 and tests, will help others in any way, survive the year
22 2000, nor work with current applications. Nor is AT&T
23 taking any responsibility for repairing any Y2K problems
24 that were overlooked nor repairing any bugs in any
25 "Y2K Application Update". All risk of using this Y2K
26 Application Update remains with the user who is expected
27 to test that this update meets their needs.
28
29 LICENSE TO USE
30 AT&T's intent is to ensure these Y2K patches are freely
31 available to the public but will not maintain a public web site
32 for their distribution. Any copyright claims only only apply to
33 the specific changes made by Y2K to the code. Any original
34 copyright holders retain rights to unchanged code. Wherever
35 possible patches will be returned to the current owner(s) of the code.
36
37 Owners and publishers are free to incorporate appropriate patches,
38 upgrades, and tests within legal future distributions as long as
39 they include the credit:
40
41 Various Y2K updates and tests provided by AT&T Labs.
42 Copyright 1999 AT&T.
43
44 and any AT&T "comments" on the changed code remain intact.
45
46 Any distributions of the updates must keep the entire update
47 intact, without any change, including copyright and disclaimer
48 information. If integrated with the original application items
49 not needed for an integrated release may be omitted. When
50 distributed on the same media as the original application there
51 must be no charge for this "Y2k Application Update".
52
53 CONTACTS
54 If you find any overlooked Y2K problems, or have other strictly Y2K
55 repairs for the software, please E-mail:
56
57 y2k@y2k.labs.att.com
58
59 This address is strictly reserved for the topic at hand.
60 AT&T makes no commitments to answer any E-mail
61 to this address. AT&T is free to use any submissions,
62 including publishing in future Y2K related release notes,
63 without payment or advance notice to the submitting person or
64 persons... appropriate credit will be given in any future
65 publications to the first person submitting something that
66 AT&T uses.
67
68
69======================================================================
70
71Perl ver - 4.036
72No. of Repairs: 2 Repairs
73Compilation of Patches Required: No
74OS Tested: Solaris 2.6
75
76======================================================================
77
78ORGANIZATION OF THE "Y2KFixes" DIRECTORY
79
80The "Y2KFixes" directory has been included in the archive to give
81you information about the Y2K testing that was conducted and their
82results.
83
84The Y2KFixes directory contains at least the following three files:
85|----> NOTES.y2kfixes -- Technical details about the Y2K Testing
86|----> Readme.y2kfixes -- this Readme file
87|----> Results.y2kfixes -- The results of Y2K Environment Tests
88
89The directory may contain additional files and/or directories, as
90appropriate to the application, to provide the exact snapshots.
91
92
93======================================================================
94
95INSTALLING THE "PATCHES"
96
97If you have downloaded a "patch", then you may install it as follows:
98
99 At the same level as the source directory, invoke:
100
101 patch -p < *.patches
102
103The patch file contains a header which has a manifest of changed files.
104
105======================================================================
106
107ADDITIONAL INSTRUCTIONS:
108
109
1101) Extract the patches into perl-4.036 directory which is top level directory
111 for the perl4 source.
112
1132) cd to Y2KFixes.
114
1153) It will have y2k directory which contains regression tests for Y2K testing.
116
1174) now cd to ../t which contains TEST file for running this regression tests.
118
1195) run TEST, see the results & apply patches.
120
1216) Once you apply the patch, you need to run a shell script in x2p/find2perl.SH
122 which will generate find2perl.
123
124
125======================================================================
126
127SUPPORT
128
129See http://y2k.labs.att.com/freeware. There will be no ongoing
130support for the project. But if you have some very important issue,
131you may email us at: y2k@y2k.labs.att.com
132
133