nSite Copyright 2000, Horsburgh.com.
Author: Steve Horsburgh, shorsburgh@horsburgh.com
Version: 1.1 (stable)


---------
Overview
---------

nSite generates site maps for a given WWW site. It walks a site from the 
root URL and generates an HTML, TEXT, or XML link page which illustrates 
the structure of the site.

The HTML site map consists of the page url, title, unique fingerprint, 
summary, and list of internal and external links. The links are 
'clickable' with the internal links in blue and the external links in 
orange.

The TEXT site map consists of the page url, title, and unique 
fingerprint.

The XML site map is a list of XML <LINK>/<URL> structures.

The structure reflects the depth from the root page to the pages listed;
i.e., the first-level bullets are pages accessible directly from the 
root page, at the next levels are pages accessible from those pages, 
etc. nSite assumes a typical, breadth-first, top-down site structure so 
pages may appear in a different order than originally intended.


------------------
Required Software
------------------

A modern Linux/Unix operating system
Perl Version 5.003 or later  (http://www.cpan.org/)


--------------------------
Installation Instructions
--------------------------

1. Unpack the distribution into a directory of choice.

   CMD: tar -zxf nsite-1.1.tar.gz
   or
   CMD: gunzip nsite-1.1.tar.gz
        tar -xf nsite-1.1.tar

   (If you are reading this, then you probably have already done so. :)

2. Change to the new subdirectory.

   CMD: cd nsite-1.1

3. Execute the setup file.

   CMD: ./setup.sh

4. Follow the instructions.

5. That's it. (see the POD information for more details)


--------------
Documentation
--------------

All documentation is in POD format inside the nsite.pl and 
nsitemap.pm files. Copies are in the docs directory in HTML
and TEXT format.

------------
Bug Reports
------------

Please send all bug reports (and solutions if you have them) to
nsitebug@horsburgh.com


-------
Testing
-------

nSite has been tested on the following platforms:
(if you have tested others, please let me know and I'll include them)

   - Redhat Linux 6.1, 6.2
   - SGI Irix 6.3, 6.4

nSite has been 'view' tested with the following browsers:
(if you have tested others, please let me know and I'll include them)

   - Windows    Internet Explorer       4.72, 5.0, 5.5
   - Windows    Netscape Navigator      4.5, 4.7
   - Macintosh  Internet Explorer       5.0
   - Macintosh  Netscape Navigator      4.5, 6.0
   - Linux      Netscape Navigator      4.72


---------
Copyright
---------
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  
02111-1307, USA.

See the file COPYING for additional information.



nSite Copyright 2000, Horsburgh.com. All Rights Reserved.
