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.

The following Output Processor commands are presented:

* Comment Command	Treats the entire line following the asterisk as a remark. Any text following the command is ignored by the Output Processor.
.appendix Command	Alphabetically assigns letters to appendix titles and creates entries in the table of contents.
.begin page Command	Forces a page break.
.block center Command	Centers all of the attributes following the command until an .xblock center command is issued.
.boldface Command	Prints text in boldface until an .xboldface command is encountered.
.box Command	Draws a box at the column positions specified in the command and overwrites anything that occupies those positions.
.break Command	Creates a new paragraph, is surrounded by at least one space, and can be placed anywhere in the text.
.cap sentences Command	Capitalizes the first letter of each sentence or attribute.
.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.
.chain Command	Passes control to a specified item-ID in the same (current) file or in a different (file reference) file.
.chapter Command	Starts a new chapter.
.char Command	Sends a raw string of characters to the printer or terminal without translation.
.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.
.columns set Command	Specifies the column heading, column width, and column spacing.
.crt Command	Directs the output from the Output Processor to the terminal, overriding the p option specified at TCL.
.cursor Command	Outputs the text on the column and row specified.
.date Command	Outputs the current system date in the form month day, year.
.default Command	Sends the device a control code to select the default font.
.em Command	Inserts spaces in output text and is dependent on the printer type.
.end case Command	Disables any previous .upper case or .lower case commands.
.figure Command	Numbers the figures sequentially using the current chapter number followed by a dash and the sequence number within the chapter.
.font Command	Selects the font defined in the device item or specifies fonts that are not predefined in the printer item.
.footing Command	Designates a text string composed of literals and special options to output at the bottom of each page.
.gohanging tab Command	Indents the text to the column set by the previous .ht command.
.hanging tab Command	Sets a tab stop at the column in the text where it is entered.
.heading Command	Designates a text string composed of literals and special options to output at the top of each page.
.hilite Command	Prints a single character on the right margin and is in effect until an .xhilite command is issued.
.indent Command	Indents the text following the command a specified number spaces from the left margin.
.indent margin Command	Adjusts the left margin a specified number of spaces.
.indent rmargin Command	Adjusts the right margin a specified number of spaces.
.index Command	Inserts a phrase and the current page number into the index.
.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	Accepts and processes text input from the terminal.
.italics Command	Causes the text following the command to be output in italics.
.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.
.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	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	Sends all subsequent output to the currently assigned printer.
.lower case Command	Outputs text in lowercase characters. The .end case command terminates this command.
.lpi Command	Sets the number of lines per inch for output.
.macro file Command	Defines the file name that contains the Output Processor macro items.
.nofill Command	Resets both the justify and fill modes.
.over char Command	Treats all characters that follow it as text.
.page length Command	Sets the page length to the number of lines specified.
.page number Command	Sets the default page number to a specified integer number.
.paging Command	Pauses at the end of each page when the output is sent to the terminal.
.paragraph Command	Specifies the number of spaces to indent the first line of a paragraph.
.preface Command	Sets the automatic preface formatting.
.prefix page Command	Turns on the prefix page numbering mode, which starts numbering each chapter at page 1.
.print index Command	Prints the index, changes the tab settings, and begins a new page.
.print ptoc Command	Prints a partial table of contents.
.print toc Command	Prints the complete table of contents.
.prompt Command	Outputs the text on the following line to the terminal.
.read Command	Reads an (Output Processor) item and outputs the item as part of the current text.
.readnext Command	Reads data, one value at a time from an active list.
.readnext null Command	Reads data from an active list.
.reset Command	Resets the printer to its initial state.
.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	Saves the table of contents to a defined item-ID.
.save index Command	Saves the index to a defined item-ID in the same file where the Output Processor document resides.
.section Command	Produces automatic section numbering and formatting.
.set chapter command	Sets the options for chapter headings.
.set section Command	Defines the options for the section headings.
.skip Command	Outputs a specific number of blank lines using the current line spacing.
.space Command	Outputs a specific number of blank lines using single-line spacing.
.spacing Command	Sets the line spacing to a specific number of lines.
.standard Command	Defines the default parameter and mode settings for the Output Processor text.
.subscript Command	Moves text down one-half line. Text remains in this position until an .xsubscript command is issued.
.superscript Command	Moves text up one-half line.
.tab fill Command	Defines a pattern, which is repeated to fill the line from the current position to the next tab stop.
.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	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	Right-aligns the optional text with the right margin.
.tab set Command	Defines the location of tab stops.
.table Command	Provides automatic table numbering with sequential numbers in the form of a chapter number.
.tc heading Command	Substitutes the heading text as the header for the table of contents pages.
.tcl box Command	Executes the specified TCL command as part of the output and draws a box around it.
.tcl Command	Executes the specified TCL command and inserts the output in the Output Processor document.
.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	Underlines the text following until an .xul or .x command is encountered.
.underline words Command	Underlines all words until an .xuw command is issued.
.upper case Command	Outputs text in uppercase characters, unless specifically altered by the \ lowercase special control function.
.variable columns Command	Specifies parameters for formatting in variable-width multiple columns.
.vmi Command	Specifies the amount of vertical space each line uses.
.x Command	Turns off the boldface, underline word, underline, and italic modes.
.xblock center Command	Turns the block center mode off.
.xboldface Command	Turns the boldface mode off.
.xbox Command	Turns off the .box command and draws the bottom line of the box.
.xcap sentences Command	Turns off the cap sentences mode.
.xcolumns Command	Turns off the column heading, width, and spacing set by the .columns or .columns set commands.
.xhilite Command	Turns off the .hilite or .hi commands.
.xindex Command	Designates the end of an index topic for a topic embedded in text.
.xitalics Command	Turns off the italics mode.
.xjustify Command	Turns off the justify mode.
.xpaging Command	Turns off the paging option and causes the output to scroll down the terminal.
.xparagraph Command	Turns off the paragraph mode.
.xpreface Command	Turns off the preface mode.
.xprefix page Command	Turns off the prefix page mode.
.xsubscript Command	Turns off the subscript mode.
.xsuperscript Command	Turns off the superscript mode.
.xul Command	Turns off the underline mode.
.xuw Command	Turns off the .underline words command.