mirror of
https://github.com/clap-rs/clap
synced 2024-12-13 14:22:34 +00:00
8f182067e3
`Command::_build_all` started as an internal function for `clap_complete` as a stopgap until #2911. Overtime, we've been finding more cases where this function needs to be called, so now we're going to fully embrace it until #2911 so people aren't scrared off by the hidden implementation from using it. This was inspired by #3602 Comptibility: Though this adds a deprecation which we general reserve for minor or major versions, this is enough of a corner case that I'm fine doing this in a patch release. |
||
|---|---|---|
| .. | ||
| examples | ||
| src | ||
| tests | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| README.md | ||
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.
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.