PEEK 1.0 Readme

PEEK Version 1.0 for Windows95 and WindowsNT 4.0

Contextmenu Extension providing simple text extraction for any file.


WELCOME TO PEEK:
================
PEEK is an Shell contextmenu extension which allows you to extract only the text
portion of files.
Peek uses setups which hold specifics of how the text extraction should take place.
After installation you are provided with 3 different setups called:
- Standard
- Binary Files
- All captital words

'Standard' can be used for any files especially where significant amount of text 
is suspected.
'Binary Files' is a somewhat stripped down version of 'Standard' which may produce
good results for any executables.
'All capital files' will find only words with all captital characters.

( See 'HOW TO MODIFY/CREATE PEEK SETUPS' for details on setups )

The output is written to a text file 'PEEK.TXT' in the system tempory folder. Each portion
of text is written to this file and terminated with a cr/lf. After scanning the source
file the program associated with TXT files is invoked to show PEEK.TXT.

This utility does not support UNICODE at this time ( maybe if I have time again ... ).
So you won't see any text coded in UNICODE characters.


INSTALLATION / DEINSTALLATION:
==============================
Copy the files PEEK.INF and PEEK.DLL to a temporary folder and right click on the
PEEK.INF file. Choose the 'Install' command and the system will install PEEK on your
computer.
To deinstall PEEK go to the control panel and use the 'Add/Remove Programs' applet to
remove PEEK from your computer.


HOW TO MODIFY/CREATE PEEK SETUPS:
=================================
The three provided setups are only thought as examples on how you can create
specific setups by yourself.

4 parameters control ths behaviour of the text extraction:

- Character Set  : defines a string of characters which composes words.
- Character Count: defines the minimum count of consecutive characters out of the character
		   set before a text is accepted as text.
- Delimiter Set  : defines a string of characters which act as delimiters between words.
- Delimiter Count: defines the maximum count of delimiter characters which are treated as
                   text.

These 4 parameters are entered into the registry in the following way:

The main key for PEEK is HKEY_LOCAL_MACHINE\SOFTWARE\Aries\Peek.
Each subkey represents a individual setup. The name of the subkey is also the name which
will appear in the context menu.
To add an additional setup insert a subkey to the main PEEK key and name it appropriately.
For this subkey you have to create the 4 items as mentioned above.

To specify nonprintable characters use the following table:

\a	Alert (bell)
\b	Backspace
\f	Formfeed
\n	Newline
\r	Carriage return
\t	Horizontal tab
\v	Vertical tab
\?	Literal quotation mark
\'	Single quotation mark
\"	Double quotation mark
\\	Backslash
\ddd	ASCII character in octal notation
\xdd	ASCII character in hex notation
\0	Null character

A silly example would be to extract only words which consists of any of the first 5 characters in
the alphabet and that are at minimum 6 characters long. We want to have each word in a
single line:
Character Set : "ABCDEabcde"
Character Count: "6"
Delimiter Set : ""
Delimiter Count : 0

A maybe more usful example could be the splitting of a text file into lines at special characters
Lets split at a ~
Character Set : 
"@ 1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz,.-;:_<>|^°!$%&/()=?+#{}[]\"\'\\\t\n\r"
Character Count : "1"
Delimiter Set : ""
Delimiter Count : "0"




HOW TO CONTACT THE AUTHOR:
==========================
If you have any suggestions, interesting setups or bug reports you can contact me at:

internet   : 	mlubich@ping.at
compuserve : 	100534.1150
snail mail : 	Martin Lubich
		Pradlerplatz 5
		A-6020 Innsbruck
		AUSTRIA




This software is Copyright 1996 by Martin Lubich.
Allthough it is distributed as FREEWARE it is NOT Public Domain.