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 / FOR-SUPP.LBR / FOR-SUPP.DZC / FOR-SUPP.DOC
Text File  |  2000-06-30  |  6KB  |  137 lines
  1.                   Instructions for FOR-SUPP.LBR
  2.                             5 Aug 87
  3.                         by Carson Wilson
  4.  
  5.  
  6. 1.  PURPOSE
  7.  
  8.      This collection of files is intended to take file 
  9. descriptions on ZCPR33-based BBS's and personal ZCPR33 systems to 
  10. new heights.  It is the first endeavor I know of to attempt to 
  11. integrate FOR.COM and KFOR.COM with the Z-System.
  12.  
  13.      With phone costs what they are and the need to keep systems 
  14. open to callers, current BBS search utilities need improving.  My 
  15. ultimate hope in creating FORZ.COM, KFORZ.COM, and CLEANFOR.COM 
  16. is to enable SysOps to easily keep FOR descriptions of all files 
  17. online.
  18.  
  19.      Of course, this scenario demands a lot of hard work from 
  20. SysOps.  They must keep an updated FOR listing for all files 
  21. online--no easy task for one with many megabytes of files to 
  22. describe.  There is also the problem of FOR.COM's method of 
  23. filing descriptions.  The FOR file is simply a text file.  While 
  24. this makes for convenient editing with a word processor, access 
  25. time for a very long (say, 100k or so) FOR file may prove 
  26. impractical.
  27.  
  28.      Nonetheless, "Half a loaf is better than none."  FOR- 
  29. SUPP.LBR is my attempt to make FOR as workable as possible.
  30.  
  31.  
  32. 2.  FILES
  33.  
  34.      The library includes source as well as compiled code for the 
  35. following programs:
  36.  
  37. FORZ.COM - 
  38.      A version of Irv Hoff's FOR.COM adapted for use with ZCPR- 
  39.      based systems.  Sets the ZCPR program error flag if a file 
  40.      specified at the command line was not listed, or FOR file 
  41.      not found, and resets the error flag otherwise.  Unlike 
  42.      FOR.COM, can be used with ZCPR's GO command.  Operates 
  43.      quietly if QUIET flag in ZCPR environment set (for use under 
  44.      shells).  Responds to '//' or '/' help commands.
  45.  
  46. KFORZ.COM -
  47.      Similarly adapted version of KFOR.COM.  In its present 
  48.      compiled form, this program works with ZCPR versions 3.3 and 
  49.      above ONLY.  MAIN FEATURE - takes a command line tail of up 
  50.      to 32 characters as the name of the file to be described.  
  51.      This allows automated running from shells such as ZFILER.  
  52.      Loads at 1000 hex so that FORZ.COM can be rerun with GO 
  53.      command even after running KFORZ.COM.
  54.  
  55. CLEANFOR.COM - 
  56.      Turbo Pascal program which removes unmatched references from 
  57.      the FOR file.
  58.  
  59. ZFILER.CMD - 
  60.      Special ZFILER macros for version 1.0F of ZFILER.COM which 
  61.      combine FORZ.COM and KFORZ.COM into an integrated program 
  62.      which can be used to automatically check and add FOR 
  63.      descriptions of files.
  64.  
  65.  
  66. 3.  INSTALLATION
  67.  
  68.      All three programs above can be installed to match the 
  69. particulars  of individual systems.  If you keep your FOR file 
  70. on drive A14: (the default), you needn't install FORZ.COM of 
  71. KFORZ.COM.  Otherwise, using DDT, EDFILE, or ZPATCH, change the 
  72. bytes following the [CONFIG> label at the beginnings of these 
  73. files to match your system.  The values are currently <41> <0E> 
  74. for <'A'> <14d>.
  75.  
  76.      CLEANFOR was written entirely by Carson Wilson in Turbo 
  77. Pascal, and needs to be installed for your terminal by extracting 
  78. CLEANFOR.COM, PDTINS.CHN and PDTINS.DTA to the current drive, 
  79. then typing "CLEANFOR INSTALL" at the command line.  CLEANFOR 
  80. searches through all user ares of a user-installable sequence of 
  81. disk drives.  This list starts just after 2100 hex in 
  82. CLEANFOR.COM, after the label "[DRIVES>."  It begins with a hex 
  83. value from 01 hex to 0F hex, which gives the length of the 
  84. sequence of drives.  This number is immediately followed by a 
  85. list of up to 15 capital letters.  The current sequence is 
  86. 5,'A','B','C','D','E'.
  87.  
  88.      Since CLEANFOR quits as soon as all FOR references have been 
  89. matched, you should specify these letters in order from the drive 
  90. CLEANFOR is most likely to find files matching the FOR listing 
  91. to the drive least likely to contain these files.  Next, install 
  92. CLEANFOR.COM as for FORZ.COM above if you use a non-default 
  93. directory for your FOR file.  The [CONFIG> label in CLEANFOR.COM 
  94. is found at 2100 hex.
  95.  
  96.  
  97. 4.  USAGE
  98.  
  99.      To use the files, place FORZ.COM, KFORZ.COM, and ZFILER.CMD 
  100. along your search path.  You may now use ZFILER to check and add 
  101. FOR descriptions in any directory by pointing to the filename and 
  102. typing ESC-K to add a description (automatically aborts if there 
  103. is already a description) or ESC-W to view a description 
  104. (asks you to add one if none is found).  Because FORZ may be 
  105. rerun with ZCPR's GO command, and KFORZ loads at 1000h under 
  106. ZCPR33, both of these macros run efficiently as "group macros" 
  107. using ZFILER version 1.0F.
  108.  
  109.      CLEANFOR is very cautious about modifying and deleting 
  110. files.  It has a built-in ZCPR-like usage message, and aborts 
  111. safely with error messages if short of disk space or if files are 
  112. missing.  The original FOR file is not modified until an explicit 
  113. command is given to do so; aborting at any previous time will not 
  114. affect this file.  If the user instructs CLEANFOR to modify the 
  115. FOR file, a new file is created containing the modifications and 
  116. the original file is renamed to FOR.BAK.  In addition, CLEANFOR 
  117. gives the user a running account, displaying unmatched FOR 
  118. descriptions as it goes, and listing the names of matched files 
  119. along with the directories they were found on.
  120.  
  121.      When CLEANFOR has finished searching for matches, a summary 
  122. of total, matched, and unmatched entries is displayed before the 
  123. user is asked whether or not to alter the FOR listing.  If all 
  124. entries were matched, CLEANFOR automatically aborts without 
  125. changing any files.
  126.  
  127.  
  128. 5.  COMMENTS
  129.  
  130.      Your comments are greatly appreciated.  Please address any 
  131. suggestions, problems, or comments regarding FOR-SUPP.LBR to:
  132.  
  133.      Carson Wilson
  134.      Lillipute Z-Nodes, Chicago
  135.      312-664-1730 or 312-649-1730
  136.      24 hours, 8-1-No Parity, 300-1200-2400 baud
  137.