34 releases

0.2.20 Feb 8, 2024
0.2.18 Jan 29, 2024
0.2.16 Dec 28, 2023
0.2.15 Oct 24, 2023
0.1.2 Feb 16, 2022

#178 in Command-line interface

Download history 30595/week @ 2024-01-29 32532/week @ 2024-02-05 30107/week @ 2024-02-12 27753/week @ 2024-02-19 27033/week @ 2024-02-26 29333/week @ 2024-03-04 28286/week @ 2024-03-11 26494/week @ 2024-03-18 30194/week @ 2024-03-25 28643/week @ 2024-04-01 28380/week @ 2024-04-08 28978/week @ 2024-04-15 27851/week @ 2024-04-22 33700/week @ 2024-04-29 27116/week @ 2024-05-06 31381/week @ 2024-05-13

123,345 downloads per month
Used in 213 crates (179 directly)

MIT/Apache

105KB
672 lines

clap_mangen

Manpage generation for clap

Crates.io Crates.io License License

Dual-licensed under Apache 2.0 or MIT.

  1. About
  2. API Reference
  3. Questions & Discussions
  4. CONTRIBUTING
  5. Sponsors

About

Generate ROFF from a clap::Command.

Example

We're going to assume you want to generate your man page as part of your development rather than your shipped program having a flag to generate it.

Run

$ cargo add --build clap_mangen

In your build.rs:

fn main() -> std::io::Result<()> {
    let out_dir = std::path::PathBuf::from(std::env::var_os("OUT_DIR").ok_or(std::io::ErrorKind::NotFound)?);

    let cmd = clap::Command::new("mybin")
        .arg(clap::arg!(-n --name <NAME>))
        .arg(clap::arg!(-c --count <NUM>));

    let man = clap_mangen::Man::new(cmd);
    let mut buffer: Vec<u8> = Default::default();
    man.render(&mut buffer)?;

    std::fs::write(out_dir.join("mybin.1"), buffer)?;

    Ok(())
}

Tip: Consider a cargo xtask instead of a build.rs to reduce build costs.

Dependencies

~0.8–1.6MB
~29K SLoC