docs: moved manpages to man, remove talks from repo
[netsniff-ng.git] / man / ifpps.8
blob70cb4d795d2b6c8f3bbd5639ddc8e7b1d37df572
1 =head1 NAME
3 ifpps - fetch and format kernel network statistics
5 =head1 SYNOPSIS
7 ifpps   -d|--dev <netdev> [-t|--interval <sec>][-p|--promisc][-c|--term]
8         [-C|--csv][-H|--csv-tablehead][-l|--loop][-v|--version][-h|--help]
10 =head1 DESCRIPTION
12 A tiny tool to provide top-like reliable networking statistics.
13 ifpps reads out the 'real' kernel statistics, so it does not give erroneous
14 statistics on high I/O load.
16 =head1 OPTIONS
18 =over
20 =item ifpps --dev eth0
22 Fetch eth0 interface statistics.
24 =item ifpps --dev eth0 --interval 60 --csv
26 Output eth0 interface statistics every minute in CSV format.
28 =back
30 =head1 OPTIONS
32 =over
34 =item -h|--help
36 Print help text and lists all options.
38 =item -v|--version
40 Print version.
42 =item -d|--dev <netdev>
44 Device to fetch statistics for i.e., eth0.
46 =item -p|--promisc
48 Put the device in promiscuous mode
50 =item -t|--interval <time>
52 Refresh time in sec (default 1 sec)
54 =item -c|--term
56 Output to terminal
58 =item -C|--csv
60 Output in CSV format.
61 E.g. post-processing with Gnuplot et al.
63 =item -H|--csv-tablehead
65 Print CSV table head.
67 =item -l|--loop
69 Loop terminal output.
71 =back
73 =head1 AUTHOR
75 Written by Daniel Borkmann <daniel@netsniff-ng.org>
77 =head1 DOCUMENTATION
79 Documentation by Emmanuel Roullit <emmanuel@netsniff-ng.org>
81 =head1 BUGS
83 Please report bugs to <bugs@netsniff-ng.org>
85 =cut