'\" t
.\" Automatically generated by Pandoc 3.1.11.1
.\"
.TH "NETR" "1" "07 Dec 2020" "net user manual" ""
.SH NAME
netr \- a simple tool to display network throughput
.SH SYNOPSIS
.IP
.EX
netr
.EE
.SH DESCRIPTION
netr shows a list of network interfaces and their throughput per second
and minute.
.PP
Input (I) and output (O) are separated in the graph.
.PP
Exit by killing the process with ctrl\-c.
.SH INTERFACE MATCHING
Interface names can be provided as regex matches to \f[B]include\f[R] or
\f[B]exclude\f[R] for reporting.
.SH COUNTERS
For use with programs such as MRTG the interface counters can be
printed, using the regex inclusion filter:
.IP
.EX
netr \-\-counters \-\-include eth0
.EE
.PP
If you have multiple interfaces where numbering/naming may be overly
inclusive then the names can use regex anchors:
.IP
.EX
netr \-\-counters \-\-include \[ha]eth0$
.EE
.PP
The script \f[CR]mrtg_cfg.pl\f[R] can be used to generate basic MRTG
config and index files:
.IP
.EX
perl mrtg_cfg.pl www \[ha]eth0$ > mrtg.cfg
mrtg mrtg.cfg
.EE
.SH OUTPUT FORMAT
The follow strings are supported with \f[CR]\-\-format\f[R]:
.PP
.TS
tab(@);
l l.
T{
placeholder
T}@T{
effect
T}
_
T{
%{if}
T}@T{
Interface name, eg `enp1s0'
T}
T{
%{ibytes}
T}@T{
Interface input bytes
T}
T{
%{obytes}
T}@T{
Interface output bytes
T}
T{
%{ipackets}
T}@T{
Interface input packets
T}
T{
%{opackets}
T}@T{
Interface output packets
T}
T{
\[rs]\f[CR]n\f[R]
T}@T{
line feed
T}
T{
\[rs]\f[CR]r\f[R]
T}@T{
carriage return
T}
T{
\[rs]\f[CR]t\f[R]
T}@T{
tab
T}
.TE
.PP
Usage of a format string will simply output and exit.
.SH CONTRIBUTIONS
I welcome pull requests with open arms.
.SH AUTHORS
Ed Neville (ed\-netr\[at]s5h.net).