home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / jumpkey.zip / readme.cid < prev    next >
Text File  |  1996-06-15  |  12KB  |  401 lines
  1. (c) Copyright International Business Machines Corporation 1996.
  2.  
  3.  
  4.                 VERSION 2.3.0    15 June     1996
  5.  
  6.  
  7. How to Install JumpKey/2 from a LAN Server
  8. ==========================================
  9. If you want to install JumpKey/2 on several
  10. workstations, you can install it without using diskettes.
  11. Follow these steps:
  12.   o Create a directory on the LAN server to store the JumpKey/2
  13.     files, for example:
  14.        MKDIR J:\JUMPKEY
  15.   o Copy each JumpKey/2 diskette into this directory using
  16.     the XCOPY command, for example:
  17.        XCOPY a:*.* J:\JUMPKEY /S
  18.   o Install JumpKey/2 by typing INSTALL at the command prompt
  19.     and pressing Enter.
  20.  
  21.  
  22. How to Install JumpKey/2 from a Diskette or CD-ROM
  23. ==================================================
  24. To install JumpKey/2 onto your workstation from diskette or CD-ROM,
  25. for example, type INSTALL, and press Enter.
  26.  
  27.  
  28. How to Create a Response File
  29. =============================
  30. Response files are used to provide data that is normally entered manually
  31. when JumpKey/2 is installed. A sample response file is provided
  32. as a template for your use. This file,
  33.         JMP230.RSP
  34. along with the .CMD file that starts the install:
  35.         JUMPCID.CMD
  36. allow for an automated hands-off installation. To customize the
  37. installation for your environment, you must modify the response
  38. file or the .CMD file.
  39.  
  40.  
  41. Response File Format and Keywords
  42. =================================
  43.  
  44. This product supports the following keywords:
  45. ---------------------------------------------
  46. CFGUPDATE (required)
  47. Specifies whether the CONFIG.SYS file is automatically updated.
  48. Valid values for this keyword are:
  49.  
  50.          AUTO             Automatically updates CONFIG.SYS
  51.          MANUAL           Does not update CONFIG.SYS
  52. JumpKey does not require that CONFIG.SYS be updated unless you want to
  53. run it from the command line.
  54. ---------------
  55.  
  56. COMP
  57. Specifies the unique name of a component of the product
  58. for which passed information applies.
  59. There can be a maximum of 100 components.
  60. The COMP value must match the NAME keyword of the COMPONENT entry in the
  61. package file.
  62.  
  63. JumpKey 2.2.1 provides 3 components:
  64.     JMPBASE - base code. Required for all installations
  65.     JMPUSE  - US 101-Key Keyboard Support
  66.     JMPUKE  - UK 102-Key Keyboard Support
  67. Always specify
  68.     COMP=JMPBASE
  69. then choose ONE keyboard support package. Do NOT choose both:
  70.     COMP=JMPUSE
  71. or
  72.     COMP=JMPUKE
  73. ---------------
  74.  
  75. DELETEBACKUP
  76. Specifies whether to delete only the backup versions of the
  77. product or to delete the entire product.
  78. Valid values for this keyword are YES and NO.
  79. It is required because an existing
  80. dialog requests this information in the attended mode.
  81.  
  82. If an unattended delete is attempted
  83. and the DELETEBACKUP is not present in the response file, the
  84. deletion fails with an EPFIE212 error.
  85. ---------------
  86.  
  87. FILE
  88. Provides the new default path for the file directory.
  89. This keyword is used only for installation processing.
  90.  
  91. This FILE value is used in place of the FILE keyword of the PATH entry in
  92. the package file.
  93. ---------------
  94.  
  95. OVERWRITE
  96. Specifies whether to automatically overwrite files during
  97. installation.  Valid values for this keyword are YES and NO.
  98. ---------------
  99.  
  100. SAVEBACKUP
  101. Specifies whether to save a backup version of the product when it
  102. is updated.  Valid values for this keyword are YES and NO.
  103. It is required for unattended processing because an existing
  104. dialog requests this information in the attended mode.
  105. ---------------
  106.  
  107. Response File Details
  108. =====================
  109. A response file is a flat ASCII file
  110. that consists of a series of lines separated by newline sequences
  111. (0x0A, 0x0D, or a combination of these two sequences).
  112.  
  113. Each line in a response file has a maximum line length of 255 bytes.
  114.  
  115. A response file has two kinds of lines:
  116.  
  117. Comment lines
  118. -------------
  119. Comment lines contain only white space characters
  120. or have either an asterisk (*) or a semicolon (;)
  121. as the first nonwhite space character on the line.
  122.  
  123. Response lines
  124. --------------
  125. Response lines are used by Software Installer
  126. to determine the options
  127. and configurations to install on the target system.
  128.  
  129. Response lines have the following syntax:
  130.  
  131. keyword = value
  132.  
  133. Keywords cannot contain imbedded spaces.
  134. Keywords are not case-sensitive.
  135. You can group keywords together
  136. in value lists using the following syntax:
  137.  
  138. keyword = (
  139.            keyword1 = value
  140.            keyword2 = value
  141.            .
  142.            .
  143.            keywordn = value
  144.           )
  145.  
  146.  
  147.  
  148. Using Command Line Parameters
  149. =============================
  150. If no parameters are specified when the executable file is started,
  151. the installation is attended.
  152. To install in an unattended mode, the /X parameter must be used.
  153. Unattended includes what is sometimes referred to as lightly attended.
  154. In the lightly attended mode, someone might have to start
  155. an executable file or insert diskettes.
  156.  
  157. If the value of any of the parameters contains spaces,
  158. use double quotes to enclose the value.
  159.  
  160. Values can be upper or lower case.
  161. Parameters can be in any order.
  162.  
  163. <command> /A:<action>
  164.           /C:JMP230.ICF
  165.           /L:<xpos,ypos>
  166.           /L1:<error log>
  167.           /L2:<history log>
  168.           /O:<originating system>
  169.           /P:"IBM JumpKey/2"
  170.           /R:JMP230.RSP
  171.           /S:<source location>
  172.           /T:<install target directory>
  173.           /TU:<update CONFIG.SYS directory>
  174.           /X  <interactive_flag>
  175.  
  176. The /A, /C, and /P parameters are required for an installation
  177. that is started with the EPFINSTS command.
  178. If the action is an install or an update, the /O is also required.
  179. Note:
  180. The drive/directory/filename path is required
  181. for all log parameters specified
  182. with the INSTALL.EXE or EPFIDLDS.EXE commands.
  183. The directories for log files must exist before starting the commands.
  184.  
  185.  
  186. Parameter Definitions
  187. =====================
  188. The command prompt parameters are:
  189.  
  190. /A:<action>
  191. Specifies the action of the EPFINSTS.EXE.
  192. If you use this parameter,
  193. the main window of the installation is not displayed.
  194. If you do not use this parameter,
  195. the installation starts normally with all windows displayed.
  196. Valid values for this parameter are:
  197.  
  198. 'D'  For delete
  199. 'I'  For install
  200. 'R'  For restore
  201. 'U'  For update
  202.  
  203. The installation program sets the EPFIACTION installation
  204. variable to the action.
  205.  
  206. /C:JMP230.ICF
  207. Specifies the name and location of the catalog file that
  208. you want to be opened automatically.
  209.  
  210. If the catalog file is located on a host session, the
  211. host session ID must precede the catalog file name.  If the
  212. catalog file is located on a drive, a drive and directory must
  213. precede the catalog file name.
  214. The installation program sets the EPFICATALOG installation
  215. variable to the name of the catalog file.
  216.  
  217. The following examples show how to use
  218. this parameter for each installation source.
  219.  
  220.   o For Drive:   /C:A:\DISK1.ICF
  221.   o For MVS:    /C:B:EPF.V1R2M0.SEPFBENU(EPFICAT)
  222.   o For VM:     /C:"B:EPFICAT ENUEPF12 *"
  223.   o For VSE:    /C:B:LIB.SUBLIB.MEMBERNAME.MEMBERTYPE
  224.  
  225. If only the host session ID is specified,
  226. for example, B:,
  227. the Open catalog window
  228. is displayed with B: as the default session or drive.
  229.  
  230. /L:<xpos,ypos>
  231. Specifies the initial horizontal and vertical coordinates
  232. of the initial installation window on the Workplace Shell
  233. relative to the lower-left corner of the screen.
  234. If this parameter is specified,
  235. all previously saved default positions are overridden.
  236. The installation program sets the EPFIWNDCOORDS installation
  237. variable to the coordinates of the Installation and Maintenance window.
  238.  
  239. /L1:<error log>
  240. Specifies the drive, path, and file name of the error log file.
  241. The installation program sets the EPFIERRORLOG installation
  242. variable to the name of the error log.
  243.  
  244. The drive/directory/filename path is required.
  245. The directory for the log file must already exist.
  246.  
  247. All lines logged to the error file are prefixed with a time stamp.
  248. The time stamp has the following format:
  249.  
  250. YYYY-MM-DD HH:mm:SS:cc
  251.  
  252. Where:
  253.  
  254.  YYYY is the year.
  255.  MM is the month.
  256.  DD is the day.
  257.  HH is the hour.
  258.  mm is the minute.
  259.  SS is the second.
  260.  cc is the hundredth of a second.
  261.  
  262. The date and time separators are the current user-defined settings in
  263. the Country object of the System Settings folder.
  264. The default separators are the hyphen and the colon, respectively.
  265. Example of using the /L1 parameter to create ERROR.LOG file in the
  266. C:\ABC\ directory:
  267.  
  268.    /L1:C:\ABC\ERROR.LOG
  269.  
  270.  
  271. /L2:<history log>
  272. Specifies the drive, path, and file name of the history log file.
  273. The installation program sets the EPFIHISTORYLOG installation
  274. variable to the name of the history log.
  275.  
  276. The drive/directory/filename path is required.
  277. The directory for the log file must already exist.
  278.  
  279. If this parameter is not specified, no history log is maintained.
  280.  
  281. All lines logged to the history file are prefixed with a time stamp.
  282. The time stamp has the following format:
  283.  
  284. YYYY-MM-DD HH:mm:SS:cc
  285.  
  286. Where:
  287.  
  288.  YYYY is the year.
  289.  MM is the month.
  290.  DD is the day.
  291.  HH is the hour.
  292.  mm is the minute.
  293.  SS is the second.
  294.  cc is the hundredth of a second.
  295.  
  296. The date and time separators are the current user-defined settings in
  297. the Country object of the System Settings folder.
  298. The default separators  are the hyphen and the colon, respectively.
  299. Example of using the /L2 parameter to create HISTORY.LOG file in the
  300. C:\ABC\ directory:
  301.  
  302.    /L2:C:\ABC\HISTORY.LOG
  303.  
  304.  
  305. /O:<originating system>
  306. Specifies the originating system of the installation.
  307. Valid values are:
  308.  
  309.   o DRIVE
  310.   o MVS
  311.   o VM
  312.   o VSE
  313.  
  314. The installation program sets the EPFISOURCE installation
  315. variable to one of these values.
  316.  
  317. /P:"IBM JumpKey/2"
  318. Provides the name of the product for the specified action.
  319.  
  320. If you do not use this parameter, the installation
  321. comes up normally with all windows displayed.
  322.  
  323. /R:JMP230.RSP
  324. Specifies the drive, path, and file name
  325. of the specific response file.
  326.  
  327. /S:<source_location>
  328. Specifies the drive and path
  329. that contains the source files to install.
  330.  
  331. If this parameter is not specified,
  332. the value of the HOSTLOC keyword is not overridden.
  333. Example:
  334.  
  335.    /S:L:\XYZ
  336.  
  337. /T:<install target directory>
  338. Specifies the drive and path
  339. where the product files are installed.
  340. If this parameter is specified, it overrides the FILE paths
  341. that are specified in the response files and the package files.
  342. Example:
  343.  
  344.    /T:C:\JUMPKEY
  345.  
  346. /TU:<update target CONFIG.SYS directory>
  347. Specifies the drive and path of the target CONFIG.SYS to be updated.
  348. If this parameter is not specified,
  349. the CONFIG.SYS files are updated as specified
  350. in the product's package file.
  351. Example:
  352.  
  353.    /TU:C:\
  354.  
  355. /X
  356. Specifies that the action is unattended.
  357. If you do not specify all of the information needed for the action
  358. to complete, an error occurs.
  359. When you specify the /X option, no progress indication is shown
  360. and all error messages are logged to the error file you specified using
  361. the /L1 parameter.
  362.  
  363. If you do not specify this option, the user is prompted
  364. for any information that the EPFINSTS.EXE needs to complete the
  365. action.  In this attended mode of
  366. action, progress indication is shown and error messages are
  367. displayed to the user in secondary windows.
  368. The  installation program sets the EPFINONINTERACT installation
  369. variable to YES if the /X parameter is specified.
  370.  
  371.  
  372.  
  373. Return Codes from JumpKey/2 to a Controller
  374. ===========================================
  375. JumpKey/2 returns the following return codes to a
  376. software distribution manager (SDM):
  377.  
  378.   o Successful installation.
  379.  
  380.         00 00    No messages were logged.
  381.  
  382.   o Successful installation.
  383.     The workstation operating system will be restarted.
  384.     Do not call Software Installer again.
  385.  
  386.          FE 00      No messages.
  387.          FE 04      Warning messages were logged.
  388.          FE 08      Error messages were logged.
  389.          FE 12      Severe error messages were logged.
  390.  
  391.   o Successful installation.
  392.     Restarting the workstation operating system occurs.
  393.     Start the installation again.
  394.  
  395.   o Unexpected condition encountered during installation.
  396.  
  397.          16 00      Incorrect invocation of installation program
  398.          16 04      Messages were logged.
  399.  
  400. All return codes are two-byte hexadecimal values.
  401.