home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / proglang / ix120.arj / IX.DOC < prev    next >
Encoding:
Text File  |  1992-03-13  |  15.3 KB  |  376 lines
  1. User's Manual for InstallX(c)                       March 1992
  2.  
  3.          S H A R E W A R E     VERSION !!!
  4.  
  5.          ███████████████████   ██
  6.              █           ██ ██
  7.              █        ███
  8.              █        ████
  9.              █           ██  ██
  10.         ████████████████    ██
  11.                     ███
  12.                       ██
  13.                        █
  14.  
  15.     InstallX and manual copyright (C) 1992 by Ray Gregoire.
  16.     All rights reserved.
  17.  
  18.     InstallX(c) version 1.2 release
  19.     The Ultimate Installation System
  20.  
  21. --------------------------------------------------------------------------------
  22. OVERVIEW
  23.  
  24. InstallX(c) is a seamless installation package that gives users
  25. an enjoyable first experience using your software. InstallX(c)
  26. is also a complete software distribution system equally easy for
  27. you the developer. InstallX(c) comes with two programs:
  28. SETUP.EXE allows you to designate which files to copy, where to
  29. copy them, and how to configure what the end user will see.
  30. After filling in the information, a master set of disks is
  31. generated. You customize the look and feel of the install
  32. process without writing a single line of code! INSTALL.EXE is a
  33. separate program that you ship with your product. INSTALL.EXE
  34. installs your software exactly as you configured it,  and
  35. optionally allows the user to choose a drive of their choice.
  36. Both programs work together in an intuitive, visually pleasing
  37. manner.
  38.  
  39. Unlike other installation systems that are script driven,
  40. InstallX(c)  is     menu driven. The intent of this decision was to
  41. make installation disk generation as simple as possible. Of
  42. course a script offers a virtual infinitude of installation
  43. permutations. A script must be carefully coded, however,
  44. demanding careful preparation and has higher failure ratio.
  45. InstallX(c)  has done all this preparation for you. The slightly
  46. increased rigidity is barely evident with the rich palette of
  47. features and elegant simplicity.
  48.  
  49. --------------------------------------------------------------------------------
  50. InstallX(c)  FEATURES
  51.                        * INDICATES USER DEFINED SWITCH
  52.  
  53. GENERAL FEATURES
  54.  
  55.  SEPARATE SETUP / INSTALL PROGRAMS   ROBUST C/S ONLINE HELP
  56.  CHARACTER BASED
  57.  WINDOWS 3.0/3.1 COMPATIBLE
  58.  DOS 3.0-5.0, DR DOS 6.0 COMPATIBLE
  59.  LOW MEMORY OVERHEAD
  60.  FAULT TOLERANT OPERATION
  61.  EXTENSIVE ERROR CONTROL
  62.  * AUTO REBOOT AFTER INSTALL
  63.  * CONFIG.SYS MODIFICATIONS
  64.  * AUTOEXEC.BAT MODIFICATIONS
  65.  * PROGRAM RUN AFTER INSTALLATION
  66.  
  67. SETUP.EXE FEATURES
  68.  
  69.  UNLIMITED NUMBER OF FILES & DISKS
  70.  POINT AND SHOOT FILE SELECTION
  71.  COLOR PALETTE CUSTOMIZATION
  72.  UNLIMITED DESTINATION DIRECTORIES ANY SUBDIRECTORY STRUCTURE
  73.  AUTO SENSING OF AVAILABLE MEDIA
  74.  ANIMATED INSTALLATION PREVIEW
  75.  REDEFINEABLE INSTALL.EXE UI
  76.  AUTOMATED INSTALL GENERATION
  77.  
  78. INSTALL.EXE FEATURES
  79.  
  80.  AUTO SENSING OF AVAILABLE MEDIA
  81.  REDEFINEABLE INSTALL DESTINATION
  82.  GRAPHICAL COMPLETION BAR
  83.  INSTALL.EXE LESS THAN 130K.
  84.  CRC ERROR CHECKING
  85.  3D SCULPTED UI
  86.  BATCH FILE FOR FUTURE ACCESS
  87.  VIRUS DETECTION
  88.  UPGRADE OR OVERWRITE FILES
  89.  * README FILE DISPLAY/PRINTOUT
  90.  * FILE COMPRESSION
  91.  * TEXTUAL STATUS INDICATORS
  92.  
  93. --------------------------------------------------------------------------------
  94. INSTALLATION:
  95.  
  96.      Copy the contents of ix120.zip into a subdirectory. Unzip the program.
  97.      type setup to begin.
  98.  
  99.  
  100.      IF YOU EXPERIENCE ANY PROBLEMS AT THIS POINT, PLEASE CONTACT
  101.      GREGOIRE DEVELOPMENT, LEAVING A MESSAGE WITH A BRIEF DESCRIPTION
  102.      OF THE PROBLEM. WE WILL MAKE EVERY ATTEMPT TO RESOLVE THE
  103.      SITUATION
  104. --------------------------------------------------------------------------------
  105.  
  106. OPERATIONAL OVERVIEW:
  107.  
  108. SETUP must be run first! It will create several data files that
  109. allow InstallX(c) to function. Just type SETUP at the DOS
  110. prompt. If you just typed install, then setup.exe will be run
  111. automatically. Understand that setup.exe is YOUR program. It
  112. only creates several data files. Setup.exe is not distributed
  113. with your product! Install.exe on the other hand IS distributed
  114. with your product!!!
  115.  
  116. When you first invoke the program you will see the main setup
  117. menu. It makes no difference which menu choice you choose first.
  118. Use the up/down arrow keys to select a menu choice and hit
  119. return on it to invoke it.
  120.  
  121. "Create/modify file list" allows you to enter the files that you
  122. want to install.  The files MUST be on an available drive.
  123. "Color customization", allows you to customize the color palette
  124. that will be displayed to the end user. "Setup defaults" allows
  125. further configuration controlling text file display, auto
  126. reboot, auto program invocation and definable  screen
  127. information. "Setup environment modifications" allows you to
  128. specify specific config.sys and autoexec.bat modifications to be
  129. performed. "Create subdirectory structure" presents you with a
  130. definable list of subdirectories to generate during the
  131. installation process. It is recommended that this menu choice be
  132. the first  information that you tell InstallX(c). Finally,
  133. "Create install disk" compiles all the data you have provided
  134. and generates a sequential set of disks, copying your software,
  135. and all the InstallX(c) program files onto the disks that you
  136. distribute.
  137.  
  138. CREATE/MODIFY FILE LIST
  139.  
  140. This menu choice allows you to search through the contents of
  141. your system and flag the files that will be included in the
  142. InstallX(c)  installation. The first time that you select this
  143. menu choice, you will be presented with a list of your current
  144. drive contents . If you have not already chosen "Create
  145. subdirectory structure" you will automatically be transferred to
  146. that area of the program  see "Create subdirectory structure"
  147. below.
  148.  
  149. Using the up/down arrow keys, PGUP/PGDN and CTRL-PGUP/CTRL-PGDN
  150. you can move through the current files. To enter a subdirectory,
  151. hit return on it. To move back a directory, hit return on the
  152. "..". To change to a different drive, hit F2, then use the
  153. up/down arrow keys to scroll through the alphabet.
  154.  
  155. Once you have arrived at a directory location containing a file
  156. that you want to include in the installation package, hit return
  157. on it. If you make a mistake, hit ESC.
  158.  
  159. After hitting return,  you will be presented with a dialogue
  160. asking you for additional information about that file .     Choose
  161. a destination directory for the file by hitting return on a
  162. subdirectory. This is the location where InstallX(c) will copy
  163. that file when the end user runs the install program. You may
  164. enter additional subdirectories (see "Create subdirectory
  165. structure") by hitting the INS key. You may also enter a line of
  166. text to be displayed while this file is being copied. Finally,
  167. choose overwrite or upgrade. If you choose overwrite, the file
  168. will be copied directly over a file that may have the same name.
  169. Upgrade will not copy the file if it senses an existing file
  170. with the same name and extension.
  171.  
  172. Upon hitting return on the last field, the file information is
  173. saved and you will be presented with your file installation
  174. list. At this point, to delete the file record, simply hit the
  175. delete key. To enter a second record, hit the INS key. To modify
  176. a record, hit return over it.
  177.  
  178. COLOR CUSTOMIZATION
  179.  
  180. This menu choice allows you to redefine the default colors that
  181. Install.exe will use while in operation. Simply hit return over
  182. a functional  area that you want to change. You will be provided
  183. with a color selection box. Hit return on the color that you
  184. want. Any changes that you make will appear in the example
  185. InstallX(c) screen to the right. To view an animated preview of
  186. what your installation will look like, based on your input, hit
  187. F3 at any time.
  188.  
  189. SETUP DEFAULTS
  190.  
  191. This dialogue box  contains information critical to the
  192. installation process. Lines one and two are simply lines of text
  193. that are displayed on the screen at all times. Appropriate
  194. information in line 1 may be the name of your program, and line
  195. 2 might be your company name. Select yes for compression if
  196. space is an issue. In the field containing EXECUTABLE NAME, you
  197. should type in the exact name of the program that should be run
  198. upon installation completion. Command line parameters should be
  199. included if they are required. Do NOT type drive or path
  200. information since these are end user contingent. EXECUTABLE
  201. LOCATION  presents you with the list of directories that you
  202. generated. Choose the directory that will contain the
  203. executable. If you enter an executable name, the information is
  204. incorporated into a batch file called go.bat. This batch file is
  205. placed in the root directory of the boot drive. The RUN
  206. AUTOMATICALLY field if yes, will run your software with the
  207. information that you provided, after InstallX(c) has finished.
  208. If you choose no, InstallX(c) will not run your software.The
  209. warm boot option is a good idea if config.sys and autoexec.bat
  210. will be changed but your software must be started by the user
  211. manually. If you choose YES for the  readme file, you will be
  212. asked to point to it on your system. This file will be displayed
  213. in a text viewer upon InstallX(c) completion. If you choose NO,
  214. you will not be prompted for a file at all.
  215.  
  216. SETUP ENVIRONMENT MODIFICATIONS
  217.  
  218. This menu choice allows you to designate exactly what changes to
  219. make to the config.sys and autoexec.bat files. You can append a
  220. total of three lines to both of these files. Simply type in the
  221. DOS information as you want it to appear in the appropriate file
  222. and hit return. You now have two options: TOP and BOTTOM. The
  223. first option, TOP will insert that line of code at the very top
  224. of the file. The second option, BOTTOM, will append that line of
  225. code to the bottom of the file.
  226.  
  227. One important point to mention is that even you explicitly
  228. enumerate these modifications, the end user can override these
  229. potential changes before they are made to the system files.
  230.  
  231. CREATE SUBDIRECTORY STRUCTURE
  232.  
  233. InstallX(c)  will generate any number of directories on a single
  234. drive when Install.exe is run.    Hit the INS key to create a
  235. directory directly off the root directory. Type in a name,
  236. obeying DOS conventions without the "\" indicators. F2 will
  237. create subdirectories directly below the selected directory that
  238. the highlighted cursor bar is positioned over. Experiment with
  239. this functionality and you will get the hang of it. To delete a
  240. directory, due to a mistake, hit the delete key when the
  241. highlighted cursor bar is positioned over it. All subdirectories
  242. containing the common root directory will be deleted as well.
  243.  
  244. CREATE INSTALL DISK
  245.  
  246. Once you are satisfied with the information that you have
  247. entered in all the menu choices, you are ready to generate the
  248. disks that you will distribute. Hit return on "Create install
  249. disk" to begin this process. InstallX(c) will automatically
  250. calculate file size information for you and display it on the
  251. screen. Once this information and all the other data that you
  252. entered has been compiled, the menu will become active.
  253. InstallX(c) will, by default, choose drive A as the drive where
  254. all the files will be copied to. You can choose any drive,
  255. however, by choosing "Change media drive". Use the up/down arrow
  256. keys to select a different drive, then hit return. If the drive
  257. is not available,  drive A will become the default drive once
  258. more.
  259.  
  260. Once you are satisfied with the drive selection you can begin
  261. the installation disk generation by choosing "MAKE INSTALL
  262. DISK". Immediately upon choosing this option, you will be
  263. prompted to install a formatted disk. Once this disk is filled
  264. to capacity, you will be prompted to insert additional disks.
  265. Be sure to label these disks as they are created.
  266.  
  267. When all files have been transferred, InstallX(c) will indicate
  268. that it has completed the disk set generation. Disk #1 will
  269. always be the one that the end user places in the drive first
  270. and types "install". All the logic is automated once install is
  271. typed. Subdirectories will be created when required, and files
  272. copied to the exact locations that you specified. It is goo
  273. protocol  to test a real installation prior to duplicating this
  274. master set.
  275.  
  276. --------------------------------------------------------------------------------
  277. TECHNICAL SUPPORT:
  278.  
  279.      Please report any bugs.  They will be resolved!!!
  280.      I can be reached at:
  281.  
  282.      Ray Gregoire at Channel 1    BBS           (617) 354-8873
  283.  
  284.      or
  285.  
  286.      Ray Gregoire
  287.      55 Phillips st.                   (617) 227-2059
  288.      Apt #8
  289.      Boston, Massachusetts 02114
  290.      USA
  291.  
  292. --------------------------------------------------------------------------------
  293. LICENSE INFORMATION
  294.  
  295. InstallX(c) Program Installation System
  296. Current Version: 1.2
  297.  
  298. Briefly, if you like this software, then use it and expect to see it become
  299. the ultimate install program by version 2.0. Tell your associates how good it
  300. is. Marvel at its simplicity of use. If you send in $79 plus the attached form
  301. I will send you the flagship version which has no file limitations, and
  302. complete documentation. You will also be able to receive the InstallX(c) 2.0
  303. upgrade for $20 (available late second quarter 1992).
  304.  
  305. Once payment has been received you are entitled to copy and use the program
  306. in any way you want.
  307.  
  308. I don't agree with Stallman, but I do think software is too $$$. Help support
  309. a fellow developer and keep moonlighting strong!
  310.  
  311. Since the shareware version can only install three files, you may want
  312. the full fledged version RIGHT NOW.
  313.  
  314. --------------------------------------------------------------------------------
  315. --------------------------------------------------------------------------------
  316. ORDER FORM
  317.  
  318. InstallX(c) Program Installation System
  319. Current Version: 1.2
  320.  
  321.   * Diskette with programs and documentation files ...... $79.      ______
  322.     (Unlimited individual use)
  323.  
  324.   * Commercial site license for the use of InstallX(c)
  325.     (Includes one diskette with programs & documentation files.)
  326.      2 to  9 computers ..... at $70 each    # computers ___x 60      ______
  327.     10 to 24 computers ..... at $60 each    # computers ___x 50      ______
  328.     25 to 49 computers ..... at $50 each    # computers ___x 40      ______
  329.     50 to 99 computers ..... at $40 each    # computers ___x 30      ______
  330.     100 or more computers .. $2000 one time fee              ______
  331.  
  332. Diskette format (choose one)  Low     5.25" disk ____   3.5" disk ____
  333.                   High    5.25" disk ____   3.5" disk ____
  334.  
  335. Extra program disk & documentation
  336. available at $10.00 each.                ___ x 10  ______
  337.  
  338. Please add $3.50 for shipping and handling.            $5.00 / 3.50
  339. (Please add $5.00 for overseas orders.)
  340.  
  341. Libertarian? ___ (y)       ___ (n) 5% sales tax.          ______
  342.  
  343.                     Total enclosed          ______
  344.  
  345.  
  346. Terms:    Check or Money Order drawn on a U.S.A. bank
  347.     in U.S. funds.    Purchase orders (net 20) accepted for software
  348.     from larger corporations.  All licenses are prepaid only.  All
  349.     orders outside of the continental United States must be prepaid.
  350.  
  351. * Includes a $20 upgrade to version 2.0 of the software, late
  352.   second quarter 1992.
  353.  
  354.  
  355. TO:                  FROM:
  356.  
  357. Ray Gregoire              Name: __________________________________
  358. 55 Phillips st.
  359. Boston, Ma 02114     (Company): __________________________________
  360.  
  361. 617-227-2059 Voice       (Title): __________________________________
  362.  
  363. Today's
  364. date: ___________    City, State: __________________________________
  365.                                   Zip Code
  366.                Phone Number: _________________________
  367.  
  368.  
  369. From what BBS did you receive InstallX(c)?  _____________________________
  370.  
  371. Data number                    _____________________________
  372.  
  373. --------------------------------------------------------------------------------
  374.  
  375. --------------------------------------------------------------------------------
  376.