Swish-e Development Documentation

Version 2.5.6-2008-11-19

Table of Contents

• The Swish-e README File

  Swish-e is Simple Web Indexing System for Humans - Enhanced. Swish-e can quickly and easily index directories of files or remote web sites and search the generated indexes.

• INSTALL - Swish-e Installation Instructions

  This document describes how to download, build, and install Swish-e from source. Also found below is a basic overview of using Swish-e to index documents, with pointers to other, more advanced examples.

• CHANGES - List of revisions

  This document contains list of bug fixes and feature additions to Swish-e.

• SWISH-CONFIG - Configuration File Directives

  This document lists the available configuration directives available in Swish-e.

• SWISH-RUN - Running Swish-e and Command Line Switches

  The Swish-e program is controlled by command line arguments (called switches). Often, it is run manually from a shell (command prompt), or from a program such as a CGI script that passes the command line arguments to swish.

• SWISH-SEARCH - Swish-e Searching Instructions

  This page describes the process of searching with Swish-e. Please see the SWISH-CONFIG page for information the Swish-e configuration file directives, and SWISH-RUN for a complete list of command line arguments.

• The Swish-e FAQ - Answers to Common Questions

  List of commonly asked and answered questions. Please review this document before asking questions on the Swish-e discussion list.

• SWISH-BUGS - List of bugs known in Swish-e

  This file contains a list of bugs reported or known in Swish-e. If you find a bug listed here you do not need to report it as a bug. But feel free to bug the developers about it on the Swish-e discussion list.

• Proposed changes for Swish-e 3.0

  This pages is intended to give users of Swish-e an idea of the changes to come, to foster discussion of the direction of Swish-e, and a place where developers can map out new ideas.

• SWISH-LIBRARY - Interface to the Swish-e C library

  The C library in an interface to the Swish-e search code. It provides a way to embed Swish-e into your applications. This API is based on Swish-e version 2.3.

• SWISH::API - Perl interface to the Swish-e C Library

  This module provides a Perl interface to the Swish-e search engine. This module allows embedding the swish-e search code into your application avoiding the need to fork to run the swish-e binary and to keep an index file open when running multiple queries. This results in increased search performance.

• swish.cgi -- Example Perl script for searching with the SWISH-E search engine.

  swish.cgi is a CGI script for searching with the SWISH-E search engine version 2.1-dev and above. It returns results a page at a time, with matching words from the source document highlighted, showing a few words of content on either side of the highlighted word.

• search.cgi -- Example Perl program for searching with Swish-e and SWISH::API

  This is a very simple program that shows how to use the SWISH::API module in a CGI script or mod_perl handler using Template-Toolkit to generate output. This program is intended for programmers that want to create a custom search script.

• spider.pl - Example Perl program to spider web servers

  spider.pl is a program for fetching documnts from a web server, and outputs the documents to STDOUT in a special format designed to be read by Swish-e.

• SWISH::Filter - Perl extension for filtering documents with Swish-e

  SWISH::Filter provides a unified way to convert documents into a type that Swish-e can index. Individual filters are installed as separate perl modules. For example, there might be a filter that converts from PDF format to HTML format.