THE SWISH-E README 
 
SYSTEM REQUIREMENTS

SWISH-E is written in C, and, up to this time, it has been tested on
Solaris 2.5.1 and Dec Alpha 3.2 in house and by users on BSDI 2.0.  To
compile, a C compiler is needed. Pretty much any standard compiler
should do, the ones we used are: gcc version 2.7.0 and ucbb SC3.0.1.

The HTTP file access method uses a Perl helper script that requires
the LWP (Note: depending on your perl installation, you might need to
install additional modules required by LWP; for requirements and
downloads check http://www.cpan.org) .  It was tested with Perl 5.005 although should
probably work with any version 5 release.

A tip from Wil Vree about compiling with a Sun C compiler:
In the Makefile the following two opions need to be modified
CC = /opt/SUNWspro/bin/cc
CFLAGS= -xO2

 
INSTALLATION

Downloading the C files and recompiling the executable
------------------------------------------------------
1) Create a directory where to keep the source code files, for
        example /opt/swish-e.x

        %mkdir /opt/swish-e.x

2) Download the swish-efiles.x.x.tar.gz into the directory, uncompress and
         untar it
         % gunzip swish-efiles.x.x.tar.gz
         %tar -xvf swish-efiles.x.x.tar
 
         The command should create the following directory and files:

      src/
	Makefile        file.h          list.c          string.h
	README-SWISH-E  fs.c            list.h          swish.c
	user.config     hash.c          mem.c           swish.h
	check.c         hash.h          mem.h           swishspider
	check.h         http.c          merge.c         swishspider.pl
	config.h        http.h          merge.h         test.html
	docprop.c       httpserver.c    search.c        /win32
	docprop.h       httpserver.h    search.h        
	error.c         index.c         stemmer.c
	error.h         index.h         stemmer.h
	file.c          index.swish     string.c


3) In the Makefile change the path for the C compiler
          Change
          CC = /usr/local/bin/gcc
          to
          CC = {PATH}/gcc
 
          as stated in the SYSTEM REQUIREMENTS section, you do not need to
          necessarily use gcc to compile.
 
4) Make any needed changes in the config.h to customize swish-e to
          your site.

5) Compile the swish-e executable from the src/ directory

          %cd src 
          %make
 
6) Run a quick test to make sure that the executable is working
          correctly.
 
           %make test
 
           If the test is successful, you should see the
           following:

        sunsite% make test
        ./swish-e -i test.html -v -f index.swish
 
        Checking file "test.html"...
        test.html (41 words)
 
        Removing very common words... no words removed.
        Writing main index... 25 unique words indexed.
        Writing file index... 1 file indexed.
        Running time: Less than a second.
        Indexing done!
        ./swish-e -f index.swish -w test
        # SWISH format 1.x
        # Search words: test
        # Name: (no name)
        # Saved as: index.swish
        # Counts: 25 words, 1 files
        # Indexed on: 13/08/97 10:40:54 PDT
        # Description: (no description)
        # Pointer: (no pointer)
        # Maintained by: (no maintainer)
        1000 test.html "If you are seeing this, the test was successful!" 358
        .


7) Move the swish-e executable to /usr/local/bin 
 
8) For instructions about how to index and search with swish-e check
         the Quick Start (http://sunsite.berkeley.edu/SWISH-E/Manual/quickstart.html)

9) The user.config file provided in the distribution is set for use with the FILESYSTEM.
   If you are using HTTP, comment out the directory of FILESYSTEM ONLY and set the ones for
   HTTP ONLY.

QUESTIONS AND TROUBLESHOOTING

If you run in any problem during installation, or if you have any
question about swish-e use and features, let us know through our
discussion group(http://sunsite.berkeley.edu/SWISH-E/Discussion
 
 
Giulia Hill
Library System Office
UC Berkeley Libraries
ghill@library.berkeley.edu
 
8/13/97
Last updated 12/10/98
 
