
README for WarpIN

May 3, 1999

(C) 1998-99 Jens Beckmn, Ulrich Mller


INTRODUCTION
============

Welcome to the fourth alpha version of WarpIN.

There has been significant progress since Alpha #3, but we're
still not quite done yet.

The following was added with Alpha #3:

--  Compression/decompression. We're now using the zlib library
    which works just beautifully.

--  Lots of error checking. Files are checked for existence
    before they are overwritten, most other error conditions
    should be handled well also. If all goes wrong, there is
    a sophisticated exception handler too.

--  The front-end sources have been cleaned up big time. There
    is now a clean separation between the string logic (for the
    install script) and the PM display stuff. There is no more
    string parsing in the PM part (gui.* files), so this can
    more easily be replaced.

--  There is readable documentation in INF format now.
    PLEASE READ IT before asking any questions.


And these are the news for Alpha #4:

--  There are now two INFs: one for the user, one for the programmer.

--  The global database is working!! This was a %&$ of work...
    This means that de-installing packages should be working now.

--  Creating WPS objects, CONFIG.SYS manipulation, WPS class management,
    and macro resultion implemented!
    Check the PCK tag reference in WPI_PROG.INF for details.

--  Better "File exists" dialog.

--  Multiple packages are now supported.

--  Added environment variable support for CID installation.

--  WIC.EXE can now update packages and set install scripts independently
    (as far as I've tested this). Phh...

--  Most strings that WarpIN displays have now been exported to the resources
    and MSG file to support NLS. This will probably still change however, so
    don't attempt any translating at this point. There's still no NLS for
    the install script error messages, and I don't know yet whether there'll
    ever be.

In contrast to what the INF file might say, the following things
are _not_ implemented or working yet (there may be more):

--  system/readonly files cannot be overwritten, DLL/EXE files cannot be unlocked if in use

--  "external" packages which are not in the archive

--  WARPIN and TITLE tags not yet recognized

--  calling user REXX scripts (EXECUTE attrib of PCK tag)

--  GROUP tags probably don't work either, I haven't had time to test this.

--  When an archive has already been installed, it cannot be removed
    in "Add/Remove" mode yet.

--  Package dependencies (REQUIRESID attrib of PCK tag) not implemented.

--  Not all environment variables are evaluated yet.

But we're working on this. ;-)

Ulrich Mller


FILE DESCRIPTIONS
=================

Files in this directory:

--  COPYING: the GNU General Public Licence (GPL), under which
    WarpIN is released.

--  *.cmd: demo scripts for creating test archives. See notes below.

--  *.wis: demo install scripts for the *.cmd archive creator scripts
    of the same filestem.

--  warpin.exe: the actual installer. This needs a WarpIN archive
    on the command line. You best create a program object for this
    and associate it with "*.WPI" files.

--  warpin.inf: "WarpIN Programmer's Guide and Reference."

--  warpin.msg: NLS support for WarpIN. (Well, not quite yet.)
    Must be in the same dir as warpin.exe.

--  warpin.sym: symbol table created by MAPSYM.EXE in case WarpIN
    crashes.
    Must be in the same dir as warpin.exe.

--  wic.exe: the "WarpIN Archive Creator". Explains itself on the
    command line.

The subdirectories contain the source code.


TESTING WARPIN
==============

*** Updated for Alpha #4

I have added a small script called "apps.cmd" which creates
a test archive in your \OS2\APPS directory on your boot drive,
containing a few of the programs that come with OS/2.
This will of course only create the archive, not delete any files.

The sample archive will have three packages and an install script
which can create WPS objects and modify CONFIG.SYS.

----> WARNING 1: This is the first alpha which messes with CONFIG.SYS.
                 From my experience, the system still boots after
                 WarpIN has modified CONFIG.SYS, but WATCH OUT.
                 WarpIN will create a backup copy of your CONFIG.SYS
                 file called CONFIG.xxx with "xxx" being a three-digit
                 number, but please, please, make a backup copy of
                 CONFIG.SYS yourself before installing the archive,
                 you never know.

Then create a program object for WARPIN.EXE, associate it with
*.WPI files, and double-click on \OS2\APPS\APPS.WPI to test
the installer. There you go.

----> WARNING 2: This thing requires about 3 MB of free space on your
                 boot drive. WIC.EXE still has no error checking in
                 this respect,  so beware.

----> WARNING 3: Do not enter any OS/2 system directories for the package
                 installation paths. This is an alpha version, and if you
                 overwrite your system DLL's, that's your own fault.
                 Use some new directory instead, e.g. the default J:\TEST.

LICENSE, COPYRIGHT, DISCLAIMER
==============================

    Copyright (C) 1998-99 Jens Bckman, Ulrich Mller.

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as contained in
    the file COPYING in this distribution.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


CONTACT
=======

    Depends. ;-) See any of the INF files.

