Struct Page 

pub struct Page {
    pub name: &'static str,
    pub section: u8,
    pub text: &'static str,
    /* private fields */
}

One manpage.

Fields

name: &'static str

datui-config.

section: u8

text: &'static str

The committed page, as datui man prints it.

Implementations

impl Page

pub fn file_name(&self) -> String

datui-config.5: the file name, and how examples name the page.

pub fn title(&self) -> String

datui-config(5).

pub fn path(&self) -> String

Where the page is committed, from the repository’s root.

pub fn render(&self, read: Read<'_>) -> String

The page as gen_docs renders it.

pub fn roff(&self) -> String

The committed page’s text with a Windows checkout’s line endings undone.

pub fn plain(&self, width: usize) -> String

The page as plain text filled to width columns, for a system without man.

pub fn summary(&self) -> String

The NAME line’s description, as whatis and datui man --list show it.