Documentation/Manpages/ifpps.8

   1 =head1 NAME
   2
   3 ifpps - fetch and format kernel network statistics
   4
   5 =head1 SYNOPSIS
   6
   7 ifpps   -d|--dev <netdev> [-t|--interval <sec>][-p|--promisc][-c|--term]
   8         [-C|--csv][-H|--csv-tablehead][-l|--loop][-v|--version][-h|--help]
   9
  10 =head1 DESCRIPTION
  11
  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.
  15
  16 =head1 OPTIONS
  17
  18 =over
  19
  20 =item ifpps --dev eth0
  21
  22 Fetch eth0 interface statistics.
  23
  24 =item ifpps --dev eth0 --interval 60 --csv
  25
  26 Output eth0 interface statistics every minute in CSV format.
  27
  28 =back
  29
  30 =head1 OPTIONS
  31
  32 =over
  33
  34 =item -h|--help
  35
  36 Print help text and lists all options.
  37
  38 =item -v|--version
  39
  40 Print version.
  41
  42 =item -d|--dev <netdev>
  43
  44 Device to fetch statistics for i.e., eth0.
  45
  46 =item -p|--promisc
  47
  48 Put the device in promiscuous mode
  49
  50 =item -t|--interval <time>
  51
  52 Refresh time in sec (default 1 sec)
  53
  54 =item -c|--term
  55
  56 Output to terminal
  57
  58 =item -C|--csv
  59
  60 Output in CSV format.
  61 E.g. post-processing with Gnuplot et al.
  62
  63 =item -H|--csv-tablehead
  64
  65 Print CSV table head.
  66
  67 =item -l|--loop
  68
  69 Loop terminal output.
  70
  71 =back
  72
  73 =head1 AUTHOR
  74
  75 Written by Daniel Borkmann <daniel@netsniff-ng.org>
  76
  77 =head1 DOCUMENTATION
  78
  79 Documentation by Emmanuel Roullit <emmanuel@netsniff-ng.org>
  80
  81 =head1 BUGS
  82
  83 Please report bugs to <bugs@netsniff-ng.org>
  84
  85 =cut