Berkeley Digital Library SunSITE

SWISH-E

Quick Start Guide

What To Do From Downloading the Code To Searching Your Site

Downloading/Installing

The source code can be downloaded from our site at ftp://sunsite.berkeley.edu/pub/swish-e.

There are detailed instructions on how to install SWISH-E in the README file. Currently the code has been tested on Solaris 2.5.1, Alpha3.2 (both in house), on BSDI 2.0, Windows NT, Linux (by users).

From version 1.2 it is possible to choose two main modes of indexing: filesystem and http. This first indexes files all on one machine, while the second allows for "spidering" capability, that is retreiving files through http:// connections. Which method is used, it is decided at compile time as point out in the README file. More information about the spidering feature.

Some customization is also possible by setting variables in the config.h file before compiling. The default configuration file in the distribution gives examples and explanations.

Indexing Your Site

Once you have compiled the code and transferred the executable in the appropriate directory (most commonly /usr/local/bin), you are ready to index your site.

First of all you'll need a configuration file . By adjusting the variables contained in this file, you'll direct the creation of the index.

For many of the settings, you can just use the defaults that are used in the sample, however, for sure you'll need to change the following:

Where IndexDir is the list of the directories containing the files that need to be indexed, IndexFile is the name of the index file with its path, and the last group represent a set of administrative information that appear in the index itself and unlikely the two previous ones, it is not essential for the engine functionality.

As you have completed the changes in your configuration file , you can proceed to index the site.

Assuming that you have placed your executable in /usr/local/bin and your configuration file is in /home/myDir/myConfigFile, the most basic command line to index is:

% /usr/local/bin/swish-e -c /home/myDir/myConfigFile

Please refer to Command Line Indexing Options for more information on what options you have available.

Searching Your Site

Ok, now that you have an index, you might want to search it. The basic command line is:

% swish -w "<word(s)>" -f <indexToSearch>

For example:

% swish -w "jack london" -f sunsite.swish

There are many search options available. See Command Line Searching Options and Search Options and Interpretation for more information.

Making It Available on the Web

To allow Web users to search your index via their Web browser, you will need to install a Common Gateway Interface (CGI) application on your Web server. For more information on your options, see Making Your Index Available on the Web.

For all your other questions check our Table of Contents or search the manual.

Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000 Hewlett-Packard Company
Originally by Kevin Hughes, kev@kevcom.com, March 11, 1994.
SWISH-E is distributed with no warranty under the terms of the GNU Public License,
Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
Public questions may be posted to the SWISH-E Discussion.
Document maintained at http://sunsite.berkeley.edu/SWISH-E/Manual/quickstart.html by the SunSITE Manager.
Last update September 9, 1998. SunSITE Manager: manager@sunsite.berkeley.edu