DISCAT pdf

#

DISCAT

by

Richard

L.

_Conn

A

File Cataloging System

A _{Disk Cataloging} System

_for

ZCPR3

Version 1.2, 22

_july

1984

The

_utilities

_{of the} DISCAT System are Copyright (C) 1984 by

Richard L. Conn.

_All

_{rights reserved.} DISCAT

_is

_{a trademark of}

Echelon, Inc. No

part of

_this

document _may be _{reproduced without}

I.

DISCAT SYSTEM.©%»k0.g.D0*0.0.*.*«0...o..03B...l

1.1. Some DISCAT

_Terms...2

1.2. ZCPR3

_{Directcries...2}

1.3. Comnand

Liñé.*©...3

1.4. Using the DISCAT

_System...4

2. DISCAT

_{COMMNDS.*...e...5}

2,L

CATCHECK...t...6

2.2.

_{cáTERAsE...,...8}

2.3.

_{CATFREE...±...,...1O}

2.4.

_{CATMAKE.0...0..0...,.*....,....,...1l}

2.5.

_{CATMER3E...o...g...,...l3}

2.6.

_{CATNAME....,d...,...g.,...,...15}

2.7.

_{CATRMDSK...17}

2.8.

_{CATSCAN...*..,...,...+.,.,...19}

2.9.

_{CATUPD...,...20}

2.10. Common

_Optians...22

2.1O.i. Option: D

-

Delete Without

Warning...22

2.10.2. Oµtion: F

-

Catalog

File...22

2.10.3. Gption: I

_-

Inspect

_{Entries...,...23}

2.10.4. opt.ion: N

-

Negate

Selection...,...23

2.Í().3. Option: O

-

Dc) NOT Enter Omitted

Fi1es...23

2.líj.6.

Option: P

-

Output to

Printer...23

2.i9.7.

Option: Q

-

Quiet...24

2.10.8. Optiori: R

-

Repeat...,...24

2.10.9. Option: Kl

-

Use W0RKING,CAT

File...24

2.10.10. Option

_{Summary,...,...25}

2.11. Common _Error

_{Messages4...,...26}

2.lív!.

AF'N NUT

Allowed...26

2.11.2. Catalog Structure

_Error...26

2.11.3. Directory

_Ful1...26

2ñl.4.

Disk

_Full...27

3. DISCAT

_{MENUS...e...28}

3.1. DISCAT MENU

1...29

3.1.1. MASTER _Catalog

_{Functions...,...30}

3.1.2. WORKING _Catalog

Functions...31

3.!.J.

General Catalog

_{Functicns...32}

3.1.4. Miscellaneous

_{Functions...,...33}

3.2. DISCAT MENU

2...35

3.3. DISCAT

_VMENU...36

Cleanup...50

4.2.8. Step 8: _{Backing up}

_{DEMO.CAT...51}

4.3. Command-Line-Based Sample

_Session...53

4.3.1. Updating DEMO.CAT _via

_CATUPD,...54

4.3.2. Verifying DEMO.CAT _{via CATCHECK...54}

4.3.3. Scanning DEMO.CAT _via

_CATSCAN...55

4.3.4. Checking Free Space _via

_CATFREE...55

4.3.5. Backup DEMO.CAT _via

_MCOPY.,...56

4.3.6. Removing BACKUPI.DMI _{from DEMO.CAT...56}

5. DISCAT SYSTEM

_{INSTALLATION...57}

5.1. Files to be

_{Installed...57}

5.2. Files Needed

_for

_{Instal1ation...57}

5.3.

_Installation

of

_DISCAT...58

APPENDICES A. DISCAT DISTRIBUTION

_FILES...59

B. DISCAT MENU _and VMENU

FILES...60

B.l.

_{DISCATI.MNU...60}

B.2.

_{DISCAT2.MNU...61}

B.3.

_{DISCATV.VMN...62}

C. ZCPR3

_{UTILITIES...63}

C.l.

_ALIAS...63

C.2.

_ELSE...63

C.3.

_ERA...63

C.4.

_ERASE...63

C.5.

_FI...63

C.6.

_IF...63

C.7.

_MCOPY...64

C.8.

_MENU...64

C.9.

_PATH...64

C.lO.

_PWD...64

C.ll.

VFILER...64

C.12.

_VMENU...64

C.13.

_XD...64

1.

_DIS

_CAT

S Y S

TEM

The DISCAT System {'-, _art zntegrated _{set of}

utility

programs

whi.ch

_is

used to maiñt«.ui

corífiguration information

on one _or more collections of dís'ks. This information

is

contained in one

or more Catalog File.m and

_{all utilities}

_{of the} DISCAT _System

work with these

_files.

Fhe _{narríes of the disks, the} names of the

files

on the disks, an-1 the amount of free _space

left

on each

disk _{are included} irí th _{catalog Files.}

The DÍSCAT _{Syste performs}

_its

_functions by

_creating,

updating, and

_reporti-

_{on Catalog}

_Files.

To _{perform these}

functions, the followiu,

_.ít-ilities

are provided:

Catalog f"¿ áe Maíntenance

_Utilities

CATCHECK

-

Used tc. i.heck a Catalog

File

and make sure

that

it

has _not been damaged CATMAKE

- Used to ('\"E'ate a Catalog File CATNAME

-

Used to place a name on a disk

Reporting

_Utilíties

CATFREE

-

Used to report on the amount _{of free} space

left

on each _{disk referenced in a Catalog File}

CATSCAN

-

Used to find

files

referenced in a Catalog File and _{report on} what _{disks they are located on}

Catalog

_Fije

Update

_Utílities

CATERASE

-

Used to erase information about

files

referenced

in a Catalog File CATMERGE

-

Used to merge one _or more Catalog

Files into

a

target Catalog File

All

of these

_utilities

_{are designed to work together} and _run

efficiently.

The _{options to these}

utilities

and

_{their error}

messages _{are consistent} with each _other, and _there

_is

_{a logical}

completeness to the DISCAT System.

The _{followirig chapter on the} DISCAT commands _describes each

utility

in

the DISCAT System

_{in detail.}

1.1. Some I)ISCAT Terms

Some _{terms which are} commonly used _{in conjunction with the} DISCAT System _{are defined here}

_for

_reference.

Catalog

_File

The _{Catalog File}

_is

t-he

_file

_manipulated by _the

_utilities

_of

the DISCAT _System.

_It

_contains

_information

_about

_disks,

in-cluding the names of the

files

and the amount of free _space

available

on them. A _Cata1og

_{File is}

a

special

_{type of binary}

file

which can only be created by the CATMAKE

_utility

and

manipu-lated by _{the other}

_utilities

_{in the} DISCAT System.

Omitted Files

Every _{Catalog File contains a}

_list

_of

_files

_{which are not to} be _included

_in

_it.

When _{a Catalog}

_{File is}

_updated,

if

a

file

whose _{name matches an entry}

_in

_the

_list

_{of Omitted}

_{Files is}

encountered,

_this

_file

_is

automatically ignored. Thus, _omitted

files will

never appear as

_{entries in}

a Catalog

File.

This

is

useful when _certain

_files

_{are contained} on

virtually

_{every disk} and _{the user prefers to not catalog} them. For example, _programs

like

PIP.COM _are commonly _{omitted from Catalog Files.}

1.2. ZCPR3 _Directoríes

Two named

_directories

_are used

_in

_conjunction

_with

_the DISCAT System. The

_first

_{is a directory} named CAT.

_It

_{is within}

this directory

that

_all

Catalog

_Files

maintained by _the DISCAT

System

_utilities

are to be

_stored.

The

utilities

will

automatically find

the Catalog

_Fijes

by _looking

_in

_the CAT

directory.

The _other

_directory

_is

named BACKUP, and

_{this is}

_the

directory

which

_is

used to

_indicate

what

_{disk is}

read by _the

DISCAT System

_utilities

_{to catalog disks from. Disks} are mounted

in

the BACKUP _directory

to be _read.

l _.3

. Command Lime

The DISCAT _System

_is

_{very consi.stent}

_in

_{terms of} use from

utility

to

_utility.

In genera!, the user types

in

_all

DISCAT System commands

_{like this:}

command _{<1istl> <list2> <options>}

Some commands _{take only one}

_list,

_{others take two,} and _{one takes}

none. The use of one

_ct

both

lists

is optional in

many _cases, and, when _{an optional}

_list

_{is omitted, the} command

_is

_{told that}

options _{are available} by _{the user proceeding those options with a}

slash

_(/).

_Lists

_are

_delimited

by _spaces, and

_list

_entries

_are

separated by _{commas. For exarüple, the} CATSCAN command _{has the}

form:

CATSCAN _{<1ist of fi1es>}

_<Iist

_{of disks> <options>}

Specifically

(additional space shown

for clarity

only):

CATSCAN '" _{.ASM, ".C}

,"

.PAS :1-_,S* ,

1<

,Bz p

Either

_list

may be omitted from the command

line,

and,

_if

an

option

_is

desired,

_it

must be _denoted by _{a leading slash,}

_like:

CATSCAN '" _{.ASM, *,C, * .PAS IE'}

or

CATSCAN _Ip

For consistency, a

fully-specified

command _{line may also} have

_its

options proceeded by _{a slash, but in}

_this

_{case, the slash}

_is

_not

required:

CATSCAN _".ASM '".S'" P

and

CATSCAN ""_{.ASM i: ,S* IP}

have _{the same} meaning.

Anüther consistent feature CN _{the DISCAT System}

is

that

_all

option

_letters

have _{the same meanings between}

utilities.

Fo _r

example, the N _{option in the CATERASE command Line}

íneans the same

thiiíg as the N _{option in the CATSCAN command}

1.4. Usiw the DISCAT System

DISCAT

_is

_{designed to} be _{used under} ZCPR3. _{Most of}

_this

manual

_is

_{devoted to providing technical}

_detail

_on how _to employ

the DISCAT system _{of programs, but the philosophy of} use

is

best

shown by _{example. For}

_this

_{reason, the}

_fourth

_{chapter on using} DISCAT

_is

_{provided. This chapter} shows how _{the author uses the}

system, and

_{this is}

_{perhaps the best} way _to

_illustrate

how _the

system was intended to be used.

The DISCAT System _can be _{viewed as an integrated subsystem}

under ZCPR3.

It

interfaces with

ZCPR3

_nicely,

_using

_its

_the

facilities

of ZCPR3 _{as they are required.} The menus (see the

third

chapter) _{are run} by _the ZCPR3 MENU _{and VMENU}

utilities.

2. D

I

S C _{A T} C O M M _A N D S

This chapter describes each _{of the} DISCAT commands _in some

detail.

In each _{case, the following information}

_is

provided to

the reader:

I.

Name _{of DISCAT Program}

2. _Synopsis

What _the

_uti1ity

does

_in

_{one or} two _lines

3. Command _Line Arguments

What arguments _the

_utility

_expects 4. _Options

Which _{options are recognized} by _the

_utility

5. _Function

What _the

_utility

does _in sorne

_detail

6. _Error Messages

What _{error messages are} generateCÍ by _the

_utility

7. _Defaults

What _{default conditions are} assumed by _the

_utility

8. Examples _of Use

Examples _of command _{line involving the}

_utility

2.1. CATCHECK

Name _{of DISCAT Program: CATCHECK}

Synopsis:

CATCHECK checks

_{for structural}

_{errors in Catalog Files.} Command _Line Arguments:

<1ist of catalog

_file

names: '

Options: None

Function:

CATCHECK

_is

_{used to check the}

_validity

_{of one or more}

Catalog Files.

_It

performs the following functions:

1. Checks _{the date area}

2. Checks _{the Omitted File}

_List

Counts _{the Files}

_in

_{the Omitted File}

_List

3. Checks _{the Disk} Name

_List

Counts _{the Entries}

_in

_{the Disk} Name

List

4. Checks _{the Catalog Entries} Counts _{the Catalog Entries}

CATCHECK _{performs a thorough check of each Catalog}

_File.

Errors are reported, and CATCHECK _aborts on the

_first

_{major error} encountered.

_If

an _error

_is

detected, the Catalog File should be

restored from

_its

backup _{copy or the disks should} be _recataloged. CATCHECK

_prints

_a

_report

_{on the Catalog}

_File

if

it

successfully

completes

_its

check of the Catalog

_File.

This

report provides the following information:

Number _{of Omitted Files}

--

How many

files

are

in

the Omitted File

List

Number _{of Disks}

--

How many disks are covered by the Catalog Number _{of Catalog Piles}

--

How many

distinct files

are in the Catalog

Number _{of Catalog Entries}

--

How many_(Each

file

entries are

in

the Catalog

distinct

_file

has _{one entry}

_for

each

disk

_it

_is

on)

If

an

_{error is}

encountered, the appropriate message

is

displayed in an attempt to indicate the extent of the error.

Error Messages:

** Error Encountered During Check _{of Disk} Names ** ** Error Encountered During Check _{of Catalog Entries **}

"xá

Error Encountered During Check _{of Omitted Files **}

--

Self-Explanatory

Defaults:

Default type of Catalog File

_is

CAT. Examples .of. Use:

CATCHECK MASTER.CAT CATCHECK MASTER

--

Check MASTER.CAT also

2.2. CATERASE

Name _of DISCAT Program: CATERASE

Synopsis:

CATERASE _erases

_files

_{from a Catalog File.} Command _Line Arguments:

<optiona1

_file

_list>

<optional disk 1ist> <options> Options: F,

_I,

N, Q

Function:

CATERASE

_is

used _{to erase}

_file

_{entries from a catalog.} The

optional disk

_list

indicates the names of the disks _to examine in

this

procedure, and _{the optional}

_{file list}

_{indicates the names of}

the

_files

to select

for

erasure.

If

the negate option

_is

enabled

(N),

_{all files}

NOT _{matching the}

_{entries in}

_the

_{file list}

_are

selected (the negate _{option applies only to}

_file

names

-

NOT disk

names).

If

no

file

name

list

_{or disk} name

list

is specified,

_all

files

on

all

disks are selected. Because _of

_this

_{power, use the}

CATERASE command _{with care!}

Erasing

_{all files}

on

all

disks does make _sense

_{in that}

the

remaining _space on each disk

is

still

retained in the Catalog

File. Using CATMAKE _{to create a new Catalog File} does _{not retain}

the remaining space information. Also, erasing

all files

on

all

disks

_in

conjunction with the Inspect Option

_{(I) is}

reasonable.

If

the disk naine

list

is

omitted, then

all

disks _are

selected.

CATERASE _performs

_its

_operations by _{reading an}

_orit:irml

Catalog File and _{creating a new one called} $WORK$.CAT.

It

builds

this

new

file

to contain

_{all file}

_entries

not selected

_for

erasure.

After this

file

is

built,

CATERASE renames

it

with

a

file

type of .BAK and _then renames $WORK$.CAT _{to the} name of the

original

_file.

_If

an

_error

_occurs while $WORK$.CAT

_is

being

created, the

_original

catalog

_{file will}

remain untouched and

valid. Use CATCHECK _{to insure that}

_{this is}

_the case.

Error Messages:

Standard

Defaults:

If

no Catalog

_{File is}

_explicitly

_specified,

the

_file

MASTER.CAT

_will

be _used. MASTER.CAT _resides

_in

_the CAT:

directory _{or the current} directory

_if

a directory named CAT: has

not been _defined. CATERASE

_will

_{automatically}

_{go to}

_{this dir}

when

it

runs.

Examples .o,f. _Use:

CATERASE *.ASM

--

Erase

files

matching *,ASM

CATERASE *.ASM IN

--

Erase

files

NOT matching *.ASM

CATERASE

_*,*

*,Z0O

_II

--

Erase

all files,

with inspect,

on

all

disks matching *.Z0O CATERASE

_Ii

2.3. CATFREE

Name _of DISCAT Program: CATFREE

Synopsis:

CATFREE _{reports on the free space}

_available

_{on selected}

disks known _{to the Catajog File.} Command _Line Arguments:

<optiona1

_list

of disks> <options> Options: F, P

Function:

CATFREE

_is

_{used to scan} a Catalog

_File

and

_report

_on

selected disks

_in

_{it. It}

reports on the names of the disks which match the

_{entries in}

the

_optional

di"& name

list

and gives the

amount of free space,

_ink,

remaining on each disk. The output from CATFREE _can be

_directed

_{to the}

_printer

_as

_well

_{as the}

console.

If

the optional

_list

of disks

_is

omitted, CATFREE _reports on

all

disks in the Catalog File.

Error Messages:

Standard

Defaults:

If

the

_file

type of the Catalog File

_is

not specified,

_it

_is

assumed _to be CAT.

If

the Catalog

_{File is}

not

_specified,

_it

_is

assumed _to be MASTER.CAT _{in the} CAT: _directory.

Examples o.f. _Use:

CATFREE

--

Display free space on

all

disks CATFREE _*.D*

--

Free Space on

al!

disks whose

type begins with the

_letter

D

CATFREE _*.S*,*,B*

--

Free Space on

all

disks whose

type begins with S

or B

CATFREE ZCPR2.ZOO,ZCPR2.Z01,BDSC.LO1

--

Free space on

selected disks

2.4. CATMAKE

Name _of DISCAT Program: CATMAKE

Synopsis:

CATMAKE

_is

used _{to create} and

_initialize

a Catalog File. Command _{Line Arguments:}

<list

of Catalog File names> <options> Options: D, O

Function:

CATMAKE

_is

_{used to}

_initialize

a Catalog

File.

CATMAKE

performs the following functions:

I.

Determine

_if

a named Catalog File already

exists and _{warn the user}

if

so, giviñ9 him the option to abort the process (the D

option overrides

_this

warning)

2. _Accept and _{edit a}

_list

_of names of the

files

to be _{automatically omitted from the Catalog}

File whenever

it

is

updated; these are the Omitted Files

3. _{Create an} empty _{Catalw File containing the}

list

of omitted names

If

the N _option

is

not used, the user

is

placed

_into

a mode

of

_inputting

a

list

of

file

names to be _{omitted from the new}

Catalog

_File.

_{After specifying}

the names he desires (or

specifying none at

_all),

the user

is

allowed to

_list,

delete, and add _{new names to}

_this

_list

_as he _desires. When

_satisfied,

_the

user exits and the Catalog File

is

created.

NOTE: Pay _{special attention to the creation of the Omitted}

File

_list.

Once a Catalog File

_{is initialized}

by CATMAKE, _there

Error Messages:

Standard

Nc _{Entries or} Nuniber Out _of Range

--

in deleting a

file

from the omitted

list

of

names, the number _{of the}

_file

_{selected to}

delete

_is

not present in the

_list

Defaults:

If

the type of a Catalog File is not given, CAT

_is

assumed. Examples of. Use:

CATMAKE _{MYCAT.CAT,MASTER}

--

Create 2

files

CATMAKE MYCATI DN

--

Create_MYCAT1.CATan empty_{with no}

omitted

_files

and

delete j-f one

already exists

2.5. CATMERGE

Name of. DISCAT ProgramL CATMERGE

Synopsis:

CATMERGE

_is

_{used to merge} one _or more Catalog

Files into

a

target Catalog File.

Command _{Line Arguments:}

<1ist of Catalog File names> <options> Options: F, Q

Function:

CATMERGE

_is

_{used to} merge one _or more Catalog

Files into

a

target

Catalog

_File.

The

_files

_to be _{merged are} assumed _to

contain more current information than the target Catalog

_File,

so

if

a disk

is specified in

a merging

file,

then

files

from

that

disk

which _{are not}

_in

the

_target

_file

are added to the

_target

file

while

_files

in the target Catalog File which are not in the merging Catalog Files _{are deleted} from the target Catalog File.

CATMERGE

_{is particularly}

_useful when _{the target Catalog File} (such _as MASTER.CAT) becomes _{so large that updatiw single disks}

into

_it

becomes a time-consumin£ _process. CATUPD can be used _to

update these disks into a temporary working Catalog File, and, _at

a

later

time, CATMERGE can be used to merge

this

temporary,

working Catalog File into the target Catalog File.

CATMERGE _performs

_its

_operations by _{reading from both the}

target

file

and _{the merging}

_files,

_creating

_{a new}

_target

_file

named $WORK$.CAT. Once _{the new target}

_file

_is

_{completed, either}

the old one

_is

renamed

_with

a

file

type of .BAK. $WORK$.CAT

_is

Error Messages:

Standard Defaults:

If

a Catalog

File's

file

_type

is

_not

_specified,

CAT

_is

assumed.

If

the F _option

is

not used, the

_target

Catalog

_{File is}

assumed _to be MASTER.CAT. Examples of. Use:

CATMERGE WORKING

--

Merge_MASTER.CATWORKING.CAT into

CATMERGE _{CAT1,CAT2 F'MAST'}

--

Merge CATI.CAT and CAT2.CAT

into MAST.CAT

2.6. CATNAME

Name _of DISCAT Program: CATNAME

Synopsis:

CATNAME

is

used _{to place} a name on a disk. Command _{Line Arguments:}

<disk name> <option> Options: Q

Function:

CATNAME

_is

used _{to place} a name on a disk. Under the DISCAT System,

_all

_disks must have _{a name placed} on them. The name of a

disk

_is

actually an empty

_file

_placed

_in

_{the disk directory} whose name begins

with

a _space and contains up _{to seven}

distinctive

characters followed by _{a disk type.} A _{suggested form}

for

a disk

name

is:

<7-chardescriptive disk name>

<2-char box ID>

<l-digit

disk. ID _(0-9)> The _{disk name}

file

is

made _Read/Only by CATNAME.

_It

_may

exist in

any _{user area} on the

disk,

but only one disk name

is

permitted _{per disk. Unless the user}

_specifically

gives _{the user}

area

for

the name to go

into,

the name

will

be placed

in

the

current directory.

When CATNAME

_is

_executed,

it

pauses,

allowing

the user to insert the disk to be named _{in the proper drive.}

_It

_{then deletes}

any

existing

names and

_writes

_{the new disk name on the}

_disk,

makint:

it

R/O. Examples: PASCAL..LOO

-

PASCAL Disk

in

Box LO, Disk // O

DATA.DI5

Error Messages:

Standard

Defaults:

If

the user does not

specify

a disk

drive (le,

C:

) in his

command _{line, the current disk drive is} used.

If

the user does _not

_specify

_{a user area}

_in

_his command

line, the current user area

is

used. Exanples o,f. _Use:

CATNAME _{C: PASCAL.LOO}

--

Naíííe_PASCAL.LOO;disk in.Drive C to

place name

in default _{user area}

CATNAME _{15: BDSC.LOI}

--

Name disk in default drive

to BDSC.LOI; _{place name}

in user area 15 CATNAME _BO:DATA.D15

--

Name_DATA.DI5;disk

in

Drive B to

place name in

user area O

2.7. CATRMDSK

Name _of DISCAT Program: CATRMDISK

Synopsis:

CATRMDSK

_is

used _{to remove}

_all

_{information pertaining to} a

disk completely from a Catalog File. The amount of free space on

the

_disk

and

_{all file}

_entries

_associated

_with

_the disk _are

removed.

Command _{Line Arguments:}

<optional

_list

of disk names> <options> Options: F,

_I,

Q

Function:

CATRMDSK

_is

used _to remove ALL _{information pertaining to} one

or more disks from a Cata1og File. CATRMDSK removes the name of the disk and

_all

_{entries for that disk,}

_{as opposed to} CATERASE

which may be _{used to erase}

_entries

_{from a Catalog}

_File

_but does

NOT _{remove the name of the disk.}

CATRMDSK can _{run in} an inspect mode (option

I),

in which

it

asks _{the user}

_for

_{permission to remove} each _{disk as}

it

encounters

them. The _{user manually confirms} each _{disk to} be removed.

CATRMDSK _also has _a

_quiet

mode _{of operation (option} Q)

_in

which

_it

does _not

tell

the user what

_it

is

doing as

it

proceeds

through the Catalog File.

CATRMDSK _performs

_its

_function by _{bui1diñ9 a working Catalog}

File

named $WORK$.CAT.

It

writes

the

_target

Catalog

_{File into}

this

working

_file,

removing entries and _{disks as}

it

goes. When

successfully completed, CATRMDSK renames

it

with a

file

type of BAK and _then renames $WORK$.CAT _{to the}

_original

name.

Error Messages:

Defaults:

If

the type of the Catalog File

_is

omitted, the type .CAT

_is

assumed.

The _{Catajog File}

_is

assumed _{to reside on the disk drive} and

in

the user area specified at

_installation

time.

If

the name of the Catalog File

is

not specified, MASTER.CAT

is

assumed. Examples o,f, _Use:

CATRMDSKPASCAL.LQ1,BDSC.LOO

--

Remove_{from the Catalog}

all

information

File about _the

indicated disks

CATRMDSK _*.L0?

II

_--

Remove

_all

_information

from the Catalog File on

all

disks

matching *.L0?, but

ask

_for

_permission

first

2.8. CATSCAN

Name _of DISCAT Program: CATSCAN

Synopsis:

CATSCAN

_is

_{used to scan}

_for

_selected

_files

and _disks

_in

a Cata1og

_File.

Command _{Line Arguments:}

"opt

_list

of fi1es> <opt

_list

_{of disks> <options>}

Options: F, N, P

Function:

CATSCAN

_is

_{used to scan} a Catalog

_File

and

_report

on

selected

_files

entries in

_it.

_It

can send

its

output to the CRT

or to the

printer in

a paged fashion, and

it

can

select certain

files

on

_all

_{or specified} disks.

The _{specification of disks to} CATSCAN _{takes precedence. For}

example,

_if

_files

*,ASM and _{disks *,B* are}

_specified,

FIRST _an

entry is

checked to see

if

its

disk name matches *,B* and _then

its file

nante

is

checked.

If

the Negate option (N)

_is

_given,

then

_files

which do NOT _match *.ASM _{are selected.}

If

the optional

_list

of disk names

is

omitted,

all

disks are

selected.

_If

the

_optional

_list

of

_file

names

_is

also omitted,

then

_{all files}

on

_all

disks _{are selected.}

Error Messages:

Standard Defaults:

If

a Catalog

File is

_not

specified

_in

the F

option,

MASTER.CAT

_is

used.

The CAT:

_{directory is}

_{used unless}

it

is

not defined,

in

2.9. CATUPD

Name of. DISCAT P,rog,raín,:, _CATUPD

Synopsis:

CATUPD

_is

used _to read _{a disk directory} and _{update a Catalog}

File with the information contained in the target disk directory.

Command _Line Arguments:

<optional

_file

name 1ist> <options>

Options: F, N, Q, R, W

Function:

CATUPD

_is

_{used to update the contents of a Catalog}

_File

by

directly

reading the directory

_(all

_{user areas) of} a target disk

and

_writing

_{its file}

names

_into

the Catalog

_File.

_If

the

_disk

was already in the

file,

then

_if

a

file

name is missing from the

disk,

_it

is

deleted from the Catalog

_File;

_if

a

file

name

is

on

the disk and _not

_in

_{the Catalog}

_File,

it

is

added _{to the Catalog}

File. The _{current free space (in} K) _{remaining on the target disk}

is noted in the Catalog File as well.

CATUPD _performs

_its

_{function in the}

_fbllowiM

_manner:

l.

_If

the Repeat _Option

_is

_selected, CATUPD pauses, asking the user to load another

disk or to abort.

2. The _{disk directory}

_is

loaded _{from the}

target disk; once the

activity light

on

the disk drive goes out, the target disk

may be removed and a new disk inserted 3. _{Files on the target disk are selected;}

they are compared against the omitted

file list

in the Cata1og _File and _deleted

if

they match _{an entry,} and _{then they}

are compared against the selected

file list

in the command

_line

4. The _target Cata1og _File

_is

opened

_for

_input, and _{a working}

_file

_is

opened

_for

_output 5. The update _{is performed from the target}

Catalog File thru CATUPD _{into the working}

file

6. The _{target Catalog File}

_is

_deleted and

the working

_file

_is

renamed _{to the}

_original

target Catalog File name

Error Messages:

Standard

Target Disk NOT _Named

-

Aborting

--

a dLsk_cataloged;name was not found on the disk to be

use CATNAME to place one there

Defaults:

If

the F _option

is

not used, MASTER.CAT

_is

_selected.

The CAT: _{directory (or the current directory}

_if

CAT:

_is

_not

defined)

_is

used _{to contain the Catalog File.}

The

_{disk identified}

by _the BACKUP:

_{directory is}

_{used to}

contain the

_target

disk unless BACKUP:

_is

_{not defined,}

_in

_which

case

disk

B:

_is

_used. Examples o,f. _Use:

CATUPD

--

Update

all files

on the target disk into MASTER.CAT

_in

_the home

_dir

CATUPD _*.ASM,*.C

--

Select

files

matching *.ASM

2.10. Coimcm _Üptions

The

_following

_{sections document the various options which}

are common _{to several} of the

_utilities

in the DISCAT System.

2.10.1. Optíon: D

-

Delete Without Warníng

The D _{option causes an existing Catalog File to be deleted.}

This option is intended to remove the need

for

_{user interaction}

with

the

_utility

once

it

has

started

so

that

t.he

utility

can be

executed from a SUBMIT

file.

Thus, the user who set up the SUBMIT

_file

does _not need _{to worry} about _{whether the delete query}

is

going to appear.

WARNING: The _user

_is

NOT _given an

_opportunity

_{to reverse}

this

action, so use

_this

option

_carefully!

The D _{option is valid only}

for

the CATMAKE

_utility.

2.10.2. Optíon: F

-

Catalog

File

The F _option

is

used _to

_specify

_{a Catalog}

_File

_to be _used

with

the associated command

_{for this}

_{run only.}

_If

_the F' _option

is

not used,

_all

DISCAT _System coínmands _except

_for

CATMAKE and CATNAME work _{with the Catalog File} named MASTER.CAT by _default. The F _option

is

used _{to select a Catalog File to work with.} The F _{option must be}

followed

by _a

_file

_{naníe surrounded} by

quotes or any other character. The general form of

this

option

is:

<delimiter>fi]ename.t.yµ<de]imiteí">

The

_delimiters

_used

_{with this}

_{option are used to mark the}

bounds of the FILENAME.TYP

_entry.

They _may be any

valid

character, and,

if

the F _option

is

the last option in the command

line, the ending

_{delimiter is}

not required.

The FILENAME.TYP _{i,ame is a standard} CP/M

file

name.

If

the

file

type ÁTYP)

_is

_{omitted, a}

_file

_{type oí .t?iT}

_is

_assumed. Examples:

MAST

--

MAST.CAT is the

file

ASMDISKS.CT

--

ASMDISKS.CT is the

file

As a

full

exarnple, the

_following

forms of the CATSCAN command _{are valid:}

CATSCAN /F/MAST/

--

Scan MAST.CAT

CATSCAN /F'MAST

--

Scan MAST.CAT

The F

option is

used

_only

by _the CATERASE, CATFREE,

CATMERGE, CATRMDSK, CATSCAN, and CATUPD

_utilities.

2.10.3. Optíon:

_I

— Inspect Entríes

The _I

_{option is}

_{used to inspect}

_files

_{or disks} before an

erase

action is

done. Thename of the

file

or disk to be _erased

from the Catalog File

_will

be _displayed

_for

_{the user.} Type y _to have _{the action performed or} any other character to abort

_it.

The _{I option}

_is

_{used only} by _the CATERASE and CATRMDSK

utilities.

2.10.4. Option: N

-

Negate Selectíon

The N _option

is

used to

_select

_{all files}

other than those given

_in

the command _line. For example:

CATSCAN *.ASM IN

selects

_{all files}

which do NOT _match *.ASM _{on the default Catalog}

File,

MASTER.CAT. The N _option

is

used only by _the CATERASE, CATSCAN, and CATUPD

_utilities.

2.10.5. Option: O

-

Do NOT Enter Omitted Files

The O _option

is

used _{to skip the entry of omitted}

_files

_from

the Catalog File. CATMAKE _{normally prompts the user}

_for

a

list

of

_files

to omit from the Catalog

_File

_it

_{is creating.}

The O

option prevents

_this

prompt from occurring. This option suppresses interactive messages _{to the user.} Thus, CATMAKE can be _used

_in

_{a SUBMIT}

_file

_without

_{the userhaving to worry about}

the SUBMIT

_file

_stopping due _{to the} need

_for

_{user interaction.} The O _option

is

used _only by _the CATMAKE

_utility.

2.10.6. Option: P

-

Output to

Printer

The P _option

causes the

information display

to be _{sent to}

the

_printer

(CP/M LST: _{device) instead of the console} (CP/M CON:

2.10.7. Option: Q

-

Quiet

The Q _{option causes informative}

messages which are normally

generated during the execution of a

utility

to be _suppressed.

Certain commands _{generate many screens of informative messages}

while _{they run. Thus, the user can omit these messages} by _using

the Q _{command. Errors}

are

still

displayed

if

they occur.

The Q _option

is

used only by _the CATERASE, CATMERGE, CATNAME, CATRMDSK, and CATUPD

_utilities.

2.10.8. Option: R — Repeat

The R _{option causes the CATUPD command}

to prompt the user to insert the next disk. With

_this

option, CATUPD

_will

_repeatedly

update one disk

after

another without returiÚ-ng to the Operating System.

The R _option

is

used _only by _the CATUPD

_utility.

2.10.9. Optíon: hi

-

Use WORKING.CAT

File

The CATUPD

_utility

can be made to use a special Catalog File

called

W(JRKING.CAT

_for

_its

_update by _{means of the} W

cption.

_If

W0RKING,CAT does _not

_exist,

CATUPD

_will

_create

it

and _then

proceed with the _update.

The W _{option should be used when the Master Catalog}

File

(MASTER.CAT) becomes _{large. Updates}

_into

MASTER.CAT become

slower as the

file

becomes

larger.

It

is preferred

to update

into

a

smaller,

working Catalog

File

and then,

after

updating

several disks

_{into this}

working

_file,

merge

it

into

MASTER.CAT

via the CATMERGE

utility.

The W _{option provides} a convenient _way

to specify and _{deal with a working Catalog File.}

For example,

CATUPD lw

creates

WORKING.CAT

if

_it

does not

exist

or appends to

WORKING.CAT

if it

does and _updates

_{ali files}

_{from the}

_default

disk drive into WORKING.CAT.

The W _{option is used only by the CATUPD}

utility.

2.IQ.IO. Option Smmary

The _{following table summarizes the options available under}

the

_utilities

of the DISCAT System.

Option Used by DISCAT System

_Utilities

D

-

Delete CATMAKE

F

-

Catalog File CATERASE, _CATSCAN,CATFREE, CATMERGE,_CATUPD CATRMDSK,

I

_-

Inspect CATERASE, CATRMDSK N

-

Negate CATERASE, CATSCAN, CATUPD

O

-

Omitted Files CATMAKE

P

-

Print CATFREE, CATSCAN

Q

-

Quiet CATERASE, CATMERGE,_CATUPD CATNAME, CATRMDSK,

R

-

Repeat CATUPD

W

2.11. Coímon _Error Messages

For _the sake _{of consistency, the}

_utilities

_{in the} CAT System

generate t.he same _error messages when _{certain error conditions}

occur during

their

operation. The _{following summarizes the error} messages common _{to the}

_utilities

of the DISCAT System.

2.11.1. AFN NOT _Allowed

Cause _{of Error:} The _{Catalog File specified in the} F _option

contains a

wild

card character, which

is either

an

_asterisk

("x)

or a question mark (?). Such a character is not allowed.

U.s.e.r Respo.ns±: _ _{The command}

line

must be _reissued

_with

_an unambiguous _{Catalog File} name.

2.11.2. Catalog Structure Error

Cause _of

_Error:

The _CataZog

_{File currently}

be:_{ing read} by

the

_utility

has been damagecÍ

_in

_{some way.} The _Catalog

_File

cannot be _found.

U,s.e.r _{R,e.spo.nse_:}_ _{The only way}

to restore

this

_file

is

to obtain

_its

backup _{copy or to create a new}

_file

_{from scratch.} The CATCHECK program is used _to check _the

_validity

_{of a Catalog}

_File,

and

it

can be used to help

identify

the

location

of the

_error.

CATCHECK

_identifies

_errors

_only

_{and does} NOT

_assist

_in

reconstruction.

This

_{error is usually irrecoverable.}

Before

attempting to recreate the Catalog

_File,

run CATCHECK on

_it

_to

verify

the

_error.

_If

CATCHECK _{gives the}

_file

_{a clean}

bill

of

health,

then

_{this error}

message was caused by the Catalog

File

not being found. This

_is

caused by _{the Catalog File not residing}

in

the

_directory

named CAT, _or,

if

there

_is

no

_directory

named CAT, _{then the Catalog}

_File

_{did not reside}

_in

_the

_current

directory.

2.11.3. Directory Full

Cause _of

_Error:

_{In attempting to create a}

_file

_{on a}

_disk,

the disk directory has reached

_{its limit}

and _there

_is

_not enough room

for

another entry. There may

still

be room on disk, but no more

files

can be placed on

it

because there

is

no room

in

the

disk directory.

User Response: _{Either erase one or} more

files

from the disk

which the Catalog

_{File is}

on _{or place} the Catalog

File

onto another disk.

2.11.4. Disk

_Full

Cause _of

_Error:

_There

_is

no more _space on disk

for

any

files,

in particular

the

_file

being created by _the

_utility

_in

use.

User Response: _{Either erase} one _or more

files

from the disk

3. D

_I

S C _{A T} M _E N U S

DISCAT was

_{written with}

ZCPR3

_in

_{mind, and, as such,} ZCPR3

MENU

files

are provided

in

the DISCAT

_{distribution.}

These

_files

may be _executed by _the ZCPR3 MENU

utility (if

their

_file

type

_is

".MNU) _or by _the ZCPR3 VMENU

_{utility (if}

_their

_file

_type

_is

"4VMN). The _{user must} have ZCPR3 and

_its

MENU and VMENU

utilities

installed

on his computer in order to take advantage of

these Menu

_files.

There _{are three} Menu

_files

_provided: DISCAT1.MNU

--

a simple menu which deals with only one

Master Catalog File (uses MENU) DISCAT2.MNU

--

a

slightly

more complex menu which can

deal with as many Master Catalog Files

as desired (uses MENU) DISCATV.VMN

-— as many Master Catalog Files as desired may be dealt with but the selection

is

thru a

_file

pointer (uses VMENU)

The menu

files

relieve much _{of the overhead of maintaining a}

catalog system by _providiríg many of the more commonly-used

functions

and command

_line

_{sequences at the}

_firtgertips

_{of the}

user. Rather than typing out the characters of each command when

the user wants _{to run at} DISCAT

_utility,

_{the menu}

_file

_allows him

to examine a menu, type one

letter,

enter any options desired, and _{watch the} command _run.

This

_facility

_is

invoked by _the command

MENU _menufile.MNU

or

VMENU _{*.CAT menufile.VMN}

béiñíg issued. Once

_{this is}

_{done, the} DISCAT Menu

_(with

high-lightiñ9

as appropriate)

will

be displayed. The _user may then

strike

the single

_letter

of the command he _{wants to execute} (case

is

not

significant),

and _that command

_will

be _executed

_after

_the

user provides the appropriate prompted inputs.

J.l.

DISCAT MENU Z

The _fo1Iowing

_{figure is}

_{a close approximation of the} menu

which

_will

be _{displayed to the user} when _the command

MENU _DISCAT1.MNU

is

issued.

DISCAT Menu SubSystem 1

--

MASTER Cataio9 Functions

--

--

WORKING Catalog Functions

--F

-

Free Space Scan l

-

Update WORKING Catalog

M

-

Merge_MASTERWORKING_CatalogCatalog into 32

-

Delete WORKING Cataio9

-

Cleanup WORKING Files

S

-

Scan MASTER Catalog

U

-

Update MASTER Catalog

V

-

Verify MASTER Catalog

--

General Catalog Functions

--

--

Miscellaneous Functions

--B

-

Backup the MASTER Catalog W

-

VFILER

C

-

Create a New Catalog File X

-

Dir

N

-

Place a Name on a Disk Z

-

ZCPR3 Cmd

— Figure: DISCAT MENU I

--The _{user may now issue any of the following single-character}

3.1.1. MASTER _{Catalog Functions}

These

_{functions affect}

_{the Master Catalog}

_directly.

The

Master Cata1og

_referred

to here

_is

the same as the

_default

cata1og

_file

which was specified _at

_installation

time.

F

-

Free Space Scan

The F _command

prints

out a display of the free space on the

disks

_specified

by _{the user.}

_It

_{prompts the user}

_for

_the names

of the disks _{to scan}

_for

(use

_*.*

to

_select

_all

disks),

and

it

then generates a display on the CRT. Prompt: Names _{of Disks}

--DISCAT Cc.mand Used: CATFREE

Command _{Line Generated:} CATFREE _{<user input>}

M

-

Merge WORKING Catalog into MASTER

The M _command

merges the

file

WORKING.CAT

_into

_{the Master}

Catalog

_file.

_It

assumes that the information in WORKING.CAT

_is

more current and _{modifies the Master Catalog}

_file

_to

_reflect

_the changes _{to the disks contained}

_in

WORKING.CAT. Only _references

to those disks contained in WORKING.CAT _{are affected} Prompt: <None>

DISCAT Command Used: CATMERGE

Command _{Line Generated:} CATMERGE _WORKING S

-

Scan MASTER Catalog

The S _command

scans the Master Catalog

file

for

the

files

and _disks

_specified

by _{the user}

_in

_{response to the prompt.} A

list

of

_files

_followed

by _a

_list

_{of disks}

_is

_{accepted as}

_input,

If

the

_list

of disks

_is

omitted,

_all

_{disks are} scanned. Prompt: , _{Input Files and Disks to Scan For}

--DISCAT Corrunand Used: CATSCAN Command _{Line Generated:} CATSCAN

<user inµut>

U

-

Update MASTER Catalog

The U _{command allows the}

user to mount one disk

after

another

_into

the

_target

disk

_{drive (specified}

at

installation

time) and _{update the contents of these disks}

_directly

_into

the Master Catalog

file.

The _user

_is

_{prompted to} mount one disk, the

update

_is

done, and _{the user}

_is

_{then prompted}

_for

_{the next disk.}

This can continue

indefinitely

and

is

terminated by the user

typing ^C.

Prompt: <None

-

comes from CATUPD> DISCAT Command Used: CATUPD

,

Command _{Line Generated:} CATUPD

_Ir

V

-

Verify MASTER Catalog

The V _{command allows the user to check the Master Catalog}

file

to make _sure

_{that is}

_{has not been corrupted.}

_{If all}

_is

well, information

on the contents of the Master Catalog

file,

such _as number _{of disks}

it

contains,

_is

displayed when done.

Prompt: <None>

DISCAT Command Used: CATCHECK

Command _{Line Generated:} CATCHECK MASTER

3.1.2. WORKING _{Catalog Functions}

1

-

Update WORKING Catalog

The _l command _{allows the user to update the contents of the}

file

WORKING.CAT.

_If

WORKING.CAT does _not

_exist,

it

is

created

as a Working Catalog

file.

In response _to

this

command, _{the user}

is

prompted to mount a disk. When done, the catalog

_is

updated

and _{the user}

_is

_{prompted again. This continues}

_indefinitely

until

the user strikes a ^C in response _{to the prompt.}

Prompt: <None

2

-

Delete WORKING Catalog

The

file

WORKING.CAT

_{is deleted.}

It

is intended

to

eventually merge WORKING.CAT into the Master Catalog

file

_after

WORKING.CAT has been _updated

_for

_a

_while.

_{After this}

_merge

occurs, there

is

no need to keep WORKING.CAT _{around, so}

_this

command _{provides a convenient} way _{to delete} WORKING.CAT.

Prompt: <None>

DISCAT Command Used: <None>

Command _{Line Generated:} ERA _WORKING.CAT 3

-

Cleanup WORKING Files

All

"4bak

_files

and _the

_file

WORKING.CAT _{are deleted.} Prompt: <None>

DISCAT Command Used: <None>

Command _{Line Generated:} ERA _{*".BAK;ERA WORKING.CAT}

3.1.3. General Catalog Functions

B

-

Backup the MASTER Catalog

The B command _{backs up the Master Catalog}

_file

_{to as many}

disks as desired. The MCOPY command

is

used to do

this,

so the

directory named BACKUP

_is

_{the directory which}

_is

_{copied to.}

_If

there

_is

no

directory

named BACKUP on the user's ZCPR3 _system,

the

_directory

BO:

_is

_used. See _{the documentation on the} MCOPY

command

_(in

_{the corresponding} ZCPR3 HLP

_file)

_{for details}

_on MCOPY.

Prompt: <None

-

MCOPY prompts>

DISCAT Command Used: <None>

Command _{Line Generated:} MCOPY _MASTER.CAT M

C

-

Create a Nev Catalog Fíle

The C _command

is

used to create a new catalog

file.

It

prompts the user

for

the name of the

file

(default

file

type

is

CAT), and

it

allows him to

_specify

_its

parameters, such as the names of the omitted

files.

Prompt: Name _{of Catalog File to Create}

--DISCAT Command Used: CATMAKE Command _{Line Generated:} CATMAKE

<user input>

N

— Place a Name on a Dísk The N _command

is

used to place a disk name on the disk

in

the

_{default destination drive}

(specified at

installation

time).

All

disks referenced by DISCAT must be named. Prompt: Name _{of Disk}

--DISCAT Command Used: CATNAME

Command _{Line Generated:} CATNAME

<user input: ' 3.1.4. Miscellaneous Functions

W

-

VFILER

The W _{command invokes VFILER}

as a subshell under the current MENU. The

_full

_{resources of} VFILER _{are available to the user.} Prompt: <None>

DISCAT Command Used: <None> Command _{Line Generated:} VFILER

Z

-

ZCPR3 Cmd

The Z _{command allows}

the user to enter any ZCPR3 command

line

he _wishes. The MENU

_is

_{terminated, the} command

_line

is

executed, and _{the user}

_is

_{returned to the} DISCAT Menu. Prompt: _Enter Command _Line ——

DISCAT Command Used: <None>

Command _{Line Generated: <user input: '}