.\" Automatically generated by Pandoc 3.1.12.1
.\"
.TH "NTP\-CTL" "8" "" "ntpd\-rs 1.5.0" "ntpd\-rs"
.SH NAME
\f[CR]ntp\-ctl\f[R] \- management client for the ntpd\-rs ntp\-daemon
process
.SH SYNOPSIS
\f[CR]ntp\-ctl\f[R] validate [\f[CR]\-c\f[R] \f[I]path\f[R]]
.PD 0
.P
.PD
\f[CR]ntp\-ctl\f[R] status [\f[CR]\-f\f[R] \f[I]format\f[R]]
[\f[CR]\-c\f[R] \f[I]path\f[R]]
.PD 0
.P
.PD
\f[CR]ntp\-ctl\f[R] force\-sync [\f[CR]\-c\f[R] \f[I]path\f[R]]
.PD 0
.P
.PD
\f[CR]ntp\-ctl\f[R] \f[CR]\-h\f[R]
.PD 0
.P
.PD
\f[CR]ntp\-ctl\f[R] \f[CR]\-v\f[R]
.SH DESCRIPTION
The \f[CR]ntp\-ctl\f[R] management client allows management of some
aspects of the ntpd\-rs daemon.
Currently the management client only allows displaying the current
status of the daemon and validating a configuration file for usage with
the daemon.
.SH OPTIONS
.TP
\f[CR]\-c\f[R] \f[I]path\f[R], \f[CR]\-\-config\f[R]=\f[I]path\f[R]
Path to the configuration file from which the observation socket address
will be retrieved.
If not specified this defaults to \f[CR]/etc/ntpd\-rs/ntp.toml\f[R].
.TP
\f[CR]\-f\f[R] \f[I]format\f[R], \f[CR]\-\-format\f[R]=\f[I]format\f[R]
The output format for the status command.
If not specified this defaults to \f[I]plain\f[R].
Alternatively the format \f[I]prometheus\f[R] is available to display
the output in an OpenMetrics/Prometheus compatible format.
.TP
\f[CR]\-h\f[R], \f[CR]\-\-help\f[R]
Display usage instructions.
.TP
\f[CR]\-v\f[R], \f[CR]\-\-version\f[R]
Display version information.
.SH COMMANDS
.TP
\f[CR]validate\f[R]
Checks if the configuration specified (or
\f[CR]/etc/ntpd\-rs/ntp.toml\f[R] by default) is valid.
.TP
\f[CR]status\f[R]
Returns status information about the current state of the ntp\-daemon
that the client connects to.
.TP
\f[CR]force\-sync\f[R]
Interactively run a single synchronization of your clock.
This command can be used to do a one\-off synchronization to the time
sources configured in your configuration file.
This command should never be used without any validation by a human
operator.
.SH SEE ALSO
ntp\-daemon(8), ntp\-metrics\-exporter(8), ntp.toml(5)