Skip to main content

write_man

Function write_man 

Source
pub fn write_man(out: &mut impl Write) -> Result<(), CliError>
Expand description

Writes the roff source of acme-proxy.1.

Rendered section by section rather than through Man::render, because five of them are facts clap has no way to know: what the exit status means, a few typical invocations, the environment this binary reads, the file it looks for, and where the full documentation is. They are written as roff here rather than hung off after_long_help, which would put the same block — .TP markup and all — into --help.

One page, for the top-level command. The per-flag detail of every subcommand lives in the book’s Admin CLI chapter, which SEE ALSO names: a tree of ~50 roff files would document admin user totp reset for a binary that installs no man pages at all.