xref: /freebsd-13.1/contrib/ntp/scripts/README (revision 224ba2bd)
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 Robertmonitoring      directory containing perl scripts useful for monitoring
10a151a66cSOllivier Robert                operations
11a151a66cSOllivier Robert
12c0b746e5SOllivier Robertrc		start/stop scripts for NTP
13c0b746e5SOllivier Robert
14c0b746e5SOllivier Robertntp-wait	Blocks until ntpd is in state 4 (synchronized).
15c0b746e5SOllivier Robert		Useful at boot time, to delay the boot sequence
16c0b746e5SOllivier Robert		until after "ntpd -g" has set the time.
17c0b746e5SOllivier Robert
18c0b746e5SOllivier Robertntpsweep	prints per host given in <file> the NTP stratum level, the
19c0b746e5SOllivier Robert		clock offset in seconds, the daemon version, the operating
20c0b746e5SOllivier Robert		system and the processor.
21*224ba2bdSOllivier Robert
22*224ba2bdSOllivier Robertntptrace        Trace ntp peers of a server up to stratum 1.
23c0b746e5SOllivier Robert
24c0b746e5SOllivier Robertstats		directory containing awk and shell scripts useful for
25c0b746e5SOllivier Robert		maintaining statistics summaries of clockstats, loopstats
26c0b746e5SOllivier Robert		and peerstats files
27c0b746e5SOllivier Robert
28*224ba2bdSOllivier Robertsummary         Generate summary files out of stat files produced by NTP
29*224ba2bdSOllivier Robert                daemon.
30*224ba2bdSOllivier Robert
31*224ba2bdSOllivier Robertplot_summary    Plot summaries generated by summary script.
32a151a66cSOllivier Robert