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 / ENTERPRS / CPM / UTILS / S / ZCPC02.ARK / HLPFILES.LBR / LBRHLP22.HZP / LBRHLP22.HLP
Text File  |  1992-10-03  |  13KB  |  298 lines
  1. ;
  2.                                   LBRHLP 
  3.                                 Version 2.2
  4.  
  5.                                May 10, 1992
  6.  
  7.  
  8. LBRHLP is a ZCPR3 utility to display Z-System help files.  The targeted 
  9. help files can be members of libraries or stand-alone, compressed or not.  
  10. Two versions of LBRHLP are supplied:  LHC handles GEL crunched files and 
  11. LHQ handles squeezed files.  Either version will handle uncompressed files.
  12.  
  13.  
  14.  
  15.            U  Usage                         E  Errors
  16.            D  Display Details               C  Configuration
  17.            S  Security                      H  History
  18. :U
  19.  
  20.                                    USAGE 
  21.  
  22.  
  23.      LBRHLP {-{dir:}library} {{dir:}hlpfile}
  24.  
  25.  
  26. If no DIR or DU specification is given, the current drive and user are 
  27. assumed.  If a library name is given, a leading hyphen ("-") is required.  
  28. If only the name of a help file is given, and that name is preceded by a 
  29. directory specification, LBRHLP searches for a matching stand-alone help 
  30. file.  The directory specification may be in the form D:, U:, DU:, DIR:, or 
  31. a colon alone for the current directory.
  32.  
  33. The library name and the help file name default to internally configured 
  34. names.  The default filetype for help files is H?P.  If a matching file or 
  35. library is not found in the given or current directory, the configured 
  36. alternate named directory will also be searched.  If no named directory 
  37. with that name is found, the configured alternate drive/user will be 
  38. searched.
  39.  
  40. USAGE (continued):
  41.  
  42. Access to stand-alone files can be simplified by use of a simple ARUNZ 
  43. alias:
  44.  
  45.      HLP  lbrhlp $td1$tu1:$tf1
  46.  
  47. Via this alias, no directory specification is needed if the help file is in 
  48. the current directory.  Just "HLP filename" will do it.
  49.  
  50. For easy access to the usage screen, the alias could be expanded:
  51.  
  52.      HLP  if nu $1;lbrhlp //;else;if eq $1 //;lbrhlp //
  53.                ;else;libhlp $td1$tu1:$tf1;fi;fi
  54.  
  55. With this alias, "HLP" with no command line parameters bypasses the 
  56. internal file and directory defaults of LBRHLP.
  57. :D
  58.  
  59.                               DISPLAY DETAILS 
  60.  
  61.                            HELP System Commands 
  62.  
  63. From a menu, pressing a letter or number will take you to the appropriate 
  64. information section.
  65.  
  66.     CR    Display next information screen.  Also returns to the menu from 
  67.           the end of an information section.
  68.    Space  Next screen (same as CR).
  69.      L    Return to previous information screen.
  70.      S    Return to start of current information section.
  71.      M    Return to previous menu.
  72.      ,    Return to menu for previous level.
  73.      ^    Return to previous level (same as ",").
  74.      .    Return to root (main) menu (level 0).
  75.      P    Send current screen to printer.
  76.     ^P    Send current information section to printer.
  77.     ESC   Exit HELP system.
  78.     ^C    Exit (same as ESC).
  79.  
  80. DISPLAY DETAILS (continued):
  81.  
  82.                             Navigation Markers 
  83.  
  84. The current level in the HELP system hierarchy is displayed in the lower- 
  85. left corner of the screen (except at the root level, level 0).  While in 
  86. information sections, the current screen number is also displayed.
  87.  
  88. For example:
  89.  
  90.       1:       Screen 1 of level 0 information section.
  91.  
  92.    Level 2     Level 2 menu screen.
  93.  
  94.    Level 1/2   Screen 2 of a level 1 information section.
  95.  
  96. The last screen of an information section will have the initials "EOI" (end 
  97. of information) immediately preceding the level and screen numbers.
  98. :S
  99.  
  100.                                  SECURITY 
  101.  
  102. For remote access systems, security is assured by using the directory 
  103. specification as parsed by the command processor, or the internally 
  104. configured alternate directory.
  105.  
  106. In addition, the printer cannot be accessed unless the wheel byte is set.  
  107. Non-wheels do not even see the "P" option displayed.
  108. :E
  109.  
  110.                                   ERRORS 
  111.  
  112. The ZCPR3 program error flag is set to FFh for most errors, including the 
  113. following:
  114.  
  115.      File not found.
  116.      Ambiguous filename.
  117.      Help file level limit (25) reached.
  118.      Memory overflow (help file too large).*
  119.      Unsupported filetype (middle character not "L", "Z", or "Q").
  120.      Uncrunch errors, such as invalid crunched file (LHC only).
  121.      Unsqueeze errors, such as unexpected end-of-file (LHQ only).
  122.  
  123. *LBRHLP can handle larger files if they are already uncompressed.
  124. :C
  125.  
  126.                                CONFIGURATION 
  127.  
  128. Several configuration options are available:
  129.  
  130.      Alternate named directory to search (as distributed: HELP)
  131.      Alternate drive and user to search (as distributed: A15)
  132.      Default library name (as distributed: HLPFILES)
  133.      Default help file name (as distributed: MENU)
  134.      Library filetype (as distributed: LBR)
  135.      Help file filetype (as distributed: H?P)
  136.      Check BIOS for "printer ready" before accessing printer
  137.  
  138. Configuration changes are made with ZCNFG and the accompanying LBRHLPnn.CFG 
  139. file.  If the name of the configuration file is not changed, ZCNFG will 
  140. always be able to find it, even if the names LHC or LHQ are changed to 
  141. something else, such as HELP or LBRHLP.  Full explanations for the various 
  142. configuration options are available on the ZCNFG help screens.
  143. :H
  144.  
  145.                                   HISTORY 
  146.  
  147. Version: 2.2 (05/10/92 by Gene Pizzetta)
  148.      My main gripe about the HELP interface was that two hands were 
  149.      required to exit (^C) and to go up a level (^).  These commands still 
  150.      work, but I have added alternates: ESC to exit and a comma to go up a 
  151.      level.  I thought the comma was a logical choice, since the period is 
  152.      used to go to the root level.  To ease maintenance I have consolidated 
  153.      into the main module all the library routines except the decompression 
  154.      modules, which are conditionally loaded and have been renamed LH- 
  155.      UNCR.LIB and LH-UNSQ.LIB.  The consolidated main module has been 
  156.      renamed LBRHLPnn.Z80.  The environment address is now set to 00h, 
  157.      which might be important when dropping out of NZCOM.  I also replaced 
  158.      the PRTNAME routine with the smaller and more reliable GCOMNAM routine 
  159.      from ZSLIB.  The method of decompression the program uses is now 
  160.      identified on the usage screen, which was heavily modified to save a 
  161.      few bytes.  As a result, LHC is (barely) under 5K.  Video highlighting 
  162.      added to CFG file.
  163.  
  164. Version: 2.1 (02/21/92 by Bruce Morgen)
  165.      Major update that allows LBRHLP to access stand-alone help files if no 
  166.      library is specified and a directory specification is prepended to the 
  167.      helpfile name.  VLIB references have been deleted in favor of shorter 
  168.      ZSLIB calls and although the program is slightly larger its buffer 
  169.      address is the same as v2.0 -- in other words, any crunched help file 
  170.      that the previous LHC.COM could use can be read by the new one. 
  171.      Production has been simplified: it is no longer necessary to specify 
  172.      the buffer address at assembly time due to modifications made to the 
  173.      uncrunch and unsqueeze code (LBRHLP5.LIB/LBRHLP6.LIB). With minimal 
  174.      ALIAS/ARUNZ support, LBRHLP can now replace HELPC and HELP5x as well 
  175.      as LHELP.  Howard Goldstein provided extensive coaching and did a 
  176.      final bug-squishing/display-refining code tune-up as well as revising 
  177.      the .CFG file.  As usual, Howard's assistance was invaluable and very 
  178.      much appreciated.
  179.  
  180. Version: 2.0 (09/16/91 by Howard Goldstein)
  181.      Modified the clear screen routine to print a CRLF if the CLS function 
  182.      is not available, e.g., no TCAP loaded.  Thanks to Al Hawley for 
  183.      suggesting this change.  Made CIN routine public.
  184.  
  185. Version: 1.9 (08/07/91 by Howard Goldstein)
  186.      Fixed a navigation problem discovered by Gene Pizzetta.  The M command 
  187.      would not return to the menu if the menu was in a higher level file.  
  188.      Also added code to cause the program to exit if not running under Z- 
  189.      System and fixed a potential problem in the unsqueeze routine.
  190.  
  191. Version: 1.8 (02/20/91 by Terry Hazen)
  192.      Added printer-ready test and configuration byte so it can be turned 
  193.      off using ZCNFG.  Added .request line for libraries.
  194.  
  195. Version: 1.7 (02/08/91 by Howard Goldstein)
  196.      Modified file loading routines to clear the high bit on all 
  197.      characters.  This enables LBRHLP to work correctly with files created 
  198.      in Wordstar Document Mode.  Added wheel byte control of print options. 
  199.      Made a few changes to the built-in help message.  The two COM files in 
  200.      this LBR can be configured using ZCNFG and THE CFG file which is also 
  201.      contained here.
  202.  
  203. Version: 1.6 (08/27/90 by Howard Goldstein)
  204.      Fixed an initialization problem in the uncrunch routine.  This problem 
  205.      didn't manifest itself very often, but when it did the results were 
  206.      strange indeed!  Thanks to Carson Wilson for bringing it to my 
  207.      attention.  This version was linked with the latest test version of 
  208.      the libraries, 4.3.
  209.  
  210. Version: 1.5 (06/20/90 by Howard Goldstein)
  211.      Fixed a problem that caused the program to search the wrong drive for 
  212.      the help library under certain conditions.
  213.  
  214. Version: 1.4 (06/18/90 by Howard Goldstein)
  215.      Improved buffer allocation.  Uncrunched files in libraries may now be 
  216.      24k larger than previously.  (If a crunched file is too large for the 
  217.      program, put it in the LBR uncrunched.) A colon, (:), is no longer 
  218.      dispayed at the beginning of each info section in help-inexed files.  
  219.      Terminal de-init routine now called on program exit.  Print routines 
  220.      improved:  tabs expanded; stack bug fixed.  Screen-full logic 
  221.      improved.  Can now handle one more line per screen.  Lines per screen 
  222.      and lines per page now obtained from environment.  Built-in usage 
  223.      message reflects patchable values for file names, etc.  Linked with 
  224.      latest versions of libraries.
  225.  
  226. Version: 1.3 (02-13-88)
  227.      Fixed a CtrlC bug, still sets error flag on errors and resets error 
  228.      flag when you type ctrlc.
  229.  
  230. Version: 1.2 (02-10-88)
  231.      Renamed file to LHC (the 'C' stands for cruncehed files).  Fixed a bug 
  232.      that was introduced in ver 1.1 also created a file that will unsqueeze 
  233.      library files, (this is similar to lhelp), but has more versatility.  
  234.      The name is LHQ.COM (the 'Q' stands for squeezed files).
  235.  
  236.      I will be soon releasing a new help file one that handles crunched 
  237.      files, this will be based on HELP53.
  238.  
  239. Version: 1.1
  240.      Program now sets the error flag on most errors, so that a different 
  241.      program can be called.
  242.  
  243. Version: 1.0
  244. Program: LBRHLP
  245. Author:  Bob Peddicord
  246. Date:    02-06-88
  247.  
  248. This program derives from the use of Help53 by R. Conn.  I also want to 
  249. thank Steve Greenburg for his uncrunch routines.
  250.  
  251. I along with alot of other people have been tired of not being able to use 
  252. crunched files in help library's.
  253.  
  254. Lbrhlp can only be used with crunched files (sorry no squeezed) this is due 
  255. to trying to keep the code size down, uncrunch uses 22k of buffer space. 
  256. This leaves about 25k+ for files, so there are a few help files that cannot 
  257. be used with this program.  The only way that I can figure to use bigger 
  258. files with this would be to write the file to disk and then read it back 
  259. in. This in itself, in my opinion would be to time consuming, and would not 
  260. be good for Remote Bulletin Boards.
  261.  
  262. The default LBR name is HLPFILES
  263. The default DIR name is HELP
  264. The default DU is A15
  265. The default filename is MENU
  266.  
  267. These  can  be  changed with Zpatch, patch  or  some  other  file editor.
  268.  
  269. The Locations are:
  270. DIR - 116h (HELP)
  271. DU  - 11Eh (disk) 0=A, 1=B etc.
  272. DU  - 11Fh (user)
  273. FILE  120h (MENU)
  274. LBR - 128h (HLPFILES)
  275.  
  276. The program allows you to specify a different Library and or help file from 
  277. the command line.
  278.  
  279. Example 1:
  280.      lbrhlp -c15:special syslib
  281. With this example we told the program that we wanted a different library on 
  282. c15 and a help file called syslib.  The (-) must precede the drive/user or 
  283. library name, if the default D/U is wanted.
  284.  
  285. Example 2:
  286.      lbrhlp syslib
  287. With this we told the program that we wanted the default LBR with the 
  288. filename syslib.
  289.  
  290. Example 3:
  291.      lbrhlp -helps
  292. With this we are specifing just the library, using the default DU/DIR and 
  293. default filename.
  294.  
  295. Any and all comments and or suggestions would be appreciated.  Please leave 
  296. them on my system ZNODE #60 or Z-CENTRAL or LILLIPUTE #1 for I call them a 
  297. couple of times a month.
  298.