1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title>SWISH-Enhanced: The Swish-e README File </title>
<link href="./style.css" rel=stylesheet type="text/css" title="refstyle">
</head>
<body>
<h1 class="banner">
<a href="http://swish-e.org"><img border=0 src="images/swish.gif" alt="Swish-E Logo"></a><br>
<img src="images/swishbanner1.gif"><br>
<img src="images/dotrule1.gif"><br>
The Swish-e README File
</h1>
<hr>
<p>
<div class="navbar">
|
<a href="./index.html">Contents</a> |
<a href="./INSTALL.html">Next</a>
</div>
<p>
<div class="toc">
<A NAME="toc"></A>
<P><B>Table of Contents:</B></P>
<UL>
<LI><A HREF="#Upgrading_">Upgrading?</A>
<LI><A HREF="#What_is_Swish_e_">What is Swish-e?</A>
<UL>
<LI><A HREF="#Key_features">Key features</A>
</UL>
<LI><A HREF="#Where_do_I_get_Swish_e_">Where do I get Swish-e?</A>
<LI><A HREF="#How_Do_I_Install_Swish_e_">How Do I Install Swish-e?</A>
<LI><A HREF="#The_Swish_e_Documentation">The Swish-e Documentation</A>
<LI><A HREF="#Where_do_I_get_help_with_Swish_e_">Where do I get help with Swish-e?</A>
<LI><A HREF="#Speling_mistakes">Speling mistakes</A>
<LI><A HREF="#Swish_e_Development">Swish-e Development</A>
<LI><A HREF="#Swish_e_s_History">Swish-e's History</A>
<LI><A HREF="#Document_Info">Document Info</A>
</UL>
</div>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<P>
<H1><A NAME="Upgrading_">Upgrading?</A></H1>
<P>
If you are upgrading Swish-e, please review the CHANGES file before
installation. The index format may change and existing indexes may need to
be re-created before use.
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="What_is_Swish_e_">What is Swish-e?</A></H1>
<P>
Swish-e is <STRONG>S</STRONG>imple <STRONG>W</STRONG>eb <STRONG>I</STRONG>ndexing <STRONG>S</STRONG>ystem for <STRONG>H</STRONG>umans - <STRONG>E</STRONG>nhanced. Swish-e can quickly and easily index directories of files or
remote web sites and search the generated indexes.
<P>
Swish-e is extremely fast in both indexing and searching, highly
configurable, and can be seamlessly integrated with existing web sites to
maintain a consistent design. Swish-e can index web pages, but can just as
easily index text files, mailing list archives, or data stored in a
relational database.
<P>
Swish is designed to index small- to medium-sized collection of documents,
Although a few users are indexing over a million documents, typical usage
is more often in the tens of thousands. Currently, Swish-e only indexes
eight bit character encodings.
<P>
Swish-e version 2.2 was a major rewrite of the code and the addition of
many new features. Memory requirements for indexing have been reduced and
indexing speed is significantly improved from previous versions. New
features allow more control over indexing, better document parsing,
improved indexing and searching logic, better filter code, and the ability
to index from any data source.
<P>
Swish-e version 2.4 includes a major rewrite of the C API and a new Perl
module for accessing the Swish-e C library. In addition, Swish-e 2.4 uses
the GNU Auto Tools. The significant changes are where files are installed,
and the use of Libtool to create the Swish-e library as a shared library on
many platforms. Basically, installation is easier than previous versions,
and more files are installed in "standard" locations (e.g.
documentation is installed in <CODE>$prefix/share/doc/swish-e</CODE>).
<P>
Note: Due to the new build and installation system in Swish-e 2.4, some
documentation may incorrectly list the location of files. Please report any
documentation errors to the Swish-e Discussion list.
<P>
Swish-e is not a "turn-key" indexing and searching solution. The
Swish-e distribution contains most of the parts to create such a system,
but you need to put the parts together as best meets your needs. This gives
you the power to index and search your documents the way you wish and to
seamlessly integrate a search engine into your web site or application.
<P>
To use Swish-e, you will need to configure Swish-e to index your documents,
create an index by running Swish-e, and setup an interface such as a CGI
script (a script is included) to search the index and display results.
Swish uses helper programs to index documents of types that Swish-e cannot
natively index. These programs may need to be installed separately from
Swish-e.
<P>
Swish-e is an Open Source (see: <A
HREF="http://opensource.org">http://opensource.org</A> ) program supported
by developers and a large group of users. Please take time to join the
Swish-e discussion list at <A
HREF="http://Swish-e.org">http://Swish-e.org</A> .
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H2><A NAME="Key_features">Key features</A></H2>
<UL>
<P><LI>
<P>
Quickly index a large number of documents in different formats including
text, HTML, and XML.
<P><LI>
<P>
Use "filters" to index other types of files such as PDF, gzip, or
PostScript.
<P><LI>
<P>
Includes a web spider for indexing remote documents over HTTP. Follows
Robots Exclusion Rules (including META tags).
<P><LI>
<P>
Can use an external program to supply documents to Swish-e, such as an
advanced spider for your web server or a program to read and format records
from a relational database.
<P><LI>
<P>
Document "properties" (some subset of the source document,
usually defined as a META or XML elements) may be stored in the index and
returned with search results.
<P><LI>
<P>
Document summaries can be returned with each search.
<P><LI>
<P>
Word stemming, soundex, metaphone, and double-metaphone indexing for
"fuzzy" searching
<P><LI>
<P>
Phrase searching and wildcard searching
<P><LI>
<P>
Limit searches to HTML links.
<P><LI>
<P>
Use powerful Regular Expressions to select documents for indexing or
exclusion.
<P><LI>
<P>
Easily limit searches to parts or all of your web site.
<P><LI>
<P>
Results can be sorted by relevance or by any number of properties in
ascending or descending order.
<P><LI>
<P>
Limit searches to parts of documents such as certain HTML tags (META,
TITLE, comments, etc.) or to XML elements.
<P><LI>
<P>
Can report structural errors in your XML and HTML documents.
<P><LI>
<P>
Index file is portable between platforms.
<P><LI>
<P>
A Swish-e library is provided to allow embedding Swish-e into your
applications for very fast searching. A Perl module is available that
provides a standard API for accessing Swish-e.
<P><LI>
<P>
Includes example search script with context summaries and search term and
phrase highlighting. Can be used with popular Perl templating systems.
<P><LI>
<P>
Swish-e is fast.
<P><LI>
<P>
It's Open Source and FREE! You can customize Swish-e and you can contribute
your fancy new features to the project.
<P><LI>
<P>
Supported by on-line user and developer groups.
</UL>
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="Where_do_I_get_Swish_e_">Where do I get Swish-e?</A></H1>
<P>
The current version of Swish-e can be found at:
<P>
<A HREF="http://Swish-e.org">http://Swish-e.org</A>
<P>
Please make sure you use a current version of Swish-e.
<P>
Information about Windows binary distributions can also be found at this
site.
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="How_Do_I_Install_Swish_e_">How Do I Install Swish-e?</A></H1>
<P>
Read the <A HREF="././INSTALL.html">INSTALL</A> page.
<P>
Building from source is recommended. On most platforms, Swish-e should
build without problems. A list of platforms where Swish-e has been built
can be found in the <A HREF="././INSTALL.html">INSTALL</A> page. Information on building for VMS and Win32 can be found in
sub-directories of the <CODE>src</CODE> directory. Check the Swish-e site for information about binary
distributions (such as for Windows).
<P>
In addition to the INSTALL page, make sure you read the <A HREF="././SWISH-FAQ.html">SWISH-FAQ</A> page if you have any questions, or to get an idea of questions that you
might someday ask.
<P>
Problems or questions about installing Swish-e should be directed to the
Swish-e discussion list (see the Swish-e web site at <A
HREF="http://Swish-e.org">http://Swish-e.org</A>).
<P>
Please read <CODE>Where do I get help with Swish-e?</CODE> below before posting any questions to the Swish-e list.
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="The_Swish_e_Documentation">The Swish-e Documentation</A></H1>
<P>
Documentation is provided as HTML pages installed in
$prefix/share/doc/swish-e where <CODE>$prefix</CODE> is /usr/local if
building from source, or /usr if installed as part of a package from your
OS vendor. Under Windows <CODE>$prefix</CODE> is selected at installation
time.
<P>
A subset of the documentation is installed as system man pages as well.
<P>
Documentation is also available on-line at <A
HREF="http://swish-e.org.">http://swish-e.org.</A>
<P>
If your system includes the required support files and programs, the
distribution make files can also generate the documentation in these
formats:
<P>
<table>
<tr>
<td bgcolor="#eeeeee" width="1">
</td>
<td>
<pre> Postscript
PDF (Adobe Acrobat)</pre>
</td>
</tr>
</table>
<P>
See <A HREF="././INSTALL.html">INSTALL</A> for information on creating the PDF and Postscript versions of the
documentation.
<P>
Patches or updates to the documentation should be done against the POD
files, located in the pod directory of the distribution, or (preferably)
against the CVS repository.
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="Where_do_I_get_help_with_Swish_e_">Where do I get help with Swish-e?</A></H1>
<P>
If you need help with installing or using Swish-e, please subscribe to the
Swish-e mailing list. Visit the Swish-e web site (listed above) for
information on subscribing to the mailing list.
<P>
Before posting any questions, please read
<A HREF="././INSTALL.html#QUESTIONS_AND_TROUBLESHOOTING">QUESTIONS AND TROUBLESHOOTING</A>.
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="Speling_mistakes">Speling mistakes</A></H1>
<P>
Please contact the Swish-e list with corrections to this documentation. Any
help in cleaning up the docs will be appreciated!
<P>
Any patches should be made against the <CODE>.pod</CODE> files, not the <CODE>.html</CODE> files.
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="Swish_e_Development">Swish-e Development</A></H1>
<P>
Swish-e is currently being developed as an Open-Source project on
SourceForge <A HREF="http://sourceforge.net.">http://sourceforge.net.</A>
<P>
Contact the Swish-e list for questions about Swish-e development.
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="Swish_e_s_History">Swish-e's History</A></H1>
<P>
SWISH was created by Kevin Hughes, circa 1994, to fill the need of the
growing number of Web administrators on the Internet - many of the indexing
systems were not well documented, were hard to use and install, and were
too complex for their own good. The system was widely used for several
years, long enough to collect some bug fixes and requests for enhancements.
<P>
In Fall 1996, The Library of UC Berkeley received permission from Kevin
Hughes to implement bug fixes and enhancements to the original binary. The
result is Swish-enhanced or Swish-e, brought to you by the Swish-e
Development Team.
<P>
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<H1><A NAME="Document_Info">Document Info</A></H1>
<P>
Each document in the Swish-e distribution contains this section. It refers
only to the specific page it's located in, and not to the Swish-e program
or the documentation as a whole.
<P>
$Id: README.pod,v 1.19 2004/10/02 23:56:30 whmoseley Exp $
<P>
.
[ <B><FONT SIZE=-1><A HREF="#toc">TOC</A></FONT></B> ]
<HR>
<p>
<div class="navbar">
|
<a href="./index.html">Contents</a> |
<a href="./INSTALL.html">Next</a>
</div>
<p>
<P ALIGN="CENTER">
<IMG ALT="" WIDTH="470" HEIGHT="10" SRC="images/dotrule1.gif"></P>
<P ALIGN="CENTER">
<div class="footer">
<BR>SWISH-E is distributed with <B>no warranty</B> under the terms of the
<A HREF="http://www.fsf.org/copyleft/gpl.html">GNU Public License</A>,<BR>
Free Software Foundation, Inc.,
59 Temple Place - Suite 330, Boston, MA 02111-1307, USA<BR>
Public questions may be posted to
the <A HREF="http://swish-e.org/Discussion/">SWISH-E Discussion</A>.
</div>
</body>
</html>
|
