40 releases

new 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

#136 in Command-line interface

Download history 38810/week @ 2024-09-23 41224/week @ 2024-09-30 44521/week @ 2024-10-07 49014/week @ 2024-10-14 43424/week @ 2024-10-21 40446/week @ 2024-10-28 39985/week @ 2024-11-04 46101/week @ 2024-11-11 40617/week @ 2024-11-18 39578/week @ 2024-11-25 42205/week @ 2024-12-02 40666/week @ 2024-12-09 39046/week @ 2024-12-16 83086/week @ 2024-12-23 40622/week @ 2024-12-30 50388/week @ 2025-01-06

217,034 downloads per month
Used in 276 crates (239 directly)

MIT/Apache

115KB
687 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
~28K SLoC