next up previous contents
Next: Installing a Binary Release Up: Shore Software Installation Manual Previous: Requirements

 

Installing the Documentation Release

If you are installing Shore for the first time and you just copied the tar files with FTP and followed the instructions in the README file there, you will already have finished this step, and you can skip to the next section.

Set the shell variables TARDIR and SHROOT and create the directory $SHROOT. Then extract the documentation.

    set TARDIR=directory-that-holds-tar-files
    set SHROOT=directory-in-which-to-install-shore
If you use the Bourne shell (/bin/sh) or one of the shells derived from it, such as ksh, omit the word "set".
    mkdir $SHROOT
    cd $SHROOT
    gzip -d -c $TARDIR/doc.tar.gz | tar -xvf -

This step creates three directories, docs.html, docs.ps, and examples. The $SHROOT/docs.html directory contains HTML versions of the documentation. You can read these documents with a World-Wide-Web (WWW) browser such as Netscape or Mosaic. Click the "Open..." button and type

    file://localhost/SHROOT/docs.html/homepage.html
where SHROOT is the directory where you un-tar'ed the documentation release.

These documents are also available over the network at

    http://cs.wisc.edu/shore/doc
You may delete docs.html if you do not want to keep local copies.

The directory $SHROOT/docs.ps contains Postscript versions of the documents suitable for printing on a laser printer. You may delete this directory after printing the documentation.

The examples directory contains example and test programs discussed in the documentation. You can get the examples without the HTML or Postscript documentation by fetching examples.tar.gz rather than doc.tar.gz.


next up previous contents
Next: Installing a Binary Release Up: Shore Software Installation Manual Previous: Requirements
This page was generated from LaTeX sources
10/27/1997