xref: /freebsd/contrib/ntp/util/README (revision 9c2daa00)
1c0b746e5SOllivier RobertREADME file for directory ./util of the NTP Version 4 distribution
2c0b746e5SOllivier Robert
3c0b746e5SOllivier RobertThis directory contains the sources for the various utility programs.
4c0b746e5SOllivier RobertSee the README and RELNOTES files in the parent directory for directions
5c0b746e5SOllivier Roberton how to make and install these programs.
6c0b746e5SOllivier Robert
7c0b746e5SOllivier RobertThe ntptime.c program checks the kernel configuration for the NTP user
8c0b746e5SOllivier Robertinterface syscalls ntp_gettime() and ntp_adjtime().  If present, the
9c0b746e5SOllivier Robertcurrent timekeeping data are displayed.  If not, a dissapointment is
10c0b746e5SOllivier Robertdisplayed.  See the kernel page file in the HTML documentation in
11c0b746e5SOllivier Robertdistribution for further details. ntptime will be built be if configure
12c0b746e5SOllivier Robertbelieves your system can use it.
13c0b746e5SOllivier Robert
14c0b746e5SOllivier RobertThe jitter.c program can be used to determine the timing jitter due to
15c0b746e5SOllivier Robertthe operating system in a gettimeofday() call.  For most systems the
16c0b746e5SOllivier Robertdominant contribution to the jitter budget is the period of the hardware
17c0b746e5SOllivier Robertinterrupt, usually in the range 10 us-1 ms.  For those systems with
18c0b746e5SOllivier Robertmicrosecond counters, such as recent Sun and certain HP and DEC systems,
19c0b746e5SOllivier Robertthe jitter is dominated only by the operating system.
20c0b746e5SOllivier Robert
21c0b746e5SOllivier RobertThe timetrim.c program can be used with SGI machines to implement a
22c0b746e5SOllivier Robertscheme to discipline the hardware clock frequency.  See the source code
23c0b746e5SOllivier Robertfor further information.
24c0b746e5SOllivier Robert
25c0b746e5SOllivier RobertThe byteorder.c and longsize.c programs are used during the configuration
26c0b746e5SOllivier Robertprocess to determine the byte order (little or big endian) and longword
27c0b746e5SOllivier Robertsize (32 or 64 bits).  See the configure scripts for further details.
28c0b746e5SOllivier Robert
29c0b746e5SOllivier RobertThe testrs6000.c program is used for testing purposes with the IBM
30c0b746e5SOllivier RobertRS/6000 AIX machines. Bill Jones <jones@chpc.utexas.edu> reports:
319c2daa00SOllivier Robert"I could not get a tickadj of less than 40 us to work on a RS6000.
329c2daa00SOllivier RobertIf you set it less than 40 us do so at your own risk!"
33c0b746e5SOllivier Robert
34c0b746e5SOllivier RobertThe tickadj.c program can be used to read and set various kernel
35c0b746e5SOllivier Robertparameters affecting NTP operations. See the tickadj page in the HTML
36c0b746e5SOllivier Robertdocumentation for further details.  tickadj will be built if configure
37c0b746e5SOllivier Robertbelieves your system can use it.
38
39tg.c and tg2.c are tone generators.  They make audio signals
40that emulate WWV or IRIG (-B and -E).  tg runs on Solaris.
41tg2 is a clone that runs on Linux, FreeBSD, and NetBSD.
42Read the source for the fine print.  tg2 has a help option
43available via -h.
44
45