diff options
| author | Aram Drevekenin <aram@poor.dev> | 2019-12-30 21:41:19 +0100 |
|---|---|---|
| committer | Aram Drevekenin <aram@poor.dev> | 2019-12-30 21:41:19 +0100 |
| commit | 92f0872ec3e4dcf58a5aed1ed8e111a71e4cf273 (patch) | |
| tree | dfabcb50dc36cc871043511b961ff4300f0fc48a /README.md | |
| parent | a935397e66c96d989e7b81157ee603b0a58664d2 (diff) | |
chore(rename): what ==> bandwhich
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 10 insertions, 9 deletions
@@ -1,25 +1,26 @@ -## what -...is taking up my bandwidth?! +## bandwhich + +(formerly known as "what")  This is a CLI utility for displaying current network utilization by process, connection and remote IP/hostname ### How does it work? -`what` sniffs a given network interface and records IP packet size, cross referencing it with the `/proc` filesystem on linux or `lsof` on MacOS. It is responsive to the terminal window size, displaying less info if there is no room for it. It will also attempt to resolve ips to their host name in the background using reverse DNS on a best effort basis. +`bandwhich` sniffs a given network interface and records IP packet size, cross referencing it with the `/proc` filesystem on linux or `lsof` on MacOS. It is responsive to the terminal window size, displaying less info if there is no room for it. It will also attempt to resolve ips to their host name in the background using reverse DNS on a best effort basis. ### Installation #### Arch Linux ``` -yay -S what +yay -S bandwhich ``` #### MacOS and other Linux flavours ``` -cargo install what +cargo install bandwhich ``` If you're on linux, you could also get the generic binary from the releases. @@ -29,7 +30,7 @@ Windows is not supported at the moment - if you'd like to contribute a windows p ### Usage ``` USAGE: - what [FLAGS] [OPTIONS] + bandwhich [FLAGS] [OPTIONS] FLAGS: -h, --help Prints help information @@ -41,12 +42,12 @@ OPTIONS: -i, --interface <interface> The network interface to listen on, eg. eth0 ``` -Note that since `what` sniffs network packets, it requires root privileges - so you might want to use it with (for example) `sudo`. +Note that since `bandwhich` sniffs network packets, it requires root privileges - so you might want to use it with (for example) `sudo`. ### raw_mode -`what` also supports an easier-to-parse mode that can be piped or redirected to a file. For example, try: +`bandwhich` also supports an easier-to-parse mode that can be piped or redirected to a file. For example, try: ``` -what --raw | grep firefox +bandwhich --raw | grep firefox ``` ### Contributing Contributions of any kind are very welcome. If you'd like a new feature (or found a bug), please open an issue or a PR. |