https://github.com/rust-cli/roff-rs

ROFF (man page format) generation library
https://github.com/rust-cli/roff-rs

Last synced: about 1 month ago
JSON representation

ROFF (man page format) generation library

• Host: GitHub
• URL: https://github.com/rust-cli/roff-rs
• Owner: rust-cli
• License: apache-2.0
• Created: 2018-04-18T21:10:25.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2025-05-07T12:47:09.000Z (about 2 months ago)
• Last Synced: 2025-05-08T23:05:16.471Z (about 1 month ago)
• Language: Rust
• Homepage: docs.rs/roff
• Size: 205 KB
• Stars: 63
• Watchers: 4
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# roff-rs

[![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]

![License](https://img.shields.io/crates/l/roff.svg)

[![crates.io](https://img.shields.io/crates/v/roff.svg)][Crates.io]

[Crates.io]: https://crates.io/crates/roff

[Documentation]: https://docs.rs/roff/

[Roff](http://man7.org/linux/man-pages/man7/roff.7.html) generation library.

## Examples

```rust

use roff::{bold, italic, roman, Roff};

fn main() {

    let page = Roff::new()

        .control("TH", ["CORRUPT", "1"])

        .control("SH", ["NAME"])

        .text([roman("corrupt - modify files by randomly changing bits")])

        .control("SH", ["SYNOPSIS"])

        .text([bold("corrupt"), roman(" ["), bold("-n"), roman(" "), italic("BITS"), roman("] ["),

               bold("--bits"), roman(" "), italic("BITS"), roman("] "), italic("FILE"), roman("..."),

        ])

        .control("SH", ["DESCRIPTION"])

        .text([bold("corrupt"), roman(" modifies files by toggling a randomly chosen bit.")])

        .control("SH", ["OPTIONS"])

        .control("TP", [])

        .text([bold("-n"), roman(", "), bold("--bits"), roman("="), italic("BITS")])

        .text([roman("Set the number of bits to modify. Default is one bit.")])

        .render();

    print!("{}", page);

}

```

Which outputs:

```troff

.ie \n(.g .ds Aq \(aq

.el .ds Aq '

.TH CORRUPT 1

.SH NAME

corrupt \- modify files by randomly changing bits

.SH SYNOPSIS

\fBcorrupt\fR [\fB\-n\fR \fIBITS\fR] [\fB\-\-bits\fR \fIBITS\fR] \fIFILE\fR...

.SH DESCRIPTION

\fBcorrupt\fR modifies files by toggling a randomly chosen bit.

.SH OPTIONS

.TP

\fB\-n\fR, \fB\-\-bits\fR=\fIBITS\fR

Set the number of bits to modify. Default is one bit.

```

Which will be shown by the `man(1)` command as:

```txt

CORRUPT(1)                 General Commands Manual                CORRUPT(1)

NAME

       corrupt - modify files by randomly changing bits

SYNOPSIS

       corrupt [-n BITS] [--bits BITS] FILE...

DESCRIPTION

       corrupt modifies files by toggling a randomly chosen bit.

OPTIONS

       -n, --bits=BITS

              Set the number of bits to modify. Default is one bit.

                                                                  CORRUPT(1)

```

## License

Licensed under either of

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or )

* MIT license ([LICENSE-MIT](LICENSE-MIT) or )

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally

submitted for inclusion in the work by you, as defined in the Apache-2.0

license, shall be dual-licensed as above, without any additional terms or

conditions.