doc: add man pages

.github/workflows/release.yml

@@ -37,6 +37,10 @@ jobs:
           profile: minimal
           toolchain: stable
           target: x86_64-unknown-linux-gnu
+      - run: |
+          mkdir -p target/man
+          cargo run --features gen-man-pages -- target/man
+          gzip -9 target/man/*.1
       - uses: taiki-e/install-action@v2
         with:
           tool: cargo-deb

Cargo.toml

@@ -15,6 +15,7 @@ strip = true
 anyhow = { version = "1.0.93", default-features = false, features = ["std", "backtrace"] }
 bincode = { version = "1.3.3", default-features = false }
 clap = { version = "4.5.21", default-features = false, features = ["std", "color", "help", "usage", "error-context", "suggestions", "derive"] }
+clap_mangen = { version = "0.2.24", default-features = false, optional = true }
 function_name = { version = "0.3.0", default-features = false }
 itertools = { version = "0.13.0", default-features = false, features = ["use_std"] }
 log = { version = "0.4.22", default-features = false, features = ["max_level_trace", "release_max_level_info"] }
@@ -39,6 +40,7 @@ pretty_assertions = { version = "1.4.1", default-features = false, features = ["
 [features]
 default = []
 as-root = [] # for tests only
+gen-man-pages = ["dep:clap_mangen"]
 nightly = [] # for benchmarks only
 
 [lints.rust]
@@ -102,3 +104,7 @@ verbose_file_reads = "warn"
 [package.metadata.deb]
 name = "shh"
 depends = "$auto, strace"
+assets = [
+  ["target/release/shh", "usr/bin/", "755"],
+  ["target/man/*.1.gz", "usr/share/man/man1/", "644"]
+]

src/main.rs

@@ -1,6 +1,10 @@
 //! Systemd Hardening Helper
 
 #![cfg_attr(all(feature = "nightly", test), feature(test))]
+#![cfg_attr(
+    feature = "gen-man-pages",
+    expect(dead_code, unused_crate_dependencies, unused_imports)
+)]
 
 use std::{
     fs::{self, File},
@@ -32,6 +36,18 @@ fn sd_options(
     sd_opts
 }
 
+#[cfg(feature = "gen-man-pages")]
+fn main() -> anyhow::Result<()> {
+    use clap::CommandFactory as _;
+    let cmd = cl::Args::command();
+    let output = std::env::args_os()
+        .nth(1)
+        .ok_or_else(|| anyhow::anyhow!("Missing output dir argument"))?;
+    clap_mangen::generate_to(cmd, output)?;
+    Ok(())
+}
+
+#[cfg(not(feature = "gen-man-pages"))]
 fn main() -> anyhow::Result<()> {
     // Init logger
     simple_logger::SimpleLogger::new()