No empty .Rs/.Re
[netbsd-mini2440.git] / usr.sbin / ntp / ntptime / ntptime.8
blob9cb3f86148d120af622fde2a85d0ba8e8e42bd4c
1 .\"     $NetBSD: ntptime.8,v 1.6 2002/02/02 01:27:22 wiz Exp $
2 .\" Converted from HTML to mandoc by ntp-html2mdoc.pl
3 .\"
4 .Dd March 29, 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
20 This program is useful only with special kernels described in the
21 .%T "A Kernel Model for Precision Timekeeping"
22 page in
23 .Pa /usr/share/doc/html/ntp/kern.html .
24 It reads and displays
25 time-related kernel variables using the
26 .Xr ntp_gettime 2
27 system call.
28 A similar display can be obtained using the
29 .Nm ntpdc
30 program and
31 .Pa kerninfo
32 command.
33 .Sh OPTIONS
34 .Bl -tag -width indent
35 .It Fl c
36 Display the execution time of
37 .Nm
38 itself.
39 .It Fl e Ar est_error
40 Specify estimated error, in microseconds.
41 .It Fl f Ar frequency
42 Specify frequency offset, in parts per million.
43 .It Fl h
44 Display times in Unix timeval format. Default is NTP format.
45 .It Fl l
46 Specify the leap bits as a code from 0 to 3.
47 .It Fl m Ar max_error
48 Display help information.
49 .It Fl o Ar offset
50 Specify clock offset, in microseconds.
51 .It Fl r
52 Display Unix and NTP times in raw format.
53 .It Fl s Ar status
54 Specify clock status. Better know what you are doing.
55 .It Fl t Ar time_constant
56 Specify time constant, an integer in the range 0-4.
57 .El
58 .Sh AUTHORS
59 David L. Mills (mills@udel.edu)