man

Generate structured man pages using roff-rs.

• Documentation
• Crates.io

Usage

extern crate man;

use man::prelude::*;

fn main() {
  let page = Manual::new("basic")
    .about("A basic example")
    .author(Author::new("Alice Person").email("alice@person.com"))
    .author(Author::new("Bob Human").email("bob@human.com"))
    .flag(Flag::new().short("-d").long("--deubg").description("Enable debug mode"))
    .flag(Flag::new().short("-v").long("--verbose").description("Enable verbose mode"))
    .option(Opt::new("output").short("-o").long("--output").description("Output file"));

  let _string = page.render();
}

Preview by running:

$ cargo run > /tmp/app.man; man /tmp/app.man

Installation

$ cargo add man

License

MIT OR Apache-2.0