Description of command line interface

A simple shell interface to HEPDB is provided, using the KUIP [15] package. To run this interface, simply type hepdb.

CALL COUNT [ PATH CHOPT ]

PATH

Character variable specifying the pathname in which the objects are to be counted.

CHOPT

Character variable specifing the options required

D

display number of subdirectories at each level

O

display number of objects at each level

L

display lowest level only, i.e. directories with no subdirectories

Z

display only directories with no (zero) objects

Use the COUNT command to count the number of objects in the specified directories.

CALL FILES

Use the FILES command to display the files that are currently open.

CALL LOGLEVEL [ PATH LOGLEVEL CHOPT ]

PATH

Top directory name of HEPDB file.

LOGLEV

Log level

<0

no messages are printed

1

error messages from main HEPDB routines (default value)

2

error messages and warnings from main HEPDB routines

3

error messages, warnings and informative messages from main HEPDB routines

4

As above, but also error messages from HEPDB internal routines

5

As above, but also warnings from HEPDB internal routines

>5

all messages are printed, and also additional debug.

CHOPT

Character option

A

Set RZ loglevel for all HEPDB files that are currently open

Use the LOGLEVEL command to set the HEPDB logging level.

CALL OPEN PREFIX [ CHFILE ] [ CHOPT ]

PREFIX

Character variable specifying the two character database prefix

CHFILE

Character variable specifying the file name

CHOPT

Character option, as for the CDOPEN routine.

Use the OPEN command to open a HEPDB file

CALL CLOSE PREFIX [ CHOPT ]

PREFIX

Character variable specifying the database prefix of the database to be cloed.

CHOPT

Character option, as for the CDEND routine.

Use the CLOSE command to close a HEPDB file. previously opened using the OPEN command.

The CLOSE command accepts a two character database prefix, top directory name, or pathname. Thus, for a file with database prefix BK, the following commands are identical.

CLOSE BK

CLOSE CDBK

CLOSE //CDBK

CALL RZOPEN CHTOP CHFILE [ CHOPT ]

CHTOP

Character variable specifying the top directory name

CHFILE

Character variable specifying the file name

CHOPT

Character option

Use the RZOPEN command to open an RZ file

CALL RZCLOSE CHTOP [ CHFILE ] [ CHOPT ]

CHTOP

Character variable specifying the top directory name

CHFILE

Character variable specifying the file name

CHOPT

Character option

A

Close all files

Use the RZCLOSE command to close a file previously opened with RZOPEN

CALL OUTPUT [ FILE CHOPT ]

FILE

Character variable specifying the name of the file

CHOPT

Character options

C

close file and redirect output to terminal

P

preserve case of file

R

replace existing file

S

switch back to previously opened file

T

redirect output back to terminal

Use the OUTPUT command to redirect output to a specified file or to the terminal.

CALL VERSION

Use the VERSION command to display the version of the HEPDB software that you are running.

CALL CD [ CHPATH ] [ CHOPT ]

CHPATH

Character variable specifying the name of the new directory

CHOPT

Character option

Q

show quota for new directory

S

show number of subdirectories

T

show creation and modification times

U

show usage information

A

all of the above

Use the CD command to change the current working directory.

If the pathname begins with a % character then it is assumed to be an alias and is automatically translated by the internal HEPDB routines.

CALL LD [ CHPATH NLEVEL CHOPT ]

CHPATH

Character variable specifying the pathname

KSN

Serial number of the object to be displayed

NLEVEL

Number of levels to display

CHOPT

Character options

C

Display the RZ creation date and time

M

Display the RZ modification date and time

O

List the number of objects at each level

R

List subdirectories recursively

S

Display the number of subdirectories at each level

T

Display the tags as specified in the call to RZMDIR

Use the LD command to display subdirectories below the specified level.

CALL LS [ CHPATH KSN BANK CHOPT ]

CHPATH

Character variable specifying the path name to be listed

BANK

Character variable specifying the name of the bank to display

ILNK1

Index of the first link to be printed

ILNK2

Index of the last link to be printed

IDAT1

Index of the first word to be printed

IDAT2

Index of the last word to be printed

CHOPT

Character options

C

display object count

D

display key definitions

S

display the system keys

E

display the experiment keys

G

display keys using generic routine (RZPRNK)

V

display validity range pairs

U

display user keys

K

display all keys

L

list only lowest level (end node) directories (default)

M

show maxima and minima of validity range pairs

N

display number of data words

P

display pathname (default)

T

display insertion date and time (RZ value)

Z

dump ZEBRA bank with DZSHOW

Use the LS command to display the contents of a directory. If option Z is specified, the name of the bank(s) to be displayed may be given. If multiple banks are to be displayed, their names should be separated by commas. Wild cards are permitted in bank names.

CALL PWD

Use the PWD command to print the current (working) directory.

CHOPT

Character options

A

display alias name for current directory

CALL STATUS [ CHPATH NLEVEL CHOPT ]

CHPATH

Character variable specifying the pathname

NLEVEL

Number of levels to display

CHOPT

Character options as for RZSTAT

Use the STATUS command to print usage statistics on the specified directory down NLEVEL levels.

CALL TREE [ CHPATH NLEVEL ]

CHPATH

Character variable specifying the pathname

NLEVEL

Number of levels to display

CHOPT

Character options

A

show alias name (if any) for each directory

N

show the number of objects for each directory if non-zero

O

show the number of objects for each directory

S

show the number of subdirectories for each directory

C

show the date and time the directory was created

M

show the date and time of the last modification (RZ)

Use the TREE command to draw a directory tree starting at the specified directory down NLEVEL levels.

CALL SELECT ISEL1 [ ISEL2 ISEL3 ]

ISEL1

Integer variable specifying the primary selection

ISEL2

Integer variable specifying the secondary selection

ISEL3

Integer variable specifying the tertiary selection

Use the SELECT command to specify the instant of validity for which objects are required.

CALL ZOOM PATH

CHPATH

Character variable specifying the pathname

Use the ZOOM command to descend the specified directory tree to the first lowest level directory that contains one or more entries. The directory specification may contain wild-cards.

CALL DIR [ CHPATH CHOPT ]

CHPATH

Character variable specifying the pathname

CHOPT

Character variable specifying the options

'T'

List also subdirectory tree

Use the DIR command to issue a call to RZLDIR for the specified path. This command is normally used for debug purposes only.

CALL EXTRACT [ CHPATH OUTPUT CHOPT ]

CHPATH

Character variable specifying the pathname

OUTPUT

Character variable specifying the output filename

CHOPT

Character variable specifying the options

Use the EXTRACT command to copy a subset of the HEPDB catalogue

CALL MERGE [ INPUT CHPATH CHOPT ]

INPUT

Character variable specifying the input file name

CHPATH

Character variable specifying the pathname

CHOPT

Character variable specifying the options

Use the MERGE command to merge an update file created by the EXTRACT command into the specified path.

CALL MKDIR CHPATH

CHPATH

Character variable specifying the pathname

Use the MKDIR command to create a directory

CALL RM KEY1

KEY1

Integer variable specifying the key serial number of the object to be deleted

CALL RMDIR CHPATH

CHPATH

Character variable specifying the pathname

Use the RMDIR command to remove a directory from the catalogue.

Note that directories can only be removed if:

1. They contain no subdirectories
2. They contain no entries

CALL RMTREE CHPATH

CHPATH

Character variable specifying the pathname

Use the RMTREE command to remove a complete directory tree.

Note that if any of the directories below the named directory contain entries, then the command will be refused.