1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
.\" Automatically generated by Pandoc 3.1.1
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "NTP-CTL" "8" "" "ntpd-rs 1.7.1" "ntpd-rs"
.hy
.SH NAME
.PP
\f[V]ntp-ctl\f[R] - management client for the ntpd-rs ntp-daemon process
.SH SYNOPSIS
.PP
\f[V]ntp-ctl\f[R] validate [\f[V]-c\f[R] \f[I]path\f[R]]
.PD 0
.P
.PD
\f[V]ntp-ctl\f[R] status [\f[V]-f\f[R] \f[I]format\f[R]] [\f[V]-c\f[R]
\f[I]path\f[R]]
.PD 0
.P
.PD
\f[V]ntp-ctl\f[R] force-sync [\f[V]-c\f[R] \f[I]path\f[R]]
.PD 0
.P
.PD
\f[V]ntp-ctl\f[R] \f[V]-h\f[R]
.PD 0
.P
.PD
\f[V]ntp-ctl\f[R] \f[V]-v\f[R]
.SH DESCRIPTION
.PP
The \f[V]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[V]-c\f[R] \f[I]path\f[R], \f[V]--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[V]/etc/ntpd-rs/ntp.toml\f[R].
.TP
\f[V]-f\f[R] \f[I]format\f[R], \f[V]--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[V]-h\f[R], \f[V]--help\f[R]
Display usage instructions.
.TP
\f[V]-v\f[R], \f[V]--version\f[R]
Display version information.
.SH COMMANDS
.TP
\f[V]validate\f[R]
Checks if the configuration specified (or
\f[V]/etc/ntpd-rs/ntp.toml\f[R] by default) is valid.
.TP
\f[V]status\f[R]
Returns status information about the current state of the ntp-daemon
that the client connects to.
.TP
\f[V]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
.PP
ntp-daemon(8), ntp-metrics-exporter(8), ntp.toml(5)
|
