diff options
author | Michael F. Schönitzer <michael@schoenitzer.de> | 2020-09-08 10:26:27 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-09-08 10:26:27 +0200 |
commit | b3ae95d7f86240012dfdcbb85d26702a0649e750 (patch) | |
tree | 98227d3096d1f7e9002be94f045ecfe019961434 | |
parent | 4ef1d7ccee1462e95a0612eec515461fb43a7087 (diff) |
docs(man): update and Improve MAN page (#182)
* Add all supported options to man page
This also fixes an error in the man page: It previously listed -v as
flag for printing the program version, this should be -V instead.
* Add more information to the man page
This enhances the description of bandwhich and adds common chapters:
"Copyright", "See also" and "Bugs".
-rw-r--r-- | docs/bandwhich.1 | 54 |
1 files changed, 49 insertions, 5 deletions
diff --git a/docs/bandwhich.1 b/docs/bandwhich.1 index c192f0f..1fa0d0e 100644 --- a/docs/bandwhich.1 +++ b/docs/bandwhich.1 @@ -3,18 +3,62 @@ bandwhich \- display current network utilization by process, connection and remote IP/hostname .SH SYNOPSIS .B bandwhich -\fB\-i\fR \fIINTERFACE_NAME\fR +[\fIFLAGS\fR] +[\fIOPTIONS\fR] .SH DESCRIPTION .B bandwhich -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 +provides a responsive terminal dashboard for displaying bandwidth information. It sniffs a given network interface and cross references it with the /proc filesystem. 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. + +It has a raw mode that can be used to parse and log this data. + +.SH FLAGS +.TP +.BR \-a ", " \-\-addresses +Show remote addresses table only +.TP +.BR \-c ", " \-\-connections +Show connections table only +.TP +.BR \-h ", " \-\-help +Prints help information .TP .BR \-n ", " \-\-no\-resolve Do not attempt to resolve IPs to their hostnames .TP +.BR \-p ", " \-\-processes +Show processes table only +.TP .BR \-r ", " \-\-raw Print output to STDOUT so it can be parsed or redirected. .TP -.BR \-v ", " \-\-version +.BR \-s ", " \-\-show-dns +Show DNS queries +.TP +.BR \-t ", " \-\-total-utilization +Show total (cumulative) usages +.TP +.BR \-V ", " \-\-version Print version and exit + +.SH OPTIONS +.TP +\fB \-i\fP, \fB\-\-interface\fP \fIinterface\fP +The network interface to listen on, eg. eth0 + +.SH COPYRIGHT +Copyright \(co 2019 Aram Drevekenin +License MIT: https://github.com/imsnif/bandwhich/blob/main/LICENSE.md +.br +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. + +.SH SEE ALSO +.BR iftop (1), +.BR lsof (1), +.BR nethogs (1), +.BR netstat (1), +.BR nload (1), +.BR ss (1), + +.SH BUGS +Please report bugs here: https://github.com/imsnif/bandwhich/issues |