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