Generate man pages and add new one to deployment

Author: tdittr

docs/precompiled/man/statime-metrics-exporter.8

@@ -0,0 +1,31 @@
+.\" Automatically generated by Pandoc 3.6.2
+.\"
+.TH "STATIME\-METRICS\-EXPORTER" "8" "" "statime 0.2.2" "statime"
+.SH NAME
+\f[CR]statime\-metrics\-exporter\f[R] \- Prometheus/OpenMetrics exporter
+for the Statime PTP daemon
+.SH SYNOPSIS
+\f[CR]statime\-metrics\-exporter\f[R] [\f[CR]\-c\f[R] \f[I]path\f[R]]
+.PD 0
+.P
+.PD
+\f[CR]statime\-metrics\-exporter\f[R] \f[CR]\-h\f[R]
+.PD 0
+.P
+.PD
+\f[CR]statime\-metrics\-exporter\f[R] \f[CR]\-V\f[R]
+.SH DESCRIPTION
+\&...
+.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 for the statime daemon.
+If not specified this defaults to \f[CR]/etc/statime/statime.toml\f[R].
+.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 SEE ALSO
+statime(8), statime.toml(5)

docs/precompiled/man/statime.8

@@ -1,4 +1,4 @@
-.\" Automatically generated by Pandoc 3.4
+.\" Automatically generated by Pandoc 3.6.2
 .\"
 .TH "STATIME" "8" "" "statime 0.2.2" "statime"
 .SH NAME
@@ -26,3 +26,5 @@ Display usage instructions.
 .TP
 \f[CR]\-V\f[R], \f[CR]\-\-version\f[R]
 Display version information.
+.SH SEE ALSO
+statime\-metrics\-exporter(8), statime.toml(5)

docs/precompiled/man/statime.toml.5

@@ -1,4 +1,4 @@
-.\" Automatically generated by Pandoc 3.4
+.\" Automatically generated by Pandoc 3.6.2
 .\"
 .TH "STATIME.TOML" "5" "" "statime 0.2.2" "statime"
 .SH NAME
@@ -115,3 +115,24 @@ The default is to accept all clock identities.
 Set a different minor ptp version.
 Should be either 1 or 0, intended to work around misbehaving ptp 2.0
 hardware
+.SS \f[CR][observability]\f[R]
+.TP
+\f[CR]observation\-path\f[R] = \f[I]path\f[R] (\f[B]unset\f[R])
+Path where the daemon will create an observation Unix domain socket.
+This socket is used by \f[CR]statime\-metrics\-exporter\f[R] to read the
+current status of the daemon.
+If not set (the default) no observation socket will be created, and it
+is not possible to use \f[CR]statime\-metrics\-exporter\f[R] to observe
+the daemon.
+.TP
+\f[CR]observation\-permissions\f[R] = \f[I]mode\f[R] (\f[B]0o666\f[R])
+The file system permissions with which the observation socket should be
+created.
+Warning: You should always write this number with the octal prefix
+\f[CR]0o\f[R], otherwise your permissions might be interpreted wrongly.
+The default should be OK for most applications.
+.TP
+\f[CR]metrics\-exporter\-listen\f[R] = \f[I]socketaddr\f[R] (\f[B]127.0.0.1:9975\f[R])
+The listen address that is used for the statime\-metrics\-exporter(8).
+.SH SEE ALSO
+statime(8), statime\-metrics\-exporter(8)

statime-linux/Cargo.toml

@@ -55,6 +55,7 @@ assets = [
   ["target/release/statime", "/usr/bin/statime", "755"],
   ["target/release/statime-metrics-exporter", "/usr/bin/statime-metrics-exporter", "755"],
   ["docs/precompiled/man/statime.8", "/usr/share/man/man8/statime.8", "644"],
+  ["docs/precompiled/man/statime-metrics-exporter.8", "/usr/share/man/man8/statime-metrics-exporter.8", "644"],
   ["docs/precompiled/man/statime.toml.5", "/usr/share/man/man5/statime.toml.5", "644"],
   ["docs/examples/conf/statime.toml.default", "/usr/share/doc/statime/statime.toml.default", "644"],
   ["docs/examples/conf/statime.toml.default", "/etc/statime/statime.toml", "644"],
@@ -81,6 +82,7 @@ assets = [
   { source = "target/release/statime", dest = "/usr/bin/statime", mode = "755" },
   { source = "target/release/statime-metrics-exporter", dest = "/usr/bin/statime-metrics-exporter", mode = "755" },
   { source = "docs/precompiled/man/statime.8", dest = "/usr/share/man/man8/statime.8", mode = "644", doc = true },
+  { source = "docs/precompiled/man/statime-metrics-exporter.8", dest = "/usr/share/man/man8/statime-metrics-exporter.8", mode = "644", doc = true },
   { source = "docs/precompiled/man/statime.toml.5", dest = "/usr/share/man/man5/statime-toml.5", mode = "644", doc = true },
   { source = "docs/examples/conf/statime.toml.default", dest = "/usr/share/doc/statime/statime.toml.default", mode = "644", doc = true },
   { source = "docs/examples/conf/statime.toml.default", dest = "/etc/statime/statime.toml", mode = "644", config = true },

utils/generate-man.sh

@@ -4,7 +4,7 @@ set -eo pipefail
 
 docs_dir="docs/man"
 output_dir="${1:-"docs/precompiled/man"}"
-files=("statime.8" "statime.toml.5")
+files=("statime.8" "statime-metrics-exporter.8" "statime.toml.5")
 
 mkdir -p "$output_dir"