source: trunk/third/xntp/README @ 10832

Revision 10832, 6.4 KB checked in by brlewis, 27 years ago (diff)
This commit was generated by cvs2svn to compensate for changes in r10831, which included commits to RCS files with non-trunk default branches.
Line 
1The xntp3 Distribution Base Directory
2
3This directory and its subdirectories contain the Network Time Protocol
4Version 3 (NTP) distribution for Unix systems. The contents of the base
5directory are given in this file. The contents of subdirectories are
6given in the README files in each subdirectory.
7
8A complete explanation of the configure, compile and install process, as
9well as setting up an NTP subnet, is in the HTML pages in the ./html
10directory. For more information on NTP and how to get a working setup,
11read WHERE-TO-START.
12
13Note that the ./doc, ./hints and ./gadget directories in previous
14releases prior to xntp3.5 are gone. The ./doc and ./hints directories
15have been replaced with the ./html directory, which contains a complete
16set of documentation in HTML format. In addition, the information in the
17PORTING and RELNOTES has been incorporated in the HTML documentation.
18The ./gadget directory has been replaced by a compressed tar archive
19available via the documentation pages.
20
21Note that in this release the ./compilers, ./machines and ./refclocks
22directories and Config.local.dist file in previous releases are gone.
23They have been replaced by files used by the new autoconfigure feature,
24which uses the GNU automake-1.2 and autoconf-2.12 utilities. These
25utilities are used only to construct the distribution itself and are not
26neccesary to compile and install the software.
27
28The base directory ./ contains the autoconfiguation files, source
29directories and related stuff:
30
31COPYRIGHT       link to the HTML file ./html/copyright.html. This file
32                specifies copyright conditions, together with a list of
33                major authors and electric addresses.
34
35INSTALL         hints for compiling and installing the software. Unless
36                you really know what you are doing, you should read the
37                directions in the HTML pages.
38
39Makefile.am     make file configuration file. Edit only if you have the
40                GNU automake and autoconf utilities installed.
41
42Makefile.in     make file template for Unix. Do not edit.
43
44NEWS            What's new in this release.
45
46README          this file.
47
48TAGS            used by Unix utilities.
49
50TODO            used by system developers.
51
52WHERE-TO-START  hints on what to read in order to get a working
53                configuration.
54
55acconfig.h      configuration template header file. Edit only if you
56                have the GNU automake and autoconf utilities installed.
57
58adjtimed        directory containing the sources for the adjtime daemon
59                for HP/UX systems prior to HP-UX 10.0.
60
61autoconf-2.12.patches     Patches for GNU autoconf-2.12
62
63automake-1.2.patches      Patches for GNU automake-1.2 (not really needed)
64
65authstuff       directory containing sources for miscellaneous programs
66                to test, calibrate and certify the cryptographic
67                mechanisms for DES and MD5 based authentication. These
68                programs do not include the cryptographic routines
69                themselves, so are free of U.S. export restrictions.
70
71clockstuff      directory containing sources for miscellaneous programs
72                to test certain auxiliary programs used with some kernel
73                configurations, together with a program to calculate
74                propagation delays for use with radio clocks and
75                national time dissemination services such as WWV/WWVH,
76                WWVB and CHU.
77
78conf            directory containing a motley collection of
79                configuration files for various systems. For example only.
80
81config.guess    script used to identify the machine architecture and
82                operating system.
83
84config.h.in     configuration file generated automatically from
85                configure.in. Do not edit.
86
87configure       script used to configure the distribution. See the HTML
88                pages for a complete description of the options available.
89
90configure.in    master configuration template. Edit only if you have the
91                GNU automake and autoconf utilities installed.
92
93html            directory containing a complete set of documentation on
94                building and configuring a NTP server or client. The
95                documentation is in the form of HTML files suitable for
96                browsing and contains links to additional documentation
97                at various web sites. If a browser is unavailable, an
98                ordinary text editor can be used.
99
100include         directory containing include header files used by most
101                programs in the distribution.
102
103install-sh      script to install a program, script or data file.
104
105kernel          directory containing sources for kernel programs such as
106                line disciplines and STREAMS modules used with the CHU
107                decoder and precision PPS signals.
108
109lib             directory containing library source code used by most
110                programs in the distribution.
111
112libntp          directory containing library source code used by most
113                programs in the distribution.
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
151xntpd           directory containing sources for the NTP Version 3 daemon.
152
153xntpdc          directory containing sources for a utility program to
154                query local and remote NTP peers for state variables and
155                related timekeeping information. This program is
156                specific to this implementation of NTP Version 3 and
157                does not conform to Appendix A of the NTP Version 3
158                Specification RFC 1305.
159
160David L. Mills (mills@udel.edu)
16112 June 1996
Note: See TracBrowser for help on using the repository browser.