Previous Next Table of Contents

ROADS version 2 manual

Martin Hamilton, Jon Knight

v2.00, August 1998

This is the collected embedded POD documentation for version 2 of the ROADS software, automatically extracted and converted into SGML. From SGML it's then converted into a variety of other formats such as RTF and HTML. NB: There's nothing here that you couldn't get using 'perldoc' followed by the program or library name, e.g. 'perldoc bin/addsl.pl'.

1. Installation and setup

1.1 NAME
1.2 DESCRIPTION
1.3 DOCUMENTATION
1.4 SYSTEM REQUIREMENTS
1.5 DOWNLOAD
1.6 UNPACKING
1.7 HOW IT WORKS
1.8 CONFIGURING YOUR WWW SERVER
1.9 MORE ON SECURITY AND ACCESS CONTROL
1.10 SITTING COMFORTABLY ?
1.11 QUESTIONS AND ANSWERS
1.12 COMPLETING THE INSTALLATION
1.13 REGISTRATION
1.14 RESOURCE DESCRIPTION TEMPLATES
1.15 CATALOGUING DIFFERENT KINDS OF RESOURCE
1.16 WHAT THE END USER SEES
1.17 CUSTOMIZATION
1.18 RUN-TIME SETTINGS
1.19 CUSTOMISING THE USER INTERFACE
1.20 OTHER COOL STUFF
1.21 SUPPORT
1.22 UPGRADING
1.23 CHANGES
1.24 COPYRIGHT
1.25 AUTHORS

2. CGI programs for admin use

2.1 admin-cgi/admin_restrict.pl - show search restrictions for admin users
2.2 admin-cgi/admincentre.pl - filter admincentre document for presentation
2.3 admin-cgi/bogus.pl - WWW front end to installation bogosity checker
2.4 admin-cgi/countattr.pl - WWW front end to template statistics gatherer
2.5 admin-cgi/deindex.pl - WWW front end to ROADS template deindexing
2.6 admin-cgi/dodgy.pl - WWW front end to link checker report on
2.7 admin-cgi/dumpdbm.pl - dump out DB(M) database entries and keys
2.8 admin-cgi/dup_urls.pl - WWW front end to IAFA template checker
2.9 admin-cgi/expansions.pl - render list of query expansions into HTML
2.10 admin-cgi/exterminate.pl - Zapping of persistently stale templates
2.11 admin-cgi/freq.pl - WWW front end to term frequency counter
2.12 admin-cgi/iafa_lint.pl - WWW front end to IAFA template checker
2.13 admin-cgi/info.pl - WWW front end to installation info generator
2.14 admin-cgi/lc.pl - WWW front end to the link checker tool
2.15 admin-cgi/lookupcluster.pl - search WHOIS++ servers for template clusters
2.16 admin-cgi/mkinv.pl - WWW front end to index generator
2.17 admin-cgi/mktemp-config-editor.pl - ROADS template editor configurator
2.18 admin-cgi/mktemp.pl - WWW based template editor
2.19 admin-cgi/register.pl - WWW front end to server registration
2.20 admin-cgi/report.pl - WWW front end to link checker report generator
2.21 admin-cgi/review.pl - WWW front end to review date checker
2.22 admin-cgi/search_restrict.pl - show list of search restrictions for
2.23 admin-cgi/stopattr.pl - render stopped attributes as HTML
2.24 admin-cgi/stoplist.pl - render stoplist as HTML
2.25 admin-cgi/tempuserauth.pl - WWW front end to template ACL editor
2.26 admin-cgi/wppdc.pl - WWW front end to start LUT WHOIS++ server
2.27 admin-cgi/zero2one.pl - convert ROADS v0 multiple databases to ROADS v1

3. Non-CGI Perl programs and shell scripts

3.1 bin/addsl.pl - generate HTML subject listings from ROADS templates
3.2 bin/addwn.pl - add what's new entries for specified templates
3.3 bin/bg_exterminate.pl - background reindexing to remove stale templates
3.4 bin/bg_lc.pl - background link checking run for WWW or cron
3.5 bin/bogus.pl - flag possible errors in ROADS installation
3.6 bin/countattr.pl - count the attributes used in a template
3.7 bin/cullsl.pl - cull entries from subject listings
3.8 bin/cullwn.pl - cull stale entries from what's new listings
3.9 bin/deindex.pl - remove templates from index
3.10 bin/dodgy.pl - find persistently stale templates
3.11 bin/dup_urls.pl - check for duplicate URLs in a collection of IAFA templates
3.12 bin/exterminate.pl - remove templates with persistently unreachable URLs
3.13 bin/freq.pl - term frequency counter for IAFA style templates
3.14 bin/harvest_centroid.pl - extract centroid from SOIF or Harvest Broker/Gatherer
3.15 bin/harvest_shim.pl - search gateway between WHOIS++ and Harvest Broker
3.16 bin/iafa2digger.pl - convert IAFA templates to Digger v2 input format
3.17 bin/iafa_lint.pl - perform sanity check on a collection of IAFA templates
3.18 bin/info.pl - display information about the ROADS server installation
3.19 bin/lc.pl - Perl based HTML/IAFA link checker
3.20 bin/lc2sd.pl - convert from Library-Catalog to Subject-Descriptor
3.21 bin/mail_owners.pl - send mail to people whose links have gone stale
3.22 bin/makethes.pl - create thesaurus file or another DB(M) database
3.23 bin/mkinv.pl - build ROADS database index
3.24 bin/rebuild.pl - rebuild ROADS index, subject/what's new listings
3.25 bin/report.pl - generate report based on link check results
3.26 bin/review.pl - generate template review info breakdown
3.27 bin/simplethes.pl - simple sample thesaurus plug-in
3.28 bin/snarf.pl - do a WHOIS++ search and snarf the resulting handles
3.29 bin/templateadmin.pl - template editor ACL manager
3.30 bin/wig.pl - gather indexes (centroids)
3.31 bin/wppd.pl - LUT WHOIS++ server
3.32 bin/wppdc.pl - control wppd.pl WHOIS++ server
3.33 bin/z3950_centroid.pl - extract centroid from NWI/EWI objects
3.34 bin/z3950_shim.pl - search gateway between WHOIS++ and Z39.50 server

4. End user visible CGI programs

4.1 cgi-bin/redirect.pl - CGI program to redirect client while logging access
4.2 cgi-bin/search.pl - user/admin CGI front end to ROADS search
4.3 cgi-bin/suggest.pl - suggest a resource for inclusion in the database
4.4 cgi-bin/survey.pl - dump out a questionnaire and record the results
4.5 cgi-bin/tempbyhand.pl - given a template handle, render it as HTML
4.6 cgi-bin/waylay.pl - generate a page of HTML for a given URL protocol

5. Legacy library code used by the WWW based template editor

5.1 lib/mktemp-authority.pl - Template editor authority file lookups
5.2 lib/mktemp-capture.pl - capture attributes and values from a template edit
5.3 lib/mktemp-editform.pl - return the main template editor form
5.4 lib/mktemp-forms.pl - return miscellaneous template editor HTML forms.
5.5 lib/mktemp-lookupcluster.pl - returns the template editor cluster search form
5.6 lib/mktemp-selectview.pl - return available template editor views
5.7 lib/mktemp-size.pl - work out the size of clusters and variants in a template
5.8 lib/mktemp-validedit.pl - Given a template handle, check the template exists

6. Run-time configuration settings

6.1 NAME
6.2 DESCRIPTION
6.3 DIRECTORIES
6.4 WORLD-WIDE WEB RELATED INFORMATION
6.5 INFORMATION ABOUT YOU AND YOUR MACHINE
6.6 WHOIS++ SERVER DETAILS
6.7 Locations of external programs
6.8 MISCELLANEOUS
6.9 BUILDING YOUR OWN TOOLS USING THIS FRAMEWORK

7. Perl modules used by multiple ROADS tools

7.1 ROADS::Auth - A class to check user authentication for admin tools
7.2 ROADS::CGIvars - A class to unpack and unescape CGI variables
7.3 ROADS::CIPv3 - A class to generate and process CIP centroids
7.4 ROADS::Centroid - A class to generate and process centroids
7.5 ROADS::DatabaseNames - A class to read in the list of ROADS databases
7.6 ROADS::ErrorLogging - A class to log errors and optionally bomb out
7.7 ROADS::Expand - A class to perform simple query expansions
7.8 ROADS::HTMLOut - A class to dump out HTML in various forms
7.9 ROADS::Index - A class to support searching of ROADS database indexes
7.10 ROADS::LookupRender - A class to render HTML resulting from a cluster lookup
7.11 ROADS::MeshTraversal - A class to perform centroid mesh traversal
7.12 ROADS::Override - A class to override unusual/odd URL protocol schemes
7.13 ROADS::Porter - A class to perform stemming using the Porter algorithm.
7.14 ROADS::PreferredURL - A class to extract the URL we prefer most
7.15 ROADS::Rank - A class to rank WHOIS++ search results
7.16 ROADS::ReadTemplate - A class to read in templates
7.17 ROADS::Render - A class to render HTML outlines + variable substitutions
7.18 ROADS::WPPC - A class to talk to WHOIS++ servers

Previous Next Table of Contents