HELP RUNOFF — MicroVMS 4.5B
Creates formatted files from source DSR (RNO) files, unformatted table of contents (RNT) files, and unformatted index (RNX) files. Optionally creates intermediate (BRN) files for input to RUNOFF/CONTENTS and RUNOFF/INDEX commands. Format RUNOFF dsr-file,... Requires the Common Utilities Option.
Additional information available:
Parameters
dsr-file Specification of an input DSR file. Wildcard characters are not allowed. The file type defaults to RNO; you must specify the file type for RNT and RNX files. Specify SYS$INPUT to type the input from your terminal or a command procedure; terminate input from the terminal by pressing CTRL/Z.
Qualifiers
Additional information available:
/BACKSPACE/BOLD/CHANGE_BARS/DEBUG/DEVICE
/DOWN/FORM_SIZE/INTERMEDIATE/LOG/MESSAGES
/OUTPUT/PAGES/PAUSE/REVERSE_EMPHASIS/RIGHT/SEPARATE_UNDERLINE
/SEQUENCE/SIMULATE/UNDERLINE_CHARACTER/VARIANT
/BACKSPACE
Positional qualifier. Bolds, overstrikes, and underlines by backspacing to each character after it is printed, if the printer permits. Otherwise, these operations are implemented by performing a carriage return without a line feed after the entire line is printed.
/BOLD[=overstrike] (default)
/NOBOLD Positional qualifier. Specifies the number of times characters are overstruck in a bolding operation. The value must be 0 or a positive integer and defaults to 1. A specification of /BOLD=0 or /NOBOLD disables all bolding, even if the appropriate flags are recognized and enabled.
/CHANGE_BARS[=character]
/NOCHANGE_BARS Positional qualifier. Enables change bars (the .BEGIN BAR and .END BAR commands) starting at the beginning of the DSR file (just as if you had included an .ENABLE BAR command within the DSR file). The value specifies the character to to be used for the change bar and defaults to a vertical line (|). You can specify the change bar character as a single printable character or a number preceded by a radix indicator (%D, %O, or %X) to represent the ASCII value of a printable or nonprintable character. (For example, you can specify /CHANGE_BARS=%D7 to ring the bell on terminal output.) A specification of /NOCHANGE_BARS overrides any .ENABLE BAR command in the DSR file.
/DEBUG[=(option,...)]
/NODEBUG (default) Positional qualifier. Traces certain operations by placing the DSR commands in the output file. The options are as follows: +--------------+-------------------------------------------+ | CONDITIONALS | Ignores conditional commands (.IF, | | | .IFNOT, .ELSE, .ENDIF) in processing the | | | DSR file and places them in the output | | | file. | +--------------+-------------------------------------------+ | FILES | Places .REQUIRE commands in the output | | | file (as well as the text of the | | | required file). | +--------------+-------------------------------------------+ | INDEX | Places .INDEX and .ENTRY commands in the | | | output file. Index flags are represented | | | by .INDEX commands before the lines on | | | which the flag occurs. | +--------------+-------------------------------------------+ | CONTENTS | Places .SEND TOC commands in the output | | | file. | +--------------+-------------------------------------------+ A specification of /DEBUG means /DEBUG=ALL.
/DEVICE[=(option,...)]
Positional qualifier. Produces an output file suitable for printing on an LN01 or an LN03 printer. The options are as follows. +--------------------+-------------------------------------+ | LN01 | Designates a standard LN01 printer | | | with a paper size of 8 1/2 by 11 | | | inches. | +--------------------+-------------------------------------+ | LN01E | Designates a European LN01 printer | | | with a paper size of European A4. | | | Incompatible with LN01. | +--------------------+-------------------------------------+ | LN03 | Designates a standard LN03 printer | | | with a paper size of 8 1/2 by 11 | | | inches. | +--------------------+-------------------------------------+ | LANDSCAPE | Prints pages with the long | | | dimension at top using a smaller | | | type size. Allowable page | | | dimensions are 0-73 lines per page | | | and 0-132 characters per line. | +--------------------+-------------------------------------+ | PORTRAIT (default) | Prints pages with the short | | | dimension at top using a larger | | | type size. Allowable page | | | dimensions are 0-66 lines per page | | | and 0-80 characters per line. | | | Incompatible with LANDSCAPE. | +--------------------+-------------------------------------+ | ITALIC (default) | Italicizes characters flagged for | | | underlining. Italicized characters | | | can also be bolded. | +--------------------+-------------------------------------+ | UNDERLINE | Underlines characters flagged for | | | underlining. You cannot underline | | | more than 63 consecutive | | | characters (counting a space as a | | | character). Incompatible with | | | ITALIC. | +--------------------+-------------------------------------+
/DOWN[=lines]
/NODOWN (default except for LN01) Positional qualifier. Shifts the entire page down the specified number of lines. A specification of /DOWN means /DOWN=5, but if you specify /DEVICE=LN01, /DEVICE=LN01E, or /DEVICE-LN03, /DOWN defaults to /DOWN=3.
/FORM_SIZE=lines
Specifies the maximum number of lines per page including headers and footers. Defaults to /FORM_SIZE=66, which is standard for 11 inch paper. For LN01 printers, set the number of lines as follows: +------------+-------+--------------------------------+ | Paper size | Lines | Mode | +------------+-------+--------------------------------+ +------------+-------+--------------------------------+ | 8.05 | 69 | Landscape | +------------+-------+--------------------------------+ | 8.28 | 71 | Landscape (LN01E default) | +------------+-------+--------------------------------+ | 8.51 | 73 | Landscape (LN01, LN03 default) | +------------+-------+--------------------------------+ | 11.00 | 66 | Portrait (LN01, LN03 default) | +------------+-------+--------------------------------+ | 11.66 | 70 | Portrait (LN01E default) | +------------+-------+--------------------------------+ | 12.33 | 74 | Portrait | +------------+-------+--------------------------------+ | 13.00 | 78 | Portrait | +------------+-------+--------------------------------+ | 14.00 | 84 | Portrait | +------------+-------+--------------------------------+
/INTERMEDIATE[=file-spec]
/NOINTERMEDIATE (default) Positional qualifier. Creates an intermediate file which can be used as input to a table of contents or index operation. The directory and file name default to that of the DSR file. The file type defaults to BRN.
/LOG
/NOLOG (default) Writes a termination message after successful completion of the DSR operation. (The message is always written if the operation fails.) The message states the DSR version number, the number of diagnostic messages (if any), the number of output pages, and the output file specification. If /INTERMEDIATE is specified, the message also includes the number of index records produced and the number of table of contents records produced.
/MESSAGES=(option,...)
Positional qualifier. Directs error messages to the terminal, to the output file, or to both. You cannot suppress error messages entirely. The options are as follows: +--------+-------------+ | Option | Description | +--------+-------------+ +--------+-------------+ | OUTPUT | Output file | +--------+-------------+ | USER | Terminal | +--------+-------------+ The default (if you do not specify the qualifier) is /MESSAGES=(OUTPUT,USER).
/OUTPUT[=file-spec] (default)
/NOOUTPUT Positional qualifier. Specifies that an output file is to be produced and optionally names it. The directory and file name default to that of the DSR file. The file type defaults to one of the following: +------+---------------------------------------------------+ | BLB | For an RNB input file | +------+---------------------------------------------------+ | CCO | For an RNC input file | +------+---------------------------------------------------+ | DOC | For an RND input file | +------+---------------------------------------------------+ | ERR | For an RNE input file | +------+---------------------------------------------------+ | HLP | For an RNH input file | +------+---------------------------------------------------+ | LNI | For an RNO input file with /DEVICE set to LN01, | | | LN01E, or LN03 | +------+---------------------------------------------------+ | MAN | For an RNM input file | +------+---------------------------------------------------+ | MEC | For an RNT input file | +------+---------------------------------------------------+ | MEM | For an RNO input file with no /DEVICE | | | specification | +------+---------------------------------------------------+ | MEX | For an RNX input file | +------+---------------------------------------------------+ | OPR | For an RNP input file | +------+---------------------------------------------------+ | PLM | For an RNL input file | +------+---------------------------------------------------+ | STD | For an RNS input file | +------+---------------------------------------------------+ If you specify /NOOUTPUT, no output file is produced.
/PAGES="range"
Positional qualifier. Specifies the pages that will be produced from the output file. Defaults to all pages. Specify range as follows: start-page-no:end-page-no,... You can specify up to five ranges; you can omit the colon and the end page number on the last range to mean the last page. You can omit the quotation marks if you specify only one range. Page numbers must be specified in their default form, not the form specified in a .DISPLAY command. You can specify just the appendix letter or name to produce an entire appendix. You can specify just the word INDEX to produce an entire index.
/PAUSE
/NOPAUSE (default) Stops output at the end of each page during processing. You must press the space bar to continue processing. Do not use /PAUSE if you name a spooled device as the output file.
/REVERSE_EMPHASIS
Positional qualifier. Directs DSR to change the order in which flagged text is underlined on an output device. If you use this qualifier, the printer first prints the characters to be underlined, issues a carriage return without a linefeed, and then prints the underscores to underline the flagged material. If you view your file on the terminal, the flagged characters are overwritten by the underline character.
/RIGHT[=spaces]
/NORIGHT (default except for LN01) Positional qualifier. Shifts the text on each page to the right the specified number of spaces. This qualifier does not affect the page width. A specification of /RIGHT means /RIGHT=5. A specification of /RIGHT=0 means /NORIGHT. The defaults (if /RIGHT is not specified) for LN01 files are as follows: +-----------+------+-------+ | Mode | LN01 | LN01E | +-----------+------+-------+ +-----------+------+-------+ | Landscape | 9 | 13 | +-----------+------+-------+ | Portrait | 2 | 2 | +-----------+------+-------+
/SEPARATE_UNDERLINE[=character]
Positional qualifier. Prints underlines as separate characters on the next line instead of overstriking with underscores on the same line. The value specifies the character to be used for the underline character and defaults to a hyphen (-). You can specify the underline character as a single printable character or a number preceded by a radix indicator (%D, %O, or %X) to represent the ASCII value of a printable or nonprintable character.
/SEQUENCE
/NOSEQUENCE (default) Positional qualifier. Precedes the lines in the output file with the line numbers of the corresponding lines in the DSR file. Sequential numbering is used if line numbers were not explicitly specified in the DSR file.
/SIMULATE
/NOSIMULATE (default) Inserts blank lines instead of a form feed to cause an advance to the top of the next page. Also stops output before the first page is processed; you must press the space bar to continue processing. Do not specify /SIMULATE if you name a spooled device as the output file.
/UNDERLINE_CHARACTER[=character]
/NOUNDERLINE_CHARACTER>RUNOFF Specifies the character to be used for the underline character. Defaults to an underscore (_). You can specify the underline character as a single printable character or a number preceded by a radix indicator (%D, %O, or %X) to represent the ASCII value of a printable or nonprintable character. A specification of /NOUNDERLINE_CHARACTER overrides any .ENABLE UNDERLINING command in the DSR file. Incompatible with /SEPARATE_UNDERLINE.
/VARIANT="variant,..."
Identifies conditional structures in the DSR file. You must name conditional structures introduced by .IF to process them. You must name conditional structures introduced by .IFNOT to exclude them. You must not name conditional structures introduced by .ELSE to process them. If you specify only one variant, you do not need the quotation marks.
/CONTENTS
Creates an unformatted table of contents file from an intermediate file. Format RUNOFF/CONTENTS intermediate-file Requires the Common Utilities Option.
Additional information available:
Parameter
intermediate-file Specification of an input intermediate file. Wildcard characters are not allowed. The file type defaults to BRN. You can concatenate input files into a single output file by connecting the input file specifications with plus signs. (If you separate the input file specifications with commas, separate output files are created.)
Qualifiers
Additional information available:
/BOLD/DEEPEST_LEVEL/IDENTIFICATION/INDENT/LOG
/OUTPUT/PAGE_NUMBERS/SECTION_NUMBERS/UNDERLINE
/BOLD
/NOBOLD (default) Bolds header titles that are flagged as bold in the text.
/DEEPEST_LEVEL=level
Writes header titles up to the specified level. Level must be an integer in the range 1-6. The default is /DEEPEST_LEVEL=6.
/IDENTIFICATION
/NOIDENTIFICATION (default) Displays the version number of the DSR table of contents facility.
/INDENT
/NOINDENT (default) Indents each level of header titles another two spaces. The default indents all levels after the first the same two spaces.
/LOG
/NOLOG (default) Writes the name of each input file as it is processed and after it is processed, and the name of each output file created. Error messages are always written.
/OUTPUT[=file-spec] (default)
/NOOUTPUT Specifies that an output file is to be produced and optionally names it. The directory and file name default to that of the DSR file. The file type defaults to RNT. If you specify /NOOUTPUT, no output file is produced.
/PAGE_NUMBERS=(option,...)
Displays page number references in the table of contents according to the options you specify: +---------------------+------------------------------------+ | RUNNING | Running page numbers (1, 2, 3, and | | | so on). | +---------------------+------------------------------------+ | NORUNNING (default) | Chapter oriented page numbers | | | (1-1, 1-2, and so on). | | | Incompatible with RUNNING. | +---------------------+------------------------------------+ | LEVEL=number | The number of levels for which | | | page numbers are written. A | | | specification of LEVEL=0 writes | | | no page numbers. Defaults to | | | LEVEL=6. | +---------------------+------------------------------------+
/SECTION_NUMBERS (default)
/NOSECTION_NUMBERS Writes section numbers to the table of contents.
/UNDERLINE
/NOUNDERLINE (default) Underlines header titles that are flagged for underlining in the text.
/INDEX
Creates a DSR index file from an intermediate file. Format RUNOFF/INDEX intermediate-file,... Requires the Common Utilities Option.
Additional information available:
Parameter
intermediate-file Specification of an input intermediate file. Wildcard characters are not allowed. The file type defaults to BRN. You can concatenate input files into a single output file by connecting the input file specifications with plus signs. (If you separate the input file specifications with commas, separate output files are created.)
Qualifiers
Additional information available:
/IDENTIFICATION/LINES_PER_PAGE/LOG/OUTPUT/PAGE_NUMBERS
/REQUIRE/RESERVE
/IDENTIFICATION
/NOIDENTIFICATION (default) Displays the version number of the DSR index facility.
/LINES_PER_PAGE=lines
Number of lines of index entries on each index page. Defaults to 55 lines. If the original DSR file specifies other than a layout of 0 (.LAYOUT command) and a page length of 58 (.PAGE SIZE command), you should explicitly specify /LINES_PER_PAGE as follows: page length minus 3, minus 1 if subtitles are used, minus the number of lines reserved by the layout at the bottom of the page.
/LOG
/NOLOG (default) Writes the name of each input file as it is processed and after it is processed, and the name of each output file created. Error messages are always written.
/OUTPUT[=file-spec]
/NOOUTPUT Specifies that an output file is to be produced and optionally names it. The directory and file name default to that of the DSR file. The file type defaults to RNX. If you specify /NOOUTPUT, no output file is produced.
/PAGE_NUMBERS=option
Displays page number references in the index according to the option you specify: +---------------------+------------------------------------+ | RUNNING | Running page numbers (1, 2, 3, and | | | so on). | +---------------------+------------------------------------+ | NORUNNING (default) | Chapter oriented page numbers | | | (1-1, 1-2, and so on). | | | Incompatible with RUNNING. | +---------------------+------------------------------------+
/REQUIRE=file-spec
/NOREQUIRE (default) Substitutes a user heading for the standard heading on the first page of the index. The standard heading is the word INDEX centered on the first line, followed by three blank lines. The substitute heading is contained in the file you specify which can contain DSR commands and text. See also /RESERVE.
/RESERVE=lines
/NORESERVE (default) Reserves space at the top of the first page for a user heading.