tcl.legend Verb: Access/TCL


Command tcl.legend Verb: Access/TCL
Applicable release versions: AP
Category TCL (746)
Description displays the current status of "legend" output, or toggles the display of the automatic page legend found in the item called "legend" in the "dm,messages," file.

If present, the "legend" item is output on the bottom of each page of OP (Output processor) reports directed to the spooler, unless "legend suppress" ("leg-supp") is in effect.

The "legend" is a static OP document stored as an item in "dm,messages,". This is in contrast to headings and footings, which are dynamic, changing with each page output.

Each user can have their own legend item, using "legend*user-id" as the naming convention for the "dm,messages," item. For example, "legend*bob".

If the legend status is "on", the system searches first for a user legend. If none exists, the default item, "legend", is used.
Syntax legend {(options}
Options f Toggles legend off. Suppresses legend on Spooler output. This eliminates the need for the "leg-supp" connective or "k" option.

n Toggles legend on. Outputs legend on Spooler listings.

s Suppresses output of status message.
[1303] Legend output is suppressed.

legend (n
[1302] Legend output is active.
Related tcl.legend-on