Library Utilities for ZCPR3

;

Library Utilities for ZCPR3
---------------------------

I - Introduction

G - LGET Tool
-- extracts files from within library files
H - LHELP Tool
-- processes HLP/HQP files from within
library files
L - LLF Tool
-- lists files within library files
X - LX Tool
-- executes COM files within library files

:I

INTRODUCTION TO THE ZCPR3 LIBRARY TOOLS

Thes� tool� assis� th� ZCPR� use� i� dealin� wit� �
librarie� i� th� ZCPR� environment�� Followin� th� ZCPR� �
philosoph� o� ho� command� shoul� b� constructed�� thes� ar� �
ful젠 ZCPR�� tool� whic� tak� advantag� o� th堠 ZCPR� �
environment and can only run in the ZCPR3 environment.

Thes� tool� ar� writte� i� Z8� cod� an� wil� onl�� ru� �
on Z80 or HD64180 microprocessors.

Onlin� documentatio� fo� eac� too� i� availabl� b� �
typing the name of the tool followed by two slashes:

TOOL //

:G

Command: LGET 1.0

Syntax:
LGET dir:library dir:afn1,dir:afn2,... o
Options:
U - Unsqueeze squeezed files

Function:

LGEԠ extract� th� specifie� file� fro� th� indicate� �
library�� I� th� file� ar� prefixe� wit� � director� �
reference� the� ar� place� i� th� indicate� directories� I� �
th� � optio� i� presen� an� th� file� ar� squeezed�� the� �
will be unsqueezed during the extraction process.

Comments:

File� i� th� destinatio� director� whic� hav� th� sam� �
names as the source files will be deleted.

I� th� whee� byt� i� no� set�� destinatio� director� �
reference� wil� b� ignored�� an� al� file� wil� b� extracte� �
into the current directory.

Selected Error Messages: None (Self-Explanatory)

Examples of Use:

LGET a:SYSLIB *.HQP
-- extract all files of type HQP from the
file SYSLIB.LBR on disk A, current user

LGET ROOT:COMMAND B4:L*.COM,B4:L*.HQP U
-- from the library COMMAND.LBR in the ROOT:
directory, extract L*.COM and L*.HQP files
and placed them in the directory B4:;
th� squeeze� file� (L*.HQP� wil� b�
unsqueezed and stored under their original
names

:H

Command: LHELP 1.0

Syntax:
LHELP topic
-- get help on the indicated topic in the
SYSTEM.LBR file
LHELP topic dir:library
-- ge� hel� o� th� indicate� topi� i� th�
indicated library
LHELP * library -or- LHELP topic *
-- name of the topic is the same as the name
of the library

Options: None

Function:
LHELР function� i� muc� th� sam� manne� a� th� HEL� �
comman� (versio� 5.� o� later�� se� HELPSYS.HLP)�� Unlik� �
HELP�� LHEL� work� fro� librar� files�� I� searche� fo� th� �
indicate� (o� implied� librar� fil� alon� th� comman� searc� �
path and in the directory named HELP. The search path is:
1) indicated or default directory (dir:library)
2) command-search path
3) HELP directory (if any)
Onc� th� librar� fil� ha� bee� found�� LHEL� lock� ont� �
it� an� al� hel� file� reference� b� th� indicate� hel� fil� �
ar� pulle� fro� thi� librar� file�� Th� fil� "topic.HLP� o� �
"topic.HQP�� i� pulle� fro� th� librar� file�� unsqueeze� i� �
necessary�� an� processed�� I� � selectio� i� mad� whic� �
reference� anothe� hel� file�� th� indicate� hel� fil� i� �
als� pulle� fro� th� curren� librar�� an� unsqueeze� i� �
necessary.

Comments:

LHELP will only run on Z80 or HD64180 microprocessors.

Th� command� whic� ma� b� issue� t� LHEL� ar� identica� �
to those which may be issued to HELP.

Selected Error Messages: None (Self-Explanatory)

Examples of Use:

LHELP SYSLIB *
-- pull SYSLIB.HLP or SYSLIB.HQP from SYSLIB.LBR
once SYSLIB.LBR is found via a search

LHELP CMD1
-- pull CMD1.HLP or CMD1.HQP from SYSTEM.LBR
once SYSTEM.LBR is found via a search

LHELP Z3LIB1 A:Z3LIB
-- pull Z3LIB1.HLP or Z3LIB1.HQP from Z3LIB.LBR,
starting the search from disk A, current user

:L

Command: LLF 1.0 (List Library Files)

Syntax:
LLF dir:library
-- list all files in library
LLF dir:library /o...
-- list all files in library with options
LLF dir:library afn1,afn2,...
-- lis� selecte� file� i� librar�
LLF dir:library afn1,afn2,... o...
-- list selected files in library with options

Options:
C Print CRCs of each file in listing
G Group files by file type and name (default is
by file name and type)
I Print starting indices of files
P Send listing to printer as well as console

Function:

LL� display� � director� o� � librar�� file�� Specifi� �
file� ma� b� selecte� b� specifyin� � lis� o� ambiguou� fil� �
names�� Th� listin� ma�� b� sen� t� th� consol� o� th� �
printer�� Fil� size� (i� term� o� record� an� neares� � �
bytes) are indicated in listing.

Comments:

LL� wil� onl� ru� o� th� Z8� o� HD64180.

Selected Error Messages: None (Self-Explanatory)

Examples of Use:

LLF A:SYSLIB
-- list all files in A:SYSLIB.LBR

LLF ROOT:COMMAND *.COM,*.HQP CPI
-- list *.COM and *.HQP files from COMMAND.LBR
in the directory ROOT:; include CRCs and
starting indices; send output to console
and printer

LLF ROOT:COMMAND /P
-- list all files in COMMAND.LBR in the ROOT:
directory; send output to the printer

:X

Command: LX 1.0

Syntax:

LX command_line
-- execute command line, extracting command verb
from ROOT:COMMAND.LBR

LX -dir:library command_line
-- execute command line, extracting command verb
from the indicated library file

Options: None

Function:

Lؠ perform� � complet� pars� o� th� indicate� comman� �
lin� a� th� ZCPR� comman� processo� would�� Name� director� �
reference� ar� resolved�� etc�� an� th� Externa� FC (i� �
available)�� FC� � (a� 5CH)�� FC� � (a� 6CH)�� an� TBUF� (a� �
80H) are loaded as though the ZCPR3 CP had done so.

Comments:
LX will only run on Z80 and HD64180 microprocessors.
Lؠ doe� no� perfor� � comman� searc� fo� th� library� �
Th� librar� mus� resid� i� th� indicate� directory�� o� L� �
will fail.
Fo� security�� director� reference� ar� ignore� i� th� �
wheel byte is not set.
Th� nam� o� th� defaul� librar� (ROOT:COMMAND.LBR� ca� �
be easily changed by patching or reassembly.

Selected Error Messages: None (Self-Explanatory)

Examples of Use:

LX -A1:ASM LIB80
-- run LIB80.COM from ASM.LBR in A1:

LX XD HELP:*.*
-- run XD.COM from ROOT:COMMAND.LBR; properly
pars� an� proces� th� comman� tai�
� HELP:*.*"