Permalink
Browse files

Documentation changes

  • Loading branch information...
1 parent 26e6faf commit b69bfa384f7b9152e3d621ffd74eda136ae4cb60 @apersaud committed May 24, 2011
Showing with 44 additions and 39 deletions.
  1. +1 −0 Changes
  2. +1 −1 LICENSE
  3. +13 −10 Parser.pm
  4. +20 −19 README → README.md
  5. +3 −3 tools/nmap2db.pl
  6. +3 −3 tools/nmap2sqlite.pl
  7. +3 −3 tools/scan.pl
View
@@ -4,6 +4,7 @@ Latest version: http://code.google.com/p/nmap-parser/
http://search.cpan.org/~apersaud/Nmap-Parser/
Website: http://anthonypersaud.com/
+
Changes for 1.21
- Added support for hostscript and script tags
- Changed ipv4_sort() to use a 10x faster sort method
View
@@ -1,4 +1,4 @@
-Copyright (c) <2003-2009> <Anthony G. Persaud>
+Copyright (c) <2003-2011> <Anthony G. Persaud>
MIT License
View
@@ -5,10 +5,7 @@ use XML::Twig;
use Storable qw(dclone);
use vars qw($VERSION %D);
-#$Author$
-#$LastChangedDate$
-#$Rev$
-$VERSION = 1.20;
+$VERSION = 1.21;
sub new {
@@ -1107,6 +1104,8 @@ It is implemented by parsing the xml scan data that is generated by nmap. This
will enable anyone who utilizes nmap to quickly create fast and robust security scripts
that utilize the powerful port scanning abilities of nmap.
+The latest version of this module can be found on here L<https://github.com/apersaud/Nmap-Parser/>
+
=head1 OVERVIEW
This module has an internal framework to make it easy to retrieve the desired information of a scan.
@@ -1812,12 +1811,12 @@ same hosts, and compare if any new tcp have been open since then
If you have questions about how to use the module, or any of its features, you
can post messages to the Nmap::Parser module forum on CPAN::Forum.
-L<http://www.cpanforum.com/dist/Nmap-Parser>
+L<https://github.com/apersaud/Nmap-Parser/issues>
=head2 Bug Reports and Enhancements
Please submit any bugs or feature requests to:
-L<http://code.google.com/p/nmap-parser/issues/list>
+L<https://github.com/apersaud/Nmap-Parser/issues>
B<Please make sure that you submit the xml-output file of the scan which you are having
trouble with.> This can be done by running your scan with the I<-oX filename.xml> nmap switch.
@@ -1827,14 +1826,18 @@ Please remove any important IP addresses for security reasons. It saves time in
nmap, XML::Twig
-The Nmap::Parser page can be found at: L<http://anthonypersaud.com/category/nmap-parser/> or L<http://code.google.com/p/nmap-parser/>.
+The Nmap::Parser page can be found at: L<https://github.com/apersaud/Nmap-Parser>.
It contains the latest developments on the module. The nmap security scanner
homepage can be found at: L<http://www.insecure.org/nmap/>.
-=head1 AUTHOR
+=head1 AUTHORS
+
+Anthony G Persaud L<http://anthonypersaud.com> . Please see Changes file and CONTRIBUTORS file for a list of other great contributors.
-Anthony G Persaud L<http://anthonypersaud.com> . Please see Changes file for a list of
-other contributors.
+Additional Contributors:
+ * Robin Bowes L<http://robinbowes.com>
+ * Daniel Miller L<https://github.com/bonsaiviking>
+ * See Changes file for other contributors.
=head1 COPYRIGHT
View
@@ -1,61 +1,61 @@
-Nmap/Parser
-============================
+Nmap-Parser
+=================================================================
-parse nmap scan data with perl
+Parse nmap scan data with perl
-This module implements a interface to the information contained in an nmap scan.
-It is implemented by parsing the xml scan data that is generated by nmap. This
-will enable anyone who utilizes nmap to quickly create fast and robust security scripts
-that utilize the powerful port scanning abilities of nmap.
+This module implements a interface to the information contained in an nmap scan. It is implemented by parsing the xml scan data that is generated by nmap. This will enable anyone who utilizes nmap to quickly create fast and robust security scripts that utilize the powerful port scanning abilities of nmap.
INSTALLATION
+=================================================================
-Latest version: http://code.google.com/p/nmap-parser/
-Website: http://anthonypersaud.com/
+Latest version: [https://github.com/apersaud/Nmap-Parser](https://github.com/apersaud/Nmap-Parser)
+Website: [http://anthonypersaud.com/](http://anthonypersaud.com)
MANUAL INSTALL
+=================================================================
Download the file and unpack. This is usually done by:
tar zxvf Nmap-Parser-x.xx.tar.gz
-Where x.xx is the version number. Next change into the newly created directory.
-To install this module type the following:
+Where x.xx is the version number. Next change into the newly created directory. To install this module type the following:
perl Makefile.PL
make
make test
make install
If you would like to install Nmap-Parser in a different directory (or if you do
-not have root access use 'perl Makefile.PL PREFIX=/install/path', where
-/install/path is the directory in which you want to install the module. Note
+not have root access use `perl Makefile.PL PREFIX=/install/path`, where
+`/install/path` is the directory in which you want to install the module. Note
that you should then use the "use lib '/install/path'" in your scripts.
ACTIVESTATE PERL (Perl Package Manager) - MSWin32
+=================================================================
Run this in the command prompt:
- ppm install Nmap-Parser
+ ppm install Nmap-Parser
-This should contact the ActiveState respository, download the file and install it
-automagically.
+This should contact the ActiveState respository, download the file and install it automagically.
CPAN AUTOMATIC INSTALL (If you are missing dependencies)
+=================================================================
Run this in the command prompt to install directly from CPAN (may need root priviledges):
perl -MCPAN -e 'install Nmap::Parser'
DEPENDENCIES
+=================================================================
This module requires these other modules and libraries:
- XML::Twig 3.16+
- Storable (comes with Perl 5+)
+* XML::Twig 3.16+
+* Storable (comes with Perl 5+)
In addition, you will need nmap 3.00+. You don't exactly need it, but this
@@ -65,9 +65,10 @@ not really need the executable, but the xml output that you will be parsing
FOR CHANGE INFORMATION SEE THE "CHANGES" FILE
-
+---------------------------------------
COPYRIGHT AND LICENCE
+=================================================================
Copyright (C) 2003-2008 Anthony G Persaud L<http://anthonypersaud.com>
View
@@ -364,7 +364,7 @@ =head2 Discussion Forum
=head2 Bug Reports
Please submit any bugs to:
-L<http://code.google.com/p/nmap-parser/issues/list>
+L<https://github.com/apersaud/Nmap-Parser/issues>
B<Please make sure that you submit the xml-output file of the scan which you are having
trouble.> This can be done by running your scan with the I<-oX filename.xml> nmap switch.
@@ -373,14 +373,14 @@ =head2 Bug Reports
=head2 Feature Requests
Please submit any requests to:
-L<http://code.google.com/p/nmap-parser/issues/list>
+L<https://github.com/apersaud/Nmap-Parser/issues>
=head1 SEE ALSO
L<Nmap::Parser>
-The Nmap::Parser page can be found at: L<http://anthonypersaud.com/category/nmap-parser>.
+The Nmap::Parser page can be found at: L<https://github.com/apersaud/Nmap-Parser>.
It contains the latest developments on the module. The nmap security scanner
homepage can be found at: L<http://www.insecure.org/nmap/>.
View
@@ -292,7 +292,7 @@ =head2 Discussion Forum
=head2 Bug Reports
Please submit any bugs to:
-L<http://code.google.com/p/nmap-parser/issues/list>
+L<https://github.com/apersaud/Nmap-Parser/issues>
B<Please make sure that you submit the xml-output file of the scan which you are having
trouble.> This can be done by running your scan with the I<-oX filename.xml> nmap switch.
@@ -301,14 +301,14 @@ =head2 Bug Reports
=head2 Feature Requests
Please submit any requests to:
-L<http://code.google.com/p/nmap-parser/issues/list>
+L<https://github.com/apersaud/Nmap-Parser/issues>
=head1 SEE ALSO
L<Nmap::Parser>
-The Nmap::Parser page can be found at: L<http://anthonypersaud.com/category/nmap-parser/>.
+The Nmap::Parser page can be found at: L<https://github.com/apersaud/Nmap-Parser/>.
It contains the latest developments on the module. The nmap security scanner
homepage can be found at: L<http://www.insecure.org/nmap/>.
View
@@ -270,7 +270,7 @@ =head2 Discussion Forum
=head2 Bug Reports
Please submit any bugs to:
-L<http://code.google.com/p/nmap-parser/w/list>
+L<https://github.com/apersaud/Nmap-Parser/issues>
B<Please make sure that you submit the xml-output file of the scan which you are having
trouble.> This can be done by running your scan with the I<-oX filename.xml> nmap switch.
@@ -279,13 +279,13 @@ =head2 Bug Reports
=head2 Feature Requests
Please submit any requests to:
-L<http://code.google.com/p/nmap-parser/w/list>
+L<https://github.com/apersaud/Nmap-Parser/issues>
=head1 SEE ALSO
L<Nmap::Parser>
-The Nmap::Parser page can be found at: L<http://anthonypersaud.com/category/nmap-parser/>.
+The Nmap::Parser page can be found at: L<https://github.com/apersaud/Nmap-Parser/>.
It contains the latest developments on the module. The nmap security scanner
homepage can be found at: L<http://www.insecure.org/nmap/>.

0 comments on commit b69bfa3

Please sign in to comment.