xref: /netbsd-src/external/bsd/ntp/dist/util/README (revision 8585484ef87f5a04d32332313cdb799625f4faf8)
1abb0f93cSkardelREADME file for directory ./util of the NTP Version 4 distribution
2abb0f93cSkardel
3abb0f93cSkardelThis directory contains the sources for the various utility programs.
4abb0f93cSkardelSee the README and RELNOTES files in the parent directory for directions
5abb0f93cSkardelon how to make and install these programs.
6abb0f93cSkardel
7abb0f93cSkardelThe ntptime.c program checks the kernel configuration for the NTP user
8abb0f93cSkardelinterface syscalls ntp_gettime() and ntp_adjtime().  If present, the
9abb0f93cSkardelcurrent timekeeping data are displayed.  If not, a dissapointment is
10abb0f93cSkardeldisplayed.  See the kernel page file in the HTML documentation in
11abb0f93cSkardeldistribution for further details. ntptime will be built be if configure
12abb0f93cSkardelbelieves your system can use it.
13abb0f93cSkardel
14abb0f93cSkardelThe jitter.c program can be used to determine the timing jitter due to
15abb0f93cSkardelthe operating system in a gettimeofday() call.  For most systems the
16abb0f93cSkardeldominant contribution to the jitter budget is the period of the hardware
17abb0f93cSkardelinterrupt, usually in the range 10 us-1 ms.  For those systems with
18abb0f93cSkardelmicrosecond counters, such as recent Sun and certain HP and DEC systems,
19abb0f93cSkardelthe jitter is dominated only by the operating system.
20abb0f93cSkardel
21abb0f93cSkardelThe timetrim.c program can be used with SGI machines to implement a
22abb0f93cSkardelscheme to discipline the hardware clock frequency.  See the source code
23abb0f93cSkardelfor further information.
24abb0f93cSkardel
25abb0f93cSkardelThe byteorder.c and longsize.c programs are used during the configuration
26abb0f93cSkardelprocess to determine the byte order (little or big endian) and longword
27abb0f93cSkardelsize (32 or 64 bits).  See the configure scripts for further details.
28abb0f93cSkardel
29abb0f93cSkardelThe testrs6000.c program is used for testing purposes with the IBM
30abb0f93cSkardelRS/6000 AIX machines. Bill Jones <jones@chpc.utexas.edu> reports:
31abb0f93cSkardel"I could not get a tickadj of less than 40 us to work on a RS6000.
32abb0f93cSkardelIf you set it less than 40 us do so at your own risk!"
33abb0f93cSkardel
34abb0f93cSkardelThe tickadj.c program can be used to read and set various kernel
35abb0f93cSkardelparameters affecting NTP operations. See the tickadj page in the HTML
36abb0f93cSkardeldocumentation for further details.  tickadj will be built if configure
37abb0f93cSkardelbelieves your system can use it.
38*8585484eSchristos
39*8585484eSchristostg.c and tg2.c are tone generators.  They make audio signals
40*8585484eSchristosthat emulate WWV or IRIG (-B and -E).  tg runs on Solaris.
41*8585484eSchristostg2 is a clone that runs on Linux, FreeBSD, and NetBSD.
42*8585484eSchristosRead the source for the fine print.  tg2 has a help option
43*8585484eSchristosavailable via -h.
44*8585484eSchristos
45