Readme for Corrective Service Facility 2-B Version 1.38B **************************** THIS FIXTOOL IS ONLY TO BE USED FOR WARP 4, FP 7 **************************** This readme file describes the new features available with Version 1.38B of the Corrective Service Facility (referred to in this document as the FixTool). Once you use the new version of the FixTool to service a product, you will not be able to use any previous version of the FixTool because the new version modifies SYSLEVEL files and prior versions do not. CONTENTS: Section 1. New Features with Version 1.38B Section 2. Files Included in the FixTool Zip File Section 3. How to Use the FixTool Zip File Section 4. How to Apply Service Section 5. How to Set Up the FixTool for Remote Installation Section 6. How to Customize the Response File Section 7. If You Have a Problem Section 8. Setting Environment Variables Section 9. Common Error Messages Section 10. Known Problems ================================================ Section 1. New Features with Version 1.38B You can tell if you have Version 1.38B by running BLDLEVEL on SERVICE.EXE or FSERVICE.EXE. You will see one of the following, depending on which version of BLDLEVEL.EXE you have. Signature: @#IBM:F.138B#@ OS/2 Corrective Service Facility (C) IBM 1994 Vendor: IBM Revision: 0.138 File Version: 0.138 Description: OS/2 Corrective Service Facility (C) IBM 1994 Signature: @#IBM:F.138B#@ OS/2 Corrective Service Facility (C) IBM 1994 Vendor: IBM Revision: F.138B Description: OS/2 Corrective Service Facility (C) IBM 1994 The new version of the FixTool updates the current CSD field in the SYSLEVEL files of the products it services. After applying a FixPak with Version 1.38B, you will be able to run SYSLEVEL and tell what FixPaks you have applied by looking at the current field of the product's SYSLEVEL file. This version is also compatible with Software Choice features. If you need to use Software Choice to install new features for a product, the FixTool will integrate SYSLEVEL and archive information from the Software Choice install the next time it services that product. Section 2. Files Included in the FixTool Zip File The following files are included in the FixTool zip file: File Use -------------- ----------------------------------------------------------- BUILD.LVL Contains build information for this Fixtool release. CSFPANS.DLL Used by FSERVICE SERVICE.EXE Executable for applying service through a windowed session SERVICE.HLP SERVICE help file SHPIINST.DLL FixTool required DLL UNPACK.EXE Used to unpack files being serviced UNPACK2.EXE Used to unpack files being serviced VIOCALLS.DLL FixTool required DLL FSERVICE.EXE Executable for applying service through a command line (used with a response file). IBMCSFLK.PK@ Locked file device driver and associated files (packed file) PACK.EXE Used to pack files being archived or backed up README.INF General Installation instructions for the FixTool RESPONSE.LAN Response file for servicing network-related products RESPONSE.WP3 Response file for servicing OS/2 Warp v3 base RESPONSE.WP4 Response file for servicing OS/2 Warp v4 base CSF_KICK Identifier for the FixTool diskette FSERVICE.MSG FSERVICE message file FPINST.CMD Command file for applying service through FSERVICE (uses standard response files for OS/2 Warp 3, OS/2 Warp 4, and network-related FixPaks) NLS.DLL FixTool required DLL FILEFIX.DL@ FixTool required DLL (packed file) READ.ME This file Section 3. How to Use the FixTool Zip File First, unzip the FixTool zip file onto a diskette or into a directory. You can do this by copying the self-extracting zip file into a new subdirectory and then use the following commands from an OS/2 command prompt: : cd fixt138 where is the drive that you've put the FixTool zip file on, is the directory that you've copied the self-extracting zip file to. is the fully qualified path where the file is to be unzipped to. If is not a diskette, you can also copy all the files in onto a diskette, except for FIXT138.EXE if you wish. Next, you need OS/2 boot capability. For this, you can use any of the following: - boot the install diskettes for the product you're servicing - create utility diskettes from your system and boot these - use a maintenance partition if you have one - boot through Alt-F1 and go to the command prompt - boot OS/2 as usual and then open an OS/2 session Section 4. How to Apply Service Once you have boot capability (see Section 3) and are at a command prompt, you can apply service using one of the following methods: Using FPINST Using SERVICE Using FSERVICE with a custom RESPONSE.FIL Insert the FixTool diskette you created, and then use FPINST or FSERVICE as described in Sections 4.1 and 4.3. To use SERVICE as described in Section 4.2, you must have OS/2 running without having booted from diskettes, maintenance partition, or via Alt-F1. 4.1. Using FPINST To use FPINST, go to the diskette or directory where you have FPINST.CMD and the related files, and type FPINST where is WARP3 for OS/2 Warp Version 3.0 FixPak installs, WARP4 for OS/2 Warp Version 4.0 FixPak installs, or NETWORK for LAN or network-related FixPak installs This uses FSERVICE with a standard response file. For OS/2 Base FixPaks, the response file saves an archive copy of the files it services in :\ARCHIVE. For LAN or network-related FixPaks, there is no archive or backup created. If you want to keep a backup with network-related FixPaks, use SERVICE or use FSERVICE with a custom RESPONSE.FIL. See Section 6 for more information on customizing a response file. 4.2. Using SERVICE To use SERVICE, go to the diskette or directory where you have SERVICE.EXE and the related files. If you have copied the FixTool files to a directory, you need to use the following command to set the CSFUTILPATH environment variable. Note that CSFUTILPATH defaults to A: drive, so this step is not needed if you are using diskettes for the FixTool. SET CSFUTILPATH=:\ where is the drive with the FixTool-related files and is the directory structure where you put the FixTool files. Then type SERVICE The program will prompt you for required inputs. See README.INF for more information about these panels. NOTE: To use SERVICE, you must have the OS/2 PM Shell running. You cannot run SERVICE if you have booted from install diskettes or if you pressed Alt-F1 to get to a command prompt. 4.3. Using FSERVICE To use FSERVICE from a diskette, copy your customized RESPONSE.FIL to the diskette with the FixTool files, then go to the diskette and type FSERVICE /R:RESPONSE.FIL If you have copied the FixTool files into a directory, you need to use the following command from the directory with FSERVICE.EXE and the related files (including your custom RESPONSE.FIL): FSERVICE /R:RESPONSE.FIL /S::\ where is the drive with the FixTool-related files and is the directory structure where you put the FixTool files. There are optional parameters that can be included on the FSERVICE command line. See the README.INF file for more details about these parameters. Section 5. How to Set Up the FixTool for Remote Installation If you want to speed up FixPak installation or setup a FixPak on a LAN drive for use by others (Redirected Install), follow these steps. Before you begin, I strongly recommend you go install a Virtual Floppy Disk program like SVDISK (Super Virtual Disk) or VFDISK (Virtual Floppy Disk). Go to a Web site and search on "virtual floppy" to locate. In the following examples, d: is the work drive and j: is the Virtual Floppy drive. Replace this with whatever drive letters you need to use. xr_w035 is the FixPak we are working with. First, setup a directory to hold the Fixtool code. For example, run FIXT138.EXE D:\CSF to place the FixTool into the target directory. Next, setup the FixPak directory using the diskette images. loaddskf xr_w035.1dk j: /f/y/q xcopy j: d:\xr_w035\ /h/o/t/s/e/r/v loaddskf xr_w035.2dk j: /f/y/q xcopy j: d:\xr_w035\ /h/o/t/s/e/r/v ... ... ... ... repeat for each disk image in the FixPak Install the FixPak by running service.exe. set csfutilpath=d:\csf set csfcdromdir=d:\xr_w035 d: cd csf service (or start service) You can also apply service by running fservice.exe with a response file. d: cd csf fservice /r:d:\csf\response.wp3 /s:d:\xr_w035 This will apply the FixPak to all servicable partitions. If you want to make the response file specific to a partition (drive) then you need to change the :SYSLEVEL and :ARCHIVE lines in response.wp3: :SYSLEVEL \OS2\INSTALL\SYSLEVEL.OS2 :ARCHIVE \ARCHIVE -- to -- :SYSLEVEL x:\OS2\INSTALL\SYSLEVEL.OS2 :ARCHIVE x:\ARCHIVE where x: is the drive you want serviced. Section 6. How to Customize the Response File There are three standard response files included with the FixTool that can be modified for your configuration needs. To modify a response file, copy one of the standard response files (RESPONSE.WP3, RESPONSE.WP4, or RESPONSE.LAN) to a file called RESPONSE.FIL. Modify the RESPONSE.FIL as needed, and then run FSERVICE /R:RESPONSE.FIL. The following sections show a few of the service actions you can take through a response file. For more information about response files, view the README.INF file that comes with the FixTool. 6.1. Applying Service to a Product Without an Existing Archive This response file can be used to apply service for the first time using FSERVICE when there is no existing archive of the product being serviced. It will service all partitions and place an archive in each partition. It does not take a backup of changed files. In this case, the SERVICE.LOG file will go into the C:\OS2\INSTALL directory. Files that are read-only, hidden, system, or newer will be replaced automatically during service. The FixPak source files are on A:. The FixTool will service all partitions where \OS2\INSTALL\SYSLEVEL.OS2 and \MMOS2\INSTALL\SYSLEVEL.MPM are found, and it will save the original files in an \ARCHIVE directory for each partition serviced. Note that the :LOGFILE tag is optional and may be overridden by using the /L: parameter on the FSERVICE command line. The :FLAGS and :SOURCE tags are also optional, but if used, the :SERVICE tag must be included. The :SOURCE tag can be overridden by using the /S: parameter on the FSERVICE command line. You should include a :SERVICE, :SYSLEVEL, and :ARCHIVE tag for each product to be serviced. Note that the :SERVICE, :SYSLEVEL, and :ARCHIVE tags must appear in the order shown in this example. :LOGFILE C:\OS2\INSTALL\SERVICE.LOG :FLAGS REPLACE_PROTECTED REPLACE_NEWER :SOURCE A:\ :SERVICE :SYSLEVEL \OS2\INSTALL\SYSLEVEL.OS2 :ARCHIVE \ARCHIVE :SERVICE :SYSLEVEL \MMOS2\INSTALL\SYSLEVEL.MPM :ARCHIVE \ARCHIVE 6.2. Applying Service to a Product With an Existing Archive This response file can be used to apply service using FSERVICE when there is an existing archive of the product being serviced. This demonstrates the ability to take a backup of changed files. Notice that each product serviced must be backed up to a different directory. Also note the order of the :SERVICE, :SYSLEVEL, :ARCHIVE, and :BACKUP tags. These tags must appear in this order. The :BACKUP tag is optional. :LOGFILE C:\OS2\INSTALL\SERVICE.LOG :FLAGS REPLACE_PROTECTED REPLACE_NEWER :SOURCE A:\ :SERVICE :SYSLEVEL C:\OS2\INSTALL\SYSLEVEL.OS2 :ARCHIVE C:\ARCHIVE :BACKUP C:\BACKUP :SERVICE :SYSLEVEL C:\MMOS2\INSTALL\SYSLEVEL.MPM :ARCHIVE C:\ARCHIVE :BACKUP C:\BACKUPM 6.3. Backing Out to the Archive Level of a Product This is a sample response file to be used when backing out to the archive level of a product. Note that you can only use one :TARGET tag in the response file. Also note that the :TARGET tag must appear before a :BACKOUT tag is used. :LOGFILE C:\OS2\INSTALL\SERVICE.LOG :TARGET ARCHIVE :BACKOUT :SYSLEVEL C:\OS2\INSTALL\SYSLEVEL.OS2 :BACKOUT :SYSLEVEL C:\MMOS2\INSTALL\SYSLEVEL.MPM 6.4. Backing Out to the Backup Level of a Product This is a sample response file to be used when backing out to the backup level of a product. :LOGFILE C:\OS2\INSTALL\SERVICE.LOG :TARGET BACKUP :BACKOUT :SYSLEVEL C:\OS2\INSTALL\SYSLEVEL.OS2 :BACKOUT :SYSLEVEL C:\MMOS2\INSTALL\SYSLEVEL.MPM 6.5. Committing a Product This is a sample response file to be used when committing a product. :LOGFILE C:\OS2\INSTALL\SERVICE.LOG :COMMIT :SYSLEVEL C:\OS2\INSTALL\SYSLEVEL.OS2 :COMMIT :SYSLEVEL C:\MMOS2\INSTALL\SYSLEVEL.MPM 6.6. Redirecting an Archive of a Product to Another Existing Archive This is a sample response file to be used when redirecting an archive of a product to another existing archive location. One example of this would be for using a shared network archive. Note that the archive directory specifies the location of an existing archive to which the current product is being redirected. In this example the arbitrary drive shows S:, which may be a LAN drive. :LOGFILE C:\OS2\INSTALL\SERVICE.LOG :REDIRECT :SYSLEVEL C:\OS2\INSTALL\SYSLEVEL.OS2 :ARCHIVE S:\ARCHIVE :REDIRECT :SYSLEVEL C:\MMOS2\INSTALL\SYSLEVEL.MPM :ARCHIVE S:\ARCHIVEM Section 7. If You Have a Problem If the FixPak does not install properly, there are files you can look in to find out what error occurred. The SERVICE.LOG file is the first place to look. The FixTool puts it in the directory where the SYSLEVEL file of the product being serviced is located. Section 8. Setting Environment Variables There are several SET statements that set environment variables for the FixTool to use. See the table below for a list of these variables and a description of what they do. Environment Variable Usage ------------------------------- ----------------------------------- SET CSFUTILPATH=path Allows you to run SERVICE or FSERVICE from your hard drive or from a redirected drive. SET CSFCDROMDIR=path Allows you to install a FixPak from a redirected drive or CD-ROM. SET REMOTE_INSTALL_STATE=0|1 If this variable is set to 1, then upon termination FixTool returns control to the calling process. Section 9. Common Error Messages Here are some common error messages that you may receive when running SERVICE. - Error message: An error occurred while searching for files to update. The reason may be old or corrupt CSF logfiles, CSF_SEL.000 file, or file system corruption. See README file for more information. Explanation: You may get this if you have used the new FixTool to install a FixPak, and then try to use the old FixTool. Solution: If you are installing a LAN FixPak, you can delete all the LOGF0000.xxx and LOGSTART.xxx files on your system, and reapply the FixPak. If you are installing an OS/2 FixPak, you will also need to copy your original SYSLEVEL.OS2 file back into the \OS2\INSTALL directory. - Error message: No products were found on the target system to service. Explanation: Your SYSLEVEL.xxx file does not contain the proper pre-requisite FixPak number or product information. In order to install a FixPak, the number of the FixPak must be higher than the number of the current CSD in the SYSLEVEL.xxx file, or the product information must match. Solution: Check the pre-requisites needed for the FixPak you are trying to install. Some FixPaks have a particular FixPak that must be installed prior to installing that FixPak. Also, make sure that the FixPak you are trying to install is one that may be applied to that product. If the product information is incorrect, you may need to copy the product SYSLEVEL.xxx file from the install media. Here's a common error message that you might see when running FSERVICE. - Error message: CSF257: No product has been selected. Explanation: This error message is reported in several situations. You may not have selected a product to service in the RESPONSE.FIL, or FSERVICE may not have found any products to service. If FSERVICE didn't find any products to service, either the product information on the system did not match the product information in the FixPak, or FSERVICE determined that the FixPak would back-level the system. Solution: Check the pre-requisites for the FixPak and make sure that the system contains the proper pre-requisites. Also, be sure that the FixPak you are trying to install is being applied to the appropriate product. If the product information is incorrect, you may need to copy the product SYSLEVEL.xxx file from the install media. Section 10. Known Problems Problem Description: On some systems, you may get an unpack error for the file IBMCSFLK.PK@. If this occurs, you will see the following in your SERVICE.LOG file: Unpack( source, destination ) failed with rc 5. Retrying unpack for IBMCSFLK.PK@... where source is the location of the IBMCSFLK.PK@ file, and destination is the location for the unpacking. It will try to unpack the file several times, and then finally report: Error unpacking the file IBMCSFLK.PK@. Workaround: Exit and restart service. The error should be resolved on the second attempt.