Skip to main content

Crate argument_mangen

Crate argument_mangen 

Source
Expand description

Man page generation for argument based command line interfaces.

This renders a man page in roff format from a Cli description. Subcommands get their own pages (eg: cargo-install.1).

use argument::{Cli, Opt};
use argument_mangen::Man;

#[derive(Copy, Clone)]
enum Arg {
    Verbose,
}

static CLI: Cli<Arg> = Cli::new("demo")
    .version("1.0")
    .about("A demo tool")
    .opts(&[Opt::new(Arg::Verbose).short('v').long("verbose").help("Be verbose")]);

let page = Man::new(&CLI).render();
assert!(page.contains(".SH NAME\ndemo \\- A demo tool"));

Structsยง

Man
A man page for a command.