Updated: 11 December 1998

OpenVMS User's Manual

The following table describes commands and keys that can be used to define keys:

Keypad Mode	Line Mode	Nokeypad Mode	Description
		BELL	Causes the terminal bell to sound when a command is processed. Used primarily in keypad key definitions.
Ctrl/K	DEFINE KEY	DEFK	Defines or redefines function keys used in keypad editing. Key definitions are based on nokeypad commands. In keypad mode, Ctrl/K starts the key definition process. In nokeypad mode, you can define a key sequence other than Ctrl/K to handle the key definition process.
	SHOW KEY		Displays the definition of any keys that have keypad editing functions.
	SET [NO]KEYPAD SHOW KEYPAD		Determines which screen editing mode (keypad or nokeypad) EDT accesses from line mode when you enter the CHANGE command. SHOW KEYPAD indicates which mode is in effect.

9.8.12 Controlling Screen and Terminal Settings

The following table describes commands and keys that can be used to control the EDT screen and terminal settings:

Keypad Mode	Line Mode	Nokeypad Mode	Description
[Return]			Adds a line terminator to the left of the current cursor position in the text you are editing.
	SET [NO]AUTOREPEAT		Prevents keypad keys (including arrow keys) from repeating faster than EDT can update the screen.
	SHOW AUTOREPEAT		Indicates whether autorepeat is in effect.
	SET LINES		Limits the number of lines that EDT displays on the terminal screen at one time.
	SHOW LINES		Displays the line limit.
	SET [NO]NUMBERS		Determines whether EDT displays line numbers during line-mode editing.
	SHOW NUMBERS		Displays the current setting.
	SET PARAGRAPH [NO]WPS		Sets paragraph default boundary limits.
	SHOW PARAGRAPH		Indicates whether SET PARAGRAPH WPS or SET PARAGRAPH NOWPS is in effect.
	SET [NO]QUIET		Silences the terminal bell that ordinarily sounds whenever EDT displays an error message during a screen-mode editing session.
	SHOW QUIET		Indicates whether the bell has been turned off.
	SET [NO]REPEAT		Disallows use of the GOLD key repeat feature, which allows you to repeat functions in keypad mode, and the SPECINS keypad function.
	SHOW SCREEN		Displays the current screen width setting.
	SET TERMINAL SHOW TERMINAL		Corrects or changes terminal settings to match the type of terminal you are using. SHOW TERMINAL displays the terminal settings that are currently in effect for your editing session.
	SET TERMINAL		Corrects or changes terminal settings to match the type of terminal you are using.
	SHOW TEXT		Indicates what text is displayed for the form-feed character or the end-of-buffer mark.
	SET [NO]TRUNCATE		Causes lines longer than the current screen width to wrap onto subsequent lines when you are working in screen mode. (In line mode, EDT always wraps long lines.) SET TRUNCATE does not take word boundaries into consideration; enter SET WRAP to break lines at word boundaries.
	SHOW TRUNCATE		Indicates whether SET TRUNCATE is in effect.
	SET WORD [NO]DELIMITER		Determines how word entity boundaries are interpreted by EDT. By default, word delimiters are treated as separate words (SET WORD DELIMITER).
	SHOW WORD		Indicates whether SET WORD NODELIMITER is in effect.
	SET [NO]WRAP		Causes lines of text to wrap when new text is inserted into a buffer in keypad mode. The SET WRAP command also determines the line length for the FILL command.
	SHOW WRAP		Indicates whether the SET WRAP command is in effect and, if so, what the SET WRAP value is.

9.8.13 Processing EDT Commands

The following table describes commands and keys that can be used to process EDT commands:

Keypad Mode	Line Mode	Nokeypad Mode	Description
Ctrl/C	Ctrl/C	Ctrl/C	Interrupts certain operations (such as a search through a long file) before EDT finishes processing them.
Do (LK201 only)	Return	Period (.)	Processes searches and line editing commands.
Enter	Return	Return	Processes searches, line editing commands, and key definitions.
	SET ENTITY		Defines the delimiters that mark the word, sentence, paragraph, and page boundaries for commands and functions.
	SHOW ENTITY		Lists the current delimiters.
	SET COMMAND		Processes additional startup command files at the beginning of your EDT session. This command is valid only in an EDT startup command file.
	SHOW COMMAND		Displays the name of the active startup command file. This command is valid only in an EDT startup command file.
	SET [NO]VERIFY SHOW VERIFY		Displays the commands in a startup command file or EDT macro as the commands are processed. SHOW VERIFY indicates whether SET VERIFY is in effect.

9.8.14 Other EDT Commands

The following table describes miscellaneous commands and keys available in EDT:

Keypad Mode	Line Mode	Nokeypad Mode	Description
		DATE	Inserts the current date into your text.
	DEFINE MACRO		Creates new line-mode commands for the duration of your editing session.
	EXIT		Creates an external file, copies the contents of the MAIN buffer into that file, and ends the editing session.
GOLD			Performs various editing functions when used with other keypad and keyboard keys.
Help	Help	Help	In keypad and line modes, accesses the EDT Help utility. In nokeypad mode, defines a different key or key sequence in keypad mode to carry out the keypad Help function.
	PRINT		Copies the specified range of lines or specified buffer to an external file in a specified directory. EDT adds a form feed and two blank lines for every 60 lines it copies. The EDT line numbers become part of the text in the external file.
	QUIT	QUIT	Ends the session without copying text to an external file.
	RESEQUENCE		Assigns new EDT line numbers to the lines of the current or specified buffer.
	SHOW FILES		Displays the current input file and output file for your EDT session.
	SET [NO]FNF		Suppresses the message that appears when you use EDT to create a new file (FNF stands for File Not Found). This command is used only in startup command files.
	SHOW FNF		Indicates whether SET FNF or SET NOFNF is in effect. This command is used only in startup command files.
	SET HELP		Enables you to access different help files for your EDT session.
	SHOW HELP		Displays the name of the help file currently available for your editing session.
	SET [NO]SUMMARY SHOW SUMMARY		Suppresses summary information displayed when you enter the EXIT or WRITE commands. By default, EDT displays the complete file specification and number of lines in the file that EDT has created as a result of entering the EXIT or WRITE command. SHOW SUMMARY indicates whether the SET SUMMARY command is in effect.
	SHOW VERSION		Displays the version of EDT that is being used by your operating system.
	TYPE		Displays lines of text at your terminal.
	WRITE		Copies text from an EDT buffer to an external file.
		XLATE	Passes information back to the calling program. You can enter this command when EDT has been called by a running program.

DIGITAL Standard Runoff (DSR) is a text-formatting facility. This chapter describes:

• Entering DSR commands
• Invoking DSR
• Creating tables of contents
• Creating indexes
• Summary of DSR commands

For additional information about DSR, refer to the OpenVMS DIGITAL Standard Runoff Reference Manual or DCL Help for a complete description of the RUNOFF commands and qualifiers. Please note that the OpenVMS DIGITAL Standard Runoff Reference Manual is archived and no longer available with the OpenVMS Documentation set. This manual has been included in Bookreader and PostScript format on the OpenVMS Version 7.2 Documentation CD.

10.1 About DSR

By inserting DSR commands, control characters, and other special identifiers within a text file, you can use DSR to:

• Determine the size of pages
• Create uneven or justified right margins
• Place space between lines
• Form lists
• Create title pages, footnotes, tables of contents, indexes, and appendixes

The steps for formatting a file with DSR are as follows:

Step	Task
1	Create the source file with EDT, EVE, or another text editor. By default, the DSR source file has the file type .RNO.
2	Enter DSR commands, flags, and control characters within the source file to indicate how the file is to be formatted. DSR flags are special characters that you insert in text to specify emphasis of text, case of characters, spacing of characters, and so forth.
3	Process the file with the DCL command RUNOFF. When DSR processes the source file, the DSR commands cause the text to be formatted into sections, paragraphs, lists, and so on. Neither the DSR commands nor the DSR flags appear in the final document.

10.2 Entering DSR Commands in Source Files

To enter a DSR command, create the source file with EDT, EVE, or another text editor. Begin the command in column 1 of a line and precede the command with a period. Most DSR commands have standard abbreviations. For example, you can abbreviate the .NO CONTROL CHARACTERS command as .NCC.

The following example shows how to insert a blank line between two lines of text:

We sail the ocean blue, .BLANK And our saucy ship's a beauty.

10.3 Invoking DSR

After you add DSR commands to your file and exit from the editor, you are ready to process the file with DSR. To invoke DSR, enter the RUNOFF command followed by the name of the file you want to process.

If you process a file with the file type .RNO, you need only to enter the file name, not the file type. By default, the RUNOFF command produces an output file with the same file name as the input file and the file type .MEM.

Both of the following examples produce output files named FUN.MEM.

• In the following example, a file named FUN.RNO is processed:

  $ RUNOFF FUN

• In the following example, a file named FUN.FUN is processed (both the file name and the file type are specified):

  $ RUNOFF FUN.FUN

By using qualifiers with the RUNOFF command, you can override DSR commands or flags included in your text file. RUNOFF command qualifiers allow you to alter the position of the text on all pages of the document, to specify emphasis such as underlining and bolding, and to otherwise control the appearance of printed output.

In the following example, the /NOBOLD qualifier suppresses any bolding specified in the file by using the DSR command .FLAGS BOLD:

$ RUNOFF/NOBOLD FUN

Table 10-1 summarizes the RUNOFF command qualifiers.

Table 10-1 RUNOFF Command Qualifiers

Qualifier	Description
/BACKSPACE	Uses the Backspace character to bold, overstrike, or underline text as it is printed. This generally gives more exact underlining and bolding for files printed on letter-quality printers. The /BACKSPACE qualifier is not recommended for line printers.
/[NO]BOLD	Enables and disables bolding. Any bolding specified in chapter and header titles appears in the table of contents.
/[NO]CHANGE_BARS	Enables and disables the appearance of change bars in the output file.
/CONTENTS	Generates a table of contents. (See Section 10.4.)
/[NO]DEBUG	Traces the operation of certain DSR commands by causing the commands to appear in the output file.
/DEVICE	Specifies printing options.
/DOWN	Specifies the number of blank lines to be inserted at the top of each page, preceding any header information.
/INDEX	Generates an index. (See Section 10.5.)
/FORM_SIZE	Controls the number of lines that can be accommodated per page of output.
/[NO]INTERMEDIATE	Generates an intermediate binary file with the default file type .BRN for use with the DSR Table of Contents utility and the DSR Indexing utility.
/[NO]LOG	Controls whether or not DSR displays processing information at your terminal.
/MESSAGES	Lets you specify whether you want error messages displayed on your terminal or in an output file only. By default, DSR displays messages in both places.
/[NO]OUTPUT	Specifies the name of the output file produced by DSR.
/PAGES	Limits the output file to a specified range of pages.
/[NO]PAUSE	Controls whether DSR pauses after printing each page of output.
/REVERSE_EMPHASIS	Specifies that underlining of flagged text is to be done after the text is printed. By default, the printer prints the underscores, issues a carriage return without a line feed, then prints the flagged text above the underscores.
/[NO]RIGHT	Causes the text on each page to be shifted to the right.
/SEPARATE_UNDERLINE	Underlines text by using separate characters on the next line instead of overprinting with underscores on the same line.
/[NO]SEQUENCE	Controls whether DSR outputs line numbers from the input file.
/[NO]SIMULATE	Controls whether blank lines or form feeds are used to advance to the top of each page.
/[NO]UNDERLINE_CHAR	Allows you to specify the character to be used for underlining of flagged text.
/VARIANT	Controls the execution of the condition commands (.IF, .IFNOT, .ELSE, .ENDIF) by specifying the names of the segments to be processed.

10.3.2 Using DSR Defaults

When you use DSR to process a file, your output file looks different from your input file because DSR provides the following standard format default settings:

• A standard typewriter page size of 8 1/2 x 11 inches; that is, a width of 70 character positions and a length of 58 lines of text per page (.PAGE SIZE 58,70)
• Sequential page numbering for every page but the first (.PAGING)
• A left margin setting of 0 (just before the first character position of a line) and a right margin setting of 70 (just after the 70th character position of a line) (.LEFT MARGIN 0 and .RIGHT MARGIN 70)
• Line spacing equivalent to the single-space setting on a typewriter (.SPACING 1)
• A tab setting every eighth character position on a line (.TAB STOPS 8, 16, 24, ...)
• Filling: DSR fills each line with as many words as possible until the addition of another complete word would exceed the right margin (.FILL)
• Justification: DSR adds spaces between words to expand each line exactly to the right margin, making the right margin even or justified (.JUSTIFY)

If you do not want your file to be formatted according to the DSR default commands (shown in parentheses in the preceding list), you must disable them. Refer to the OpenVMS DIGITAL Standard Runoff Reference Manual for a complete list of the default commands provided by DSR and the commands you need to disable them. (Available on our documentation CD in Bookreader or PostScript.)

Copyright © Compaq Computer Corporation 1998. All rights reserved. Legal

6489PRO_021.HTML