xref: /freebsd/contrib/ntp/scripts/README (revision 224ba2bd37e182b64f7d78defef8a6cacaad3415)
1c0b746e5SOllivier RobertREADME file for directory ./scripts of the NTP Version 4 distribution
2c0b746e5SOllivier Robert
3c0b746e5SOllivier RobertThis directory contains shell and perl script files for the configuration,
4c0b746e5SOllivier Robertmonitoring and support of NTP installations. See the README and RELNOTES
5c0b746e5SOllivier Robertfiles in the parent directory for directions on how to use these files.
6c0b746e5SOllivier Robert
7c0b746e5SOllivier Robertcalc_tickadj	Calculates "optimal" value for tick given ntp.drift file
8c0b746e5SOllivier Robert
9a151a66cSOllivier Robertfreq_adj	Calculates and optionally sets the clock frequency
10a151a66cSOllivier Robert		based on ntp.drift .  For FreeBSD systems.
11a151a66cSOllivier Robert
12c0b746e5SOllivier Robertmkver.in	script to create new version numbers for all sources
13c0b746e5SOllivier Robert
14c0b746e5SOllivier Robertmonitoring      directory containing perl scripts useful for monitoring
15c0b746e5SOllivier Robert                operations
16c0b746e5SOllivier Robert
17c0b746e5SOllivier Robertrc1		start/stop scripts for NTP
18c0b746e5SOllivier Robert
19c0b746e5SOllivier Robertrc2		start/stop script for NTP
20c0b746e5SOllivier Robert
21224ba2bdSOllivier Robertntp-close	find public stratum 2 servers that don't respond
22224ba2bdSOllivier Robert
23c0b746e5SOllivier Robertntp-groper	script useful for reaching out and rattling the cages of
24c0b746e5SOllivier Robert		NTP peers to see if animals are inside the bars
25c0b746e5SOllivier Robert
26c0b746e5SOllivier Robertntp-restart	script useful for killing and restarting the NTP daemon
27c0b746e5SOllivier Robert
28224ba2bdSOllivier Robertntp-wait	Blocks until ntpd is in state 4 (synchronized).
29224ba2bdSOllivier Robert		Hopefully useful at boot time, to delay the boot sequence
30224ba2bdSOllivier Robert		until after "ntpd -g" has set the time.
31224ba2bdSOllivier Robert
32a151a66cSOllivier Robertntpsweep	prints per host given in <file> the NTP stratum level, the
33a151a66cSOllivier Robert		clock offset in seconds, the daemon version, the operating
34a151a66cSOllivier Robert		system and the processor.
35a151a66cSOllivier Robert
36c0b746e5SOllivier Robertntpver		What version of the NTP daemon is running?
37c0b746e5SOllivier Robert
38c0b746e5SOllivier Robertstats		directory containing awk and shell scripts useful for
39c0b746e5SOllivier Robert		maintaining statistics summaries of clockstats, loopstats
40c0b746e5SOllivier Robert		and peerstats files
41c0b746e5SOllivier Robert
42c0b746e5SOllivier Robertsupport         directory containing shell and perl scripts useful for
43c0b746e5SOllivier Robert                configuration and monitoring of NTP subnets
44