home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / CPM / ZCPR33 / A-R / LUSH10.LBR / LUSH10.DZC / LUSH10.DOC
Text File  |  2000-06-30  |  6KB  |  185 lines
  1.  
  2.               L * U * S * H
  3.  
  4.               Library Utility Shell
  5.  
  6.          For ZCPR Versions 3.3 and Above
  7.  
  8.                Version 1.0
  9.  
  10.         01 December 1987 by Carson Wilson
  11.  
  12.  
  13.  
  14.                 Contents
  15.                 --------
  16.  
  17.         1. Description
  18.  
  19.         2. System Requirements
  20.  
  21.         3. Installation
  22.  
  23.         4. Usage
  24.             1. Internal commands
  25.             2. External commands
  26.             3. Parsed commands
  27.             4. Hybrid commands -- KMD and XMODEM
  28.  
  29.         5. Files included
  30.  
  31.         6. Assembly
  32.  
  33.         7. Inquiries
  34.  
  35.  
  36.  
  37. 1.  Description
  38.  
  39. LUSH is a minimal ZCPR shell which takes advantage of the
  40. extended CCP services of ZCPR version 3.3.  This allows both
  41. reduced program size (making for a faster shell) and enhanced
  42. security.  Since ZCPR itself, and not LUSH, parses DU and
  43. directory specifications used by the program, LUSH automatically
  44. adjusts to whatever security levels are present in the current
  45. ZCPR system.  This means that the same program can be used by
  46. both secure and private systems without installation.
  47.  
  48. LUSH contains only three internal commands: LUSH, HELP and DIR.
  49. All other commands are sent to ZCPR as is, with the option of
  50. prepending the current library's drive, user, and name as the
  51. first command parameter.  Therefore, LUSH automatically installs
  52. for library-oriented programs such as LBRE, LPUT, LT, and TYPELZ
  53. which accept library names as the first command line parameter.
  54.  
  55.  
  56. 2.  System Requirements
  57.  
  58. LUSH will only operate on ZCPR systems with a version of 3.3 or
  59. higher.  Further, LUSH requires that the ZCPR system includes a
  60. shell stack with entries of at least 32 bytes each (standard
  61. size), and an external FCB.  If any of these conditions are not
  62. met, LUSH aborts with the appropriate error message.
  63.  
  64.  
  65. 3.  Installation
  66.  
  67. No installation is necessary.
  68.  
  69.  
  70. 4.  Usage
  71.  
  72. 4.1  Internal commands
  73.  
  74. LUSH operates in several modes.  Simplest is the internal command
  75. mode.  If the commands HELP, ?, DIR, or LUSH are used at LUSH's
  76. command prompt, they call up procedures built into LUSH itself.
  77. These commands work as follows:
  78.  
  79. Command             Result
  80. -------             ------
  81. >HELP or ?. . . . . . . . . . . Display help screen
  82. >DIR [afn]. . . . . . . . . . . Display this library's directory
  83. >LUSH [du:|dir:]ufn[.LBR] . . . Attach to another library file
  84.  
  85.  
  86. 4.2  External commands
  87.  
  88. The second type of LUSH command begins with a leading space, and
  89. instructs LUSH to send the command verbatim to ZCPR.  Thus:
  90.  
  91. Command             Result
  92. -------             ------
  93. > command [parameters]. . . . . command [parameters]
  94.  
  95. When ZCPR has completed processing the command, ZCPR reloads LUSH
  96. using the program name, ZCPR directory, and library name LUSH was
  97. originally invoked with.
  98.  
  99.  
  100. 4.3  Parsed commands
  101.  
  102. The third type of LUSH command begins without a leading space.
  103. This is where LUSH performs its most important function--that of
  104. parsing the drive, user, and name of the current library file as
  105. the first parameter of any ZCPR command line.  This allows LUSH
  106. to work as a "front end" for the various library utilities which
  107. accept the first command line parameter as a designation of the
  108. library file on which to operate.  Thus, if LUSH were attached to
  109. LUSH10.LBR at directory B0:,
  110.  
  111. Command             Result
  112. -------             ------
  113. >command [parameters] . . . . . command B0:LUSH10.LBR [parameters]
  114.  
  115. Again, when ZCPR has completed processing the command, ZCPR
  116. reloads LUSH using the program name, ZCPR directory, and library
  117. name LUSH was originally invoked with.
  118.  
  119.  
  120. 4.4  Hybrid commands -- KMD and XMODEM
  121.  
  122. The fourth and final type of LUSH command is a hybrid between
  123. internal and external commands.  If the KMD or XMODEM commands
  124. are given _without_ a leading space, LUSH parses them as follows:
  125.  
  126. Command             Result
  127. -------             ------
  128.  
  129. >KMD|XMODEM S[K] ufn. . . . . . Send a member of this library
  130.  
  131. Thus, if LUSH were attached to LUSH10.LBR at directory B0:, and
  132. the command was "KMD SK THIS.FIL", LUSH would send the command
  133. "KMD LK B0:LUSH10.LBR THIS.FIL" to ZCPR.
  134.  
  135. KMD and XMODEM are external commands in the sense that no command
  136. processing is done by LUSH--it merely sends a command line to
  137. ZCPR.  But they are internal commands in the sense that they are
  138. dedicated commands.  Only the commands "KMD" and "XMODEM" will be
  139. parsed with L or LK as the first parameter, and only "KMD" or
  140. "XMODEM" will be sent as the command name to ZCPR.  Therefore,
  141. for use with RCPM systems, a program with the exact name XMODEM
  142. or KMD must be available for sending files.
  143.  
  144.  
  145. 5.  Files included
  146.  
  147. Files included in LUSH10.LBR are as follows:
  148.  
  149. LUSH10.DOC    This file
  150. LUSH10.FOR    Short description
  151. LUSH.Z80    Program source code
  152. LUSH.COM    Object code which loads at 100 hex
  153. LUSH8000.COM    Object code which loads at 8000 hex
  154. SLUDIR11.REL    Correction to SYSLIB's SLUDIR module
  155.  
  156. LUSH.COM loads at 100 hex, allowing ZCPR's GO command to be used
  157. with LUSH.COM.    LUSH8000.COM loads at 8000 hex, allowing the GO
  158. command to be used on other programs from within LUSH8000.COM.
  159.  
  160.  
  161. 6.  Assembly
  162.  
  163. LUSH was assembled using Z80ASM.COM and SLRNK.COM by SLR Systems,
  164. the latest versions of the ZCPR Z33LIB, Z3LIB, and SYSLIB
  165. linkable libraries, and SLUDIR11.REL, which supercedes the SYSLIB
  166. module SLUDIR.
  167.  
  168. To test modifications to LUSH.COM, comment out the ".dseg"
  169. pseudo-op near the end of the file, and remove the semicolon from
  170. the ".request" comment at the beginning of the code and link the
  171. file as one absolute segment.  When through testing, return these
  172. to the original state and link using code and data segments for
  173. smallest code size.
  174.  
  175.  
  176. 7.  Inquiries
  177.  
  178. Please address any comments or inquiries regarding LUSH10.LBR to:
  179.  
  180.               Carson Wilson
  181.          Lillipute Z-Nodes, Chicago, IL
  182.       24 hours - 300/1200/2400 baud - 8/1/No parity
  183.           312-664-1730 and 312-649-1730
  184.  
  185.