cli: Use clap-mangen to generate man pages

Author: felinira

Cargo.lock

@@ -15,6 +15,7 @@ rand = "0.8.3"
 
 # CLI specific dependencies
 magic-wormhole = { path = "..", features = ["all"] }
+clap_mangen = { version = "0.2", optional = true }
 clap = { version = "4", features = ["cargo", "derive", "help"] }
 clap_complete = "4"
 env_logger = "0.11"
@@ -31,3 +32,6 @@ arboard = { version = "3.2.0", features = [
 
 [dev-dependencies]
 trycmd = "0.15"
+
+[features]
+generate-manpage = ["dep:clap_mangen"]

cli/Cargo.toml

@@ -221,12 +221,19 @@ enum WormholeCommand {
     },
     #[command(hide = true)]
     Help,
+    /// Generate the manual pages for this project
+    #[cfg(feature = "generate-manpage")]
+    #[command(name = "generate-manpage", hide = true)]
+    GenerateManpage {
+        /// The path of the manpage
+        path: PathBuf,
+    },
 }
 
 #[derive(Debug, Parser)]
 #[command(
     version,
-    author,
+    author = "The wormhole-rs developers",
     about,
     arg_required_else_help = true,
     disable_help_subcommand = true,
@@ -245,7 +252,7 @@ struct WormholeCli {
         display_order = 100
     )]
     log: bool,
-    #[clap(subcommand)]
+    #[command(subcommand)]
     command: WormholeCommand,
 }
 
@@ -542,6 +549,19 @@ async fn main() -> eyre::Result<()> {
             println!("Use --help to get help");
             std::process::exit(2);
         },
+        #[cfg(feature = "generate-manpage")]
+        WormholeCommand::GenerateManpage { path } => {
+            println!("Generating manpage as {}", path.canonicalize()?.display());
+
+            let cmd = WormholeCli::command();
+            let man = clap_mangen::Man::new(cmd)
+                .section("1")
+                .date("Jul 2024")
+                .manual("User Commands");
+
+            let mut file = std::fs::File::create(path)?;
+            man.render(&mut file)?;
+        },
     }
 
     Ok(())

cli/src/main.rs

@@ -1,48 +1,39 @@
-.TH WORMHOLE-RS "1" "May 2024" "wormhole-rs 0.6.1" "User Commands"
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH wormhole-rs 1 "Jul 2024" "wormhole-rs 0.6.1" "User Commands"
 .SH NAME
-wormhole-rs \- manual page for wormhole-rs 0.6.1
+wormhole\-rs
+.SH SYNOPSIS
+\fBwormhole\-rs\fR [\fB\-v\fR|\fB\-\-verbose\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] <\fIsubcommands\fR>
 .SH DESCRIPTION
-wormhole\-rs 0.6.1
-.SS "USAGE:"
-.IP
-wormhole\-rs [OPTIONS] <SUBCOMMAND>
-.SS "OPTIONS:"
-.TP
-\fB\-h\fR, \fB\-\-help\fR
-Print this help message
+.SH OPTIONS
 .TP
 \fB\-v\fR, \fB\-\-verbose\fR
 Enable logging to stdout, for debugging purposes
 .TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help
+.TP
 \fB\-V\fR, \fB\-\-version\fR
-Print version information
-.SS "SUBCOMMANDS:"
+Print version
+.SH SUBCOMMANDS
 .TP
-forward
-Forward ports from one machine to another
+wormhole\-rs\-send(1)
+Send a file or a folder
 .TP
-receive
-Receive a file or a folder [aliases: rx]
+wormhole\-rs\-receive(1)
+Receive a file or a folder
 .TP
-send
-Send a file or a folder [aliases: tx]
+wormhole\-rs\-send\-many(1)
+Send a file to many recipients
 .TP
-send\-many
-Send a file to many recipients. READ HELP PAGE FIRST!
-.PP
-Run a subcommand with `\-\-help` to know how it's used.
+wormhole\-rs\-forward(1)
+Forward ports from one machine to another
+.SH EXTRA
+Run a subcommand with `\-\-help` to know how it\*(Aqs used.
 To send files, use `wormhole send <PATH>`.
 To receive files, use `wormhole receive <CODE>`.
-.SH AUTHOR
-.TP
-Matthias Geiger <[email protected]>
-.SH COPYRIGHT
-.PP
-Copyright \[co] 2024 Matthias Geiger
-.PP
-This manual page was written for the Debian system (and may be used by
-others).
-.PP
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU General Public License, Version 3 or (at your
-option) any later version published by the Free Software Foundation.
+.SH VERSION
+v0.6.1
+.SH AUTHORS
+The wormhole\-rs developers