add man pages

Author: mrshmllow

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased] - yyyy-mm-dd
 
+### Added
+
+- Manpages for `1` & `5`, including subcommands.
+
 ### Fixed
 
 - Fix a bug where key permissions where being printed in decimal format instead

Cargo.lock

@@ -23,10 +23,11 @@ thiserror = { workspace = true }
 enum-display-derive = "0.1.1"
 futures = "0.3.31"
 clap-num = "1.2.0"
-clap-markdown = "0.1.5"
 itertools = "0.14.0"
 dhat = "0.3.2"
 clap_complete = { version = "4.5.60", features = ["unstable-dynamic"] }
 owo-colors = { workspace = true }
 signal-hook-tokio = { version = "0.3.1", features = ["futures-v0_3"] }
 signal-hook = "0.3.18"
+clap-markdown = "0.1.5"
+clap_mangen = "0.2.31"

crates/cli/Cargo.toml

@@ -14,35 +14,64 @@
       agents = lib.strings.concatMapStrings (
         system: "--set WIRE_KEY_AGENT_${cleanSystem system} ${(getSystem system).packages.agent} "
       ) (import inputs.linux-systems);
+
+      options = pkgs.callPackage ../../doc/options.nix { };
+
+      cliManpage = pkgs.runCommand "cli-manpage" { } ''
+        mkdir $out
+
+        ${lib.getExe' self'.packages.wire-unwrapped-dev "wire"} apply --roff $out
+      '';
     in
     {
       packages = {
         default = self'.packages.wire;
-        wire-unwrapped = buildRustProgram {
+
+        wire-unwrapped-dev = buildRustProgram {
           name = "wire";
           pname = "wire";
           cargoExtraArgs = "-p wire";
           doCheck = true;
+          CARGO_PROFILE = "dev";
           nativeBuildInputs = [
-            pkgs.installShellFiles
             pkgs.sqlx-cli
           ];
           preBuild = ''
             export DATABASE_URL=sqlite:./db.sqlite3
             sqlx database create
             sqlx migrate run --source ./crates/core/src/cache/migrations/
           '';
+        };
+
+        wire-unwrapped = self'.packages.wire-unwrapped-dev.overrideAttrs (old: {
+          CARGO_PROFILE = "release";
+          nativeBuildInputs = old.nativeBuildInputs ++ [
+            pkgs.installShellFiles
+            pkgs.ronn
+          ];
           postInstall = ''
             installShellCompletion --cmd wire \
                 --bash <(COMPLETE=bash $out/bin/wire) \
                 --fish <(COMPLETE=fish $out/bin/wire) \
                 --zsh <(COMPLETE=zsh $out/bin/wire)
-          '';
-        };
 
-        wire-unwrapped-dev = self'.packages.wire-unwrapped.overrideAttrs {
-          CARGO_PROFILE = "dev";
-        };
+            mkdir -p $out/share/man/man1/
+            mkdir -p $out/share/man/man5/
+
+            cp ${options} wire.5
+            cp ${cliManpage}/* $out/share/man/man1/
+
+            ronn -r \
+                --manual="Module Options" \
+                --name="wire" \
+                --section="5" \
+                --date="2026-01-1" \
+                -o $out/share/man/man5/ \
+                wire.5
+
+            rm wire.5
+          '';
+        });
 
         wire-unwrapped-perf = buildRustProgram {
           name = "wire";

crates/cli/default.nix

@@ -15,6 +15,8 @@ use wire_core::hive::node::{Goal as HiveGoal, HandleUnreachable, Name, SwitchToC
 use wire_core::hive::{Hive, get_hive_location};
 
 use std::io::IsTerminal;
+#[cfg(debug_assertions)]
+use std::path::PathBuf;
 use std::{
     fmt::{self, Display, Formatter},
     sync::Arc,
@@ -58,6 +60,10 @@ pub struct Cli {
     #[cfg(debug_assertions)]
     #[arg(long, hide = true, global = true)]
     pub markdown_help: bool,
+
+    #[cfg(debug_assertions)]
+    #[arg(long, hide = true, global = true)]
+    pub roff: Option<PathBuf>,
 }
 
 #[derive(Clone, Debug)]

crates/cli/src/cli.rs

@@ -65,6 +65,12 @@ async fn main() -> Result<()> {
         return Ok(());
     }
 
+    #[cfg(debug_assertions)]
+    if let Some(path) = args.roff {
+        clap_mangen::generate_to(Cli::command(), path).unwrap();
+        return Ok(());
+    }
+
     if !check_nix_available() {
         miette::bail!("Nix is not available on this system.");
     }

crates/cli/src/main.rs

@@ -20,12 +20,11 @@ let
     };
   };
 
-  optionsMd =
-    (nixosOptionsDoc {
-      inherit (eval) options;
-    }).optionsCommonMark;
+  options = nixosOptionsDoc {
+    inherit (eval) options;
+  };
 in
 runCommand "options-doc.md" { } ''
-  cat ${optionsMd} > $out
+  cat ${options.optionsCommonMark} > $out
   sed -i -e '/\*Declared by:\*/,+1d' $out
 ''

doc/options.nix

@@ -1,7 +1,5 @@
 {
-  lib,
-  nixosOptionsDoc,
-  runCommand,
+  callPackage,
   wire-small-dev,
   nix,
   nodejs,
@@ -11,31 +9,7 @@
   ...
 }:
 let
-  eval = lib.evalModules {
-    modules = [
-      ../runtime/module/options.nix
-      {
-        options._module.args = lib.mkOption {
-          internal = true;
-        };
-      }
-    ];
-    specialArgs = {
-      name = "‹node name›";
-      nodes = { };
-    };
-  };
-
-  optionsMd =
-    (nixosOptionsDoc {
-      inherit (eval) options;
-    }).optionsCommonMark;
-
-  optionsDoc = runCommand "options-doc.md" { } ''
-    cat ${optionsMd} > $out
-    sed -i -e '/\*Declared by:\*/,+1d' $out
-  '';
-
+  optionsDoc = callPackage ./options.nix { };
   pkg = builtins.fromJSON (builtins.readFile ./package.json);
 in
 stdenv.mkDerivation (finalAttrs: {