home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / editors / hypsh40b.arj / HSRES110.LZH / HSRES.DOC < prev    next >
Text File  |  1991-04-12  |  35KB  |  855 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.                   HSRES -- A Resident Shell for HyperShell
  21.                                Version 1.10
  22.                                 April 1991
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37. HSRES resident swapping shell for HyperShell.
  38. Version 1.10, april 1991
  39.  
  40. (c) Werner Knudsen
  41.     Tulipanvej 5
  42.     DK-2600 Glostrup
  43.     Denmark
  44.  
  45. HSRES       A Resident Shell For HyperShell                  Page 3
  46.  
  47.  
  48. 2   Overview - General information    
  49.  
  50. ------- Overview -------------------------------------------------------
  51.  
  52. HSRES is a TSR (Terminate and Stay Resident) program that can activate
  53. HyperShell while almost any application is running, hence providing the
  54. ability to access hyperfiles programs that didn't originally allow it.
  55. HSRES keeps only about 6K of normal DOS memory when it goes resident,
  56. but can provide up to about 600K of free DOS space when it pops up.
  57.  
  58. HSRES uses two forms of swapping technology to maximize the amount of
  59. memory available to the shell. First, HSRES is a swappable TSR: when its
  60. hot key is pressed, HSRES swaps out the applications loaded after it and
  61. swaps itself in. Most of the memory area that it reclaims in this way
  62. isn't used directly by HSRES. Besides the code, data, and stack space
  63. that HSRES actually uses, it retains a variable amount of heap space
  64. that provides the free RAM for HyperShell. Second, HSRES uses a swapping
  65. DOS shell: after the swappable TSR takes control, it swaps the TSR's
  66. code and data back out, shrinks its memory allocation to the minimum,
  67. and calls the DOS EXEC function to activate HyperShell. The amount of
  68. memory free for this can range from 30K to over 600K depending on when
  69. and how HSRES was loaded. After you terminate HyperShell, the sequence
  70. is reversed and the original application regains control.
  71.  
  72. For reasons that aren't clear at this time, HSRES does not work with
  73. PC-DOS 2.0 or 2.1. Either piece of swapping technology -- swappable
  74. TSR's or swapping exec -- works fine by itself, but the two don't
  75. combine. Interestingly, AT&T DOS version 2.11 works with HSRES, which
  76. suggests the presence of a bug in the earlier DOS versions. HSRES.EXE as
  77. supplied will not load for any DOS version prior to 3.00.
  78.  
  79.  
  80.  
  81. 3   Installation - How to install HSRES  
  82.  
  83. ------- Installing HSRES -----------------------------------------------
  84.  
  85. HSRES will use either EMS (expanded memory) or disk space for its
  86. swapping medium. When using EMS, it consumes about X+45 kilobytes of EMS
  87. space (rounded up to the nearest 16K boundary), where X is the amount of
  88. RAM to be free when the DOS shell starts. When using disk, it uses about
  89. n*(X+15)+30 kilobytes of space, where n is either 1 or 2 depending on
  90. whether single or double file swapping is used. The single file swapping
  91. option is described in more detail below.
  92.  
  93.  
  94. 4   Default - The default behavior   
  95.  
  96. You can install HSRES simply by typing its name at the DOS command line.
  97. It provides the following default behavior:
  98.  
  99.   - all RAM that is free at the time HSRES is loaded, less about 20K,
  100.     will be available to HyperShell - EMS, if available, will be used
  101.     for swap space - dual swap files located in the root directory of
  102.     drive C: will be used if EMS is not available - swap files will be
  103.     marked hidden - hot key will be <Alt><F1>, with <Alt> activating
  104.  
  105. HSRES       A Resident Shell For HyperShell                  Page 4
  106.  
  107.     on-screen configuration during popup - the mouse state will be saved
  108.     and restored if the mouse driver allows
  109.  
  110.     HyperShell will be activated by the HS browsing program, with no
  111.     options, hyperfiles or frames in the call.
  112.  
  113.     All of these defaults may be modified by using the command line
  114.     options or on-screen configuration described below.
  115.  
  116.  
  117.  
  118. 5   Options - Description of command line options 
  119.  
  120. ------- HSRES command line options -------------------------------------
  121.  
  122. The following table summarizes the HSRES command line options:
  123.  
  124.   /1           single swap file
  125.   /A           visible attribute for swap files
  126.   /C           on-screen configuration
  127.   /D           force disk swapping even if EMS available
  128.   /Fkbytes     specify approx. kbytes free within DOS shell
  129.   /Hhyperfile  specify hyperfile to activate. $-variables allowed
  130.   /Khexkeys    specify TSR hot keys in hex
  131.   /M           disable swap message
  132.   /Pprogram    chose as program HS, HL or HI
  133.   /Rframe      specify hyperfile frame to show. $-variables allowed
  134.   /Spath       specify path for swap files. $-variables allowed
  135.   /U           unload TSR
  136.   /V           remove mouse management code
  137.   /? or ?      show the command line options
  138.  
  139. The "/" option prefix may be substituted by "-". Spaces are not allowed
  140. inside command line options, and the options must be separated by
  141. spaces.
  142.  
  143. The "switching" options, eg. /1, will switch the option back and forth
  144. when mentioned several times. The other options, like /S, will retain
  145. the value from the LAST time they are mentioned.
  146.  
  147. Options may be placed in a configuration file, as described below.
  148.  
  149.  
  150. 6   /1 - Single swap file   
  151.  
  152. When disk space is used for swapping, HSRES normally uses three swap
  153. files. Two of the files are used to activate the swappable TSR. The
  154. first such file holds the HSRES code and data and the other one holds
  155. the memory contents that HSRES overwrites. The third file is used for
  156. the DOS shell itself and consumes about 30K bytes, which is typically
  157. much smaller than the first two. When the /1 option is specified, HSRES
  158. uses a small intermediate buffer which removes the need for one of the
  159. first two files and thus cuts its disk space requirement by up to a
  160. factor of two (see the formula above). However, the intermediate buffer
  161. slows swapping since the swap file is read in smaller (2K byte vs. 64K
  162. byte) blocks and since an extra memory-to-memory move is required.
  163. Nevertheless, the single swap file option is advantageous if it allows
  164. the swap files to fit entirely on a RAM disk. Note that the intermediate
  165.  
  166. HSRES       A Resident Shell For HyperShell                  Page 5
  167.  
  168. buffer increases the size of the HSRES resident core by 2K bytes as well.
  169.  
  170.  
  171. 7   /A - Visible / hidden swap files 
  172.  
  173. When the /A option is specified, HSRES leaves its swap files visible and
  174. unprotected. Don't delete or overwrite the swap files (which are named
  175. HSSWAP01.!!!, HSSWAP02.!!!, HSSWAP03.!!!) while HSRES is loaded. Note
  176. that HSRES deletes its own swap files when it is unloaded. Although
  177. HSRES cannot delete the swap files if you turn the machine off while
  178. HSRES is still loaded, it will correctly overwrite them the next time
  179. it's loaded again.
  180.  
  181.  
  182. 8   /C - View or change HSRES configuration 
  183.  
  184. The /C option puts you into the on-screen configuration mode, which is
  185. described in details below.
  186.  
  187.  
  188. 9   /D - Use Disk when EMS is available
  189.  
  190. The /D option forces HSRES to use disk space for swapping even if
  191. sufficient EMS space is available. You'd specify this option if you have
  192. other applications that will need the EMS space, or if you have an
  193. extended memory RAM disk that you prefer to use for swapping. Note that
  194. HSRES allocates space for the TSR-swapping requirement when it goes
  195. resident. At the time it pops up, it allocates another 30K bytes of EMS
  196. or disk space for the shell itself.
  197.  
  198.  
  199. 10   /F - Free Kbytes for shell  
  200.  
  201. /F lets you specify how many kilobytes of RAM space you'd like to remain
  202. free for HyperShell. The larger this number, the larger your swap space
  203. requirements will be. The smallest allowed parameter is 30, since DOS
  204. itself won't do much with less than 30KB free.
  205.  
  206. If you don't specify a /F option, HSRES will try to estimate an amount,
  207. based on the actual /P program component and the actual /H HyperFile.
  208. Environment $-variables are evaluated before the estimate is done.
  209.  
  210. If the amount cannot be estimated, the free space within the shell will
  211. be the amount of memory that was free when HSRES was loaded, less about
  212. 20K.
  213.  
  214.  
  215. 11   /H - HyperFile to activate   
  216.  
  217. /H lets you specify, which hyperfile HyperShell shall try to locate.
  218. by default it is blank, so that HyperShell will try to activate HOME.HYP.
  219. When this option is placed in the configuration file, the hyperfile name
  220. can be prefixed by any number of HyperShell options. For example the line
  221.  
  222. /H-R -A HELP.HYP
  223.  
  224. in the configuration file will tell HyperShell to open HELP.HYP, and
  225. restart on the frame, it left in HELP.HYP last time, using the
  226.  
  227. HSRES       A Resident Shell For HyperShell                  Page 6
  228.  
  229. HyperShell restart file RESTART.HSF, using auto-referencing.
  230. It is limited to a length of 66 characters.
  231.  
  232. $-variables of any kind are allowed in this option.
  233.  
  234.  
  235. 12   /K - Popup HotKey    
  236.  
  237. /K allows you to specify a hot key other than the default <Alt><F1>,
  238. with <Alt> for on-screen configuration during popup. The format of the
  239. option is /Fxxxx[,yyyy]. The x and y parameters following /K must be in
  240. hexadecimal. In xxxx the high byte specifies the shift key combination
  241. and the low byte specifies the scan code of the trigger key.
  242. The yyyy part denotes the config shift key, which is described below.
  243.  
  244. The shift key codes are:
  245.  
  246.   None       - 00
  247.   RightShift - 01
  248.   LeftShift  - 02
  249.   Ctrl       - 04
  250.   Alt        - 08
  251.  
  252. Valid scan codes (in hexadecimal) are:
  253.  
  254.   A - 1E      N - 31      0 - 0B      F1 - 3B      [ - 1A
  255.   B - 30      O - 18      1 - 02      F2 - 3C      ; - 27
  256.   C - 2E      P - 19      2 - 03      F3 - 3D      , - 33
  257.   D - 20      Q - 10      3 - 04      F4 - 3E      / - 35
  258.   E - 12      R - 13      4 - 05      F5 - 3F      \ - 2B
  259.   F - 21      S - 1F      5 - 06      F6 - 40      ] - 1B
  260.   G - 22      T - 14      6 - 07      F7 - 41      ' - 28
  261.   H - 23      U - 16      7 - 08      F8 - 42      . - 34
  262.   I - 17      V - 2F      8 - 09      F9 - 43      ` - 29
  263.   J - 24      W - 11      9 - 0A      F10- 44
  264.   K - 25      X - 2D                  F11- 57
  265.   L - 26      Y - 15                  F12- 58
  266.   M - 32      Z - 2C
  267.  
  268. For example, 0244 means <LeftShift><F10>, 0820 means <Alt><D>, while
  269. 0517,04 means <Ctrl><RightShift><I> with <Ctrl> as config key.
  270.  
  271. Please notice, that although the scan codes for 1-9, A-Z and F1-F10 are
  272. quite dependable, the rest of the scan codes may not work with explicit
  273. keyboard definitions, eg. the danish KEYB,DK.
  274.  
  275.  
  276. 13   config shift key - Key to invoke on-screen configuration
  277.  
  278.  
  279. In the optional yyyy part of the /K option the low byte specifies the
  280. shift key code for on-screen configuration. This is the key you keep
  281. depressed while popping up, when you wish to reconfigure HSRES
  282. interactively. If the code is 0000, the popup of on-screen configuration
  283. is disabled.
  284.  
  285. Please notice, that all of the hexadecimal key values can be generated
  286. for you from the configuration screen.
  287.  
  288. HSRES       A Resident Shell For HyperShell                  Page 7
  289.  
  290.  
  291.  
  292. 14   /M - Disable swapping message   
  293.  
  294. /M disables the swapping message, which HSRES normally displays whenever
  295. it is swapping to disk or to EMS when it judges that the swap delay
  296. would be noticeable. /M is particularly useful when you're swapping to a
  297. RAM disk.
  298.  
  299.  
  300. 15   /P - Choose HyperShell program component
  301.  
  302. /P lets you switch between the normal HS program and the HL program for
  303. large hyperfiles, or the HI program for the integrated development
  304. environment.
  305.  
  306.  
  307. 16   /R - HyperFile start frame   
  308.  
  309. /R lets you specify, which frame in the current hyperfile HyperShell
  310. shall try to locate. by default it is blank, so that HyperShell will
  311. start in the home frame. It is limited to a length of 30 characters.
  312.  
  313. $-variables of any kind are allowed in this option.
  314.  
  315.  
  316. 17   /S - Swap file directory   
  317.  
  318. /S specifies an alternate drive and directory for the swap files. The
  319. default location is C:\. All three swap files go to the same place. Note
  320. that the parameter to /S should specify a complete path name, including
  321. a drive and directory but no filename.
  322.  
  323. $-variables of the environment variable kind are allowed in this option.
  324.  
  325.  
  326. 18   /U - Unload HSRES
  327.  
  328. /U unloads HSRES, if it is found safe to do so.
  329.  
  330.  
  331. 19   /V - Mouse management code   
  332.  
  333. When /V is specified, HSRES doesn't execute its mouse management code.
  334. This option does nothing unless a mouse is installed. By default, HSRES
  335. saves and reinitializes the mouse state before it starts the DOS shell
  336. and restores the mouse before returning control to the underlying
  337. application. For some mouse drivers, notably recent versions of
  338. Microsoft MOUSE.COM and MOUSE.SYS, the call to reinitialize the mouse
  339. takes an annoyingly long time (a second or so). /V removes this delay,
  340. but you may see a phantom mouse cursor when you return to the
  341. interrupted application.
  342.  
  343.  
  344. HSRES       A Resident Shell For HyperShell                  Page 8
  345.  
  346.  
  347. 20   $-variables - Transferring data to HSRES
  348.  
  349.  
  350. You can transfer data from the running application to HSRES by means of
  351. $-variables. These variables will be evaluated and replaced in the HSRES
  352. configuration at the time of installation or popup.
  353.  
  354. There are four types of $-variables:
  355.  
  356.      $              Word from text cursor position
  357.      $(x,y)         Word from x,y screen position
  358.      $(?prompt)     Ask the user for a value
  359.      $(EnvVar)      Value of environment variable
  360.  
  361.  
  362. 21   Word from text cursor position - $ 
  363.  
  364.  
  365. A $ character without no (parameters) will evaluate to the word under
  366. the text cursor position at the time of popup. The word can consist of
  367. all international letters and numbers.
  368.  
  369. Example: If the word under the cursor is "Test", then the HyperFile
  370.          option            /H$.HXP
  371.          will evaluate to  /HTest.HXP
  372.  
  373.  
  374. 22   Word from x,y screen position - $(x,y) 
  375.  
  376.  
  377. A $ character with an (x,y) pair as parameter will evaluate to the word at
  378. the the absolute screen position at the time of popup, where x is the
  379. column and y is the row. The top left position is numbered (1,1). The
  380. word can consist of all international letters and numbers.
  381.  
  382. Example: If the word under position 78,25 is "Test", then the HyperFile
  383.          option            /H$(78,25).HXP
  384.          will evaluate to  /HTest.HXP
  385.  
  386.  
  387. 23   Ask the user for a value - $(?prompt)
  388.  
  389.  
  390. A $ character where the first character of the (parameter) is ? will
  391. evaluate to the answer, the user gives to a prompt. The text after "?"
  392. will be used as prompt. If no prompt is defined, ie. $(?), will prompt
  393. the user will be prompted with "Enter parameters:".
  394.  
  395. Example: The frame option     /R$(?Enter frame name:)
  396.          will prompt the user with "Enter frame name:", and use the
  397.          answer in the HyperShell call.
  398.  
  399. Please note, that the prompt contains spaces. This can be obtained by
  400. placing the option in a HSRES.CFG file.
  401.  
  402.  
  403. HSRES       A Resident Shell For HyperShell                  Page 9
  404.  
  405.  
  406. 24   Value of environment variable - $(EnvVar)
  407.  
  408.  
  409. If the parameter to a $ character is neither a screen coordinate nor a
  410. prompt, HSRES will check the DOS environment for a variable value. The $
  411. parameter will evaluate to this value, or to a blank, if no value exists.
  412.  
  413. You can use this feature to define options with spaces from DOS, or a
  414. batch file. As an example, see the lines
  415.  
  416.     set frame=Additional information
  417.     HSRES /Hhelp /R$(frame)
  418.  
  419. which will configure HSRES for the HyperFile "HELP.HYP" starting on the
  420. frame "Additional information".
  421.  
  422. You can also use this to define a swap file path.
  423.  
  424.  
  425. 25   Examples - HSRES command line examples
  426.  
  427. Here are some examples of HSRES command line options:
  428.  
  429. HSRES /F90
  430.   Installs HSRES to start HS, searching by default for HOME.HYP, with
  431.   about 90K bytes available, which often is enough. The actual amount
  432.   available will vary slightly depending on the version of DOS.
  433.  
  434. SET TMP=G:\
  435. HSRES /D /1 /A /M /S$(TMP)
  436.   Forces HSRES to swap to disk, using single file swapping, leaving the swap
  437.   file visible, turning off the swap message, and locating the swap file in
  438.   the root directory of drive G (which is presumably a RAM disk).
  439.  
  440. HSRES /K0844 /R$(?Frame:)
  441.   HSRES will activate when <Alt><F10> is pressed, and ask for a frame name.
  442.  
  443. HSRES /U
  444.   Unloads HSRES.
  445.  
  446. HSRES /?
  447.   Displays the HSRES command line options.
  448.  
  449.  
  450. 26   Use - How to use HSRES  
  451.  
  452. ------- Using HSRES ----------------------------------------------------
  453.  
  454. Once HSRES has been installed, just press its hot key. After a short
  455. swapping delay, the screen will clear and HyperShell will appear. When
  456. you want to return, just exit from HyperShell to return to the
  457. interrupted application.
  458.  
  459. If you, after pressing the hot key, keep the config shift key depressed
  460. while HSRES is popping up, it will enter the on-screen configuration
  461. described below.
  462.  
  463.  
  464. HSRES       A Resident Shell For HyperShell                  Page 10
  465.  
  466. If HSRES cannot shell when you request it, it will beep and return to
  467. the current application.
  468.  
  469.  
  470.  
  471. 27   the HSR program - Checking for HSRES
  472.  
  473.  
  474. Popup from the DOS command line is not possible, but you can run the
  475. small HSR program, and then pop up HSRES. When inside HSR, you can write
  476. a word, to be transferred to HSRES as word from text cursor position.
  477.  
  478. You can also use HSR to check, whether HSRES is installed or not, by the
  479. call:
  480.  
  481. HSR ?
  482.  
  483. HSR will return a value which can be tested by the DOS errorlevel.
  484. 0 means HSRES not installed, 1 means HSRES currently installed. See the
  485. enclosed EXAMPLE.BAT for ways to use this feature.
  486.  
  487. Exception: The on-screen configuration can be popped up (by keeping the
  488. config shift key depressed after pressing the hot key combination) even
  489. from the DOS command line.
  490.  
  491.  
  492.  
  493. 28   Configuration - On-screen configuration    
  494.  
  495. ------- Configurating HSRES --------------------------------------------
  496.  
  497. The configuration screen can be entered by writing HSRES /C on the
  498. command line, or by keeping the config shift key depressed while popping
  499. up, until the screen shows up. If you release the key before the screen
  500. emerges, the pop up will continue without configuration.
  501.  
  502. On the configuration screen you can see the current values of the HSRES
  503. options. By pressing the key corresponding to an option you are allowed
  504. to change this option, by switching or by entering a new value.
  505.  
  506. You can define the popup key (option K) by pressing the hotkey
  507. combination, and then confirming by pressing the main key again, without
  508. Alt, Ctrl or Shift keys. If the combination is accepted, you are
  509. prompted to define the config shift key, or to disable popup
  510. configuration.
  511.  
  512. HSRES will show both the hotkey combination and the hexadecimal
  513. representation.
  514.  
  515.  
  516. 29   Exit keys - How to end on-screen configuration
  517.  
  518.  
  519. You can exit by pressing "X" (or "U" for unload).
  520.  
  521. After pressing X, you are prompted to press G og Q to Go on, or Quit.
  522.  
  523. If you chose to go on, one of two things may happen:
  524.  
  525. HSRES       A Resident Shell For HyperShell                  Page 11
  526.  
  527.  
  528. 1. If you entered the screen while popping up, the "Hyper options",
  529.    eg. the /H hyperfile name, will immediately be activated at the next
  530.    popup. The rest of the options, the "swapping options" will, if
  531.    written to the CFG file, be activated after the next HSRES
  532.    installation.
  533.  
  534. 2. If you entered the screen from the command line by HSRES /C, all
  535.    options will be activated in the installation.
  536.  
  537. If you chose to quit, the pop up or installation is terminated.
  538.  
  539. You can use the "G" og "Q" keys as short cuts directly from the
  540. configuration screen.
  541.  
  542.  
  543. 30   unload - How to remove HSRES from memory
  544.  
  545.  
  546. The "U" key is used to unload or avoid installing HSRES, before exiting
  547. on-screen configuration.
  548.  
  549. HSRES will only unload itself, if it is safe to do so. If it is unsafe,
  550. the U option will not be shown on the configuration screen.
  551.  
  552. After a successfull unload, all memory and disk space used by HSRES will
  553. again be free.
  554.  
  555. You can also unload HSRES from memory by typing HSRES /U from the DOS
  556. command line. The unload will succeed only if no TSRs that grab
  557. interrupt vectors have been loaded after HSRES. HSRES will also refuse
  558. to unload if you try to do so from within its own DOS shell.
  559.  
  560.  
  561. 31   HSRES.CFG - Configuration file    
  562.  
  563.  
  564. If you during on-screen configuration press the "W" key, HSRES will
  565. write the current configuration into a file called HSRES.CFG. You are
  566. prompted to specify whether the file shall be written in the directory,
  567. that was current when HSRES was installed, or in the program directory
  568. where HSRES.EXE is found. The CFG file is an Ascii file, containing an
  569. option on each line of the file. You may edit it with any Ascii editor.
  570.  
  571. HSRES allows comments, in the form of lines starting with a ";".
  572.  
  573. When HSRES is called from the command line, it looks first for options
  574. in this file. It is searched, first in the current directory, and, if
  575. not found here, in the HSRES program directory. HSRES validates the
  576. options, and uses them, if they are OK. Options in the HSRES.CFG file
  577. can be overruled by entering options on the command line.
  578.  
  579. If you rename the HSRES.EXE file, the new name will be used for the CFG
  580. file as well.
  581.  
  582.  
  583.  
  584. HSRES       A Resident Shell For HyperShell                  Page 12
  585.  
  586.  
  587. 32   Restrictions - What you can't do  
  588.  
  589. ------- Restrictions ---------------------------------------------------
  590.  
  591. HSRES may not be loaded "high" using such utilities as QEMM, QRAM, or
  592. 386MAX. HSRES requires a large amount of contiguous RAM space that must
  593. immediately follow its kernel in memory.
  594.  
  595. Like any swappable TSR, HSRES should not be loaded before programs or
  596. TSRs that contain hardware interrupt handlers. Examples include network
  597. shells, asynchronous communications programs, and multitasking operating
  598. systems.
  599.  
  600. You may not pop up HSRES when you're at the DOS command line. (This is
  601. not a critical restriction, of course, but it's the first thing that
  602. most people try.) HSRES protects itself against such a request and just
  603. beeps and returns to the command line. The limitation arises because of
  604. the way DOS manages its internal stacks. For related reasons, you may
  605. not shell to DOS while you're at the DEBUG or EDLIN command line.
  606. Similarly, you may not shell to DOS when you're within another TSR that
  607. was popped up at the DOS command line. The techniques HSRES uses to
  608. detect that it was popped up at the command line may be fooled by
  609. multitasking operating systems such as DesqView; use HSRES carefully in
  610. these situations.
  611.  
  612. You may not pop up HSRES from within a program operating in graphics
  613. mode. This is not a limitation of the swappable TSR itself; HSRES simply
  614. doesn't know how to save and restore the state of a graphics screen.
  615.  
  616. Do not install another TSR while within a HSRES shell. The most likely
  617. result will be a system hang when you return from the shell.
  618.  
  619. HSRES must be able to find HS.EXE or HL.EXE in the current directory, or
  620. somewhere on the DOS path.
  621.  
  622. As mentioned above, HSRES can't be used with DOS 2.x.
  623.  
  624.  
  625. 33   PROGRESS - Make any program a resident system.
  626.  
  627.  
  628. Just like HyperShell is made into a resident system by HSRES, you can
  629. make any program resident by using PROGRESS.
  630.  
  631. PROGRESS operates in a way similar to HSRES, but it can be configured to
  632. work with any program, or even with DOS itself.
  633.  
  634. PROGRESS is a shareware program. You can get a shareware or registered
  635. version by contacting the author of HSRES, Werner Knudsen, the author of
  636. HyperShell, Nick Taylor, or any authorized HyperShell agent.
  637.  
  638.  
  639.  
  640. HSRES       A Resident Shell For HyperShell                  Page 13
  641.  
  642.  
  643. 34   Acknowledgments - To whom do I owe thanks
  644.  
  645. ------- Acknowledgments ------------------------------------------------
  646.  
  647. I couldn't have made this program without the features in Turbo Powers
  648. fantastic Object Professional package. Especially their POPDOS example
  649. program was a great help to me.
  650.  
  651. I wouldn't have made this program, if Nick Taylor hadn't written such a
  652. great hypertext system. It just HAD to have a resident option to make
  653. it's possibilities even greater.
  654.  
  655.  
  656. 35   Shareware - The Shareware distribution method
  657.  
  658. HSRES is a Shareware product. Shareware is a distribution method, not a
  659. type of software. With Shareware you get the ultimate money-back
  660. guarantee...if you don't use the product, you don't pay for it.
  661.  
  662. Shareware is not free software. Copyright laws apply to both Shareware
  663. and commercial software, and the copyright holder retains all rights,
  664. with a few specific exceptions as stated in this document. Shareware
  665. authors are accomplished programmers, just like commercial authors, and
  666. the programs are of comparable quality. (In both cases, you will find
  667. good programs and bad ones!) The main difference is in the method of
  668. distribution. The author specifically grants the right to copy and
  669. distribute the SHAREWARE VERSION of the software to anyone as long as no
  670. remuneration is received for the distribution of the software unless
  671. permission is granted in writing by the author.
  672.  
  673. Shareware distribution gives users a chance to try software before
  674. buying it. If you try a Shareware program and continue using it, you are
  675. expected to register the software with the author. With registration,
  676. you will receive the latest version of the software without the
  677. evaluation titles and messages. With shareware you are able to try the
  678. software on your computer with your own set of peripherals, the only way
  679. to know if it will function in your own environment. After deciding that
  680. HSRES is a software product that you will use, then and only then
  681. do you pay for it. The ultimate trust from the author! When you do pay
  682. for the software, you pay only for the software, not for advertisement
  683. for the software which can cost many times what the software actually
  684. costs.
  685.  
  686. 36   License - License Agreement
  687.  
  688.  License Agreement
  689.  ------------------
  690.  
  691.  By installing HSRES on your system, you indicate your agreement to
  692.  the following terms and conditions. If you do not agree to these
  693.  conditions, you should not install and use the HSRES system. HSRES,
  694.  and the accompanying supporting programs and documentation will be
  695.  collectively referred to as HSRES.
  696.  
  697.  Users of HSRES must accept this disclaimer of warranty: "HSRES is
  698.  supplied as is. The author disclaims all warranties, expressed or
  699.  implied, including, without limitation, the warranties of
  700.  
  701. HSRES       A Resident Shell For HyperShell                  Page 14
  702.  
  703.  merchantability and of fitness for any purpose. The author assumes no
  704.  liability for damages, direct or consequential, which may result from
  705.  the use of HSRES."
  706.  
  707.  HSRES is a "shareware program" and is provided at no charge to the
  708.  user for evaluation. Feel free to share the SHAREWARE VERSION with
  709.  your friends, but please do not give it away altered or as part of
  710.  another system. The essence of "user-supported" software is to
  711.  provide personal computer users with quality software without high
  712.  prices, and yet to provide incentive for programmers to continue to
  713.  develop new products. If you find this program useful and find that
  714.  you are using HSRES and continue to use HSRES after a 30 day trial
  715.  period, you must make a registration payment to Werner Knudsen, or
  716.  any authorized agent. The registration fee will license one copy for
  717.  use on any one computer at any one time. You must treat this software
  718.  just like a book. An example is that this software may be used by any
  719.  number of people and may be freely moved from one computer location
  720.  to another, so long as there is no possibility of it being used at
  721.  one location while it's being used at another. Just as a book cannot
  722.  be read by two different persons at the same time.
  723.  
  724.  Commercial users (every user except personal users) of HSRES must
  725.  register and pay for their copies of HSRES within 30 days of first
  726.  use or their license is withdrawn. Site-License arrangements may be
  727.  made by contacting Werner Knudsen, or any authorized agent. Rights to
  728.  distribute HSRES with your own applications may be obtained by
  729.  contacting Werner Knudsen, or any authorized agent.
  730.  
  731.  Anyone distributing HSRES for any kind of remuneration must first
  732.  contact Werner Knudsen at the address on the title page for
  733.  authorization.
  734.  
  735.  You are encouraged to pass the SHAREWARE VERSION of HSRES along to
  736.  your friends for evaluation. Please encourage them to register their
  737.  copy if they find that they can use it. All registered users will, upon
  738.  registration, receive a copy of the latest version of HSRES.
  739.  Distribution of registered copies of HSRES is a violation of copyright
  740.  laws.
  741.  
  742.  
  743. 37   Registration - Registration Fees And What You Get
  744.  
  745.  
  746. To register your copy of HSRES, print the file HSRES.REG, complete this
  747. form, and send along with your registration fee to Werner Knudsen.
  748. Alternatively you can register HSRES on the HyperShell registration
  749. form. You will receive the latest version of the program along with the
  750. latest documentation. The fully registered version of the program
  751. removes all references to evaluation. Registered users will receive
  752. notice of all updates made to the program and these updates will be
  753. supplied to registered users for a nominal charge. Every effort will be
  754. made to supply updates to registered users at the lowest possible cost.
  755.  
  756. The evaluation version of HSRES contains 100% of the capabilities of the
  757. registered version. Those who register HSRES will receive the latest
  758. release of the software and documentation and will receive update offers
  759. in the mail at a minimal cost as they become available.
  760.  
  761.  
  762. HSRES       A Resident Shell For HyperShell                  Page 15
  763.  
  764. The registration fees for HSRES are noted on the registration form.
  765. Prices are subject to to change without notice.
  766.  
  767.  
  768. 38   Software Support - How do you get help?
  769.  
  770.  
  771. If you are a registered user, support for HSRES may be obtained by
  772. writing to Werner Knudsen. The support is chargeable on a time and
  773. materials basis at mutually agreed rates.
  774.  
  775. Bug reports and suggestions for improvements are welcomed from all
  776. users, including unregistered users evaluating the product.
  777.  
  778. All bug reports and problems from registered users will be responded to.
  779. All problems should be posted to the provided address. Full details of
  780. problems should be included, along with any related hyperfile if this
  781. would be of assistance in solving a problem. Bug reports should indicate
  782. the full circumstances of the bug, including the machine type, monitor
  783. type, the version of HSRES and HyperShell, the memory size, the version
  784. of MSDOS (or DRDOS), details of resident programs, and any other
  785. relevant information.
  786.  
  787.  
  788. 39   History - HSRES version history   
  789.  
  790. ------- HSRES Version History ------------------------------------------
  791.  
  792. Version 1.10  14.apr.1991
  793.   Added $-variables in configuration parameters.
  794.  
  795.   Added automatic guess of free bytes needed for popup.
  796.  
  797.   Added support for both HS, HL and HI components. HI is an integrated
  798.   development environment, available from HyperShell version 4.0.
  799.  
  800.   Improved exit from configuration screen. Removed bug when changing
  801.   free bytes at installation time.
  802.  
  803.   Removed possibility of choosing between popping up HyperShell or a DOS
  804.   shell. This can be done much more flexibly by the PROGRESS system
  805.   described above.
  806.  
  807. Version 1.00   26.mar.1991
  808.   First official release. Improved performance, configurability and
  809.   possibilities for unload.
  810.  
  811. Version 0.99   19.mar.1991
  812.   PreRelease, including all significant features
  813.  
  814. HSRES                       INDEX
  815.  
  816. $-variables - Transferring data to HSRES                              7
  817. /1 - Single swap file                                                 4
  818. /A - Visible / hidden swap files                                      5
  819. /C - View or change HSRES configuration                               5
  820. /D - Use Disk when EMS is available                                   5
  821. /F - Free Kbytes for shell                                            5
  822. /H - HyperFile to activate                                            5
  823. /K - Popup HotKey                                                     6
  824. /M - Disable swapping message                                         7
  825. /P - Choose HyperShell program component                              7
  826. /R - HyperFile start frame                                            7
  827. /S - Swap file directory                                              7
  828. /U - Unload HSRES                                                     7
  829. /V - Mouse management code                                            7
  830. Acknowledgments - To whom do I owe thanks                             12
  831. Ask the user for a value - $(?prompt)                                 8
  832. Configuration - On-screen configuration                               10
  833. Default - The default behavior                                        3
  834. Examples - HSRES command line examples                                9
  835. Exit keys - How to end on-screen configuration                        10
  836. HSRES.CFG - Configuration file                                        11
  837. History - HSRES version history                                       15
  838. Installation - How to install HSRES                                   3
  839. License - License Agreement                                           13
  840. Options - Description of command line options                         4
  841. Overview - General information                                        3
  842. PROGRESS - Make any program a resident system.                        12
  843. Registration - Registration Fees And What You Get                     14
  844. Restrictions - What you can't do                                      12
  845. Shareware - The Shareware distribution method                         13
  846. Software Support - How do you get help?                               15
  847. Use - How to use HSRES                                                9
  848. Value of environment variable - $(EnvVar)                             9
  849. Word from text cursor position - $                                    8
  850. Word from x,y screen position - $(x,y)                                8
  851. config shift key - Key to invoke on-screen configuration              6
  852. the HSR program - Checking for HSRES                                  10
  853. the HSRES system - A Resident Shell For HyperShell                    1
  854. unload - How to remove HSRES from memory                              11
  855.