xref: /openbsd/usr.sbin/ntpd/ntpctl.8 (revision 771fbea0)
1.\" $OpenBSD: ntpctl.8,v 1.8 2015/03/11 19:38:48 jmc Exp $
2.\"
3.\" Copyright (c) 2012 Mike Miller <mmiller@mgm51.com>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER IN
14.\" AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
15.\" OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: March 11 2015 $
18.Dt NTPCTL 8
19.Os
20.Sh NAME
21.Nm ntpctl
22.Nd control the Network Time Protocol daemon
23.Sh SYNOPSIS
24.Nm ntpctl
25.Fl s Cm all | peers | Sensors | status
26.Sh DESCRIPTION
27The
28.Nm
29program displays information about the running
30.Xr ntpd 8
31daemon.
32.Pp
33The options are as follows:
34.Bl -tag -width "-s modifierX"
35.It Fl s Cm all | peers | Sensors | status
36Used to display information about the running daemon.
37Keywords may be abbreviated.
38.Pp
39.Cm all
40shows all data available.
41.Pp
42.Cm peers
43shows the following information about each peer: weight, trustlevel,
44stratum, number of seconds until the next poll, polling interval
45in seconds, and offset, network delay and network jitter in milliseconds.
46When the system clock is synced to a peer, an asterisk
47is displayed to the left of the weight column for that peer.
48.Pp
49.Cm Sensors
50shows the following information about each sensor: weight, sensor "good"
51status, stratum, and offset and the configured correction in
52milliseconds.
53When the system clock is synced to a sensor, an asterisk
54is displayed to the left of the weight column for that sensor.
55.Pp
56.Cm status
57shows the status of peers and sensors, and whether the system clock is synced.
58When the system clock is synced, the stratum is displayed.
59When the system clock is not synced, the offset of the system clock,
60as reported by the
61.Xr adjtime 2
62system call, is displayed.
63When the median constraint is set, the offset to the local time is displayed.
64.El
65.Sh FILES
66.Bl -tag -width "/var/run/ntpd.sockXXX" -compact
67.It Pa /var/run/ntpd.sock
68Socket file for communication with
69.Xr ntpd 8 .
70.El
71.Sh SEE ALSO
72.Xr adjtime 2 ,
73.Xr ntpd.conf 5 ,
74.Xr ntpd 8
75.Sh HISTORY
76The
77.Nm
78program first appeared in
79.Ox 5.5 .
80