With this patch, we replace cursive’s default ncurses backend with the
termion backend.  This has multiple reasons:
- The ncurses backend has safety issues, see [0].
- ncurses requires a pre-installed library and a C compiler, introducing
  additional build dependencies.  Termion is implemented in Rust only.
- ncurses does not work on Windows, while termion works in all terminals
  that support ANSI escape codes.

Per default, the termion backend does not buffer the output which may
cause flickering [1].  Therefore, we also use the
cursive_buffered_backend that buffers the output and fixes the
flickering problem.

[0] https://github.com/gyscos/cursive/issues/488
[1] https://github.com/gyscos/cursive/issues/142

2020-10-08 10:30:17 +02:00

2.0 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.

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
```