(***********************************)
(* SearchIn , Version 2.5e *)
(* by: Jean Lalonde, May 18 1988 *)
(***********************************)

SearchIn is a powerful utility that allows you to search through
files for text you need to find. It is menu-driven and can use a
mouse if you have one. SearchIn will look through a list of files
to find your text, then display the lines containing your search
text, along with the filename and line numbers in that file.

Normally, SearchIn displays the result of the search on the
screen, but you can also send the search result to your printer
or to a file at the same time.


INSTALLING SearchIn:

Begin the installation of SearchIn by copying the files
SIN25E.EXE, SETUP.BAT, and SIN.DOC onto a floppy disk or into a
directory on your hard disk. If you're using a floppy disk
system, you may want to put SearchIn on a bootable disk. To
create a bootable disk, format a blank floppy disk with the /S
switch of the FORMAT command.

On a hard disk, SearchIn will work best if you copy the files
into a directory included in the PATH statement in your
AUTOEXEC.BAT file. That way, you'll be able to run SearchIn from
any directory on your hard disk. If you need more information
about the PATH command, consult your DOS manual.

After copying the files, configure SearchIn for your system by
giving the command SETUP. This will let you set the screen colors
or screen attributes for monochrome systems. When you finish with
the SETUP program, a new version of SIN.EXE will be created. Keep
the original SIN25E.EXE file in a safe place as a backup.


RUNNING SearchIn:

There are two ways to run SearchIn. You can either start the
program with the simple command, SIN , or you can include a
number of parameters on the command line to speed up its operation.


MENU-DRIVEN OPERATION:

Most often, you'll want to start with the simple command SIN. Started
this way, SearchIn displays a menu that allows you to control your
search.

You will be able to enter or modify all parameters for your search. If
you need to change a default entry for a parameter, simply backspace
to erase the old entry, then type in your new information.

To specify a command, press one of the function keys. The function
keys are F1 to F10. If you have redefined those function keys, you
can also use Alt-function, Ctrl-function or Shift-function for the same
result. The commands are:

F1- Start searching. (Use F3 to specify text before searching.)

F2- Display the help window.

F3- Specify or change the text to search for.

F4- Toggle File Out ON/OFF. If ON, output the result to the file
"SIN.LST". If SIN.LST already exists, the result is appended to it.
This file is never erased by the program. You can also specify a
different filename for the data.

F5- Specify or change the directory and the files to examine. Wild
cards (*.* or ??.???) and multiple filenames are allowed. You can name
multiple drives as well. For example, to search for your text in all
files on drives A:, B:, and C:, type ABC:*.* in this field. Add the
colon only after naming all the drives.

F6- Toggle Printer ON/OFF. If ON, the results go to the printer.

F7- Toggle Case ON/OFF. If ON, match upper/lower case in the search
string. IMPORTANT: Be sure to use F3 to specify the text to search for
before you use this function. If you press F7 to toggle the case before you
specify a search string, your system will crash and you'll have to reboot.

F8- Toggle Scan Subdirectories ON/OFF. If ON, scan files in
subdirectories of the current search directory. This feature can let
you search an entire disk's files for your text. To do this, start
with the root directory of the disk. For example, to search all files
in all directories on drives A:, B:, and C:, toggle this switch on and
enter ABC:\*.* in the F5 directory field.

F9- Toggle Skip binary files ON/OFF. If ON, SearchIn will ask for
file extensions to skip during the search. Normally, you won't want
to search for your text in program files, so leave this switch on
unless you actually want to search .COM, .EXE, .ARC and .BIN files.

F10- Quit the program. SIN quits immediately.

While SearchIn is running a search, you can control the search
process. To pause while a search is underway, press the spacebar. If
you decide you want to skip the file currently displayed in the file
window, just press -. Finally, you can abort the current
search by pressing .

SearchIn, Version 2.5e, supports the Microsoft mouse (and compatible
drivers). The mouse cursor is displayed in the menu window. To select
an item, place the mouse cursor on the item and click the left or
right button. When SearchIn is searching in files, the mouse cursor
is hidden but the buttons are still enabled. You can click the left
button to pause the search, click the right button to skip the file
currently being scanned or click both buttons to abort the search.
When SearchIn is waiting for an input in the menu window, click both
buttons to quit the program.


COMMAND-LINE OPERATION:

You can also run SearchIn from the command line, using a number of
switches to control its operation. This method is ideal for fast
searches, or for repeated searches. You can even create batch files
to perform searches that are frequently the same.

There are two ways to give your SearchIn command. First, from the DOS
prompt, you can add to the program name "SIN", the string to search
for and the file specification. Drive(s), path and multiple
filenames with wild cards and exclusion list are allowed in the file
specification.

Multiple drives must be specified before the ':' (eg: 'cd:' for drives
C: and D:), multiple file names must be separated by '+' (eg:
'*.txt+*.doc' for *.TXT and *.DOC files) and the exclusion list must
follow after a slash '/' (eg: '*.*/*.txt' for all files except *.TXT files).

You can also specify the status of these options: case sensitivity,
printer output, text file output, sub-directory inclusion, and binary
file skipping.

Here is a list of switches that can be added to the command line to
control these functions:

Switch Action

/c+ Upper/lower case sensitive.
/c- Upper/lower case non-sensitive (default).

/p+ Turn the printer on.
/p- Turn the printer off (default).

/f+ Send result text to SIN.LST
/f- Do not send result to text file (default).

/s+ Scan given directory and children directories.
/s- Scan only the top directory (default).

/k+ Skip binary files (*.ARC *.BIN *.COM and *.EXE) (default).
You can add file extensions to skip after the +.
/k- Do not skip binary files.


/b SIN returns to DOS after the execution of the request.
This option is designed for batch file use.

/i Initialize color or monochrome attributes configuration.


SAMPLE COMMAND LINES:

Command Operation

C>sin string *.txt Search for the "string" in all files with
the extension ".txt" in current directory.

C>sin string \subdir\*.* /c+ Search for the "string" in all files of the
directory "\subdir" matching upper and
lower cases, skipping binary files
(default).

C>sin str acd:\?.txt /s+ /p+ Search for the "string" in all files with
a one letter name and extension ".txt" in
all directories of drive A:, C: and D:,
send the result to the printer.

C>sin string *.doc+*.hlp /s+ Search for the "string" in all files with
extension ".doc" or ".hlp" in current
directory and its children directories.

C>sin string *.*/*.doc Search for the "string" in all files except
those with the extension ".doc" in
current directory.

C>sin string *.* /k- Search for the "string" in all files of the
current directory including binary files.

C>sin string *.* /k+*.doc Search for the "string" in all files of
current directory, skipping *.DOC
files in addition to the default
*.ARC, *.BIN, *.COM and *.EXE files.

String and file specifications must be separated by a space. If you
want to include spaces in the search string, the string must be
included in single or double quotes:

sin "two words"
sin 'he said: "Yes'
sin "ch := 'A';"

If a search string is given at the DOS prompt, the program will start
searching immediately. If you omit the file specification, the
default is all files (*.*) except binary files.

If you include the "/b" switch, the program will stop after the
execution of the command and will return to DOS. If SearchIn is
called from a batch file, the batch will continue with the next
command.

Advanced users can make SearchIn parameters permanent by adding them
to the DOS environment. To do this add a line to your AUTOEXEC.BAT.
The line should specify: 'SET SINSPEC=/x /x...'(eg.: SET SINSPEC=/f+).
You can specify any or all of SearchIn's switches, making your
selection the default.


TECHNICAL INFORMATION:

(***********************************************************)
(* SearchIn specifications *)
(***********************************************************)
(* Language: MODULA-2/86, Rel 3.0, PC/MS-DOS 8088/8086 *)
(* LOGITECH, (Switzerland / Palo Alto, Cal. USA) *)
(* (C) Copyright 1987 Logitech *)
(***********************************************************)
(* This program has been tested with PC-DOS and MS-DOS *)
(* versions 3.0 and greater. *)
(***********************************************************)
(* SearchIn is an adaptation of GREP ("A simple file *)
(* search utility") distributed by Logitech with its *)
(* compiler. This adaptation uses Console Modules for *)
(* screen, keyboard and mouse input/output. *)
(* *)
(* Console Modules (c) Jean Lalonde, July 1987, Montreal. *)
(* *)
(* The sources of those modules can be obtained by *)
(* sending me $25.00. Send your check or money order to *)
(* Jean Lalonde at the following address: *)
(* *)
(* Jean Lalonde *)
(* 6667 De Normanville *)
(* Montreal, Quebec *)
(* CANADA *)
(* H2S-2B8 *)
(* *)
(* Compuserve ID: 76606,671 *)
(* BIX Info Exchange: jlalonde *)
(***********************************************************)
(* For speed consideration, Console Modules are not *)
(* configured for some Color Graphic Adaptor (CGA). *)
(* On those adaptors, the screen writing operations could *)
(* cause some snow or flicker. *)
(***********************************************************)