home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / os2 / wpsbk110.zip / READ.ME < prev    next >
Text File  |  1993-06-12  |  10KB  |  193 lines
  1.                            Workplace Shell Backup Utility
  2.  
  3.  
  4. FOREWORD BY THE AUTHOR - 06/12/93
  5.  
  6. Changes since 04/02/93
  7.   - Corrected an ambiguity in the creation scheme for the 
  8.     progress indicator that caused an error under OS/2 2.1 GA.
  9.   - Tested and validated under OS/2 2.1 GA.
  10.  
  11. Changes since 11/08/92
  12.   - Inserted ATTRIB command to remove potential ReadOnly flag
  13.     from INI being replaced during restore.  (3/93 beta)
  14.   - Added some performance/size parms to compile and link
  15.   - Changed WipeWPS from fullscreen to windowable
  16.   - Changed WipeWPS DosDelete to DosForceDelete
  17.   - Changed WipeWPS reply prompt from scanf to _getch to allow
  18.     use of minimal boot partition created for 2.1 by SE20boot
  19.   - Removed read.me section relating to long elapsed times.
  20.     (Thank you prf* API developers for 2.1!)
  21.  
  22. Changes since 11/02/92
  23.   - Fixed my own bug that occurred >63K record in OS2SYS.ini
  24.     Special thanks to Olaf Koch, Bruce Leiwant and Rick Yoder.
  25.   - WPSbkup release number now appears on the title bar
  26.  
  27. Changes since 9/18/92
  28.   - Bug workaround when >64K I/O area input to PrfQueryProfileData
  29.   - Version check recognises SP levels 6050 and 6055 
  30.  
  31. Changes since 7/4/92 
  32.   - 32 bit GRE beta level code tested and certified
  33.   - Bug workaround when 64K I/O area and enumerate appls
  34.   - DosForceDelete used to clear old target dir
  35.   - Wait pointer consistant over client area
  36.   - Progress indicator added for INI backups
  37.   - Enterprise registration now available
  38.  
  39. Introduction -
  40.  
  41. Thank you for trying WPSbkup.  WPSbkup is a 32 bit utility that will backup
  42. status and configuration data for the OS/2 2.x WorkPlace Shell (WPS).
  43.  
  44. The OS/2 WPS is the new and exciting object oriented user interface that
  45. accompanies the OS/2 version 2 operating system.  When you customize the WPS
  46. to suit your own need and taste, you are modifying two physical elements of
  47. OS/2.  These elements are:
  48.  
  49.   - The system initialization (INI) files, OS2.INI and OS2SYS.INI which
  50.     reside in the OS2 directory of the boot drive.  These INI files contain
  51.     the bulk of the system customization information.  They are opened for 
  52.     update immediately after boot.  The INI files are accessed through a set
  53.     of two indices.  Since these files are updated through "random access", 
  54.     data integrity using a sequential backup method can not be provided while
  55.     the INI files are open.  WPSbkup uses API calls provided by OS/2 for the
  56.     purpose of accessing INI files with integrity.  The INI integrity is 
  57.     critical for the successful operation of your system.  Remember that 
  58.     OS/2 is a multitasking system.  You can do real work while WPSbkup 
  59.     is active.
  60.  
  61.   - The desktop directory structure (DTP) and its associated extended attribute
  62.     (EA) data also holds a large amount of your customization data.  The DTP
  63.     is more visible to you because you directly manipulate its elements using
  64.     the OS/2 file system and WPS objective controls.  However, much of its
  65.     information is really stored in the INI files (see above.)  When you drag
  66.     a "Program object instance" out of the Templates folder, drop it on the
  67.     desktop and fill in execution related information you are interacting with
  68.     DTP.  However, almost all of the information that records this activity is
  69.     maintained in the INI files.  WPSbkup records enough information about the
  70.     DTP to be able to recreate it in a way that preserves its associations in
  71.     the INI files.  WPSbkup records the information in a way that allows you
  72.     to store the backup data on removable (floppy) FAT formatted media.
  73.  
  74. WPSbkup provides an alternative to the Alt+F1 procedure.  WPSbkup will provide
  75. backup data for your WPS and create a simple to use WPS restore procedure.
  76. More than likely you will never need to use the restore procedure, but if you
  77. do, it can save you hours of recovery time.  WPSbkup backs up only the data
  78. that "personalizes" your implementation of OS2 2.x.  WPSbkup has been tested
  79. with both US and National Language releases of OS2 version 2.  
  80.  
  81. WPSbkup can also be used in large organizations to install a standard WPS user
  82. interface for user machine that have identical (or VERY VERY similar) hardware
  83. configurations.
  84.  
  85.  
  86.  
  87. Contents of this package are:
  88.  
  89. Read.Me     - You're reading it right now.
  90. WPSbkup.exe - The Workplace Shell image copy utility.
  91. WipeWPS.exe - Clears out the desktop directorie(s) before recovery.
  92.  
  93.  
  94.  
  95. Installation is pretty darn simple:
  96.  
  97. Step1 - Copy WPSbkup.exe to a directory that you use to store programs.  Use
  98.         a directory OTHER THAN the OS/2 Desktop directory or any of its
  99.         subdirectories, though.  If a program is physically located in the
  100.         desktop directory structure AND that program is running when you
  101.         execute WPSbkup, then the backup will fail.
  102.  
  103. Step2 - Copy WipeWPS.exe to one of the boot drive directories named in the
  104.         config.sys that is contained on your SYSTEM DISK 1 OF 15.  They are:
  105.  
  106.             \     (Root)
  107.             \OS2
  108.             \OS2\SYSTEM
  109.             \OS2\INSTALL    <== suggested
  110.  
  111. Step3 - Add a program entry to any of your folders for WPSbkup.exe.  As far
  112.         as program settings go, all you really have to specify is path and
  113.         file name for where you placed WPSbkup.exe and the name of the
  114.         target directory into which Workplace Shell backup data will be placed.
  115.  
  116.         Enter the name of the target directory in the Parameters entry field.
  117.         You must specify drive and full path name. (I.e. E:\WPSstore)  If this
  118.         directory does not exist, WPSbkup will create it when it executes.
  119.  
  120.         TAKE NOTE:  WPSbkup.exe owns the target directory lock, stock and
  121.                     barrel.  When it starts execution, it erases all files
  122.                     and sub-directories contained within its target directory.
  123.                     So don't specify a directory that holds any files or
  124.                     sub-directories that you wish to keep.
  125.  
  126. Executing the backup is as simple as double clicking the icon!  WPSbkup.exe
  127. is a well behaved 32 bit PM application.  It does its considerable I/O on a
  128. separate thread so that you can close it, minimize it or do other tasks while
  129. it is running.  After it completes execution, look at the Read.Me file that is
  130. created in the target directory.  This file will tell you exactly what must
  131. be done in the case of a Workplace Shell failure.
  132.  
  133. Miscellaneous Notes:
  134.  
  135. 1) To receive syntax help for WPSbkup, execute it with no parameters from
  136.    an OS2 command prompt.
  137.  
  138. 2) Optional Parameters:
  139.  
  140.    PurgePrompt | NoPurgePrompt    -  allows suppression of the confirmation
  141.                                      message box that warns of the erasure
  142.                                      of files and sub-directories in the
  143.                                      backup target.  Default is PurgePrompt.
  144.                                      Be advised that WPSbkup is running when
  145.                                      the WPS status is stored.  That means
  146.                                      that if you have to restore, WPSbkup will
  147.                                      be initiated for execution.  If you use
  148.                                      the NoPurgePrompt parameter, a superfluous
  149.                                      backup will be taken when you reboot after
  150.                                      a restore.
  151.  
  152.    TestVer2Rev | NoTestVer2Rev    -  allows suppression of the check made for
  153.                                      CSD XR02000_ or CSD XR02010_.  Use this
  154.                                      parameter if you have more current
  155.                                      maintenance and are sure that this backup
  156.                                      procedure will still work with your
  157.                                      revision.  Default is TestVer2Rev.
  158.  
  159. 3) Many checks are made to insure that you will be notified if valid backups
  160.    are not created.  However, image copies are created and the GIGO (garbage
  161.    in / garbage out) rule applies.  Therefore, make sure that you are running
  162.    cleanly before you write over backup data with a new backup.  Try to use
  163.    a rotating target directory methodology so that you can maintain a valid
  164.    -1 backup should the current backup data prove to be damaged.
  165.  
  166.  
  167. ================== SUPPORT SHAREWARE =====================================
  168.  
  169. I hope you find this utility helpful, but (here comes the disclaimer) I am
  170. in no way responsible for any damages the use of this utility may cause.
  171. You are free to use this utility at your own risk with no obligation to me,
  172. the author, for only a short period of time.
  173.  
  174. This backup utility will allow 15 trial executions.  Then it will "time out."
  175. If WPSbkup is helpful to you or your organization, you should register it.
  176. The registration fee for individuals is $15 (US).  The site registration fee
  177. for corporate entities is $150 (US).  Finally, an enterprise registration is
  178. available for organizations with more that ten branches or offices.  The 
  179. enterprise registration fee is $1500 (US).  Checks must be drawn upon US banks.
  180.  
  181. Please state the file date of WPSbkup.exe that you currently have (if any)
  182. in your registration letter.
  183.  
  184. Please send registration fees to:
  185.  
  186. Dave Lester
  187. PO Box 461
  188. New Freedom, PA. 17349 USA
  189.  
  190. Comments, suggestions and bug reports may be submitted through CIS Mail
  191. ID 75600,237.  These will be answered on a "best effort" basis.
  192.  
  193.