home *** CD-ROM | disk | FTP | other *** search
/ Bila Vrana / BILA_VRANA.iso / 021A / XTRCT102.ZIP / Readme.eng < prev    next >
Text File  |  1996-09-03  |  10KB  |  253 lines
  1.  
  2.                    -= Manual for Xtractor, version 1.02 =-
  3.  
  4.                           -= UK/American version =-
  5.  
  6.                                   March 1996
  7.  
  8.  
  9.  
  10. See README.SWE for the Swedish version.
  11.  
  12.  
  13. TABLE OF CONTENTS
  14. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  15.  
  16. SECTION 1: Introduction
  17. SECTION 2: Installation notes
  18. SECTION 3: Starting the shell/batchfile
  19. SECTION 4: In-depth description of features (read this!)
  20. SECTION 5: The text- and batchfile pair
  21. SECTION 6: Some final words...
  22.  
  23.  
  24.  
  25. SECTION 1 : Introduction
  26. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  27.  
  28. Thanks for uploading the Xtractor! Xtractor is a combined menue shell and
  29. batchenhancer especially designed for making installation of archived progs
  30. from CDROM easier. For each new CDROM distribution, you will need to make a
  31. new batch & textfile pair (see below for details).
  32.  
  33. I'm releasing Xtractor as UGLYWARE (same as freeware but uglier), which means
  34. that you don't have to feel guilty for using the program. I think it's a bad
  35. trend that amateurs like me, to a greater extent, charges for their SMALL
  36. programs. Long live freeware!
  37.  
  38. ! Here is one for all you americans out there. I think you're great, but you
  39. ! do have a tendency to sue anybody for anything. I DON'T TAKE ANY RESPONS-
  40. ! ABILITY WHATSOEVER IF THE XTRACTOR MESSES UP YER COMPUTER. FURTHERMORE, I
  41. ! DON'T TAKE ANY RESPONSABILITY IF THE XTRACTOR IS USED IN ILLEGAL PURPOSES,
  42. ! LIKE INSTALLING PROGS FROM A PIRATE WAREZ CD.
  43.  
  44. The Xtractor package consists of six files: X.BAT (launches the main prog),
  45. XPROG.EXE (the main prog), README.SWE (Swedish manual), README.ENG (this
  46. file) and the example files FOOBAR.TXT and FOOBAR.BAT.
  47.  
  48.  
  49.  
  50. SECTION 2: Installation notes
  51. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  52.  
  53. Installation requires the 3 following steps (A-C):
  54.  
  55.  
  56. A) Increase environment space to 1K
  57.  
  58.    Since Xtractor takes advantage of the environmental space, you will
  59.    probably need to increase this to at least 512 bytes (depends on yer
  60.    current config). The environment is by default defined to 256 bytes of the
  61.    conventional memory. To increase this value, do the following:
  62.  
  63.    * make a boot diskette in case you mess up.
  64.    * Write 'SHELL=C:\COMMAND.COM C:\ /E:1024 /P' in Config.sys. This will
  65.      increase the environment to 1 k.
  66.  
  67.    Comment: Having a 'large' environment can be very useful if you write yer
  68.    own batchfiles. Besides, increasing the size with 256+ bytes is a drop in
  69.    the cean compared to what some drivers does for your system.
  70.  
  71.  
  72. B) Copy all the Xtractor files to some directory in your PATH
  73.  
  74.  
  75. C) Edit X.BAT
  76.  
  77.    To make sure the menue shell can locate the textfile (ex FOOBAR.TXT) where-
  78.    ever you are in the directory structure, you need to edit X.BAT. Start an
  79.    editor, open X.bat and edit the line AFTER the label RESTART. Here's where:
  80.  
  81.    <snip>
  82.  
  83.    :RESTART
  84.    REM ** Add a ChDir to the line below. Example: 'CD C:\XTRACTOR' **
  85.    REM CD C:\XTRACTOR
  86.  
  87.    <snip>
  88.  
  89.    Instead of the directory C:\XTRACTOR, add the directory where you chose to
  90.    install the files. Also, don't forget to remove the REMark. ;-)
  91.  
  92.  
  93. Windows 95 tip:
  94. ---------------
  95.  
  96. Don't worry, the Xtractor works fine with Windows95. Here's a tip though:
  97. Create a shortcut to X.BAT, and add a '?' after the command line (ex
  98. 'C:\DOSUTILS\X.BAT ?'. When starting X, you will be prompted for a parameter,
  99. ie the textfile. Also, choose 'terminate after completion' and write 'Input
  100. textfile...' in the topmost field.
  101.  
  102.  
  103.  
  104. SECTION 3: Starting the shell/batchfile
  105. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  106.  
  107. You can launch the menue shell in two ways; in Windows or DOS. In Windows just
  108. doubleclick on X.BAT and load the name of the textfile (see tip above). In
  109. DOS, you can start it by writing 'X txtfile' (ex 'X FOOBAR.TXT').
  110.  
  111. There are two ways to launch the batch procedures. First, you can use the
  112. menue shell and launch an installation procedure simply by pressing <enter>.
  113. Second, you can launch the batchfile by calling it directly from the prompt,
  114. ie 'FOOBAR progname'. If the batchfile is constructed well, it should provide
  115. information about syntax and a list of all the available programs, when it
  116. lacks a command line argument.
  117.  
  118.  
  119.  
  120. SECTION 4: In-depth description of features (read this!)
  121. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  122.  
  123. The Xtractor package provides two main features, the menue shell and the batch
  124. enhancer.
  125.  
  126.  
  127. The menue shell
  128. ---------------
  129.  
  130. X-BAT launches the menue shell. If the first argument is either 'HELP' or '?'
  131. syntax information is shown, otherwise the argument is supposed to be a text-
  132. file. Example: 'X ?' or 'X Foobar.txt'. If no argument is given, a default txt-
  133. file called X.txt will be created and launched. In the menue shell you can:
  134.  
  135.   1) (L)oad    - Load new textfiles.
  136.   2) (S)ort    - Sort the database contents.
  137.   3) E(X)tract - Installs marked program. You can also use <enter>.
  138.   4) (O)ptions - Customizes the menue shell (colors).
  139.   5) (I)nfo    - shows general information.
  140.  
  141. The menue shell is terminated by pressing <esc> or 'Q'.
  142.  
  143.  
  144. The batch enhancer
  145. ------------------
  146.  
  147. The batch enhancer features are adressed through XPROG.EXE. In your batch
  148. installer file, call the features with 'XPROG command', where available
  149. commands are:
  150.  
  151.   HELP or ? - shows syntax and all available commands.
  152.   CDDRV     - returns the first CDROM drive letter in the environmental var-
  153.               iable CDDRV. All variables can be accessed in your batch file
  154.               by putting a % before and after the variable. 
  155.   CDVOL     - returns CD label in the variable CDVOL.
  156.   ANSI      - tests whether ANSI driver is loaded, then returns 'YES' or
  157.               'NO' in variable ANSI.
  158.   WIN       - tests if Windows is loaded, then returns 'YES' or 'NO' in the
  159.               variable WIN.
  160.   MSCDEX    - tests if MSCDEX is loaded, then returns 'YES' or 'NO' in the
  161.               variable MSCDEX. This is useful if ya want to do an emulation.
  162.   PUSHDIR   - saves the current directory.
  163.   POPDIR    - restores the 'current' directory previously saved.
  164.   ASKDIR    - asks for an install directory, returns answer in variable DIR.
  165.   ASKKEY [S] - writes string S, then prompts for key input. Response is given
  166.                in variable KEY.
  167.   ASKSTR [S] - writes string S, prompts for string input and returns response
  168.                environmental variable STR.
  169.   MAKEDIR D  - creates (multiple-level) directory structures
  170.  
  171.  
  172. Examples of use:
  173.  
  174.   XPROG CDVOL
  175.   IF NOT %CDVOL%=="My progs" ECHO This is the NOT the correct CD!
  176.   
  177.   XPROG ASKDIR
  178.   MAKEDIR %DIR%
  179.  
  180.  
  181.  
  182. SECTION 5 : The text- and batchfile pair
  183. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  184.  
  185. The Xtractor provides some of the TOOLS you need to make an efficient and
  186. easy-to-use install program. You will however, need to put some effort into
  187. making a good text- and batchfile pair, which is used by the Xtractor shell.
  188. The batchfile has to have the SAME NAME as the information file, but with
  189. different extensions (ofcourse). Examples are FOOBAR.BAT and FOOBAR.NFO. Note
  190. that the information file does not have to have the TXT extension.
  191.  
  192.  
  193. The (information) textfile
  194. --------------------------
  195.  
  196. The info-file should have the following structure (number in brackets denote
  197. character length):
  198.  
  199.   BatchID (12)  Category (17)      Description (39)
  200.   ------------  -----------------  --------------------------------------
  201.   
  202.   Example:
  203.  
  204.   <snip>
  205.  
  206.   Dosgame#1     Game (Strategy)    Tic-Tac-Toe, (c)NeverNever Productions
  207.   Dosgame#2     Game (Action)      Big Heffer, (c) Playboy Interactive
  208.   Winapp#1      Win95 application  Golf Ball Manager, (c) Humpty Inc
  209.     .               .                     .
  210.     .               .                     .
  211.     .               .                     .
  212.  
  213.   <snip>
  214.  
  215. Observe that there are two spaces between each part. If a