Struct Manual

pub struct Manual { /* private fields */ }

The main man page struct.

Implementations

impl Manual

pub fn new(name: &str) -> Self

Create a new instance.

pub fn about<S: Into<String>>(self, about: S) -> Self

Add a short description.

pub fn description<S: Into<String>>(self, description: S) -> Self

Add a long description.

pub fn author(self, author: Author) -> Self

Add an author.

pub fn env(self, env: Env) -> Self

Add an environment variable.

pub fn flag(self, flag: Flag) -> Self

Add an flag.

pub fn option(self, opt: Opt) -> Self

Add an option.

pub fn custom(self, custom_section: Section) -> Self

Add a custom section

pub fn example(self, example: Example) -> Self

Add an examples section

pub fn arg(self, arg: Arg) -> Self

Add a positional argument. The items are displayed in the order they’re pushed.

pub fn custom_synopsis_expansion<S: Into<String>>(self, expansion: S) -> Self

pub fn render(self) -> String

Render to a string.

Trait Implementations

impl Debug for Manual

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.