clap/clap_mangen
Ed Page 5ba41d775c docs(license): Update years/holders
Without copyright assignment, everyone owns their own copyright, so
tried to reflect that.

See #3875
2022-06-27 12:55:09 -05:00
..
examples refactor: Update app variables to cmd 2022-02-14 15:55:56 -06:00
src fix(man): show the environment info with separate paragraph (#3631) 2022-04-20 08:50:11 -05:00
tests fix: Deprecate possible_values 2022-05-25 12:57:11 -05:00
Cargo.toml chore: Release 2022-06-21 09:32:04 -05:00
CHANGELOG.md chore: Release 2022-06-21 09:32:04 -05:00
CONTRIBUTING.md fix(man): Rename crate to match style 2022-02-07 20:20:01 -06:00
LICENSE-APACHE fix(man): Rename crate to match style 2022-02-07 20:20:01 -06:00
LICENSE-MIT docs(license): Update years/holders 2022-06-27 12:55:09 -05:00
README.md chore: Release 2022-06-21 09:32:04 -05:00

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.

In your Cargo.toml:

[build-dependencies]
clap_mangen = "0.1"

In your build.rs:

fn main() -> std::io::Result<()> {
    let out_dir = std::path::PathBuf::from(std::env::var_os("OUT_DIR").ok_or_else(|| 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.