═══ 1. Release Notes - 01/15/94 ═══ o Read.Me material is now presented in this INF format. o Qlog is now distributed along with WPSbkup so that trace data can be easily obtained. o WPSbkup will now allow you to discard unreadable records found in the INI files. If you choose to discard damaged records, an appropriate warning is placed in the WPSrest.Cmd file. o WPSbkup no longer uses XCOPY to copy files found in the desktop. Hidden files can now be backed up and appropriate ATTRIB commands are generated in the WPSrest.cmd file. o Because WPSbkup no longer uses XCOPY, erroneous EAs are not attached to the FLSTORE directory. So, backup target directories may be deleted through the Drives object. o WPSbkup now calls EAUTIL as a child process. o Performance ehancements have been provided in the desktop backup phase. o The temporary folder created during the desktop location phase will now replace existing folder if it exists. This will aid run reliability. ═══ 1.1. Release Notes - 12/30/93 ═══ o Some systems did not respond well to the WinDrawText API. This caused WPSbkup to loop trying to set the fontsize. A workaround was added to trap this situation. 10 point fontsize is now forced under these circumstances. o The system levels for OS/2 for Windows and the 2.1 Standard Edition CSD were added to WPSbkup's recognised list. ═══ 1.2. Release Notes - 10/04/93 ═══ o Added the optional parameters NotifyOK and NoNotifyOK (default.) The NotifyOK parameter may be placed after the specification of the backup target directory on the command line or in the Parameters entry field of WPSbkup's program reference settings notebook. The NotifyOK parm causes WPSbkup to display an informational message window just before it exits from a successful backup run. WPSbkup *always* displays error messages for any reason that causes it to exit without creating a valid backup. As always, a discription of WPSbkup syntax requirements can be displayed by entering WPSBKUP from the command line with no input parameters. o The WPSrest.cmd was modified slightly to cut down on non-essential messages displayed during restore. Also, a new message is displayed at the end of the restore process that instructs the PC user that the restore is complete and a reboot is needed. o Plugged a hole whereby WPSbkup would be unable to find the desktop of OS/2 2. 0 GA systems. o Added logic to more closely examine a display system's ability to present a given font size in a specific target area. ═══ 1.3. Release Notes - 09/07/93 ═══ o WPSrest command generation is completely reworked. It is now possible to copy the backup target to any other location. The restore process is no longer dependent upon the physical location of the backup directory. (The old approach required that the backup directory be unchanged from the place of its creation.) However, now you must change to the backup directory before executing the WPSrest.cmd restore command. To relocate the backup directory, use: XCOPY D:\MYbackupDir\*.* A:\MYBKDIR /s /e /v If the backup directory is contained upon an HPFS volume, you may also simply rename the directory to establish backup generation control: REN D:\MYbackupDir E:\MYbackupDir.old o WPSbkup can now find your Desktop directory even if you move it to a different drive or subdirectory. o WPSbkup will not allow you to specify the Desktop directory as a backup target. This specification was accidentally made by several users while adding WPSbkup to the Desktop popup menu. Since the first step of the backup process includes deleting all of the entries in the target directory, allowing the Desktop directory to be specified as the target had dire consequences. WPSbkup will ignore the Desktop path if it is found in the input parameters. o WipeWPS.exe is stored in the backup target directory during the backup process. This removes any PATH requirements for the restore procedure. Formerly , I suggested that WPSbkup.exe and WipeWPS.exe be placed in the \OS2\ INSTALL. This is no longer required. These files may be placed in any directory with the following provisions - They can't reside in the backup target directory - They shouldn't reside in the physical Desktop Directory - BOTH FILES MUST RESIDE IN THE SAME DIRECTORY o WPSbkup has been given a new look. The presentation code is completely rewritten. A new program icon has been assigned. o WPSbkup recognizes and has been tested with all levels of OS/2 up to and including the S3 video support production release. ═══ 1.4. Release Notes - 06/12/93 ═══ o Corrected an ambiguity in the creation scheme for the progress indicator that caused an error under OS/2 2.1 GA. o Tested and validated under OS/2 2.1 GA. ═══ 1.5. Release Notes - 04/02/93 ═══ o Inserted ATTRIB command to remove potential ReadOnly flag from INI being replaced during restore. (3/93 beta) o Added some performance/size parms to compile and link o Changed WipeWPS from fullscreen to windowable o Changed WipeWPS DosDelete to DosForceDelete o Changed WipeWPS reply prompt from scanf to _getch to allow use of minimal boot partition created for 2.1 by SE20boot o Removed read.me section relating to long elapsed times. (Thank you prf* API developers for 2.1!) ═══ 1.6. Release Notes - 11/08/92 ═══ o Fixed my own bug that occurred >63K record in OS2SYS.ini Special thanks to Olaf Koch, Bruce Leiwant and Rick Yoder. o WPSbkup release number now appears on the title bar ═══ 1.7. Release Notes - 11/02/92 ═══ o Bug workaround when >64K I/O area input to PrfQueryProfileData o Version check recognises SP levels 6050 and 6055 ═══ 1.8. Release Notes - 09/18/92 ═══ o 32 bit GRE beta level code tested and certified o Bug workaround when 64K I/O area and enumerate appls o DosForceDelete used to clear old target dir o Wait pointer consistant over client area o Progress indicator added for INI backups o Enterprise registration now available ═══ 1.9. Release Notes - 07/04/92 ═══ o WPSbkup goes full production! ═══ 2. Introduction ═══ Thank you for trying WPSbkup. WPSbkup is a 32 bit utility that will backup status and configuration data for the OS/2 2.x WorkPlace Shell (WPS). 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: o 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 your 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. The INI integrity is critical for the successful operation of your system. Remember that OS/2 is a multitasking system. You can do real work while WPSbkup is active. o 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. 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.x. WPSbkup has been tested with both US and National Language releases of OS2 version 2. WPSbkup can also be used in organizations to install a standard WPS user interface for user machines that have identical (or VERY VERY similar) hardware configurations. ═══ 3. Package Contents ═══ Contents of this package are: ReadMe.Inf - You're reading it right now. WPSbkup.exe - The Workplace Shell image copy utility. WipeWPS.exe - Clears out the desktop directorie(s) during recovery. Qlog.exe - Trace facility for WPSbkup. Qlog.hlp - Help file for Qlog. ═══ 3.1. What's Qlog?? ═══ Qlog is a trace facility that can be used to monitor the progress of the desktop backup. Monitoring is only helpful if WPSbkup is unable to successfully backup your OS/2 Desktop settings. Should you need to report a problem, you may wish to first execute the following procedure: 1. Start Qlog 2. Open a new log file from the File action bar item. 3. Reset the priority from the Options/Priority/Critical action bar item 4. Run WPSbkup using the undocumented parameter "log" (without the quotes.) For Example: WPSbkup D:\MyBackup LOG 5. After the error occurs stop WPSbkup as normal 6. Close the Qlog file from its File action bar item 7. Edit out the last ten lines or so and send them to: Dave Lester CIS ID 75600,237 or Dave Lester New Freedom Data Center Box 461 New Freedom, PA 17349 Armed with this information, we can usually resolve backup problems. ═══ 4. Installation ═══ Installation is pretty darn simple: Step1 Copy WPSbkup.exe to a directory that you use to store programs. Use a directory OTHER THAN the OS/2 Desktop directory or any of its subdirectories, though. If a program is physically located in the desktop directory structure AND that program is running when you execute WPSbkup, then the backup will fail. Step2 Copy WipeWPS.exe TO THE SAME DIRECTORY AS USED ABOVE. Step3 Add a Program Reference object to any of your folders for WPSbkup. 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 for example, E:\WPSstore. If this directory does not exist, WPSbkup will create it when it executes. CAUTION: 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. ═══ 4.1. Creating a Program Reference ═══ OS/2 makes it very easy to add icons to your desktop that will cause programs to execute. Just follow these steps: 1. Open your system Templates folder 2. Drag a Program template and drop it on your desktop or any desktop folder 3. The Program Reference object will automatically open to the Program Settings page of its settings notebook 4. Fill in the "Path and filename:" field. This is where you specify the full pathname for the WPSbkup program. For example: E:\WPSbkpgm\WPSbkup.exe 5. Fill in the "Parameters:" entry field. This is where you specify the startup parms for WPSbkup. The only required parameter is the full pathname of the directory in which you want WPSbkup to create your backup. For example: E:\WPSstore If this directory does not exist, WPSbkup will create it when it runs. CAUTION: Be careful, WPSbkup starts the backup process by deleting everything (files and subdirectories) that it finds in the directory that you specify here. So, do not specify a directory that holds ANYTHING that you already have. 6. WPSbkup has other parameters that you may also wish to specify here. 7. Click the General tab on the settings notebook. Enter a descriptive name in the "Title:" entry field. Anything you enter here will appear beneath the icon for WPSbkup. 8. Close the settings notebook. You're done! ═══ 4.2. A Trick with WPS Parameters ═══ A little known (but extremely handy) device can be used when entering parameters into the settings notebook for a program reference object. You can get the WPS to prompt you for all or part of the input parameters for a program. Your response to the prompt will be inserted into the startup parameters that are passed to the program. Simply enter the prompt message inside of square braces that you wish to see when the WPS starts the program. For example, let's say that you have a directory called D:\MyBkups and you wish to save desktop backups in this directory orgainzed by day of week. You could enter the following into the parameters field in WPSbkup's program reference object settings notebook: D:\MyBkups\[Enter the day of the week:] When you double click WPSbkup's program reference icon, the WPS will display a prompt window with instructions to "Enter the day of the week." The WPS would take your reply and insert it into the parameter string before it invoked WPSbkup. The resulting parameter might look like: D:\MyBkups\Thursday Given that input parameter, WPSbkup would make a backup of your desktop configuraton in a subdirectory called Thursday of the directory D:\MyBkups. ═══ 5. Misc. Notes + Exec Parms ═══ Miscellaneous Notes: o To receive syntax help for WPSbkup, execute it with no parameters from an OS2 command prompt. o Optional Parameters: (Defaults are shown first followed by overrides.) 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 tested OS/2 CSD levels. 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. NoNotifyOK | NotifyOK allows generation of an "all clear" message that indicates the backup completed successfully. Default is NoNotifyOK. WPSbkup *always* reports error conditions that might keep it from being able to create a valid backup. NoLog | Log causes WPSbkup to output trace records. These trace records can be displayed and saved to disk by the Qlog utility. o 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. ═══ 6. A Short Message From Our Sponsor ═══ Please print a registration form topic and register WPSbkup. 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 fees are: o For individuals - $15 (US) o For each business location - $150 (US) o Enterprise wide - $1500 (US) Checks must be drawn upon US banks. Comments, suggestions and bug reports may be submitted to Dave Lester through CIS Mail ID 75600,237. These will be answered on a "best effort" basis. ═══ 7. Registration Forms ═══ Since there are varied ways in which WPSbkup may be registered, I have provided several order forms that you can use. Just click the + sign located to the left of the Registration Forms line in the Contents window. That will expand several registration form entries. Please choose Print from the Services menu to print the registration form that best suits your needs. ═══ 7.1. Individual Registration ═══ Please, print this form and register WPSbkup. My Name and Address: Remit Payment and Order To: ________________________ Dave Lester ________________________ New Freedom Data Center ________________________ Box 461 ________________________ New Freedom, PA. 17349 Qty. Description Unit Extended Price Price ____ I would like to register WPSbkup for my individual use. $15 _______ TOTAL: _______ Please remit payment in US dollars or check written in US dollars drawn upon US bank. ═══ 7.2. Company Site Registration (by check) ═══ Please, print this form and register WPSbkup. Remit Payment and Order To: Dave Lester New Freedom Data Center (717) 235-7315 (Voice) Box 461 (717) 235-0985 (FAX) New Freedom, PA. 17349 Qty. Description Unit Extended Price Price _1__ I am registering WPSbkup to be used at one of my company's business locations. A check is enclosed and the following addresses should be used to deliver WPSbkup to us. $150 _150___ Technical Contact Ship To Address Registered Site Address _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ ____ Additional business sites at which WPSbkup will be run in my company. $150 _______ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ TOTAL: _______ Please remit payment in US dollars or check written in US dollars drawn upon US bank. ═══ 7.3. Company Site Registration (by purchase order) ═══ Please, print this form and register WPSbkup. Remit Purchase Order and Order Form To: Dave Lester New Freedom Data Center (717) 235-7315 (Voice) Box 461 (717) 235-0985 (FAX) New Freedom, PA. 17349 Qty. Description Unit Extended Price Price _1__ I am registering WPSbkup to be used at one of my company's business locations. A purchase order is enclosed and the following addresses should be used to deliver and bill WPSbkup to us. $150 _150___ Technical Contact Ship To Address Registered Site Address Bill To Address _____________________ ____________________ ____________________ ____________________ _____________________ ____________________ ____________________ ____________________ _____________________ ____________________ ____________________ ____________________ _____________________ ____________________ ____________________ ____________________ ____ Additional business sites at which WPSbkup will be run in my company. $150 _______ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ TOTAL: _______ Please remit payment in US dollars or check written in US dollars drawn upon US bank. ═══ 7.4. Enterprise Registration (by check) ═══ Please, print this form and register WPSbkup. Remit Payment and Order To: Dave Lester New Freedom Data Center (717) 235-7315 (Voice) Box 461 (717) 235-0985 (FAX) New Freedom, PA. 17349 Qty. Description Unit Extended Price Price _1__ I am registering WPSbkup for unlimited use within our enterprise A check is enclosed and the following addresses should be used to deliver WPSbkup to us. $1,500 _1,500_ Technical Contact Ship To Address _____________________ ____________________ _____________________ ____________________ _____________________ ____________________ _____________________ ____________________ I understand that by registering WPSbkup for my enterprise I secure the following rights: - Ability to make unlimited copies of the software for use at any of our corporate facilities - Employees of my corporation may copy the software for their home use - Updates to the software (as they occur) will be automatically mailed to the technical contact listed above TOTAL: _$,1500_ Please remit payment in US dollars or check written in US dollars drawn upon US bank. ═══ 7.5. Enterprise Registration (by purchase order) ═══ Please, print this form and register WPSbkup. Remit Purchase Order and Order Form To: Dave Lester New Freedom Data Center (717) 235-7315 (Voice) Box 461 (717) 235-0985 (FAX) New Freedom, PA. 17349 Qty. Description Unit Extended Price Price _1__ I am registering WPSbkup for unlimited use within our enterprise A purchase order is enclosed and the following addresses should be used to deliver and bill WPSbkup to us. $1,500 _1,500_ Technical Contact Ship To Address Bill To Address _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ _____________________ ____________________ ____________________ I understand that by registering WPSbkup for my enterprise I secure the following rights: - Ability to make unlimited copies of the software for use at any of our corporate facilities - Employees of my corporation may copy the software for their home use - Updates to the software (as they occur) will be automatically mailed to the technical contact listed above TOTAL: _$,1500_ Please remit payment in US dollars or check written in US dollars drawn upon US bank.