SiteC Installation

Installation of SiteC:
======================

Prerequisites:
--------------

- Solaris 2.5.x or newer, Linux 1.2 or newer 
  (tested on SuSE 4.4.1)
- Perl 5.001 or higher.


Installation:
-------------

1.) Create the installation directory.

SiteC may be installed globally (superuser-rights
necessary) or for a single user without particular
 permissions.

# cd ~user
# mkdir sitec
# cd sitec

or
# cd /usr/local
# mkdir sitec
# cd sitec


2.) Untar package:

# gzip -d sitec_xxx-X.X.X.tgz
# tar xvf sitec_xxx-X.X.X.tar

or in case you have gnutar:
# tar xvzf sitec_xxx-X.X.X.tgz


3.) Enter the SiteC directory, copy the file "sitecrc" 
to your home directory as ~/.sitecrc (Attention, add the 
leading dot "." before "sitecrc"!) and modify it to suit 
your configuration. The parameters are explained within 
the file. It may be a good idea to use the SiteC online 
documentation as a first example. "Sitecrc" contains 
corresponding pathes as a default.
The other configuration files (tdlinit.dl, design.html) 
do not need to be changed at this moment.


4.) Make Sitec (Source Distribution Only)

If you have the source distribution enter the SiteC 
directory and type: 

# make sitec

With the binary distribution, the "sitec" binary is provided.


5.) Start the executable:

# ./sitec

By default, SiteC behaves rather verbosely and displays
any possible causes of errors.

Operation is split into several phases:
Phase 0 - Initialization: The ~/.sitecrc file is read
Phase 1 - Parsing of HEAD-information of source files
Phase 2 - Generating the destination tree
Phase 3 - Link Checking

If your HTML files contain errors, the SiteC parser will
issue verbose HTML warnings, indicating location and possible
cause of HTML errors. These messages tend to be a little
lengthy but proved to be useful.


6.) Copy SiteC to your ~/bin directory

Just for convenience, I usually copy "sitec" into the path 
by creating a link to it in ~/bin:

# cd ~/bin
# ln -s ~/sitec/sitec sitec

NOTE: If SiteC creates an error and displays "?-" or similar,
please type "Ctrl-D" to end.