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