Output processorOutput processor commands

Output processor commands

An Output processor command is preceded by a space and a period (the period is part of the command) followed by the characters that make up the command. The Output processor command ends with a space, another Output processor command, or an attribute mark. The Output processor commands are not shown in the formatted and printed text.

Most Output processor commands have a shortcut syntax. The shortcut is referenced with each command.

Syntax

.opcommand[|{.}opcommand)]

Execution of the Output processor commands can be suppressed by utilizing the override character. The default override character is the underscore. When the underscore is placed before the period following the command, the command is not executed but output like normal textual data. To change this character, use the .oc command. If the underscore is to be used in the text, then the override character should be changed.

Margins

The margins define the boundaries in which the Output processor places text.

  • * comment command
    The * command treats the entire line following the asterisk as a remark. Any text following the command is ignored by the Output processor.
  • .appendix command
    The .appendix command alphabetically assigns letters to appendix titles and creates entries in the table of contents.
  • .begin page command (Output processor)
    The .begin page command forces a page break. A page break terminates the current page, prints the optional footing, ejects a page, increments the page counter, and prints the optional heading. The text immediately following the .begin page command is printed on the next page.
  • .block center command
    The .block center command centers all of the attributes following the command until an .xblock center command is issued.
  • .boldface command
    The .boldface command prints text in boldface until an .xboldface command is encountered. If the printer does not have a boldface font, the text is double struck. On terminals boldfaced text is often displayed as reverse-video.
  • .box command (Output processor)
    The .box command draws a box at the column positions specified in the command and overwrites anything that occupies those positions.
  • .break command (Output processor)
    The .break command creates a new paragraph, is surrounded by at least one space, and can be placed anywhere in the text.
  • .cap sentences command
    The .cap sentences command capitalizes the first letter of each sentence or attribute.
  • .center command (Output processor)
    The .center command centers the single line of text that follows the command, can be anywhere in the text, and does not need to be turned off. This command also causes a break (new paragraph) to occur.
  • .chain command (Output processor)
    The .chain command passes control to a specified item-ID in the same (current) file or in a different (file reference) file.
  • .chapter command (Output processor)
    The .chapter command starts a new chapter.
  • .char command
    The .char command sends a raw string of characters to the printer or terminal without translation.
  • .col command
    The .col command uses the column headings and spacing specified with the last .columns set or .variable columns command to determine the position of the specified column number. If the column number is less than the previous column number, the columns are printed and a new paragraph begins. A maximum of seven columns are available.
  • .columns set command
    The .columns set command specifies the column heading, column width, and column spacing.
  • .crt command (Output processor)
    The .crt command directs the output from the Output processor to the terminal, overriding the p option specified at TCL.
  • .cursor command
    The .cursor command outputs the text on the column and row specified.
  • .date command
    The .date command outputs the current system date in the form month day, year.
  • .default command
    The .default command sends the device a control code to select the default font.
  • .em command
    The .em command inserts spaces in output text and is dependent on the printer type.
  • .end case command (Output processor)
    The .end case command disables any previous .upper case or .lower case commands.
  • .figure command
    The .figure command numbers the figures sequentially using the current chapter number followed by a dash and the sequence number within the chapter.
  • .font command
    The .font command selects the font defined in the device item or specifies fonts that are not predefined in the printer item. If the device does not support the fonts or the device item has not been configured, this command has no affect.
  • .footing command (Output processor)
    The .footing command designates a text string composed of literals and special options to output at the bottom of each page. If the line following the .footing command is null, the footing is suppressed.
  • .gohanging tab command
    The .gohanging tab command indents the text to the column set by the previous .ht command.
  • .hanging tab command
    The .hanging tab command sets a tab stop at the column in the text where it is entered.
  • .heading command (Output processor)
    The .heading command designates a text string composed of literals and special options to output at the top of each page. If the line following the .heading command is null, the heading is suppressed.
  • .hilite command (Output processor)
    The .hilite command prints a single character on the right margin and is in effect until an .xhilite command is issued.
  • .indent command (Output processor)
    The .indent command indents the text following the command a specified number spaces from the left margin.
  • .indent margin command (Output processor)
    The .indent margin command adjusts the left margin a specified number of spaces. If the command is in the middle of an attribute, the preceding text is output and the next word begins a new paragraph that is indented number of spaces.
  • .indent rmargin command
    The .indent rmargin command adjusts the right margin a specified number of spaces. If the command is in the middle of an attribute, the preceding text is output and the next word begins a new paragraph with a right margin of the specified number of spaces.
  • .index command (Output processor)
    The .index command inserts a phrase and the current page number into the index. The .index command may be embedded in text, in which case the end of the index text must be indicated by the .xindex command.
  • .index heading command
    The .index heading command substitutes the heading text as the header for index pages. The heading text is output on the top of each index page.
  • .input command (Output processor)
    The .input command accepts and processes text input from the terminal.
  • .italics command
    The .italics command causes the text following the command to be output in italics. If the printer does not support italics, this command has no affect.
  • .justify command (Output processor)
    The .justify command right-aligns each line of text with the right margin by adding spaces in each line to pad to the end of the line. This command stays in affect until an .xjustify command is executed.
  • .left margin command (Output processor)
    The .left margin command sets the left margin at a specific number of spaces from the left edge of the paper and remains in affect until an .im, .left margin, or .standard command is issued.
  • .line length command (Output processor)
    The .line length command sets the line length a specified number of characters from the left margin and remains in affect until changed by another .line length command.
  • .line printer command
    The .line printer command sends all subsequent output to the currently assigned printer.
  • .lower case command (Output processor)
    The .lower case command outputs text in lowercase characters. The .end case command terminates this command.
  • .lpi command
    The .lpi command sets the number of lines per inch for output. If the printer does not support the specified number of lines per inch, this command has no affect.
  • .macro file command
    The .macro file command defines the file name that contains the Output processor macro items. Macros may contain multiple Output processor commands and text.
  • .nofill command (Output processor)
    The .nofill command resets both the justify and fill modes. When using this command, there is no removal of extra spaces, end-of-line marks are not stripped from input, output lines are not filled, and the right margins are not justified. This command creates a break (new paragraph).
  • .over char command
    The .over char command treats all characters that follow it as text.
  • .page length command
    The .page length command sets the page length to the number of lines specified. The physical page length, in terms of inches, can be calculated by the .vmi height of each of the printed lines multiplied by 1/48 of an inch. The length (in inches) of each page can vary as the vertical motion index is changed.
  • .page number command (Output processor)
    The .page number command sets the default page number to a specified integer number.
  • .paging command
    The .paging command pauses at the end of each page when the output is sent to the terminal. At the end of a page of terminal output, any key can be pressed to advance to the next page.
  • .paragraph command (Output processor)
    The .paragraph command specifies the number of spaces to indent the first line of a paragraph.
  • .preface command
    The .preface command sets the automatic preface formatting. If a .preface command has already been issued, the page numbers resume where the last .preface command ended.
  • .prefix page command
    The .prefix page command turns on the prefix page numbering mode, which starts numbering each chapter at page 1.
  • .print index command (Output processor)
    The .print index command prints the index, changes the tab settings, and begins a new page. The index is sorted in alphabetical order and printed in two columns per page. After the index is printed, it is cleared. To save the index in an item for editing, use the .save index command.
  • .print ptoc command
    The .print ptoc command prints a partial table of contents. This includes topics made by these commands encountered since the last .print ptoc command:
  • .print toc
    The .print toc command prints the complete table of contents.
  • .prompt command
    The .prompt command outputs the text on the following line to the terminal. This command is often used with the .input command to prompt for user input.
  • .read command (Output processor)
    The .read command reads an (Output processor) item and outputs the item as part of the current text. At the end of the item, the Output processor continues with the next line following the .read command.
  • .readnext command (Output processor)
    The .readnext command reads data, one value at a time from an active list. It has an affect only if prior to entering the Output processor a select, sselect, qselect, or get-list statement has been executed.
  • .readnext null command
    The .readnext null command reads data from an active list. The .readnext command does not terminate if a list value does not exist.
  • .reset command
    The .reset command resets the printer to its initial state. If the printer does not support reset, this command has no affect.
  • .right margin command
    The .right margin command sets the right margin at a specific number of spaces from the right edge of the paper and remains in affect until an .indent rmargin, .right margin or .standard command is issued.
  • .save contents command
    The .save contents command saves the table of contents to a defined item-ID. The item is saved in the same file as the current document. After saving, the item can be formatted and edited to create a customized table of contents.
  • .save index command (Output processor)
    The .save index command saves the index to a defined item-ID in the same file where the Output processor document resides.
  • .section command (Output processor)
    The .section command produces automatic section numbering and formatting.
  • .set chapter command
    The .set chapter sets the options for chapter headings. This command must precede any .chapter commands.
  • .set section
    The .set section command defines the options for the section headings. This command must precede any .section commands.
  • .skip command (Output processor)
    The .skip command outputs a specific number of blank lines using the current line spacing. The line spacing can be set either by the .spacing command or as part of the statement that invokes the Output processor. If the current line spacing is 2, a .skip command skips four lines.
  • .space command (Output processor)
    The .space command outputs a specific number of blank lines using single-line spacing. This command is independent of the line spacing. To skip lines based on line spacing, use the .skip command.
  • .spacing command (Output processor)
    The .spacing command sets the line spacing to a specific number of lines. This command causes blank lines to be printed in between each line of text.
  • .standard command (Output processor)
    The .standard command defines the default parameter and mode settings for the Output processor text.
  • .subscript command
    The .subscript command moves text down one-half line. Text remains in this position until an .xsubscript command is issued. If the printer cannot move in half lines, this command has no affect.
  • .superscript command
    The .superscript command moves text up one-half line. If the printer cannot move in half lines, this command has no affect. To move the text back down one-half line, use the .xsuperscript command.
  • .tab fill command
    The .tab fill command defines a pattern, which is repeated to fill the line from the current position to the next tab stop. Tab stops must be set prior to using this command (see .tab set command).
  • .tab left command
    The .tab left command moves the word or specified phrase following the command to the next tab position and left-aligns the last character of the word or phrase at the tab position.
  • .tab right command
    The .tab right command moves the word or delimited phrase following the command to the next tab position and right-aligns the last character of the word or phrase at the tab position.
  • .tab rightm command
    The .tab rightm command right-aligns the optional text with the right margin.
  • .tab set command
    The .tab set command defines the location of tab stops. To move the text to these tabs, use the .tl and the .tr commands. Do not use the TAB key.
  • .table command
    The .table command provides automatic table numbering with sequential numbers in the form of a chapter number.
  • .tc heading command
    The .tc heading command substitutes the heading text as the header for the table of contents pages.
  • .tcl box command
    The .tcl box command executes the specified TCL command as part of the output and draws a box around it. This command is similar to the .box command, except that the box parameters cannot be specified. The width of the box is determined by the left and right margins.
  • .tcl command
    The .tcl command executes the specified TCL command and inserts the output in the Output processor document. When the TCL command completes, control returns to the document and continues processing on the following line.
  • .test page command (Output processor)
    The .test page command tests the number of lines left on the current page and determines whether the text is output on the current or next page.
  • .underline command
    The .underline command underlines the text following until an .xul or .x command is encountered. This command underlines spaces as well a words, and works on printers and terminals that support the underline function.
  • .underline words Commands
    The .underline words command underlines all words until an .xuw command is issued.
  • .upper case command (Output processor)
    The .upper case command outputs text in uppercase characters, unless specifically altered by the \ lowercase special control function. The .end case command terminates the .upper case command.
  • .variable columns command
    The .variable columns command specifies parameters for formatting in variable-width multiple columns.
  • .vmi command
    The .vmi command specifies the amount of vertical space each line uses. The .vmi spacing is allocated in 2.08-inch increments, and is essentially the flip side of the .lpi command. For example, if the .lpi is set to 6, the equivalent .vmi setting is 8.
  • .x command
    The .x command turns off the boldface, underline word, underline, and italic modes.
  • .xblock center command
    The .xblock center command turns the block center mode off.
  • .xboldface command
    The .xboldface command turns the boldface mode off.
  • .xbox command
    The .xbox command turns off the .box command and draws the bottom line of the box.
  • .xcap sentences command
    The .xcap sentences command turns off the cap sentences mode.
  • .xcolumns command
    The .xcolumns command turns off the column heading, width, and spacing set by the .columns or .columns set commands.
  • .xhilite command
    The .xhilite command turns off the .hilite or .hi commands.
  • .xindex command
    The .xindex command designates the end of an index topic for a topic embedded in text.
  • .xitalics command
    The .xitalics command turns off the italics mode.
  • .xjustify command
    The .xjustify command turns off the justify mode.
  • .xpaging command
    The .xpaging command turns off the paging option and causes the output to scroll down the terminal.
  • .xparagraph
    The .xparagraph command turns off the paragraph mode.
  • .xpreface command
    The .xpreface command turns off the preface mode.
  • .xprefix page command
    The .xprefix page command turns off the prefix page mode.
  • .xsubscript command
    The .xsubscript command turns off the subscript mode.
  • .xsuperscript command
    The .xsuperscript command turns the superscript mode off.
  • .xul command
    The .xul command turns off the underline mode.
  • .xuw command
    The .xuw command turns off the .underline words command.

Related topics
Output processor
Output processor overview