diff --git a/README.md b/README.md index 66a0395e9..d9da80a81 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ ----------------------------------------------- - + uutils is an attempt at writing universal (as in cross-platform) CLI utilities in [Rust](http://www.rust-lang.org). @@ -145,8 +145,8 @@ $ cargo install --path . This command will install uutils into Cargo's *bin* folder (*e.g.* `$HOME/.cargo/bin`). -This does not install files necessary for shell completion. For shell completion to work, -use `GNU Make` or see `Manually install shell completions`. +This does not install files necessary for shell completion or manpages. +For manpages or shell completion to work, use `GNU Make` or see `Manually install shell completions`/`Manually install manpages`. ### GNU Make @@ -214,6 +214,20 @@ run: cargo run completion ls bash > /usr/local/share/bash-completion/completions/ls ``` +### Manually install manpages + +To generate manpages, the syntax is: +```bash +cargo run manpage +``` + +So, to install the manpage for `ls` to `/usr/local/share/man/man1/ls.1` +run: + +```bash +cargo run manpage ls > /usr/local/share/man/man1/ls.1 +``` + ## Un-installation Un-installation differs depending on how you have installed uutils. If you used