home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / mynst105.zip / INSTALL.INF (.txt) < prev    next >
OS/2 Help File  |  1997-10-07  |  17KB  |  464 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Copyright ΓòÉΓòÉΓòÉ
  3.  
  4. (c) Copyright Janosch R. Kowalczyk, 1996-1997. All rights reserved.
  5.  
  6. myNstall is the universal small PM installation program for OS/2 from Janosch 
  7. R. Kowalczyk. 
  8.  
  9. This program is Freeware. You can use this program for your own private 
  10. purposes, but you cannot change any of the contents with following exceptions: 
  11.  
  12.    1. Contents of the file INSTALL.DAT. 
  13.    2. You can use your own help file, but you MUST enclose following chapters 
  14.       from the existing INSTALL.HLP: 
  15.           Author 
  16.           Author's thanks 
  17.           Copyright (this chapter) 
  18.           Disclaimer 
  19.           Introduction 
  20.  
  21.  Please send all bug reports and improvement suggestions to the author. 
  22.  
  23.  
  24. ΓòÉΓòÉΓòÉ 2. Introduction ΓòÉΓòÉΓòÉ
  25.  
  26. The myNstall ([maj:]Nstall) is the universal small installation PM-program. 
  27.  
  28. It uses control words to arrange the installation process and gives you the 
  29. interface to your own Rexx routines, so that you can design the installation 
  30. process with more flexibility as you are now able to. Of course you can omit 
  31. all these controls and work with the default values as delivered. 
  32.  
  33. If you want to work without the control words, you can use this routine as is. 
  34. It copies almost all files (with exception of hidden and system files) from the 
  35. home directory into the selected destination directory. 
  36.  
  37. myNstall revision history 
  38.  
  39.  
  40. ΓòÉΓòÉΓòÉ 2.1. myNstall revision history ΓòÉΓòÉΓòÉ
  41.  
  42. These are the new features that were added for the version 1.01 Beta of 
  43. myNstall. 
  44.  
  45. Following keywords for the control file INSTALL.DAT were added: 
  46.  
  47.    1. WPS_ONLY_IF_EXIST= to hide/show the check box "Create WPS object only". 
  48.    2. WELCOME_BUTTON=OKCANCEL | OK to show in the Welcome message of your 
  49.       installation the buttons OK and Cancel or OK only. 
  50.    3. WELCOME_TITLE= to set the Title for this message. 
  51.    4. WELCOME= to set the message text. You can use this keyword multiple 
  52.       times. 
  53.    5. START_REXX_BY_OPEN_WINDOW= to start your own Rexx routine at the start of 
  54.       the installation process (Exit 1). 
  55.    6. START_REXX_BY_START_INSTALL= to call your own Rexx routine after you 
  56.       pressed the Install-Button but before the installation has started (Exit 
  57.       2). 
  58.    7. START_REXX_BY_SUCCESSFUL= to start your own Rexx routine after the 
  59.       successful installation (Exit 3). 
  60.    8. START_REXX_IF_FAILURE= to start your own Rexx routine if the installation 
  61.       has failed (Exit 4). 
  62.    9. START_REXX_BY_CLOSE_WINDOW= to start your own Rexx routine before you 
  63.       exit the installation process (Exit 5). 
  64.   10. DELETE_FILE= to delete a file from the destination directory before you 
  65.       start the installation process. You can use this keyword multiple times. 
  66.       It is useful for the update installation. 
  67.   11. REMOVE_DIR= to delete a subdirectory from the destination directory 
  68.       before you start the installation process. You can use this keyword 
  69.       multiple times. It is useful for the update installation. 
  70.  
  71.  These are the new features that were added for the version 1.02 Beta of 
  72.  myNstall. 
  73.  
  74.    1. DELETE_FILE_AFTER_INSTALLATION= to delete a file from the destination 
  75.       directory after successfully installing your product. 
  76.    2. REMOVE_DIR_AFTER_INSTALLATION= to delete a subdirectory from the 
  77.       destination directory  after successful installation. 
  78.  
  79.  
  80. ΓòÉΓòÉΓòÉ 3. System requirements ΓòÉΓòÉΓòÉ
  81.  
  82. myNstall requires approximately 200 kB (additional INSTALL.DAT) of disk space. 
  83. To use myNstall to install products, the following must be on the computer: 
  84.  
  85.      OS/2 version 2.x or higher, 
  86.      Rexx support. 
  87.  
  88.  
  89. ΓòÉΓòÉΓòÉ 4. How to install? ΓòÉΓòÉΓòÉ
  90.  
  91. To install a product: 
  92.  
  93.      Use the program INSTALL.EXE to start installation - an installation 
  94.       window will be displayed. 
  95.      Select the drive letter in the Box named Drive. 
  96.      Select the directory in the Box named Directory: 
  97.            Single click with the mouse button 1 selects the directory, 
  98.            Double click with the mouse button 1 opens the subdirectory list. 
  99.      The path to the last selected directory is showing in the entry field 
  100.       named Path. 
  101.      If you wish to install the product into a new directory, you should write 
  102.       its name into the entry field named Path. 
  103.      Select the push button Install to start the installation. 
  104.      If the destination directory not yet exists, you will be prompted for 
  105.       confirmation. 
  106.      Select Yes to install or No to cancel the installation. 
  107.  
  108.  
  109. ΓòÉΓòÉΓòÉ 5. How does the myNstaller work? ΓòÉΓòÉΓòÉ
  110.  
  111. To use the myNstall copy following files into your products source 
  112. (installation) directory: 
  113.  
  114.      INSTALL.EXE 
  115.      INSTALL.HLP 
  116.      [INSTALL.DAT] 
  117.  
  118.  INSTALL.DAT is the control file with the keywords to control your installation 
  119.  process. You don't need this file, if you don't want to use its features. 
  120.  
  121.  The myNstall unpacks almost all files (with exception of files with attributes 
  122.  H (hidden) and S (system) from the home (source) directory into the current 
  123.  destination directory. 
  124.  
  125.  See OS/2 UNPACK command for more info. 
  126.  
  127.  Note:  If the current destination directory does not exist, it will be 
  128.  created. You will be prompted for the confirmation. 
  129.  
  130.  The description of the WPS objects is situated in the file INSTALL.DAT. The 
  131.  description records must be enclosed in parenthesis ( ). If you want to create 
  132.  a folder for other objects, it must be placed at the beginning of the listing. 
  133.  For the syntax see the parameter list of the REXX function SysCreateObject. 
  134.  
  135.  Note:  You can only use one (1) line for one (1) description record. i.e.: 
  136.  
  137.           /*------(start WPS objects)-----*/
  138.           ("WPFolder", title, location, associations, "r")
  139.           ("WPProgram", title, location, associations, "r")
  140.              other descriptions record
  141.              other descriptions record
  142.           /*------(end WPS objects)-----*/
  143.  
  144.  See chapter Control words (keywords) in this file for more information. 
  145.  
  146.  
  147. ΓòÉΓòÉΓòÉ 6. Control words summary ΓòÉΓòÉΓòÉ
  148.  
  149. The following are keywords to control the installation process: 
  150.  
  151.    1. WINDOW_TITLE=your_installation_window_title 
  152.    2. DESTINATION=destination_directory_path 
  153.    3. WPS_ONLY_IF_EXIST=file_name 
  154.    4. WELCOME=welcome_message 
  155.    5. WELCOME_TITLE=message_title 
  156.    6. WELCOME_BUTTON={OK | OKCANCEL} 
  157.    7. START_REXX_BY_OPEN_WINDOW=rexxcall 
  158.    8. START_REXX_BY_START_INSTALL=rexxcall 
  159.    9. START_REXX_BY_SUCCESSFUL=rexxcall 
  160.   10. START_REXX_BY_FAILURE=rexxcall 
  161.   11. START_REXX_BY_CLOSE_WINDOW=rexxcall 
  162.   12. DEST_PATH (used by SysCreateObject and your own Rexx) 
  163.   13. HOMEDIR (to be used by your own Rexx) 
  164.   14. DELETE_FILE=file_to_delete 
  165.   15. REMOVE_DIR=directory_to_remove 
  166.   16. CREATE_DIR=directory_or_tree_to_create 
  167.   17. DELETE_FILE_AFTER_INSTALLATION=file_to_delete_after_installation 
  168.   18. REMOVE_DIR_AFTER_INSTALLATION=directory_to_remove_after_installation 
  169.  
  170.  See chapter Control words (keywords) for more details. 
  171.  
  172.  
  173. ΓòÉΓòÉΓòÉ 7. Control words (keywords) ΓòÉΓòÉΓòÉ
  174.  
  175. Note:  You can write the keywords into the file INSTALL.DAT in any order! 
  176.  
  177. In the follwing chapters are described keywords which you can use in the 
  178. control file INSTALL.DAT. 
  179.  
  180. Remember:  you can omit all these controls and work with default values only. 
  181.  
  182.  
  183. ΓòÉΓòÉΓòÉ 7.1. Title of the installation window ΓòÉΓòÉΓòÉ
  184.  
  185. WINDOW_TITLE=your_installation_window_title 
  186.  
  187. The keyword WINDOW_TITLE identifies the record from file INSTALL.DAT which sets 
  188. the title of the installation window. 
  189.  
  190. If you omit this keyword, the the title 'myNstall: Installation program' will 
  191. be used. 
  192.  
  193.  
  194. ΓòÉΓòÉΓòÉ 7.2. Destination path ΓòÉΓòÉΓòÉ
  195.  
  196. DESTINATION=destination_directory_path 
  197.  
  198. This keyword identifies the record from file INSTALL.DAT which sets the name of 
  199. the standard destination directory. 
  200.  
  201. If you omit this name, the root directory of the drive C: will be used. 
  202.  
  203. You should omit the leading and ending backslashes and the drive character. 
  204.  
  205. Default value:   root directory of the drive C: (drive C: is always the default 
  206. drive. Everybody has drive C: - don't they?). 
  207.  
  208. Example:  DESTINATION=TOOLS\INSTALL 
  209.  
  210.  
  211. ΓòÉΓòÉΓòÉ 7.3. Create WPS object only ΓòÉΓòÉΓòÉ
  212.  
  213. WPS_ONLY_IF_EXIST=file_name 
  214.  
  215. The Installer is able to recreate the damaged WPS-Objects for your 
  216. installation. It does this if the Check Box Create WPS objects only is 
  217. selected. But it is not necessary to show this box if the user is doing his 
  218. first installation. You can hide this Check Box for the installation window if 
  219. you use this keyword. This box will be showed if the file file_name is present 
  220. in the destination directory. 
  221.  
  222. Default value:  no - the check box will be showed 
  223.  
  224. Example:  WPS_ONLY_IF_EXIST=GREED.EXE 
  225.  
  226.  
  227. ΓòÉΓòÉΓòÉ 7.4. Welcome keywords ΓòÉΓòÉΓòÉ
  228.  
  229. These keywords help you to personify the start of the install procedure. There 
  230. are 3 WELCOME-keywords: 
  231.  
  232.    1. WELCOME=welcome_message 
  233.  
  234.       This keyword allows you to show the text of welcome_message before your 
  235.       installation starts. You can use multiple WELCOME= keywords for one 
  236.       message. Each WELCOME= message gives you a new line in the message box. 
  237.       Additionally  you can use '\n' (like C) in the message line for Line 
  238.       Feed. 
  239.  
  240.       Note:  You must have used at least one WELCOME= message before you can 
  241.       use the WELCOME_TITLE and WELCOME_BUTTON keywords. 
  242.  
  243.       Default value:   No - no message box. 
  244.  
  245.       Example: 
  246.  
  247.       WELCOME=Welcome to the Installation of "GREED"\nVersion 2.0 Beta.\n\n 
  248.  
  249.       WELCOME=Click OK to continue or CANCEL to exit\n\n 
  250.  
  251.    2. WELCOME_TITLE=message_title 
  252.  
  253.       You can use this keyword to change the title in the message box 
  254.  
  255.       Default value:  Welcome 
  256.  
  257.       Example:  WELCOME_TITLE=Hallo folks! 
  258.  
  259.    3. WELCOME_BUTTON={OK | OKCANCEL} 
  260.  
  261.       The message box, in which you show your info, can have either an OK 
  262.       button or both OK and CANCEL buttons. You can decide which form you will 
  263.       use. 
  264.  
  265.       Default value:  OKCANCEL 
  266.  
  267.       Example:  WELCOME_BUTTON=OK 
  268.  
  269.  Note:  Set message text without apostrophes. 
  270.  
  271.  
  272. ΓòÉΓòÉΓòÉ 7.5. Keywords for call of Rexx procedures ΓòÉΓòÉΓòÉ
  273.  
  274. myNstall supplies the possibility of calling your own Rexx procedures at 5 
  275. different points of installation processing: 
  276.  
  277.    1. START_REXX_BY_OPEN_WINDOW=rexxcall - before the start of the installation 
  278.       (pre-processing exit 1). 
  279.  
  280.       Default value:  No - no Rexx will be called. 
  281.  
  282.       Example:  START_REXX_BY_OPEN_WINDOW=my1rexx 'Janosch' 
  283.  
  284.    2. START_REXX_BY_START_INSTALL=rexxcall - after pressing the Push Button 
  285.       "Install" (pre-installing exit 2). 
  286.  
  287.       Default value:  No - no Rexx will be called. 
  288.  
  289.       Example:  START_REXX_BY_START_INSTALL=my2rexx 
  290.  
  291.    3. START_REXX_BY_SUCCESSFUL=rexxcall - after successful installation 
  292.       (post-installing-successful exit 3). 
  293.  
  294.       Default value:  No - no Rexx will be called. 
  295.  
  296.       Example:  START_REXX_BY_SUCCESSFUL=my3rexx 'A:' 
  297.  
  298.    4. START_REXX_BY_FAILURE=rexxcall - after unsuccessful installation 
  299.       (post-installing-failure exit 4). 
  300.  
  301.       Default value:  No - no Rexx will be called. 
  302.  
  303.       Example:  START_REXX_BY_FAILURE=my4rexx 
  304.  
  305.    5. START_REXX_BY_CLOSE_WINDOW=rexxcall - after the pressing of the Push 
  306.       Button "Exit" (post-processing exit 5). 
  307.  
  308.       Default value:  No - no Rexx will be called. 
  309.  
  310.       Example:  START_REXX_BY_CLOSE_WINDOW=my5rexx dest_path 
  311.  
  312.  Note:  Your REXX programs, if used, must exist in the installation (source) 
  313.  directory. You can only use constant values as calling parameters or the 
  314.  following keywords: 
  315.  
  316.      dest_path (for the destination directory) 
  317.  
  318.      homeDir (for the installation (source) directory) 
  319.  
  320.  It is not necessary to enter the File Extention (.CMD). Please do not use the 
  321.  output to / input from the Stdio - it is suppressed anyway! 
  322.  
  323.  Example:  Call for MYREXX.CMD with the parameter 'A:' after successful 
  324.  installation: 
  325.  
  326.  START_REXX_BY_SUCCESSFUL=MYREXX 'A:' 
  327.  
  328.  
  329. ΓòÉΓòÉΓòÉ 7.6. Keywords for creation of the WPS-objects ΓòÉΓòÉΓòÉ
  330.  
  331. Please use these keywords as is! They are used for the parameter list of the 
  332. function SysCreateObject in the RexxUtil functions packaging. For example see 
  333. the file INSTALL.DAT. The line must start and end with a parenthesis ( ). The 
  334. keyword dest_path is the variable name for the destination directory without 
  335. the ending backslash (i.e.: C:\TOOLS\INSTALL) 
  336.  
  337. Note:  Use only one (1) line for one (1) object. 
  338.  
  339. DEST_PATH is a keyword for the destination directory - please use it as is. 
  340.  
  341. For syntax of those lines see RexxUtil function SysCreateObject. 
  342.  
  343.  
  344. ΓòÉΓòÉΓòÉ 7.7. Create subdirectories ΓòÉΓòÉΓòÉ
  345.  
  346.  Using the keyword CREATE_DIR you can create a subdirectory tree in your 
  347. destination directory. The subdirectories will be created in the order of 
  348. entered keywords. 
  349.  
  350. You can use this keyword as frequently as you need. 
  351.  
  352. Default value:  No - no subdirectory will be created. 
  353.  
  354. Example: 
  355.  
  356. CREATE_DIR=FirstSub 
  357. CREATE_DIR=OtherSub 
  358. CREATE_DIR=FirstSub\SecSubD 
  359.  
  360. In this example 3 subdirectories will be created. First, named FirstSub as the 
  361. subdirectory of your destination directory. Second, named OtherSub as the 
  362. subdirectory of your destination directory, too. Third, named SecSubD as the 
  363. subdirectory of the directory FirstSub 
  364.  
  365. CAUTION:
  366.  If the superior directory not exists the subdirectory will not be created! 
  367.  
  368.  
  369. ΓòÉΓòÉΓòÉ 7.8. Keywords for the Update ΓòÉΓòÉΓòÉ
  370.  
  371. The following are the keywords that you can use to update an existing 
  372. installation: 
  373.  
  374.    1. DELETE_FILE=delete_file_name 
  375.  
  376.       Here you can enter the names of files to delete if you use this procedure 
  377.       for updating a previous installation. It is useful to delete files you do 
  378.       not need any more for the new release. 
  379.  
  380.       You can use this keyword as frequently as you need. The delete_file_name 
  381.       will be searched-for in the destination directory. 
  382.  
  383.       Default value:  No - no file will be deleted. 
  384.  
  385.       Example: 
  386.  
  387.       DELETE_FILE=MYAPPL16.EXE 
  388.  
  389.       DELETE_FILE=SUBDIR\MYSEC16.EXE 
  390.  
  391.    2. REMOVE_DIR=remove_dir_name 
  392.  
  393.       Here are the entries for the Directories to be deleted before installing 
  394.       the new instance of a previously installed application. These are 
  395.       directories that you no longer require (or want) to appear in the new 
  396.       installation, in an existing directory. You can use this keyword as oft 
  397.       as you want. Only empty (with no files) directories will be removed, a 
  398.       tree of empty subdirectories will also be removed if present. 
  399.  
  400.       Note:  ALL subdirectories must be empty for this function to work. 
  401.  
  402.       Default value:   No - no directory will be removed. 
  403.  
  404.       Example: 
  405.  
  406.       REMOVE_DIR=SUBDIR1 
  407.  
  408.       REMOVE_DIR=SUBDIR3\SUBSUB2 
  409.  
  410.  
  411. ΓòÉΓòÉΓòÉ 7.9. Post-installation processing ΓòÉΓòÉΓòÉ
  412.  
  413. The following are the keywords, that you can use after a  successful 
  414. installation: 
  415.  
  416.      DELETE_FILE_AFTER_INSTALLATION=file_name 
  417.      REMOVE_DIR_AFTER_INSTALLATION=directory_name 
  418.  
  419.  After successful installation you can delete files and directories, which you 
  420.  do not need after the installation such as Log files, Rexx-exits or backup 
  421.  directory. 
  422.  
  423.  You can use thes keywords as frequently as you need. 
  424.  
  425.  Note:  Only empty directories will be deleted. 
  426.  
  427.  Refer to the Keywords for the Update Installation for more information and the 
  428.  examples. 
  429.  
  430.  
  431. ΓòÉΓòÉΓòÉ 8. Authors thanks ΓòÉΓòÉΓòÉ
  432.  
  433. Thanks to David L. White and Peter MacCarthy-Morrogh for help in testing this 
  434. product, new ideas and improvement suggestions and correction of this text. 
  435.  
  436. Thanks to Uwe Aust for the help by testing of this product, new ideas and 
  437. improvement suggestions. 
  438.  
  439.  
  440. ΓòÉΓòÉΓòÉ 9. Author ΓòÉΓòÉΓòÉ
  441.  
  442.       Janosch R. Kowalczyk 
  443.  
  444.  
  445.       Oberwaldstr. 42 
  446.       63538 Grosskrotzenburg 
  447.       Germany 
  448.  
  449.  
  450.       Tel: +49-6186/201676 
  451.       Compuserve: 101572,2160 
  452.       Internet: 101572.2160@compuserve.com 
  453.  
  454.  
  455. ΓòÉΓòÉΓòÉ 10. Disclaimer ΓòÉΓòÉΓòÉ
  456.  
  457. This package is provided as is, without any guarantees or warrantees 
  458. whatsoever. The author is not liable or responsible for any loss or damage of 
  459. any kind whatsoever, including, but not limited to, losses of a financial, 
  460. physical, emotional, marital, social or mental nature that may result from the 
  461. use or the purported use of anything in this package, for any purpose 
  462. whatsoever. 
  463.  
  464. Thanks to Michael Shillingford for this wording.