
                DOCUMENTATION FOR WPS BACKUP v1.40
                ----------------------------------

   Changes since version 1.30:
   ---------------------------
   1. TCPSTART.CMD is now backed up if you have TCP/IP installed, and
      if the file is in the \TCPIP\BIN directory of your OS/2 boot
      drive.
   2. Bug which caused certain files not to be backed up if there is
      insufficient disk space fixed.

      Please read this documentation carefully.


   INTRODUCTION
   ------------
   Although OS/2 is a wonderful operating system, it is far from
   perfect, and it is not as crash-proof as some would have us
   believe. In addition, many activities (for example, installing
   drivers for new devices or even simply changing screen drivers)
   are fraught. Many users, including myself have had to go through
   the process of reinstalling OS/2, as a result of something going
   wrong when changing screen drivers. Re-installation itself is
   relatively painless (if you are doing it from a supported CD-ROM).
   However the pain of losing all your weeks and months of
   customisation of the OS/2 Desktop and Work Place Shell (WPS) is
   much more significant.

   What this package does is to provide a very simple way of backing
   up and restoring your OS/2 Desktop and WPS settings. The executables
   can be run either with command line parameters (each of them only
   takes 2 parameters) or in an interactive mode. Both of the
   executables are run from an OS/2 command prompt.


   NOTE: This program has only been tested on OS/2 v2.1. It should work
   also for later versions, but may not work with earlier versions.


   INSTALLATION
   ------------
   The package consists of the following files;

      1. WPS-BACK.EXE   - executable to back up the WPS and Desktop
      2. WPS-REST.EXE   - executable to restore the back up
      3. README.DOC     - this file

   There is no special produre for installation. Just copy the files
   WPS-BACK.EXE and WPS-REST.EXE into a directory which is in your
   OS/2 program path.


   --------------
   | BACKING UP |
   --------------

   The back up is processed by running WPS-BACK.EXE.

   The best method of performing the back up is to run WPS-BACK.EXE
   when the WPS is not active. There are 2 ways of achieving this.

   Either;

   1. Booting from an OS/2 boot floppy (this is tedious and time
      consuming),

   or

   2. Adding the line "CALL=C:\OS2\CMD.EXE" as the LAST line in your
      CONFIG.SYS file. This opens up a full screen OS/2 session upon
      boot up. From there you can run WPS-BACK.EXE and also perform
      any other maintainance duties before typing "EXIT", which will
      then cause the boot up into the WPS to be completed.

      This is the easiest method, and is advisable, even if you are not
      using this package at all.

    However, you can still run WPS-BACK.EXE (but not WPS-REST.EXE) from
    your OS/2 Desktop, by creating a WPS program object for it.

    WPS-BACK.EXE takes 2 parameters (there is an optional 3rd parameter
    for non-English language versions of OS/2 v2.1, and an optional
    4th parameter for "quick" backups);

    1. Your OS/2 boot drive
    2. The floppy disk drive that you want to back up to.


   Thus the syntax is;

   WPS-BACK <os2 drive> <destination drive> [os2 desktop directory] [/Q]


    Examples;

    WPS-BACK D: A:             (backs up from drive D: to drive A:)
    WPS-BACK C: A:             (backs up from drive C: to drive A:)
    WPS-BACK C: A: /Q          (backs up from drive C: to drive A:)
                               (but does not pause for any confirmation)

    WPS-BACK C: A: C:\OS2_!SYS (backs up from drive C: to drive A:)
                               (the OS/2 Desktop directory is not)
                               (called "C:\DESKTOP", but "C:\OS2_!SYS")

    WPS-BACK C: A: C:\OS2_!SYS /Q
                               (backs up from drive C: to drive A:)
                               (the OS/2 Desktop directory is not)
                               (called "C:\DESKTOP", but "C:\OS2_!SYS")
                               (It does not pause for any confirmation)

    That is it!

    If you run WPS-BACK without any parameter (or with less than 2
    parameters) the program goes into an interactive mode, and asks
    you for your OS/2 boot drive, and the target drive. You can stop
    at these stages, by just pressing ENTER.

    For safety's sake, you are given 1 chance to stop the back up
    process, by pressing CTRL-Break (note that if you press CTRL-Break
    at the stage when you are asked to insert a floppy disk, the
    program will not backup the desktop directory, but will still backup
    the other files).

    If you decide to go on with the backup, WPS-BACK then does some
    checking, and finally starts the backing up.

    When the back up has started (if you run it from the Desktop) you
    can start to do other things, and it will run in the background.

    * NOTES *:
    ----------
       The 3rd parameter is only needed if your OS/2 Deskop
       directory is NOT called "\DESKTOP". This is the case with some
       non-English language versions of OS/2, and it is also the case
       with OS/2 v2.0. Some people with OS/2 version 2.1 have renamed
       their desktop directory. They also will need to supply the third
       parameter.

       If in doubt, just run WPS-BACK.EXE with no parameter, and the
       interactive process will ask you all the necessary questions.


    THE /Q OPTION
    -------------
    If you use the "/Q" option, the following consequences ensue;
      1. Everything goes on without any intervention from you.
      2. You will not get a chance to back out.
      3. You MUST specify your os/2 drive, and your destination drive.
      4. The /Q switch MUST be the LAST parameter.
      5. Your backup (floppy) disk must already be in the drive BEFORE
         you start.

    This option is useful if you want to put the program in your
    STARTUP folder, or you otherwise wish to run it unattended.

    Note that the /Q option is only valid for WPS-BACK.EXE. You
    cannot use it when restoring, and I will NEVER implement it in
    the WPS-REST.EXE program.


    WHAT IS BACKED UP?
    ------------------
    The following are backed up;

      1. The \Desktop directory on the OS/2 boot drive
      2. OS2.INI
      3. OS2SYS.INI
      4. CONFIG.SYS
      5. AUTOEXEC.BAT   (if it exists)
      6. STARTUP.CMD    (if it exists)
      7. TCPSTART.CMD   (if it exists in <os2drive>\TPCIP\BIN

     If you have Win-OS/2 installed, you will have to back up your
     Win-OS/2 INI files manually.


   -------------
   | RESTORING |
   -------------

   The restoration of a backup that has been carried out with
   WPS-BACK is processed by running WPS-REST.EXE.


   NOTES:
   -----
   1. WPS-REST.EXE *must* be run after booting from an OS/2 boot floppy.
      Please note this point. Do NOT attempt to run WPS-REST.EXE when
      the WPS is active. I cannot guarantee what will happen if anyone
      tried this.

   2. It is advised that you run CHKDSK on your OS/2 boot drive before
      running WPS-REST.EXE. This will give CHKDSK the opportunity to
      correct any disk errors, and will increase the chance of a
      successful restore.

   3. You should make copies of your current CONFIG.SYS, OS2.INI and
      OS2SYS.INI files, BEFORE running WPS-REST.EXE. This will allow
      you to restore your old setup in case you wish to do so.

      The program will attempt to copy make backups of the existing files
      (giving them a .OLD extension) - but it expects to find them in a
      certain place and if they are not found there, the program just
      tells you that it cannot find them, and continues with the restore.

   4. For the restore process to work properly, the \OS2 directory on
      your OS/2 boot drive should be in the "PATH" statement.
      Alternatively, you could copy WPS-REST.EXE to the root directory
      of your OS/2 boot drive, and run it from there.


  -------------------------

   Like WPS-BACK.EXE, WPS-REST.EXE is run with 2 parameters;

    1. Your OS/2 boot drive
    2. The floppy disk drive that you want to back up to.


    Thus the syntax is;

    WPS-REST <backup drive> <os2 boot drive> [os2 desktop directory]


    Examples;

    WPS-REST A: D:              (restores from drive A: to drive D:)
    WPS-REST A: C:              (restores from drive A: to drive C:)

    WPS-REST A: C: C:\OS2_!SYS  (restores from drive A: to drive C:)
                                (the OS/2 Desktop directory is not)
                                (called "C:\DESKTOP", but "C:\OS2_!SYS")

   That is it! (hopefully).

   If WPS-REST.EXE is run without any parameters, it goes into an
   interactive mode.

    * NOTE: the 3rd parameter is only needed if your OS/2 Deskop
    directory is NOT called "\DESKTOP".

    If in doubt, just run WPS-REST.EXE with no parameter, and the
    interactive process will ask you all the necessary questions.


   * NOTES *
   ---------
   When the restore process begins, it first of all renames your
   DESKTOP directory to \OLDDESK1. If \OLDDESK1 already exists on
   your OS/2 boot drive, the the DESKTOP directory will be renamed
   to \OLDDESK2. This is just a precaution in case you wish to go back
   to what you had before.

   If both \OLDDESK1 and \OLDDESK2 exist on your OS/2 boot drive, then
   WPS-REST.EXE will stop. You will then have to remove one of them
   yourself.

   Your old configuration files are backed up, with a ".OLD" extension.

   After the DESKTOP directory has been renamed, the restore process
   begins in earnest.


    WHAT IS RESTORED?
    ------------------
    The following are restored;

      1. The \Desktop directory on the OS/2 boot drive
      2. OS2.INI
      3. OS2SYS.INI
      4. CONFIG.SYS
      5. AUTOEXEC.BAT   (if it exists)
      6. STARTUP.CMD    (if it exists)
      7. TCPSTART.CMD   (if it exists)


   ** IMPORTANT NOTE **
   --------------------
   If your backup spans more than one floppy disk, you may get a
   message that a certain file cannot be found on the disk, and
   that you should insert the other backup disk(s), and press ENTER.
   If you are not sure of the disk on which the file is, then you
   should just insert the other backup disks one-by-one, and press
   ENTER. When the file is found, the restore will continue.
   At this point, you can always skip any file by typing "S" and
   pressing ENTER. You WILL need to do this in respect of files
   that were not backed up. There are many reasons why a file may
   not have been backed up, and which will mean that you will need
   to "skip" the step of restoring it. Some possible reasons are;

      [a] you aborted the backup before it was finished.
      [b] the file did not exist at all (e.g., TCPSTART.CMD only
          exists if you have TCP/IP installed); and some people
          (including me) do not have a STARTUP.CMD file at all.

      The second reason is why you are allowed to skip the restore
      of a file.


   After all this, your old WPS and Desktop settings will hopefully
   have been restored. You can then reboot, and watch.

   That's all folks!


   LICENSE
   -------

   This package is supplied as FREEWARE. You can do with it as you
   please, as long as nothing in it is modified, and this documentation
   is supplied with it.


   NON-ENGLISH TRANSLATIONS OF THIS DOCUMENTATION
   ----------------------------------------------

   If anybody wishes to translate this file into another language, please
   contact me first. I have no objection to people providing translations of
   this file, as long as;

      1. My WRITTEN permission is requested
      2. If I give my permission, I am given a copy of the translation
      3. You are ready to accept FULL responsibility for your translation

   As I have no way of verifying the accuracy of any non-English
   translation, ANYBODY WHO RELIES ON A NON-ENGLISH TRANSLATION DOES SO
   *ENTIRELY* AT HIS/HER OWN RISK. IF THIS IS NOT ACCEPTABLE TO YOU, THEN
   YOU *MUST* RELY ONLY ON MY ENGLISH DOCUMENTATION.


   FEEDBACK
   --------
   I am interested to know how well this package works for you. If it
   saves your life, then you can buy me some African palm wine :-)
   If it kills you, then I have gone to Timbuktu, and will not be
   back for a while.


   COMPILER
   --------
   For all who are interested, the programs in this package are 16-bit
   character mode OS/2 executables, and were developed with Borland
   Pascal 7.0, with the OS/2 patch for it produced by the German computer
   magazine "c't", and the developments to that patch produced by the
   Compu$erve BP4OS2 forum.


   DISCLAIMER
   ----------
   These programs were written for my own use, and they work well for
   me. They have been thoroughly tested in simulated conditions, and
   have been used to restore my Desktop and WPS in real situations
   twice. However, your mileage may vary and I cannot guarantee
   anything. Hence, the following disclaimer.

   THE PROGRAMS WPS-BACK.EXE AND WPS-REST.EXE ARE SUPPLIED "AS IS", AND
   WITHOUT ANY GUARANTEES WHATSOEVER. I ACCEPT NO RESPONSIBILITY FOR
   ANY LOSS OR DAMAGE, WHETHER DIRECT OR INDIRECT, PHYSICAL, FINANCIAL,
   EMOTIONAL, MARITAL, MENTAL, SOCIAL, OR OTHERWISE, THAT MAY RESULT
   FROM THE USE, OR THE PURPORTED USE OF ANY PROGRAM IN THIS PACKAGE
   FOR ANY REASON WHATSOEVER.

   IF THESE TERMS ARE NOT ACCEPTABLE TO YOU, THEN YOU HAVE NO LICENSE
   TO USE THIS PACKAGE AT ALL, AND YOU SHOULD DELETE THE PROGRAMS FROM
   YOUR DISKS IMMEDIATELY.


-------------------------------------------
  (c) February 1994,
  Dr. A. Olowofoyeku,
  Keele University
  England.

  e-mail:   laa12@keele.ac.uk
--------------------------------------------

