home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / bkupwp14.zip / WPS-BACK.DOC next >
Text File  |  1994-02-19  |  14KB  |  378 lines
  1.  
  2.                 DOCUMENTATION FOR WPS BACKUP v1.40
  3.                 ----------------------------------
  4.  
  5.    Changes since version 1.30:
  6.    ---------------------------
  7.    1. TCPSTART.CMD is now backed up if you have TCP/IP installed, and
  8.       if the file is in the \TCPIP\BIN directory of your OS/2 boot
  9.       drive.
  10.    2. Bug which caused certain files not to be backed up if there is
  11.       insufficient disk space fixed.
  12.  
  13.       Please read this documentation carefully.
  14.  
  15.  
  16.    INTRODUCTION
  17.    ------------
  18.    Although OS/2 is a wonderful operating system, it is far from
  19.    perfect, and it is not as crash-proof as some would have us
  20.    believe. In addition, many activities (for example, installing
  21.    drivers for new devices or even simply changing screen drivers)
  22.    are fraught. Many users, including myself have had to go through
  23.    the process of reinstalling OS/2, as a result of something going
  24.    wrong when changing screen drivers. Re-installation itself is
  25.    relatively painless (if you are doing it from a supported CD-ROM).
  26.    However the pain of losing all your weeks and months of
  27.    customisation of the OS/2 Desktop and Work Place Shell (WPS) is
  28.    much more significant.
  29.  
  30.    What this package does is to provide a very simple way of backing
  31.    up and restoring your OS/2 Desktop and WPS settings. The executables
  32.    can be run either with command line parameters (each of them only
  33.    takes 2 parameters) or in an interactive mode. Both of the
  34.    executables are run from an OS/2 command prompt.
  35.  
  36.  
  37.    NOTE: This program has only been tested on OS/2 v2.1. It should work
  38.    also for later versions, but may not work with earlier versions.
  39.  
  40.  
  41.    INSTALLATION
  42.    ------------
  43.    The package consists of the following files;
  44.  
  45.       1. WPS-BACK.EXE   - executable to back up the WPS and Desktop
  46.       2. WPS-REST.EXE   - executable to restore the back up
  47.       3. README.DOC     - this file
  48.  
  49.    There is no special produre for installation. Just copy the files
  50.    WPS-BACK.EXE and WPS-REST.EXE into a directory which is in your
  51.    OS/2 program path.
  52.  
  53.  
  54.    --------------
  55.    | BACKING UP |
  56.    --------------
  57.  
  58.    The back up is processed by running WPS-BACK.EXE.
  59.  
  60.    The best method of performing the back up is to run WPS-BACK.EXE
  61.    when the WPS is not active. There are 2 ways of achieving this.
  62.  
  63.    Either;
  64.  
  65.    1. Booting from an OS/2 boot floppy (this is tedious and time
  66.       consuming),
  67.  
  68.    or
  69.  
  70.    2. Adding the line "CALL=C:\OS2\CMD.EXE" as the LAST line in your
  71.       CONFIG.SYS file. This opens up a full screen OS/2 session upon
  72.       boot up. From there you can run WPS-BACK.EXE and also perform
  73.       any other maintainance duties before typing "EXIT", which will
  74.       then cause the boot up into the WPS to be completed.
  75.  
  76.       This is the easiest method, and is advisable, even if you are not
  77.       using this package at all.
  78.  
  79.     However, you can still run WPS-BACK.EXE (but not WPS-REST.EXE) from
  80.     your OS/2 Desktop, by creating a WPS program object for it.
  81.  
  82.     WPS-BACK.EXE takes 2 parameters (there is an optional 3rd parameter
  83.     for non-English language versions of OS/2 v2.1, and an optional
  84.     4th parameter for "quick" backups);
  85.  
  86.     1. Your OS/2 boot drive
  87.     2. The floppy disk drive that you want to back up to.
  88.  
  89.  
  90.    Thus the syntax is;
  91.  
  92.    WPS-BACK <os2 drive> <destination drive> [os2 desktop directory] [/Q]
  93.  
  94.  
  95.     Examples;
  96.  
  97.     WPS-BACK D: A:             (backs up from drive D: to drive A:)
  98.     WPS-BACK C: A:             (backs up from drive C: to drive A:)
  99.     WPS-BACK C: A: /Q          (backs up from drive C: to drive A:)
  100.                                (but does not pause for any confirmation)
  101.  
  102.     WPS-BACK C: A: C:\OS2_!SYS (backs up from drive C: to drive A:)
  103.                                (the OS/2 Desktop directory is not)
  104.                                (called "C:\DESKTOP", but "C:\OS2_!SYS")
  105.  
  106.     WPS-BACK C: A: C:\OS2_!SYS /Q
  107.                                (backs up from drive C: to drive A:)
  108.                                (the OS/2 Desktop directory is not)
  109.                                (called "C:\DESKTOP", but "C:\OS2_!SYS")
  110.                                (It does not pause for any confirmation)
  111.  
  112.     That is it!
  113.  
  114.     If you run WPS-BACK without any parameter (or with less than 2
  115.     parameters) the program goes into an interactive mode, and asks
  116.     you for your OS/2 boot drive, and the target drive. You can stop
  117.     at these stages, by just pressing ENTER.
  118.  
  119.     For safety's sake, you are given 1 chance to stop the back up
  120.     process, by pressing CTRL-Break (note that if you press CTRL-Break
  121.     at the stage when you are asked to insert a floppy disk, the
  122.     program will not backup the desktop directory, but will still backup
  123.     the other files).
  124.  
  125.     If you decide to go on with the backup, WPS-BACK then does some
  126.     checking, and finally starts the backing up.
  127.  
  128.     When the back up has started (if you run it from the Desktop) you
  129.     can start to do other things, and it will run in the background.
  130.  
  131.     * NOTES *:
  132.     ----------
  133.        The 3rd parameter is only needed if your OS/2 Deskop
  134.        directory is NOT called "\DESKTOP". This is the case with some
  135.        non-English language versions of OS/2, and it is also the case
  136.        with OS/2 v2.0. Some people with OS/2 version 2.1 have renamed
  137.        their desktop directory. They also will need to supply the third
  138.        parameter.
  139.  
  140.        If in doubt, just run WPS-BACK.EXE with no parameter, and the
  141.        interactive process will ask you all the necessary questions.
  142.  
  143.  
  144.     THE /Q OPTION
  145.     -------------
  146.     If you use the "/Q" option, the following consequences ensue;
  147.       1. Everything goes on without any intervention from you.
  148.       2. You will not get a chance to back out.
  149.       3. You MUST specify your os/2 drive, and your destination drive.
  150.       4. The /Q switch MUST be the LAST parameter.
  151.       5. Your backup (floppy) disk must already be in the drive BEFORE
  152.          you start.
  153.  
  154.     This option is useful if you want to put the program in your
  155.     STARTUP folder, or you otherwise wish to run it unattended.
  156.  
  157.     Note that the /Q option is only valid for WPS-BACK.EXE. You
  158.     cannot use it when restoring, and I will NEVER implement it in
  159.     the WPS-REST.EXE program.
  160.  
  161.  
  162.     WHAT IS BACKED UP?
  163.     ------------------
  164.     The following are backed up;
  165.  
  166.       1. The \Desktop directory on the OS/2 boot drive
  167.       2. OS2.INI
  168.       3. OS2SYS.INI
  169.       4. CONFIG.SYS
  170.       5. AUTOEXEC.BAT   (if it exists)
  171.       6. STARTUP.CMD    (if it exists)
  172.       7. TCPSTART.CMD   (if it exists in <os2drive>\TPCIP\BIN
  173.  
  174.      If you have Win-OS/2 installed, you will have to back up your
  175.      Win-OS/2 INI files manually.
  176.  
  177.  
  178.    -------------
  179.    | RESTORING |
  180.    -------------
  181.  
  182.    The restoration of a backup that has been carried out with
  183.    WPS-BACK is processed by running WPS-REST.EXE.
  184.  
  185.  
  186.    NOTES:
  187.    -----
  188.    1. WPS-REST.EXE *must* be run after booting from an OS/2 boot floppy.
  189.       Please note this point. Do NOT attempt to run WPS-REST.EXE when
  190.       the WPS is active. I cannot guarantee what will happen if anyone
  191.       tried this.
  192.  
  193.    2. It is advised that you run CHKDSK on your OS/2 boot drive before
  194.       running WPS-REST.EXE. This will give CHKDSK the opportunity to
  195.       correct any disk errors, and will increase the chance of a
  196.       successful restore.
  197.  
  198.    3. You should make copies of your current CONFIG.SYS, OS2.INI and
  199.       OS2SYS.INI files, BEFORE running WPS-REST.EXE. This will allow
  200.       you to restore your old setup in case you wish to do so.
  201.  
  202.       The program will attempt to copy make backups of the existing files
  203.       (giving them a .OLD extension) - but it expects to find them in a
  204.       certain place and if they are not found there, the program just
  205.       tells you that it cannot find them, and continues with the restore.
  206.  
  207.    4. For the restore process to work properly, the \OS2 directory on
  208.       your OS/2 boot drive should be in the "PATH" statement.
  209.       Alternatively, you could copy WPS-REST.EXE to the root directory
  210.       of your OS/2 boot drive, and run it from there.
  211.  
  212.  
  213.   -------------------------
  214.  
  215.    Like WPS-BACK.EXE, WPS-REST.EXE is run with 2 parameters;
  216.  
  217.     1. Your OS/2 boot drive
  218.     2. The floppy disk drive that you want to back up to.
  219.  
  220.  
  221.     Thus the syntax is;
  222.  
  223.     WPS-REST <backup drive> <os2 boot drive> [os2 desktop directory]
  224.  
  225.  
  226.     Examples;
  227.  
  228.     WPS-REST A: D:              (restores from drive A: to drive D:)
  229.     WPS-REST A: C:              (restores from drive A: to drive C:)
  230.  
  231.     WPS-REST A: C: C:\OS2_!SYS  (restores from drive A: to drive C:)
  232.                                 (the OS/2 Desktop directory is not)
  233.                                 (called "C:\DESKTOP", but "C:\OS2_!SYS")
  234.  
  235.    That is it! (hopefully).
  236.  
  237.    If WPS-REST.EXE is run without any parameters, it goes into an
  238.    interactive mode.
  239.  
  240.     * NOTE: the 3rd parameter is only needed if your OS/2 Deskop
  241.     directory is NOT called "\DESKTOP".
  242.  
  243.     If in doubt, just run WPS-REST.EXE with no parameter, and the
  244.     interactive process will ask you all the necessary questions.
  245.  
  246.  
  247.    * NOTES *
  248.    ---------
  249.    When the restore process begins, it first of all renames your
  250.    DESKTOP directory to \OLDDESK1. If \OLDDESK1 already exists on
  251.    your OS/2 boot drive, the the DESKTOP directory will be renamed
  252.    to \OLDDESK2. This is just a precaution in case you wish to go back
  253.    to what you had before.
  254.  
  255.    If both \OLDDESK1 and \OLDDESK2 exist on your OS/2 boot drive, then
  256.    WPS-REST.EXE will stop. You will then have to remove one of them
  257.    yourself.
  258.  
  259.    Your old configuration files are backed up, with a ".OLD" extension.
  260.  
  261.    After the DESKTOP directory has been renamed, the restore process
  262.    begins in earnest.
  263.  
  264.  
  265.     WHAT IS RESTORED?
  266.     ------------------
  267.     The following are restored;
  268.  
  269.       1. The \Desktop directory on the OS/2 boot drive
  270.       2. OS2.INI
  271.       3. OS2SYS.INI
  272.       4. CONFIG.SYS
  273.       5. AUTOEXEC.BAT   (if it exists)
  274.       6. STARTUP.CMD    (if it exists)
  275.       7. TCPSTART.CMD   (if it exists)
  276.  
  277.  
  278.    ** IMPORTANT NOTE **
  279.    --------------------
  280.    If your backup spans more than one floppy disk, you may get a
  281.    message that a certain file cannot be found on the disk, and
  282.    that you should insert the other backup disk(s), and press ENTER.
  283.    If you are not sure of the disk on which the file is, then you
  284.    should just insert the other backup disks one-by-one, and press
  285.    ENTER. When the file is found, the restore will continue.
  286.    At this point, you can always skip any file by typing "S" and
  287.    pressing ENTER. You WILL need to do this in respect of files
  288.    that were not backed up. There are many reasons why a file may
  289.    not have been backed up, and which will mean that you will need
  290.    to "skip" the step of restoring it. Some possible reasons are;
  291.  
  292.       [a] you aborted the backup before it was finished.
  293.       [b] the file did not exist at all (e.g., TCPSTART.CMD only
  294.           exists if you have TCP/IP installed); and some people
  295.           (including me) do not have a STARTUP.CMD file at all.
  296.  
  297.       The second reason is why you are allowed to skip the restore
  298.       of a file.
  299.  
  300.  
  301.    After all this, your old WPS and Desktop settings will hopefully
  302.    have been restored. You can then reboot, and watch.
  303.  
  304.    That's all folks!
  305.  
  306.  
  307.    LICENSE
  308.    -------
  309.  
  310.    This package is supplied as FREEWARE. You can do with it as you
  311.    please, as long as nothing in it is modified, and this documentation
  312.    is supplied with it.
  313.  
  314.  
  315.    NON-ENGLISH TRANSLATIONS OF THIS DOCUMENTATION
  316.    ----------------------------------------------
  317.  
  318.    If anybody wishes to translate this file into another language, please
  319.    contact me first. I have no objection to people providing translations of
  320.    this file, as long as;
  321.  
  322.       1. My WRITTEN permission is requested
  323.       2. If I give my permission, I am given a copy of the translation
  324.       3. You are ready to accept FULL responsibility for your translation
  325.  
  326.    As I have no way of verifying the accuracy of any non-English
  327.    translation, ANYBODY WHO RELIES ON A NON-ENGLISH TRANSLATION DOES SO
  328.    *ENTIRELY* AT HIS/HER OWN RISK. IF THIS IS NOT ACCEPTABLE TO YOU, THEN
  329.    YOU *MUST* RELY ONLY ON MY ENGLISH DOCUMENTATION.
  330.  
  331.  
  332.    FEEDBACK
  333.    --------
  334.    I am interested to know how well this package works for you. If it
  335.    saves your life, then you can buy me some African palm wine :-)
  336.    If it kills you, then I have gone to Timbuktu, and will not be
  337.    back for a while.
  338.  
  339.  
  340.    COMPILER
  341.    --------
  342.    For all who are interested, the programs in this package are 16-bit
  343.    character mode OS/2 executables, and were developed with Borland
  344.    Pascal 7.0, with the OS/2 patch for it produced by the German computer
  345.    magazine "c't", and the developments to that patch produced by the
  346.    Compu$erve BP4OS2 forum.
  347.  
  348.  
  349.    DISCLAIMER
  350.    ----------
  351.    These programs were written for my own use, and they work well for
  352.    me. They have been thoroughly tested in simulated conditions, and
  353.    have been used to restore my Desktop and WPS in real situations
  354.    twice. However, your mileage may vary and I cannot guarantee
  355.    anything. Hence, the following disclaimer.
  356.  
  357.    THE PROGRAMS WPS-BACK.EXE AND WPS-REST.EXE ARE SUPPLIED "AS IS", AND
  358.    WITHOUT ANY GUARANTEES WHATSOEVER. I ACCEPT NO RESPONSIBILITY FOR
  359.    ANY LOSS OR DAMAGE, WHETHER DIRECT OR INDIRECT, PHYSICAL, FINANCIAL,
  360.    EMOTIONAL, MARITAL, MENTAL, SOCIAL, OR OTHERWISE, THAT MAY RESULT
  361.    FROM THE USE, OR THE PURPORTED USE OF ANY PROGRAM IN THIS PACKAGE
  362.    FOR ANY REASON WHATSOEVER.
  363.  
  364.    IF THESE TERMS ARE NOT ACCEPTABLE TO YOU, THEN YOU HAVE NO LICENSE
  365.    TO USE THIS PACKAGE AT ALL, AND YOU SHOULD DELETE THE PROGRAMS FROM
  366.    YOUR DISKS IMMEDIATELY.
  367.  
  368.  
  369. -------------------------------------------
  370.   (c) February 1994,
  371.   Dr. A. Olowofoyeku,
  372.   Keele University
  373.   England.
  374.  
  375.   e-mail:   laa12@keele.ac.uk
  376. --------------------------------------------
  377.  
  378.