LIBINFORM procedure

Prints information about the contents of the Procedure Library (R.W. Payne).

Options

PRINT = strings

Indicates what information is required about each module (contents, index, modules, errors); default cont, erro

LIBRARY = string

Defines the library for which information is required (GenStat, local); default Gene

Parameter

MODULE = texts

Single-valued texts indicating the modules about which the information is required; if this is not set, information is given about the whole library

Description

LIBINFORM provides information about the GenStat Procedure Library or a local library. The MODULE parameter allows you to specify that information is required only for a specified list of modules of the library; if MODULE is not set, the information is given for the whole library. The name of each module should be given in a quoted string: for example

LIBINFORM [PRINT=index] 'AOV','MVA'

If the MODULE is not given in full, LIBINFORM identifies the first module (in alphabetic order) that matches the MODULE setting, up to the number of characters that has been specified.

The PRINT option specifies what information is required about each module. The possible values are as follows: contents list of procedures in the module or in the Library (see MODULE), index index lines for the procedures in the module/Library, errors list of procedures in the module/Library for which errors have been reported, modules list of modules in the Library (given only if MODULE is not set).

The information is stored in a backing-store file whose name is defined by library procedure LIBFILENAME; there must be a free backing-store to which the file can be attached. A second file may also have been defined to supply information about procedures in a local library, and you can then set option LIBRARY=local to print details about the local instead of the main library.

Options: PRINT, LIBRARY. Parameter: MODULE.

Method

The information is held in subfile _contents of the backing-store file that holds help for the library; the name of the file is supplied by procedure LIBFILENAME. This file is opened on the first available backing-store channel; if all the channels are in use, the procedures stops with a diagnostic. After printing the requested sections, the help file is closed.