CATHEADER - List various header information for a catalogue

Description:

List various header information for a catalogue. By default the information listed is: the number of rows, the number of columns, the number of catalogue parameters and a list of the names of all the columns. Parameter DETAILS can be used to specify that various alternative details are to be listed.

The output is directed to the standard output and optionally may also be copied to a text file. If the name of the catalogue is CNAME, then this output file will be called CNAME.lis.

Application parameters ROWS, COLS, PARS and NAMES are written only if DETAILS=SUMMARY or FULL.

Usage:

catheader

Parameters:

CATALOGUE = CHARACTER (read)

Name of the catalogue.

FILE = LOGICAL (read)

Flag indicating whether or not an output file is to be written. It is coded as follows: .TRUE. - write the output file, .FALSE. - do not write the output file.

DETAIL = CHARACTER (read)

Flag specifying the details which catheader is to display. The options are: SUMMARY - summary (default), COLUMNS - full details of all the columns, PARAMETERS - full details of all the parameters, TEXT - textual information, AST - details of any AST information, FULL - full information (all the above).

QUIET = LOGICAL (read)

Operate in quiet mode where warnings are suppressed. The permitted values are: TRUE - quiet mode, FALSE - verbose mode.

ROWS = INTEGER (write)

The number of rows in the catalogue.

COLS = INTEGER (write)

The number of columns in the catalogue.

PARS = INTEGER (write)

The number of parameters in the catalogue.

NAMES = CHARACTER (write)

A list of the names of all the columns in the catalogue.

Examples:

catheader

The catalogue name will be prompted for, then the default details will be displayed.

catheader input-catalogue

Here the input catalogue has been specified on the command line. The default details will be displayed.

catheader details=columns

The catalogue name will be prompted for, then details of all the columns in the catalogue will be displayed.

catheader file=true

The catalogue name will be prompted for, then the default details will be both displayed and written to a text file called input-catalogue.lis.