Runoff commands

The .b command outputs a partially filled line before processing the next line.

The .begin page command executes a .break command followed by an advance to a new page. The page number is incremented and the page heading (if set) is printed.

The .box command defines the left and right margin boundaries for a box around the text, and encloses the following text in a box of vertical bars on the output page. The .box off command turns off the box effect previously started with a .box command.

The .break command creates a new paragraph.

The .capitalize sentences command capitalizes sentences following a period, exclamation point, question mark, colon, or a semicolon that is followed by one or more spaces. If the first word of the sentence is already capitalized, it remains capitalized. The .nocapitalize sentences command disables the .capitalize sentences command.

The .center command outputs the next line of the document in nofill mode and centers it on the next line of output. This command causes a break (new paragraph) to occur.

The .chain command transfers control to the specified item-ID.

The .chapter command ejects a page, increments the page and chapter counters, and outputs the literal, Chapter, followed by the optional text, centered between the current margins. The chapter, page number, and text are accumulated for the table of contents.

The .contents command outputs the current table of contents, as defined by the previous .chapter and .section commands.

The .crt command directs text unconditionally to the terminal screen.

The .end case command disables any previous .upper case or .lower case commands.

The .fill command enters line fill mode. Words are processed until there are enough to fill a line without overflowing it. If justification mode is on, Runoff inserts spaces in the line at random to make the right margin line up.

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. The .footing command places the footing text in a buffer and is only processed during a break page, either explicitly with a .bp command or by data.

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. The .heading command places the heading text in a buffer and is only processed during a break page, either explicitly with a .bp command or by data.

The .hilite command prints the optionally-specified character along the right margin. If the character is omitted, or the word off displays after the command, the .hilite command is disabled. The .hilite off command terminates the .hilite command.

The .indent command indents the text following the command a specified number of spaces from the left margin.

The .indent margin command increments the left margin by the specified number of spaces.

The .index command places the text and the current page number into the document’s index.

The .input command accepts and processes text input from the terminal. The text entered is output as though it had been stored in the document.

The .justify command enables the .fill and .justify commands. The .justify command is one of the .standard command settings. The .nojustify command terminates the .justify command.

The .left margin command sets the left margin at a specific number of spaces from the left edge of the paper. The left margin is automatically set to 0 in the .standard command.

The .line length command sets the line length a specified number of characters from the left margin. Line length is automatically set to 70 in the .standard command.

The .lower case command outputs text in lowercase characters. The .end case command terminates this command.

The .lptr command directs output to the system printer, via the Spooler.

The .lx command sets the auto-tab to a specified column number.

The .nocapitalize sentences command deactivates the automatic capitalization of sentences mode.

The .nofill command resets both the justify and fill modes. Removal of extra spaces does not take place, and end-of-lines are not stripped from the input. Output lines are not filled nor are right margins justified. The .nofill command causes a break (new paragraph).

The .nojustify command disables the justification mode. The fill mode remains in effect.

The .noparagraph command turns off the .paragraph command.

The .page number command sets the current page number to a specified number.

The .paper length command specifies the maximum number of print lines per output page.

The .paragraph command specifies the number of spaces for paragraph indentation. Any blank line or any line beginning with a space is indented the specified number of spaces.

The .pfile command creates a separate Spooler entry containing the table of contents created with the .contents command. The .pfile command directs subsequent output to the specified print file number, just like the print on statement in FlashBASIC.

The .print command prints the next line of text on the terminal. This command is used in conjunction with the .input command.

The .print index command prints the sorted index of words and page numbers. The index is sorted in alphabetical order, and printed two columns per page. The .print index command changes the tab settings, and issues a .begin page command.

The .read command transfers control to the specified Runoff item for output and returns control upon completion.

The .readnext command extracts the top entry of an active list created by one of the list-generating commands prior to output and inserts the value into the text of the item.

The .save index command saves entries defined in previous .index commands in the specified file reference, using the item-ID of the current Runoff item. The file reference of the index must be different than the current file reference to avoid destroying data. This command causes chapter and page number information of indexed data in a text to be saved in a separate file. Each index entry is stored as an individual item using the index entry as the item-ID, the chapter (where that index entry is referenced) as the first attribute and the page number as the second attribute. Multiple values are stored in these attributes as multiple references to the same index entry. The resulting file may then be operated on by the AQL processor to generate listings for the chapter and page number information of all indexed data in a text. The .save index command is placed in the text item itself and must precede the .index commands. Only indexed data that has been preceded by the .save index command is saved in the specified file.

The .section command handles automatic chapter section numbering and formatting, in conjunction with the .chapter command.

The .set tabs command clears previous tab stops and specifies tab stop locations at specified column position.

The .skip command outputs a specific number of blank lines on a page, taking into account any previously specified .spacing commands.

The .space command outputs a specific number of blank lines on a page, regardless of any previously specified .spacing commands.

The .spacing command specifies interline spacing to the specified number of lines.

The .standard command defines the default parameter and mode settings for Runoff text.

The .test page command tests the number of lines left on the current page and determines whether text is output on the current or next page.

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.