NAME

sitemapper - script for generating site maps

SYNOPSIS

    sitemapper 
        [ -verbose ] 
        [ -help ] 
        [ -doc ] 
        [ -depth <depth> ] 
        [ -proxy <proxy URL> ] 
        [ -[no]envproxy ] 
        [ -authen ] 
        [ -format <html|text|js|xml> ] 
        [ -summary <no. chars> ] 
        [ -title <page title> ] 
        [ -email <your e-mail address> ]
        -url <root URL> 

DESCRIPTION

sitemapper generates site maps for a given site. It traverses a site from the root URL given as the "-site" in OPTIONS option and generates an HTML page consisting of a bulleted list which reflects the structure of the site.

The structure reflects the distance from the home page of the pages listed; i.e. the first level bullets are pages accessible directly from the home page, the next level, pages accessible from those pages, etc. Obviously, pages that are linked from "higher" up pages may appear in the "wrong place" in the tree, than they "belong".

The "-format" in OPTIONS option can be used to specify alternative options for formating the site map. Currently the options are html (as described above - the default), js, which uses Jef Pearlman's (jef@mit.edu) Javascript Tree class to display the site map as a collapsable tree, and text (plain text).

OPTIONS

-depth

Option to specify the depth of the site map generated. If no specified, generates a sitemap of unlimited depth.

-email

Option to specify the e-mail address which is reported by the robot to the site it gets pages from.

-url

Option to specify a root URL to generate a site map for.

-proxy

Specify an HTTP proxy to use.

-envproxy

If -envproxy is set, the proxy specified by the $http_proxy environment variable will be used (this is the default behaviour). Use -noenvproxy to suppress this. -proxy takes precedence over -envproxy.

-format

Option for specifying the for the site map. Possible values are:

html

Plain old HTML bulleted list.

js

A collapsable DHTML tree, generated using Jef Pearlman's (jef@mit.edu) Javascript Tree class.

text

Plain text.

xml

An XML graph of linkage between pages.

-summary <no. chars>

Automatically extract a summary to display with the title. This will be truncated at the specified number of characters.

-title

Option to specify a page title for the site map.

-authen

Option to use LWP::AuthenAgent to get HTML pages. This allows the user to type username / password for pages that are access controlled.

-help

Display a short help message to standard output, with a brief description of purpose, and supported command-line switches.

-doc

Display the full documentation for the script, generated from the embedded pod format doc.

-version

Print out the current version number.

-verbose

Turn on verbose error messages.

ENVIRONMENT

sitemapper makes use of the $http_proxy environment variable, if it is set.

SEE ALSO

Date::Format (Date::Format) HTML::Entities (HTML::Entities) Getopt::Long (Getopt::Long) IO::File (IO::File) LWP::AuthenAgent (LWP::AuthenAgent) LWP::UserAgent (LWP::UserAgent) Pod::Usage (Pod::Usage) URI::URL (URI::URL) WWW::Sitemap (WWW::Robot) Jef Pearlman's Javascript Tree class (http://developer.netscape.com/docs/examples/dynhtml/tree.html)

BUGS

The Javascript sitemap has only been tested on Netscape 4.05.

AUTHOR

Ave Wrigley <wrigley@cre.canon.co.uk> Web Group, Canon Research Centre Europe

COPYRIGHT

Copyright (c) 1998 Canon Research Centre Europe. All rights reserved.

This script is free software; you can redistribute it and/or modify it under the same terms as Perl itself.