mirror of
https://github.com/RGBCube/uutils-coreutils
synced 2025-07-28 11:37:44 +00:00
docs: add installation page with package managers
This commit is contained in:
parent
28127a433e
commit
5c676ac268
5 changed files with 110 additions and 13 deletions
13
README.md
13
README.md
|
@ -43,7 +43,7 @@ uutils has both user and developer documentation available:
|
||||||
Both can also be generated locally, the instructions for that can be found in the
|
Both can also be generated locally, the instructions for that can be found in the
|
||||||
[coreutils docs](https://github.com/uutils/coreutils-docs) repository.
|
[coreutils docs](https://github.com/uutils/coreutils-docs) repository.
|
||||||
|
|
||||||
<!-- ANCHOR: installation (this mark is needed for mdbook) -->
|
<!-- ANCHOR: build (this mark is needed for mdbook) -->
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
* Rust (`cargo`, `rustc`)
|
* Rust (`cargo`, `rustc`)
|
||||||
|
@ -197,15 +197,6 @@ Installing with `make` installs shell completions for all installed utilities
|
||||||
for `bash`, `fish` and `zsh`. Completions for `elvish` and `powershell` can also
|
for `bash`, `fish` and `zsh`. Completions for `elvish` and `powershell` can also
|
||||||
be generated; See `Manually install shell completions`.
|
be generated; See `Manually install shell completions`.
|
||||||
|
|
||||||
### NixOS
|
|
||||||
|
|
||||||
The [standard package set](https://nixos.org/nixpkgs/manual/) of [NixOS](https://nixos.org/)
|
|
||||||
provides this package out of the box since 18.03:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
$ nix-env -iA nixos.uutils-coreutils
|
|
||||||
```
|
|
||||||
|
|
||||||
### Manually install shell completions
|
### Manually install shell completions
|
||||||
|
|
||||||
The `coreutils` binary can generate completions for the `bash`, `elvish`, `fish`, `powershell`
|
The `coreutils` binary can generate completions for the `bash`, `elvish`, `fish`, `powershell`
|
||||||
|
@ -263,7 +254,7 @@ To uninstall from a custom parent directory:
|
||||||
# DESTDIR is also supported
|
# DESTDIR is also supported
|
||||||
$ make PREFIX=/my/path uninstall
|
$ make PREFIX=/my/path uninstall
|
||||||
```
|
```
|
||||||
<!-- ANCHOR_END: installation (this mark is needed for mdbook) -->
|
<!-- ANCHOR_END: build (this mark is needed for mdbook) -->
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
|
|
|
@ -7,3 +7,7 @@ title = "uutils Documentation"
|
||||||
|
|
||||||
[output.html]
|
[output.html]
|
||||||
git-repository-url = "https://github.com/rust-lang/cargo/tree/master/src/doc/src"
|
git-repository-url = "https://github.com/rust-lang/cargo/tree/master/src/doc/src"
|
||||||
|
|
||||||
|
[preprocessor.toc]
|
||||||
|
command = "mdbook-toc"
|
||||||
|
renderer = ["html"]
|
3
docs/src/build.md
Normal file
3
docs/src/build.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Build from source
|
||||||
|
|
||||||
|
{{#include ../../README.md:build }}
|
|
@ -1,3 +1,101 @@
|
||||||
# Installation
|
# Installation
|
||||||
|
|
||||||
{{#include ../../README.md:installation }}
|
This is a list of uutils packages in various distributions and package managers.
|
||||||
|
Note that these are packaged by third-parties and the packages might contains
|
||||||
|
patches.
|
||||||
|
|
||||||
|
You can also [build uutils from source](/build.md).
|
||||||
|
|
||||||
|
<!-- toc -->
|
||||||
|
|
||||||
|
## Cargo
|
||||||
|
[](https://repology.org/project/uutils-coreutils/versions)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Linux
|
||||||
|
cargo install coreutils --features unix
|
||||||
|
# MacOs
|
||||||
|
cargo install coreutils --features macos
|
||||||
|
# Windows
|
||||||
|
cargo install coreutils --features windows
|
||||||
|
```
|
||||||
|
|
||||||
|
## Linux
|
||||||
|
### Alpine
|
||||||
|
|
||||||
|
[](https://pkgs.alpinelinux.org/packages?name=uutils-coreutils)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
apk update uutils-coreutils
|
||||||
|
```
|
||||||
|
|
||||||
|
> **Note**: Requires the `edge` repository.
|
||||||
|
|
||||||
|
### Arch
|
||||||
|
|
||||||
|
[](https://archlinux.org/packages/community/x86_64/uutils-coreutils/)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pacman -S uutils-coreutils
|
||||||
|
```
|
||||||
|
|
||||||
|
### Debian
|
||||||
|
|
||||||
|
[](https://packages.debian.org/sid/source/rust-coreutils)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
apt install rust-coreutils
|
||||||
|
```
|
||||||
|
|
||||||
|
> **Note**: Requires the `unstable` repository.
|
||||||
|
|
||||||
|
### Manjaro
|
||||||
|

|
||||||
|
[](https://repology.org/project/uutils-coreutils/versions)
|
||||||
|
[](https://repology.org/project/uutils-coreutils/versions)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pacman -S uutils-coreutils
|
||||||
|
# or
|
||||||
|
pamac install uutils-coreutils
|
||||||
|
```
|
||||||
|
|
||||||
|
### NixOS
|
||||||
|
[](https://repology.org/project/uutils-coreutils/versions)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
nix-env -iA nixos.uutils-coreutils
|
||||||
|
```
|
||||||
|
|
||||||
|
## MacOS
|
||||||
|
|
||||||
|
### Homebrew
|
||||||
|
[](https://formulae.brew.sh/formula/uutils-coreutils)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
brew install uutils-coreutils
|
||||||
|
```
|
||||||
|
|
||||||
|
### MacPorts
|
||||||
|
[](https://ports.macports.org/port/coreutils-uutils/)
|
||||||
|
|
||||||
|
```
|
||||||
|
port install coreutils-uutils
|
||||||
|
```
|
||||||
|
|
||||||
|
## Windows
|
||||||
|
|
||||||
|
### Scoop
|
||||||
|
[](https://scoop.sh/#/apps?q=uutils-coreutils&s=0&d=1&o=true)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
scoop install uutils-coreutils
|
||||||
|
```
|
||||||
|
|
||||||
|
## Non-standard packages
|
||||||
|
|
||||||
|
### `coreutils-hybrid` (AUR)
|
||||||
|
|
||||||
|
[](https://aur.archlinux.org/packages/coreutils-hybrid)
|
||||||
|
|
||||||
|
A GNU coreutils / uutils coreutils hybrid package. Uses stable uutils programs mixed with GNU counterparts if uutils counterpart is unfinished or buggy.
|
|
@ -41,6 +41,7 @@ fn main() -> io::Result<()> {
|
||||||
\n\
|
\n\
|
||||||
[Introduction](index.md)\n\
|
[Introduction](index.md)\n\
|
||||||
* [Installation](installation.md)\n\
|
* [Installation](installation.md)\n\
|
||||||
|
* [Build from source](build.md)\n\
|
||||||
* [Contributing](contributing.md)\n\
|
* [Contributing](contributing.md)\n\
|
||||||
* [GNU test coverage](test_coverage.md)\n\
|
* [GNU test coverage](test_coverage.md)\n\
|
||||||
\n\
|
\n\
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue