home *** CD-ROM | disk | FTP | other *** search
/ The Education Master 1994 (4th Edition) / EDUCATIONS_MASTER_4TH_EDITION.bin / files / progmisc / qinst / quik.hlp < prev    next >
Text File  |  1993-12-24  |  13KB  |  326 lines
  1. ~CREATE NEW INSTALL
  2.  
  3.    CREATE NEW INSTALL
  4.  
  5.    In order to create an INSTALL.EXE program you must first select a
  6. filename for the install setup file.  This setup file will store all
  7. the configuration information for each INSTALL.EXE you create.  This
  8. allows you to easily create installation programs for multiple
  9. applications.  To recreate a previous install program you need only to
  10. reload the setup.
  11.  
  12.    You can load a setup file from a previously created install program
  13. to modify for a new install program.  To create the new install setup
  14. file just rename the setup as you exit the QUIK-INSTALL program.
  15.  
  16.    If you like you may load the setup file that came with your copy of
  17. QUIK-INSTALL.  You can then make the desired changes and save the setup
  18. under a new name.
  19.  
  20. ~CREATE NEW INSTALL
  21. ~LOAD EXISTING FILE
  22.  
  23.    LOAD AN EXISTING SETUP FILE
  24.  
  25.    Choose this option display a directory listing of all the SETUP.QIK
  26. files in the QUIK-INSTALL directory.  You can load a setup file from a
  27. previously created install program, modify it, then save it under a
  28. different name to easily create multiple installation programs.
  29.  
  30. ~LOAD EXISTING FILE
  31. ~COMPLETION MESSAGE
  32.  
  33.    INSTALLATION COMPLETION MESSAGE
  34.  
  35.    At this prompt you may enter a message that will be displayed at the
  36. end of the installation.  Most likely this would be a message on how to
  37. start or configure your program.  It could be a greeting or warning.
  38. It can be anything you like up to 80 characters.
  39.  
  40.    Unless you clear or overwrite the screen by executing a batch file
  41. or program after the installation is completed, this message will be
  42. the last text on left on the screen.
  43.  
  44. ~COMPLETION MESSAGE
  45. ~DEFAULT PROMPT
  46.  
  47.    DEFAULT PROMPT
  48.  
  49.    When the program runs it prompts the user to press ENTER to accept
  50. the default drive and subdirectory name to install to.  You should use
  51. an example that will be suitable for your program.  Example:  If your
  52. program is named QUIKWORK your might want the user to install the
  53. program to a directory named QUIKWORK.  In this case enter
  54. C:\QUIKWORK.
  55.  
  56.    QUIK-INSTALL defaults to the C: drive and the filename you have
  57. chosen for the setup file.
  58.  
  59. ~DEFAULT PROMPT
  60. ~NUMBER OF DISKS
  61.  
  62.    NUMBER OF INSTALLATION DISKS
  63.  
  64.    Here you should enter the number of disks you would like QUIK-
  65. INSTALL to prompt for and copy.  This number is limited only by the
  66. length of the EXE archive's filename.  If you are not installing
  67. from an EXE archive this number is unlimited.  The reason: QUIK-
  68. INSTALL concatenates the the number 1 to the number of disks to
  69. install to the end of the EXE archive's filename.  If your program
  70. installs from more than 9 disks your EXE archive's file name must not
  71. be more than 6 characters long.  If your program installs from more
  72. than 99 disks the EXE archive's name must not be longer than 5
  73. characters.  See option 7 for more details.  (It is unlikely you will
  74. encounter this problem.)
  75.  
  76. ~NUMBER OF DISKS
  77. ~EXIT IN INSTALL DIRECTORY
  78.  
  79.    EXIT IN INSTALL DIRECTORY  <Y/N>
  80.  
  81.    After the installation is completed you will most likely want your
  82. user to start your program.  If this is the case you should answer Yes
  83. to this question.  Answering Yes will cause the user to be in the
  84. installed directory after installation has completed. 
  85.  
  86. ~EXIT IN INSTALL DIRECTORY
  87. ~STUFF KEYBOARD BUFFER
  88.  
  89.    STUFF KEYBOARD BUFFER
  90.  
  91.    If you like QUIK-INSTALL will stuff the keyboard buffer with a
  92. command of your choice.  This allows the user to start the program
  93. without doing a directory to find the right file.  This could be a
  94. batch file to type a README or it could start your program.  You may
  95. leave this option blank.
  96.  
  97.    EXECUTE BUFFER <Y/N>
  98.  
  99.    If you elect to Stuff The Keyboard Buffer you will be prompted to
  100. have whatever the command execute immediately.  You might wish your
  101. user to read a text file or start a configuration program.  If you
  102. stuff the buffer with a batch file you can have the install program do
  103. a number of things.  If you select No the command you have stuffed in
  104. the buffer will remain on the screen after the installation is
  105. completed.  The user then has the option to press ENTER to start the
  106. program or choose to do something else.
  107.  
  108. ~STUFF KEYBOARD BUFFER
  109. ~EXECUTABLE ARCHIVE
  110.  
  111.    EXECUTABLE ARCHIVE
  112.  
  113.    This option has some important features.  First, when QUIK-INSTALL
  114. is run it will copy files or try to run an executable archive.  If
  115. you enter a filename at this prompt the program will try to run an
  116. executable archive by the name you enter.  If your program is being
  117. installed from a single disk this is all you need to do.
  118.  
  119.    If you are using executable archives and installing an application
  120. that requires more than 1 disk there are some special considerations.
  121. In order to keep the QUIK-INSTALL program at it's minimum size I
  122. opted not to store individual filenames for multiple disk archive
  123. installations.  Instead I use a simple system that requires you to
  124. name your executable archives using a number as the last letter of
  125. the filename.
  126.  
  127.    Example: If your program uses three disks to install and your
  128. program's name is MYWORK you would have to name your three executable
  129. archives MYWORK1.EXE, MYWORK2.EXE and MYWORK3.EXE.  When the QUIK-
  130. INSTALL program asks you for an archive name you would enter MYWORK.
  131. This method allows me to concatenate a number to the MYWORK filename
  132. based on the number of disks you are installing.  It also allows an
  133. unlimited number of disks and requires no extra space inside the
  134. QUIK-INSTALL program.  (Note: Make sure your file name does not
  135. exceed 7 characters (6 characters if you install 10 or more disks) so
  136. the disk number can be concatenated.)
  137.  
  138.    The QUIK-INSTALL program will work with any executable archive.  It
  139. is not dependant on the command syntax of any of the known EXE archive
  140. compressors.
  141.  
  142. ~EXECUTABLE ARCHIVE
  143. ~SPACE NEEDED TO INSTALL
  144.  
  145.    SPACE NEEDED TO INSTALL
  146.  
  147.    To have the program test for available disk space before installing,
  148. enter the amount of space your program requires in bytes.  If the user
  149. tries to install your application to a drive that does not have enough
  150. space QUIK-INSTALL will abort the installation.  It will also display
  151. a message explaining that your application requires the amount of space
  152. you enter here.  Like all options you may leave this blank to have the
  153. program skip disk space checking.
  154.  
  155. ~SPACE NEEDED TO INSTALL
  156. ~BACKGROUND COLOR
  157.  
  158.    BACKGROUND COLOR
  159.  
  160.    This is the color the screen will be set to when the QUIK-INSTALL
  161. installation program is first executed.  You should choose colors that
  162. are similar to the application that will be installed.
  163.  
  164.    When you choose this option a small window will be diplayed in the
  165. currently selected colors.  The ARROW keys and Mouse may be used to
  166. select colors.  When you have selected the color combination you wish
  167. to use you may press ENTER or "click" the ENTER line with mouse to set
  168. the colors and return to the main menu.
  169.  
  170. ~BACKGROUND COLOR
  171. ~FOREGROUND COLOR
  172.  
  173.    FOREGROUND COLOR
  174.  
  175.    This is the color the information window will be set to when the
  176. QUIK-INSTALL installation program is first executed.  You should choose
  177. colors that are similar to the application that will be installed.
  178.  
  179.    When you choose this option a small window will be diplayed in the
  180. currently selected colors.  The ARROW keys and Mouse may be used to
  181. select colors.  When you have selected the color combination you wish
  182. to use you may press ENTER or "click" the ENTER line with mouse to set
  183. the colors and return to the main menu.
  184.  
  185. ~FOREGROUND COLOR
  186. ~BATCH FILE TO EXECUTE
  187.  
  188.    BATCH FILE TO EXECUTE
  189.  
  190.    If you enter a file name at this prompt QUIK-INSTALL will attempt
  191. to execute it before beginning the installation.  This is the FIRST
  192. thing QUIK-INSTALL does after getting all the necessary installation
  193. information.  QUIK-INSTALL passes three installation variables to
  194. whatever file is being executed.  Using a batch file this will allow
  195. you to perform a variety of installation tasks.  If you are adept at
  196. writing batch files it is quite feasable to have the start-up batch
  197. file perform the entire installation.  The would allow you to create a
  198. highly customized installation.  The variables passed to a batch file
  199. are:
  200.  
  201.     %1   -    Drive letter the user is installing to in this
  202.               form:  C:.
  203.  
  204.     %2   -    The sub-directory the program is being installed
  205.               to in this form:  \DIRNAME.
  206.  
  207.     %3   -    The full path of the drive and directory where
  208.               the QUIK-INSTALL program was executed from in
  209.               this form:  C:\DIRNAME\DIRNAME\ etc.  (This is
  210.               where the files being installed will be residing.)
  211.  
  212.    If a start-up batch file is specified you will be prompted to
  213. specify whether QUIK-INSTALL or the start-up batch file should perform
  214. the installation.  If you select ENABLE the QUIK-INSTALL program will
  215. make the subdirectory, copy the files, and/or unpack the EXE archives.
  216. If you select DISABLE the previous three feature will be disabled.
  217.  
  218.    The QUIK-INSTALL installation program can called from this batch
  219. file to prompt the user for answers to additional questions and to set
  220. screen colors. (See the section in the manual on COMMAND LINE
  221. PARAMETERS for additional details on calling the INSTALL.EXE module
  222. from within a start-up batch file.)
  223.  
  224. ~BATCH FILE TO EXECUTE
  225. ~MAKE INSTALL.EXE
  226.  
  227.    MAKE THE INSTALL.EXE PROGRAM
  228.  
  229.    When this option is selected a second menu listing the final setup
  230. information will be displayed.  It is from this final menu that the
  231. INSTALL.EXE module is created.
  232.  
  233. ~MAKE INSTALL.EXE
  234. ~EXIT PROGRAM TO DOS
  235.  
  236.    EXIT PROGRAM TO DOS
  237.  
  238.    When you select this option you will be prompted to save the current
  239. configuration under the current name or change it.  After the
  240. configuration has been saved the program is exited to DOS.
  241.  
  242. ~EXIT PROGRAM TO DOS
  243. ~DISABLE FUNCTIONS
  244.  
  245.    ENABLE/DISABLE QUIK-INSTALL INSTALLATION FUNCTIONS
  246.  
  247.    Since a start-up batch file has been specified you must specify
  248. whether QUIK-INSTALL or the start-up batch file should perform the
  249. installation.  If you select ENABLE the QUIK-INSTALL program will make
  250. the subdirectory, copy the files, and/or unpack the EXE archives. If
  251. you select DISABLE the previous three features will be disabled.
  252.  
  253.    This option allows you to have the QUIK-INSTALL program pass
  254. information to the start-up batch file (Installation source and
  255. destination drives and directories) to allow it to perform the entire
  256. installation.
  257.  
  258.    Since the QUIK-INSTALL installation program can be called from 
  259. within the start-up batch file using command line parameters to perform
  260. tasks that set ERRORLEVELS (Such as waiting for a keypress then setting
  261. the errorlevels to the ASCII code for the key pressed.) you can write
  262. very elaborate batch files that can perform very complex installations.
  263.  
  264. ~DISABLE FUNCTIONS
  265. ~EXECUTE BUFFER
  266.  
  267.    EXECUTE BUFFER
  268.  
  269.    This option appears only if you choose to stuff the keyboard
  270. buffer.  If you stuff a command into the keyboard buffer after
  271. installation it can be very useful to have it execute immediately.
  272. You might wish your user to read a text file or start a configuration
  273. program.  If you stuff the buffer with a batch file name you can have
  274. the batch file perform an number of useful tasks.
  275.  
  276. ~EXECUTE BUFFER
  277. ~COMPRESS INSTALL.EXE
  278.  
  279.    COMPRESS INSTALL.EXE
  280.  
  281.    The QUIK-INSTALL program can optionally call the public domain
  282. LZEXE program to compress the customized QUIK-INSTALL installation
  283. program.  Compress the INSTALL.EXE module after it is created will
  284. usually squeeze another 1000 bytes or so out of it.
  285.  
  286.    To compress INSTALL.EXE leave this option set to YES.
  287.  
  288. ~COMPRESS INSTALL.EXE
  289. ~OUTPUT DIRECTORY
  290.  
  291.    OUTPUT DIRECTORY
  292.  
  293.    This is the DRIVE\DIRECTORY where the new INSTALL.EXE program will
  294. be created.  Usually when you are packaging a new application for 
  295. distribution you will gather all it's associated files into a single
  296. directory.  This option allows you to create the INSTALL.EXE module in
  297. the same place as the application files.
  298.  
  299.    The output path defaults to the currently logged directory.
  300.  
  301. ~OUTPUT DIRECTORY
  302. ~TITLE TEXT
  303.  
  304.    TITLE TEXT
  305.  
  306.    This is a customized line of text that will be displayed underneath
  307. the copyright notice at the top of the screen.  Use this line to relate
  308. the installation program to the application it will be installing.
  309.  
  310. ~TITLE TEXT
  311. ~CANCEL INSTALL.EXE CREATION
  312.  
  313.    CANCEL INSTALL.EXE CREATION
  314.  
  315.    This option simply returns to the main menu.
  316.  
  317. ~CANCEL INSTALL.EXE CREATION
  318. ~MAKE THE INSTALL.EXE PROGRAM
  319.  
  320.    When you select this menu item the INSTALL.EXE program is created
  321. using the configuration currently selected.  The INSTALL.EXE program
  322. will be created in the DRIVE\DIRECTORY specified in the OUTPUT 
  323. DIRECTORY field.
  324.  
  325. ~MAKE THE INSTALL.EXE PROGRAM
  326.