Workplace Shell Backup Utility


FOREWORD BY THE AUTHOR - 09/18/92

Changes since 7/4/92
- 32 bit GRE beta level code tested and certified
- Bug workaround when 64K I/O area and enumerate appls
- DosForceDelete used to clear old target dir
- Wait pointer consistant over client area
- Progress indicator added for INI backups
- Enterprise registration now available

Introduction -

Thank you for trying WPSbkup. WPSbkup is a 32 bit utility that will backup
status and configuration data for the OS/2 2.0 general availability (GA)
WorkPlace Shell (WPS). And a special thanks to Olaf Koch for helping resolve
the "where's Waldo" problem with the desktop directory. His grasp of the
obvious managed to dislodge my nose from the bark of the tree.

The OS/2 WPS is the new and exciting object oriented user interface that
accompanies the OS/2 version 2 operating system. When you customize the WPS
to suit your own need and taste, you are modifying two physical elements of
OS/2. These elements are:

- The system initialization (INI) files, OS2.INI and OS2SYS.INI which
reside in the OS2 directory of the boot drive. These INI files contain
the bulk of the system customization information. They are opened for
update immediately after boot. The INI files are accessed through a set
of two indices. Since these files are updated through "random access",
data integrity using a sequential backup method can not be provided while
the INI files are open. WPSbkup uses API calls provided by OS/2 for the
purpose of accessing INI files with integrity. While the performance
trade off is obvious using system API calls, the INI integrity is critical
for the successful operation of your system. Remember that OS/2 is a
multitasking system. Your can do real work while WPSbkup is active.

- The desktop directory structure (DTP) and its associated extended attribute
(EA) data also holds a large amount of your customization data. The DTP
is more visible to you because you directly manipulate its elements using
the OS/2 file system and WPS objective controls. However, much of its
information is really stored in the INI files (see above.) When you drag
a "Program object instance" out of the Templates folder, drop it on the
desktop and fill in execution related information you are interacting with
DTP. However, almost all of the information that records this activity is
maintained in the INI files. WPSbkup records enough information about the
DTP to be able to recreate it in a way that preserves its associations in
the INI files. WPSbkup records the information in a way that allows you
to store the backup data on removable (floppy) FAT formatted media.

IBM has set new standards for quality assurance in a ".0" release level
product. There are nations with fewer citizens than IBM had beta testers
for OS/2 version 2. However, Murphy's Law states, "The item that will cause
the greatest amount of 'redo' is always the first item to fail." IBM has
allowed for this irrefutable law of the computing universe by providing the
new "Alt+F1" procedure that is described in the GA read.me file.

WPSbkup provides an alternative to the Alt+F1 procedure. WPSbkup will provide
backup data for your WPS and create a simple to use WPS restore procedure.
More than likely you will never need to use the restore procedure, but if you
do, it can save you hours of recovery time. WPSbkup backs up only the data
that "personalizes" your implementation of OS2 2.0. WPSbkup has been tested
with both US and National Language releases of OS2 version 2.

WPSbkup can also be used in large organizations to install a standard WPS user
interface for user machine that have identical (or VERY VERY similar) hardware
configurations.



Contents of this package are:

Read.Me - You're reading it right now.
WPSbkup.exe - The Workplace Shell image copy utility.
WipeWPS.exe - Clears out the desktop directorie(s) before recovery.



Installation is pretty darn simple:

Step1 - Copy WPSbkup.exe to a directory that you use to store programs.

Step2 - Copy WipeWPS.exe to one of the boot drive directories named in the
config.sys that is contained on your SYSTEM DISK 1 OF 15. They are:

\ (Root)
\OS2
\OS2\SYSTEM
\OS2\INSTALL <== suggested

Step3 - Add a program entry to any of your folders for WPSbkup.exe. As far
as program settings go, all you really have to specify is path and
file name for where you placed WPSbkup.exe and the name of the
target directory into which Workplace Shell backup data will be placed.

Enter the name of the target directory in the Parameters entry field.
You must specify drive and full path name. (I.e. E:\WPSstore) If this
directory does not exist, WPSbkup will create it when it executes.

TAKE NOTE: WPSbkup.exe owns the target directory lock, stock and
barrel. When it starts execution, it erases all files
and sub-directories contained within its target directory.
So don't specify a directory that holds any files or
sub-directories that you wish to keep.

Executing the backup is as simple as double clicking the icon! WPSbkup.exe
is a well behaved 32 bit PM application. It does its considerable I/O on a
separate thread so that you can close it, minimize it or do other tasks while
it is running. After it completes execution, look at the Read.Me file that is
created in the target directory. This file will tell you exactly what must
be done in the case of a Workplace Shell failure.

Miscellaneous Notes:

1) To receive syntax help for WPSbkup, execute it with no parameters from
an OS2 command prompt.

2) Optional Parameters:

PurgePrompt | NoPurgePrompt - allows suppression of the confirmation
message box that warns of the erasure
of files and sub-directories in the
backup target. Default is PurgePrompt.
Be advised that WPSbkup is running when
the WPS status is stored. That means
that if you have to restore, WPSbkup will
be initiated for execution. If you use
the NoPurgePrompt parameter, a superfluous
backup will be taken when you reboot after
a restore.

TestVer2Rev | NoTestVer2Rev - allows suppression of the check made for
CSD XR02000_ or CSD XR02010_. Use this
parameter if you have more current
maintenance and are sure that this backup
procedure will still work with your
revision. Default is TestVer2Rev.

3) Make the target directory disk resident. If you write to floppy, the
backup of the system INI files may not complete in your lifetime. It
would be prudent to use a drive other than your OS/2 boot drive.

4) Many checks are made to insure that you will be notified if valid backups
are not created. However, image copies are created and the GIGO (garbage
in / garbage out) rule applies. Therefore, make sure that you are running
cleanly before you write over backup data with a new backup. Try to use
a rotating target directory methodology so that you can maintain a valid
-1 backup should the current backup data prove to be damaged.


================== SUPPORT SHAREWARE =====================================

I hope you find this utility helpful, but (here comes the disclaimer) I am
in no way responsible for any damages the use of this utility may cause.
You are free to use this utility at your own risk with no obligation to me,
the author, for only a short period of time.

This backup utility will allow 15 trial executions. Then it will "time out."
If WPSbkup is helpful to you or your organization, you should register it.
The registration fee for individuals is $15 (US). The site registration fee
for corporate entities is $150 (US). Finally, an enterprise registration is
available for organizations with more that ten branches or offices. The
enterprise registration fee is $1500 (US).

Please state the file date of WPSbkup.exe that you currently have (if any)
in your registration letter.

Please send registration fees to:

Dave Lester
PO Box 461
New Freedom, PA. 17349 USA

Comments, suggestions and bug reports may be submitted through CIS Mail
ID 75600,237. These will be answered on a "best effort" basis.