xref: /freebsd/usr.sbin/ntp/doc/ntptime.8 (revision 2f9966ff63d65bd474478888c9088eeae3f9c669)
1.\"
2.Dd April 27, 2015
3.Dt NTPTIME 8
4.Os
5.Sh NAME
6.Nm ntptime
7.Nd read kernel time variables
8.Sh SYNOPSIS
9.Nm
10.Op Fl chr
11.Op Fl e Ar est_error
12.Op Fl f Ar frequency
13.Op Fl m Ar max_error
14.Op Fl o Ar offset
15.Op Fl s Ar status
16.Op Fl t Ar time_constant
17.Sh DESCRIPTION
18The
19.Nm
20utility is useful only with special kernels
21described in the
22.Qo
23A Kernel Model for Precision Timekeeping
24.Qc
25page
26(available as part of the HTML documentation
27provided in
28.Pa /usr/share/doc/ntp ) .
29It reads and displays time-related kernel variables
30using the
31.Fn gettime
32and
33.Xr adjtime 2
34system calls if available.
35A similar display can be obtained using the
36.Xr ntpdc 8
37program's
38.Ic kerninfo
39command.
40.Pp
41The following options are available:
42.Bl -tag -width indent
43.It Fl c
44Display the execution time of
45.Nm
46itself.
47.It Fl e Ar est_error
48Specify estimated error, in microseconds.
49.It Fl f Ar frequency
50Specify frequency offset, in parts per million.
51.It Fl h
52Display help information.
53.It Fl m Ar max_error
54Specify max possible errors, in microseconds.
55.It Fl o Ar offset
56Specify clock offset, in microseconds.
57.It Fl r
58Display Unix and NTP times in raw format.
59.It Fl s Ar status
60.It Fl t Ar time_constant
61Specify time constant, an integer in the range 0-4.
62.El
63.Sh SEE ALSO
64.Xr adjtime 2 ,
65.Xr ntpdc 8
66