[ntpsec commit] Bring the directory listing in README up to date.
Eric S. Raymond
esr at ntpsec.org
Tue Oct 20 08:48:16 UTC 2015
Module: ntpsec
Branch: master
Commit: ebf65a7678144a7fef26c9f89a190e0df979d74a
Changeset: http://git.ntpsec.org/ntpsec/commit/?id=ebf65a7678144a7fef26c9f89a190e0df979d74a
Author: Eric S. Raymond <esr at thyrsus.com>
Date: Tue Oct 20 04:48:05 2015 -0400
Bring the directory listing in README up to date.
---
README | 29 +++++++++++++++++++----------
1 file changed, 19 insertions(+), 10 deletions(-)
diff --git a/README b/README
index ba33d2a..878a8ab 100644
--- a/README
+++ b/README
@@ -35,6 +35,8 @@ docs/:: Directory containing a complete set of documentation on
include/:: Directory containing include header files used by most
programs in the distribution.
+INSTALL:: Installation instructions.
+
lib/:: Source code for third-party libraries included in the
distribution. Currently just one: isc, utility code
from Internet Systems Consortium. The local copy has
@@ -51,21 +53,22 @@ libparse/:: This directory contains the files making up the parser for
by just providing a conversion routine and the
appropriate NTP parameters
+NEWS:: Project news summarizing user-visible changes.
+
ntpd/:: Sources for the main time-synchronization daemon.
-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.
+ntpdig/:: Query an NTP or SNTP server to report or set the time.
+ (This tool was formerly sntp).
-ntpfrob:: The ntpfrob utility collects several small diagnostic
+ntpfrob/:: The ntpfrob utility collects several small diagnostic
functions for reading and tweaking the local clock
hardware, including reading the clock tick rate,
precision, and jitter.
-ntpkeygen:: Directory containing the utility program used to generate
+ntpkeygen/:: Directory containing the utility program used to generate
NTP authentication keys.
-mtpleapfetch:: Directory containing a script ro be run from a cron job
+ntpleapfetch/:: Directory containing a script ro be run from a cron job
to keep your local leap-second file properly updated.
ntpq/:: Directory containing sources for a utility program to
@@ -73,22 +76,28 @@ ntpq/:: Directory containing sources for a utility program to
related timekeeping information. This program conforms
to Appendix A of the NTP Version 3 Specification RFC 1305.
+ntptime/:: Directory containing a utility for reading and modifying
+ kernel parameters related to the local clock.
+
ports/:: Subdirectories of this contain code for non-Unix operating
systems. At present there is just one, for Windows.
+pylib/:: A library of Python procedures used by the build sytem.
+
+README:: This file
+
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.
-ntpdig/:: Query an NTP or SNTP server to report or set the time.
- (This tool was formerly sntp).
-
tests/:: Self-test code.
util/:: Directory containing sources for various utility and
- testing programs.
+ testing programs that are *not* part of a normal installation.
+
+VERSION:: The version stamp, to be used by scripts and programs.
waf:: A copy of the waf builder. This is the engine used to configure
and build the codebase.
More information about the vc
mailing list