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