Search v2.00b

<h1>Search v2.00b</h1>

by Thorbj&ouml;rn Jemander.
<hr>
<h2>1. Introduction</h2>

This add-on lets you search the contents of the files that you
have marked in the Tracker. It recursively descends down 
into any marked directories and searches the conents of
the files present there.

There are two ways to specify the search string; the first
is to just use the contents of the clipboard, the second
is by explicitly enter the string in a by the program 
provided text control.

There are several search options regarding case sensitivty,
wildcards and regular expressions.

<h2>2. Archive</h2>

The following entries are included in the package:
<ul>
	<li> Search.html (this file :)
	<li> Search-S
	<li> Drop Search-S Here To Install
	<li> Art/ParameterWindow.jpeg
	<li> Art/ResultWindow.jpeg
</ul> 

<h2>3. Requirements </h2>

Search v2.00 requires BeOS R3/x86 and Marco Nelissen's
layout library liblayout. It can be found in BeWare.

<h2>4. Installation</h2>

Drag Search-S to folder "Drop Search-S Here To Install".

<h2>5. Operation</h2>

<h3>5.1 The clipboard</h3>

Make sure that you have the text you want to
search for in the clipboard by copy it somewhere
e.g. in a editor, terminal or a text control
somewhere.

<h3>5.2 Invocation</h3>

Mark the files and folders you want to search 
in the Tracker and choose the Search add-on in the
add-ons menu, or press Command-Option-S. 
(The command key is mapped to Alt on most x86 keyboard
layouts.)

<h3>5.3 The Parameter Window</h3>

<img src="Art/ParameterWindow.jpeg"><p>

If the clipboard is empty when the add-on
is selected OR if you activate it (by pressing
the right command key while launching the add-on)
a window will appear where you can modify the
selected text and specify some search criteria:

<ul>
	<li><B>Ignore case</B> - The search is case insensitive when set.
	<li><B>Entire word</B> - Only hits when the word is surrounded by white spaces.
	<li><B>Use * and ?</B> - * and ? are interpreted as common wildcards (?=1 unknown character, *=multiple unknown characters.)
	<li><B>Regexp</B> - The string is interpreted as a regular expression.
</ul>

You also have a history menu of previous searches. 
You can clear the history with the so marked button.
Start the search by pressing the Search button or hit enter
on the keyboard.

<h3>5.4 The Result Window</h3>

<img src="Art/ResultWindow.jpeg"><p>

When the search has started, a window will open that
displays the files that are found to contains the
specified text. They appear on the list as the algorithm
finds the files. <p>

The files can be double-clicked to be launched with its
preferred application. Holding down shift while doing it,
causes its parent folder will be opened in the Tracker. The
same thing can be accomplished by pressing the buttons
above the listview. <p>

Below the list view there's a check box that determine whether
the full path should be visible or not. Default is on.
(The files can still be invoked when only the names are visible.)<p>

When the search is finished, the first item (if any) in the list 
will be marked and there will be a system beep.

<h2>6. Bugs</h2>

No that I know of. Enlighten me! :)
However, the regexp search is not tested very hard since I'm not
an expert on it myself. There could be a question 
on how reliable the regexp search is over the 64k boundary.
It is not tested very good due to a limtied time and
experience. This software should be regarded as beta.

<h2>7. Limitations</h2>

The maximum size of the searched text is 
currently 255 characters. The wildcard
extension is max 256 characters.

<h2>8. Performance </h2>

I have not done any timing, but the fastest
search is done with no options checked. The 
buffer size is 64k and by using the BeOS API
that should guarantee a high speed. The case
insensitivity is slower and the regexp search
is considerably slower. <p>

NB! It is <B>not</B> an good idea to make two searches
simultaneously, especially on IDE-based hardware. It
will kill the system in terms of performance and
the searching speed becomes utterly slow. <p>

<h2>9. History</h2>
<ul>
	<li> v.1.00 Initial release 
	<li> v.1.10 Bugfix.
	<li> v.1.11 Bugfix. Release
	<li> v.1.12 Enhancement: The listview. Release.
	<li> v.1.13 Enhancement, the ending alert.
	<li> v.1.20 Recompilation for AA:DR9. Release.
	<li> v.1.21 Recompilation for PR. Release.
	<li> v.1.50 Scrollbars, double click invocation. Intel and PPC version.
	<li> v.2.00.b. Case insensitivity, entire word search, wildcards, regexp,
inovocation buttons, full path option, history menu.
</ul>

<h2>10. Thanks...</h2>
... to Rainer Riedl who came with valuable 
suggestions and source code, and to you
all other that encouraged me. Thanks also goes to
Marco Nelissen for providing the nice liblayout
library. And to those at Be. And to BeDevTalk
participants. And to...

<h2>11. Legal stuff</h2>

I do not take any responsibilities what so ever
for any consequences caused by, or even remotely
associated with this program. You use it entirely
at your own risk and I do leave no guarantees that
this program will work 100% as stated here.

You may copy, redistribute and modify it as much as
you want as long as you (or another person, company
foundation or similair) does not make commercial
profit on this program and if this archive is 
distributed intact.

<h2>12.  Contact info</h2>

Comments, bug reports, feature requests etc,
are grately appreciated and can be sent to:<p>

<a href="mailto:thoan@ifm.liu.se">thoan@ifm.liu.se</a> <p>

Enjoy!
<hr>
Late September 1998<p>
Thorbj&ouml;rn Jemander<p>
</html>