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