-
-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
210 additions
and
286 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
<!-- --- | ||
title: NTP-CTL(8) ntpd-rs 1.1.2 | ntpd-rs | ||
title: NTP-CTL(8) ntpd-rs 1.1.3 | ntpd-rs | ||
--- --> | ||
|
||
# NAME | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
<!-- --- | ||
title: NTP.TOML(5) ntpd-rs 1.1.2 | ntpd-rs | ||
title: NTP.TOML(5) ntpd-rs 1.1.3 | ntpd-rs | ||
--- --> | ||
|
||
# NAME | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,74 +1,56 @@ | ||
.\" Automatically generated by Pandoc 3.1.1 | ||
.\" Automatically generated by Pandoc 3.1.13 | ||
.\" | ||
.\" 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.1.2" "ntpd-rs" | ||
.hy | ||
.TH "NTP\-CTL" "8" "" "ntpd\-rs 1.1.3" "ntpd\-rs" | ||
.SH NAME | ||
.PP | ||
\f[V]ntp-ctl\f[R] - management client for the ntpd-rs ntp-daemon process | ||
\f[CR]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]] | ||
\f[CR]ntp\-ctl\f[R] validate [\f[CR]\-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]] | ||
\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[V]ntp-ctl\f[R] \f[V]-h\f[R] | ||
\f[CR]ntp\-ctl\f[R] \f[CR]\-h\f[R] | ||
.PD 0 | ||
.P | ||
.PD | ||
\f[V]ntp-ctl\f[R] \f[V]-v\f[R] | ||
\f[CR]ntp\-ctl\f[R] \f[CR]\-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. | ||
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[V]-c\f[R] \f[I]path\f[R], \f[V]--config\f[R]=\f[I]path\f[R] | ||
\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[V]/etc/ntpd-rs/ntp.toml\f[R]. | ||
If not specified this defaults to \f[CR]/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] | ||
\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[V]-h\f[R], \f[V]--help\f[R] | ||
\f[CR]\-h\f[R], \f[CR]\-\-help\f[R] | ||
Display usage instructions. | ||
.TP | ||
\f[V]-v\f[R], \f[V]--version\f[R] | ||
\f[CR]\-v\f[R], \f[CR]\-\-version\f[R] | ||
Display version information. | ||
.SH COMMANDS | ||
.TP | ||
\f[V]validate\f[R] | ||
\f[CR]validate\f[R] | ||
Checks if the configuration specified (or | ||
\f[V]/etc/ntpd-rs/ntp.toml\f[R] by default) is valid. | ||
\f[CR]/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 | ||
\f[CR]status\f[R] | ||
Returns status information about the current state of the ntp\-daemon | ||
that the client connects to. | ||
.SH SEE ALSO | ||
.PP | ||
ntp-daemon(8), ntp-metrics-exporter(8), ntp.toml(5) | ||
ntp\-daemon(8), ntp\-metrics\-exporter(8), ntp.toml(5) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,68 +1,49 @@ | ||
.\" Automatically generated by Pandoc 3.1.1 | ||
.\" Automatically generated by Pandoc 3.1.13 | ||
.\" | ||
.\" 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-DAEMON" "8" "" "ntpd-rs 1.1.2" "ntpd-rs" | ||
.hy | ||
.TH "NTP\-DAEMON" "8" "" "ntpd\-rs 1.1.3" "ntpd\-rs" | ||
.SH NAME | ||
.PP | ||
\f[V]ntp-daemon\f[R] - ntpd-rs Network Time Protocol service daemon | ||
\f[CR]ntp\-daemon\f[R] \- ntpd\-rs Network Time Protocol service daemon | ||
.SH SYNOPSIS | ||
.PP | ||
\f[V]ntp-daemon\f[R] [\f[V]-c\f[R] \f[I]path\f[R]] [\f[V]-l\f[R] | ||
\f[CR]ntp\-daemon\f[R] [\f[CR]\-c\f[R] \f[I]path\f[R]] [\f[CR]\-l\f[R] | ||
\f[I]loglevel\f[R]] | ||
.PD 0 | ||
.P | ||
.PD | ||
\f[V]ntp-daemon\f[R] \f[V]-h\f[R] | ||
\f[CR]ntp\-daemon\f[R] \f[CR]\-h\f[R] | ||
.PD 0 | ||
.P | ||
.PD | ||
\f[V]ntp-daemon\f[R] \f[V]-v\f[R] | ||
\f[CR]ntp\-daemon\f[R] \f[CR]\-v\f[R] | ||
.SH DESCRIPTION | ||
.PP | ||
\f[V]ntp-daemon\f[R] is the Network Time Protocol (NTP) service daemon | ||
for ntpd-rs, an NTP implementation with a focus on security and | ||
\f[CR]ntp\-daemon\f[R] is the Network Time Protocol (NTP) service daemon | ||
for ntpd\-rs, an NTP implementation with a focus on security and | ||
stability. | ||
The \f[V]ntp-deamon\f[R] can be configured as both an NTP client and an | ||
NTP server. | ||
The \f[CR]ntp\-deamon\f[R] can be configured as both an NTP client and | ||
an NTP server. | ||
The daemon also works with the Network Time Security (NTS) protocol. | ||
Details of the configuration of the daemon and implementation details | ||
can be found in ntp.toml(5), where several concepts of the ntp-daemon | ||
can be found in ntp.toml(5), where several concepts of the ntp\-daemon | ||
are also explained. | ||
.SH OPTIONS | ||
.TP | ||
\f[V]-c\f[R] \f[I]path\f[R], \f[V]--config\f[R]=\f[I]path\f[R] | ||
The configuration file path for the ntp-daemon where settings for the | ||
configuration of ntpd-rs are stored. | ||
\f[CR]\-c\f[R] \f[I]path\f[R], \f[CR]\-\-config\f[R]=\f[I]path\f[R] | ||
The configuration file path for the ntp\-daemon where settings for the | ||
configuration of ntpd\-rs are stored. | ||
If not specified the default configuration file is | ||
\f[V]/etc/ntpd-rs/ntp.toml\f[R]. | ||
\f[CR]/etc/ntpd\-rs/ntp.toml\f[R]. | ||
.TP | ||
\f[V]-h\f[R], \f[V]--help\f[R] | ||
\f[CR]\-h\f[R], \f[CR]\-\-help\f[R] | ||
Display usage instructions. | ||
.TP | ||
\f[V]-l\f[R] \f[I]loglevel\f[R], \f[V]--log-level\f[R]=\f[I]loglevel\f[R] | ||
\f[CR]\-l\f[R] \f[I]loglevel\f[R], \f[CR]\-\-log\-level\f[R]=\f[I]loglevel\f[R] | ||
Change which log messages are logged to stdout. | ||
Available log levels are \f[I]trace\f[R], \f[I]debug\f[R], | ||
\f[I]info\f[R], \f[I]warn\f[R] and \f[I]error\f[R] (from lower to higher | ||
priority). | ||
Only messages with the given priority and higher will be displayed. | ||
The default log level is \f[I]info\f[R]. | ||
.TP | ||
\f[V]-v\f[R], \f[V]--version\f[R] | ||
\f[CR]\-v\f[R], \f[CR]\-\-version\f[R] | ||
Display version information. | ||
.SH SEE ALSO | ||
.PP | ||
ntp-ctl(8), ntp-metrics-exporter(8), ntp.toml(5) | ||
ntp\-ctl(8), ntp\-metrics\-exporter(8), ntp.toml(5) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,52 +1,33 @@ | ||
.\" Automatically generated by Pandoc 3.1.1 | ||
.\" Automatically generated by Pandoc 3.1.13 | ||
.\" | ||
.\" 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-METRICS-EXPORTER" "8" "" "ntpd-rs 1.1.2" "ntpd-rs" | ||
.hy | ||
.TH "NTP\-METRICS\-EXPORTER" "8" "" "ntpd\-rs 1.1.3" "ntpd\-rs" | ||
.SH NAME | ||
.PP | ||
\f[V]ntp-metrics-exporter\f[R] - Prometheus/OpenMetrics exporter for the | ||
ntpd-rs daemon | ||
\f[CR]ntp\-metrics\-exporter\f[R] \- Prometheus/OpenMetrics exporter for | ||
the ntpd\-rs daemon | ||
.SH SYNOPSIS | ||
.PP | ||
\f[V]ntp-metrics-exporter\f[R] [\f[V]-c\f[R] \f[I]path\f[R]] | ||
\f[CR]ntp\-metrics\-exporter\f[R] [\f[CR]\-c\f[R] \f[I]path\f[R]] | ||
.PD 0 | ||
.P | ||
.PD | ||
\f[V]ntp-metrics-exporter\f[R] \f[V]-h\f[R] | ||
\f[CR]ntp\-metrics\-exporter\f[R] \f[CR]\-h\f[R] | ||
.PD 0 | ||
.P | ||
.PD | ||
\f[V]ntp-metrics-exporter\f[R] \f[V]-v\f[R] | ||
\f[CR]ntp\-metrics\-exporter\f[R] \f[CR]\-v\f[R] | ||
.SH DESCRIPTION | ||
.PP | ||
Exports the status metrics from the ntpd-rs daemon as | ||
Exports the status metrics from the ntpd\-rs daemon as | ||
Prometheus/OpenMetrics via an HTTP socket. | ||
.SH OPTIONS | ||
.TP | ||
\f[V]-c\f[R] \f[I]path\f[R], \f[V]--config\f[R]=\f[I]path\f[R] | ||
\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 where the observation socket path for | ||
connecting with the ntp-daemon is specified. | ||
This defaults to \f[V]/etc/ntpd-rs/ntp.toml\f[R] if not specified. | ||
connecting with the ntp\-daemon is specified. | ||
This defaults to \f[CR]/etc/ntpd\-rs/ntp.toml\f[R] if not specified. | ||
.TP | ||
\f[V]-h\f[R], \f[V]--help\f[R] | ||
\f[CR]\-h\f[R], \f[CR]\-\-help\f[R] | ||
Display usage instructions. | ||
.TP | ||
\f[V]-v\f[R], \f[V]--version\f[R] | ||
\f[CR]\-v\f[R], \f[CR]\-\-version\f[R] | ||
Display version information. | ||
.SH SEE ALSO | ||
.PP | ||
ntp-daemon(8), ntp-ctl(8), ntp.toml(5) | ||
ntp\-daemon(8), ntp\-ctl(8), ntp.toml(5) |
Oops, something went wrong.