home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / PASCAL / INST1.ZIP / INSTALL.DOC < prev    next >
Encoding:
Text File  |  1993-01-22  |  11.6 KB  |  319 lines
  1.                            Instant INSTALL
  2.                            ***************
  3.  
  4. This is a software installation program which runs under any version
  5. of DOS 2.x or higher.
  6.  
  7. You can customize it in several ways:  Number of diskettes with ID
  8. check, single or multiple destination directories, ensure minimum
  9. target drive free space, view READ*.ME* files, a screen title, final
  10. messages and run any program after installation.
  11.  
  12. Your choice of ARC, LZH or ZIP archives and extract programs is
  13. supported automatically.  Any of the following may be used:
  14.  
  15.  File EXT     "UNZIP" Utilities supported
  16.  --------     ---------------------------
  17.  LZH              LHA.EXE - Haruyasu Yoshizaki
  18.  ZIP          PKUNZIP.EXE - PKWARE Inc.
  19.  ZIP            UNZIP.EXE - Borland International
  20.  ARC & ZIP        PAK.EXE - NoGate Consulting
  21.  ARC           PKXARC.COM - PKWARE Inc.
  22.  ARC             XARC.EXE - System Enhancements Associates
  23.  ARC             ARCE.COM - Wayne Chin and Vernon D. Buerg
  24.  ARC            ARC-E.COM - Wayne Chin and Vernon D. Buerg
  25.  
  26. INSTALL detects whether the extract program is on diskette, or on the
  27. target PC via the PATH= environment variable.
  28.  
  29.  
  30.  
  31.                                OVERVIEW
  32.                                ********
  33. Source drive is auto-detected; the user selects a drive from a
  34. PickList, then presses ENTER (or clicks with mouse).  That's it!
  35.  
  36. Files are over-written during a re-install.  INSTALL works with
  37. versions 2.x - 5.0 of DOS.
  38.  
  39.  
  40.  
  41.                          MINIMUM REQUIREMENTS
  42.                          ********************
  43. FIRST DISK
  44. ----------
  45. [X] A copy of INSTALL.EXE
  46. [X] An archive extract program (see above)
  47. [X] An INSTALL.DAT file, with line ".ID x" (".ID x y" for 2+ disks)
  48. [X] One or more archive files (ARC, LZH or ZIP)
  49.  
  50. SUBSEQUENT DISKS
  51. ----------------
  52. [X] An INSTALL.DAT file with line ".ID x"
  53. [X] One or more archive files (ARC, LZH or ZIP)
  54.  
  55.  
  56. INSTALL.DAT (all disks)
  57. -----------------------
  58. The contents of this file is ignored until the ".ID" keyword is found.
  59.  
  60.  
  61. If there is more than one disk, the first INSTALL.DAT uses ".ID x y",
  62. where "x" is the disk number and "y" is the total number of disks.
  63. Subsequent disks use the form ".ID x", where "x" is the disk number.
  64.  
  65. In addition, there will usually be at least one pair of names; an
  66. archive filename and its destination directory.  If none at all,
  67. files are sent to the current directory of the selected drive.  If
  68. not for a given archive, the FIRST is used as the default.
  69.  
  70.  
  71.  
  72.                          INSTALL.DAT EXAMPLES
  73.                          ********************
  74.                               EXAMPLE #1
  75. DISK 1 of 1
  76. -----------
  77.     .ID 1                    @@ only one disk
  78.     .TITLE Good Program      @@ Title at top of screen
  79.     myarc \mydir\            @@ archive file and destination directory
  80.  
  81. If the user selected drive "F:", the contents of archive "myarc" is
  82. extracted to "F:\MYDIR\".
  83.  
  84. It is not necessary to specify a file extension; the diskette is
  85. scanned for a list of ARC, LZH or ZIP files; whichever is found first
  86. determine what extension is used for INSTALL.
  87.  
  88. After files are extracted, INSTALL switches to "F:\MYDIR\" and leaves
  89. the user at the DOS prompt.
  90.  
  91.  
  92.                               EXAMPLE #2
  93. DISK 1 of 2
  94. -----------
  95.     .ID 1 2                  @@ disk one of two
  96.     .TITLE Better Program    @@ Title at top of screen
  97.     myone mydir              @@ archive and default destination
  98.     myconfig mydir\cfg       @@ special stuff
  99.     .DOS myprog /setup       @@ run program, with setup switch
  100.  
  101.  
  102. DISK 2 of 2
  103. -----------
  104.     .ID 2                    @@ disk two of two
  105.  
  106.  
  107. DISK #1.  Assuming drive "F:" again, the contents of archive "myone"
  108. is sent to "F:\MYDIR\".  The contents of archive "myconfig" goes to
  109. "F:\MYDIR\CFG\".
  110.  
  111. The contents of any other archive files are routed to "\MYDIR\".  It
  112. was the first one specified, so it is the default.
  113.  
  114.  
  115. DISK #2.  If the archives on disk 2 can all go to "\MYDIR\", the
  116. contents of INSTALL.DAT on disk 2 could consist of a single line,
  117. ".ID 2", to identify the correct disk.
  118.  
  119. When INSTALL is finished, the user will be in the "C:\MYDIR"
  120. directory, and the "MYPROG" program is run with the "/SETUP" switch.
  121.  
  122. "MYPROG" can be a batch, command or executable file (BAT, COM or EXE).
  123.  
  124.  
  125.                               EXAMPLE #3
  126. DISK 1 of 2
  127. -----------
  128. .ID 1 2                      @@ first of two disks
  129. .TITLE The ~Best~ Program!   @@ Title with "highlight"
  130. .KILOBYTES 200               @@ 200 k needed; ie: 204800 bytes
  131.  
  132. @@  FILENAME  DIRECTORY      <--This is a comment!
  133.     myfile    mydir          @@ primary
  134.     mydata    mydir\data     @@ data directory
  135.  
  136. .MSG First disk installed!
  137. .VIEW read.* readme1     @@ display files in destination directory
  138. .DOS myfile /setup       @@ A DOS command when done
  139.  
  140.  
  141. DISK 2 of 2
  142. -----------
  143. .ID 2
  144.  
  145. .MSG Second disk installed!
  146. .MSG
  147. .MSG --------------------------------------------------------
  148. .MSG Call "NONOTHING SOFTWARE STORES" to buy computer thingys
  149. .MSG --------------------------------------------------------
  150. .MSG          "We'll sell you anything!"
  151. .MSG
  152. .MSG          If you need computer stuff, call us!
  153. .MSG          If you need Technical Support, we don't know you!
  154.  
  155.  
  156. Note that blank lines are ignored, but ".MSG" will result in an empty
  157. line inserted into the final message screen.
  158.  
  159.  
  160. COMMENTS.  The double at-sign ("@@") is used for comments; anything
  161. after the "@@" symbols is ignored.  Leading and trailing spaces are
  162. also ignored.
  163.  
  164. DESTINATION(S).  Drive names ("C:", "D:", etc) are ignored; this is
  165. selected by the user.  Leading and trailing slashes are optional.
  166. Directories are created before extracting files (for each diskette).
  167.  
  168.  
  169.  
  170.                                OPTIONS
  171.                                *******
  172. You specify destination directory(s) in INSTALL.DAT; if none are
  173. given, files are extracted to the current directory of the selected
  174. drive.  The user selects a drive from a list of fixed and network
  175. disks; if ".KILOBYTES xxx" is used in INSTALL.DAT, only those with
  176. enough free space are listed.
  177.  
  178.  
  179.  
  180.                                KEYWORDS
  181.                                ********
  182. The following keywords let you specify destination directories, total
  183. number of diskettes, ID check, minimum free space, file(s) to view
  184. after installation and a final DOS command, to run a program which
  185. further customizes installation (see SETUP.BAT for an example).
  186.  
  187. Certain keywords are used BEFORE a diskette is processed, others
  188. AFTER the entire installation process is completed.
  189.  
  190.  
  191.                         BEFORE (each diskette)
  192.                         ======================
  193. Keyword            Purpose
  194. -------            -------
  195. .ID x              Required on all diskettes.
  196.  
  197. .ID x y            "x" is the disk number, "y" is the total disks.
  198.                    First diskette only; if "y" isn't given, it is
  199.                    assumed this is a single diskette installation.
  200.  
  201. .KILOBYTES xxx     "xxx" is the minimum disk space you require.  If
  202.                    given, only drives with enough free disk space
  203.                    will be shown to the user.
  204.  
  205.  
  206.                                ANYTIME
  207.                                =======
  208. Keyword            Purpose
  209. -------            -------
  210. @@                 Comment symbol; anything after it is ignored
  211.  
  212. .TITLE string      There can be only one of these, in the first
  213.                    INSTALL.DAT file.  It displays a single line
  214.                    inside a bordered window.
  215.  
  216.                    You can "highlight" by enclosing text with pairs
  217.                    of title (~) characters:
  218.  
  219.                    .TITLE A ~highlighted~ title
  220.  
  221. .MSG string        These "accumulate" from each INSTALL.DAT file,
  222.                    then are presented when the whole job is done.
  223.  
  224.                    The number of lines is not limited.  The display
  225.                    pauses when the screen is full and/or when the
  226.                    last sentence is displayed.
  227.  
  228.  
  229.                         AFTER (all diskettes)
  230.                         =====================
  231. Keyword            Purpose
  232. -------            -------
  233. .VIEW f1 f2        "f1", "f2", etc are filespecs (wildcards OK)
  234.                    Use to view extracted files in the final directory.
  235.  
  236. .DOS setup %1 /sw  A command just like at the DOS prompt.  "Setup" can
  237.                    be any string; ie:  ".DOS myprog /go".
  238.  
  239.                    This feature is used to run an extracted program,
  240.                    to customize installation (see example SETUP.BAT).
  241.                    It can be a BAT, COM or EXE file.
  242.  
  243.                    The total length must be 15 characters or less.
  244.  
  245.                    If the "%1" is used, INSTALL will replace it with
  246.                    the drive from which the program was installed.
  247.                    It will be either "A:" or "B:" (in case your SETUP
  248.                    program needs to know this.)
  249.  
  250.                    This command is executed when the installation
  251.                    process is completely finished; there is no memory
  252.                    overhead, and the diskette no longer needs to be
  253.                    in the drive (unless your SETUP program needs it).
  254.  
  255.  
  256.  
  257.                       HOW TO CREATE DISKETTE(S)
  258.                       *************************
  259. INSTALL.EXE and the "extract" program are needed only on the first
  260. diskette.  For multiple disks, INSTALL copies the extract program to
  261. the root directory of the target drive, then deletes it when the
  262. installation process is finished.
  263.  
  264. [X] You can save diskette space if you KNOW the target PC has the
  265.     extract program available via the "PATH=" environment variable.
  266.     If the extract program is not on the first disk, INSTALL will
  267.     search PATH= automatically.
  268.  
  269. Now all you have to do is archive your program into ARC, LZH or ZIP
  270. file(s) and copy to diskette.
  271.  
  272. The simplest possible disk would have INSTALL.EXE, INSTALL.DAT and
  273. one archive file.  In this case, you're counting on the extract
  274. program being present and available via PATH= on the host.
  275.  
  276. A more likely scenario:  INSTALL.EXE, INSTALL.DAT, an extract program
  277. such as LHA.EXE (tightest compression), and your program in several
  278. archive files, to be routed to several destination directories.
  279.  
  280.  
  281.                          The INSTALL Process
  282.                          *******************
  283.  
  284. If an error condition arises, or the user cancels the process, a
  285. message is displayed, and the program ends.  The sequence of events
  286. is as follows:
  287.  
  288.  
  289. FIRST DISK ONLY
  290. ---------------
  291. Ensure user is running from diskette.  Read the INSTALL.DAT file,
  292. ignore everying until ID check passes, then get additional options.
  293. Determine archive type and find extract program.  If 2 or more disks,
  294. copy program to root of target drive.  Present user with PickList
  295. dialog, to select a drive.  Check free space on on target drive.
  296.  
  297.  
  298. ALL DISKS
  299. ---------
  300. Check disk ID number, get other information from INSTALL.DAT.  Create
  301. specified directory(s) on target drive.  Scan diskette for list of
  302. archive files (*.ARC, *.LZH or *.ZIP), route to destination as
  303. specified.  Call extract program to de-archive; if user interrupts
  304. with Ctrl-C or Ctrl-Break, flash ABORT message and stop.
  305.  
  306. If more that one diskette, prompt user for next disk and continue.
  307.  
  308.  
  309. AFTER LAST DISK
  310. ---------------
  311. If 2+ disks, erase extract program from root directory of target
  312. drive.  Perform "CHDIR" to specified (or first) directory of list.
  313. If ".VIEW" files specified, load viewer; continue when user presses
  314. "ALT-X".  Display ".MSG" screen(s), then custom screen(s); run the
  315. ".DOS xxx /xx" command (if specified).
  316.  
  317.  
  318.  
  319. *** END DOCUMENTATION ***