|
Packit |
09aa44 |
.TH NTPSTAT 1 "" "ntpstat"
|
|
Packit |
09aa44 |
.SH NAME
|
|
Packit |
09aa44 |
ntpstat \- Print NTP synchronisation status
|
|
Packit |
09aa44 |
|
|
Packit |
09aa44 |
.SH SYNOPSIS
|
|
Packit |
09aa44 |
\fBntpstat\fR [\fB-m\fR \fIMAXERROR\fR]
|
|
Packit |
09aa44 |
|
|
Packit |
09aa44 |
.SH DESCRIPTION
|
|
Packit |
09aa44 |
\fBntpstat\fR is a script which prints a brief summary of the system clock's
|
|
Packit |
09aa44 |
synchronisation status when the \fBntpd\fR or \fBchronyd\fR daemon is running.
|
|
Packit |
09aa44 |
It prints the time source (NTP server or reference clock) to which the system
|
|
Packit |
09aa44 |
clock is currently synchronised, its stratum, how often is the server polled,
|
|
Packit |
09aa44 |
and the maximum estimated error of the clock. The script uses the \fBntpq\fR or
|
|
Packit |
09aa44 |
\fBchronyc\fR program to obtain the information from the daemon.
|
|
Packit |
09aa44 |
|
|
Packit |
09aa44 |
Following the NTPv4 specification (RFC 5905), if the time source becomes
|
|
Packit |
09aa44 |
unreachable and there are no other sources that could be selected, the status
|
|
Packit |
09aa44 |
of the clock will still be \*(lqsynchronised\*(rq, but the maximum error will
|
|
Packit |
09aa44 |
be slowly increasing.
|
|
Packit |
09aa44 |
|
|
Packit |
09aa44 |
\fBntpstat\fR exits with a status of 0 if the clock is synchronised, 1 if the
|
|
Packit |
09aa44 |
clock is not synchronised, 2 if the status could not be determined, e.g.
|
|
Packit |
09aa44 |
when the daemon is not running, or 3 if an invalid command-line option was
|
|
Packit |
09aa44 |
specified.
|
|
Packit |
09aa44 |
|
|
Packit |
09aa44 |
.SH OPTIONS
|
|
Packit |
09aa44 |
.TP 8
|
|
Packit |
09aa44 |
\fB-m\fR \fIMAXERROR\fR
|
|
Packit |
09aa44 |
Specify a maximum acceptable error of the clock in milliseconds. If the
|
|
Packit |
09aa44 |
clock is synchronised, but its maximum estimated error is larger than
|
|
Packit |
09aa44 |
\fIMAXERROR\fR, or is unknown, \fBntpstat\fR will exit with a status of 1.
|
|
Packit |
09aa44 |
.TP 8
|
|
Packit |
09aa44 |
\fB-h\fR
|
|
Packit |
09aa44 |
Print a help message.
|
|
Packit |
09aa44 |
|
|
Packit |
09aa44 |
.SH SEE ALSO
|
|
Packit |
09aa44 |
.BR ntpd (8),
|
|
Packit |
09aa44 |
.BR ntpq (8),
|
|
Packit |
09aa44 |
.BR chronyd (8),
|
|
Packit |
09aa44 |
.BR chronyc (1)
|