===============================================================================
== Ruby Nmap::Parser                         http://rubynmap.sourceforge.net ==
== Kris Katterjohn                                      katterjohn@gmail.com ==
===============================================================================

$Id: README 126 2009-02-08 15:32:04Z kjak $


OVERVIEW
========

This library provides a Ruby interface to Nmap's scan data.  It can run Nmap
and parse its XML output directly from the scan, parse a file containing the
XML data from a separate scan, parse a String of XML data from a scan, or parse
XML data from an object via its read() method.  This information is presented
in an easy-to-use and intuitive fashion for storage and manipulation.

Keep in mind that this is not just some Ruby port of Anthony Persaud's Perl
Nmap::Parser!  There are more classes, many different methods, and blocks are
extensively available.


REQUIREMENTS and RECOMMENDATIONS
================================

Things Required:

- Nmap (http://nmap.org) [Only required for parsescan()]

- REXML Ruby Library [In standard library with Ruby >= 1.8]

Things Recommended:

- Open3 Ruby Library [In standard library]


HELP
====

The website has detailed RDoc documentation available.  You can create a quick
set of these docs yourself by issuing the following command from the base
directory:

$ rdoc lib

A "doc" directory will be created.  Just point your browser to doc/index.html

