Add man pages

Author: timoast

Cargo.toml

@@ -11,4 +11,5 @@ readme = "README.md"
 [dependencies]
 clap = { version = "4.0", features = ["derive"] }
 flate2 = "1.0"
-regex = "1.5"
+regex = "1.5"
+clap_mangen = "0.2"

README.md

@@ -36,3 +36,33 @@ cd spars; cargo install --path .
 ```
 
 Precompiled binaries are also available in the release
+
+## Man Pages
+
+The tool includes man pages (documentation) that can be generated and installed after installation:
+
+```bash
+# generate manpages
+spars generate-manpages --outdir /tmp/spars-man
+
+# install man pages (requires sudo)
+# note that this path may be different on different systems
+sudo cp /tmp/spars-man/*.1 /usr/local/share/man/man1/
+
+# on linux, update the manual page cache by running mandb
+sudo mandb
+```
+
+Once installed, you can view the documentation with:
+
+```bash
+man spars         # main command documentation
+man spars-stats   # stats subcommand
+man spars-subset  # subset subcommand
+```
+
+Alternatively, you can view the man pages directly without installation:
+
+```bash
+man /tmp/spars-man/spars.1
+```

src/main.rs

@@ -1,9 +1,10 @@
 use clap::{Parser, Subcommand, ArgGroup};
 use std::error::Error;
-
+use std::path::PathBuf;
 mod stats;
 mod subset;
 mod io_utils;
+mod man;
 
 #[derive(Parser)]
 #[command(
@@ -65,6 +66,20 @@ enum Commands {
         #[arg(long)]
         no_reindex: bool,
     },
+
+    #[command(
+        name = "generate-manpages",
+        about = "Generate man pages",
+        hide = true  // Hide from normal help output
+    )]
+    GenerateManPages {
+        #[arg(
+            short, 
+            long,
+            help = "Output directory for man pages"
+        )]
+        outdir: PathBuf,
+    },
 }
 
 fn main() -> Result<(), Box<dyn Error>> {
@@ -90,6 +105,9 @@ fn main() -> Result<(), Box<dyn Error>> {
                 no_reindex,
             )?;
         }
+        Commands::GenerateManPages { outdir } => {
+            man::generate_manpages(outdir)?;
+        },
     }
 
     Ok(())

src/man.rs

@@ -0,0 +1,25 @@
+use clap::CommandFactory;
+use clap_mangen::Man;
+use std::fs::File;
+use std::path::Path;
+use std::io::Result;
+
+use crate::Cli;
+
+pub fn generate_manpages<P: AsRef<Path>>(outdir: P) -> Result<()> {
+    let outdir = outdir.as_ref();
+    std::fs::create_dir_all(outdir)?;
+
+    // Generate man page for main command
+    let cmd = Cli::command();
+    let mut out = File::create(outdir.join("spars.1"))?;
+    Man::new(cmd.clone()).render(&mut out)?;
+
+    // Generate man pages for subcommands
+    for subcmd in cmd.get_subcommands() {
+        let mut out = File::create(outdir.join(format!("spars-{}.1", subcmd.get_name())))?;
+        Man::new(subcmd.clone()).render(&mut out)?;
+    }
+
+    Ok(())
+}