summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLoy <LoyVanBeek@users.noreply.github.com>2020-01-02 08:33:20 +0100
committerAram Drevekenin <aram@poor.dev>2020-01-02 08:33:20 +0100
commit43618d32aaf8058f46db7c2cac8cc771e3368ce1 (patch)
treee91b478cf7d1e1d7f2d56b5dba1deac4fc214f6f /README.md
parent9d93d34d5ab365ec1c07d6ec197cb12c4b8105f3 (diff)
Extend installation steps with sudo-able paths (#42)
* Extend installation steps with sudo-able paths Fixes https://github.com/imsnif/what/issues/30 * Change name to 'bandwhich' * Add setcap option for installation * Fix typo and make path uniform with other options Co-Authored-By: Oleksii Filonenko <brightone@protonmail.com> * docs(readme): rework sections Co-authored-by: Oleksii Filonenko <brightone@protonmail.com> Co-authored-by: Aram Drevekenin <aram@poor.dev>
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index b14256f..3a3901f 100644
--- a/README.md
+++ b/README.md
@@ -21,9 +21,18 @@ yay -S bandwhich
cargo install bandwhich
```
+This installs `bandwhich` to `~/.cargo/bin/bandwhich` but you need root priviliges to run `bandwhich`. To fix that, there are a few options:
+- Give the executable elevated permissions: `sudo setcap cap_net_raw,cap_net_admin=+ep ~/.cargo/bin/bandwhich`
+- Run `sudo ~/.cargo/bin/bandwhich` instead of just `bandwhich`
+- Create a symlink: `sudo ln -s ~/.cargo/bin/bandwhich /usr/local/bin/` (or another path on root's PATH)
+- Set root's PATH to match your own `sudo env "PATH=$PATH" bandwhich`
+- Pass the desired target directory to cargo: `sudo cargo install bandwhich --root /usr/local/bin/`
+
+#### Download a prebuilt binary
If you're on linux, you could also get the generic binary from the releases.
-Windows is not supported at the moment - if you'd like to contribute a windows port, it would be very much welcome.
+#### Windows
+Unfortunately, windows is not supported at the moment - if you'd like to contribute a windows port, it would be very much welcome.
### Usage
```