diff options
| author | Aram Drevekenin <aram@poor.dev> | 2019-11-11 13:40:27 +0100 |
|---|---|---|
| committer | Aram Drevekenin <aram@poor.dev> | 2019-11-11 13:40:27 +0100 |
| commit | 7e0a9abcc8cfcbb816f1c8e0f9da327a41a9a673 (patch) | |
| tree | afe4866744a8869c18c198a65f9ad78594e8ea96 | |
| parent | a6a9577a6231660611fbaf204ecf6d9e491bf891 (diff) | |
docs(manpage): initial
| -rw-r--r-- | docs/what.1 | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/what.1 b/docs/what.1 new file mode 100644 index 0000000..f69159f --- /dev/null +++ b/docs/what.1 @@ -0,0 +1,20 @@ +.TH WHAT 1 +.SH WHAT +what \- display current network utilization by process, connection and remote IP/hostname +.SH SYNOPSIS +.B what +\fB\-i\fR \fIINTERFACE_NAME\fR +.SH DESCRIPTION +.B what +provides a responsive terminal dashboard for displaying bandwidth information. It sniffs a given network interface and cross references it with the /proc filesystem. +Optionally, it has a raw mode that can be used to parse and log this data. +.SH OPTIONS +.TP +.BR \-n ", " \-\-no\-resolve +Do not attempt to resolve IPs to their hostnames +.TP +.BR \-r ", " \-\-raw +Print output to STDOUT so it can be parsed or redirected. +.TP +.BR \-v ", " \-\-version +Print version and exit |