Skip to content

Commit

Permalink
add README
Browse files Browse the repository at this point in the history
  • Loading branch information
maddingue committed Nov 15, 2012
1 parent fdd1704 commit 6f49c49
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 0 deletions.
2 changes: 2 additions & 0 deletions MANIFEST
@@ -1,4 +1,6 @@
MANIFEST
Makefile.PL
README
README.pod
bin/netsnmp-pcap
etc/pcap.conf
45 changes: 45 additions & 0 deletions README
@@ -0,0 +1,45 @@
NAME

netsnmp-pcap - SNMP extension which captures network traffic and reports
the number of packets captured, and the throughput


DESCRIPTION

This program is a port of bsnmpd-pcap, the pcap plugin for FreeBSD's
bsnmpd, as an AgentX for Net-SNMP, written in Perl. It allows you to
measure arbitrary network traffic, in packets or octets, using the
pcap(3) library. Multiple flows of traffic can be measured by setting
as many network monitors, with different filters.


INSTALLATION

To install this program, run the following commands:

perl Makefile.PL
make
make test
make install

SUPPORT AND DOCUMENTATION

After installing, you can find documentation for this program with the
perldoc or man commands.

perldoc netsnmp-pcap

man netsnmp-pcap


LICENSE

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 3 or later:
http://www.fsf.org/licensing/licenses/gpl.txt


AUTHOR

Sebastien Aperghis-Tramoni (sebastien@aperghis.net)

46 changes: 46 additions & 0 deletions README.pod
@@ -0,0 +1,46 @@
=head1 NAME

netsnmp-pcap - SNMP extension which captures network traffic and reports
the number of packets captured, and the throughput


=head1 DESCRIPTION

This program is a port of B<bsnmpd-pcap>, the pcap plugin for FreeBSD's
bsnmpd, as an AgentX for Net-SNMP, written in Perl. It allows you to
measure arbitrary network traffic, in packets or octets, using the pcap(3)
library. Multiple flows of traffic can be measured by setting as many
network monitors, with different filters.


=head1 INSTALLATION

To install this program, run the following commands:

perl Makefile.PL
make
make test
make install


=head1 SUPPORT AND DOCUMENTATION

After installing, you can find documentation for this program with
the perldoc or man commands.

perldoc netsnmp-pcap

man netsnmp-pcap


=head1 LICENSE

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 3 or
later: L<http://www.fsf.org/licensing/licenses/gpl.txt>


=head1 AUTHOR

Sebastien Aperghis-Tramoni (sebastien@aperghis.net)

0 comments on commit 6f49c49

Please sign in to comment.