home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
CBM Funet Archive
/
cbm-funet-archive-2003.iso
/
cpm
/
zutils
/
lbrhlp22.lbr
/
LBRHLP22.HZP
/
LBRHLP22.HLP
Wrap
Text File
|
1992-05-09
|
13KB
|
298 lines
;
lbrhlp
vERSION 2.2
mAY 10, 1992
lbrhlp IS A zcpr3 UTILITY TO DISPLAY z-sYSTEM HELP FILES. tHE TARGETED
HELP FILES CAN BE MEMBERS OF LIBRARIES OR STAND-ALONE, COMPRESSED OR NOT.
tWO VERSIONS OF lbrhlp ARE SUPPLIED: lhc HANDLES gel CRUNCHED FILES AND
lhq HANDLES SQUEEZED FILES. eITHER VERSION WILL HANDLE UNCOMPRESSED FILES.
u uSAGE e eRRORS
d dISPLAY dETAILS c cONFIGURATION
s sECURITY h hISTORY
:u
usage
lbrhlp {$7b}-{$7b}DIR:{$7d}LIBRARY{$7d} {$7b}{$7b}DIR:{$7d}HLPFILE{$7d}
iF NO dir OR du SPECIFICATION IS GIVEN, THE CURRENT DRIVE AND USER ARE
ASSUMED. iF A LIBRARY NAME IS GIVEN, A LEADING HYPHEN ("-") IS REQUIRED.
iF ONLY THE NAME OF A HELP FILE IS GIVEN, AND THAT NAME IS PRECEDED BY A
DIRECTORY SPECIFICATION, lbrhlp SEARCHES FOR A MATCHING STAND-ALONE HELP
FILE. tHE DIRECTORY SPECIFICATION MAY BE IN THE FORM d:, u:, du:, dir:, OR
A COLON ALONE FOR THE CURRENT DIRECTORY.
tHE LIBRARY NAME AND THE HELP FILE NAME DEFAULT TO INTERNALLY CONFIGURED
NAMES. tHE DEFAULT FILETYPE FOR HELP FILES IS h?p. iF A MATCHING FILE OR
LIBRARY IS NOT FOUND IN THE GIVEN OR CURRENT DIRECTORY, THE CONFIGURED
ALTERNATE NAMED DIRECTORY WILL ALSO BE SEARCHED. iF NO NAMED DIRECTORY
WITH THAT NAME IS FOUND, THE CONFIGURED ALTERNATE DRIVE/USER WILL BE
SEARCHED.
usage (CONTINUED):
aCCESS TO STAND-ALONE FILES CAN BE SIMPLIFIED BY USE OF A SIMPLE arunz
ALIAS:
hlp LBRHLP $TD1$TU1:$TF1
vIA THIS ALIAS, NO DIRECTORY SPECIFICATION IS NEEDED IF THE HELP FILE IS IN
THE CURRENT DIRECTORY. jUST "hlp FILENAME" WILL DO IT.
fOR EASY ACCESS TO THE USAGE SCREEN, THE ALIAS COULD BE EXPANDED:
hlp IF NU $1;LBRHLP //;ELSE;IF EQ $1 //;LBRHLP //
;ELSE;LIBHLP $TD1$TU1:$TF1;FI;FI
wITH THIS ALIAS, "hlp" WITH NO COMMAND LINE PARAMETERS BYPASSES THE
INTERNAL FILE AND DIRECTORY DEFAULTS OF lbrhlp.
:d
display details
help sYSTEM cOMMANDS
fROM A MENU, PRESSING A LETTER OR NUMBER WILL TAKE YOU TO THE APPROPRIATE
INFORMATION SECTION.
cr dISPLAY NEXT INFORMATION SCREEN. aLSO RETURNS TO THE MENU FROM
THE END OF AN INFORMATION SECTION.
sPACE nEXT SCREEN (SAME AS cr).
l rETURN TO PREVIOUS INFORMATION SCREEN.
s rETURN TO START OF CURRENT INFORMATION SECTION.
m rETURN TO PREVIOUS MENU.
, rETURN TO MENU FOR PREVIOUS LEVEL.
^ rETURN TO PREVIOUS LEVEL (SAME AS ",").
. rETURN TO ROOT (MAIN) MENU (LEVEL 0).
p sEND CURRENT SCREEN TO PRINTER.
^p sEND CURRENT INFORMATION SECTION TO PRINTER.
esc eXIT help SYSTEM.
^c eXIT (SAME AS esc).
display details (CONTINUED):
nAVIGATION mARKERS
tHE CURRENT LEVEL IN THE help SYSTEM HIERARCHY IS DISPLAYED IN THE LOWER-
LEFT CORNER OF THE SCREEN (EXCEPT AT THE ROOT LEVEL, LEVEL 0). wHILE IN
INFORMATION SECTIONS, THE CURRENT SCREEN NUMBER IS ALSO DISPLAYED.
fOR EXAMPLE:
1: sCREEN 1 OF LEVEL 0 INFORMATION SECTION.
lEVEL 2 lEVEL 2 MENU SCREEN.
lEVEL 1/2 sCREEN 2 OF A LEVEL 1 INFORMATION SECTION.
tHE LAST SCREEN OF AN INFORMATION SECTION WILL HAVE THE INITIALS "eoi" (END
OF INFORMATION) IMMEDIATELY PRECEDING THE LEVEL AND SCREEN NUMBERS.
:s
security
fOR REMOTE ACCESS SYSTEMS, SECURITY IS ASSURED BY USING THE DIRECTORY
SPECIFICATION AS PARSED BY THE COMMAND PROCESSOR, OR THE INTERNALLY
CONFIGURED ALTERNATE DIRECTORY.
iN ADDITION, THE PRINTER CANNOT BE ACCESSED UNLESS THE WHEEL BYTE IS SET.
nON-WHEELS DO NOT EVEN SEE THE "p" OPTION DISPLAYED.
:e
errors
tHE zcpr3 PROGRAM ERROR FLAG IS SET TO ffH FOR MOST ERRORS, INCLUDING THE
FOLLOWING:
fILE NOT FOUND.
aMBIGUOUS FILENAME.
hELP FILE LEVEL LIMIT (25) REACHED.
mEMORY OVERFLOW (HELP FILE TOO LARGE).*
uNSUPPORTED FILETYPE (MIDDLE CHARACTER NOT "l", "z", OR "q").
uNCRUNCH ERRORS, SUCH AS INVALID CRUNCHED FILE (lhc ONLY).
uNSQUEEZE ERRORS, SUCH AS UNEXPECTED END-OF-FILE (lhq ONLY).
*lbrhlp CAN HANDLE LARGER FILES IF THEY ARE ALREADY UNCOMPRESSED.
:c
configuration
sEVERAL CONFIGURATION OPTIONS ARE AVAILABLE:
aLTERNATE NAMED DIRECTORY TO SEARCH (AS DISTRIBUTED: help)
aLTERNATE DRIVE AND USER TO SEARCH (AS DISTRIBUTED: a15)
dEFAULT LIBRARY NAME (AS DISTRIBUTED: hlpfiles)
dEFAULT HELP FILE NAME (AS DISTRIBUTED: menu)
lIBRARY FILETYPE (AS DISTRIBUTED: lbr)
hELP FILE FILETYPE (AS DISTRIBUTED: h?p)
cHECK bios FOR "PRINTER READY" BEFORE ACCESSING PRINTER
cONFIGURATION CHANGES ARE MADE WITH zcnfg AND THE ACCOMPANYING lbrhlpNN.cfg
FILE. iF THE NAME OF THE CONFIGURATION FILE IS NOT CHANGED, zcnfg WILL
ALWAYS BE ABLE TO FIND IT, EVEN IF THE NAMES lhc OR lhq ARE CHANGED TO
SOMETHING ELSE, SUCH AS help OR lbrhlp. fULL EXPLANATIONS FOR THE VARIOUS
CONFIGURATION OPTIONS ARE AVAILABLE ON THE zcnfg HELP SCREENS.
:h
history
vERSION: 2.2 (05/10/92 BY gENE pIZZETTA)
mY MAIN GRIPE ABOUT THE help INTERFACE WAS THAT TWO HANDS WERE
REQUIRED TO EXIT (^c) AND TO GO UP A LEVEL (^). tHESE COMMANDS STILL
WORK, BUT i HAVE ADDED ALTERNATES: esc TO EXIT AND A COMMA TO GO UP A
LEVEL. i THOUGHT THE COMMA WAS A LOGICAL CHOICE, SINCE THE PERIOD IS
USED TO GO TO THE ROOT LEVEL. tO EASE MAINTENANCE i HAVE CONSOLIDATED
INTO THE MAIN MODULE ALL THE LIBRARY ROUTINES EXCEPT THE DECOMPRESSION
MODULES, WHICH ARE CONDITIONALLY LOADED AND HAVE BEEN RENAMED lh-
uncr.lib AND lh-unsq.lib. tHE CONSOLIDATED MAIN MODULE HAS BEEN
RENAMED lbrhlpNN.z80. tHE ENVIRONMENT ADDRESS IS NOW SET TO 00H,
WHICH MIGHT BE IMPORTANT WHEN DROPPING OUT OF nzcom. i ALSO REPLACED
THE prtname ROUTINE WITH THE SMALLER AND MORE RELIABLE gcomnam ROUTINE
FROM zslib. tHE METHOD OF DECOMPRESSION THE PROGRAM USES IS NOW
IDENTIFIED ON THE USAGE SCREEN, WHICH WAS HEAVILY MODIFIED TO SAVE A
FEW BYTES. aS A RESULT, lhc IS (BARELY) UNDER 5k. vIDEO HIGHLIGHTING
ADDED TO cfg FILE.
vERSION: 2.1 (02/21/92 BY bRUCE mORGEN)
mAJOR UPDATE THAT ALLOWS lbrhlp TO ACCESS STAND-ALONE HELP FILES IF NO
LIBRARY IS SPECIFIED AND A DIRECTORY SPECIFICATION IS PREPENDED TO THE
HELPFILE NAME. vlib REFERENCES HAVE BEEN DELETED IN FAVOR OF SHORTER
zslib CALLS AND ALTHOUGH THE PROGRAM IS SLIGHTLY LARGER ITS BUFFER
ADDRESS IS THE SAME AS V2.0 -- IN OTHER WORDS, ANY CRUNCHED HELP FILE
THAT THE PREVIOUS lhc.com COULD USE CAN BE READ BY THE NEW ONE.
pRODUCTION HAS BEEN SIMPLIFIED: IT IS NO LONGER NECESSARY TO SPECIFY
THE BUFFER ADDRESS AT ASSEMBLY TIME DUE TO MODIFICATIONS MADE TO THE
UNCRUNCH AND UNSQUEEZE CODE (lbrhlp5.lib/lbrhlp6.lib). wITH MINIMAL
alias/arunz SUPPORT, lbrhlp CAN NOW REPLACE helpc AND help5X AS WELL
AS lhelp. hOWARD gOLDSTEIN PROVIDED EXTENSIVE COACHING AND DID A
FINAL BUG-SQUISHING/DISPLAY-REFINING CODE TUNE-UP AS WELL AS REVISING
THE .cfg FILE. aS USUAL, hOWARD'S ASSISTANCE WAS INVALUABLE AND VERY
MUCH APPRECIATED.
vERSION: 2.0 (09/16/91 BY hOWARD gOLDSTEIN)
mODIFIED THE CLEAR SCREEN ROUTINE TO PRINT A crlf IF THE cls FUNCTION
IS NOT AVAILABLE, E.G., NO tcap LOADED. tHANKS TO aL hAWLEY FOR
SUGGESTING THIS CHANGE. mADE cin ROUTINE PUBLIC.
vERSION: 1.9 (08/07/91 BY hOWARD gOLDSTEIN)
fIXED A NAVIGATION PROBLEM DISCOVERED BY gENE pIZZETTA. tHE m COMMAND
WOULD NOT RETURN TO THE MENU IF THE MENU WAS IN A HIGHER LEVEL FILE.
aLSO ADDED CODE TO CAUSE THE PROGRAM TO EXIT IF NOT RUNNING UNDER z-
sYSTEM AND FIXED A POTENTIAL PROBLEM IN THE UNSQUEEZE ROUTINE.
vERSION: 1.8 (02/20/91 BY tERRY hAZEN)
aDDED PRINTER-READY TEST AND CONFIGURATION BYTE SO IT CAN BE TURNED
OFF USING zcnfg. aDDED .REQUEST LINE FOR LIBRARIES.
vERSION: 1.7 (02/08/91 BY hOWARD gOLDSTEIN)
mODIFIED FILE LOADING ROUTINES TO CLEAR THE HIGH BIT ON ALL
CHARACTERS. tHIS ENABLES lbrhlp TO WORK CORRECTLY WITH FILES CREATED
IN wORDSTAR dOCUMENT mODE. aDDED WHEEL BYTE CONTROL OF PRINT OPTIONS.
mADE A FEW CHANGES TO THE BUILT-IN HELP MESSAGE. tHE TWO com FILES IN
THIS lbr CAN BE CONFIGURED USING zcnfg AND the cfg FILE WHICH IS ALSO
CONTAINED HERE.
vERSION: 1.6 (08/27/90 BY hOWARD gOLDSTEIN)
fIXED AN INITIALIZATION PROBLEM IN THE UNCRUNCH ROUTINE. tHIS PROBLEM
DIDN'T MANIFEST ITSELF VERY OFTEN, BUT WHEN IT DID THE RESULTS WERE
STRANGE INDEED! tHANKS TO cARSON wILSON FOR BRINGING IT TO MY
ATTENTION. tHIS VERSION WAS LINKED WITH THE LATEST TEST VERSION OF
THE LIBRARIES, 4.3.
vERSION: 1.5 (06/20/90 BY hOWARD gOLDSTEIN)
fIXED A PROBLEM THAT CAUSED THE PROGRAM TO SEARCH THE WRONG DRIVE FOR
THE HELP LIBRARY UNDER CERTAIN CONDITIONS.
vERSION: 1.4 (06/18/90 BY hOWARD gOLDSTEIN)
iMPROVED BUFFER ALLOCATION. uNCRUNCHED FILES IN LIBRARIES MAY NOW BE
24K LARGER THAN PREVIOUSLY. (iF A CRUNCHED FILE IS TOO LARGE FOR THE
PROGRAM, PUT IT IN THE lbr UNCRUNCHED.) a COLON, (:), IS NO LONGER
DISPAYED AT THE BEGINNING OF EACH INFO SECTION IN HELP-INEXED FILES.
tERMINAL DE-INIT ROUTINE NOW CALLED ON PROGRAM EXIT. pRINT ROUTINES
IMPROVED: TABS EXPANDED; STACK BUG FIXED. sCREEN-FULL LOGIC
IMPROVED. cAN NOW HANDLE ONE MORE LINE PER SCREEN. lINES PER SCREEN
AND LINES PER PAGE NOW OBTAINED FROM ENVIRONMENT. bUILT-IN USAGE
MESSAGE REFLECTS PATCHABLE VALUES FOR FILE NAMES, ETC. lINKED WITH
LATEST VERSIONS OF LIBRARIES.
vERSION: 1.3 (02-13-88)
fIXED A cTRLc BUG, STILL SETS ERROR FLAG ON ERRORS AND RESETS ERROR
FLAG WHEN YOU TYPE CTRLC.
vERSION: 1.2 (02-10-88)
rENAMED FILE TO lhc (THE 'c' STANDS FOR CRUNCEHED FILES). fIXED A BUG
THAT WAS INTRODUCED IN VER 1.1 ALSO CREATED A FILE THAT WILL UNSQUEEZE
LIBRARY FILES, (THIS IS SIMILAR TO LHELP), BUT HAS MORE VERSATILITY.
tHE NAME IS lhq.com (THE 'q' STANDS FOR SQUEEZED FILES).
i WILL BE SOON RELEASING A NEW HELP FILE ONE THAT HANDLES CRUNCHED
FILES, THIS WILL BE BASED ON help53.
vERSION: 1.1
pROGRAM NOW SETS THE ERROR FLAG ON MOST ERRORS, SO THAT A DIFFERENT
PROGRAM CAN BE CALLED.
vERSION: 1.0
pROGRAM: lbrhlp
aUTHOR: bOB pEDDICORD
dATE: 02-06-88
tHIS PROGRAM DERIVES FROM THE USE OF hELP53 BY r. cONN. i ALSO WANT TO
THANK sTEVE gREENBURG FOR HIS UNCRUNCH ROUTINES.
i ALONG WITH ALOT OF OTHER PEOPLE HAVE BEEN TIRED OF NOT BEING ABLE TO USE
CRUNCHED FILES IN HELP LIBRARY'S.
lBRHLP CAN ONLY BE USED WITH CRUNCHED FILES (SORRY NO SQUEEZED) THIS IS DUE
TO TRYING TO KEEP THE CODE SIZE DOWN, UNCRUNCH USES 22K OF BUFFER SPACE.
tHIS LEAVES ABOUT 25K+ FOR FILES, SO THERE ARE A FEW HELP FILES THAT CANNOT
BE USED WITH THIS PROGRAM. tHE ONLY WAY THAT i CAN FIGURE TO USE BIGGER
FILES WITH THIS WOULD BE TO WRITE THE FILE TO DISK AND THEN READ IT BACK
IN. tHIS IN ITSELF, IN MY OPINION WOULD BE TO TIME CONSUMING, AND WOULD NOT
BE GOOD FOR rEMOTE bULLETIN bOARDS.
tHE DEFAULT lbr NAME IS hlpfiles
tHE DEFAULT dir NAME IS help
tHE DEFAULT du IS a15
tHE DEFAULT FILENAME IS menu
tHESE CAN BE CHANGED WITH zPATCH, PATCH OR SOME OTHER FILE EDITOR.
tHE lOCATIONS ARE:
dir - 116H (help)
du - 11eH (DISK) 0=a, 1=b ETC.
du - 11fH (USER)
file 120H (menu)
lbr - 128H (hlpfiles)
tHE PROGRAM ALLOWS YOU TO SPECIFY A DIFFERENT lIBRARY AND OR HELP FILE FROM
THE COMMAND LINE.
eXAMPLE 1:
LBRHLP -C15:SPECIAL SYSLIB
wITH THIS EXAMPLE WE TOLD THE PROGRAM THAT WE WANTED A DIFFERENT LIBRARY ON
C15 AND A HELP FILE CALLED SYSLIB. tHE (-) MUST PRECEDE THE DRIVE/USER OR
LIBRARY NAME, IF THE DEFAULT d/u IS WANTED.
eXAMPLE 2:
LBRHLP SYSLIB
wITH THIS WE TOLD THE PROGRAM THAT WE WANTED THE DEFAULT lbr WITH THE
FILENAME SYSLIB.
eXAMPLE 3:
LBRHLP -HELPS
wITH THIS WE ARE SPECIFING JUST THE LIBRARY, USING THE DEFAULT du/dir AND
DEFAULT FILENAME.
aNY AND ALL COMMENTS AND OR SUGGESTIONS WOULD BE APPRECIATED. pLEASE LEAVE
THEM ON MY SYSTEM znode #60 OR z-central OR lillipute #1 FOR i CALL THEM A
COUPLE OF TIMES A MONTH.