README 3.07 KB
Newer Older
1
= The NTPsec distribution base directory =
2

3
This directory and its subdirectories contain NTPSec, a
4
security-hardened implementation of Network Time Protocol Version 4.
5 6 7
You can browse a summary of differences from legacy NTP here:

https://docs.ntpsec.org/latest/ntpsec.html
Harlan Stenn's avatar
Harlan Stenn committed
8 9

The contents of the base directory are given in this file. The contents of
10
subdirectories are usually given in the README files in each subdirectory.
11

12
The base directory ./ contains the configuration files, source
13 14
directories and related stuff:

15
INSTALL::	Generic installation instructions.
16

17
NEWS::		What's new in this release.
18

19
README::	This file.
20

21 22
VERSION::	The version stamp, to be used by scripts and programs.

Eric S. Raymond's avatar
Eric S. Raymond committed
23 24 25 26
attic/:: 	Directory containing source code that is *not* part of a
		normal installation. Things can disappear from here at any
		time.

27
contrib/::	Directory containing contributed scripts, dragons dwell here.
28
		Some of this might eventually move to being supported code.
29

30 31
devel/::	Documentation and small tools aimed at developers.
		Includes a hacking guide and a tour of the internals.
32

33 34 35
docs/::		Directory containing a complete set of documentation on
		building and configuring a NTP server or client. The files
		are in asciidoc markup.  This replaces the 'html' directory
36
		of previous versions, but html can be generated from it.
37

38
etc/::		Directory containing a motley collection of configuration files
39
		and launch scripts for various systems. For example
40 41
		only.

42
include/::	Directory containing include header files used by most
43 44
		programs in the distribution.

45 46
libisc/::	Utility code from Internet Systems Consortium.  The local
		copy has been significantly trimmed and modified.
47 48

libjsmn/::	A minimal JSON library used by the GPSD-JSON driver.
49

50 51
libntp/::	Directory containing library source code used by most
		programs in the distribution.
52

53
libparse/:: 	This directory contains the files making up the parser for
54 55 56 57 58
		the parse refclock driver. For reasonably sane clocks
		this refclock drivers allows a refclock implementation
		by just providing a conversion routine and the
		appropriate NTP parameters

59 60 61 62 63
ntpclients/::   Directory containing sources for clients - utility programs
		to query local and remote NTP installations for log status,
		state variables, and other timekeeping information.  The term
		"clients" is used quite loosely here; any tool that is not a
		not a multi-file C program probably lives in this directory.
64

65
ntpd/::		Sources for the main time-synchronization daemon.
66

67
ntpfrob/::      The ntpfrob utility collects several small diagnostic
68 69 70 71
		functions for reading and tweaking the local clock
		hardware, including reading the clock tick rate,
		precision, and jitter.

72 73 74
ntptime/:: 	Directory containing a utility for reading and modifying
		kernel parameters related to the local clock.

75
pylib/::	Installable Python helper classes for scripts.
76

77
tests/::	Self-test code.
78

79 80 81
waf::		A copy of the waf builder.  This is the engine used to configure
		and build the codebase.

82 83
wafhelpers/::	A library of Python procedures used by the waf build system.

84
wscript::	NTP-specific waf rules.
85

86 87
www/::		Sample ntpviz files

88
// end