xref: /freebsd/usr.sbin/ntp/doc/ntptime.8 (revision 5521ff5a4d1929056e7ffc982fac3341ca54df7c)
1.\"
2.\" $FreeBSD$
3.\"
4.Dd January 7, 2000
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
20This program 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.Xr ntp_gettime 2
32and
33.Xr ntp_adjtime 2
34system calls if available.
35A similar display can be obtained using the
36.Xr ntpdc 8
37program's
38.Ic kerninfo
39command.
40The following options are available:
41.Bl -tag -width indent
42.It Fl c
43Display the execution time of
44.Nm
45itself.
46.It Fl e Ar est_error
47Specify estimated error, in microseconds.
48.It Fl f Ar frequency
49Specify frequency offset, in parts per million.
50.It Fl h
51Display times in Unix timeval format.
52Default is NTP format.
53.It Fl l
54Specify the leap bits as a code from 0 to 3.
55.It Fl m Ar max_error
56Display help information.
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 ntp_adjtime 2 ,
67.Xr ntp_gettime 2 ,
68.Xr ntpdc 8
69