Struct rust_utils::linux::ManpageBuilder

pub struct ManpageBuilder { /* private fields */ }

Basic unix manpage generator

Implementations

impl ManpageBuilder

pub fn name(self, name: String) -> Self

pub fn short_desc(self, short_desc: String) -> Self

pub fn desc(self, desc: String) -> Self

pub fn author_name(self, author_name: String) -> Self

pub fn author_email(self, author_email: String) -> Self

pub fn name_comment(self, name_comment: impl Into<String>) -> Self

Add in a comment next to the name in the file comment

pub fn other_pages(self, other_pages: Vec<String>) -> Self

pub fn other_sections(self, other_sections: HashMap<String, String>) -> Self

impl ManpageBuilder

pub fn new( name: &str, short_desc: &str, author_name: &str, author_email: &str, desc: &str, ) -> Self

Create a new ManpageBuilder

pub fn other_page(self, name: &str) -> Self

Add a link to a page in the “SEE ALSO” section

pub fn section(self, name: &str, text: &str) -> Self

Add in a section

The name should be in all capital letters

pub fn build<P: Into<PathBuf>>(&self, app_ver: &str, path: P)

Generate and save the manpage at the specified path