Merge pull request #12 from jubako/man_page

Generate man page for (and from) arx tool.

Author: mgautierfr

Cargo.lock

@@ -12,6 +12,7 @@ license = "MIT"
 [workspace.dependencies]
 jbk = { git = "https://github.com/jubako/jubako.git", package = "jubako", version = "0.2.0" }
 clap = { version = "4.4.5", features = ["derive"] }
+clap_mangen = "0.2.20"
 indicatif = "0.17.7"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Cargo.toml

@@ -14,6 +14,7 @@ license.workspace = true
 arx = { path = "../libarx", version = "0.2.0", package="libarx", features=["cmd_utils"] }
 jbk.workspace = true
 clap.workspace = true
+clap_mangen.workspace = true
 indicatif.workspace = true
 env_logger = "0.10.0"
 anyhow = "1.0.75"

arx/Cargo.toml

@@ -8,7 +8,7 @@ use std::rc::Rc;
 use std::sync::Arc;
 
 /// Create an archive.
-#[derive(clap::Args, Debug)]
+#[derive(clap::Parser, Debug)]
 pub struct Options {
     /// File path of the archive to create.
     ///

arx/src/create.rs

@@ -39,7 +39,7 @@ fn dump_entry(
 }
 
 /// Print the content of an entry in the archive.
-#[derive(clap::Args, Debug)]
+#[derive(clap::Parser, Debug)]
 pub struct Options {
     /// Archive to read
     #[arg(value_parser)]

arx/src/dump.rs

@@ -6,7 +6,7 @@ use std::io::{BufRead, BufReader};
 use std::path::PathBuf;
 
 /// Extract the content of an archive
-#[derive(clap::Args, Debug)]
+#[derive(clap::Parser, Debug)]
 pub struct Options {
     /// Archive to read
     #[arg(short = 'f', long = "file")]

arx/src/extract.rs

@@ -135,7 +135,7 @@ where
 }
 
 /// List the content in an archive.
-#[derive(clap::Args, Debug)]
+#[derive(clap::Parser, Debug)]
 pub struct Options {
     /// Archive to read
     #[arg(value_parser)]

arx/src/list.rs

@@ -7,7 +7,7 @@ mod list;
 mod mount;
 
 use anyhow::Result;
-use clap::Parser;
+use clap::{CommandFactory, Parser};
 use log::error;
 use std::process::ExitCode;
 
@@ -18,8 +18,24 @@ struct Cli {
     #[arg(short, long, action=clap::ArgAction::Count, global=true)]
     verbose: u8,
 
+    #[arg(
+        long,
+        num_args= 0..=1,
+        default_missing_value = "",
+        help_heading = "Advanced",
+        value_parser([
+            "create",
+            "list",
+            "dump",
+            "extract",
+            #[cfg(not(windows))]
+            "mount"
+        ])
+    )]
+    generate_man_page: Option<String>,
+
     #[command(subcommand)]
-    command: Commands,
+    command: Option<Commands>,
 }
 
 #[derive(clap::Subcommand, Debug)]
@@ -64,13 +80,32 @@ fn run() -> Result<()> {
     let args = Cli::parse();
     configure_log(args.verbose);
 
+    if let Some(what) = args.generate_man_page {
+        let command = match what.as_str() {
+            "" => Cli::command(),
+            "create" => create::Options::command(),
+            "list" => list::Options::command(),
+            "dump" => dump::Options::command(),
+            "extract" => extract::Options::command(),
+            #[cfg(not(windows))]
+            "mount" => mount::Options::command(),
+            _ => return Ok(Cli::command().print_help()?),
+        };
+        let man = clap_mangen::Man::new(command);
+        man.render(&mut std::io::stdout())?;
+        return Ok(());
+    }
+
     match args.command {
-        Commands::Create(options) => create::create(options),
-        Commands::List(options) => Ok(list::list(options)?),
-        Commands::Dump(options) => Ok(dump::dump(options)?),
-        Commands::Extract(options) => Ok(extract::extract(options)?),
-        #[cfg(not(windows))]
-        Commands::Mount(options) => Ok(mount::mount(options)?),
+        None => Ok(Cli::command().print_help()?),
+        Some(c) => match c {
+            Commands::Create(options) => create::create(options),
+            Commands::List(options) => Ok(list::list(options)?),
+            Commands::Dump(options) => Ok(dump::dump(options)?),
+            Commands::Extract(options) => Ok(extract::extract(options)?),
+            #[cfg(not(windows))]
+            Commands::Mount(options) => Ok(mount::mount(options)?),
+        },
     }
 }
 

arx/src/main.rs

@@ -89,7 +89,7 @@ impl std::fmt::Display for StatCounter {
 }
 
 /// Mount an archive in a directory.
-#[derive(clap::Args, Debug)]
+#[derive(clap::Parser, Debug)]
 pub struct Options {
     /// Archive to read
     #[arg(value_parser)]

arx/src/mount.rs

@@ -15,5 +15,6 @@ arx = { path = "../libarx", version = "0.2.0", package="libarx", features=["cmd_
 jbk.workspace = true
 clap.workspace = true
 indicatif.workspace = true
+clap_mangen.workspace = true
 tar = "0.4.39"
 niffler = "2.5.0"

tar2arx/Cargo.toml

@@ -1,4 +1,4 @@
-use clap::Parser;
+use clap::{CommandFactory, Parser};
 
 use arx::create::Adder;
 use std::io::Read;
@@ -16,20 +16,29 @@ struct Cli {
     #[arg(value_parser)]
     tar_file: Option<String>,
 
+    #[arg(long, help_heading = "Advanced")]
+    generate_man_page: bool,
+
     /// Archive name to create
     #[arg(
         short,
         long,
         value_parser,
-        required_unless_present("list_compressions")
+        required_unless_present_any(["list_compressions", "generate_man_page"])
     )]
     outfile: Option<PathBuf>,
 
     #[command(flatten)]
     concat_mode: Option<arx::cmd_utils::ConcatMode>,
 
     /// Set compression algorithm to use
-    #[arg(short, long, value_parser=arx::cmd_utils::compression_arg_parser, required=false, default_value = "zstd")]
+    #[arg(
+        short,
+        long,
+        value_parser=arx::cmd_utils::compression_arg_parser,
+        required=false,
+        default_value = "zstd"
+    )]
     compression: jbk::creator::Compression,
 
     /// List available compression algorithms
@@ -257,6 +266,12 @@ fn main() -> jbk::Result<()> {
         return Ok(());
     }
 
+    if args.generate_man_page {
+        let man = clap_mangen::Man::new(Cli::command());
+        man.render(&mut std::io::stdout())?;
+        return Ok(());
+    }
+
     let mut input_size = None;
     let input: Box<dyn Read> = match args.tar_file {
         None => Box::new(std::io::stdin()),

tar2arx/src/main.rs

@@ -15,5 +15,6 @@ arx = { path = "../libarx", version = "0.2.0", package="libarx", features=["cmd_
 jbk.workspace = true
 clap.workspace = true
 indicatif.workspace = true
+clap_mangen.workspace = true
 zip = "0.6.6"
 flate2 = "1.0.26"