From 83d5d1558e311f2c959aa4dfdfa37281eee07f1d Mon Sep 17 00:00:00 2001 From: Terts Diepraam Date: Thu, 20 Jan 2022 23:21:02 +0100 Subject: [PATCH] docs: add multi-call binary --- docs/src/SUMMARY.md | 3 +++ docs/src/index.md | 2 +- docs/src/multicall.md | 17 +++++++++++++++++ 3 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 docs/src/multicall.md diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 1364134b1..ecde924be 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -3,6 +3,9 @@ [Introduction](index.md) * [Installation](installation.md) * [Contributing](contributing.md) + +# Reference +* [Multi-call binary](multicall.md) * [Utils](utils/index.md) * [arch](utils/arch.md) * [base32](utils/base32.md) diff --git a/docs/src/index.md b/docs/src/index.md index 23cc0d9af..52490f41d 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -6,7 +6,7 @@ Linux, Windows, Mac and other platforms. The API reference for `uucore`, the library of functions shared between various utils, is hosted at at -[docs.rs](https://docs.rs/uucore/0.0.10/uucore/). +[docs.rs](https://docs.rs/uucore/0.0.12/uucore/). uutils is licensed under the [MIT License](https://github.com/uutils/coreutils/LICENSE.md). diff --git a/docs/src/multicall.md b/docs/src/multicall.md new file mode 100644 index 000000000..5d7b8b169 --- /dev/null +++ b/docs/src/multicall.md @@ -0,0 +1,17 @@ +# Multi-call binary +uutils includes a multi-call binary from which the utils can be invoked. This +reduces the binary size of the binary and can be useful for portability. + +The first argument of the multi-call binary is the util to run, after which +the regular arguments to the util can be passed. + +```shell +coreutils [util] [util options] +``` + +The `--help` flag will print a list of available utils. + +## Example +``` +coreutils ls -l +``` \ No newline at end of file