40 releases

0.2.26 Jan 10, 2025
0.2.24 Oct 8, 2024
0.2.23 Jul 25, 2024
0.2.20 Feb 8, 2024
0.1.2 Feb 16, 2022

#210 in Command-line interface

Download history 55944/week @ 2025-01-28 59021/week @ 2025-02-04 57747/week @ 2025-02-11 54979/week @ 2025-02-18 54529/week @ 2025-02-25 55780/week @ 2025-03-04 61835/week @ 2025-03-11 61753/week @ 2025-03-18 59185/week @ 2025-03-25 67645/week @ 2025-04-01 68806/week @ 2025-04-08 61015/week @ 2025-04-15 63842/week @ 2025-04-22 65851/week @ 2025-04-29 73020/week @ 2025-05-06 66223/week @ 2025-05-13

278,795 downloads per month
Used in 309 crates (262 directly)

MIT/Apache

110KB
621 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–6MB
~27K SLoC