OS/2 Shareware BBS: 8 Other/08-Other.zip/zs120e.zip/ZSTREAM.INF

OS/2 Help File | 1996-06-23 | 109KB | 1,724 lines

ΓòÉΓòÉΓòÉ 1. ZipStream ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ 2. Copyright ΓòÉΓòÉΓòÉ

Fifth Edition (May 1996)

This publication could include technical inaccuracies or typographical errors.
Changes are periodically made to the information in this publication. Carbon
Based Software may make improvements and/or changes to the
product(s)/program(s) described in this publication at any time.

Copyright (C) Carbon Based Software  1994 - 1996.  All Rights Reserved.

No part of this publication may be reproduced, stored in a retrieval system or
transmitted in any form or by any means, electronic, mechanical, chemical,
photocopy, recording or otherwise without the prior written permission of
Carbon Based Software.


ΓòÉΓòÉΓòÉ 3. Trademarks ΓòÉΓòÉΓòÉ

ZipStream is a trademark of Carbon Based Software.

IBM OS/2 are trademarks of International Business Machines Corporation.

Pentium is a trademark of Intel Corporation.

ALL TRADEMARKS AND SERVICE MARKS ARE THE PROPERTY OF THEIR RESPECTIVE OWNERS.


ΓòÉΓòÉΓòÉ 4. License ΓòÉΓòÉΓòÉ

INTRODUCTION

This is a legal agreement which allows you, the end user, to use ZipStream
under certain terms and conditions.  If you cannot agree to abide by what this
agreement says, you should not use ZipStream.

This agreement explains when and how you may use the program ZipStream from
Carbon Based Software.

COPYRIGHT

ZipStream is fully protected by copyright under Australian law and
international treaty provisions.

OWNERSHIP OF SOFTWARE

Carbon Based Software retains title and ownership of ZipStream. You, subject to
conditions in this agreement have license to use ZipStream.  This license is
not a sale of the original software or any copy.

USE OF ZIPSTREAM

1.  You agree not to install or use any individual copy of ZipStream on more
    than one computer at any one time.

2.  If you purchased a multi-system license for ZipStream, you agree not to
    install or use it on more computers than the number included in your
    license, as shown on your invoice.

COPYING OF ZIPSTREAM

ZipStream and the accompanying written materials are copyrighted. Unauthorised
copying of the ZipStream software or documentation is forbidden. You may make
copies of the ZipStream software which are necessary for normal backup
purposes.  You agree not to make any other copies of  ZipStream, the manual(s),
or any part of them, or sell or give any copies to others, without our advance
written permission.

REGISTRATION NUMBER

The Registered Copy of the ZipStream software is provided with a unique
Registration Number.  This Registration Number is not be given to others or
publicized in any manner.

MISCELLANEOUS

No one may modify or patch the ZipStream executable files in any way,
including, but not limited to decompiling, disassembling, or otherwise reverse
engineering the program.

DEMONSTRATION VERSION LICENSE CONDITIONS

If you are evaluating a Demonstration Copy of ZipStream the following
conditions apply.

EVALUATION PERIOD

You may use a Demonstration Copy of ZipStream for an evaluation period of up to
30 days, in order to determine whether ZipStream meets your needs before
purchasing it.  Once the evaluation period ends, you agree to either purchase a
Registered Copy of ZipStream, or to stop using it.  If you have ordered a
Registered Copy of ZipStream from us or from a dealer, you may continue to use
your Demonstration Copy until your Registered Copy arrives.

MAKING AND DISTRIBUTING DEMONSTRATION COPIES OF ZIPSTREAM

A limited license is granted to copy and distribute the Demonstration Version
of ZipStream only for the trial use of others, subject to the above
limitations, and also the following:

1. The Demonstration Copy of ZipStream must be copied in unmodified form,
complete with the file containing this license information.

2. The Demonstration Copy of ZipStream may not be distributed in conjunction
with any other product without a specific license to do so from Carbon Based
Software.

3.  The Registration Number of a Registered Copy of ZipStream may NOT be
provided to others or publicized in any manner.

4. No fee, charge, or other compensation may be requested or accepted, except
as authorised below:

a. Operators of electronic bulletin board systems (sysops) may make
Demonstration Copies of ZipStream available for down loading only as long as
the above conditions are met.  An overall or time-dependent charge for the use
of the bulletin board system is permitted as long as there is not a specific
charge for the down load of the Demonstration Copy of ZipStream.

b. Vendors of user-supported or Shareware software approved by the ASP may
distribute the Demonstration Copy of ZipStream, subject to the above
conditions, without specific permission.

Non-approved vendors may distribute the Demonstration Copy of ZipStream only
after obtaining written permission from Carbon Based Software.

USE OF THIS PRODUCT FOR ANY PERIOD OF TIME CONSTITUTES YOUR ACCEPTANCE OF THIS
AGREEMENT AND SUBJECTS YOU TO ITS CONTENTS.


ΓòÉΓòÉΓòÉ 5. Limited Warranty ΓòÉΓòÉΓòÉ

Carbon Based Software guarantees your satisfaction with this product for a
period of 90 days from the date of original purchase.  If you are dissatisfied
with ZipStream within that time period, you must inform Carbon Based Software
in writing before the expiration of the warranty.

Carbon Based Software warrants that all disks (if provided) are free from
defects in material and workmanship, assuming normal use, for a period of 90
days from the date of purchase.

Carbon Based Software warrants that ZipStream will perform in substantial
compliance with the documentation supplied with the software product.  If a
significant defect in the product is found, Carbon Based Software will attempt
to rectify the problem.  If Carbon Based Software does not provide a remedy,
the Purchaser may return the product for a refund.  In no event will such a
refund exceed the purchase price of the product.

DISCLAIMER

EXCEPT AS PROVIDED ABOVE, Carbon Based Software DISCLAIMS ALL WARRANTIES,
EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, WITH RESPECT TO THE
PRODUCT.  SHOULD THE PROGRAM PROVE DEFECTIVE, THE PURCHASER ASSUMES THE RISK OF
PAYING THE ENTIRE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION AND
ANY INCIDENTAL OR CONSEQUENTIAL DAMAGES.

IN NO EVENT WILL Carbon Based Software BE LIABLE FOR ANY DAMAGES WHATSOEVER
(INCLUDING WITHOUT LIMITATION DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS
INTERRUPTION, LOSS OF BUSINESS INFORMATION AND THE LIKE) ARISING OUT OF THE USE
OR THE INABILITY TO USE THIS PRODUCT EVEN IF Carbon Based Software HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Some states do not allow the exclusion or limitation of incidental or
consequential damages, so the above limitation or exclusion may not apply to
you.

USE OF THIS PRODUCT FOR ANY PERIOD OF TIME CONSTITUTES YOUR ACCEPTANCE OF THIS
AGREEMENT AND SUBJECTS YOU TO ITS CONTENTS.


ΓòÉΓòÉΓòÉ 6. Introduction ΓòÉΓòÉΓòÉ

What is ZipStream ?

ZipStream is an exciting new concept in automatic file compression, that
harnesses the power and features of OS/2 2.1, 2.11, Warp Version 3 and higher.

ZipStream is an OS/2 Installable File System (IFS) that mirrors access to
existing OS/2 File Systems simultaneously providing automatic transparent file
compression and decompression.

The ZipStream Concept

To further understand the ZipStream concept, consider the following scenario.

You have an existing OS/2 system with the file letter.doc in the root directory
of the C: drive.

ZipStream is installed and drive C: is mirrored as compressed drive X:.  This
is achieved using the ZSAttach utility as follows:

zsattach x: c:\

Access to all files on drive C: is now possible simultaneously via drive X:.
i.e.  The commands

type C:\letter.doc

and

type X:\letter.doc

will achieve the same results.

Now letter.doc  is compressed with the ZipStream file compression utility
ZSPack as follows:

zspack c:\letter.doc

Typically, a text file like letter.doc will be reduced in size by at least 50
percent.  Compression ratios of around 80 percent can generally be expected on
large text files.

Access via C:\letter.doc will reveal its compressed contents, but access via
X:\letter.doc will allow access as if the file is uncompressed. That is,
ZipStream recognises that the file is compressed and transparently decompresses
it.

Transparent Background Compression

Any new files copied to a ZipStream compressed drive will be automatically and
transparently compressed in the background.


ΓòÉΓòÉΓòÉ 7. Installation Instructions ΓòÉΓòÉΓòÉ

Installing ZipStream is easy.  You use the Device Driver Install feature that
comes with OS/2.

To get started, proceed as follows:

1. Insert the ZipStream diskette in your A: drive.

2. Now open your OS/2 System folder    or

3. Then open the System Setup folder    or

4. Start the Device Driver Install utility    or

5. Click on the Install button and wait for the ZipStream installation to
complete.

Note:  ZipStream will always install to the \cbased directory on the OS/2 boot
partition.  Installation to the boot partition is required to ensure correct
Installable File System (IFS) initialisation.

6. For a first time installation, you will be prompted to enter your two part
ZipStream registration number.  The two numbers you need are supplied with the
packaged product.  Enter the two numbers into the entry fields provided and
then click on the OK button.  Click on Cancel if you are not registering at
this time.  In this case you can register later using the ZipStream
Registration Utility.

7. After the installation is complete, click on the Exit button in the Device
Driver Install window.

8. The process of installing ZipStream requires you to now reboot your system
for the changes to take effect.

9. Shutdown your system in the standard way (i.e.  from the Desktop, DO NOT
Ctrl-Alt-Del).

When your system restarts, the ZipStream File System will be loaded.

You will then be able to compress files and access them again transparently.


ΓòÉΓòÉΓòÉ 8. Features ΓòÉΓòÉΓòÉ

ZipStream is an exciting new concept in automatic file compression which takes
full advantage of OS/2's power, features, functions and reliability.

ZipStream's Features:

Supports HPFS and FAT File Systems.

Any OS/2 supported file system can be utilised.

Supports Diskettes.

Diskettes don't have to be specially formatted, just attach and compression is
available.

Supports LAN File Systems.

Any LAN file system that is mapped as a drive letter can be used with
ZipStream.  Additionally, there are no Server overheads as all compression
operations are performed by the work station.

Supports CD-ROM File Systems.

If you have the facility to write your own CD-ROM's, you can compress the files
first and then achieve at least double the storage capacity of the CD-ROM
transparently.

Supports Long File Names and Extended Attributes.

No restrictions are imposed other than those imposed by OS/2's native File
Systems.  Fully supports Extended attributes and is compatible with OS/2's
Workplace Shell.

Automatic Compression of New Files.

Newly created files or any files copied to the compressed drive letter are
automatically and transparently compressed.

File Based Compression not Disk Based.

Being file based, you have complete control over what files are compressed and
what files are not. That is, uncompressed files can reside on the compressed
drive.

Ultra High Compression Ratios.

The use of state of the art 32 bit implementation and background compression
techniques, achieves compression ratios equal to that of popular archiving
programs.

Native OS/2 32 bit Application.

This isn't a port of a DOS compression application, it has been built
specifically for OS/2 and designed to fully utilise the features of OS/2.

No Reformatting Required and No Container Files.

Just attach to a drive letter or path and compression is available.  Using
existing File Systems means reliability.


ΓòÉΓòÉΓòÉ 8.1. Technical Features ΓòÉΓòÉΓòÉ

ZipStream's advanced design comes loaded with technical features, as follows:

High Performance Multi Threaded Design

ZipStream exploits OS/2's pre-emptive multi threaded processing capabilities,
giving you outstanding performance in automatic file compression.

ZipStream utilises OS/2's multi threaded features for read-ahead, write-behind
and priority based compression processing.

Advanced 32 bit Implementation

ZipStream is a state of the art Object Orientated 32 bit implementation that
allows for optimal complex processing, while coexisting harmoniously with OS/2
as a native 32 bit application.

Compatible with and Exploitation of OS/2s' HPFS and Advanced FAT File Systems

ZipStream uses existing OS/2 File Systems.  It has been specifically optimised
to operate these File Systems in the most efficient manner i.e. ZipStream is
aware of and takes advantage of the HPFS caching strategy.

Additionally, compressed files can be easily transported to other systems in
compressed format by simply referencing them via the host drive letter.

File Name and Size Sensitive Compression Algorithm Selection

ZipStream, being a file system, has intimate knowledge of a file's parameters
and, as such, can apply optimum algorithms on a per file basis. i.e.  ZipStream
applies different caching strategies depending on the file size/type and may
also apply different compression algorithms depending on the file name and
contents.

Additionally, ZipStream treats each file on an individual file basis.
Therefore, every file may be processed with different compression options and
parameters as specified by the user.

This allows greater flexibility in the management of your system. e.g.
Infrequently accessed files may have maximum compression applied at a slightly
greater cost in access time, while frequently accessed files may have less
compression applied, thus increasing access performance.

Large Sparse Virtual Memory Utilisation

ZipStream implements a Virtual File Cache that utilises OS/2's powerful 32 bit
Flat Memory System to keep entire files uncompressed in memory.

This Virtual Memory File capability allows performance sensitive applications,
such as games etc, near instant access to uncompressed data.

In-situ Compression (No Container Files)

ZipStream uses in-situ compression.  That is, the file being compressed is
replaced in the standard file system with a compressed version.  It can then be
referenced via a ZipStream drive as uncompressed data again, or it can be
inter-actively uncompressed again with a ZipStream utility.

This means that compressed files may be easily transported in compressed
format, and additionally, you don't have the usual worries of container files
suddenly becoming corrupt.

Configuration and Compression Options that Cater for the Most Demanding
Environments

ZipStream provides a variety of compression options and configuration settings
so it can be tailored to your particular needs and expectations.

Compression options are configurable on a per file basis, allowing you the
greatest possible flexibility.

Network Capable with ZERO File Server Overhead

ZipStream is fully capable of providing compression operations on network
paths.  This is achieved on the work-station side of the network.

This means that files can be stored compressed on a File Server and then
accessed as uncompressed at the work-station.

The real bonus is that there is ZERO Server overhead (the Server does not have
to do the compression or decompression), and since the Server will be
processing less data (as it is compressed), the server performance may actually
increase.

Note:  A licensed copy of ZipStream must be on all work-stations that wish to
access compressed data.

Zero Write and Create Overhead.

ZipStream imparts ZERO overhead on file create and write operations, as the
compression operation is relegated to a write behind thread running at low
background priority.

Besides the immediate benefit of completely removing any compression overhead,
ZipStream can now spend longer on the actual compression operation. This
ability to simultaneously compress files and maintain performance levels
results in a much higher compression ratio than can be achieved by other
systems, that because of their synchronous operation must sacrifice compression
in order to maintain performance.


ΓòÉΓòÉΓòÉ 8.2. Safety Features ΓòÉΓòÉΓòÉ

ZipStream's  primary design and implementation goal is to deliver an 'on the
fly' compression system for OS/2 that is safe and reliable.

To accomplish this, ZipStream has the following safety features as part of its
design:

No Container Files

ZipStream uses in-situ compression.  That is, the file being compressed is
replaced in the standard file system with a compressed version.  It can then be
referenced via a ZipStream drive as uncompressed data again, or it can be
inter-actively uncompressed again with a ZipStream utility.

The safety benefit of this is three fold:

1.  As each file is processed individually, any failure of the ZipStream
    compression system will be limited to the one file, unlike a container
    system where any failure of the container compression system could result
    in a catastrophic loss of data.

2.  As ZipStream uses standard OS/2 File Systems, it benefits from the years of
    File System technology and reliability that have been designed into OS/2.

3.  In the event of some type of system failure where the system can no longer
    boot, files compressed with ZipStream can be interactively decompressed
    with a small standard ZipStream utility (ZSUnpack).  This means, when you
    are in a situation where you are unable to get your system running well
    enough to use the transparent ZipStream compression system, you can
    decompress your files on your system, or take them to another system where
    they can be decompressed.

No Direct Disk Access

ZipStream never makes direct physical disk access to any of the OS/2 File
Systems.  All accesses to files are done via the standard OS/2 File System
application programming interfaces.  The benefit here is that as ZipStream only
uses standard OS/2 interfaces, any failure on ZipStream's behalf will benefit
from the in-built protection afforded by OS/2's design.

In simpler terms, this means that it is practically impossible for ZipStream to
damage an OS/2 File System.

Object Orientated Design

ZipStream uses state of the art Object Orientated techniques, and other
sophisticated design practices to ensure safe and reliable operation.


ΓòÉΓòÉΓòÉ 9. System Requirements ΓòÉΓòÉΓòÉ

If your system is running OS/2 2.1, 2.11, Warp Version 3 or higher, you can
take advantage of ZipStream.

If you are still unsure, ZipStream has the following requirements:

Requirements

1.  A PC that is running OS/2 2.1, OS/2 2.11, OS/2 Warp Version 3 or higher.

2.  At least 4 MB of RAM, 8 MB recommended, 16 MB optimal.

3.  At least 10 MB of swap area is recommended (see below for more information
    on Swap Requirements).

4.  A 386 (or better) CPU, 486 highly recommended, Pentium outstanding.

Recommendations

1.  ZipStream excels on 486's with 16 MB of RAM and for that matter, so does
    OS/2.

2.  ZipStream has been designed to take advantage of 486 (and better) CPU's,
    and ZipStream's Virtual File Cache performs best when there is plenty of
    RAM.

The benefit of these recommendations is that ZipStream gives access performance
to compressed files as if they were not compressed.  For example, after a small
initial access delay to game files, games will play with no noticeable
degradation in performance.

Swap File Requirements

ZipStream is designed to give fast access to files by trying to keep as many of
the current set of files decompressed in memory as possible in its Virtual File
Cache.

Note:  ZipStream's behaviour is highly configurable in this area.

On systems with low amounts of RAM, ZipStream will utilise Swap Space to keep
uncompressed information available for ready access.  More memory means less
Swap requirements and faster access.  More files being concurrently accessed,
means more memory requirements.

Of course, the Swap Space requirements are easily reclaimed MANY times over by
keeping your files compressed with ZipStream.


ΓòÉΓòÉΓòÉ 10. Using ZipStream ΓòÉΓòÉΓòÉ

Once you have installed ZipStream, you can begin to take advantage of it at
your own pace.

One of the best ways to start is to compress files that you use infrequently,
as this will more than likely free up a lot of space quickly.  Most of us tend
to hoard old applications (and big games) etc. just in case, and that's why you
are now using an automatic compression program to increase the capacity of your
disk system.

To begin with, use the ZSAttach utility to provide mirrored access to your C:
drive as say the H: drive. You enter at the command prompt:

zsattach h: c:\

Now all the files that you can access via the C: drive are accessible via the
H: drive.

You could have specified a more specific path to ZSAttach, such as

zsattach h: c:\games

but, to begin with, we recommend complete drive mirroring to keep things
straight forward and simple.

As a quick experiment, execute the following command (now that you have C:
mirrored as H:).

zspack c:\readme

Now the OS/2 readme file is compressed.  You can view it again by executing the
command

type h:\readme

At your own pace start compressing more files and in the future reference them
again via drive h:

Any new applications etc. you load or any new files you create on drive h: will
be automatically compressed.


ΓòÉΓòÉΓòÉ 10.1. Compressed versus Actual File ΓòÉΓòÉΓòÉ

The most important thing to keep in mind when using ZipStream is to remember
that the files on the ZipStream path are actually files on a standard OS/2 File
System drive.  There are not physically two copies of the file, only the one.
You should therefore not think that as you can now access the files from the
ZipStream path, they can be deleted on the standard OS/2 path.


ΓòÉΓòÉΓòÉ 10.2. Access by Compressed or Actual Path ΓòÉΓòÉΓòÉ

Sometimes it can be confusing if you continue to access files from both the
compressed (mirrored)  and standard paths.  If you attempt to access compressed
files on the standard path, you will get errors of some kind or another.  As
you can access both compressed and uncompressed files on the compressed path,
we recommend that you do the majority of your accessing via the compressed path
only.  If you adopt this strategy, you will find a lot less confusion taking
place.


ΓòÉΓòÉΓòÉ 10.3. Background Compression ΓòÉΓòÉΓòÉ

If you are copying a lot of files to a compressed path, the background
compression system will tend to lag behind.  That is, ZipStream will have many
outstanding compression tasks not yet completed.  There is no problem with
this, as this is the way ZipStream is designed to operate.  You may look at
files and see that they are not compressed yet.  This is quite normal as the
compression operation needs time to catch back up.  We highly recommend that
you use the ZipStream Monitor  program so that you can be aware of the
background operations taking place.

Note:  You can use the files immediately even thought they are still queued for
compression.

When the background compression operation gets well behind, it will attempt to
rectify this situation by boosting its own priority slightly.  This means that
you may notice a small drop in system performance as ZipStream tries to catch
up.

If you need the outstanding compression operations to complete in the shortest
possible time, you can use the ZipStream Sync  utility to provide a significant
boost to the background compression priority.


ΓòÉΓòÉΓòÉ 10.4. Games ΓòÉΓòÉΓòÉ

In most cases ZipStream is completely compatible with all games that can be run
by OS/2.

Normally there can be a small delay as the games are started, but then as the
game files are virtualised, performance should return to normal and may
actually improve.

If a game is very slow to load or is suffering performance problems when
compressed, then try recompressing the files with the Warp 4 or Warp 7 option
e.g.

zsunpack *.*

zspack -w7 *.*

This option will in most cases remove any performance problems, but will tend
to increase the Swapper file space requirements.


ΓòÉΓòÉΓòÉ 10.5. When Not to use ZipStream ΓòÉΓòÉΓòÉ

We have tried to make ZipStream as general purpose and easy to use as possible
and we are continually providing improvements.  For the most part anything you
can do now can be done safely with ZipStream providing a compression benefit.
There are however, some limitations to its operation.

Device Drivers

Do not compress or store OS/2 device drives on a ZipStream path.  The reason
for this is that OS/2 loads device drivers prior to the loading of File
System's during the OS/2 boot sequence.  This means, that when OS/2 tries to
load the device driver, the path and de-compression system will not yet be
available to OS/2 and subsequently the load will fail.

It is most important to realise that even if the file is not compressed, it
still will not load, as the path provided by ZipStream will not be available
when OS/2 loads device drivers.

OLTP Systems

Do not use ZipStream to compress large database files (i.e. over say 10MB) for
Online Transaction Processing Systems (OLTP).  The reasons for this are as
follows:

1.  ZipStream utilises background compression and will get well behind the OLTP
    system, making it rather ineffective.

2.  ZipStream tries to keep whole files in its Virtual File Cache for
    performance reasons, but if a file is being updated continually, the cache
    will be continually flushed, which negates its performance benefits.

3.  Large database systems like these are always better off implementing their
    own specific compression system, as a database, by its very nature,
    understands the data content, and can apply a more effective compression
    algorithm than a general purpose compression system.


ΓòÉΓòÉΓòÉ 11. Shutting Down ΓòÉΓòÉΓòÉ

NEVER JUST TURN YOUR SYSTEM OFF

Always shut your system down from the Desktop.

By shutting down from the Desktop you will ensure that:

1.  Any new or altered files that were being compressed in the background will
    continue to be compressed and saved before the system is stopped.

2.  ZipStream is shutdown correctly which in turn will ensure that any changed
    configuration information is preserved.

3.  ZipStream is idle at shutdown, ensuring the most reliable operation of your
    system.


ΓòÉΓòÉΓòÉ 11.1. The Shutdown Process ΓòÉΓòÉΓòÉ

During the shutdown process, ZipStream will display an Information Window
informing you that it is shutting down.

If there are any remaining compression jobs outstanding, the window will show a
count of the jobs and will continually update this counter until all jobs have
been completed.

During this process, ZipStream's compression system will receive a boost in
priority to cause these operations to be completed in the shortest possible
time.


ΓòÉΓòÉΓòÉ 11.2. Using Ctrl-Alt-Del ΓòÉΓòÉΓòÉ

We strongly recommend that this method of shutdown is used only when OS/2 fails
to shutdown in the normal manner, or for some reason the Desktop is no longer
accessible.

ZipStream will sense this event and close all open files and abort any
operations that may have been in progress, before allowing the system to stop.

This ensures the safe and reliable operation of your system.

Note:  Using Ctrl-Alt-Del may cause files that were queued to be compressed, to
remain uncompressed.  However, no damage to the files should occur.


ΓòÉΓòÉΓòÉ 12. Utilities ΓòÉΓòÉΓòÉ

ZipStream is supplied with various utilities to supplement the transparent
compression system.

Access to Utilities

To access the ZipStream utilities, open the ZipStream folder

Many of the utilities can operate via Drag and Drop as well as operate on a
command line basis.

Utilities are supplied to:

Note:  Command line program names are shown in parentheses where applicable.

1.  Compress Files (ZSPack).

2.  Decompress Files (ZSUnpack).

3.  Attach to OS/2 Directories (ZSAttach).

4.  Monitor ZipStream status.

5.  Wait for compression to complete (ZSSync).

6.  Query Compression status of files (ZSQuery).

7.  Register ZipStream.

8.  Control Panel.


ΓòÉΓòÉΓòÉ 12.1. ZipStream Attach ΓòÉΓòÉΓòÉ


The ZipStream Attach utility is used to

1.  Make the ZipStream connection with other file systems.

2.  Display a current ZipStream connection.

3.  Cancel a current ZipStream connection.

4.  Display all current ZipStream connections.

5.  Reattach persistent connections.

Note:  After connections have been made, they remain persistent across system
boots.

We recommend that you setup some standard connections as soon as you start
using ZipStream and stick with these connections from then on.


ΓòÉΓòÉΓòÉ 12.1.1. Attaching to an OS/2 Path ΓòÉΓòÉΓòÉ

To attach a ZipStream drive letter to an OS/2 path, run the ZSAttach command
from an OS/2 command prompt with the first argument specifying the Drive letter
you wish to use, and the second argument specifying the OS/2 path that you wish
to attach to.

e.g. ZSAttach Drive_Letter  OS/2_Path

Drive_Letter may be any free or unassigned OS/2 drive letter.

OS/2_Path may be any valid OS/2 directory.

Example

You wish to attach the root directory of the C: drive as the ZipStream H:
drive.  You enter at the command prompt:

 zsattach h: c:\


ΓòÉΓòÉΓòÉ 12.1.2. Display Attachment ΓòÉΓòÉΓòÉ

You can have ZipStream report the current attachment path of a ZipStream drive
letter at any time by entering the ZSAttach command, followed by the ZipStream
drive letter you are querying.

e.g.  ZSAttach Drive_Letter

Drive_Letter must be a ZipStream drive letter assigned to an OS/2 directory.

Example

You have a ZipStream drive H: and you wish to determine the directory to which
it is attached.  You enter at the command prompt:

 zsattach h:

ZSAttach reports:

 H: - ZipStream drive mapped to c:\


ΓòÉΓòÉΓòÉ 12.1.3. Removing an Attachment ΓòÉΓòÉΓòÉ

If you wish to discontinue an attachment of a ZipStream drive letter to an OS/2
path, you enter the ZSAttach command with the ZipStream drive letter, followed
by a '/D'.

e.g.  ZSAttach Drive_Letter  /D

Drive_Letter must be a ZipStream drive letter assigned to an OS/2 directory.

Example

You have a ZipStream drive H: connected to the root directory of drive C: and
you wish to cancel the connection.  You enter at the command prompt:

zsattach h: /d


ΓòÉΓòÉΓòÉ 12.1.4. Displaying all Current Attachments ΓòÉΓòÉΓòÉ

To display all current ZipStream attachments, double click on the ZipStream
Attach program object , or run ZSAttach from the OS/2 command prompt with no
arguments.

e.g.  ZSAttach

Example

You have a ZipStream drive H: connected to the root directory of drive C:\ and
ZipStream drive G: connected to D:\.

You enter at the command prompt:

zsattach

ZSAttach reports:

H: - ZipStream drive mapped to c:\

I: - ZipStream drive mapped to d:\


ΓòÉΓòÉΓòÉ 12.1.5. Non Compressed Attachment ΓòÉΓòÉΓòÉ

To attach a Non Compressed ZipStream drive letter to an OS/2 path, run the
ZSAttach command from an OS/2 command prompt with the first argument specifying
the Drive letter you wish to use, and the second argument specifying the OS/2
path that you wish to attach to.

e.g. ZSAttach Drive_Letter  OS/2_Path /N

Drive_Letter may be any free or unassigned OS/2 drive letter.

OS/2_Path may be any valid OS/2 directory.

The /N switch enables Non Compression mode of operation.

Example

You wish to attach the root directory of the C: drive as the ZipStream Non
Compressed H: drive.  You enter at the command prompt:

 zsattach h: c:\ /n


ΓòÉΓòÉΓòÉ 12.1.6. Reattach Persistent Connections ΓòÉΓòÉΓòÉ

If you wish to reattach paths based on the persistent connection database, you
enter the ZSAttach command with the ZipStream drive letter followed by a '/R'
switch.

e.g.  ZSAttach  /R

Example

You have a removable media drive A: that was not loaded during system startup
and is normally connected as ZipStream drive X:.  After you have loaded a
diskette into Drive A: you can issue the following command to cause the
ZipStream connection to be re-established.  You enter at the command prompt:

  zsattach /r


ΓòÉΓòÉΓòÉ 12.2. ZipStream Compress ΓòÉΓòÉΓòÉ

The ZipStream Compress utility is used to interactively compress files, so that
they can be transparently accessed as decompressed files via ZipStream

Note:  Copying files to a ZipStream path will cause transparent background
compression.  ZipStream Compress is not required in this case.

ZipStream Compress can be used in a Drag and Drop manner, or from the command
line.


ΓòÉΓòÉΓòÉ 12.2.1. Drag and Drop Operation ΓòÉΓòÉΓòÉ

For Drag and Drop, just drag a folder or file object from one of the Drives
Disk objects to the ZipStream Compress object  and the contents of that folder
or object will be compressed.

Note:  By default, this operation will not compress sub-directories.  If you
wish to compress sub-directories via this method, you will need to add an '/S'
switch to the objects parameters settings.  Refer to OS/2 help on how to adjust
object settings.


ΓòÉΓòÉΓòÉ 12.2.2. Command Line Operation ΓòÉΓòÉΓòÉ

To operate from the command line, enter ZSPack at an OS/2 command prompt,
followed by the file or directory names that you wish to process.

e.g.  ZSPack filenames options

filenames may consist of OS/2 wildcard characters.

options may be:

/A Always compress files even if they are too small, or no gain is achieved
after compression.

/F Force compression of read-only files.

/I  Ignore safety rules and force compression.  ZSPack will normally not
compress files that are thought to be OS/2 system files so as to ensure that
the system will still boot and operate after compression.  This option will
override this safety feature and should be used with extreme care.

/N No compression - this option is useful when files are targeted for access
from a substituted drive only.

/P Pause after compression operations are completed and wait for a key stroke.

/S Descend the directory tree and compress files with matching specifications
in filenames.

/W Compression Warp Option, see next topic for more detail.

/Z Always compress files even if they appear to be in a foreign compressed
format.


ΓòÉΓòÉΓòÉ 12.2.2.1. Compression Options ΓòÉΓòÉΓòÉ

ZSPack, by default, uses a standard set of compression parameters when
compressing files.  These parameters can optionally be configured by using the
Warp '/w number' option.

Currently Warp values of '2', '3', '4', '5', '6' and '7' may be applied.

Warp 2

Warp 2 has the following effects:

1.  Use sparse virtualisation.

2.  Does not use Grip cache.

3.  Asynchronous recompression if modified.

4.  Use default compression effort.

5.  Use best compression method.

6.  Use auto algorithm selection.

Warp 3

Warp 3 has the following effects:

1.  Use sparse virtualisation.

2.  Files *.exe and *.dll placed in Grip cache for default Grip period.

3.  Asynchronous recompression if modified.

4.  Use default compression effort.

5.  Use best compression method.

6.  Use auto algorithm selection.

Warp 4

Warp 4 has the following effects:

1.  Use sparse virtualisation.

2.  Place in Grip cache for default period.

3.  Asynchronous recompression if modified.

4.  Use default compression effort.

5.  Use best compression method.

6.  Use auto algorithm selection.

Warp 5

Warp 5 has the following effects:

1.  File fully virtualised on open.

2.  Does not use Grip cache.

3.  Asynchronous recompression if modified.

4.  Use default compression effort.

5.  Use best compression method.

6.  Use auto algorithm selection.

Warp 6

Warp 6 has the following effects:

1.  File fully virtualised on open.

2.  Files *.exe and *.dll placed in Grip cache for default Grip period.

3.  Asynchronous recompression if modified.

4.  Use default compression effort.

5.  Use best compression method.

6.  Use auto algorithm selection.

Warp 7

Warp 7 has the following effects:

1.  File fully virtualised on open.

2.  Place in Grip cache for default period.

3.  Asynchronous recompression if modified.

4.  Use default compression effort.

5.  Use best compression method.

6.  Use auto algorithm selection.

The higher the warp value selected, will generally result in higher performance
when accessing compressed files.  This may also cause larger Swapper file space
requirements.

Without a warp option selection, the default selection of Warp 3 will be
applied.  The default method is recommended in most cases.

Warp 2 is recommended for infrequently accessed files or for machines with low
amounts of RAM.

Warp 4, 6, or 7 is recommended for games etc. where access to compressed data
must occur at the fastest possible rate.

Note:  A Warp setting above 4 requires much more system resources for operation
and therefore should only be selected when needed as performance may actually
decrease in constrained or very active environments.


ΓòÉΓòÉΓòÉ 12.2.3. Grip Cache ΓòÉΓòÉΓòÉ

The Grip cache is one form of internal cache that ZipStream utilises to boost
performance.

Basically, a compressed file that has the Grip cache option, will be retained
in the Virtual File Cache memory as uncompressed data for a period of time
after its last access.

The benefit of this is that any subsequent accesses within the Grip time
period, will avoid the decompression delay.

Currently the default Grip period is 1 (one) minute.

It is not recommended to use the Grip cache in all situations as this may
result in very large Swapper file space requirements.

Note:

1.  This cache operates independently to the other ZipStream caches.

2.  The maximum cache size is configurable with the ZipStream Control Panel.

3.  Files are never cached if they have been modified.

4.  Files that have been modified retain their Grip cache option.


ΓòÉΓòÉΓòÉ 12.2.4. Actual versus Effective Compression ΓòÉΓòÉΓòÉ

ZSPack reports both Actual compression and Effective (parenthetical)
compression ratios.

Actual compression ratio is the ratio of the original file size to the final
compressed file size.

Effective compression is the ratio of the amount of disk space used to store
the uncompressed version of the file, compared to the disk space used to store
the compressed version of the file.

The difference between Effective and Actual compression ratios arises as the
disk space is allocated in blocks of bytes, not just bytes as the file size is
measured.

The number of bytes in a block is dependant on the underlying File System.

The HPFS File System always allocates blocks of 512 bytes, while the FAT (DOS)
File System allocates blocks as follows:

ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéPartition Size                ΓöéBlock Size                    Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéLess than 16 Mbyte            Γöé4 Kbyte                       Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéLess than 128 Mbyte           Γöé2 Kbyte                       Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéLess than 256 Mbyte           Γöé4 Kbyte                       Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéLess than 512 Mbyte           Γöé8 Kbyte                       Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéLess than 1024 Mbyte          Γöé16 Kbyte                      Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéLess than 2048 Mbyte          Γöé32 Kbyte                      Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéLess than 4096 Mbyte          Γöé64 Kbyte                      Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ

As ZSPack works on a byte basis and the Disk System works on a block basis, a
difference between Actual and Effective compression can occur.  However, this
difference will generally only be noticed on smaller files.  Obviously then,
Effective compression is what counts, as this represents the true saving in
disk space.

To further illustrate this situation, consider the following scenario:

You have a HPFS partition with a file 'letter.doc' occupying 700 bytes.  This
file is then compressed to 350 bytes.  A 50 percent Actual reduction.

The HPFS File System has a block size of 512 bytes.  Therefore, the file would
have used 2 blocks (1024 bytes) before compression.

After compression, the file would occupy 1 block (512 bytes).  Once again a 50
percent Effective reduction.  In this case the Actual and Effective compression
ratios are the same.

Now consider another file 'letter1.doc' which is 700 bytes in size.  This file
is then compressed to 500 bytes, a 28 percent Actual reduction.

As in the previous case, the number of disk blocks used has been reduced from 2
to 1, a 50 percent reduction.

In this case, the Effective compression is greater than the Actual compression.


ΓòÉΓòÉΓòÉ 12.2.5. When ZSPack will not compress a file ΓòÉΓòÉΓòÉ

There are situations when ZSPack will not compress files.  In these cases it
will report

filename  Skipped: Reason

The possible reasons are as follows (see following topics)


ΓòÉΓòÉΓòÉ 12.2.5.1. Skipped - No net gain achieved ΓòÉΓòÉΓòÉ

This means that after ZSPack has attempted to compress a file, it checks if an
Effective reduction in the disk space utilisation has been achieved.

If none is achieved, then the file is skipped.  In this case compression is of
no benefit.

This situation can occur when the file is small or very low Actual compression
has been achieved.

Example

A file 'letter.doc' occupies 900 bytes, and this is 2 disk blocks in a HPFS
partition.

After compression it is reduced in size to 600 bytes (a 33 percent Actual
reduction).

However, 2 blocks are still required to store the file, so there has been no
effective saving.


ΓòÉΓòÉΓòÉ 12.2.5.2. Skipped - Too small, no effective gain possible ΓòÉΓòÉΓòÉ

This situation occurs when the file is smaller than the File System Block size.

This situation is much more likely to occur on FAT File Systems rather than on
HPFS File Systems, as the block size on a FAT file system is larger than that
of HPFS, and it increases in size as the partition size increases.

Example 1

A file 'letter.doc' occupies 400 bytes, and this is 1 disk block in a HPFS
partition.  Even with compression, the amount of disk blocks used cannot be
reduced.

Example 2

A file 'letter1.doc' occupies 2000 bytes, and this is 1 disk block in a FAT
partition (that is less than 120 MB in size).  Even with compression, the
amount of disk blocks used cannot be reduced.

In this case, a saving could be achieved if the partition used the HPFS File
System.

Override

You can force compression of these files using the '/A' switch e.g.

  zspack /a filenames


ΓòÉΓòÉΓòÉ 12.2.5.3. Skipped - Already compressed by ZipStream ΓòÉΓòÉΓòÉ

This means that the file has already been compressed by ZipStream.  It is not
possible to further compress a file in this way.


ΓòÉΓòÉΓòÉ 12.2.5.4. Skipped -  Already in another Foreign Compressed Format ΓòÉΓòÉΓòÉ

Before ZSPack attempts to compress a file, it checks if the file is already in
a compressed format (i.e.  Zip, Gif etc.).  Generally, very little or no
compression can be achieved on a file that has already been compressed.

You can force compression of these files using the '/Z' switch e.g.

  zspack /z filenames


ΓòÉΓòÉΓòÉ 12.2.5.5. Skipped - OS/2 System File ΓòÉΓòÉΓòÉ

In order to ensure that your system will remain operational, and provide the
greatest possible performance, ZipStream will refuse to compress any file that
is deemed part of the OS/2 system (including OS/2 LAN Server).

You can force compression of these files using the '/F' switch e.g.

  zspack /F filenames

Danger: Overriding this safety feature may disable your system - use with
extreme caution.


ΓòÉΓòÉΓòÉ 12.3. ZipStream Control ΓòÉΓòÉΓòÉ

The ZipStream Control Panel is used configure various ZipStream options.


The Apply push button causes the specified settings to be applied to ZipStream.

The Defaults push button resets the displayed settings to their default values.


ΓòÉΓòÉΓòÉ 12.3.1. Compression Options ΓòÉΓòÉΓòÉ

Compression options allow you to configure ZipStream's compression system.


ΓòÉΓòÉΓòÉ 12.3.1.1. Compress New ΓòÉΓòÉΓòÉ

If checked, ZipStream will compress newly created files.

Having this option not checked is most useful when you wish to manually
compress files with ZSPack to establish your compressed environment and you do
not want any further automatic compression to take place. e.g. You have a Word
Processing program that you compressed with ZSPack, but you do not want any new
files created by the Word Processor to be compressed.


ΓòÉΓòÉΓòÉ 12.3.1.2. ReCompress ΓòÉΓòÉΓòÉ

If checked, ZipStream will recompress compressed files that have been updated.

Leaving this option unchecked will cause compressed files that are updated to
be returned to the uncompressed state.


ΓòÉΓòÉΓòÉ 12.3.1.3. Compress ReadOnly ΓòÉΓòÉΓòÉ

If checked, ZipStream will compress Read-Only Files.


ΓòÉΓòÉΓòÉ 12.3.1.4. Compress Always ΓòÉΓòÉΓòÉ

If checked, ZipStream will compress a file even if no gain is made by the
compression operation.


ΓòÉΓòÉΓòÉ 12.3.1.5. Rename Track ΓòÉΓòÉΓòÉ

If checked, ZipStream will track rename operations so that new or updated files
are compressed.

Normally, most Word Processors and similar programs update a file by writing to
a temporary file and then renaming it to the actual file name.  ZipStream will,
if this option is checked, track these operations to ensure that new or
modified files that are renamed are automatically compressed.


ΓòÉΓòÉΓòÉ 12.3.1.6. DOS Compatible ΓòÉΓòÉΓòÉ

If checked, ZipStream will compress a file using an algorithm that will allow
the file to be decompressed again under DOS in a future version of ZipStream.
Using this mode may reduce the performance and compression efficiency.

The option is currently disabled while design improvements are being
researched.


ΓòÉΓòÉΓòÉ 12.3.1.7. Warp Factor ΓòÉΓòÉΓòÉ

The Warp Factor is a combination Compression Effort, Compression Algorithm and
Caching method selection.

Currently Warp values of '2', '3', '4', '5', '6' and '7' may be applied.

For more information see ZSPack.


ΓòÉΓòÉΓòÉ 12.3.1.8. Effort ΓòÉΓòÉΓòÉ

The Effort setting allows you to trade compression for speed.

The minimum value of 1 favors speed over compression, while the maximum value
of 9 favors compression over speed.

The default value of 3 has been selected to provide the best balance of speed
and compression with a slight favoring towards speed due to the 'on the fly'
nature of ZipStream's operation.


ΓòÉΓòÉΓòÉ 12.3.2. Performance Options ΓòÉΓòÉΓòÉ

Performance options allow you to configure ZipStream's options for performance.
They should not be altered without a detailed understanding of ZipStream's
operation.


ΓòÉΓòÉΓòÉ 12.3.2.1. High Priority ΓòÉΓòÉΓòÉ

If checked, ZipStream's background compression will operate at a higher
priority. Using this mode may reduce the overall performance of your system,
but will ensure that files are compressed quickly.

By default the background compression system will operate at low or background
priority and will have very little effect on overall system performance.
However, in some situations this may lead to a large number of outstanding
compression operations being queued.

Note:  ZipStream uses automatic measures to limit the number of outstanding
compression operations.


ΓòÉΓòÉΓòÉ 12.3.2.2. Search Cache ΓòÉΓòÉΓòÉ

The Search Cache value is the number of Directory entries ZipStream will store
in persistent memory measured in thousands.  More Search Cache normally means
faster operation.

The default value of 8 (8192) entries is optimal for the average system,
however, if you have a very large number of files on a compressed drive you may
want to increase this value.

The minimum value is 4 (4096) and the maximum value is 64 (65536).

Having a very large number of Search Cache entries will have the side effect of
slowing system booting.

Note:  A reboot is required for this option change to take effect.


ΓòÉΓòÉΓòÉ 12.3.2.3. Grip Cache ΓòÉΓòÉΓòÉ

The Grip Cache is a secondary Virtual File Cache that ZipStream uses to
optimise performance.

The size selection is given in MBytes.

Basically, a compressed file that has the Grip cache option will be retained in
the Virtual File Cache memory as uncompressed data for a period of time after
its last access.

The benefit of this is that any subsequent accesses within the Grip time
period, will avoid the decompression delay.

The value selected is only a hint to ZipStream as ZipStream will internally
adjust this value depending on the system configuration.

Currently the default Grip period is 1 (one) minute.

Note:  A reboot is required for this option change to take effect.


ΓòÉΓòÉΓòÉ 12.4. ZipStream Decompress ΓòÉΓòÉΓòÉ

The ZipStream Decompress utility is used to interactively decompress files that
have been compressed with the ZipStream Compress utility.

ZipStream Decompress can be used in a Drag and Drop manner, or from the command
line.

Drag and Drop Operation

For Drag and Drop, drag a folder or file object from one of the Drives  Disk
objects to the ZipStream Decompress object  and the contents of that folder or
object will be decompressed.

By default, this operation will not decompress sub-directories.  If you wish to
decompress sub-directories via this method, you will need to add an '/S' switch
to the objects parameters settings.  Refer to OS/2 help on how to adjust object
settings.

Command Line Operation

To operate from the command line, enter ZSUnPack at an OS/2 command prompt,
followed by the file or directory names that you wish to process.

ZSUnpack filenames options

filenames  may consist of OS/2 wildcard characters.

options may be:

/P pause after decompression operations are completed and wait for a key
stroke.

/S descend the directory tree and decompress files with matching specifications
in filenames.


ΓòÉΓòÉΓòÉ 12.5. ZipStream Monitor ΓòÉΓòÉΓòÉ

The ZipStream Monitor utility is used to monitor the performance and operation
of ZipStream's compression system.  When run it will display a window, as shown
below, that will be continuously updated at approximately 1.5 second intervals.


If this window is hidden or minimised the monitor will display a smaller window
containing compacted information as shown below:


The compacted view reports (in the following order): Outstanding
Files,Compression Ratio, Compression Percentage, Current File.

The ZipStream Monitor main view reports the following information:

Outstanding Files

This is the number of files that are awaiting background compression in
ZipStream.

Rescheduled Files

This is the number of files that have been rescheduled for background
compression in ZipStream.

Files Processed

This is the total number of files that have been compressed by the compression
system since the last system boot.

Bytes In

This is the total number of uncompressed bytes compressed by the compression
system since the last system boot.

Bytes Out

This is the total number of compressed bytes output by the compression system
since the last system boot.

Bytes Saved

This is the total number of bytes saved by the compression system since the
last system boot.

Compression Ratio

This is the overall compression ratio statistic which has been achieved since
the last system boot.  Both Ratio and Percentage information is reported.  A
compression ratio of 50% means that the files have been reduced to half their
original size or a 2:1 reduction.  The higher the value here, the better the
compression system is performing e.g.  67% means that files have been reduced
in size to one third of their original size.

Search Cache

This is the search cache hit ratio statistic, which has been collected since
the last system boot.  The higher the value here, the better the search cache
is performing.  ZipStream's search cache is used to optimise access to files.

Grip Cache

This information provides utilisation information on ZipStream's grip cache.

The grip cache is a part of ZipStream's Virtual File Cache that is used to keep
decompressed files in memory after they are no longer in use in the hope that
the user or application may request the information again shortly. After one
minute the contents of this cache are freed so that the memory can be used for
other purposes and not have a negative impact on system performance.

Normally this utilisation value should be low or zero with infrequent peaks of
up to 75 percent. Should this value be consistently high, you may need to
increase your grip cache allocation via the ZipStream control panel.

Processing File

This is the path name of the current file being processed by the background
compression system.  If no file is currently being processed, then the monitor
will report 'sleeping'.


ΓòÉΓòÉΓòÉ 12.6. ZipStream Query ΓòÉΓòÉΓòÉ

The ZipStream Query utility is used to query files for compression status and
compression ratio information.

ZipStream Query can be used in a Drag and Drop manner, or from the command
line.

Drag and Drop Operation

For Drag and Drop operation, drag a folder or file object from one of the
Drives  Disk objects to the ZipStream Query object  and the contents of that
folder or object will be queried.

By default, this operation will not process sub-directories.  If you wish to
process sub-directories via this method, you will need to add an '/S' switch to
the objects parameters settings.  Refer to OS/2 help on how to adjust object
settings.

Command Line Operation

To operate from the command line, enter ZSQuery at an OS/2 command prompt,
followed by the file or directory names that you wish to process.

e.g.  ZSQuery filenames options

filenames may consist of OS/2 wildcard characters.

options may be:

/N report on non-compressed files only, ignore compressed files.

/P pause after the query operations are completed and wait for a key stroke.

/R print the compression ratio as a ratio and not a percentage.

/S descend the directory tree and query files with matching specifications in
filenames.

/T print a totals report only.

/W "warp factor"  report only for files compressed with the specified warp
factor.

/Y report on compressed files only, ignore uncompressed files.


ΓòÉΓòÉΓòÉ 12.7. ZipStream Register ΓòÉΓòÉΓòÉ


The ZipStream Registration utility is used to register your copy of ZipStream.
The two numbers you need are supplied with the packaged product. Click on
Cancel if you are not registering at this time.

If you do not run the registration utility ZipStream's automatic compression
system will cease to operate after 45 days.  However, the interactive
compression and decompression programs (ZSPack and ZSUnpack) will always
continue to operate.


When the utility is run it will display a window for the entry of the two part
registration number, as shown above.  You should enter the two numbers supplied
with the product and then click on the OK button.

The registration process will take several seconds, and when complete, it will
display a message indicating the success of the operation.  If the operation is
successful, the registration process is complete.  If unsuccessful this means
that you have typed in one of the two numbers incorrectly, and you should
retype them and try again.


ΓòÉΓòÉΓòÉ 12.8. ZipStream Sync ΓòÉΓòÉΓòÉ

The ZipStream Sync utility is used to wait for background compression
operations to complete.  When this utility is activated the background
compression system will receive a large boost in priority so that all the
outstanding compression operations will be completed in the shortest possible
time.


If there are background compression operations, the utility will display a
running counter, as shown above, until all background compression operations
have been completed.

When all operations have been completed, the utility will display a message
box, as shown below.  Click on OK to terminate the utility.


This utility is most useful when files have been written to diskette and it is
not known when all processing has been completed.  When the utility displays
its completion message box you will know it is then safe to remove the diskette
from the diskette drive.


ΓòÉΓòÉΓòÉ 13. Update Policy ΓòÉΓòÉΓòÉ

Registered users can update to new releases of the current version at no cost.

That is, version 1.xx can be updated to any other release of 1.xx at no cost.

Registered users will be offered new versions at a highly discounted rate.

That is version 1.xx can be updated to version 2.xx at very little cost.

Registered users can update across versions at no cost if their registered
version is less than 12 months old.

That is, if you register version 1.xx and version 2.xx becomes available in
less than 12 months, the upgrade would be at no cost.

We will make new releases available on CompuServe and our primary anonymous ftp
site.  Registered users wishing to receive updates by email, post mail, or any
other method, will be required to pay all costs involved (e.g. postage,
communications costs etc.).


ΓòÉΓòÉΓòÉ 14. Support ΓòÉΓòÉΓòÉ

Carbon Based Software provides support services for Registered Users.

ZipStream is supported primarily via CompuServe or Internet email and
additionally in section 1 of the "OS2BVEN" CompuServe forum.  If you wish to
access this forum area type "GO OS2BVEN".

Technical Support

Technical support for ZipStream can be obtained by:

1.  Email to CompuServe ID: 100351,2052

2.  Email to Internet ID: [e-mail]

3.  Fax mail to [phone]

In general, we try to provide a response within 24 hours.

Update Locations

The latest version of ZipStream can be located in the following areas:

1.  Lib 1 of OS2BVEN in CompuServe.

2.  Lib 4 of OS2USER in CompuServe.

3.  Anonymous ftp from ftp://ftp.onthenet.com.au/pub/carbon

4.  World Wide Web from http://www.CarbonBased.com.au

The latest version can usually be found at various Internet Anonymous FTP
sites.


ΓòÉΓòÉΓòÉ 15. Acknowledgments ΓòÉΓòÉΓòÉ

ZipStream has been designed, developed and manufactured in Australia.

Many people and organisations have been invaluable during the development and
testing of ZipStream.

Carbon Based Software sincerely thank:-

Gary Bale, Antranig Basman, Jeanine Bouchard, Rohaini Cain, Chris Eldridge, K.
R.  Fulton & Associates, Scott Garfinkle, Chuck Grandgent, Michael Hagerty,
Greg Hamblin, Ron Hester, Kevin Hine, Bill Hinkle, Bruce Leiwant, Joe
Lindstrom, Ed Lipson, Robert Mahoney, Steve Mastrianni, Greg Mobley, Terry
Norton, Steve Richards, Ed Tomlinson, Mike Vorris, Steven White, Steve
Williams, Samuel Yodaiken, Les Zellan, The IBM Developers Assistance Program
both Australian and World Wide and many many more.

ZipStream was developed and published with the following tools:-

IBM CSet++ V2.1, Zortech C++ V3.0, VisPro C V1.01, Word for Windows V2.0, Corel
Draw V3.0 & V4.0.

We use Golden Commpass teamed with SpellGuard for our CIS access.