Initial import from FreeBSD RELENG_4:
[dragonfly.git] / contrib / ntp / html / ntptime.htm
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
2 <html>
3 <head>
4 <meta name="generator" content="HTML Tidy, see www.w3.org">
5 <title>ntptime - read kernel time variables</title>
6 </head>
7 <body>
8 <h3><tt>ntptime</tt> - read kernel time variables</h3>
9
10 <img align="left" src="pic/pogo5.gif" alt="gif"><a href=
11 "http://www.eecis.udel.edu/~mills/pictures.htm">from <i>Pogo</i>,
12 Walt Kelly</a> 
13
14 <p>The turtle is been swimming in the kernel.<br clear="left">
15 </p>
16
17 <hr>
18 <h4>Synopsis</h4>
19
20 <tt>ntptime [ -chr ] [ -e <i>est_error</i> ] [ -f <i>frequency</i>
21 ] [ -m <i>max_error</i> ] [ -o <i>offset</i> ] [ -s <i>status</i> ]
22 [ -t <i>time_constant</i>]</tt> 
23
24 <h4>Description</h4>
25
26 This program is useful only with special kernels described in the
27 <a href="kern.htm">A Kernel Model for Precision Timekeeping</a>
28 page. It reads and displays time-related kernel variables using the
29 <tt>ntp_gettime()</tt> system call. A similar display can be
30 obtained using the <tt>ntpdc</tt> program and <tt>kerninfo</tt>
31 command. 
32
33 <h4>Options</h4>
34
35 <dl>
36 <dt><tt>-c</tt></dt>
37
38 <dd>Display the execution time of <tt>ntptime</tt> itself.</dd>
39
40 <dt><tt>-e <i>est_error</i></tt></dt>
41
42 <dd>Specify estimated error, in microseconds.</dd>
43
44 <dt><tt>-f <i>frequency</i></tt></dt>
45
46 <dd>Specify frequency offset, in parts per million.</dd>
47
48 <dt><tt>-h</tt></dt>
49
50 <dd>Display help information.</dd>
51
52 <dt><tt>-m <i>max_error</i></tt></dt>
53
54 <dd>Specify max possible errors, in microseconds.</dd>
55
56 <dt><tt>-o <i>offset</i></tt></dt>
57
58 <dd>Specify clock offset, in microseconds.</dd>
59
60 <dt><tt>-r</tt></dt>
61
62 <dd>Display Unix and NTP times in raw format.</dd>
63
64 <dt><tt>-s <i>status</i></tt></dt>
65
66 <dd>Specify clock status. Better know what you are doing.</dd>
67
68 <dt><tt>-t <i>time_constant</i></tt></dt>
69
70 <dd>Specify time constant, an integer in the range 0-10.</dd>
71 </dl>
72
73 <hr>
74 <a href="index.htm"><img align="left" src="pic/home.gif" alt=
75 "gif"></a>
76 <address><a href="mailto:mills@udel.edu">David L. Mills
77 &lt;mills@udel.edu&gt;</a></address>
78 </body>
79 </html>
80