clap_mangen
| Crates.io | clap_mangen |
| lib.rs | clap_mangen |
| version | |
| source | src |
| created_at | 2022-02-08 03:24:02.211042+00 |
| updated_at | 2025-01-10 16:22:31.218879+00 |
| description | A manpage generator for clap |
| homepage | |
| repository | https://github.com/clap-rs/clap |
| max_upload_size | |
| id | 528849 |
| Cargo.toml error: | TOML parse error at line 27, column 1 | 27 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
Maintainers (github:rust-cli:maintainers)
documentation
README
clap_mangen
Manpage generation for
clap
Dual-licensed under Apache 2.0 or MIT.
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.