home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 28 Fixes4x / 28-Fixes4x.zip / fixt139.exe / read.me < prev    next >
Text File  |  1998-08-20  |  22KB  |  540 lines
  1.                 Readme for Corrective Service Facility 2-B
  2.                               Version 1.39
  3.  
  4.                       ****************************
  5.  
  6.  
  7. This readme file describes the new features available with Version 1.39 of the
  8. Corrective Service Facility (referred to in this document as the FixTool).
  9. Once you use this version of the FixTool to service a product, you will not
  10. be able to use Version 1.37B or earlier because this version modifies
  11. SYSLEVEL files and versions prior to 1.38 did not.
  12.  
  13. CONTENTS:
  14.  
  15. Section 1.  New Features with Version 1.39
  16. Section 2.  Files Included in the FixTool EXE File
  17. Section 3.  How to Use the FixTool EXE (Zip) File
  18. Section 4.  How to Apply Service
  19. Section 5.  How to Set Up the FixTool for Remote Installation
  20. Section 6.  How to Customize the Response File
  21. Section 7.  If You Have a Problem
  22. Section 8.  Setting Environment Variables
  23. Section 9.  Common Error Messages
  24.  
  25. ================================================
  26.  
  27. Section 1.  New Features with Version 1.39
  28.  
  29. You can tell if you have Version 1.39 by running BLDLEVEL on SERVICE.EXE or
  30. FSERVICE.EXE.  You will see one of the following, depending on which version of
  31. BLDLEVEL.EXE you have.
  32.  
  33.   Signature:       @#IBM:F.139#@ OS/2 Corrective Service Facility (C) IBM 1994
  34.   Vendor:          IBM
  35.   Revision:        0.139
  36.   File Version:    0.139
  37.   Description:     OS/2 Corrective Service Facility (C) IBM 1994
  38.  
  39.   Signature:   @#IBM:F.139#@ OS/2 Corrective Service Facility (C) IBM 1994
  40.   Vendor:      IBM
  41.   Revision:    F.139
  42.   Description: OS/2 Corrective Service Facility (C) IBM 1994
  43.  
  44. The new version of the FixTool (Corrective Service Facility) updates the
  45. current CSD field in the SYSLEVEL files of the products it services.  After
  46. applying a FixPak with Version 1.38, you will be able to run SYSLEVEL and
  47. tell what FixPaks you have applied by looking at the current field of the
  48. product's SYSLEVEL file.
  49.  
  50. This version is also compatible with Software Choice features.  If you need to
  51. use Software Choice to install new features for a product, the FixTool will
  52. integrate SYSLEVEL and archive information from the Software Choice install the
  53. next time it services that product.
  54.  
  55.  
  56. Section 2.  Files Included in the FixTool EXE File
  57.  
  58. The following files are included in the FixTool EXE (Zip) file:
  59.  
  60. File            Use
  61. --------------  -----------------------------------------------------------
  62. BUILD.LVL       Contains build information for this Fixtool release.
  63. CSFPANS.DLL     Used by FSERVICE
  64. SERVICE.EXE     Executable for applying service through a windowed session
  65. SERVICE.HLP     SERVICE help file
  66. SHPIINST.DLL    FixTool required DLL
  67. UNPACK.EXE      Used to unpack files being serviced
  68. UNPACK2.EXE     Used to unpack files being serviced
  69. VIOCALLS.DLL    FixTool required DLL
  70. FSERVICE.EXE    Executable for applying service through a command line
  71.                 (used with a response file).
  72. IBMCSFLK.DLL    Locked file device driver file
  73. IBMCSFLK.EXE    Locked file device driver file
  74. IBMCSFLK.SYS    Locked file device driver file
  75. IBMCSFLK.MSG    Locked file device driver file
  76. PACK.EXE        Used to pack files being archived or backed up
  77. README.INF      General Installation instructions for the FixTool
  78. RESPONSE.LAN    Response file for servicing network-related products
  79. RESPONSE.WP3    Response file for servicing OS/2 Warp v3 base
  80. RESPONSE.WP4    Response file for servicing OS/2 Warp v4 base
  81. FSERVICE.MSG    FSERVICE message file
  82. FPINST.CMD      Command file for applying service through FSERVICE
  83.                 (uses standard response files for OS/2 Warp 3, OS/2 Warp 4,
  84.                  and network-related FixPaks)
  85. NLS.DLL         FixTool required DLL
  86. MSG.DLL         FixTool required DLL
  87. FILEFIX.DLL     FixTool required DLL
  88. READ.ME         This file
  89.  
  90. Section 3.  How to Use the FixTool EXE (Zip) File
  91.  
  92. First, unzip the FixTool zip file onto a diskette or into a directory.  You can
  93. do this by copying the self-extracting zip file into a new subdirectory and
  94. then use the following commands from an OS/2 command prompt:
  95.  
  96.         <d>:
  97.         cd <directory>
  98.         CSx139 <target>
  99.  
  100. where <d>         is the drive that you've put the FixTool zip file on,
  101.       <directory> is the directory that you've copied the self-extracting
  102.                   zip file to.
  103.       x           Country code, where '_' is the US country code. Other NLV
  104.                   country codes are identical to the Country code used in
  105.                   FixPak's.
  106.       <target>    is the fully qualified path where the file is to be
  107.                   unzipped to.
  108.  
  109. If <target> is not a diskette, you can also copy all the files in <target>
  110. onto a diskette, except for CSx139.EXE if you wish.
  111.  
  112. Next, you need OS/2 boot capability.  For this, you can use any of the
  113. following:
  114.  
  115.    - boot the install diskettes for the product you're servicing
  116.    - create utility diskettes from your system and boot these
  117.    - use a maintenance partition if you have one
  118.    - boot through Alt-F1 and go to the command prompt
  119.    - boot OS/2 as usual and then open an OS/2 session
  120.  
  121.  
  122. Section 4.  How to Apply Service
  123.  
  124. Once you have boot capability (see Section 3) and are at a command prompt,
  125. you can apply service using one of the following methods:
  126.  
  127.         Using FPINST
  128.         Using SERVICE
  129.         Using FSERVICE with a custom RESPONSE.FIL
  130.  
  131. Insert the FixTool diskette you created, and then use FPINST or FSERVICE
  132. as described in Sections 4.1 and 4.3.  To use SERVICE as described in
  133. Section 4.2, you must have OS/2 running without having booted from
  134. diskettes, maintenance partition, or via Alt-F1.
  135.  
  136. 4.1.  Using FPINST
  137.  
  138. To use FPINST, go to the diskette or directory where you have FPINST.CMD
  139. and the related files, and type
  140.  
  141.         FPINST <fixpak_type>
  142.  
  143. where   <fixpak_type> is
  144.  
  145.         WARP3     for OS/2 Warp Version 3.0 FixPak installs,
  146.         WARP4     for OS/2 Warp Version 4.0 FixPak installs, or
  147.         NETWORK   for LAN or network-related FixPak installs
  148.  
  149. This uses FSERVICE with a standard response file.  For OS/2 Base FixPaks, the
  150. response file saves an archive copy of the files it services in
  151. <boot_drive>:\ARCHIVE.  For LAN or network-related FixPaks, there is no archive
  152. or backup created.  If you want to keep a backup with network-related FixPaks,
  153. use SERVICE or use FSERVICE with a custom RESPONSE.FIL.  See Section 6 for more
  154. information on customizing a response file.
  155.  
  156. 4.2.  Using SERVICE
  157.  
  158. To use SERVICE, go to the diskette or directory where you have SERVICE.EXE and
  159. the related files.  Then type
  160.  
  161.         SERVICE
  162.  
  163. The program will prompt you for required inputs.  See README.INF for more
  164. information about these panels.
  165.  
  166. With version 1.39 of the FixTool, the CSFUTILPATH defaults to the path that you
  167. have executed SERVICE from, so you do not need to set this environment variable
  168. if all the FixTool files are in the same directory with SERVICE.EXE.
  169.  
  170. NOTE:  To use SERVICE, you must have the OS/2 PM Shell running.  You cannot
  171.        run SERVICE if you have booted from install diskettes or if you pressed
  172.        Alt-F1 to get to a command prompt.
  173.  
  174. 4.3.  Using FSERVICE
  175.  
  176. To use FSERVICE from a diskette, copy your customized RESPONSE.FIL to the
  177. diskette with the FixTool files, then go to the diskette and type
  178.  
  179.         FSERVICE /R:RESPONSE.FIL
  180.  
  181. If you have copied the FixTool files into a directory, you need to use the
  182. following command from the directory with FSERVICE.EXE and the related files
  183. (including your custom RESPONSE.FIL):
  184.  
  185.         FSERVICE /R:RESPONSE.FIL /S:<d>:\<directory>
  186.  
  187. where <d> is the drive with the FixTool-related files and
  188.       <directory> is the directory structure where you put the FixTool files.
  189.  
  190. There are optional parameters that can be included on the FSERVICE command
  191. line.  See the README.INF file for more details about these parameters.
  192.  
  193.  
  194. Section 5.  How to Set Up the FixTool for Remote Installation
  195.  
  196. If you want to speed up FixPak installation or setup a FixPak on a LAN drive
  197. for use by others (Redirected Install), follow these steps.
  198.  
  199. Before you begin, I strongly recommend you go install a Virtual Floppy Disk
  200. program like SVDISK (Super Virtual Disk) or VFDISK (Virtual Floppy Disk).  Go
  201. to a Web site and search on "virtual floppy" to locate.
  202.  
  203. In the following examples, d:  is the work drive and j: is the Virtual Floppy
  204. drive.  Replace this with whatever drive letters you need to use. xr_w035 is
  205. the FixPak we are working with.
  206.  
  207. First, setup a directory to hold the Fixtool code. For example,
  208. run CS_139.EXE D:\CSF to place the FixTool into the target directory.
  209.  
  210. Next, setup the FixPak directory using the diskette images.
  211.  
  212.         loaddskf xr_w035.1dk j: /f/y/q
  213.         xcopy j: d:\xr_w035\ /h/o/t/s/e/r/v
  214.         loaddskf xr_w035.2dk j: /f/y/q
  215.         xcopy j: d:\xr_w035\ /h/o/t/s/e/r/v
  216.         ...     ...     ...     ...
  217.         repeat for each disk image in the FixPak
  218.  
  219.  
  220. Install the FixPak by running service.exe.
  221.  
  222.         set csfutilpath=d:\csf
  223.         set csfcdromdir=d:\xr_w035
  224.         d:
  225.         cd csf
  226.         service  (or start service)
  227.  
  228. You can also apply service by running fservice.exe with a response file.
  229.  
  230.         d:
  231.         cd csf
  232.         fservice /r:d:\csf\response.wp3 /s:d:\xr_w035
  233.  
  234.         This will apply the FixPak to all servicable partitions.  If you want
  235.         to make the response file specific to a partition (drive) then you need
  236.         to change the :SYSLEVEL and :ARCHIVE lines in response.wp3:
  237.  
  238.         :SYSLEVEL \OS2\INSTALL\SYSLEVEL.OS2
  239.         :ARCHIVE \ARCHIVE
  240.  
  241.         -- to --
  242.  
  243.         :SYSLEVEL x:\OS2\INSTALL\SYSLEVEL.OS2
  244.         :ARCHIVE x:\ARCHIVE
  245.  
  246. where x: is the drive you want serviced.
  247.  
  248.  
  249. Section 6.  How to Customize the Response File
  250.  
  251. There are three standard response files included with the FixTool that can be
  252. modified for your configuration needs.  To modify a response file, copy one of
  253. the standard response files (RESPONSE.WP3, RESPONSE.WP4, or RESPONSE.LAN) to a
  254. file called RESPONSE.FIL.  Modify the RESPONSE.FIL as needed, and then run
  255. FSERVICE /R:RESPONSE.FIL.
  256.  
  257. The following sections show a few of the service actions you can take through
  258. a response file.  For more information about response files, view the README.INF
  259. file that comes with the FixTool.
  260.  
  261. 6.1.  Applying Service to a Product Without an Existing Archive
  262.  
  263. This response file can be used to apply service for the first time using
  264. FSERVICE when there is no existing archive of the product being serviced.  It
  265. will service all partitions and place an archive in each partition.  It does
  266. not take a backup of changed files.
  267.  
  268. In this case, the SERVICE.LOG file will go into the C:\OS2\INSTALL directory.
  269. Files that are read-only, hidden, system, or newer will be replaced
  270. automatically during service.  The FixPak source files are on A:. The FixTool
  271. will service all partitions where \OS2\INSTALL\SYSLEVEL.OS2 and
  272. \MMOS2\INSTALL\SYSLEVEL.MPM are found, and it will save the original files in
  273. an \ARCHIVE directory for each partition serviced.
  274.  
  275. Note that the :LOGFILE tag is optional and may be overridden by using the /L:
  276. parameter on the FSERVICE command line.  The :FLAGS and :SOURCE tags are also
  277. optional, but if used, the :SERVICE tag must be included.  The :SOURCE tag can
  278. be overridden by using the /S:  parameter on the FSERVICE command line.  You
  279. should include a :SERVICE, :SYSLEVEL, and :ARCHIVE tag for each product to be
  280. serviced.  Note that the :SERVICE, :SYSLEVEL, and :ARCHIVE tags must appear in
  281. the order shown in this example.
  282.  
  283. :LOGFILE C:\OS2\INSTALL\SERVICE.LOG
  284. :FLAGS REPLACE_PROTECTED REPLACE_NEWER
  285. :SOURCE A:\
  286. :SERVICE
  287. :SYSLEVEL \OS2\INSTALL\SYSLEVEL.OS2
  288. :ARCHIVE \ARCHIVE
  289. :SERVICE
  290. :SYSLEVEL \MMOS2\INSTALL\SYSLEVEL.MPM
  291. :ARCHIVE \ARCHIVEM
  292.  
  293. For OS/2 Warp 4 systems, the multimedia lines are not needed in the response
  294. file.  So, the last three lines in the previous example should be removed or
  295. commented out of the response file for OS/2 Warp 4.0.
  296.  
  297. 6.2.  Applying Service to a Product With an Existing Archive
  298.  
  299. This response file can be used to apply service using FSERVICE when there is an
  300. existing archive of the product being serviced.  This demonstrates the ability
  301. to take a backup of changed files.
  302.  
  303. Notice that each product serviced must be backed up to a different directory,
  304. so the drive must be explicitly defined in the :SYSLEVEL, :ARCHIVE, and :BACKUP
  305. lines.  Also note the order of the :SERVICE, :SYSLEVEL, :ARCHIVE, and :BACKUP
  306. tags.  These tags must appear in this order.  The :BACKUP tag is optional.
  307.  
  308. :LOGFILE C:\OS2\INSTALL\SERVICE.LOG
  309. :FLAGS REPLACE_PROTECTED REPLACE_NEWER
  310. :SOURCE A:\
  311. :SERVICE
  312. :SYSLEVEL C:\OS2\INSTALL\SYSLEVEL.OS2
  313. :ARCHIVE C:\ARCHIVE
  314. :BACKUP C:\BACKUP
  315. :SERVICE
  316. :SYSLEVEL C:\MMOS2\INSTALL\SYSLEVEL.MPM
  317. :ARCHIVE C:\ARCHIVEM
  318. :BACKUP C:\BACKUPM
  319.  
  320. For OS/2 Warp 4.0, the last four lines are not needed in the response file.
  321.  
  322. 6.3.  Backing Out to the Archive Level of a Product
  323.  
  324. This is a sample response file to be used when backing out to the archive level
  325. of a product.  Note that you can only use one :TARGET tag in the response file.
  326. Also note that the :TARGET tag must appear before a :BACKOUT tag is used.
  327.  
  328. :LOGFILE C:\OS2\INSTALL\SERVICE.LOG
  329. :TARGET ARCHIVE
  330. :BACKOUT
  331. :SYSLEVEL C:\OS2\INSTALL\SYSLEVEL.OS2
  332. :BACKOUT
  333. :SYSLEVEL C:\MMOS2\INSTALL\SYSLEVEL.MPM
  334.  
  335. For OS/2 Warp 4.0, you do not need to include the last two lines of this
  336. example in your response file.
  337.  
  338. 6.4.  Backing Out to the Backup Level of a Product
  339.  
  340. This is a sample response file to be used when backing out to the backup level
  341. of a product.
  342.  
  343. :LOGFILE C:\OS2\INSTALL\SERVICE.LOG
  344. :TARGET BACKUP
  345. :BACKOUT
  346. :SYSLEVEL C:\OS2\INSTALL\SYSLEVEL.OS2
  347. :BACKOUT
  348. :SYSLEVEL C:\MMOS2\INSTALL\SYSLEVEL.MPM
  349.  
  350. For OS/2 Warp 4.0, you do not need to include the last two lines of this
  351. example in your response file.
  352.  
  353. 6.5.  Committing a Product
  354.  
  355. This is a sample response file to be used when committing a product.
  356.  
  357. :LOGFILE C:\OS2\INSTALL\SERVICE.LOG
  358. :COMMIT
  359. :SYSLEVEL C:\OS2\INSTALL\SYSLEVEL.OS2
  360. :COMMIT
  361. :SYSLEVEL C:\MMOS2\INSTALL\SYSLEVEL.MPM
  362.  
  363. For OS/2 Warp 4.0, do not include the last two lines of this example in your
  364. response file.
  365.  
  366. 6.6.  Redirecting an Archive of a Product to Another Existing Archive
  367.  
  368. This is a sample response file to be used when redirecting an archive of a
  369. product to another existing archive location.  One example of this would be for
  370. using a shared network archive.  Note that the archive directory specifies the
  371. location of an existing archive to which the current product is being
  372. redirected.  In this example the arbitrary drive shows S:, which may be a LAN
  373. drive.
  374.  
  375. :LOGFILE C:\OS2\INSTALL\SERVICE.LOG
  376. :REDIRECT
  377. :SYSLEVEL C:\OS2\INSTALL\SYSLEVEL.OS2
  378. :ARCHIVE S:\ARCHIVE
  379. :REDIRECT
  380. :SYSLEVEL C:\MMOS2\INSTALL\SYSLEVEL.MPM
  381. :ARCHIVE S:\ARCHIVEM
  382.  
  383. For OS/2 Warp 4.0, do not include the last three lines of this example in
  384. your response file.
  385.  
  386.  
  387. Section 7.  If You Have a Problem
  388.  
  389. If the FixPak does not install properly, there are files you can look in
  390. to find out what error occurred.  The SERVICE.LOG file is the first place
  391. to look.  The FixTool puts it in the directory where the SYSLEVEL file
  392. of the product being serviced is located.
  393.  
  394.  
  395. Section 8.  Setting Environment Variables
  396.  
  397. There are several SET statements that set environment variables for the
  398. FixTool to use.  See the table below for a list of these variables and
  399. a description of what they do.
  400.  
  401.    Environment Variable              Usage
  402.    -------------------------------   -----------------------------------
  403.    SET CSFUTILPATH=path              Allows you to run SERVICE or
  404.                                      FSERVICE from your hard drive or
  405.                                      from a redirected drive.
  406.  
  407.    SET CSFCDROMDIR=path              Allows you to install a FixPak
  408.                                      from a redirected drive or CD-ROM.
  409.  
  410.    SET REMOTE_INSTALL_STATE=0|1      If this variable is set to 0, then
  411.                                      upon termination FixTool returns
  412.                                      control to the calling process.
  413.  
  414.  
  415. Section 9.  Common Error Messages
  416.  
  417. Here are some common error messages that you may receive when running
  418. SERVICE.
  419.  
  420.     - Error message:
  421.       An error occurred while searching for files to update.
  422.       The reason may be old or corrupt CSF logfiles, CSF_SEL.000
  423.       file, or file system corruption.  See README file for more
  424.       information.
  425.  
  426.       Explanation:
  427.       You may get this if you have used the new FixTool (version
  428.       1.38 or 1.39) to install a FixPak, and then try to use an
  429.       old version of the FixTool (version 1.37B or earlier).
  430.  
  431.       Solution:
  432.       If you are installing a LAN FixPak, you can delete all the
  433.       LOGF0000.xxx and LOGSTART.xxx files on your system, and
  434.       reapply the FixPak.  If you are installing an OS/2 FixPak,
  435.       you will also need to copy your original SYSLEVEL.OS2 file
  436.       back into the \OS2\INSTALL directory.
  437.  
  438.     - Error message:
  439.       No products were found on the target system to service.
  440.  
  441.       Explanation:
  442.       Your SYSLEVEL.xxx file does not contain the proper
  443.       prerequisite FixPak number or product information.  In
  444.       order to install a FixPak, the number of the FixPak must
  445.       be higher than the number of the current CSD in the
  446.       SYSLEVEL.xxx file, or the product information must match.
  447.  
  448.       Solution:
  449.       Check the prerequisites needed for the FixPak you are
  450.       trying to install.  Some FixPaks have a particular FixPak
  451.       that must be installed prior to installing that FixPak.
  452.       Also, make sure that the FixPak you are trying to install
  453.       is one that may be applied to that product.  If the product
  454.       information is incorrect, you may need to copy the product
  455.       SYSLEVEL.xxx file from the install media.
  456.  
  457.     - Error message:
  458.       Error reading file <path>\IBMCSFLK.DLL.
  459.  
  460.       Explanation:
  461.       FixTool could not find the files needed for servicing.
  462.  
  463.       Solution:
  464.       Make sure that you've set the CSFUTILPATH and CSFCDROMDIR
  465.       environment variables if you're running service from a hard
  466.       drive.  The CSFUTILPATH should point to the directory that
  467.       contains the FixTool files (SERVICE.EXE, FSERVICE.EXE, etc.),
  468.       and CSFCDROMDIR should point to the directory that contains
  469.       the FixPak files (with the FIX directory).  Also make sure
  470.       that all the files listed in Section 2 are in your FixTool
  471.       file directory.
  472.  
  473.     - Error message:
  474.       No source drive is available.
  475.  
  476.       Explanation:
  477.       The FixTool first checks for removable drives on the system.
  478.       If there are no removable drives, you will get this error
  479.       message if you have not set the CSFCDROMDIR to point to a valid
  480.       hard drive or LAN drive.
  481.  
  482.       Solution:
  483.       Set the CSFCDROMDIR to point to the drive and directory that
  484.       contain the FixPak files.
  485.  
  486. Here are some common error messages that you might see when running
  487. FSERVICE.
  488.  
  489.     - Error message:
  490.       CSF257: No product has been selected.
  491.  
  492.       Explanation:
  493.       This error message is reported in several situations.  You may
  494.       not have selected a product to service in the RESPONSE.FIL, or
  495.       FSERVICE may not have found any products to service.  If FSERVICE
  496.       didn't find any products to service, either the product information
  497.       on the system did not match the product information in the FixPak,
  498.       or FSERVICE determined that the FixPak would back-level the system.
  499.  
  500.       Solution:
  501.       Check the prerequisites for the FixPak and make sure that the
  502.       system contains the proper pre-requisites.  Also, be sure that
  503.       the FixPak you are trying to install is being applied to the
  504.       appropriate product.  If the product information is incorrect,
  505.       you may need to copy the product SYSLEVEL.xxx file from the
  506.       install media.
  507.  
  508.     - Error message:
  509.       This portion of service has completed.  Reboot your
  510.       system before applying additional service or using the product
  511.       to process files that were locked during service.
  512.  
  513.       Explanation:
  514.       This appears as a red screen with a title of "Corrective Service
  515.       Facility Fatal Error," but the message may not indicate an error.
  516.       Please view the service.log file by pressing Enter.  This screen
  517.       appears after doing a backout with FSERVICE so that you can check
  518.       the log file to make sure there are no errors before you reboot
  519.       your system.
  520.  
  521.       Solution:
  522.       Make sure that there are no errors logged and then press Ctrl-Break
  523.       to exit service.  If there were no errors in the log file, then
  524.       FSERVICE completed successfully and it's safe to reboot your system.
  525.  
  526.     - Error message:
  527.       Error reading file <path>\IBMCSFLK.DLL.
  528.  
  529.       Explanation:
  530.       FixTool could not find the files needed for servicing.
  531.  
  532.       Solution:
  533.       Make sure that all the files listed in Section 2 are in the
  534.       directory (or on the diskette) with the FixTool files.  Also,
  535.       make sure your /S: parameter path is valid.  It should contain the
  536.       FixPak files with the FIX directory.  Sometimes you may need to
  537.       include the /S: parameter--even if you have set SOURCE properly in
  538.       the response file.
  539.  
  540.