4. CA MICS Facilities › 4.6 Documentation Programs › 4.6.1 Document Utility Control Commands › 4.6.1.4 $PARM Command Parameters

4.6.1.4 $PARM Command Parameters

$PARM nnnn nnnn ...

This control record sets parameters that affect document
format.  These parameters can also be set using the SYSPARM
option of the MICSDOC PROC, but only if the parameter affects
the entire document.  Parameters set with the $PARM card take
effect when they are encountered in the input text.  The
values of the parameters can be changed as often as
necessary.  Several parm values may be specified on the same
$PARM card.  Each must be separated by a blank or a comma.

   The parameters currently supported include:

    o  1UP/2UP

       Allows selection of one or two columns of text per
       page.  If encountered within the text, this parm will
       take effect at the end of the current column of text.
       The default value is 2UP.

    o  UCASE

       Requests translation of "|" to "I" for the page border
       box.  This parm is intended to be used in conjunction
       with the UCASE option of the MICSDOC PROC, and is set
       automatically when this option is specified on the
       EXEC statement.  The UCASE option on the EXEC
       statement causes all of the input text to be
       translated to upper case.

    o  LSIZE=nnnn

       Changes the line size of the output text.  This
       parameter is intended primarily for use in one-column
       text.  It does not dynamically flow text across line
       boundaries.  The default value is 61.  When set to 80,
       column 1 is treated as part of the text.

    o  NLINES=nnnn

       Changes the number of lines of output per page.  This
       parameter is intended primarily for use in sites that
       use a paper size that will not hold 60 lines.  The
       minimum value allowed is 20.  MICSDOC reserves lines
       at the top and bottom of each page which are included
       in the NLINES count.  Three lines are reserved at the
       top of the page.  The number of reserved lines at the
       bottom of a page varies with the type of text on each
       particular page.  MICSDOC reserves 5 lines for text, 2
       lines for figures, and 10 lines for dictionary
       entries.  Thus, the default NLINES value of 60 allows
       for 52 text lines with text type output.

    o  SNUM

       Signals the DOCUMENT program to suppress printing of
       the section number (from $HEDR entries) as part of all
       GENERAL and DETAIL Table of Contents lines.  Without
       this option, the format of table of contents lines is:

            x.x.x.x  title information . . . . . . . . page#

       where x.x.x.x is the document section number.  Using
       this option, the format of table of contents lines is:

            title information  . . . . . . . . . . . . page#

    o  NONUM

       Signals the DOCUMENT program to suppress printing of
       the section number (from $HEDR entries) as part of all
       text page headers and footers.  This option includes
       SNUM features and additionally strips section numbers
       from the beginning of each text section.  It also
       blanks out the section number that would normally
       print at the bottom of the page box on a two-up print.
       The NONUM option was added to allow for text to be
       printed without any numbering except chapter and
       figure numbers.

    o CNTL

       This option requests that ./ control record lines be
       ignored if present in the text.