home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / i / inst150a.zip / INSTALL.DOC < prev    next >
Text File  |  1993-03-14  |  17KB  |  428 lines
  1.  INSTALL.EXE                                                    Version 1.50
  2.  
  3.  
  4.  1.0  INTRODUCTION
  5.  
  6.  A convienent and user friendly method for your users to install new programs
  7.  onto their systems. Unlike other installation programs or standard batch
  8.  file methods, INSTALL will not transfer itself ,its configuration file,
  9.  message files, any other files used to install your programs onto the user's
  10.  hard disk taking up your users precious space.
  11.  
  12.  INSTALL begins by displaying a title screen with a brief description to
  13.  the user of what will take place. Next, an optional message screen is
  14.  displayed. This message screen uses a standard ASCII text file of up to 
  15.  250 lines of text which you create using your favorite word processer. The 
  16.  user can page up and down or print it to refer to after the installation 
  17.  process is complete.
  18.  
  19.  INSTALL then prompts the user for the correct source and destination
  20.  drives\paths, after which it checks for existing information within the 
  21.  destination directory. If the backup option is turned on, a BAK subdirectory 
  22.  is created. INSTALL begins the installation process by backing up any
  23.  existing information into the BAK subdirectory, then copies files from 
  24.  the source disk onto the destination drive\path while displaying the 
  25.  percentage of completion for the disk graphically.
  26.  
  27.  Using the configuration file "INSTALL.CFG", INSTALL can be customized to fit
  28.  your particular needs. Below is the available keywords used for configuring
  29.  INSTALL along with an explanation for each. Each keyword can be in upper or
  30.  lower case, followed by an equal "=" sign, then the required parameter. You 
  31.  may place any amount spaces between the keyword, equal sign, and the required 
  32.  parameter to improve readability. Comments may be placed anywhere within the 
  33.  file and should begin with a single quote character "'" or semi-colon ";".
  34.  
  35.  INSTALL also incorporates automatic detection and decompression of files
  36.  compressed using PKUNZIP.EXE*. The file PKUNZIP.EXE* must be present on all
  37.  disks to be installed that contain compressed files. Automatic decompression
  38.  can be turned off by using '-norun' parameter with the ZIPPARM keyword (See
  39.  below).
  40.  
  41.  If you have one of those monochrome monitors which INSTALL is unable to
  42.  detect, a "/m" may be used on the command line to force the monchrome mode
  43.  (Eg: INSTALL /m).
  44.  
  45.  
  46.  
  47.  2.0  KEYWORDS 
  48.  
  49.  The following list contains all keyword options available to INSTALL. Note
  50.  either the full keyword name or the reduced three character keyword (noted 
  51.  in brackets) may be used. INSTALL is case insensitive when searching the
  52.  configuration file for valid keywords and spaces may be used between the
  53.  keyword and parameter as required to make your configuration file more 
  54.  readable.
  55.  
  56.  By using braces '{}', the result of the Source and Destin keyword variables 
  57.  can be imbeded in certain parameters. For example, say you need to rename a 
  58.  file on the destination drive before you start installation, but it will be 
  59.  unknown until run time what drive and path was chosen. By imbeding the 
  60.  Destin keyword on the parameter line, INSTALL will replace the definition 
  61.  with the correct value at run time. These keywords for the Source and Destin 
  62.  are only available for DEL, DosCommandFirst, DosCommandLast, RunFirst and 
  63.  RunLast keywords.
  64.  
  65.         DosCommandFirst = ren {Destin}run.bat run.old
  66.  
  67.                 - or -
  68.         
  69.         DCF = ren {DST}run.bat run.old
  70.  
  71.  Comments and blank lines may be placed anywhere within the configuration file. 
  72.  Each comment line should begin with a single quote character or semicolon. 
  73.  Refer to the sample configuration file included with the program for examples 
  74.  of how to setup and use the configuration file.
  75.  
  76.  
  77.               *** KEYWORD LISTING ***
  78.  
  79.  BACKUP [BKP] = no
  80.  
  81.  Prevents the creation of  the BAK subdirectory and subsequent backup of any 
  82.  existing data into it. Default if not specified is yes
  83.  
  84.  
  85.  COMPANY [CMP] = company name                      * Registered Version Only
  86.  
  87.  Replaces the company name at the top center of the display screen.
  88.  
  89.  
  90.  DEL [DEL] = filename
  91.  
  92.  Name of any files to be deleted after INSTALL has backed up any existing
  93.  data in the destination directory. A maximum of 20 filenames may be specified
  94.  Only files within the destination drive\path may be deleted. Standard DOS 
  95.  wildcards, question marks "?" and/or asterisks "*" , may be used. Multiple
  96.  filenames can be placed in sequence with a single keyword if they are 
  97.  separated by commas.
  98.  
  99.     Example1:                  Example2:
  100.     DEL = PROGRAM2.EXE         DEL = PROGRAM2.EXE, OVERLAY.*, MNTH??92.DAT
  101.     DEL = OVERLAY.*
  102.     DEL = MNTH??92.DAT
  103.  
  104.  
  105.  DESTIN [DST] = drive:\path
  106.  
  107.  Preferred destination drive\path for files to be installed into. If omitted, 
  108.  a default of C:\ is used. The user has the option of changing this prior to
  109.  starting the installation. INSTALL will verify that the drive\path exists
  110.  and, if not, will prompt the user for creation prior to starting.
  111.  
  112.     Example:
  113.     DESTIN = C:\MYPROG
  114.  
  115.  
  116.  DISKS [DSK] = n
  117.  
  118.  The number of disks to be installed. After each disk is complete, the user 
  119.  will be prompted to install a new disk in the Source drive. If this keyword 
  120.  is omitted, a default of one disk is assumed.
  121.  
  122.     Example:
  123.     DISKS = 3
  124.  
  125.  
  126.  DISKSPACE [SPC] = xxxxx                           * Registered Version Only
  127.  
  128.  Defines the minimum allowable amount of disk space that must exist on the
  129.  destination drive prior to starting installation. Parameter may contain
  130.  commas for clarity. 
  131.  
  132.     Example1:                     Example2:
  133.     DiskSpace=2000000             SPC = 2,000,000
  134.               
  135.  
  136.  DOSCOMMANFIRST [DCF] = any_dos_command            * Registered Version Only
  137.  
  138.  Up to 25 Dos commands can be defined to be run in the background before 
  139.  installation of disks. Use caution when using this keyword, any characters
  140.  that would be output to the screen will be displayed over the current screen
  141.  display. This keyword is only designed to run Dos commands in the background. 
  142.  The original screen will be restored after running all of the Dos commands 
  143.  specified in case this should happen. If you plan to use this keyword, be 
  144.  sure to redirect any output to the nul device using standard the Dos 
  145.  redirection " > nul". Multiple commands can be placed in sequence with a 
  146.  single keyword if they are separated by commas.
  147.  
  148.      Example1:
  149.      DOSCommandFirst = copy {Destin}run.bat {Destin}run.old > nul
  150.  
  151.      Example2:
  152.      DCF = copy {Dst}run.bat {Dst}run.old > nul, ren {DST}prog.exe prog.old
  153.  
  154.      NOTE: In the above example, {Destin} will be replaced with 
  155.      the correct destination drive and path as selected by the 
  156.      user prior to starting in the format of {drive}:\{path}\.
  157.  
  158.  
  159.  DOSCOMMANLAST [DCL] = any_dos_command             * Registered Version Only
  160.  
  161.  Up to 25 Dos commands can be defined to be run in the background after 
  162.  installation of disks. Use caution when using this keyword, any characters
  163.  that would be output to the screen will be displayed over the current screen
  164.  display. This keyword is only designed to run Dos commands in the background. 
  165.  The original screen will be restored after running all of the Dos commands 
  166.  specified in case this should happen. If you plan to use this keyword, be 
  167.  sure to redirect any output to the nul device using standard the Dos 
  168.  redirection " > nul". Multiple commands can be placed in sequence with a 
  169.  single keyword if they are separated by commas.
  170.  
  171.      Example1:
  172.      DOSCommandLast = copy {Source}tmp.bat {Destin}run.bat > nul
  173.  
  174.      Example2:
  175.      DCL = copy {Src}tmp.bat {Dst}run.bat > nul, ren {DST}tmp.exe tmp.old
  176.  
  177.      NOTE: In the above example, {Source} and {Destin} will be 
  178.      replaced with the correct drive and path as selected by the 
  179.      user in the format of {drive}:\{path}\ prior to starting.
  180.  
  181.  
  182.  EXCLUDEFILE [EXF] = source_file_name              * Registered Version Only
  183.  
  184.  Any files located on the source drive to be excluded from being installed
  185.  on the destination drive. INSTALL automatically excludes itself, the
  186.  configuration file, message file and PKUNZIP* file. Up to 20 files additional
  187.  files may be excluded by listing each one with this keyword. Dos wildcards 
  188.  are valid. Multiple file names can be placed in sequence with a single 
  189.  keyword if they are separated by commas.
  190.      
  191.      Example1:                           Example2:
  192.      ExcludeFile = RUN.BAT               EXF = RUN.BAT, MEMTEST.EXE
  193.      ExcludeFile = MEMTEST.EXE   
  194.  
  195.  
  196.  GRAPH [GPH] = no
  197.  
  198.  Prevents the graphic display of the percentage completed while installing.
  199.  It is suggested to use this keyword when only decompressing one or two zip
  200.  files. INSTALL cannot determine the percentage of completion while PKUNZIP*
  201.  is working. Using this keyword, the graph is replaced showing only the
  202.  name of the file being installed along with the number of files successfully 
  203.  installed out of the total number to be installed. Default is yes.
  204.  
  205.  
  206.  INSTR [INS] = no
  207.  
  208.  Prevents the initial instruction page from being displayed. This page is
  209.  normally displayed after the title page and informs the user of what will
  210.  take place prior to starting. Default is yes.
  211.  
  212.  
  213.  LABEL [LBL] = volume_name
  214.  
  215.  Used to verify the proper disk has been placed into the source drive. One
  216.  Label keyword should be used for every disk to be installed. These keywords
  217.  must be placed in the order of installation. Multiple labels can be placed 
  218.  in sequence with a single keyword if they are separated by commas.
  219.  
  220.     Example1:
  221.     LABEL = PROGRAM    (Defines the label for disk one)
  222.     LABEL = FILES      (Defines the label for disk two)
  223.  
  224.     Example2:
  225.     LBL = PROGRAM,FILES,GRAPHICS
  226.  
  227.  
  228.  MAIN [MAN] = filename (Special User Keyword Option Only)
  229.  
  230.  Main .EXE program being installed. This is only used in conjuction with
  231.  the Rec keyword to define where configuration data is located.
  232.  
  233.  
  234.  PRINT [PRT] = filename
  235.  
  236.  Allows a 250 line by 70 column message to be displayed in pages of 16 lines 
  237.  each. The message must be in ASCII format and reside on the first source
  238.  disk only. Messages that exceed 16 lines in length are displayed on multiple 
  239.  pages. The user can select the next page, previous page, output the message 
  240.  in raw format to the printer, exit the installation process, or continue 
  241.  with the installation.
  242.  
  243.     Example:
  244.     PRINT=MESSGE.TXT
  245.  
  246.  
  247.  REC [REC] = type (Special User Keyword Option Only)
  248.  
  249.  Type of configuration data tagged onto the end of program.
  250.  Can be either TYPE as in TYPE...END TYPE or NOTYPE as in Cr/Lf records.
  251.  
  252.  
  253.  RUNFIRST [RFP] = program_name                     * Registered Version Only
  254.  
  255.  Allows an external program to be called prior to installation of disks. The
  256.  program will be provided with both the source and destination drives passed
  257.  as parameters when called. The program should be located on the first disk
  258.  to be installed. Refer to RUNFIRSTWIN for additional display options.
  259.  
  260.  For example, certain setup processes may need to be performed prior to
  261.  installation. Including this keyword, you can write a program that would be
  262.  called to perform these setup routines. Upon program startup, you would
  263.  check %1 parameter for the source drive\path and %2 for the destination
  264.  drive\path. The format for drive\path is '{drive}:\{path}\' (C:\DESTIN\). 
  265.  
  266.     Example:
  267.     RUNFIRST=make.bat
  268.  
  269.  
  270.  RUNFIRSTWIN [RFW] = yes                           * Registered Version Only
  271.  
  272.  Window parameter for the RUNFIRST keyword which tells INSTALL whether to run 
  273.  the program or batch file specified with the keyword in a window. INSTALL 
  274.  will open a nine line window at the bottom of the display screen for any 
  275.  output the calling program requires. The default is no window which is useful 
  276.  if your processes require no operator intervention or output to the screen 
  277.  while running.
  278.  
  279.  
  280.  RUNLAST [RLP] = program_name                      * Registered Version Only
  281.  
  282.  Allows an external program to be called after the installation of all disks. 
  283.  The program will be provided with both the source and destination drives 
  284.  passed as parameters. The program should be located on the last disk to
  285.  be installed. Refer to RUNLASTWIN for additional display options.
  286.  
  287.  For example, you may require certain processes to be performed on the
  288.  destination drive after installation is done. Including this keyword, your
  289.  program would be called to perform these processes. Upon program startup,
  290.  you would check %1 parameter for the source drive\path and %2 for the
  291.  destination drive\path. The format for drive\path is '{drive}:\{path}\' 
  292.  (C:\DESTIN\). 
  293.  
  294.     Example:
  295.     RUNLAST=make.bat
  296.  
  297.  
  298.  RUNLASTWIN [RLW] = yes                            * Registered Version Only
  299.  
  300.  Window parameter for the RUNLAST keyword which tells INSTALL whether to run 
  301.  the program or batch file specified with the keyword in a window. INSTALL 
  302.  will open a nine line window at the bottom of the display screen for any 
  303.  output the calling program requires. The default is no window which is useful 
  304.  if your processes require no operator intervention or output to the screen 
  305.  while running.
  306.  
  307.  
  308.  SOURCE [SRC] = drive:\path
  309.  
  310.  Source drive\path from which files will be installed from. If omitted, the
  311.  default directory from which the program was invoked will be used.
  312.  
  313.  
  314.  TITLE [TTL] = new title name
  315.  
  316.  Name or Title of program being installed (Max 45 characters). Using This
  317.  optional keyword will invoke a title page to be displayed.
  318.  
  319.  
  320.  ZIPPARM [ZIP] = {pkunzip parameters}
  321.  
  322.  This line should contain the parameters you require for those files to be
  323.  'unzipped' using PKUNZIP.EXE* (refer to the program PKUNZIP.EXE* for valid
  324.  parameters). The default parameter that INSTALL uses is '-o' for overwriting
  325.  existing files on the destination drive. If you plan to use only the -o  
  326.  parameter, this keyword is not required. INSTALL always uses it as the
  327.  default parameter to prevent the PKUNZIP's overwrite prompt message from 
  328.  displaying over INSTALL's display screen. To disable automatic decompression, 
  329.  use the parameter '-norun'. 
  330.  
  331.     Example ZIPPARM = -norun 
  332.     
  333.     NOTE: Using -norun, compressed files will still be installed 
  334.     on the destination drive, but no decompression will take place.
  335.  
  336.  
  337.  
  338.  3.0  RELEASE HISTORY
  339.  
  340.  02/11/92
  341.  Ver 1.01 - Fixed bugs found when destination drive did not end with
  342.         a backlash "\" character
  343.  
  344.         Backup option did not work properly if "NO" was specified
  345.  
  346.         Added option to change company name at top-center of screen
  347.  
  348.  02/26/92
  349.  Ver 1.20 - Added the LABEL keyword to identify when the user has placed 
  350.         the proper install disk into the source drive
  351.  
  352.  07/18/92
  353.  Ver 1.21 - Removed the message "Be sure to back-up existing data files before
  354.         using." from the final Installation Complete box.
  355.  
  356.         Added the INSTR keyword to prevent the instruction page being
  357.         displayed.
  358.  
  359.  10/12/92
  360.  Ver 1.30 - Added external program capability with the RUNFIRST and RUNLAST
  361.         keywords.
  362.  
  363.         Corrected bug found in identifying the proper drive\path when not
  364.         found during source and destination verification.
  365.  
  366.  10/29/92
  367.  Ver 1.40 - Added decompression capability via PKUNZIP.EXE* and the ability
  368.         to locate those files that have been compressed using PKZIP.EXE*.
  369.  
  370.         Added RUNFIRSTWIN and RUNLASTWIN keywords for external programs
  371.         to be run with or without a DOS window being opened.
  372.  
  373.         Corrected bug found in displaying full destination path name.
  374.  
  375.         Expanded message display capability from a single page to muliple.
  376.  
  377.  11/15/92
  378.  Ver 1.41 - Corrected several bugs:
  379.         a) Error detected when only zip files exist on source
  380.         b) Error generated when widcards used for deletion routine
  381.         Added several extended error messages
  382.  
  383.         Added GRAPH keyword to eliminate graphic display. Graph not
  384.         effective when only decompressing one or two zip files.
  385.  
  386.  Ver 1.41a- Minor bug fix increasing stack space.
  387.  
  388.  03/15/93
  389.  Ver 1.50 - Added four new keywords: DiskSpace, DosCommandFirst, DosCommandLast
  390.         and ExcludeFile
  391.  
  392.         Enhanced message display by allowing paging back and forth through
  393.         the message, outputting to the printer and allowing exiting or
  394.         continuing with install.
  395.  
  396.         Fixed keyword input to allow blank parameters in configuration
  397.         file.
  398.  
  399.         Upgraded error handling to not only detect, but display errors when
  400.         they occur rather than just exiting to the system.
  401.  
  402.         Added imbeded source and destin keywords in selected parameters.
  403.  
  404.         Created separate shareware and registered versions.
  405.  
  406.         Added reduced three character keyword size option.
  407.  
  408.         Change configuration input routine to allow multiple names in the
  409.         parameter line separated by commas.
  410.  
  411.  -----------------------------------------------------------------------------
  412.  
  413.  We at PM Systems welcome any comments suggestions or user customizable
  414.  features you may have. Please contact us at the address below.
  415.  
  416.                 PM Systems
  417.                   8385 Tulip Lane
  418.              Chagrin Falls, Ohio  44023
  419.                   (216) 543-8739
  420.                CompuServe 70253,2100
  421.  
  422.  This software is registered in the Compuserve Shareware Database - ID #472
  423.  
  424.  
  425.   -----------------------------------------------------------------------------
  426.  
  427.        * PKZIP.EXE and PKUNZIP.EXE is a product of PKWARE Inc.
  428.