xref: /freebsd/contrib/ntp/scripts/README (revision 416ba5c74546f32a993436a99516d35008e9f384)
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
9c0b746e5SOllivier Robertmonitoring      directory containing perl scripts useful for monitoring
10c0b746e5SOllivier Robert                operations
11c0b746e5SOllivier Robert
12*2b15cb3dSCy Schubertrc		start/stop scripts for NTP
13c0b746e5SOllivier Robert
14224ba2bdSOllivier Robertntp-wait	Blocks until ntpd is in state 4 (synchronized).
15*2b15cb3dSCy Schubert		Useful at boot time, to delay the boot sequence
16224ba2bdSOllivier Robert		until after "ntpd -g" has set the time.
17224ba2bdSOllivier Robert
18a151a66cSOllivier Robertntpsweep	prints per host given in <file> the NTP stratum level, the
19a151a66cSOllivier Robert		clock offset in seconds, the daemon version, the operating
20a151a66cSOllivier Robert		system and the processor.
21a151a66cSOllivier Robert
22*2b15cb3dSCy Schubertntptrace        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*2b15cb3dSCy Schubertsummary         Generate summary files out of stat files produced by NTP
29*2b15cb3dSCy Schubert                daemon.
30*2b15cb3dSCy Schubert
31*2b15cb3dSCy Schubertplot_summary    Plot summaries generated by summary script.
32