Skip to content

Commit c255c08

Browse files
authored
Update usage in README (#409)
* Update usage * Write changelog
1 parent 13ef09a commit c255c08

File tree

2 files changed

+19
-26
lines changed

2 files changed

+19
-26
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
3333
* CI refactor #399 - @cyqsimon
3434
* CI: Temporarily disable UI tests #406 - @cyqsimon
3535
* Update README #407 - @cyqsimon
36+
* Update usage in README #409 - @cyqsimon
3637

3738
## Removed
3839

README.md

+18-26
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ This is a CLI utility for displaying current network utilization by process, con
2222
- [2. `sudo` (or alternative)](#2-sudo-or-alternative)
2323
- [Post install (Windows)](#post-install-windows)
2424
- [Usage](#usage)
25-
- [raw\_mode](#raw_mode)
2625
- [Contributing](#contributing)
2726
- [License](#license)
2827

@@ -169,31 +168,24 @@ You might need to first install [npcap](https://npcap.com/#download) for capturi
169168
## Usage
170169

171170
```
172-
USAGE:
173-
bandwhich [FLAGS] [OPTIONS]
174-
175-
FLAGS:
176-
-a, --addresses Show remote addresses table only
177-
-c, --connections Show connections table only
178-
-h, --help Prints help information
179-
-n, --no-resolve Do not attempt to resolve IPs to their hostnames
180-
-p, --processes Show processes table only
181-
-r, --raw Machine friendlier output
182-
-s, --show-dns Show DNS queries
183-
-t, --total-utilization Show total (cumulative) usages
184-
-V, --version Prints version information
185-
186-
OPTIONS:
187-
-i, --interface <interface> The network interface to listen on, eg. eth0
188-
-d, --dns-server <dns-server> A dns server ip to use instead of the system default
189-
```
190-
191-
## raw_mode
192-
193-
`bandwhich` also supports an easier-to-parse mode that can be piped or redirected to a file. For example, try:
194-
195-
```
196-
bandwhich --raw | grep firefox
171+
Usage: bandwhich [OPTIONS]
172+
173+
Options:
174+
-i, --interface <INTERFACE> The network interface to listen on, eg. eth0
175+
-r, --raw Machine friendlier output
176+
-n, --no-resolve Do not attempt to resolve IPs to their hostnames
177+
-s, --show-dns Show DNS queries
178+
-d, --dns-server <DNS_SERVER> A dns server ip to use instead of the system default
179+
--log-to <LOG_TO> Enable debug logging to a file
180+
-v, --verbose... Increase logging verbosity
181+
-q, --quiet... Decrease logging verbosity
182+
-p, --processes Show processes table only
183+
-c, --connections Show connections table only
184+
-a, --addresses Show remote addresses table only
185+
-u, --unit-family <UNIT_FAMILY> Choose a specific family of units [default: bin-bytes] [possible values: bin-bytes, bin-bits, si-bytes, si-bits]
186+
-t, --total-utilization Show total (cumulative) usages
187+
-h, --help Print help (see more with '--help')
188+
-V, --version Print version
197189
```
198190

199191
## Contributing

0 commit comments

Comments
 (0)