This patch adds a new viewer, tui, that provides an interactive
interface using cursive.  This viewer makes it possible to follow links
to other documentation items and to open external links in a web
browser.

2020-10-06 19:19:13 +02:00

2.4 KiB

Raw Blame History

Installing rusty-man

Installing a package

rusty-man packages are available for these distributions:

Arch Linux: rusty-man in the Arch User Repository

Installing from source

Build Requirements

To compile rusty-man, you need Rust 1.40 or later. The tui backend requires the ncurses library in the default search path and a C compiler.

If you don’t want to use ncurses, you can select another cursive backend by replacing this line in Cargo.toml:

cursive = "0.15.0"

with this:

cursive = { version = "0.15.0", default-features = false, feature = ["termion-backend"] }

Installing from Git

Clone the rusty-man Git repository:

$ git clone https://git.sr.ht/~ireas/rusty-man && cd rusty-man

Optional: Checkout the latest release:
```
$ git checkout v0.3.0
```

Optional: Verify the signature of the latest commit:

$ curl -s "https://pgp.ireas.org/0x6D533958F070C57C.txt" | gpg --import
$ git verify-commit HEAD

Compile rusty-man:
```
$ cargo build --release --locked
```

Optional: Install the rusty-man binary:

$ sudo cp ./target/release/rusty-man /usr/local/bin/rusty-man

Installing from a tarball

Download the tarball for the latest rusty-man release (see the release list) and optionally its signature:

$ curl "https://git.sr.ht/~ireas/rusty-man/archive/v0.3.0.tar.gz" \
      --output rusty-man-v0.3.0.tar.gz

Optional: Download and verify the signature of the tarball:

$ curl "https://git.sr.ht/~ireas/rusty-man/refs/v0.3.0/v0.3.0.tar.gz.asc" \
      --output rusty-man-v0.3.0.tar.gz.asc
$ curl -s "https://pgp.ireas.org/0x6D533958F070C57C.txt" | gpg --import
$ gpg --verify rusty-man-v0.3.0.tar.gz.asc

Extract the tarball:

$ tar -xf rusty-man-v0.3.0.tar.gz
$ cd rusty-man-v0.3.0

Compile rusty-man:
```
$ cargo build --release --locked
```