[go: up one dir, main page]

roff 0.1.0

ROFF (man page format) generation library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

extern crate roff;
extern crate duct;
#[macro_use] extern crate pretty_assertions;

fn roff_to_ascii(input: &str) -> String {
    duct::cmd("troff", &["-a", "-mman"])
        .input(input)
        .stdout_capture()
        .read()
        .unwrap()
}

#[test]
fn demo() {
    use roff::*;

    let page = Roff::new("corrupt", 1)
        .section("name", &["corrupt - modify files by randomly changing bits"])
        .section("SYNOPSIS", &[
            bold("corrupt"), " ".into(),
            "[".into(), bold("-n"), " ".into(), italic("BITS"), "]".into(),
            " ".into(),
            "[".into(), bold("--bits"), " ".into(), italic("BITS"), "]".into(),
            " ".into(),
            italic("file"), "...".into(),
        ])
        .section("description", &[
            bold("corrupt"),
            " modifies files by toggling a randomly chosen bit.".into(),
        ])
        .section("options", &[
            list(
                &[bold("-n"), ", ".into(), bold("--bits"), "=".into(), italic("BITS")],
                &[
                    "Set the number of bits to modify. ",
                    "Default is one bit.",
                ]
            ),
        ])
        ;

    // use std::io::Write;
    // let mut f = ::std::fs::File::create("./tests/demo.generated.troff").unwrap();
    // f.write_all(&page.render().as_bytes());

    assert_eq!(roff_to_ascii(include_str!("./demo.troff")), roff_to_ascii(&page.render()));
}