tar2arx and zip2arx also generate man page.

Author: mgautierfr

Cargo.lock

@@ -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"

zip2arx/Cargo.toml

@@ -1,4 +1,4 @@
-use clap::Parser;
+use clap::{CommandFactory, Parser};
 
 use arx::create::Adder;
 use std::io::{Read, Seek};
@@ -11,23 +11,35 @@ use std::sync::Arc;
 #[command(name = "tar2arx", author, version, about, long_about=None)]
 struct Cli {
     /// Zip file to convert
-    #[arg(value_parser, required_unless_present("list_compressions"))]
+    #[arg(
+        value_parser,
+        required_unless_present_any(["list_compressions", "generate_man_page"])
+    )]
     zip_file: Option<PathBuf>,
 
+    #[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
@@ -224,6 +236,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 file = std::fs::File::open(args.zip_file.as_ref().unwrap())?;
     let archive = zip::ZipArchive::new(file).unwrap();
     let converter = Converter::new(