Crate roff

A document in the ROFF format.

ROFF is a family of Unix text-formatting languages, implemented by the nroff, troff, and groff programs, among others. See groff(7) for a description of the language. This structure is an abstract representation of a document in ROFF format. It is meant for writing code to generate ROFF documents, such as manual pages.

Example

let doc = Roff::new().text(vec![roman("hello, world")]).render();
assert!(doc.ends_with("hello, world\n"));

Structs

Roff

A ROFF document, consisting of lines.

Enums

Inline

A part of a text line.

Functions

bold

Return some inline text in the bold font.

italic

Return some inline text in the italic font.

line_break

Return an inline element for a hard line break.

roman

Return some inline text in the “roman” font.