MOMspider Installation Information
==================================
# $Id: INSTALL.txt,v 1.1 1994/08/10 10:14:45 fielding Exp $

See the file README.html for licensing and distribution info.
See the file MOM_Changes.pl for a complete list of changes and version history.

The latest version of MOMspider can always be found at:

       http://www.ics.uci.edu/WebSoft/MOMspider/

or by anonymous ftp from

       ftp://liege.ics.uci.edu/pub/arcadia/MOMspider/

==========================================================================
Installation instructions:

1. If you don't already have it, get and install the perl software package
   from one of its many distribution sites.  Information on Perl can be
   found at

       http://www.cis.ufl.edu/perl/
       http://web.nexor.co.uk/perl/perl.html

   Be sure to install the user and system libraries along with it.
   The following are required: timelocal.pl, getopts.pl, and sys/socket.ph.


2. If you don't already have it, get and install the libwww-perl package
   from its distribution site at

       http://www.ics.uci.edu/WebSoft/libwww-perl/
       ftp://liege.ics.uci.edu/pub/arcadia/libwww-perl/

   If you have not included the libwww-perl directory on the standard 
   include path for Perl, be sure to set the $LIBWWW_PERL environment
   variable so that client programs (like MOMspider) can find it.


3. Get the MOMspider distribution from one of the sites listed at the
   top of this document.  It will be in the form of a compressed unix
   tar file.  If it has not already been decompressed by your WWW client,
   then do one of:

        % uncompress MOMspider-V.VV.tar.Z
        % gunzip MOMspider-V.VV.tar.gz

   depending on which compressed version you downloaded.
   Note that "V.VV" is the current version number, e.g. "1.00".


4. Move the resulting MOMspider-V.VV.tar file to the directory above
   where you want to install libwww-perl, cd to that directory, and do

        % tar xvf MOMspider-V.VV.tar

   to create the directory ./MOMspider-V.VV containing the following:

   MOM_Changes.pl   -- the list of known problems and version information.
   README.html      -- primary source of information about MOMspider

   momspider        -- MOMspider main program
   momavoid.pl      -- package for managing avoid and sites files.
   momconfig.pl     -- package for setting MOMspider configuration defaults.
   momemail.pl      -- package for generating the optional e-mail message.
   momhistory.pl    -- package for storing information about tested nodes.
   momindex.pl      -- package for writing the HTML index and summary results.
   momevent.pl      -- package for receiving traversal events and notifying
                       other packages/programs.
   momvisit.pl      -- package for controlling the traversal process.
   system-avoid     -- System Avoid file for listing URLs to avoid/leaf
   system-sites     -- System Sites file for listing sites (hostname:port)
                       which have been checked for /robots.txt

   docs             -- documentation directory (what, why, and how for ...)
   docs/INSTALL.txt    -- Installation Notes
   docs/config.html    -- Configuration Options
   docs/instruct.html  -- MOMspider's Instruction Files
   docs/avoiding.html  -- Avoiding and Leafing Specific URLs
   docs/metainfo.html  -- Making Document Metainformation Visible
   docs/extending.html -- Extending MOMspider's Functionality
   docs/www94_paper.ps -- The MOMspider WWW94 paper (in PostScript)

   examples         -- a directory for example MOMspider instructions/output
   examples/.momspider-instruct    -- a user's instruction file
   examples/.momspider-avoid       -- a user's avoid file
   examples/.momspider-sites       -- a user's avoid file
   examples/short-instruct         -- a short example instruction file
   examples/short-outfile.txt      --        and the resulting program output
   examples/short-index.html       --        and the resulting HTML index
   examples/short-email.txt        --        and the resulting email message
   examples/ICS-instruct           -- a real example instruction file


5. The first line of the momspider program may need to be changed
   to point to your perl executable, e.g.:

        #!/usr/local/bin/perl


6. The MOMSPIDER_HOME environment variable must be set to point to the
   MOMspider-V.VV directory, e.g. 

        % setenv MOMSPIDER_HOME /usr/local/MOMspider-V.VV

   This allows momspider to place it on the @INC path and to specify
   the default location for the system avoid and sites files.


7. Make sure the momspider program is executable:

        % chmod 755 momspider


8. Read and follow the instructions in docs/config.html to set up
   MOMspider's default configuration options.


9. Read docs/instruct.html to set up an instruction file for
   testing MOMspider.  I recommend choosing a tree-oriented subdirectory
   (such as one generated by latex2html) and accessing it using "file" URLs.


******************************* N O T E **********************************
** Do not allow yourself to be tempted into fixing all the problems     **
** MOMspider finds before you have completely finished the installation **
** process and successfully run the program on your entire site.        **
** Otherwise, we won't be able to see how effective MOMspider is at     **
** uncovering hypertext problems.                                       **
**************************************************************************


10. Read docs/avoiding.html to set up an the initial Sites and Avoid
    files for Avoiding and Leafing Specific URLs.


11. Read docs/usage.html for information on command-line options and
    how to start MOMspider.


12. Test MOMspider using your test instructions.


13. If you want more document metainformation to appear in the generated
    index files, read docs/metainfo.html to see how to make document
    metainformation visible to MOMspider and other programs.
    

14. If you want to extend MOMspider's functionality or connect it to
    other programs (such as graph-drawing programs), read docs/extending.html.


15. Create a general instruction file for maintaining your site using
    the information in docs/instruct.html.  Run MOMspider on your site
    using those instructions and save the output file.


16. Please e-mail to Roy Fielding <fielding@ics.uci.edu> a cut-and-pasted
    copy of the "Summary of Process Results" generated by MOMspider on
    the FIRST FULL TEST of your site (i.e.  BEFORE you fix any of the
    problems reported).  THIS IS VERY IMPORTANT as it will allow us
    to perform further research into the usability of distributed hypertext
    and the effectiveness of tools like MOMspider.  Any other comments
    you wish to send will also be welcome.


17. If you wish to become part of a long-term (about six months) study of 
    distributed information systems, let us know.  There will be very low
    overhead (just answering a few questions before/during/after the period
    and sending periodic MOMspider outputs back to us) and you will benefit
    from having direct access to the MOMspider developers.  For more info,
    please contact Dr. Mark Ackerman <ackerman@ics.uci.edu> or Roy Fielding.


==========================================================================
Have fun,


....Roy Fielding   ICS Grad Student, University of California, Irvine  USA
                   (fielding@ics.uci.edu)
    <A HREF="http://www.ics.uci.edu/dir/grad/Software/fielding">About Roy</A>
