CATALOGUE directive

Displays the contents of a backing-store file.


Options

PRINT = strings
What to print (subfiles, structures); default subf, stru

CHANNEL = scalar
Channel number of the backing-store file; default 0, i.e. the workfile

LIST = string
How to interpret the list of subfiles (inclusive, exclusive, all); default incl

SAVESUBFILE = text
To save the subfile identifiers; default *

UNNAMED = string
Whether to list unnamed structures (yes, no); default no


Parameters

SUBFILE = identifiers
Identifiers of subfiles in the file to be catalogued

SAVESTRUCTURE = texts
To save the identifiers of the structures in each subfile


Description

You can use CATALOGUE to obtain details of the subfiles contained in a backing-store file, or the structures within an ordinary subfile, or the procedures within a procedure subfile. The file is indicated by the CHANNEL option, and the SUBFILE parameter specifies the subfiles (of ordinary structures or of procedures) that are to be catalogued.

   The PRINT option specifies which catalogues are to be printed. The subfiles setting prints the catalogue of subfiles in the backing-store file attached to the channel specified by the CHANNEL option, while the structures setting prints the catalogue of structures or procedures that are in the subfiles specified by the SUBFILE parameter. If you set option UNNAMED=yes the unnamed structures in each subfile will also be listed, together with details of how the structures depend on each other.

   The LIST option controls how the SUBFILE list is interpreted. The default setting inclusive simply catalogues the subfiles that have been listed. Alternatively, if you set LIST=all GenStat will catalogue all the subfiles in the backing-store file. Finally, you can see LIST=exclusive to catalogue everything that you have not included in the SUBFILE list.

   The SAVESTRUCTURE parameter allows you to set up texts, one for each subfile in the SUBFILE parameter. Each text contains the identifiers of all structures with an unsuffixed identifier in the subfile. Each identifier is put on a separate line, and the characters ,\ are appended to all but the last line. You would normally use these texts as a macro; the ,\ makes them useable as lists of identifiers. If the text is used as a macro, it is subject to the restriction on the length of statements. The SAVESUBFILE option allows you to save a similar text containing the identifiers of all the subfiles in a backing-store file.

 

Options: PRINT, CHANNEL, LIST, SAVESUBFILE, UNNAMED.

Parameters: SUBFILE, SAVESTRUCTURE.