2020-07-19 23:34:56 +00:00
|
|
|
<!---
|
2021-06-06 11:59:59 +00:00
|
|
|
SPDX-FileCopyrightText: 2020-2021 Robin Krahl <robin.krahl@ireas.org>
|
2020-07-19 23:34:56 +00:00
|
|
|
SPDX-License-Identifier: MIT
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
# Installing rusty-man
|
|
|
|
|
|
2020-08-11 07:59:43 +00:00
|
|
|
## Installing a package
|
2020-07-24 11:45:23 +00:00
|
|
|
|
2020-08-11 07:59:43 +00:00
|
|
|
rusty-man packages are available for these distributions:
|
|
|
|
|
- Arch Linux: [`rusty-man`][pkg-aur] in the Arch User Repository
|
|
|
|
|
|
|
|
|
|
[pkg-aur]: https://aur.archlinux.org/packages/rusty-man/
|
2020-07-19 23:34:56 +00:00
|
|
|
|
2020-07-24 11:45:23 +00:00
|
|
|
## Installing from source
|
2020-07-19 23:34:56 +00:00
|
|
|
|
2020-08-11 07:59:43 +00:00
|
|
|
### Build Requirements
|
|
|
|
|
|
2020-10-08 08:19:21 +00:00
|
|
|
To compile rusty-man, you need Rust 1.40 or later.
|
2020-08-11 07:59:43 +00:00
|
|
|
|
|
|
|
|
### Installing from Git
|
|
|
|
|
|
2020-07-19 23:34:56 +00:00
|
|
|
1. Clone the rusty-man Git repository:
|
|
|
|
|
```
|
|
|
|
|
$ git clone https://git.sr.ht/~ireas/rusty-man && cd rusty-man
|
|
|
|
|
```
|
2020-07-24 11:45:23 +00:00
|
|
|
2. Optional: Checkout the latest release:
|
|
|
|
|
```
|
2021-06-06 12:57:37 +00:00
|
|
|
$ git checkout v0.4.2
|
2020-07-24 11:45:23 +00:00
|
|
|
```
|
|
|
|
|
3. Optional: Verify the signature of the latest commit:
|
2020-07-19 23:34:56 +00:00
|
|
|
```
|
|
|
|
|
$ curl -s "https://pgp.ireas.org/0x6D533958F070C57C.txt" | gpg --import
|
2020-08-11 07:59:43 +00:00
|
|
|
$ git verify-commit HEAD
|
2020-07-19 23:34:56 +00:00
|
|
|
```
|
2020-07-24 11:45:23 +00:00
|
|
|
4. Compile rusty-man:
|
2020-07-19 23:34:56 +00:00
|
|
|
```
|
2020-08-11 07:59:43 +00:00
|
|
|
$ cargo build --release --locked
|
2020-07-19 23:34:56 +00:00
|
|
|
```
|
2020-07-24 11:45:23 +00:00
|
|
|
5. Optional: Install the rusty-man binary:
|
2020-07-19 23:34:56 +00:00
|
|
|
```
|
|
|
|
|
$ sudo cp ./target/release/rusty-man /usr/local/bin/rusty-man
|
|
|
|
|
```
|
2020-07-24 11:45:23 +00:00
|
|
|
|
2020-08-11 07:59:43 +00:00
|
|
|
### Installing from a tarball
|
|
|
|
|
|
|
|
|
|
1. Download the tarball for the latest rusty-man release (see the [release
|
|
|
|
|
list][]) and optionally its signature:
|
|
|
|
|
```
|
2021-06-06 12:57:37 +00:00
|
|
|
$ curl -OJ "https://git.sr.ht/~ireas/rusty-man/archive/v0.4.2.tar.gz"
|
2020-08-11 07:59:43 +00:00
|
|
|
```
|
|
|
|
|
2. Optional: Download and verify the signature of the tarball:
|
|
|
|
|
```
|
2021-06-06 12:57:37 +00:00
|
|
|
$ curl -O "https://git.sr.ht/~ireas/rusty-man/refs/v0.4.2/rusty-man-v0.4.2.tar.gz.asc"
|
2020-08-11 07:59:43 +00:00
|
|
|
$ curl -s "https://pgp.ireas.org/0x6D533958F070C57C.txt" | gpg --import
|
2021-06-06 12:57:37 +00:00
|
|
|
$ gpg --verify rusty-man-v0.4.2.tar.gz.asc
|
2020-08-11 07:59:43 +00:00
|
|
|
```
|
|
|
|
|
3. Extract the tarball:
|
|
|
|
|
```
|
2021-06-06 12:57:37 +00:00
|
|
|
$ tar -xf rusty-man-v0.4.2.tar.gz
|
|
|
|
|
$ cd rusty-man-v0.4.2
|
2020-08-11 07:59:43 +00:00
|
|
|
```
|
|
|
|
|
4. Compile rusty-man:
|
|
|
|
|
```
|
|
|
|
|
$ cargo build --release --locked
|
|
|
|
|
```
|
|
|
|
|
5. Optional: Install the rusty-man binary:
|
|
|
|
|
```
|
|
|
|
|
$ sudo cp ./target/release/rusty-man /usr/local/bin/rusty-man
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
[release list]: https://git.sr.ht/~ireas/rusty-man/refs
|
|
|
|
|
|
|
|
|
|
### Installing from crates.io
|
2020-07-24 11:45:23 +00:00
|
|
|
|
|
|
|
|
```
|
2021-06-06 11:59:59 +00:00
|
|
|
cargo install rusty-man --locked
|
2020-07-24 11:45:23 +00:00
|
|
|
```
|
2021-06-06 11:59:59 +00:00
|
|
|
|
|
|
|
|
You can omit the `--locked` option to use the latest dependency versions
|
|
|
|
|
available. Note that this might cause issues if a dependency breaks semantic
|
|
|
|
|
versioning.
|
