README

BGPmon-core version 0.01
========================

BGPmon-core is a collection of Perl functions that
are useful for obtaining and parsing BGPmon XML messages.

- Log.pm contains common logging functions that allow one to
  easily write log messages to syslog,  STDERR,  or a file.

- Configure.pm contains common functions that allow
  one to easily include command line options and configuration
  files.

- Fetch.pm allows one to easily access XML messages
  from a live stream,  a file,  or a web-based archive.

- Fetch modules are used by Fetch.pm to handle specific
  types of data.   For example, File.pm fetches data from a
  file.   These modules may be used directly, but the
  preferred method is to simply use Fetch.pm and it determines
  the appropriate module to use.

- Translator modules translate XML messages into other formats.
  For exmaple,  one can translate the XML into MRT or into
  ASCII pipe ("|") delimited files.

- Filter.pm allows one to easily discover if a BGP message contains
  IPv4 or IPv6 prefixes, or autonymous system number of interest.

The combination of logging, configuration, data access, data 
translation, and filtering should allow the rapid creation of clients
that make use of the BGPmon data.

INSTALLATION

To install this module type the following:

   perl Makefile.PL
   make
   make test
   make install

DEPENDENCIES

This module requires these other modules and libraries:

  Test
  POSIX
  IO::Socket
  XML::LibXML
  XML::LibXML::Simple
  WWW::Curl::Easy
  Net::IP
  Regexp::IPv6

COPYRIGHT AND LICENCE

      Copyright (c) 2012 Colorado State University

      Permission is hereby granted, free of charge, to any person
      obtaining a copy of this software and associated documentation
      files (the "Software"), to deal in the Software without
      restriction, including without limitation the rights to use,
      copy, modify, merge, publish, distribute, sublicense, and/or
      sell copies of the Software, and to permit persons to whom
      the Software is furnished to do so, subject to the following
      conditions:

      The above copyright notice and this permission notice shall be
      included in all copies or substantial portions of the Software.

      THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
      EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
      OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
      NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
      HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
      WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
      FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
      OTHER DEALINGS IN THE SOFTWARE.