home *** CD-ROM | disk | FTP | other *** search
/ Super CD / Super CD.iso / educ / azoo / doc / readme.ins < prev    next >
Encoding:
Text File  |  1992-08-21  |  10.8 KB  |  299 lines
  1.  
  2.                    DECRIPTION OF REQUIRED FILES FOR INSTALLER
  3.                    ------------------------------------------
  4.  
  5. 1. BD.PDT - Optional
  6.    ------
  7.  
  8.    Baby Printer Driver Printer Defintion file.  This file contains data that
  9.    is needed by the Baby Printer Driver.  If you are not using the Baby Printer
  10.    Driver, you can exclude this file.
  11.  
  12. 2. INS.EXE
  13.    -------
  14.  
  15.    Installer program.  Takes parameters /S for setup and /U for uninstall.
  16.  
  17. 3. INSTALL.BAT
  18.    -----------
  19.  
  20.    Batch file that calls INS.EXE.  If your program needs to call other
  21.    programs after the installer is finished, put the calls in this file.
  22.  
  23. 4. INSTALL.DAT
  24.    -----------
  25.  
  26.    This file contains encrypted questions and answers that INS.EXE uses to
  27.    allow the user to continue the installation process.  The original data
  28.    file is an ASCII file that is converted using the ENCRYPT.EXE program.
  29.    INS.EXE assumes that there is a one-line question followed by a one-line
  30.    answer.  The number for question-answer combinations is limited to size
  31.    of the file.  The file must not exceed 32000 bytes.  EACH QUESTION OR
  32.    ANSWER MUST NOT EXCEED 40 CHARACTERS.
  33.  
  34. 5. ORIGDISK.ID
  35.    -----------
  36.  
  37.    Small file that indicates that the disk from which INS.EXE is running from
  38.    is the original installation disk.  THIS FILE MUST NOT BE LISTED IN THE
  39.    INSTALL.INF FILE!  This file is used to prevent the user from uninstalling
  40.    files from the original disks.
  41.  
  42. 6. SETUP.BAT
  43.    ---------
  44.  
  45.    Batch file that calls INS.EXE with the /S parameter for updating setup
  46.    information.
  47.  
  48. 7. UNINSTAL.COM
  49.    ------------
  50.  
  51.    Uninstall program.  Spawns INS.EXE with the /U parameter.  Use this program
  52.    to uninstall files.  Using a batch file to call INS.EXE with the /U
  53.    parameter can cause DOS to report errors if the batch file is deleted.
  54.  
  55. 8. INSTALL.INF
  56.    -----------
  57.  
  58.    Script file used by INS.EXE.  The following section describes INSTALL.INF
  59.    in detail.
  60.  
  61.                    DESCRIPTION OF INSTALL.INF SCRIPT FILE
  62.                    --------------------------------------
  63.  
  64. INSTALL.INF is the script file that contains commands, prompts, paths, and
  65. other information needed in order to start the install program INSTALL.EXE.
  66. This script file MUST BE IN THE SAME DIRECTORY as INSTALL.EXE.  The script
  67. file is used during the setup, install, and uninstall processes.  The 
  68. following sections describes each script command and the operation it performs.
  69.  
  70.                            INITIALIZATION COMMANDS
  71.                            -----------------------
  72.  
  73. ALL COMMANDS MUST BE IN UPPERCASE LETTERS!!  All of the
  74. initialization commands must be present in the INSTALL.INF
  75. file.  If any of setup's code lists are left out, the prompts
  76. for those lists will not be shown.  For instance,
  77. if your program has only one video mode, you can leave out
  78. the SET_VID_PRMPT, SET_VID_MODES, and SET_VID_CODES commands.
  79. Also, if you do not need a batch file created by the install
  80. program, you can leave out the BATCH_NAME and BATCH_CMNDS
  81. commands.  Each command must be on a separate line.  Any data
  82. following these commands can be indented with a tab character
  83. that will be ignored when it is read.  All prompts and messages
  84. with the exception of the copyright message, can have up to 20
  85. lines of text. The copyright message can have only one line of text.
  86. All lists can have up to 256 items.
  87.  
  88. The note that is within parentheses just below the command specifies
  89. the type of the command.  "Toggle" - sets a switch, "assignment" - 
  90. assigns the following value to a variable, "list" - assigns the
  91. following values to a list array.
  92.  
  93. -START_SCRIPT    -  Tells INSTALL.EXE that this is a valid
  94.  (toggle)           script file.
  95.  
  96. -NETWORK         -  USE ONLY IN INSTALL SCRIPTS THAT WILL BE USED
  97.  (toggle)           TO INSTALL THE PRODUCT ON AN ICLAS NETWORK.
  98.  
  99. -PROG_NAME       -  Name of the program being installed
  100.  (assignment)       (i.e., Speech Master).
  101.  
  102. -BYTES_NEEDED    -  Amount of disk space that must be available
  103.  (assignment)       in order for your program to install.
  104.  
  105. -BYTES_TOTAL     -  Total amount of bytes of all files that will be
  106.  (assignment)       installed.  If you have packed files, use the
  107.                     unpacked file's size.  This number is used in
  108.                     conjunction with the install status bar.  This
  109.                     number differs from the BYTES_NEEDED number in
  110.                     that this number is the actual total of all files
  111.                     while BYTES_NEEDED is how much disk space you
  112.                     require for the product.  BYTES_NEEDED is usually
  113.                     bigger because it should take into consideration
  114.                     that directories take up space, files occupy 512
  115.                     byte sectors, and space for record or custom files.
  116.  
  117. -SPEAKER_MINVAL  -  Threshold for SPEAKERFAST mode.  This number
  118.  (assignment)       determines if the speaker output will be 
  119.                     digitized sound or speaker beeps.  30 is the
  120.                     recommended threshold value.
  121.  
  122. -MIDI_HERTZ      -  Frequency at which DMIDI driver will play
  123.  (assignment)       midi notes.
  124.  
  125. -DEF_SORC_PATH   -  Default source drive and path.
  126.  (assignment)
  127.  
  128. -DEF_DEST_PATH   -  Default destination drive and path.
  129.  (assignment)
  130.  
  131. -SORC_PRMPT      -  Prompt for entering in the source drive and
  132.  (list)             path.
  133.  
  134. -DEST_PRMPT      -  Prompt for entering in the destination drive
  135.  (list)             and path.
  136.  
  137. -DISK_PRMPT      -  Prompt for inserting a disk.
  138.  (list)
  139.  
  140. -CPYRGHT_MSG     -  Copyright message.
  141.  (list)
  142.  
  143. -INS_OPEN_MSG    -  Install's opening message.
  144.  (list)
  145.  
  146. -SET_OPEN_MSG    -  Setup's opening message.
  147.  (list)
  148.  
  149. -UN_OPEN_MSG     -  Uninstall's opening message.
  150.  (list)
  151.  
  152. -INS_END_MSG     -  Install's closing message when no errors
  153.  (list)             occur.
  154.  
  155. -SET_END_MSG     -  Setup's closing message when no errors occur.
  156.  (list)
  157.  
  158. -UN_END_MSG      -  Uninstall's closing message when no errors
  159.  (list)             occur.
  160.  
  161. -SET_MENU_PRMPT  -  Setup menu prompt.
  162.  (list)
  163.  
  164. -SET_MENU_CHCES  -  Setup menu choices.
  165.  (list)
  166.  
  167. -SET_MENU_CODES  -  List of codes associated with setup menu choices.
  168.  (list)             0 - video, 1 - sound, 2 - printer, 3 - end setup.
  169.                     You can leave out menu choices by leaving out the
  170.                     choice code.  If you leave out a choice code, make
  171.                     sure you leave out the menu choice.
  172.  
  173. -SET_VID_PRMPT   -  Setup's prompt for selecting a video mode.
  174.  (list)
  175.  
  176. -SET_VID_MODES   -  List of supported video modes.
  177.  (list)
  178.  
  179. -SET_VID_CODES   -  List of codes associated with video modes.
  180.  (list)
  181.  
  182. -SET_SND_PRMPT   -  Setup's prompt for selecting a sound device.
  183.  (list)
  184.  
  185. -SET_SND_DRVRS   -  List of supported sound devices.
  186.  (list)
  187.  
  188. -SET_SND_CODES   -  List of codes associated with sound devices.
  189.  (list)             (First Byte sound driver ID numbers)
  190.  
  191. -SET_PRNT_PRMPT  -  Setup's prompt for selecting a printer driver.
  192.  (list)
  193.  
  194. -SET_PRT_PRMPT   -  Setup's prompt for selecting which printer port
  195.  (list)             the printer is connected to.
  196.  
  197. -SET_PRT_PORTS   -  List of supported printer ports.
  198.  (list)
  199.  
  200. -SET_PRT_CODES   -  List of codes associated with printer ports.
  201.  (list)
  202.  
  203. -SET_PORT_PRMPT  -  Setup's prompt for selecting a port that is 
  204.  (list)             used with a Sound Blaster or Media Vision
  205.                     sound card.
  206.  
  207. -SET_PORT_NUMS   -  List of valid ports for a Sound Blaster or
  208.  (list)             Media Vision sound card.
  209.  
  210. -SET_PORT_CODES  -  List of codes associated with ports.
  211.  (list)
  212.  
  213. -SET_INT_PRMPT   -  Setup's prompt for selecting an interrupt 
  214.  (list)             that is used with the SoundBlaster sound 
  215.                     card.
  216.  
  217. -SET_INT_NUMS    -  List of valid interrupts for the SoundBlaster 
  218.  (list)             sound card.
  219.  
  220. -SET_INT_CODES   -  List of codes associated with interrupts.
  221.  (list)
  222.  
  223. -SET_MIDI_PRMPT  -  Setup's prompt for selecting which printer
  224.  (list)             port the Disney sound source is connected to.
  225.  
  226. -BATCH_NAME      -  File name of batch file to create during install
  227.  (list)             and setup.
  228.  
  229. -BATCH_CMNDS     -  Batch file commands to put into the file specified
  230.  (list)             by BATCH_NAME.
  231.  
  232. There are 2 batch file macros that can be used in any of the BATCH_CMNDS
  233. lines.  They are:
  234.  
  235.      $$LOAD_SOUND   -  Replaces macro with sound driver's file name.
  236.                        Must be at the end of a batch command line.
  237.  
  238.      $$LOAD_MIDI    -  Replaces macro with soft synth midi driver name.
  239.                        Must preceed the program's execution command.
  240.  
  241. Examples:    DRIVERS\$$LOAD_SOUND
  242.              $$LOAD_MIDI ZOO.EXE
  243.  
  244.  
  245.                       DISK COPYING COMMANDS
  246.                       ---------------------
  247.  
  248. Each of the following commands can be repeated for each disk 
  249. being installed.
  250.  
  251. -CHECK_VOL        -  Check disk being copied for a matching
  252.  (assignment)        volume name.  DO NOT USE WILD CARD CHARACTERS!
  253.  (default)
  254.  
  255. -CHECK_FILE       -  Check disk being copied for a matching file
  256.  (assignment)        name.  DO NOT USE WILD CARD CHARACTERS!
  257.  
  258. -DISK_LABEL       -  Text on disk's label (i.e., Program Disk).
  259.  (assignment)
  260.  
  261. (NOTE: The three commands above MUST appear
  262.        before the INSERT_DISK command)
  263.  
  264. -INSERT_DISK      -  Have the install program prompt the user for
  265.  (toggle)            a disk.
  266.  
  267. -NOTPACKED_FILES  -  All specified files from this point on have
  268.  (toggle)            not been packed by Phil's PACKHD.EXE file
  269.  (default)           packer.  DO NOT LIST FILES AFTER THIS COMMAND!
  270.                      Use the OTHER_FILES command to list the files.
  271.  
  272. -PACKED_FILES     -  All specified files from this point on are
  273.  (toggle)            packed with Frank's PK.EXE file packer.  PK.EXE
  274.                      uses PKWARE's data compression library.
  275.  
  276. -REBUILD_FILE     -  The file name immediately following this
  277.  (assignment)        command will be used at the destination
  278.                      file for all source files until the STOP_
  279.                      REBUILD command is found.
  280.  
  281. -STOP_REBUILD     -  Stops the rebuilding of several files into
  282.  (toggle)            one file.
  283.  
  284. -COPY_ATTRIB      -  All specified files from this point on will 
  285.  (toggle)            have their file attributes copied to the 
  286.  (default)           destination drive.
  287.  
  288. -IGNORE_ATTRIB    -  All specified files from this point on will 
  289.  (toggle)            NOT have their file attributes copied to the 
  290.                      destination drive.
  291.  
  292. -OTHER_FILES      -  List of file specifications for files that
  293.  (list)              are to be copied.
  294.  
  295. Here is the command that MUST BE LAST IN THE FILE.
  296.  
  297. -END_SCRIPT       -  Tells the install program that it is 
  298.  (toggle)            finished. 
  299.