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

#48 in Command-line interface

Download history 19504/week @ 2023-11-21 20896/week @ 2023-11-28 22718/week @ 2023-12-05 21351/week @ 2023-12-12 19000/week @ 2023-12-19 21047/week @ 2023-12-26 24447/week @ 2024-01-02 28097/week @ 2024-01-09 26725/week @ 2024-01-16 28548/week @ 2024-01-23 31251/week @ 2024-01-30 31805/week @ 2024-02-06 29930/week @ 2024-02-13 27089/week @ 2024-02-20 27060/week @ 2024-02-27 25687/week @ 2024-03-05

114,284 downloads per month
Used in 180 crates (158 directly)

MIT/Apache

105KB
674 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.9–1.6MB
~29K SLoC