home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 25 / CDROM25.iso / Share / linux / swish-e / README-SWISH-E < prev    next >
Encoding:
Text File  |  1998-06-06  |  4.2 KB  |  142 lines
  1. THE SWISH-E README
  2.  
  3.  
  4. SYSTEM REQUIREMENTS
  5.  
  6. SWISH-E is written in C, and, up to this time, it has been tested on
  7. Solaris 2.5.1 and Dec Alpha 3.2 in house and by users on BSDI 2.0.
  8. If you are just using the provided executable, there are no
  9. requirements  on the system; if, however you want to change the
  10. config.h  files and recompile, a C compiler is needed. Pretty much any
  11. standard compiler should do, the ones we used are: gcc version 2.7.0
  12. and  ucbb SC3.0.1. 
  13.  
  14. A tip from Wil Vree about compiling with a Sun C compiler:
  15. In the Makefile the following two opions need to be modified
  16. CC = /opt/SUNWspro/bin/cc
  17. CFLAGS= -xO2
  18.  
  19.  
  20. INSTALLATION
  21.  
  22. Downloading only the executable
  23. --------------------------------
  24. 1. In a temporary directory download the swish-e.1.1.tar.Z file
  25.  
  26. 2. Uncompress the file
  27.        %gunzip swish-e.1.1.tar.Z
  28.  
  29. 3. Untar the file
  30.        %tar -xvf swish-e.1.1.tar
  31.  
  32. 4. Move the untarred executable swish-e.1.1 in its final directory,
  33.    most commonly /usr/local/bin.
  34.  
  35.  
  36.  
  37. Downloading the C files and recompiling the executable
  38. -------------------------------------------------------
  39. 1. Create a directory where to keep the source code files, for
  40.    example /opt/swish-e.1
  41.  
  42.        %mkdir /opt/swish-e.1
  43.  
  44. 2. Download the swish-efiles.1.1.tar.Z into the directory, uncompress and
  45.    untar it
  46.       % gunzip swish-efiles.1.1.tar.Z
  47.       %tar -xvf swish-efiles.1.1.tar
  48.  
  49.       The command should create the following directory and files:
  50.  
  51.       src/
  52.         Makefile     error.h      index.c      mem.h        search.h
  53.         check.c      file.c       index.h      merge.c      string.c
  54.         check.h      file.h       list.c       merge.h      string.h
  55.         config.h     hash.c       list.h       oldconfig.h  swish.c
  56.         error.c      hash.h       mem.c        search.c     swish.h
  57.         test.html
  58.  
  59. 3. In the Makefile change the path for the C compiler
  60.  
  61.       Change
  62.       CC = /vol/moby/moby_a/gnu/sun4_sunos5.1/bin/gcc
  63.  
  64.       to
  65.       CC = {PATH}/gcc
  66.  
  67.       as stated in the SYSTEM REQUIREMENTS section, you do not need to
  68.       necessarily use gcc to compile.
  69.  
  70. 4. Make any needed changes in the config.h to customize swish-e to
  71.    your site.  Information about the variables contained in config.h
  72.    and their values range is contained in the file itself, also an
  73.    example of the config.h file is contained in the web page
  74.    at http://sunsite.Berkeley.EDU/SWISH-E/changes.html
  75.  
  76. 5. Compile the swish-e executable from the src/ directory
  77.  
  78.       %cd src
  79.       %make pure
  80.  
  81.       NOTE: If you make changes to the code, using this Makefile will
  82.       automatically enable you to use gdb (I used GDB 4.13) for
  83.       debugging.
  84.  
  85. 6.  Run a quick test to make sure that the executable is working
  86.     correctly.
  87.  
  88.        %make test
  89.  
  90.        If the test is successful, you should see the
  91.        following:
  92.  
  93.         sunsite% make test
  94.         ./swish-e -i test.html -v -f index.swish
  95.  
  96.         Checking file "test.html"...
  97.         test.html (41 words)
  98.  
  99.         Removing very common words... no words removed.
  100.         Writing main index... 25 unique words indexed.
  101.         Writing file index... 1 file indexed.
  102.         Running time: Less than a second.
  103.         Indexing done!
  104.         ./swish-e -f index.swish -w test
  105.         # SWISH format 1.1
  106.         # Search words: test
  107.         # Name: (no name)
  108.         # Saved as: index.swish
  109.         # Counts: 25 words, 1 files
  110.         # Indexed on: 13/08/97 10:40:54 PDT
  111.         # Description: (no description)
  112.         # Pointer: (no pointer)
  113.         # Maintained by: (no maintainer)
  114.         1000 test.html "If you are seeing this, the test was successful!" 358
  115.         .
  116.  
  117. 7.  Move the swish-e executable to /usr/local/bin
  118.  
  119. 8.  For instructions about how to index and search with swish-e check
  120.     the the manual at http://sunsite.Berkeley.EDU/SWISH-E/manual.html,
  121.     or check out AUTOSWISH at
  122.     http://sunsite.Berkeley.EDU/SWISH-E/AutoSwish/
  123.  
  124.  
  125. QUESTIONS AND TROUBLESHOOTING
  126.  
  127. If you run in any problem during installation, or if you have any
  128. question about swish-e use and features, let us know. Information about
  129. subscriptions to the discussion group is available at
  130. http://sunsite.Berkeley.EDU/SWISH-E/Discussion/
  131.  
  132.  
  133. Giulia Hill
  134. Library System Office
  135. UC Berkeley Libraries
  136. ghill@library.berkeley.edu
  137.  
  138. 8/13/97
  139. Last updated 1/6/98
  140.  
  141.  
  142.