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