Digital PDFs

AA-Z301B-TE

July 1985

244 pages

Original

24MB

Document:	VAX DIGITAL Standard Runoff DSR Reference Manual folal t LR P SR j oy Revision Undate intorimation THis eved GOLment supeisades e v AX OIGTAL Sianaard Hune DSR User Curde
Order Number:	AA-Z301B-TE
Revision:
Pages:	244
Original Filename:	https://archive.org/download/stx_AA-Z301B-TE_VMS_4.2_VAX_DIGITAL_Standard_Runoff_DSR_Reference_Manual_Jul85/AA-Z301B-TE_VMS_4.2_VAX_DIGITAL_Standard_Runoff_DSR_Reference_Manual_Jul85.pdf

OCR Text

VAX
DIGITAL Standard
Runoff (DSR) Reference
Manual
Order Number: AA-Z301B-TE

July 1985

This manual documents the VAX DIGITAL Standard Runoff (DSR)
text-formatting utility.

Revision/Update Information:

This revised document supersedes
the VAX-11 DIGITAL Standard
Runoff (DSR) User's Guide (Order No.
AA-Z301A-TE).

Software Version:

VAX/VMS Version 4.2

digital equipment corporation
maynard, massachusetts

July 1985

The information in this document is subject to change without notice and should
not be construed as a commitment by Digital Equipment Corporation. Digital
Equipment Corporation assumes no responsibility for any errors that may appear
in this document.
The software described in this document is furnished under a license and may be
used or copied only in accordance with the terms of such license.
No responsibility is assumed for the use or reliability of software on equipment
that is not supplied by Digital Equipment Corporation or its affiliated companies.

Copyright ©1985 by Digital Equipment Corporation
All Rights Reserved.
Printed in U.S.A.
The postpaid READER'S COMMENTS form on the last page of this document
requests the user's critical evaluation to assist in preparing future documentation.
The following are trademarks of Digital Equipment Corporation:
DEC
DEC/CMS
DEC/MMS
DECnet
DECsystem-10
DECSYSTEM-20
DECUS
DECwriter

DIBOL
EduSystem
IAS
MASSBUS
PDP
PDT
RSTS
RSX

UNIBUS
VAX
VAXcluster
VMS
VT

SDSDEED
ZK-2816

This document was prepared using an in-house documentation production system. All
page composition and make-up was performed by T^X, the typesetting system developed
by Donald E. Knuth at Stanford University. T^X is a registered trademark of the American
Mathematical Society.

Contents
PREFACE

xiii

SUMMARY OF TECHNICAL CHANGES

SECTION 1

INTRODUCTION

1-1

1.1 OVERVIEW

1-1

1.2 DSR COMMAND FORMAT

1-2

1.3 ENTERING DSR COMMANDS
1.3.1
Separating Command Arguments _
1.3.2
Entering Null Arguments _
1.3.3
Abbreviating DSR Commands _

1-2
1-3
1 -4
1 -4

1.4

DSR COMMAND DEFAULTS

1-5

1.5

PRINTING DSR OUTPUT FILES
1.5.1
DSR Form Feeds _
1.5.2
Print Symbiont Form Feeds _
1.5.3
Printer Driver Form Feeds _
1.5.4
Printer Device Form Feeds _

1-5
1-5
1-6
1-7
1-7

DSR COMMANDS

2 1

SECTION 2

.APPENDIX
.AUTOJUSTIFY AND .NO AUTOJUSTIFY
.AUTOPARAGRAPH AND
.NO AUTOPARAGRAPH
.AUTOSUBTITLE AND .NO AUTOSUBTITLE
.AUTOTABLE AND .NO AUTOTABLE
BLANK

2-2
2-3
2-4
2-6
2-7
2-9

.BREAK
.CENTER (.CENTRE)

2-10
2-11

.CHAPTER
.CONTROL CHARACTERS AND .NO CONTROL
CHARACTERS
.DATE AND .NO DATE

2-13
2-14
2-15
iii

Contents

DISPLAY APPENDIX
DISPLAY CHAPTER

2-18

.DISPLAY ELEMENTS

2-20

DISPLAY LEVELS

2-22

.DISPLAY NUMBER

2-24

DISPLAY SUBPAGE

2-25

■ ENABLE BAR, .DISABLE BAR, .BEGIN BAR,
AND .END BAR

2-26

.ENABLE BOLDING AND .DISABLE BOLDING

2-29

.ENABLE HYPHENATION AND .DISABLE
HYPHENATION

2-30

.ENABLE INDEXING AND .DISABLE
INDEXING

2-31

■ ENABLE OVERSTRIKING AND .DISABLE
OVERSTRIKING

2-32

.ENABLE TOC AND .DISABLE TOC

2-33

.ENABLE UNDERLINING AND .DISABLE
UNDERLINING

2-34

.ENTRY

2-35

.FIGURE DEFERRED AND .FIGURE
.FILL AND .NO FILL

2-36
2-39

.FIRST TITLE

2-40

■ FLAGS ALL AND .NO FLAGS ALL

2-41

FLAGS ACCEPT AND .NO FLAGS ACCEPT

2-42

.FLAGS BOLD AND .NO FLAGS BOLD

2-43

.FLAGS BREAK AND .NO FLAGS BREAK

2-44

.FLAGS CAPITALIZE AND .NO FLAGS
CAPITALIZE
.FLAGS COMMENT AND .NO FLAGS
COMMENT

2-45
2-46

.FLAGS CONTROL AND .NO FLAGS
CONTROL

2-47

.FLAGS HYPHENATE AND .NO FLAGS
HYPHENATE

2-48

.FLAGS INDEX AND .NO FLAGS INDEX

2-49

.FLAGS LOWERCASE AND .NO FLAGS
LOWERCASE
.FLAGS OVERSTRIKE AND .NO FLAGS
OVERSTRIKE
.FLAGS PERIOD AND .NO FLAGS PERIOD
.FLAGS SPACE AND .NO FLAGS SPACE
.FLAGS SUBINDEX AND .NO FLAGS
SUBINDEX

2-16

2-50
2-51
2-52
2-53
2-54

.FLAGS SUBSTITUTE AND .NO FLAGS
SUBSTITUTE

2-55

.FLAGS UNDERLINE AND .NO FLAGS
UNDERLINE

2-56

Contents

.FLAGS UPPERCASE AND .NO FLAGS
UPPERCASE

2-57

.FOOTNOTE AND .END FOOTNOTE

2-58

.HEADER LEVEL

2-60

.HEADERS ON AND .NO HEADERS

2-63

.HEADERS UPPER, .HEADERS LOWER, AND
.HEADERS MIXED

2-65

.IF, .IFNOT, .ELSE, AND .ENDIF

2-66

.INDENT

2-69

.INDEX

2-70

JUSTIFY AND .NO JUSTIFY

2-71

.KEEP AND .NO KEEP

2-73

LAYOUT

2-75

.LEFT MARGIN

2-78

.LIST AND .END LIST

2-79

LIST ELEMENT

2-82

.LITERAL

2-84

NO SPACE

2-85

.NOTE AND .END NOTE

2-87

.NUMBER APPENDIX

2-88

.NUMBER CHAPTER

2-89

.NUMBER LEVEL
NUMBER LIST

2-90
2-91

.NUMBER PAGE AND .NO NUMBER

2-92

.NUMBER RUNNING

2-93

.NUMBER SUBPAGE

2-94

.PAGE

2-95

.PAGE SIZE

2-96

.PAGING AND .NO PAGING

2-98

.PARAGRAPH
.PERIOD AND NO PERIOD

2-99
2-101

.REPEAT
.REQUIRE
.RIGHT
.RIGHT MARGIN

2-103
2-104
2-105
2-106

.SAVE AND .RESTORE

2-107

.SEND TOC
.SET DATE AND .SET TIME

2-108
2-110

.SET LEVEL
.SET PARAGRAPH

2-112
2-115

.SKIP

2-116

.SPACING
.STYLE HEADERS
.SUBPAGE AND END SUBPAGE

2-117
2-118
2-120
v

Contents

SUBTITLE AND .NO SUBTITLE

2-121

.TAB STOPS

2-123

.TEST PAGE

2-125

.TITLE

2-127

.VARIABLE

2-128
2-132

.XLOWER AND .XUPPER

SECTION 3
3.1

DSR FLAGS

3-1

DSR FLAG CHARACTERS

3-1

3.1.1

Entering Flag Characters

3-1

3.1.2

Using Multiple Flag Characters

3-2

DSR COMMANDS THAT CONTROL FLAGS
Recognition of Flag Characters
3.2.1
3.2.2
Enabling of Flag Actions
Redefining Flag Characters
3.2.3

3-2
3-2
3-3
3-3

THE ACCEPT FLAG (_)

3-5

THE BOLD FLAG {*)

3-6

THE BREAK FLAG (1)

3-7

THE CAPITALIZE FLAG ( < )

3-8

THE COMMENT FLAG (!)

3-9

THE CONTROL FLAG (.)

3-10

THE HYPHENATE FLAG (=)
THE INDEX FLAG (> )

3-11
3-12

THE LOWERCASE FLAG (\)

3-13

THE OVERSTRIKE FLAG (%)

3-14

THE PERIOD FLAG (+)

3-15

THE SPACE FLAG (#)
THE SUBINDEX FLAG (> )

3-16
3-17

THE SUBSTITUTE FLAG PAIR ($$)

3-18

THE UNDERLINE FLAG (&)
THE UPPERCASE FLAG (")

3-19
3-21

Contents

SECTION 4

RUNOFF COMMAND QUALIFIERS

4-1

4.1 INPUT AND OUTPUT FILE SPECIFICATIONS

4-1

4.2 HOW TO RUN DSR
4.2.1
Output to Disk _
4.2.2
Output to Terminal _
4.2.3
Input from Terminal _
4.2.4 Terminal Input and Output _

4-1
4-2
4-2
4-2
4-3

4.3

4-3

RULES FOR COMMAND QUALIFIERS

4.4 COMMAND QUALIFIERS
/BACKSPACE
/BOLDMMUMBER] AND /NOBOLD
/CHANGE_BARS[="CHARACTER"] AND
/NOCHANGE—BARS
/DEBUG[=(OPTION[,...])] AND /NODEBUG
/DEVICE=(OPTION[,...])
/DOWN-NUMBER
/FORM_SIZE=NUMBER
/INTERMEDIATE[=FILE-SPEC] AND
/NOINTERMEDIATE
/LOG AND/NOLOG
/MESSAGES=OPTION
/OUTPUT=FILE-SPEC AND /NOOUTPUT
/PAGES=STRING
/PAUSE AND /NOPAUSE
/REVERSE_EMPHASIS
/RIGHT[=NUMBER] AND /NORIGHT
/SEPARATE_UNDERLINE[="CHARACTER"]
/SEQUENCE AND /NOSEQUENCE
/SIMULATE AND /NOSIMULATE
/UNDERLINE_CHARACTER[="CHARACTER"]
AND /NOUNDERLINE
/VARIANT=STRING

4-4
4-5
4-6
4-7
4-8
4-9
4-12
4-13
4-14
4-15
4-16
4-17
4-18
4-19
4-20
4-21
4-22
4-23
4-24
4-25
4-26

vii

Contents

THE DSR TABLE OF CONTENTS UTILITY

5 1

5.1

FEATURES OF THE TABLE OF CONTENTS UTILITY

5-1

5.2

PRODUCING A TABLE OF CONTENTS
5.2.1
Process the RNO file with RUNOFF/INTERMEDIATE _
5.2.2
Process the BRN file with the Table of Contents Utility
5.2.3
Process the RNT file with RUNOFF

5-1
5-2
5-2
5-3

5.3

RUNOFF/CONTENTS COMMAND QUALIFIERS

5-3

5.4

RUNOFF/CONTENTS COMMAND LINE EXAMPLES

5-6

THE DSR INDEXING UTILITY

6-1

FEATURES OF THE DSR INDEXING UTILITY
6.1.1
Punctuation of Index Entries
6.1.2
Case Control of Index Entries
6.1.3
Merging of Index Entries
6.1.3.1
Case Merging • 6-2
6.1.3.2
Emphasis Merging • 6-3
6.1.4
Merging of Page Number References
6.1.5
Sorting of ENTRY (.Y) Entries

6-1
6-1
6-1
6-2

PRODUCING AN INDEX
6.2.1
Enter Indexing Commands in the RNO File
6.2.2
Process the RNO file with RUNOFF/INTERMEDIATE
6.2.3
Process the BRN file with the Indexing Utility
6.2.4
Process the RNX file with RUNOFF

6-3
6-4
6-5
6-5
6-6

SECTION 5

SECTION 6
6.1

6.2

6-3
6-3

6.3

RUNOFF/INDEX COMMAND QUALIFIERS

6-6

6.4

RUNOFF/INDEX COMMAND LINE EXAMPLES

6-9

Contents

APPENDIX A

DSR COMMANDS ORGANIZED BY FUNCTION

A-1

A.1

PAGE-FORMATTING COMMANDS
A.1.1
Page Size and Running Heads _
A.1.2
Paging and Page-Number Control _
A.1.3
Subpaging ___

A-1
A-1
A-1
A-1

A.2

TEXT-FORMATTING COMMANDS
A.2.1
Margin Setting _
A.2.2
Filling and Justifying _
A.2.3
Vertical Spacing ___
A.2.4
Horizontal Spacing _
A.2.5
Paragraph Formatting _
A.2.6
Text Emphasis _
A.2.7
Figures _.
A.2.8
Lists _
A.2.9
Notes and Footnotes _

A-2
A-2
A-2
A-2
A-2
A-3
A-3
A-3
A-3
A-3

A.3

SECTION-FORMATTING COMMANDS
A.3.1
Appendixes and Chapters _
A.3.2
Sections __
A.3.3
Indexes _
A.3.4 Tables of Contents _

A-3
A-4
A-4
A-4
A-4

A.4

FLAG-RECOGNITION COMMANDS

A-5

A.5

MISCELLANEOUS COMMANDS

A-5

APPENDIX B

B.1

B.2

REQUIREMENTS FOR PRINTING LNI FILES
ON AN LN01 LASER PRINTER
LN01 FONT KITS FOR LNI FILES
B.1.1
Directory Listing of Font Files

DSR FONT DEFINITIONS FOR LNI FILES
B.2.1
Loading DSR Font Definitions into the Device Control
Library _

B-1

B-1
B-2

B-4
B-5

Contents

EXAMPLES
2-1
2-2
2-3
2—4
2-5
2-6
2-7
2-8
2-9
2—10
2—11
2-12
2—13
2-14
2-15
2-16
2-17
2-18
2-19
2—20
2-21
2-22
2-23
2-24
2-25
2-26
6—1
6—2
B—1
B—2
B—3

.AUTOPARAGRAPH _
.AUTOTABLE _
.CONTROL CHARACTERS _
.DISPLAY APPENDIX _
.DISPLAY CHAPTER _
NUMBERING ELEMENTS IN A LIST _1_
BAR COMMANDS _
.FIGURE and .FIGURE DEFERRED _
Header Levels in a Chapter-Oriented Document _
Long Header Level Text _
Conditional Commands _
.INDEX entries _
Justified Text and Unjustified Text _
.KEEP _
.LAYOUT 0 (Default) _
.LAYOUT 1.2 _
.LAYOUT 2,2 (Even Page) _
LAYOUT 2,2 (Odd Page) _
.LAYOUT 3,2 _
Default List Format _
.NO SPACE _
.PERIOD _
.SEND TOC _
.SET LEVEL _
.TEST PAGE _
.VARIABLE _
Input File with Indexing Commands _
Sample Index _
Directory Listing for Courier (10 pitch) _
DSR Modules in the Device Control Library _
Command Procedure for Loading Font Definitions _

2-5
2-8
2-14
2-17
2-19
2-21
2-27
2-37
2-62
2-62
2-68
2-70
2-72
2-74
2-76
2-76
2-76
2-77
2-77
2-81
2-86
2-102
2-109
2-113
2-126
2-129
6-4
6-5
B-2
B-4
B-5

FIGURES
1—1

DSR Command Format

1-2

Contents

TABLES
3- 1
4- 1

DSR Flags _
/RIGHT Default Values with /DEVICE=LIM01 [E],LIM03

3-1
4-21

Preface

Intended Audience
This manual is intended for users of the VAX/VMS operating system who
need to format documents. Users are expected to have some familiarity with
VAX/VMS system concepts and to know how to use a text editor (such as
EDT).

Structure of This Document
This manual contains six sections and two appendixes.
•

Section 1, Introduction, provides an overview of DSR, describes terms and
conventions used in DSR, and gives some simple examples to introduce
the user to a few DSR commands and flags.

•

Section 2, DSR Commands, describes all of the DSR commands.

•

Section 3, DSR Flags, describes all of the DSR flags.

•

Section 4, RUNOFF Command Qualifiers, explains how to run DSR and
describes all of the command line qualifiers.

•

Section 5, The DSR Table of Contents Utility, describes the features of
the Table of Contents utility, how to produce a table of contents, and
contains the RUNOFF/CONTENTS command qualifiers and command
line examples.

•

Section 6, The DSR Indexing Utility, describes the features of the DSR
indexing utility, shows how to produce an index, and contains the
RUNOFF/INDEX command qualifiers and command line examples.

•

Appendix A, DSR Commands Organized by Function, contains a list of
DSR commands organized by function.

•

Appendix B, Requirements for Printing LNI files on an LN01, describes to
system managers the requirements for printing an LNI file on an LN01 or
an LN01E Laser Printer.

Preface

Conventions Used in This Document
Convention

Meaning

[ret]

A symbol with a one- to three-character
abbreviation indicates that you press a key
on the terminal, for example, 1 ret| .

ICTRL/xl

The phrase CTRL/x indicates that you
must press the key labeled CTRL while
you simultaneously press another key,
for example, CTRL/C, CTRL/Y, CTRL/O.
In examples, this control key sequence
is shown as ~x, for example, X, “Y, X,
because that is how the system echoes
control key sequences.

$ SHOW TIME
05-JUN-1985 11:55:22

Command examples show all output lines or
prompting characters that the system prints
or displays in black letters. All user-entered
commands are shown in red letters.

$ TYPE MYFILE.DAT

Vertical series of periods, or ellipsis, mean
either that not all the data that the system
would display in response to the particular
command is shown or that not all the data a
user would enter is shown.

file-spec,...

Horizontal ellipsis indicates that additional
parameters, values, or information can be
entered.

[logical-name]

Square brackets indicate that the enclosed
item is optional. (Square brackets are
not, however, optional in the syntax of a
directory name in a file specification or in
the syntax of a substring specification in an
assignment statement.)

Braces are used to enclose lists from which
one element is to be chosen.

quotation marks
apostrophes

The term quotation marks is used to refer
to double quotation marks ("). The term
apostrophe (') is used to refer to a single
quotation mark.

UPPERCASE WORDS
AND LETTERS

Uppercase words and letters used in
examples indicate that you should type
the word or letter exactly as shown.

lowercase words
and letters

Lowercase words and letters used in format
examples indicate that you are to substitute
a word or value of your choice.

Summary of Technical Changes
This manual documents VAX DIGITAL Standard Runoff (DSR) Version 3.1
as released with Version 4.2 of VAX/VMS. This section summarizes the
technical changes in the use of DSR from earlier versions.

Additions to the DSR Command Line
•

The qualifier /DEVICE has a new option, =LN03, that generates output
files suitable for printing on the LN03 laser printer.

•

The new qualifier, /REVERSE_EMPHASIS, allows DSR to direct the
output device to change the order of underlining the flagged text in a
file. 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.

Introduction

1.1

Overview
DIGITAL Standard Runoff (DSR) is a text-formatting facility consisting of
DSR commands, DSR flags, the DCL RUNOFF command, the DSR table of
contents utility, and the DSR indexing utility. You enter DSR commands
and flags in a file along with the text you want to format. The output file
that results from DSR processing is a formatted document. Neither the DSR
commands nor the DSR flags appear in the document.
The following steps summarize the process of producing a document with
DSR:
1

Use a text editor such as EDT to create or edit a file that contains DSR
commands, DSR flags, and text.
Use the RUNOFF command to process your file and format the text
according to DSR defaults and/or DSR commands that you enter.
Print the formatted document.

DSR commands allow you to specify many formatting items, among them,
the size of pages, uneven or justified right margins, the amount of spaces to
appear between lines, and the arrangement of items in lists. The procedure
for entering DSR commands in your file is described later in this section.
Each DSR command is described in detail in Section 2.
DSR flags are special characters that you enter to specify emphasis of text,
case of characters, spacing of text, and other formatting details. Section 3
describes the procedure for using flags and gives a detailed description of
each individual flag.
The RUNOFF command is a DCL (DIGITAL Command Language) command
whose qualifiers allow you to adjust the amount of text on a page, process all
or a part of your file, create an intermediate binary file for indexes and tables
of contents, among other functions. The RUNOFF command and its qualifiers
are described in Section 4.
The DSR table of contents utility formats a table of contents from the
structural commands (.CHAPTER, .HEADER LEVEL, and so on) that you
enter in your document. This utility is described in Section 5.
The DSR indexing utility formats an index from the indexing commands
(.INDEX, .ENTRY) that you enter in your document. This utility is described
in Section 6.

i-i
i

Introduction

1.2

DSR Command Format
A DSR command consists of the following parts:
•

A Control flag (.) that introduces a DSR command. Begin a command in
column 1 unless it follows other DSR commands on the same line.

•

A keyword that immediately follows the Control flag to specify the
command function. A keyword can be a single word or several
words separated by spaces. The letters of a keyword may be entered
in uppercase, lowercase, or both. Keywords may be abbreviated to
uniqueness.

•

An argument that provides additional information for some commands.
Use commas or spaces to separate multiple arguments (for example,
.LAYOUT 1,3).
Many commands have optional arguments. If you do not enter a value
for the argument, DSR supplies a predetermined standard numeric or
alphabetic value. This standard value is known as a default.

•

A terminator that ends the command or string of commands. Commands
are most commonly terminated by the end of the line. However, you
can terminate a command with a semicolon (;). You can terminate a
command and begin a comment with an exclamation point (!). Or you
can terminate a command and begin another one with a period (.).

Figure 1-1 shows the parts of a DSR command.

Figure 1-1

DSR Command Format

.LEFT MARGIN 10;

ZK-1258-83

1.3

Entering DSR Commands
You can put each DSR command on a separate line or you can put several
DSR commands on the same line. You must always type the Control flag (.)
in column 1 of a line. The following example shows a single command on
each line:
.BLANK
.LEFT MARGIN 0
.INDENT 10

1-2

Introduction

To put more than one DSR command on a line, you must follow these rules:
•

You must type the first command in column 1 of a line.

•

You can put one command after another if all commands on the line
either take no values or take numeric values.

•

You can (except where explicitly disallowed) include a command that
takes an alphabetic argument, as long as it is the last command on the
line.

•

You must precede each command with a Control flag (.).

The following example shows multiple commands on a single line:
.BLANK.LEFT MARGIN 0.INDENT 10

There are exceptions to these rules. Some commands that take alphabetic
values (such as the .DISPLAY commands) can appear anywhere in a line
of commands. Other commands take text, but they must be followed by
a semicolon (;) for another command to follow on the same line. Some
commands that take text after them (.TITLE and .CHAPTER) cannot be
followed by any other commands. Section 2 describes the formats of the
individual commands.
To terminate a command or line of commands, you usually enter a carriage
return. However, you can terminate a command by typing a semicolon if
you want to enter text on the same line with the command. The text must
immediately follow the semicolon. For example:
We sail the ocean blue,
.BLANK;And our saucy ship'8 a beauty.

In the preceding example, the semicolon after the .BLANK command tells
DSR that the command is terminated and that text now follows. DSR inserts
a blank line between the two lines of text, as shown in the following output:
We sail the ocean blue.
And our saucy ship's a beauty.

1.3.1

Separating Command Arguments
There are rules for separating command arguments from keywords, and
for separating arguments from other arguments. The rule for separating
arguments from keywords is: If the leading character of the first argument is
not a letter, no separator is required; but if the leading character is a letter,
the letter must be separated from the final keyword by at least one space or
tab. For example:
.TITLE Runoff

is acceptable, whereas
.TITLERunoff

is not, because DSR cannot differentiate between the argument and the
keyword.

1-3

Introduction

The rule for separating arguments from other arguments is: If more than
one argument is required, you may insert a space or a comma as a separator
between arguments. But if you have adjacent letters or numbers in your
argument sequence, you must insert a separator. A space separator consists of
a SPACE or TAB character. A comma separator consists of a single comma,
alone or within any number of spaces and/or tabs.
You must enter separators in the following example because there are
adjacent numbers in the argument sequence:
.TAB STOPS 10,20,30,40

1.3.2

Entering Null Arguments
If you wish to use a default value when you are entering a sequence of
arguments, use a comma to indicate a null argument. DSR assigns the
appropriate default value to the null argument.
In the following example, the .TAB STOPS command uses default values for
the first and second arguments, and uses the value supplied by the user (30)
for the third argument.
.TAB STOPS .,30

The result of this command is that the user has tab stops of 8, 16, and 30.

1.3.3

Abbreviating DSR Commands
Most DSR commands have standard abbreviations. It is often convenient
to enter the abbreviation instead of the full command. The standard
abbreviations for DSR commands are given in Section 2, and the
abbreviations for DSR flags are given in Section 3.
You can use your own short form of a DSR command instead of the standard
abbreviations. However, your short form cannot match any other command
name or similarly shortened form of any other command name. For example,
the standard abbreviation of the .NO CONTROL CHARACTERS command
is:
. NCC

Two possible short forms of the same command are these:
.N0C0N CHA
.NO CO CH

Standard abbreviations are preferred over your own short forms because the
latter cannot be guaranteed to be unique in future versions of DSR.

1-4

Introduction

1.4

DSR Command Defaults
Even if you have not included any DSR commands in your input file, you
will see formatting differences between the input file and the output file after
processing the input file with DSR. The reason for the changed appearance
of the output file is that DSR uses certain basic or default formats when
processing a file. These defaults are as follows:
•

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 (.FILL)

•

Justification (.JUSTIFY)

These default commands and all the other DSR commands are described in
Section 2.

1.5

Printing DSR Output Files
After you have used DSR to produce a formatted output file, use the DCL
PRINT command to send the file to an output device. On most systems, the
print devices are set so that you will get the output that you specified with
DSR formatting commands.
However, since the print symbiont, the printer driver, and print devices, such
as the LN01, can all insert form feeds that cause page breaks in your file, you
may not get the output you expect. In case the printed output file has page
breaks different from those you specified with DSR, the following sections
describe when form feeds are inserted and how to control the number of form
feeds that are inserted in your file.

1.5.1

DSR Form Feeds
DSR inserts a form feed at the end of a page, based on the page length
specified with .PAGE SIZE command and the value associated with the
/FORM_SIZE qualifier. Both .PAGE SIZE and /FORM_SIZE have default
values that you can override by specifying a different value.

1-5

Introduction

The RUNOFF command line qualifier /FORM_SIZE allows you to adjust
your DSR file to allow for page breaks that are generated by other software
programs or hardware devices. The /FORM_SIZE qualifier suppresses form
feeds at the line number that you use as a value for /FORM_SIZE = n.
Follow these guidelines when printing a DSR output file:
•

If you use /SIMULATE on the command line, make the value of /FORMSIZE equal to the physical size of the form on which the document will be
printed.

•

If you do not use /SIMULATE on the command line, make the value of
/FORM_SIZE equal to one of the following:
— 200 (the maximum value for /FORM_SIZE)—this causes DSR to
suppress form feeds only when there are exactly 200 lines on the
output page; in other words, you want DSR to insert form feeds in the
file.
— The number of lines that the physical device will print before it
inserts a page break—this causes DSR to suppress form feeds at the
point where the hardware device inserts them. If you then use the
/NOFEED qualifier on the DCL PRINT command to prevent the print
symbiont and the printer driver from inserting form feeds, only the
hardware device inserts form feeds.

1.5.2

Print Symbiont Form Feeds
The print symbiont inserts a form feed at the end of a page, based on a form
that is associated with the DCL PRINT command. Someone with OPER
privilege must define a form with the DEFINE /FORM command. The
following is a sample form definition for an LN01 laser printer (elements
required for DSR output are so marked):
DEFINE /FORM DSR$LN01 2
! pick a name and number
/MARGIN = BOTTOM = 0
! *** required ***
i *** required ***
/NOWRAP
/NOTRUNCATE
! *** required ***
/STOCK = DEFAULT
/DESCRIPTION = 'DSR/LN01 forms definition'

Associate a defined form with the PRINT command in the following way:
PRINT /F0RM=form-name file-spec

Since the command that associates a defined form with the PRINT command
may be quite long, you can equate this command to a global symbol in your
LOGIN.COM file. A sample symbol definition follows (LN01$QUEUE is the
name of a generic queue for the LN01):
$ DSRLN01PRINT == "PRINT/NOFEED/FORM=DSR$LN01/QUEUE=LN01$QUEUE"

1-6

Introduction

1.5.3

Printer Driver Form Feeds
The printer driver may insert a form feed at the end of a page, based on the
value of the /PAGE qualifier on the SET PRINTER command. You need
LOG—IO privilege to use the SET PRINTER command.
A printer that is to receive DSR output should have the following setting:
SET PRINTER /NOTRUNCATE /NOWRAP

1.5.4

Printer Device Form Feeds
Printer devices such as the LN01 laser printer and line printers that have
Variable Forms Control Units also perform page breaks. Sometimes it is hard
to determine how many lines a printer will put on a page (depending upon
the font you use, the LN01 puts varying numbers of lines on a page). Use the
following steps to produce a test file to determine how many lines a printer
puts on a page:
1 Create a sample DSR input file that starts with a .NO PAGING command.
The following input file puts a unique line number on each line of the
output file when processed with DSR:
.NO PAGING
.lm+3.b;.PAGE SIZE 200
.NO FILL
1
2
3

197
198
199
200

2 Process your sample file with the RUNOFF command.
If you intend to use the /DOWN qualifier when you process your file, use
/DOWN to process the sample file also. The /DOWN qualifier affects
how many lines of text a printer will put on a page.
If you are trying to determine how many lines an LN01 will put on a
page, use the /DEVICE=LN01 qualifier with the RUNOFF command to
produce an LNI file to print on the LN01. (See Section 4 for information
on the /DEVICE=LN01 qualifier.)

3 Check the setting of the print symbiont (SHOW QUEUE/FORM ...) and
the printer driver (SHOW PRINTER) to ensure that they do not insert
unwanted page breaks.

1-7

Introduction

4 Print the file with the following command:
PRINT /NOFEED file-spec

Use any other qualifiers for the DCL PRINT command (for example,
/FORM=) that you will be using when you print your DSR output file.

5 Examine the printed output to see how many lines there are on the first
page.
The printed output of the sample file allows you to determine how many
lines the printer puts on a physical page. Use the number of lines per page
as the value for the /FORM_SIZE qualifier and also as the upper limit for the
length parameter you specify for the .PAGE SIZE command in your input file.
There is information in Appendix B for system managers about setting an
LN01[E] laser printer to print LNI files.

1-8

DSR Commands

This section contains an alphabetical list of all DSR commands with a detailed
description of each command. The command descriptions are divided, as
applicable, into the following parts:
•

Overview paragraph

•

Format

•

Description

•

Related Commands

•

Default

•

Examples

Standard abbreviations for the commands are included in the Format
sections. Under Characteristics you will find any side effects of the
command, other commands that may be required, and other commands that
may be issued by that command.
For a list of DSR commands according to function, see Appendix A.

2-1

DSR Commands
.APPENDIX

.APPENDIX
The .APPENDIX command specifies the beginning of an appendix,
assigns an identifying letter to it, and allows you to supply a title.
Successive .APPENDIX commands assign identifying letters in
alphabetical order. (See also .NUMBER APPENDIX and .DISPLAY
APPENDIX.)

FORMAT
parameter

.APPENDIX [text]
.AX [text]
text
The title you give the appendix

DESCRIPTION 1

.APPENDIX issues a .BREAK before doing its main task.

2 .APPENDIX issues a .LEFT MARGIN 0 and a .SPACING 1.
3 .APPENDIX issues a .FILL and a .JUSTIFY unless you have issued a .NO
AUTOJUSTIFY. (However, note that if .JUSTIFY was in effect before you
issued the .APPENDIX, .NO AUTOJUSTIFY does not cancel .JUSTIFY.)
4 .APPENDIX issues a .PAGING command.
5 .APPENDIX issues a .PAGE and inserts 12 blank lines.
6 .APPENDIX prints and centers the word APPENDIX, following it with a
space and a letter identifying the appendix. After printing a blank line,
.APPENDIX prints the title in uppercase letters unless you have specified
otherwise with case flags (see Section 3). Three blank lines follow the
title.
7 If you issue an .APPENDIX command after or instead of a .TITLE
command, the appendix title becomes the running-head title and any
.SUBTITLE in effect before the .APPENDIX command is blanked.

2-2

DSR Commands
.AUTOJUSTIFY and .NO AUTOJUSTIFY

.AUTOJUSTIFY
.NO AUTOJUSTIFY
When you issue .AUTOJUSTIFY, the following commands
automatically issue .JUSTIFY (as well as .FILL) commands:
.APPENDIX
.CHAPTER
.HEADER LEVEL
.NOTE
If you disable automatic justification by issuing .NO AUTOJUSTIFY,
DSR does not disturb either the justify/no-justify or the fill/no-fill
states that are in effect (whether by default or as a result of a
previous .JUSTIFY or .NO JUSTIFY command) at the time you use
one of these commands. Whichever state is in effect remains in
effect when you issue .NO AUTOJUSTIFY. (See also .JUSTIFY, .NO
JUSTIFY, .FILL, and .NO FILL.)

FORMAT

.AUTOJUSTIFY
.AJ

DEFAULT

.AUTOJUSTIFY

.NO AUTOJUSTIFY
.NAJ

2-3

DSR Commands
.AUTOPARAGRAPH and .NO AUTOPARAGRAPH

.AUTOPARAGRAPH
.NO AUTOPARAGRAPH
The .AUTOPARAGRAPH and .NO AUTOPARAGRAPH
commands turn the automatic paragraph capability on and
off. If .AUTOPARAGRAPH is in effect, you do not have to
insert .PARAGRAPH commands each time you want to format
a paragraph. When you start a line with a space or tab, DSR
automatically formats a new paragraph, using the values of
.PARAGRAPH or .SET PARAGRAPH. You can specify values for
.PARAGRAPH or you can use the default values (see .PARAGRAPH).
.AUTOPARAGRAPH functions the same way that .AUTOTABLE
does, except that .AUTOTABLE starts a new paragraph each time a
line does not start with a space or tab (see .AUTOTABLE).

FORMAT

.AUTOPARAGRAPH
.AP

.NO AUTOPARAGRAPH
.NAP

DESCRIPTION

.FILL must be in effect for a space or tab to start a new paragraph.

If you issue either .AUTOPARAGRAPH or .NO AUTOPARAGRAPH, you
cancel .AUTOTABLE.

RELATED
COMMAND

If you issue .AUTOTABLE or .NO AUTOTABLE, you cancel
.AUTOPARAGRAPH.

DEFAULT

If you have not issued a .PARAGRAPH or .SET PARAGRAPH, DSR executes
a .TEST PAGE 2 followed by a .SKIP 1 and a .INDENT 5.

2-4

DSR Commands
.AUTOPARAGRAPH and .NO AUTOPARAGRAPH

EXAMPLE
Example 2-1 illustrates the use of the .AUTOPARAGRAPH command.

Example 2-1

.AUTOPARAGRAPH

The following shows the input text format before it is processed by DSR:
.AUTOPARAGRAPH

The output text format looks like this:

2-5

DSR Commands
.AUTOSUBTITLE and .NO AUTOSUBTITLE

.AUTOSUBTITLE
.NO AUTOSUBTITLE
The .AUTOSUBTITLE command causes DSR to use .HEADER LEVEL
titles for running-head subtitles. Subtitles therefore can change
according to the section title that applies to a given page. The .NO
AUTOSUBTITLE command cancels the .AUTOSUBTITLE function.
(See .HEADERS ON, .SUBTITLE, and .HEADER LEVEL.)

FORMAT

parameters

.AUTOSUBTITLE [[+/-]n]
.AST [[+/-]n]

.NO AUTOSUBTITLE
.NAST

n
The highest numbered .HEADER LEVEL whose title will be used as a
subtitle. For example, if you issue .AUTOSUBTITLE 2, the titles of header
levels 1 and 2 appear as running-head subtitles. Header levels 3, 4, 5, and 6
do not appear as running-head subtitles.

+n
Increases the current highest numbered header level by n.

—n
Decreases the current highest numbered header level by n.

DESCRIPTION

You must issue a .SUBTITLE command for .AUTOSUBTITLE to work.

If the text of the header level that is used as a subtitle is wider than
the page size currently in effect, the subtitle is truncated and an ellipsis
( ... ) is appended to it.

RELATED
COMMAND

The .DATE command causes the current date to be placed to the right of each
subtitle.

DEFAULTS

If you do not issue .AUTOSUBTITLE or .NO AUTOSUBTITLE, the default
is .AUTOSUBTITLE 1.

If you issue .AUTOSUBTITLE with no value, the default is the value
you specified with a previous .AUTOSUBTITLE command. If no
.AUTOSUBTITLE was previously issued, the default value is 1.

2-6

DSR Commands
.AUTOTABLE and .NO AUTOTABLE

.AUTOTABLE
.NO AUTOTABLE
The .AUTOTABLE and .NO AUTOTABLE commands turn the
automatic paragraph capability on and off. If .AUTOTABLE
is in effect, DSR formats a new paragraph for each line that
does not start with a space or tab. It is formatted according to
.PARAGRAPH or .SET PARAGRAPH values, whether they are
specified or supplied by default (see .PARAGRAPH). .AUTOTABLE
functions the same way that .AUTOPARAGRAPH does, except that
.AUTOPARAGRAPH starts a new paragraph for each line that starts
with a space or tab (see .AUTOPARAGRAPH).

FORMAT

.AUTOTABLE
.AT

DESCRIPTION 1
2

.NO AUTOTABLE
.NAT

.FILL must be in effect for a line without a space or a tab at the beginning
to start a new paragraph.
If you issue either .AUTOTABLE or .NO AUTOTABLE, you cancel
.AUTOPARAGRAPH.

RELATED
COMMAND

If you issue .AUTOPARAGRAPH or .NO AUTOPARAGRAPH, you cancel
.AUTOTABLE.

DEFAULT

If you have not issued a .PARAGRAPH or .SET PARAGRAPH, the default is
a .TEST PAGE 2 followed by a .SKIP 1 and an .INDENT 5.

2-7

DSR Commands
.AUTOTABLE and .NO AUTOTABLE

EXAMPLE
Example 2-2 illustrates the use of the .AUTOTABLE command.

Example 2-2

.AUTOTABLE

The following shows the input text before it is processed by DSR:
.AUTOTABLE

I SPACE |TABTAB-

The output text format looks like this:

2-8

DSR Commands
.BLANK

.BLANK
The .BLANK command inserts exactly the number of blank lines that
you specify. It is different from .SKIP, which inserts a multiple of
the number of blank lines specified in the .SPACING command (see
.SKIP and .SPACING).

FORMAT

parameters

.BLANK [[-]n]
■B [[-]n]
n
The number of blank lines you want to insert.

—
Specifies that the next line will begin exactly n lines from the bottom of the
current page.

DESCRIPTION

DEFAULT

The .BLANK command issues a .BREAK before doing its main task.

.BLANK n does not work at the top of a page, that is, immediately
following a .PAGE or just after .PAGE SIZE length has been exceeded.
However, .BLANK -n pushes the next line to the bottom of the page,
minus n lines, under such conditions. (Use a .FIGURE command to insert
blank lines at the top of a page.)

If there is not enough room on the current page for .BLANK to do exactly
as you specified, .BLANK does as much as it can on that page. It finishes
on the next page only if you issue .BLANK -n and .SPACING has a value
greater than n.

If DSR encounters a footnote while executing .BLANK, it considers the
line directly above the footnote to be the bottom of the page.

If you issue .BLANK without a value, you get .BLANK 1.

2-9

DSR Commands
.BREAK

.BREAK
The .BREAK command ends the current line immediately, without
filling or justifying. Issue a .BREAK when .FILL is in effect and you
want a few short lines of text with no blank lines in between.

FORMAT

.BREAK
.BR
.

RET

DESCRIPTION A .BREAK immediately after a .PARAGRAPH, .INDENT, .LEFT MARGIN,
.AUTOPARAGRAPH, or .AUTOTABLE cancels the indentation you just
requested. This also occurs with most of the commands that issue a .BREAK
command automatically.

RELATED
COMMAND

The following DSR commands issue .BREAK commands before doing their
main tasks:
.APPENDIX

.LIST and .END LIST

.BLANK

.LIST ELEMENT

.CENTER

.PAGE

.CHAPTER

.PAGE SIZE

.DISPLAY APPENDIX

.PAPER SIZE

.DISPLAY CHAPTER

.PARAGRAPH

.DISPLAY ELEMENTS

.RIGHT

.DISPLAY LEVELS

.RIGHT MARGIN

DISPLAY NUMBER

.SET DATE

DISPLAY SUBPAGE

.SKIP

.FIGURE

.SPACING

.FIGURE DEFERRED

.STYLE HEADERS

.FILL and .NO FILL

.SUBPAGE and .END SUBPAGE

.HEADER LEVEL

.TEST PAGE

.INDENT

.TITLE

.LAYOUT

2-10

DSR Commands
.CENTER (.CENTRE)

.CENTER (.CENTRE)
The .CENTER command centers a single line of text around a
character position on a line (compare with .RIGHT).

FORMAT

.CENTER[[+/-]n]; text

.CENTER [[+/-]n]
text

parameters

.CENTRE [[+/-]n]; text

.CENTRE [[+/-]n]

■ C [[+/~]n]; text

text
. C [[+/-]n]
text

n
Twice the value of the character position that you want to center the text
around. (Absolute character positions on a line always start with 0 at the
leftmost position on the page.)
If you center the line of text between settings of the left and right margins,
then n is equal to the .LEFT MARGIN value added to the .RIGHT MARGIN
value.

+n
Moves the character position around which the text is centered to the right by
n/2 character positions. This value normally is used to adapt .CENTER to a
.LEFT MARGIN setting.

—n
Moves the character position around which the text is centered to the left by
n/2 character positions. This value normally is used to adapt .CENTER to a
.RIGHT MARGIN setting.

text
The text you want to center. You must enter this text on one line.

DESCRIPTION

The .CENTER command issues a .BREAK before doing its main task.

The line of text being centered can extend past margin settings and even
beyond the .PAGE SIZE width setting, but it cannot go to the left of
character position 0.

2-11

DSR Commands
.CENTER (.CENTRE)

DEFAULT

2-12

You can enter the text to be centered on the same line following the
.CENTER command. If you end the line after the .CENTER command, the
text on the following line is centered.

No commands will be recognized on the line following a .CENTER
command (or if that line is blank, on the next line). The Control flag (.) is
not honored while .CENTER is collecting text to center. Other DSR flags
are recognized, however, the Bold and Underline flags, for example.

If you issue .CENTER without specifying n, the text is centered between the
current left and right margins.

DSR Commands
.CHAPTER

.CHAPTER
The .CHAPTER command specifies the beginning of a chapter,
numbers it, and allows you to supply a chapter title. Successive
.CHAPTER commands number the following chapters sequentially.
(See also .NUMBER CHAPTER and .DISPLAY CHAPTER.)

FORMAT

parameter

.CHAPTER [text]
.CH [text]
text
The title of the chapter.

DESCRIPTION 1 .CHAPTER issues a .BREAK before doing its main task.
2 .CHAPTER issues a .LEFT MARGIN 0 and a .SPACING 1.
3 .CHAPTER issues a .FILL and a .JUSTIFY, unless you have issued a .NO
AUTOJUSTIFY. (However, note that if .JUSTIFY was in effect before you
issued the .CHAPTER, .NO AUTOJUSTIFY does not cancel the .JUSTIFY.)

4 .CHAPTER issues a .PAGING command.
5 .CHAPTER issues a .PAGE and inserts 12 blank lines.
6 .CHAPTER prints and centers the word CHAPTER and a number
identifying the chapter. After printing a blank line, .CHAPTER prints the
title in uppercase letters unless you have specified otherwise with case
flags (see Section 3). Three blank lines follow the title.

7 If you include a .CHAPTER after or instead of a .TITLE, the chapter title
becomes the running-head title and any .SUBTITLE in effect before the
.CHAPTER command is blanked.

2-13

DSR Commands
.CONTROL CHARACTERS and .NO CONTROL CHARACTERS

.CONTROL CHARACTERS
.NO CONTROL CHARACTERS
The .CONTROL CHARACTERS command causes DSR to accept
control characters as normal text in your input file. The characters
that are affected by this command are the characters in the DEC
Multinational Character set with the following decimal values; 0 31, 127 - 159, and 255.
The .NO CONTROL CHARACTERS command does not accept
control characters as normal text.

FORMAT

.CONTROL CHARACTERS
cc

.NO CONTROL CHARACTERS
.NCC
DEFAULT

.NO CONTROL CHARACTERS

EXAMPLE
Example 2-3 shows how you might use the .CONTROL CHARACTERS and
.NO CONTROL CHARACTERS commands in a command file.

Example 2-3

.CONTROL CHARACTERS

.IF DIABLO
.! Switch the Diablo printer to horizontal 12-pitch (12 char/in.)
.! and vertical 7-pitch (7 char/in.). The codes are as follows:
.!
.
Horizontal:
.
Vertical

!
!

Codes
<ESC><US><VT>
<ESC><RS><BS>

Decimal values
27 - 31 - 11
27 - 30 - 08

.CONTROL CHARACTERS
<ESC>~_<VT>
<ESC>
H
.NO CONTROL CHARACTERS
.ENDIF DIABLO

This command file allows device-dependent information to pass through DSR
to the device (a DIABLO terminal). Without the .CONTROL CHARACTERS
command, DSR would send error messages and would then delete the control
characters.

2-14

DSR Commands
.DATE and .NO DATE

.DATE
.NO DATE
The .DATE and .NO DATE commands control whether the current
date appears in running heads. The date appears in the following
format: 22 August 1984. A .SUBTITLE command must be included
for .DATE to be effective. (See also .HEADERS ON and .SET DATE.)

FORMAT

.DATE
.D

.NO DATE
.ND

DESCRIPTION

The date appears on the right-hand side of the subtitle line.

RELATED
COMMANDS

.DATE is not effective if either .LAYOUT 1 or .LAYOUT 2 is in effect.

You can specify a different date with the .SET DATE command.

DEFAULT

.NO DATE

2-15

DSR Commands
.DISPLAY APPENDIX

.DISPLAY APPENDIX
The .DISPLAY APPENDIX command allows you to specify the
form that the lettering (or numbering) of appendixes will take. The
form you specify appears in the title, the page numbers, and the
first character of header level numbers throughout the appendix.
This command does not change any values; it only affects the
way the values are displayed. (See also .APPENDIX and .NUMBER
APPENDIX.)

FORMAT

parameter

.DISPLAY APPENDIX y
.DAX y
y
One of the following one- or two-letter codes:
Code

Form of Sequence and Case

Decimal Numbers

Octal Numbers

Hexadecimal Numbers

Roman Uppercase Numerals

Roman Lowercase Numerals

Roman Mixed Case Numerals—only first numeral is uppercase

Letters, Uppercase

Letters, Lowercase

Letters, Mixed Case—only first letter is uppercase

DESCRIPTION i
2

DEFAULT

2-16

The .DISPLAY APPENDIX command issues a .BREAK before doing its
main task.
Issue a .DISPLAY APPENDIX before the .APPENDIX command you want
to affect.

Uppercase letters (LU)

DSR Commands
.DISPLAY APPENDIX

EXAMPLE
Example 2-4 illustrates the use of the .DISPLAY APPENDIX command.

Example 2-4

.DISPLAY APPENDIX

The following shows the input text format before it is processed by DSR:
.RIGHT MARGIN 60
.DISPLAY APPENDIX RU
.NUMBER APPENDIX 5
.APPENDIX
This is the beginning of the fifth appendix in a book. The
appendix identifiers are displayed as Roman Uppercase Numerals.

The output text format looks like this:

APPENDIX V
This is the beginning of the fifth appendix in a book.
The
appendix
identifiers are displayed as Roman Uppercase
Numerals.

2-17

DSR Commands
.DISPLAY CHAPTER

.DISPLAY CHAPTER
The .DISPLAY CHAPTER command allows you to specify the form
that the numbering (or lettering) of chapters will take. The form you
specify appears in the title, the page numbers, and the first character
of header level numbers throughout the chapter. This command
does not change any values; it only affects the way the values are
displayed. (See also .CHAPTER and .NUMBER CHAPTER.)

FORMAT

parameter

.DISPLAY CHAPTER y
.DCH y

•

y
One of the following one- or two-letter codes:

DESCRIPTION

DEFAULT

2-18

Code

Form of Sequence and Case

Decimal Numbers

Octal Numbers

Hexadecimal Numbers

Roman Uppercase Numerals

Roman Lowercase Numerals

Roman Mixed Case Numerals—only first numeral is uppercase

Letters, Uppercase

Letters, Lowercase

Letters, Mixed Case—only first letter is uppercase

The .DISPLAY CHAPTER command issues a .BREAK before doing its
main task.

Issue a .DISPLAY CHAPTER before the .CHAPTER command you want
to affect.

Decimal numbers (D)

•

DSR Commands
.DISPLAY CHAPTER

EXAMPLE
Example 2-5 illustrates the use of the .DISPLAY CHAPTER command.

Example 2-5

.DISPLAY CHAPTER

The following shows the input text format before it is processed by DSR:
.DISPLAY CHAPTER RL
.NUMBER CHAPTER 7
.CHAPTER
This is the beginning of the seventh chapter in a book. The
chapter identifiers are displayed as Roman Lowercase Numerals.

The output text format looks like this:

CHAPTER vii
This is the beginning of the seventh chapter in a book.
The
chapter identifiers are displayed as Roman Lowercase Numerals.

2-19

DSR Commands
.DISPLAY ELEMENTS

.DISPLAY ELEMENTS
The .DISPLAY ELEMENTS command allows you to specify the form
that sequential numbering or lettering of items in a list will take.
This command does not change any values; it only affects the way
the values are displayed. (See also .LIST, .END LIST, and .NUMBER
LIST.)

FORMAT

parameters

.DISPLAY ELEMENTS ["x",] y[, "z"] (or['x',]y[, ’z'])
■ DLE rx",]y[t''z"](or['x',]y[,'z'])
X
A character, such as a left parenthesis or bracket, that you can specify
to precede the number or letter. You must enclose the character within
quotation marks ("") or apostrophes (' ').

y
One of the following one- or two-letter codes:
Code

Form of Sequence and Case

Decimal Numbers

Octal Numbers

Hexadecimal Numbers

Roman Uppercase Numerals

Roman Lowercase Numerals

Roman Mixed Case Numerals—only first numeral is uppercase

Letters, Uppercase

Letters, Lowercase

Letters, Mixed Case—only first letter is uppercase

A character, such as a right parenthesis or bracket, that you can specify to
follow the number or letter. You must enclose the character within quotation
marks ("") or apostrophes

(' ').

DESCRIPTION

The .DISPLAY ELEMENTS command issues a .BREAK before doing its
main task.

2 You must issue a .DISPLAY ELEMENTS before the first .LIST ELEMENT
command that you want to affect, but after the .LIST command.

2-20

DSR Commands
.DISPLAY ELEMENTS

3 A .DISPLAY ELEMENTS command remains in effect only for a particular
list. A list is defined by a .LIST command and its paired .END LIST.
Other lists, similarly defined, can exist within it and are unaffected by the
.DISPLAY ELEMENTS command issued for outer lists (or any other lists).

4 If you omit a value from .DISPLAY ELEMENTS, the current setting
remains unchanged, but you must retain any comma that would have
followed it. (The final value present, however, need not have a comma
after it.)

DEFAULT

A space for x, decimal numbers for y, and a period (.) for z

EXAMPLE
Example 2-6 shows how to specify special numbering of the items in a list.

Example 2-6

NUMBERING ELEMENTS IN A LIST

The following input produces a list that has Roman lowercase numerals set
off with a right parenthesis ()).
.LIST
.DISPLAY ELEMENTS RL,")"
.LE;First
.LE;Second
.END LIST

When the input file is processed with DSR the items in the list are numbered
in the following way:
i) First
ii) Second

2-21

DSR Commands
.DISPLAY LEVELS

.DISPLAY LEVELS
The .DISPLAY LEVELS command allows you to specify the form
that sequential numbering (or lettering) of section headers will take.
You can control the form of individual numbers within a section
number for a header (that is, those numbers preceding or following a
dot). This command does not change any values; it only affects the
way the values are displayed. (See also .HEADER LEVEL, .NUMBER
LEVEL, and .STYLE HEADERS.)

Default Header Level Numbering

FORMAT

parameter

Nonchapter

Chapter n

Appendix A

.HEADER LEVEL 1

n. 1

A. 1

.HEADER LEVEL 2

1.1

n.1.1

A.1.1

.HEADER LEVEL 3

1.1.1

n.1.1.1

A.1.1.1

.DISPLAY LEVELS [yl] [,y2]...[,y6]
.DHL [y1][,y2]...[,y6]
y
One of the following one- or two-letter codes; 1,2,...6 indicate positions of
numbers (or letters) for a section header. The commas correspond to the dots
in a printed section number. See the example under Characteristics. (See
also .NUMBER LEVEL.)

2-22

Code

Form of Sequence and Case

Decimal Numbers

Octal Numbers

Hexadecimal Numbers

Roman Uppercase Numerals

Roman Lowercase Numerals

Roman Mixed Case Numerals—only first numeral is uppercase

Letters, Uppercase

Letters, Lowercase

Letters, Mixed Case—only first letter is uppercase

DSR Commands
.DISPLAY LEVELS

DESCRIPTION

The .DISPLAY LEVELS command issues a .BREAK before doing its main
task.

If you have issued a .DISPLAY LEVELS RU„LL command, for example,
and if you now issue a .HEADER LEVEL command that normally would
produce a section number of 2.2.1, the section header number would
appear as follows:
For a document with no chapters,
.HEADER LEVEL 3 produces II.2.a.
For a document with chapters,
.HEADER LEVEL 3 produces l.II.2.a., if you issued it in Chapter 1.
Note that this command does not affect the chapter number. However,
.CHAPTER, .NUMBER CHAPTER, and .DISPLAY CHAPTER do affect
it.

DEFAULT

yl,y2,...y6 are displaced one position to the right if you have issued
.CHAPTER or .APPENDIX.

Decimal numbers (D)

2-23

DSR Commands
.DISPLAY NUMBER

.DISPLAY NUMBER
The .DISPLAY NUMBER command allows you to specify the form
that sequential numbering (or lettering) of pages will take. This
command does not change any values; it only affects the way the
values are displayed. (See also .HEADERS ON, .NUMBER PAGE, .NO
NUMBER, .LAYOUT, .NUMBER RUNNING, and .NO PAGING.)

FORMAT

parameter

.DISPLAY NUMBER y
.DIMM y
y
One of the following one- or two-letter codes:
Code

Form of Sequence and Case

Decimal Numbers

Octal Numbers

Hexadecimal Numbers

Roman Uppercase Numerals

Roman Lowercase Numerals

Roman Mixed Case Numerals—only first numeral is uppercase

Letters, Uppercase

Letters, Lowercase

Letters, Mixed Case—only first letter is uppercase

DESCRIPTION i

The .DISPLAY NUMBER command issues a .BREAK before doing its main
task.

2 Issue a .DISPLAY NUMBER before the page you want to affect. However,
note that if you are using .LAYOUT 1 or .LAYOUT 2 (where the page
number appears at the bottom of the page), the .DISPLAY NUMBER
command might affect the page on which you issue that command when
you are trying to affect the next page.

DEFAULT

2-24

Decimal numbers (D)

DSR Commands
.DISPLAY SUBPAGE

.DISPLAY SUBPAGE
The .DISPLAY SUBPAGE command allows you to specify the form
that sequential lettering (or numbering) of subpage characters will
take. Subpage characters are the characters that are appended to
the page numbers of subpages. This command does not change
any values; it only affects the way the values are displayed. (See
also .SUBPAGE and .NUMBER SUBPAGE.)

FORMAT

parameter

.DISPLAY SUBPAGE y
.DSP y

y
One of the following one- or two-letter codes:

DESCRIPTION

DEFAULT

Code

Form of Sequence and Case

Decimal Numbers

Octal Numbers

Hexadecimal Numbers

Roman Uppercase Numerals

Roman Lowercase Numerals

Roman Mixed Case Numerals—only first numeral is uppercase

Letters, Uppercase

Letters, Lowercase

Letters, Mixed Case—only first letter is uppercase

The .DISPLAY SUBPAGE command issues a .BREAK before doing its
main task.

Issue a .DISPLAY SUBPAGE before the subpage you want to affect.

Uppercase letters (LU) appended to the page number preceding the subpage

2-25

DSR Commands
.ENABLE BAR, .DISABLE BAR, .BEGIN BAR, and .END BAR

.ENABLE BAR, .DISABLE BAR, .BEGIN BAR,
.END BAR
The bar commands control the insertion of vertical bars (1) at the
beginning of lines of text. The bars (usually called change bars) are
normally inserted to indicate where changes in text have occurred
since the previous edition of a document. You can specify a
character other than the default character (vertical bars) to indicate
changes. See the description of the /CHANGE_BAR[="character"]
qualifier in Section 4, Runoff Command Qualifiers.)
.ENABLE BAR shifts all text following it three spaces to the right to
make room for the bars on the left. The width of the lines of actual
text is not altered.
.BEGIN BAR causes DSR to start inserting vertical bars at the
beginning of lines.
.END BAR causes DSR to stop putting vertical bars at the beginning
of lines.
.DISABLE BAR disables the bar commands but does not shift the
lines of text back to their original position.

FORMAT

DEFAULT

2-26

.ENABLE BAR

.DISABLE BAR

CRD

HRR

.BEGIN BAR
.BB

!eND BAR
.EB

.DISABLE BAR - Operation of the change bar function is not initially enabled.
By default, there are no change bars and text is not indented.

The following shows an input file with bar comma
by DSR:

.RIGHT MARGIN 50
A .BEGIN BAR command follows this text. The word
"Here" is placed between
.BEGIN BAR and .END BAR
commands. However, we should not see change bars
in the output file (unless this file is processed
with the /CHANGE_BARS qualifier) because we have
issued an .ENABLE BAR comm and.
.BLANK
.BEGIN BAR
Here.
.END BAR
.BLANK
No change bars appeared.
.BLANK
Following this sentence, we issue an .ENABLE BAR
.BLANK
.ENABLE BAR
The .ENABLE BAR command shifts all text following
spaces to the right to prepare for change bars in
margin. .ENABLE BAR does not put change bars in t
file until .BEGIN BAR is specified.
.BLANK
Now we issue the .BEGIN BAR command.
.BLANK
.BEGIN BAR
This text is barred because it is between .BEGIN
and .END BAR commands when the bar commands are e
.END BAR
.BLANK
Following this sentence, we turn off recognition
the bar commands with a .DISABLE BAR command.
.BLANK
.DISABLE BAR
Notice that the left margin does not change. It
was offset 3 spaces to the right when bars were
enabled (either with the /CHANGE.BARS qualifier o
the command line or with the .ENABLE BAR command
in the input file). Disabling the recognition of
bar commands with the
.DISABLE BAR command does
not cause the margin to go back to its orignal
setting.

"Here"
is placed between .BEGIN BAR and .END BAR
commands.
However, we should not see change bars
in the output file (unless this file is processed
with the /CHANGE_BARS qualifier) because we have
not issued an .ENABLE BAR command.
Here.
No change bars appeared.
Following this sentence, we issue an
command.

.ENABLE

BAR

The .ENABLE BAR command shifts all text following
it three spaces to the right to prepare for change
bars in the left margin.
.ENABLE BAR does not put
change bars in the output file until .BEGIN BAR is
specified.
Now we issue the .BEGIN BAR command.
I
I
I

This text is barred because it is between
.BEGIN
BAR and
.END BAR commands when the bar commands
are enabled.
Following this sentence, we turn off recognition
of the bar commands with a .DISABLE BAR command.
Notice that the left margin does not change.
It
was offset 3 spaces to the right when bars were
enabled (either with the /CHANGE.BARS qualifier on
the command line or with the .ENABLE BAR command
in the input file).
Disabling the recognition of
bar commands with the .DISABLE BAR command does
not cause the margin to go back to its orignal
setting.

2-28

DSR Commands
.ENABLE BOLDING and DISABLE BOLDING

.ENABLE BOLDING
.DISABLE BOLDING
The .ENABLE BOLDING and .DISABLE BOLDING commands enable
and disable the bolding function. You can perform bolding only if
recognition of the Bold flag (*) is turned on and the bold function is
enabled. See the description of the Bold flag in Section 3, and the
description of .FLAGS BOLD in this section.

FORMAT

.ENABLE BOLDING
.EBO

DEFAULT

Operation of the Bold function is initially enabled (.ENABLE BOLDING), but
recognition of the Bold flag (*) is not turned on (.NO FLAGS BOLD).

.DISABLE BOLDING
.DBO

2-29

DSR Commands
.ENABLE HYPHENATION and .DISABLE HYPHENATION

.ENABLE HYPHENATION
.DISABLE HYPHENATION
The .ENABLE HYPHENATION and .DISABLE HYPHENATION
commands enable and disable the hyphenation function.
You can use hyphenation to close up excessive spacing between
words. Extra spaces often are placed between words when
margins are narrow and a line contains several long words. See
the description of the Hyphenate flag (=) in Section 3, and .FLAGS
HYPHENATE in this section.

FORMAT

.ENABLE HYPHENATION .DISABLE
HYPHENATION
.EHY
.DHY

DEFAULT

Operation of the hyphenation function is initially enabled (.ENABLE
HYPHENATION), but recognition of the Hyphenate flag ( = ) is not turned on
(.NO FLAGS HYPHENATE).

2-30

DSR Commands
.ENABLE INDEXING and .DISABLE INDEXING

.ENABLE INDEXING
.DISABLE INDEXING
These commands enable and disable the operation of the indexing
commands (.INDEX and .ENTRY), and the Index flag (> ). See the
description of the Index flag in Section 3, and .FLAGS INDEX in this
section. Section 6, Creating an Index, has information on the DSR
indexing utility.

FORMAT

.ENABLE INDEXING
.EIX

DEFAULT

Operation of the index function is initially enabled (.ENABLE INDEXING),
but recognition of the Index flag (> ) is not turned on (.NO FLAGS INDEX).

.DISABLE INDEXING
.DIX

2-31

DSR Commands
.ENABLE OVERSTRIKING and .DISABLE OVERSTRIKING

.ENABLE OVERSTRIKING
.DISABLE OVERSTRIKING
The .ENABLE OVERSTRIKING and .DISABLE OVERSTRIKING
commands enable and disable the overstrike function.
You use the Overstrike flag (%) to create special characters that are
not available on the terminal by overstriking any printing character
with another. For example, you can overstrike a 7 with a hyphen to
create a European 7 (7). See the description of the Overstrike flag in
Section 3, and .FLAGS OVERSTRIKE in this section.

FORMAT

.ENABLE OVERSTRIKING .DISABLE
OVERSTRIKING
.EOV
.DOV

DEFAULT

Operation of the overstrike function is initially enabled (.ENABLE
OVERSTRIKING), but recognition of the Overstrike flag (%) is not turned on
(.NO FLAGS OVERSTRIKE).

2-32

DSR Commands
.ENABLE TOC and .DISABLE TOC

.ENABLE TOC
.DISABLE TOC
These commands enable and disable DSR's collection of information
for the table of contents. Section 5, Creating a Table of Contents,
has information on the DSR table of contents utility.

FORMAT

.ENABLE TOC
.ETC

.DISABLE TOC
.DTC

DEFAULT

Operation of the table of contents function is initially enabled (.ENABLE
TOC).

2-33

DSR Commands
.ENABLE UNDERLINING and .DISABLE UNDERLINING

.ENABLE UNDERLINING
.DISABLE UNDERLINING
The .ENABLE UNDERLINING and .DISABLE UNDERLINING
commands enable and disable the underline function. You can
perform underlining only if recognition of the Underline flag (&) is
turned on and the underline function is enabled. See the description
of the Underline flag in Section 3, and .FLAGS UNDERLINE in this
section.

FORMAT

.ENABLE UNDERLINING .DISABLE
UNDERLINING
.EUN
.DUL

DEFAULT

Operation of the underline function is initially enabled (.ENABLE
UNDERLINING) and recognition of the Underline flag (&) is turned on
(.FLAGS UNDERLINE).

2—34

DSR Commands
.ENTRY

.ENTRY
The .ENTRY command creates an index entry without a page
number reference. It is usually used for "see..." or "see also..."
index entries. Section 6, Creating an Index, has a description of the
DSR indexing utility.

FORMAT

.ENTRY topic[> subtopic 1... > subtopicn]
.Y topic[> subtopic 1... > subtopicn]

2-35

DSR Commands
.FIGURE DEFERRED and .FIGURE

.FIGURE DEFERRED
.FIGURE
The .FIGURE DEFERRED command leaves room on a page for you to
insert a figure later. You specify the number of blank lines you need,
and DSR leaves that amount of space on the current page if there is
enough room.
If there is not enough room on the current page, .FIGURE DEFERRED
first adds enough text to complete the page and then puts the
required number of blank lines at the top of the next page.
The .FIGURE command is the same as .FIGURE DEFERRED, except
that if there is not enough room on the current page, DSR ends the
page immediately and then puts the blank lines at the top of the next
page.

FORMAT

parameter

.FIGURE DEFERRED [n]
.FGD [n]

.FIGURE [n]
.FG [n]

n
The number of blank lines needed. Values of 0 or less are not valid and n
cannot exceed the number of lines of text allowed on a page (this would be
the page-length value associated with .PAGE SIZE minus any header lines,
any forced blank spaces after the header information, and any bottom of the
page information specified by .LAYOUT 1, .LAYOUT 2, or .LAYOUT 3).

DESCRIPTION i

The .FIGURE DEFERRED and .FIGURE commands both issue .BREAK
commands before doing their main tasks.

.FIGURE DEFERRED avoids short pages (a large amount of white space at
the bottom of the page).

You should not issue two .FIGURE DEFERRED commands in a row. You
should enter at least one line of text before issuing a second .FIGURE
DEFERRED command.

You can issue .FIGURE and .PAGE alternately to produce consecutive
blank pages. (A series of .PAGE commands alone does not accomplish
this action. See also .SKIP and .BLANK.)

For a figure ending a page, you can cause a caption to be printed at the
bottom of the page by issuing the following commands after .FIGURE:
.SKIP -1
.CENTER;figure caption

DEFAULTS

2-36

.FIGURE 1

.FIGURE DEFERRED 1

The following shows the input file before it is proc

.PAGE SIZE 25,55
.RIGHT MARGIN 55
.LAYOUT 1.2
.FLAGS BOLD
Here are examples of using .FIGURE and .FIGURE
DEFERRED. The results are clearer if you use the
/SEQUENCE qualifier when running off this file.
The page length for this example is 25 lines. Th
width is 55 characters.
.BLANK
The following is Figure 1, a 3-line figure:
.BLANK
.CENTER;~*Title for Figure 1\*
.FIGURE 3
.SUBTITLE ~*Title for Figure 2\*
The next figure will be deferred to the following
page. It will be seven lines long and will occur
the top of page 2.
.FIGURE DEFERRED 7
.BLANK
This text occurs after Figure 1, still on page 1
It demonstrates that text will continue to fill
the previous page after a .FIGURE DEFERRED
command is processed, but before it is triggered
.PAGE
Now we are on page 2 after the occurrence of Fig
We are about to set up Figure 3 to occur on page
This time, we will use .PAGE followed by .FIGURE
Page 2 will be left short.
.SUBTITLE ~*Title for Figure 3\*
.PAGE
.FIGURE 4
.SUBTITLE
And here is the text following Figure 3. It
appears physically after the figure on Page 3.
This is in contrast to the .FIGURE DEFERRED
behavior we saw for Figure 2; the text was not
pulled up to fill page 2.

/SEQUENCE qualifier when running off this file.
The
page length for this example is 25 lines.
The width is
55 characters.
The following is Figure 1, a 3-line figure:
Title for Figure 1
The next figure will be deferred to the following page.
It will be seven lines long and will occur at the top
of page 2.
This text occurs after Figure 1, still on page 1.
It
demonstrates that text will continue to fill the
previous page after a
.FIGURE DEFERRED command is
processed, but before it is triggered.
1
Title for Figure 2

Now we are on page 2 after the occurrence of Figure 2.
We are about to set up Figure 3 to occur on page 3.
This time, we will use .PAGE followed by
.FIGURE 4.
Page 2 will be left short.

2
Title for Figure 3
And here is the text following Figure 3.
It appears
physically after the figure on Page 3.
This is in
contrast to the .FIGURE DEFERRED behavior we saw for
Figure 2; the text was not pulled up to fill page 2.

2-38

DSR Commands
.FILL and .NO FILL

.FILL
.NO FILL
The .FILL command causes DSR to treat line endings exactly like
spaces (see also .NO SPACE). Line-filling is the accumulation of
words on a line until the addition of one more word would exceed
the right margin. If .NO FILL is in effect, line endings in the input file
are duplicated in the output file (see also .KEEP).

FORMAT

.FILL
.F

DESCRIPTION

Both .FILL and .NO FILL issue .BREAK commands before doing their
main tasks.

The .NO FILL command suspends both line-filling and justification.

The .FILL command restores line-filling and normally restores the most
recent .JUSTIFY or .NO JUSTIFY setting that was in effect. A no-justify
state that was set as a result of a .NO FILL command is not considered
when DSR is determining the most recent setting. In other words, .NO
FILL turns off both filling and justification, and .FILL restores them.

.NO FILL suspends any .AUTOPARAGRAPH or .AUTOTABLE that has
been issued; .FILL restores it.

You can create an uneven right margin (ragged right text format) by
having both .FILL and .NO JUSTIFY in effect.

If you want justification of text without lines being filled, you must issue
.NO FILL before you issue .JUSTIFY. Under these conditions, the same
words appear on each line of the output file as were present in the input
file. DSR inserts as much space between words as it needs to expand the
lines to the right margin.

The following commands issue .FILL commands unless you have issued
.NO AUTOJUSTIFY:

RELATED
COMMANDS

.NO FILL
.NF

.APPENDIX
.CHAPTER
.HEADER LEVEL
2

DEFAULT

.NOTE also issues a .FILL, but .END NOTE restores the setting to what it
was before you issued the .NOTE command.

.FILL

2-39

DSR Commands
.FIRST TITLE

.FIRST TITLE
The .FIRST TITLE command allows running-head information
to appear on the first page of a document with no chapters.
(See also .HEADERS ON, .LAYOUT, .TITLE, .SUBTITLE, and
.AUTOSUBTITLE.)

FORMAT

.FIRST TITLE
.FT

DESCRIPTION Insert the .FIRST TITLE command before any text on the first page.
RELATED
COMMAND

If you issue a .CHAPTER or .APPENDIX, .FIRST TITLE does not work; but if
.LAYOUT is set to print page numbers (of any kind) at the bottom of pages
(.LAYOUT 1 or 2 or 3), you get a page number on the first page, even if you
did not issue .FIRST TITLE.

DEFAULT

No running-head information on the first page

2-40

DSR Commands
.FLAGS ALL and .NO FLAGS ALL

.FLAGS ALL
.NO FLAGS ALL
The .FLAGS ALL and .NO FLAGS ALL commands function as a
master switch for all other .FLAGS/.NO FLAGS flag-name command
settings, except the .FLAGS/.NO FLAGS COMMENT and
.FLAGS/.NO FLAGS CONTROL commands.
.FLAGS ALL and .NO FLAGS ALL turn on and turn off recognition
of all flags without disturbing other flag command settings. (An
analogy for flag recognition is turning on a master switch [issuing
.FLAGS ALL] - those lights whose switches are in the ON position
will go on and those whose switches are in the OFF position will
not go on.) See also .ENABLE/.DISABLE BOLDING, HYPHENATION,
INDEXING, OVERSTRIKING, and UNDERLINING commands.

FORMAT

. FLAGS ALL
.FLAGS
.FL

DEFAULT

.FLAGS ALL

. NO FLAGS ALL
.NO FLAGS
.NFL

2-41

DSR Commands
.FLAGS ACCEPT and .NO FLAGS ACCEPT

.FLAGS ACCEPT
.NO FLAGS ACCEPT
The .FLAGS ACCEPT and .NO FLAGS ACCEPT commands turn on
and turn off recognition of the Accept flag character (_). See the
description of the Accept flag in Section 3.

FORMAT

parameter

.FLAGS ACCEPT[k]
.FL ACCEPT [k]

.NO FLAGS ACCEPT
.NFL ACCEPT

k
Specifies a character to replace the current flag character.

DEFAULT

2-42

. FLAGS ACCEPT - Recognition of the Accept flag character (__) is turned
on.

DSR Commands
.FLAGS BOLD and .NO FLAGS BOLD

.FLAGS BOLD
.NO FLAGS BOLD
The .FLAGS BOLD and .NO FLAGS BOLD commands turn on
and turn off recognition of the Bold flag character (*). See the
description of the Bold flag in Section 3, and the description of
.ENABLE BOLDING in this section.

FORMAT

parameter

.FLAGS BOLD [k]
.FL SOLD [k]

.NO FLAGS BOLD
.NFL BOLD

k
Specifies a character to replace the current flag character.

DEFAULT

.NO FLAGS BOLD - Recognition of the Bold flag character (*) is turned off.

2-43
\

DSR Commands
.FLAGS BREAK and .NO FLAGS BREAK

.FLAGS BREAK
.NO FLAGS BREAK
The .FLAGS BREAK and .NO FLAGS BREAK commands turn on
and turn off recognition of the Break flag character (1). See the
description of the Break flag in Section 3.

FORMAT

parameter

.FLAGS BREAK/ty
.FL BREAK [k]

.NO FLAGS BREAK
.NFL BREAK

k
Specifies a character to replace the current flag character.

DEFAULT

2-44

.NO FLAGS BREAK - Recognition of the Break flag character (1) is turned
off.

DSR Commands
.FLAGS CAPITALIZE and .NO FLAGS CAPITALIZE

.FLAGS CAPITALIZE
.NO FLAGS CAPITALIZE
The .FLAGS CAPITALIZE and .NO FLAGS CAPITALIZE commands
turn on and turn off recognition of the Capitalize flag character (< ).
See the description of the Capitalize flag in Section 3.

FORMAT
parameter

.FLAGS CAPITALIZE [k]
.FL CAPITALIZE [k]

.NO FLAGS CAPITALIZE
.NFL CAPITALIZE

k
Specifies a character to replace the current flag character.

DEFAULT

.NO FLAGS CAPITALIZE - Recognition of the Capitalize flag character ( <)
is turned off.

2-45

DSR Commands
.FLAGS COMMENT and .NO FLAGS COMMENT

.FLAGS COMMENT
.NO FLAGS COMMENT
The .FLAGS COMMENT and .NO FLAGS COMMENT commands turn
on and turn off recognition of the Comment flag character (!). See
the description of the Comment flag in Section 3.

FORMAT

parameter

.FLAGS COMMENT [k]
.FL COMMENT [k]

.NO FLAGS COMMENT
.NFL COMMENT

k
Specifies a character to replace the current flag character.

DEFAULT

2-46

.FLAGS COMMENT - Recognition of the Comment flag character (!) is
turned on.

DSR Commands
.FLAGS CONTROL and .NO FLAGS CONTROL

.FLAGS CONTROL
.NO FLAGS CONTROL
These commands control recognition of the Control flag character
(the dot that begins a DSR command). You can use .FLAGS
CONTROL to change the character that precedes the commands
from a dot to a character of your choice. You can use .NO FLAGS
CONTROL to turn off recognition of the Control flag character.
Note: There is no way to reenable recognition of the Control flag once you issue
a .NO FLAGS CONTROL command.

FORMAT

parameter

.FLAGS CONTROL//cy
.FL CONTROL [k]

.NO FLAGS CONTROL
.NFL CONTROL

k
Specifies a character to replace the current Control flag character.

DEFAULT

.FLAGS CONTROL - Recognition of the Control flag character (.) is
turned on.

2-47

DSR Commands
.FLAGS HYPHENATE and .NO FLAGS HYPHENATE

.FLAGS HYPHENATE
.NO FLAGS HYPHENATE
The .FLAGS HYPHENATE and .NO FLAGS HYPHENATE commands
turn on and turn off recognition of the Hyphenate flag character ( = ).
See the description of the Hyphenate flag in Section 3, and .ENABLE
HYPHENATION in this section.

FORMAT

parameter

.FLAGS HYPHENATE [k] .NO FLAGS
HYPHENATE
.FL HYPHENATE [k]
.NFL HYPHENATE
k
Specifies a character to replace the current flag character.

DEFAULT

2-48

.NO FLAGS HYPHENATE - Recognition of the Hyphenate flag character ( = )
is turned off.

DSR Commands
.FLAGS INDEX and .NO FLAGS INDEX

.FLAGS INDEX
.NO FLAGS INDEX
These commands respectively turn on and turn off recognition of
the Index flag character ( > ). See the description on the Index flag
in Section 3, and .ENABLE INDEXING in this section.

FORMAT

parameter

.FLAGS INDEX[k]
.FL INDEX [k]

.NO FLAGS INDEX
.NFL INDEX

k
Specifies a character to replace the current flag character.

DEFAULT

.NO FLAGS INDEX - Recognition of the Index flag character (> ) is
turned off.

2-49

DSR Commands
.FLAGS LOWERCASE and .NO FLAGS LOWERCASE

.FLAGS LOWERCASE
.NO FLAGS LOWERCASE
The .FLAGS LOWERCASE and .NO FLAGS LOWERCASE commands
turn on and turn off recognition of the Lowercase flag character (\)
See Section 3 for a description of the Lowercase flag.

FORMAT

parameter

.FLAGS LOWERCASE/ty .NO FLAGS
LOWERCASE
FL LOWERCASE [k]
.NFL LOWERCASE

k
Specifies a character to replace the current flag character.

DEFAULT

.FLAGS LOWERCASE - Recognition of the Lowercase flag character (\) is
turned on.

DSR Commands
.FLAGS OVERSTRIKE and .NO FLAGS OVERSTRIKE

.FLAGS OVERSTRIKE
.NO FLAGS OVERSTRIKE
The .FLAGS OVERSTRIKE and .NO FLAGS OVERSTRIKE commands
enable and disable recognition of the Overstrike flag character (%).
See the description of the Overstrike flag in Section 3, and .ENABLE
OVERSTRIKING in this section.

FORMAT

parameter

.FLAGS OVERSTRIKE [k] .NO FLAGS
OVERSTRIKE
.FL OVERSTRIKE [k]
.NFL OVERSTRIKE

k
Specifies a character to replace the current flag character.

DEFAULT

.NO FLAGS OVERSTRIKE - Recognition of the Overstrike flag character (%)
is turned off.

2-51

DSR Commands
.FLAGS PERIOD and .NO FLAGS PERIOD

.FLAGS PERIOD
.NO FLAGS PERIOD
The .FLAGS PERIOD and .NO FLAGS PERIOD commands turn on
and turn off recognition of the Period flag character ( + ). See the
description of the Period flag in Section 3.

FORMAT

parameter

FLAGS PERIOD [k]
.FL PERIOD [k]

.NO FLAGS PERIOD
.NFL PERIOD

k
Specifies a character to replace the current flag character.

DEFAULT

2-52

.NO FLAGS PERIOD - Recognition of the Period flag character (+) is
turned off.

DSR Commands
.FLAGS SPACE and .NO FLAGS SPACE

.FLAGS SPACE
.NO FLAGS SPACE
The .FLAGS SPACE and .NO FLAGS SPACE commands turn on
and turn off recognition of the Space flag character (#). See the
description of the Space flag in Section 3.

FORMAT

parameter

.FLAGS SPACE [k]
.FL SPACE [k]

.NO FLAGS SPACE
.NFL SPACE

k
Specifies a character to replace the current flag character.

DEFAULT

.FLAGS SPACE - Recognition of the Space flag character (#) is turned on.

2-53

DSR Commands
.FLAGS SUBINDEX and .NO FLAGS SUBINDEX

.FLAGS SUBINDEX
.NO FLAGS SUBINDEX
The .FLAGS SUBINDEX and .NO FLAGS SUBINDEX commands
turn on and turn off recognition of the Subindex flag ( > ). You can
also use the .FLAGS SUBINDEX command to change the Subindex
flag to another character. If you issue .NO FLAGS SUBINDEX, the
command will cause a right angle bracket (> ) to be printed as part
of your indexed text, instead of causing subindexing. See Section 3
for a description of the Subindex flag. Section 6 has information on
the DSR indexing utility.

FORMAT

parameter

.FLAGS SUBINDEX [k]
.FL SUBINDEX [k]

.NO FLAGS SUBINDEX
.NFL SUBINDEX

k
Specifies a character to replace the current flag character.

DEFAULT

2-54

.FLAGS SUBINDEX - Recognition of the Subindex flag character (> ) within
.INDEX or .ENTRY commands is turned on. The Subindex flag character is
always taken as normal text outside an .INDEX or .ENTRY command.

DSR Commands
.FLAGS SUBSTITUTE and .NO FLAGS SUBSTITUTE

.FLAGS SUBSTITUTE
.NO FLAGS SUBSTITUTE
The .FLAGS SUBSTITUTE and .NO FLAGS SUBSTITUTE commands
turn on and turn off recognition of the Substitute flag character
($). The default Substitute flag character ($) or any replacement
character you specify must be used in pairs. See the description of
the Substitute flag pair in Section 3.

FORMAT

parameter

.FLAGS SUBSTITUTE [k] .NO FLAGS
SUBSTITUTE
FL SUBSTITUTE [k]
.NFL SUBSTITUTE
k
Specifies a character to replace the current flag character.

DEFAULT

.NO FLAGS SUBSTITUTE - Recognition of the Substitute flag character ($) is
turned off.

DSR Commands
.FLAGS UNDERLINE and .NO FLAGS UNDERLINE

.FLAGS UNDERLINE
.NO FLAGS UNDERLINE
The .FLAGS UNDERLINE and .NO FLAGS UNDERLINE commands
turn on and turn off recognition of the Underline flag character (&).
See the description of the Underline flag in Section 3, and .ENABLE
UNDERLINING in this section.

FORMAT

parameter

.FLAGS UNDERLINE [k]
.FL UNDERLINE [k]

.NO FLAGS UNDERLINE
.NFL UNDERLINE

k
Specifies a character to replace the current flag character.

DEFAULT

2-56

.FLAGS UNDERLINE - Recognition of the Underline flag character (&) is
turned on.

DSR Commands
.FLAGS UPPERCASE and .NO FLAGS UPPERCASE

.FLAGS UPPERCASE
.NO FLAGS UPPERCASE
The .FLAGS UPPERCASE and .NO FLAGS UPPERCASE commands
turn on and turn off recognition of the Uppercase flag (*)• See the
description of the Uppercase flag in Section 3.

FORMAT

FLAGS UPPERCASE [k]
.FL UPPERCASE [k]

parameter

.NO FLAGS
UPPERCASE
.NFL UPPERCASE

k
Specifies a character to replace the current flag character.

DEFAULT

.FLAGS UPPERCASE - Recognition of the Uppercase flag character (") is
turned on.

2-57

DSR Commands
.FOOTNOTE and .END FOOTNOTE

.FOOTNOTE
.END FOOTNOTE
The .FOOTNOTE command places the text following it at the bottom
of the current page if there is room. If there is not enough room on
the current page for the entire footnote, DSR places the entire note
at the bottom of the next page.
The .END FOOTNOTE command ends the footnote and restores any
case, fill, justify, spacing, or margin settings that you might have
changed within the footnote.
The right margin of the footnote will be the same as the right margin
in effect for the document at the time the footnote is created. If you
change the right margin of the document, but want the right margin
of all footnotes to be the same, use the .RIGHT MARGIN command
immediately after each .FOOTNOTE command, to set the same right
margin for each footnote.
The left margin setting of the footnote is defaulted to 0.

FORMAT
parameter

.FOOTNOTE [n]
.FN [n]

.END FOOTNOTE
.EFN

n
The number of lines the footnote will occupy. This argument is included
only for compatibility with older versions of RUNOFF and is not necessary or
recommended.

DESCRIPTION

.FOOTNOTE does not provide a footnote symbol, such as * or (1), or any
separation from the main text just above the footnote.
•

You can create a separator of 15 hyphens (-) as follows:
.FOOTNOTE
.REPEAT 15"-"
.BREAK

•

You can put an asterisk (*) before the text of the footnote as follows:
.LEFT MARGIN 2
.INDENT -2;_*#text
.END FOOTNOTE

2-58

DSR Commands
.FOOTNOTE and .END FOOTNOTE

RELATED
COMMAND

DSR tries to put all footnotes at the bottom of the page on which they
occur. If this is not possible—if a footnote reference occurs too near the
bottom of the page, or if you issue more footnotes than there is room
for—DSR puts one or more of the footnotes at the bottom of the following
page.

DSR does not split a single footnote over two pages.

If you have issued a .NO PAGING command, all footnotes appear at the end
of your document.

2-59

DSR Commands
.HEADER LEVEL

.HEADER LEVEL
The .HEADER LEVEL command allows you to specify both a section
number and a section title. Successive .HEADER LEVEL commands
of the same value (all .HEADER LEVEL 1's for example) cause
the section numbers to increase sequentially. This happens at all
six levels of headers. If your current section is in Chapter 2 and
is numbered 2.5.2.4, then the following numbering would result
depending upon the .HEADER LEVEL command you used:
•

.HL3 (or .HL without a value) would number the next section
2.5.2.5

•

.HL2 would number the next section 2.5.3

•

.HL1 would number the next section 2.6

(See also .DISPLAY LEVELS, .NUMBER LEVEL, .SET LEVEL, and
.STYLE HEADERS.)
Following is a summary of default header level numbering for three
levels of three different types of documents:
Default Header Level Numbering

FORMAT

parameters

Nonchapter

Chapter n

Appendix A

.HEADER LEVEL 1

n. 1

A. 1

.HEADER LEVEL 2

1.1

n.1.1

A.1.1

.HEADER LEVEL 3

1.1.1

n.1.1.1

A.1.1.1

.HEADER LEVEL [[+/-]n][title]
.HL [[+/-]n[title]
n
A number from 1 to 6 that specifies the level of the header. Do not confuse
the level numbers with the header numbers that are printed in your document
just to the left of the header title.

-hil
Adds n to the current header level number.

—n
Subtracts n from the current header level number.

title
The name of the section you are now starting. Do not precede the title with a
semicolon (;).

2-60

DSR Commands
.HEADER LEVEL

DESCRIPTION i

The .HEADER LEVEL command issues a .BREAK before doing its main
task.

.HEADER LEVEL issues a .TEST PAGE using seven more than the
.PARAGRAPH or .SET PARAGRAPH value (you can change the test-page
value by using the .STYLE HEADERS command). If the required number
of lines is not available on the current page, DSR puts the header at the
beginning of the next page. Note that these paragraph commands take
into account the .SPACING value when they interpret the test-page value.

.HEADER LEVEL issues a .FILL and a JUSTIFY unless you have issued a
.NO AUTOJUSTIFY. (However, note that if .JUSTIFY was in effect before
you issued .HEADER LEVEL, .NO AUTOJUSTIFY does not cancel the
.JUSTIFY.)

.HEADER LEVEL 1 text is normally printed in all uppercase letters,
regardless of how it is typed. All other levels are normally printed with
only the first letter of each word in uppercase. You can override the initial
capitalization of words like of and the by preceding any of them with a
Lowercase flag (\). Alternatively, you can have the letters printed exactly
as you type them by preceding the title with the flag pair
(See also
.STYLE HEADERS.)

Header levels 3 through 6 are normally run into the text, but separated
from it by a hyphen (-). You can suppress the hyphen by not entering
the header level title on the same line as the .HEADER LEVEL command.
(See also .STYLE HEADERS.)

6 If the title you specify for the header is wider than the current margins, it
is filled (and justified, if justification is in effect) between the right margin
and the header level number. See Example 2-10.

RELATED
COMMANDS

DEFAULT

If .AUTOSUBTITLE is in effect, titles of specified header levels are used as
running subtitles at the tops of pages.

You can use the .SET LEVEL command to preset the level of the next
section head without issuing a previous .HEADER LEVEL.

If you issue .HEADER LEVEL without specifying a level number, you get
the current header level. All header levels, .HEADER LEVEL 1 to .HEADER
LEVEL 6, begin their numbering with 1 unless you specify another value with
.NUMBER LEVEL.

2-61

oriented document.

Example 2-9

Header Levels in a Chapter-Oriented Doc

The following input produces the section numbers and titles for Ch
.NUMBER CHAPTER 5
.CHAPTER FIFTH CHAPTER
.HEADER LEVEL1 This the first header level 1
.HEADER LEVEL1 This is the second header level 1
.HEADER LEVEL2 This is the first header level 2
.HEADER LEVEL2 This is the second header level 2
.HEADER LEVEL3 This is the first header level 3
.HEADER LEVEL3 This is the second header level 3

When the input file is processed with DSR, the sections in the chap
numbered and titled in the following way:
CHAPTER 5
FIFTH CHAPTER
5.1

THIS THE FIRST HEADER LEVEL 1

5.2

THIS IS THE SECOND HEADER LEVEL 1

5.2.1

This Is The First Header Level 2

5.2.2

This Is The Second Header Level 2

5.2.2.1

This Is The First Header Level 3 -

5.2.2.2

This Is The Second Header Level 3

Example 2-10 illustrates the use of the .HEADER LEVEL command
long title.

Example 2-10

Long Header Level Text

The following shows input text before it is processed by DSR:
.RIGHT MARGIN 40
.HEADER LEVEL 2 long header level that exceeds the margins
More text, which will revert to Column 1.

The output format looks like this:
2.3

Long Header Level That Exceeds
Margins

More text, which will revert
1.

2-62

The

Column

DSR Commands
.HEADERS ON and .NO HEADERS

.HEADERS ON
.NO HEADERS
The .HEADERS ON and .NO HEADERS commands restore and
cancel, respectively, the capability of having one or two lines of
information at the top of a page. These lines indicate the content
of the page and the page number. They are called running heads,
which you should not confuse with section heads (specified with
.HEADER LEVEL commands).

FORMAT

.HEADERS [ON]
.HD [ON]
.HD

DESCRIPTION

.NO HEADERS
.NHD

Standard running-head information consists of a title at the top left of
the page and the page number preceded by the word page at the top
right (flush with the .PAGE SIZE page width, not with the right margin).
A subtitle normally appears on the second line of the page immediately
below the title. You can also have the current date appear on the right,
immediately below the page number.
Note that you can cause information to appear in positions other than
these by issuing the .LAYOUT command.

No running heads appear on the first page unless you issue a .FIRST
TITLE command. However, if you have issued a .LAYOUT command
that puts page numbers at the bottom of pages, the first page will have a
number even if you do not issue .FIRST TITLE.

If you are using .CHAPTER commands in your document and if headers
are on, DSR uses the title of the current chapter as the running-head
title. You can, however, override this function by issuing a .TITLE
command after the .CHAPTER command. If you are not using .CHAPTER
commands, you must issue a .TITLE command to get a running-head title.

Use the .SUBTITLE command to specify a subtitle for running heads or
to make it possible for you to issue a valid .AUTOSUBTITLE or .DATE.
.AUTOSUBTITLE uses titles of .HEADER LEVEL commands (down to
whatever level you specify) as subtitles in running heads.

2-63

DSR Commands
.HEADERS ON and .NO HEADERS

DEFAULT

2-64

If you are using .CHAPTER or .APPENDIX commands, page numbers
appear in the form c-p, where c is the chapter number and p is the page
number within the chapter. If your document has no chapters, you get
page numbers of the form n, where n is a running page number. You
can control the case of the word page by issuing a .HEADERS LOWER,
.HEADERS UPPER, or .HEADERS MIXED command. You can suppress
page numbers in the running heads by issuing .NO NUMBER.

You can cause the current date to appear in the running heads by issuing
the .DATE command. You must also have issued .SUBTITLE for .DATE to
work.

.HEADERS ON

DSR Commands
.HEADERS UPPER, .HEADERS LOWER, and .HEADERS MIXED

.HEADERS UPPER, .HEADERS LOWER,
.HEADERS MIXED
The .HEADERS UPPER/LOWER/MIXED commands specify the case
of the word page that precedes the page number. The commands
produce, respectively, PAGE, page, and Page. In an index, these
commands also affect the word index that is part of the page
number, for example. Page Index-3. The command normally takes
effect on the next page.

FORMAT

.HEADERS UPPER
LOWER
MIXED
.HD UPPER
LOWER
MIXED

DEFAULT

.HEADERS MIXED

2-65

DSR Commands
.IF, .IFNOT, .ELSE, and .ENDIF

.IF, .IFNOT, .ELSE,
.ENDIF
The .IF, .IF NOT, .ELSE, and .ENDIF commands (also known as the
conditional commands) cause portions of a DSR file to be processed
or not processed, according to conditions that you specify. The
commands refer to the /VARIANT qualifier that you specify on
the DSR command line. (See also /DEBUG=CONDITIONALS and
.VARIABLE.)

FORMAT

parameter

.IF name
.ELSE name
.ENDIF name (or .El name)
. 1F N OT name (or. 1N name)
.ELSE name
.ENDIF name
name
A word that is common to the conditional commands that make up a single
.IF or .IFNOT block of text.

DESCRIPTION

The command line qualifier /VARIANT is of the form
/VARIANT=x or /VARIANT="xl,x2,...xn"

where x is a name you give to a portion, or to separate portions, of a DSR file
to be processed.

2-66

DSR Commands
.IF, .IFNOT, .ELSE, and .ENDIF

In the following definitions, A is a name that may have been specified in a
/VARIANT qualifier.
Command

Meaning

.IF A

If A was specified in /VARIANT, then DSR processes the
portion of the file following .IF A down to the next .ELSE A or
.ENDIF A.
If A was not specified in /VARIANT, then DSR ignores the
portion of the file following .IF A down to the next .ELSE A or
.ENDIF A.

.IFNOT A

If A was not specified in /VARIANT, then DSR processes the
portion of the file following .IFNOT A down to the next .ELSE
A or .ENDIF A.
If A was specified in /VARIANT, then DSR ignores the portion
of the file following .IFNOT A down to the next .ELSE A or
.ENDIF A.

.ELSE A

If DSR processed the portion of the file following the most
recent .IF A or .IFNOT A, it ignores the portion of the file
following .ELSE A down to the next .ENDIF A.
If DSR ignored the portion of the file following the most recent
.IF A or .IFNOT A, it processes the portion of the file following
.ELSE A down to the next .ENDIF A.

.ENDIF A

DSR terminates the most recent .IF A or .IFNOT A.

Notes
1

Each of the conditional commands must begin in column one; therefore
each command must be entered on a separate line.

You can have .IF/.ELSE/.ENDIF blocks (or .IFNOT/.ELSE/.ENDIF
blocks) within other such blocks, as shown in Example 2-11. (See similar
discussion in description of .LIST and .END LIST.)

You are not required to use an .ELSE command in an .IF or .IFNOT block.

You cannot have an .IF and an .IFNOT with the same name in the same
block.

For purposes of debugging or analysis, you can distinguish those portions
that would normally be processed from those that would not normally be
processed. See .VARIABLE and /DEBUG=CONDITIONALS.

6 If /VARIANT and /DEBUG are both present in the command line,
/DEBUG overrides /VARIANT.

RELATED
COMMAND

If you issue a .VARIABLE command in your text file and
/DEBUG=CONDITIONALS in the DSR command line (or just /DEBUG
if you do not want to limit debugging to conditionals), all the segments
in the preceding example will be processed. In addition, you can issue
.VARIABLE commands in your text file to distinguish between the portions of
text generated by the various segments.

2—67

DSR Commands
.IF, .IFNOT, .ELSE, and .ENDIF

EXAMPLE
Example 2-11 shows how you enter three groups of conditional commands
(A, B, C) with groups B and C nested within group A. This example explains
what DSR does when it encounters each entry. Segment refers to a block of
text.

Example 2-11

2-68

Conditional Commands

Entry

Explanation

.IF A

Begin segment A.

A1 Segment

Process A1 if A was specified.

.IF B

Begin segment B.

B1 Segment

Process B1 if both A and B were specified.

ELSE B

Alternative segment B.

B2 Segment

Process B2 if A was specified and B was not.

.ENDIF B

End segment B.

A2 Segment

Process A2 if A was specified.

.ELSE A

The following segment is processed only if A was not
specified.

A3 Segment

Process A3 if A was not specified.

.IF C

Begin segment C.

Cl Segment

Process Cl if A was not specified and C was.

.ELSE C

Alternative segment C.

C2 Segment

Process C2 if neither A nor C was specified.

.ENDIF C

End segment C.

A4 Segment

Process A4 if A was not specified.

.ENDIF A

End segment A.

DSR Commands
.INDENT

.INDENT
The .INDENT command causes the first line of text following it to
begin at a position relative to the left margin.

FORMAT

parameters

.INDENT [[-]n]
•1 [Hn]
n
Specifies how many character positions to the right of the .LEFT MARGIN
setting the first line of text will begin.
—n
Specifies how many character positions to the left of the .LEFT MARGIN
setting the first line of text will begin. An .INDENT cannot begin to the left
of character position 0.

DESCRIPTION

The .INDENT command issues a .BREAK before doing its main task.

RELATED
COMMAND

If you issue a .BREAK immediately after an .INDENT, you will cancel the
indentation just requested. (This effect occurs with most of the commands
that issue .BREAK commands.)

DEFAULT

If you issue .INDENT without a number, you get the indent value that you
specified with .PARAGRAPH or .SET PARAGRAPH. If you did not issue
either of these paragraph commands, you get an indentation of 5.

2-69

DSR Commands
.INDEX

.INDEX
The .INDEX command creates an index entry with a page number
reference. See Section 6, Creating an Index, for information on the
DSR indexing utility.

FORMAT

. 1NDEX topic[> subtopic 1... > subtopicn]
.X topic[> subtopic 1... > subtopicn]

EXAMPLE
Example 2-12 illustrates the use of the .INDEX command.

Example 2-12

.INDEX entries

The following shows input text before it is processed by DSR and the DSR
indexing utility:
.PAGE
text text text text text text text text text text text text
.INDEX Parameters description
.PAGE
text text text text text text text text text text text text
.INDEX Parameters >Examples
.PAGE
text text text text text text text text text text text text
.INDEX Parameters >Types >Strings
.INDEX Parameters >Types >Integers

The following shows the output after the file has been processed with DSR
and the DSR indexing utility (See Section 6.)
Page Index-1
INDEX

Parameters
Description, 1
Examples, 2
Types
Integers, 3
Strings, 3

2-70

DSR Commands
.JUSTIFY and .NO JUSTIFY

!no justify
The .JUSTIFY command causes DSR to insert exactly enough space
between words so that the last character reaches the right margin.
The .NO JUSTIFY command disables justification.

FORMAT

.JUSTIFY
.J

DESCRIPTION

Both JUSTIFY and .NO JUSTIFY issue .BREAKs before doing their main
tasks.

You can create an uneven right margin (ragged right text format) by using
the .NO JUSTIFY command and the .FILL command.

If you want text justified without lines being filled, you must issue
.JUSTIFY after you issue .NO FILL.

.NO FILL suspends justification as well as line-filling.

.FILL normally restores the most recent .JUSTIFY or .NO JUSTIFY setting
that was in effect. A .NO JUSTIFY state that was set as a result of .NO
FILL is not considered when DSR is determining the most recent setting.
In other words, .NO FILL turns off both filling and justification, and .FILL
restores them.

The following commands issue .JUSTIFY commands unless you have
issued .NO AUTOJUSTIFY:

RELATED
COMMANDS

.NO JUSTIFY
.NJ

.APPENDIX
.CHAPTER
.HEADER LEVEL
.NOTE

DEFAULT

If you have issued .NO AUTOJUSTIFY and if .JUSTIFY is in effect at the
time you issue any of the above four commands, .JUSTIFY is not canceled
(see .NO AUTOJUSTIFY).

JUSTIFY

2-71

DSR Commands
.JUSTIFY and .NO JUSTIFY

EXAMPLE
Example 2-13 illustrates the use of the JUSTIFY command.

Example 2-13 Justified Text and Unjustified Text
The following shows an input file before it is processed by DSR:
.RIGHT MARGIN 50
.NO JUSTIFY
Person is used increasingly to create compounds
which may refer to either a man or woman:
chairperson, spokesperson,
anchorperson, salesperson.
.BLANK
.JUSTIFY
Person is used increasingly to create compounds
which may refer to either a man or woman:
chairperson, spokesperson,
anchorperson, salesperson.

The following shows the unjustified and justified text after the file has been
processed with the DSR:
Person is used increasingly to create compounds
which may refer to either a man or woman:
chairperson, spokesperson, anchorperson,
salesperson.
Person is used increasingly to create compounds
which
may refer to either a man or woman:
chairperson,
spokesperson,
anchorperson,
salesperson.

2-72

DSR Commands
.KEEP and .NO KEEP

.KEEP
.NO KEEP
The .KEEP command allows you to keep in the output file blank lines
that are present in the input file when .NO FILL is in effect. Normally,
multiple blank lines in the input file are discarded in the output file
while .NO FILL is in effect. .NO KEEP also discards blank lines when
.NO FILL is in effect. (See also .LITERAL.)

FORMAT

.KEEP
.K

.NO KEEP
.NK

DESCRIPTION The combination of the .KEEP and .NO FILL commands differs from

.LITERAL in that it allows you to issue commands and flags while .KEEP
and .NO FILL are in effect. For example, you can issue a .REQUIRE
command after .KEEP and .NO FILL, whereas after .LITERAL no commands
are recognized until after an .END LITERAL command.

DEFAULT

.NO KEEP

EXAMPLE
Example 2-14 shows how to use the .KEEP command.

2-73

DSR Commands
.KEEP and .NO KEEP

Example 2-14

.KEEP

The following shows the input text format, without the .KEEP command,
before it is processed by DSR:

.BLANK

.BLANK.NO FILL

.BLANK.FILL

Here is the output text format. Note that the .NO FILL command does not
cause DSR to keep the blank lines as they appear in the input text:

Here is the same input file, with the .KEEP command added, before
processing by DSR:

.BLANK

.KEEP
.BLANK.NO FILL

.BLANK.FILL

The output file is this:

Note that the .KEEP command causes DSR to keep the blank lines as they
appear in the input file.

2-74

DSR Commands
.LAYOUT

.LAYOUT
The .LAYOUT command rearranges running-head and running-foot
information on pages. (See also .HEADERS ON.)

FORMAT

parameters

.LAYOUT nl [,n2]
.LO n 1 [,n2]
nl
A number from 0 to 3 that specifies one of the following arrangements of
running head information:
.LAYOUT 0

Restores the standard arrangement of title and subtitle in the
upper left of a page, and page number and date in the upper
right.

.LAYOUT 1

Titles and subtitles are centered at the tops of pages. Page
numbers are centered at the bottom.

LAYOUT 2

Titles and subtitles appear at the top right of right-hand
(odd-numbered) pages and at the top left of left-hand (evennumbered) pages. Page numbers are centered at the bottom.

LAYOUT 3

Gives the standard page arrangement for title and subtitle (as
in .LAYOUT 0), but with the addition of running-page numbers
centered at the bottom of pages between two hyphens (for
example, - 23 -). Running-page numbers are consecutive
through the entire document rather than within chapters; they
are not affected by the .NO NUMBER or .NUMBER PAGE
command. (But see .NUMBER RUNNING.)

n2
Specifies how many lines below the last line of text on a page the number
will appear. You must specify n2 if nl is 1, 2, or 3. If nl is 0, you cannot
specify a value for n2.

DESCRIPTION i
2

DEFAULT

The .LAYOUT command issues a .BREAK before doing its main task.
The page length (.PAGE SIZE) is not affected by this command.

.LAYOUT 0

2-75

DSR Commands
.LAYOUT

EXAMPLES
Examples 2-15 through 2-19 below are for pages of a second chapter in
a document with 20 pages in the first chapter. The .DATE command has
been issued. The title is "INTRODUCTION TO DSR"; the subtitle is "DSR
COMMAND FORMAT."

Example 2-15

.LAYOUT 0 (Default)

INTRODUCTION TO DSR
DSR COMMAND FORMAT

Page 2-2
11 December 1984

[text of page 2-2]

Example 2-16

.LAYOUT 1,2
INTRODUCTION TO DSR
DSR COMMAND FORMAT

[text of page 2-2]

2-2

Example 2-17

.LAYOUT 2,2 (Even Page)

INTRODUCTION TO DSR
DSR COMMAND FORMAT

[text of page 2-2]

2-2

2-76

[text of page 2-3]

2-3

Example 2-19

.LAYOUT 3,2

INTRODUCTION TO DSR
DSR COMMAND FORMAT

[text of page 2-2]

2-2

DSR Commands
.LEFT MARGIN

.LEFT MARGIN
The .LEFT MARGIN command sets the left margin to the specified
position.

FORMAT

parameters

.LEFT MARGIN [[+/-]n]
.LM [[+/-]n]
n
Specifies the number of the character position of the left margin. For example,
.LEFT MARGIN 0 sets the left margin just to the left of the first character
position.

-hfl
Sets the left margin n character positions to the right of the current left
margin.

—n
Sets the left margin n character positions to the left of the current left margin.

DESCRIPTION

.LEFT MARGIN issues a .BREAK before setting the left margin.

The value for the left margin must be smaller than the value for the right
margin.

If you want a left margin value that is larger than 70 (the default for
.RIGHT MARGIN), you must issue a .RIGHT MARGIN command with
a value greater than the left margin value before you issue the .LEFT
MARGIN command.

The resulting value for +n must be smaller than the right margin value
(see .RIGHT MARGIN).

The resulting value for -n cannot be less than 0.

RELATED
COMMAND

.LIST and .NOTE change the left margin; .END LIST and .END NOTE restore
it.

DEFAULT

.LEFT MARGIN 0

2-78

DSR Commands
.LIST and .END LIST

.LIST
.END LIST
The .LIST command specifies the beginning of a list by resetting
the .LEFT MARGIN farther to the right, by setting a .SKIP value
to take effect before each item in the list, and by issuing a .TEST
PAGE. Use a .LIST ELEMENT command to specify each item in the
list. .LIST ELEMENT commands also give you numbers or letters in
sequence in the left margin, or let you substitute a single character
of your choice for each of the numbers or letters (for example,
the lowercase letter o, which is known as a "bullet"). (See also
.DISPLAY ELEMENTS and .NUMBER LIST.)
The .END LIST command ends a list, restoring any fill, justify, case,
margin, or spacing settings that were in effect before you issued
the most recent .LIST command. You can also specify a value with
.END LIST that puts blank lines after the last item in the list (as with
.SKIP).

FORMAT

parameters

.LIST [[-]n] [”x"J
•LIST [[-]n]['x']
•LS [[-]n] ["x"]
■LS [[-]n]['x']

.END LIST [[-]n]
.END LIST [[-]n]
■ELS [[-]n]
•ELS [[-]n]

n
With .LIST, specifies the number of blank lines to appear before each item,
but each blank line can result in additional blank lines if the .SPACING
setting is greater than 1. (See .SKIP n.)
With .END LIST, behaves the same as n with .LIST. However, the blank lines
appear after the final item in the current list.

—n
With .LIST, pushes the next line of list text to within n lines of the bottom of
the current page by inserting blank lines. (See .SKIP -n and .BLANK -n.)
With .END LIST, pushes the next line of current list text to within n lines of
the bottom of the current page by inserting blank lines. (See .SKIP -n and
.BLANK -n.)
X
A character enclosed in quotation marks ("x") or apostrophes (V) that you can
specify to appear at the beginning of each list item.

2-79

DSR Commands
.LIST and .END LIST

DESCRIPTION

A list is defined by a .LIST and a paired .END LIST. Other lists, similarly
defined, can exist within it. You can nest lists up to 14 levels.
If the .LEFT MARGIN is set at 0 before you issue .LIST, the .LIST issues
a .LEFT MARGIN 9. If the .LEFT MARGIN is not set at 0 just before you
issue .LIST, then the .LIST issues a .LEFT MARGIN +4.
.LIST issues a .TEST PAGE, adding 2 to the test-page value from either
the most recently issued .PARAGRAPH or .SET PARAGRAPH command
or from its default value. Paragraph commands take into account the
.SPACING value that is in effect when they interpret the test-page value.
You can issue a .LIST without having to issue a .LIST ELEMENT for it.
You must pair every .LIST you issue with an .END LIST. It is important to
know how the pairing works if you want to make lists within other lists:
•

While you are in a list, you can issue a new .LIST without having
issued an .END LIST for the previous .LIST.

•

When you issue the next .END LIST, you end only the new inner
.LIST.

•

You can then add more items to the main outer .LIST by issuing more
.LIST ELEMENT commands. All attributes of the outer list will be
restored, including the resumption of any sequence of numbers or
letters that was in effect. For example:
.LIST (main)
.LIST ELEMENT
.LIST ELEMENT
.LIST (new)
.LIST ELEMENT
.LIST ELEMENT
.END LIST (new)
.LIST ELEMENT
.LIST ELEMENT
.END LIST (main)
You can also issue another .END LIST to end the main list immediately
after the .END LIST that ends the new inner list.

DEFAULTS

If you omit n from either .LIST or .END LIST, you get the .SKIP value
associated with .PARAGRAPH or .SET PARAGRAPH or 1 (if you have
not specified such a value).
If you omit "x," you get a sequence of decimal numbers beginning with 1,
or you get another kind of sequence if you issue a .DISPLAY ELEMENTS
command after the .LIST.

2—80

DSR Commands
.LIST and .END LIST

EXAMPLE
Example 2-20 illustrates the use of the .LIST command.
Example 2-20

Default List Format

The following shows the input file before it is processed by DSR:
Following are the names of some of the French Impressionists:
.LIST
.LIST ELEMENT;Renoir
.LIST ELEMENT;Manet
.LIST ELEMENT;Monet
.LIST ELEMENT;Seurat
.END LIST

The following shows the formatted text after the file has been processed with
the DSR:
Following are the names of some of the French Impressionists:
1.

Renoir

Manet

Monet

Seurat

2-81

DSR Commands
.LIST ELEMENT

.LIST ELEMENT
The .LIST ELEMENT command specifies the beginning of each
item in a list. If you specify a character in a .LIST command, it
appears, followed by two spaces, before each item. Otherwise,
a sequence of numbers or letters, as defined in the .DISPLAY
ELEMENTS command, appears when you issue successive
.LIST ELEMENT commands. If you have not issued a .DISPLAY
ELEMENTS command, you will get a sequence of decimal numbers,
each followed by a period and two spaces. (See .LIST, .END LIST,
.DISPLAY ELEMENTS, and .NUMBER LIST.)

FORMAT

parameter

.LIST ELEMENT; text
.LE; text
text
The text that will appear after the list element delimiter.

DESCRIPTION

2-82

The .LIST ELEMENT command issues a .BREAK before doing its main
task.

You can specify the number of the next element in the sequence by issuing
a .NUMBER LIST.

A sequence is interrupted by the next occurrence of a .LIST or .END LIST.

If you have not yet ended the current list, a new .LIST temporarily
suspends all the attributes of the old one. The next .END LIST ends only
the new .LIST and restores all the attributes of the old .LIST. You can nest
lists up to 14 levels.

If you have issued a .LIST command, both the number of blank lines
before each .LIST ELEMENT item and the .LEFT MARGIN setting for the
list of items are as noted in the .LIST description.

You can issue .LIST ELEMENT without having issued .LIST. If you have
not issued a .LIST command, you will get the .LEFT MARGIN setting that
was in effect before you issued the .LIST ELEMENT. If an item is more
than one line long, the character or number normally printed in the left
margin will be merged with the text of the item instead.

DSR Commands
.LIST ELEMENT

DEFAULTS

If you have not issued a .LIST command with a specified character to
appear in the left margin, you will get the kind of sequence that you
specified in .DISPLAY ELEMENTS.

If you have not issued a .DISPLAY ELEMENTS command, you will get
decimal numbers, each followed by a period and two spaces.

EXAMPLE
Example 2-20, in the .LIST example section, illustrates the use of the .LIST
and .LIST ELEMENT commands.

2-83

DSR Commands
.LITERAL

.LITERAL
The .LITERAL command allows you to have your text formatted
exactly as you have typed it. This means that you will get a blank
line in the output file wherever a blank line occurs in the input file (If
the value of .SPACING is anything other than one, you will get the
spacing value that you specified.)
Commands are not recognized when .LITERAL is in effect and are
treated as ordinary text if you enter them. DSR flags are also treated
as normal text. Tab stops set prior to the .LITERAL command,
however, are still in effect within the block of .LITERAL text (see
.TAB STOPS). You must issue an .END LITERAL when you want
DSR to resume normal formatting.

FORMAT

parameter

.LITERAL [n]
.LT [n]

.END LITERAL
.EL

n
The number of lines to be produced. This argument is included only for
compatibility with older versions of RUNOFF and is not necessary or
recommended.

DESCRIPTION

.LITERAL issues a .BREAK before doing its main task.

.LITERAL issues a .RIGHT MARGIN 150.

If .LITERAL is in effect, a blank line occurs in the output file wherever one
occurs in the input file. If .LITERAL (or .KEEP) is not in effect, you cannot
produce blank lines by putting them in the input file, even if .NO FILL is
in effect.

4 Between .LITERAL and .END LITERAL, all recognition of commands
and flags is suspended. In addition, nearly all commands and flags that
were in effect before you issued .LITERAL are disabled. For example,
previously specified case, fill, and justify operations are disabled. If you
want to be able to use commands and flags and still get all the benefits
of .LITERAL, you can use the .KEEP and .NO FILL commands instead of
.LITERAL.

The settings that were in effect for the following commands and flags prior
to the .LITERAL remain in effect for the .LITERAL text:
.LEFT MARGIN
.SPACING
.TAB STOPS
(Underlining)
(Bolding)

2-84

DSR Commands
.NO SPACE

.NO SPACE
The .NO SPACE command prevents the insertion of the end-of-line
space for one text line only, causing the characters at the end of one
line and the beginning of the next to be adjacent.
Without the .NO SPACE command, when .FILL is in effect, DSR
treats the end of an input line exactly like a space. That is, it inserts
a space in the output file at the place where each input line ended
(this is the meaning of "fill").
If you ever have occasion to use this command, you should issue it
immediately after the end-of-line space that you want to affect.

FORMAT

.NO SPACE
.NSP

DESCRIPTION

(You cannot use .NO SPACE either directly before or directly after a .BREAK
command, or any command that issues a .BREAK command. In other words,
you can only use .NO SPACE between two pieces of text.)

DEFAULT

You get the normal space for the RETURN unless you issue .NO SPACE.

2-85

DSR Commands
.NO SPACE

EXAMPLE
Example 2-21 illustrates the use of the .NO SPACE command. The example
contains two files. The first file shows what occurs when you do not use the
.NO SPACE command and the second shows what occurs when you do use
it.
Example 2-21

.NO SPACE

The input of the first file, in which there are no .NO SPACE commands, is
this:
The following diagram illustrates the 16
-bit,

bit-slice,

byte-encoded configuration:

The output file is this:
The following diagram illustrates the 16 -bit,

bit-slice,

byte-encoded configuration:

Notice the space between "16" and "-bit." To avoid having this space, use the
.NO SPACE command. The next input file shows this:
The following diagram illustrates the 16
.NO SPACE
-bit,

bit-slice,

byte-encoded configuration:

The processed output file looks like this:
The following diagram illustrates the 16-bit,

bit-slice,

byte-encoded configuration:

Notice that now there is no space between "16" and "-bit."

2-86

DSR Commands
.NOTE and .END NOTE

.NOTE
.END NOTE
The .NOTE command highlights a portion of text by narrowing the
margin settings, centering the text on the page, and printing a title
centered over the text.
The .END NOTE command restores the fill, justify, case, margin,
and spacing settings that were in effect just before you issued the
.NOTE.

FORMAT

parameters

.NOTE [text]
.NT [text]

.END NOTE [[-]n]
.EN [[-]n]

n
Specifies the number of blank lines to follow the note. If .SPACING has a
value greater than 1, you will get more lines than you specified. (See also
.SKIP n.)

—n
Specifies that the next line of text be pushed to within n lines of the bottom
of the current page by the insertion of blank lines. (See also .SKIP -n and
.BLANK -n.)

text
A title for the note. If omitted, you get the word NOTE.

DESCRIPTION i

The .NOTE command issues a .BREAK before doing its main task.

2 .NOTE does a .TEST PAGE, taking the test-page value from the most
recently issued .PARAGRAPH or .SET PARAGRAPH command and
adding 4 to it. Paragraph commands take into account the .SPACING
value when they interpret the test-page value. (See also .SKIP.)

3 .NOTE then issues a .SKIP 1 above the title and a .SKIP 1 below the title.

DEFAULT

If the left margin is set to 0, .NOTE issues a .LEFT MARGIN +8 and
a .RIGHT MARGIN -8. Otherwise, the margins are set +4 and -4,
respectively. (See .LEFT MARGIN and .RIGHT MARGIN.)

.NOTE issues a .FILL. It also issues a .JUSTIFY unless you have issued a
.NO AUTOJUSTIFY. (However, note that if JUSTIFY was in effect before
you issued the .NOTE, .NO AUTOJUSTIFY does not cancel the .JUSTIFY.)

.END NOTE issues a .SKIP 1 after the text and then restores all settings
that were in effect before the .NOTE.

The word NOTE appears over the text if you do not specify a title. .END
NOTE leaves 1 blank line after the note.

2-87

DSR Commands
.NUMBER APPENDIX

.NUMBER APPENDIX
The .NUMBER APPENDIX command allows you to specify an
identifying letter with which a sequence of appendixes will begin.
The next .APPENDIX command starts the sequence. Subsequent
.APPENDIX commands cause appendixes to be lettered in alphabetic
order. See also .DISPLAY APPENDIX.

FORMAT

parameters

.NUMBER APPENDIX [[+/-]n]
.NMAX [[+/-]n]
n
The character that specifies what the next Appendix letter will be. You can
specify the letter itself (A) or you can specify a number corresponding (in
order) to the letter that will identify the appendix. For example, 1=A, 26=Z,
27=AA, 28=AB.

+n
Specifies how many alphabetically ordered letters past the current appendix
letter the next .APPENDIX character will be. For example, if the current
appendix is APPENDIX B, then .NUMBER APPENDIX +2 will cause the next
.APPENDIX to produce APPENDIX D.

—
Specifies how many alphabetically ordered letters before the current appendix
letter the next .APPENDIX letter will be.

DESCRIPTION You can specify a string of up to five characters instead of a single character.
An appendix of examples, for instance, could be numbered EXAM and appear
in a running head as Page EXAM-1, EXAM-2,...

DEFAULT

2-88

Sequential uppercase lettering, beginning with A

DSR Commands
NUMBER CHAPTER

.NUMBER CHAPTER
The .NUMBER CHAPTER command allows you to specify the
number with which a sequence of chapters will begin. The next
.CHAPTER command starts the sequence. Subsequent .CHAPTER
commands will cause each chapter to be numbered one higher than
the previous chapter. (See also .DISPLAY CHAPTER.)

FORMAT

parameters

.NUMBER CHAPTER [[+/-]n]
.NMCH [[+/-]n]
n
The number that the next .CHAPTER will have. .NMCH without an
argument gives Chapter 1.

+n
Adds n to the number of the most recently issued .CHAPTER. The result is
the number that the next .CHAPTER will have.

—n
Subtracts n from the number of the most recently issued .CHAPTER. The
result is the number that the next .CHAPTER will have.

DEFAULT

Sequential decimal numbering, beginning with 1

2-89

DSR Commands
.NUMBER LEVEL

.NUMBER LEVEL
The .NUMBER LEVEL command allows you to specify the beginning
number of a sequence of headers. Issue this command immediately
before the first .HEADER LEVEL that you want to affect. Subsequent
.HEADER LEVEL commands will each be one higher than the
preceding one according to its level (see .HEADER LEVEL). (See
also .STYLE HEADERS and .DISPLAY LEVELS.)
Default Header Level Numbering

FORMAT

parameters

Nonchapter

Chapter n

Appendix A

.HEADER LEVEL 1

n. 1

A. 1

.HEADER LEVEL 2

1.1

n.1.1

A.1.1

.HEADER LEVEL 3

1.1.1

n.1.1.1

A.1.1.1

.NUMBER LEVEL [[+/-]n1] [,[+/-]n2]...[,[+/-]n6]
.NMLV [[+/-]n 1][,[+/-]n2]...[,[+/-]n6]
nl ,n2,...n6
Indicate positioned numbers in a section header. The commas correspond
to the dots in the printed section number. For example, to set the next
.HEADER LEVEL to 3.5.2.4, you would issue the following commands:
.NUMBER LEVEL 3,5,2,4
.HEADER LEVEL

+n1
Adds n to the current value of nl.

—nl
Subtracts n from the current value of nl.

DESCRIPTION When you issue the first .HEADER LEVEL after a .NUMBER LEVEL, do not
specify a level number for it (note preceding example). If you specify a level
number that does not correspond to the level you indicated in the .NUMBER
LEVEL command, you will get unexpected results.

DEFAULT

2-90

Sequential decimal numbering, beginning with 1

DSR Commands
.NUMBER LIST

.NUMBER LIST
The .NUMBER LIST command allows you to specify, anywhere in a
list, the number with which a sequence of items in a list will begin.
Issue this command just before the .LIST ELEMENT that you want
to affect. Subsequent list elements will each have a number that is
one greater than the number for the preceding .LIST ELEMENT. (See
also .DISPLAY ELEMENTS, with which you can specify the form the
number will take.)

FORMAT

parameter

.NUMBER LIST
.NMLS n

n
Specifies a string of characters or the number with which a following
sequence of items in a list will begin. You must issue a .LIST ELEMENT
following the .NUMBER LIST command.

DESCRIPTION A list is defined by a .LIST and a paired .END LIST and has .LIST

ELEMENTS within it. Lists can be "nested"; that is, lists can exist within other
lists. Each list must be defined by a .LIST, .END LIST pair of commands.

DEFAULT

Sequential decimal numbering, beginning with 1

DSR Commands
.NUMBER PAGE and .NO NUMBER

.NUMBER PAGE
.NO NUMBER
The .NO NUMBER command suspends normal page numbering. The
.NUMBER PAGE command resumes normal page numbering, having
kept track of the numbering while .NO NUMBER was in effect; or
it allows you to specify the beginning of a new number sequence
by specifying a number for the next page. (See also .NUMBER
RUNNING, .DISPLAY NUMBER, .NO PAGING, and .HEADERS ON.)

FORMAT

parameters

.NUMBER PAGE[[+/-]n]
.NMPG [[+/-]n]

.NO NUMBER
.NNM

n
The number that the next page will have.

+n
Sets the number of the next page to n more than the number of the current
page.
—n
Sets the number of the next page to n less than the number of the current
page.

DESCRIPTION

DEFAULT

If you are using .CHAPTER, or .APPENDIX commands, page numbers
appear as chapter-oriented (2-15, 5-5) or appendix-oriented (A-30, C-10)
numbers. If your document has no chapters, page numbers appear as
running numbers (77,102).

.NO NUMBER and .NUMBER PAGE do not affect running page numbers
(that is, the numbering you get by issuing .LAYOUT with an nl value of
3). (See also .NUMBER RUNNING.)

Sequential decimal numbering, beginning with 1 or chapter number-1 or
appendix letter-1

DSR Commands
.NUMBER RUNNING

.NUMBER RUNNING
The .NUMBER RUNNING command allows you to specify the
beginning of a new sequence of running page numbers. This
command affects page numbers only if you have issued a .LAYOUT
command with an nl value of 3. (See .LAYOUT, .HEADERS ON,
and .NO NUMBER.)

FORMAT

parameters

.NUMBER RUNNING [[+/-]n]
.NMR [f+/-]n]
n
The running number that the next page will have.

+n
Sets the running number of the next page to n more than the running number
of the current page.
—n
Sets the running number of the next page to n less than the running number
of the current page.

DESCRIPTION i
2

DEFAULT

Running page numbers appear at the bottom of pages, are enclosed in
hyphens (- n -), and run consecutively throughout the entire document.
Running page numbers are produced only by .LAYOUT 3,n. (Note that
you can get similar numbering [without hyphens], if you are not using
.CHAPTER commands and if you issue .LAYOUT l,n or 2,n. This type of
numbering is not affected by the .NUMBER RUNNING command.)

No running page numbers

2—93

DSR Commands
.NUMBER SUBPAGE

.NUMBER SUBPAGE
The .NUMBER SUBPAGE command allows you to specify the
beginning of a new sequence of subpage numbers, for example,
1-16A, 1-16B, 1-16C, and so on. This command affects only the
letter(s) that the .SUBPAGE command appends to the normally
numeric page number. .NUMBER SUBPAGE takes effect on the next
page. (See also .SUBPAGE and .DISPLAY SUBPAGE.)

FORMAT
parameters

.NUMBER SUBPAGE [[+/-]n]
.NMSPG [[+/-]n]
n
The subpage letter that will be appended to the number of the next page. You
can specify the letter itself (A) or you can specify a number corresponding
(in order) to the letter that the subpage will have. For example, 1=A, 26=Z,
27=AA, 28=AB.

+n
Specifies how many alphabetically ordered letters past the current subpage
letter the next subpage letter will be. For example, if the current subpage is
page 3-12E, then .NUMBER SUBPAGE +2 will cause the next subpage to be
numbered 3-12G.

—n
Specifies how many alphabetically ordered letters before the current subpage
letter the next subpage letter will be.

DESCRIPTION

.NUMBER SUBPAGE turns on .SUBPAGE if it was not previously in effect.

DEFAULT

Sequential uppercase lettering, beginning with A

DSR Commands
.PAGE

.PAGE
The .PAGE command starts a new page.

FORMAT

.PAGE
.PG

DESCRIPTION

The .PAGE command issues a .BREAK before doing its main task.

The current page must have at least one line of text for .PAGE to work, so
you cannot use .PAGE to generate a series of blank pages.

You can generate a series of blank pages by alternately issuing .PAGE and
.FIGURE commands.

If .NO PAGING is in effect, you can still issue a .PAGE successfully, but
you will not get additional pages as you normally would if the text on a
page exceeds the page length associated with .PAGE SIZE.

2-95

DSR Commands
.PAGE SIZE

.PAGE SIZE
The .PAGE SIZE command sets the page "frame" by specifying the
page length (the maximum number of lines of text on a page) and the
page width for the running heads. (Compare with .RIGHT MARGIN,
which sets the text width.) The width component of .PAGE SIZE
and the .RIGHT MARGIN value are separate values.

FORMAT

parameters

.PAGE SIZE [[+/-]n l][,[+/-]n2]
.PS [[+/-]n1][,[+/-]n2]
nl
(Length) is the maximum number of lines on a page; nl cannot be smaller
than 13.

+n1
Increases the current page length by nl lines.

—nl
Decreases the current page length by nl lines.

n2
(Width) is the maximum number of characters on a line for running heads; n2
cannot be larger than 150.

+n2
Increases the current page width by n2 characters.

—n2
Decreases the current page width by n2 characters.

DESCRIPTION

The .PAGE SIZE command issues a .BREAK before doing its main task.

Running heads line up on the right with the page-width setting.

Page numbers in .LAYOUT 1, 2, and 3 are centered between 0 and the
width set by the PAGE SIZE command. All other centering takes place
between the left margin and the right margin.

4 If you have issued a .NO PAGING command, .PAGE SIZE restores the
.PAGING state.

DSR Commands
.PAGE SIZE

RELATED
COMMANDS

The width value of .PAGE SIZE and the value of .RIGHT MARGIN do
not affect each other. However, they are generally the same value.

2 The .CENTER command uses the .RIGHT MARGIN value rather than the
.PAGE SIZE value to center text on a line.

DEFAULT

.PAGE SIZE 58,70

2-97

DSR Commands
.PAGING and .NO PAGING

!no paging
The .PAGING command enables paging. The .NO PAGING command
disables it.

FORMAT

.PAGING
.PA

DESCRIPTION

.PAGING issues a .BREAK before doing its main task.

If you have issued .NO PAGING, the document is not split into numbered
pages and space is not reserved for running heads. Any mechanical page
breaks that a print device causes still occur.

If .NO PAGING is in effect and if you want to start a new page after some
lines of text, you can use the .PAGING command.

.NO PAGING
.NPA

4 If your input file has a file type of RNH (Help file), paging is turned off
and the .PAGING command has no effect.

RELATED
COMMANDS

DEFAULT

If you issue .CHAPTER, .APPENDIX, or .PAGE SIZE, you get .PAGING
(unless your input file type is RNH).

You can temporarily override a .NO PAGING state by issuing a .PAGE,
but unless you issue .PAGING, you will not get additional pages as you
normally would if the text on a page exceeded the page-length value of
.PAGE SIZE.

.PAGING

DSR Commands
.PARAGRAPH

.PARAGRAPH
The .PARAGRAPH command controls spacing and page placement
associated with the creation of paragraphs. It issues a .TEST PAGE,
followed by a .SKIP and an .INDENT. (See also .SET PARAGRAPH.)

FORMAT

.PARAGRAPH [[-]n1 [,[-]n2[,n3]]]
■P [[~]n1 [,[-]r>2[,n3]]]
The parameters nl, n2, and n3 are identical to the values of the .SET
PARAGRAPH command. If you choose not to use one of these optional
parameters, you must use a comma as a placeholder for the missing
parameter in the parameter list.

parameters

n 1 = spaces indented (The default is 5.)
Specifies (like .INDENT) how many character positions to the right of the
.LEFT MARGIN setting the first line of text will begin.

—nl
Specifies how many character positions to the left of the .LEFT MARGIN
setting the first line of text will begin; -nl cannot, however, cause the text to
begin to the left of character position 0.

n2 = vertical spacing (The default is 1.)
Specifies (like .SKIP) the number of blank lines you want inserted before the
paragraph. You get additional blank lines if the .SPACING value is greater
than 1 (see .SKIP, .SPACING).

—n2
Specifies that the next line of text be pushed to within n2 lines of the bottom
of the current page by the insertion of blank lines. Every line but the last one
retains the line spacing (.SPACING value) that follows it.

n3 = test page lines (The default is 2.)
Specifies (like .TEST PAGE) the number of lines of text required to be on one
page. This parameter, unlike the .TEST PAGE command, takes into account
any blank lines that .SPACING is routinely inserting after each line of text.
If there is not enough room on the current page to accommodate that many
lines, DSR puts the text on the next page. You can cancel this function by
specifying 0 for n3.

DESCRIPTION

The .PARAGRAPH command issues a .BREAK before doing its main task.

2-99

DSR Commands
.PARAGRAPH

DEFAULTS

.PARAGRAPH 5,1,2

If you issue .PARAGRAPH without one or more of the n values, you
get the corresponding setting from the previous .PARAGRAPH or .SET
PARAGRAPH that you issued.

If you have not set values in any previous .PARAGRAPH or .SET
PARAGRAPH that you might have issued, you get one or more of the
following:
nl=5
n2=l
n3=2

The following lines show how to change the default values from 5 for spaces
indented, 1 for vertical spaces, and 2 for test page lines.

2-100

Format

Actual Arguments

.PARAGRAPH

5.1.2

PARAGRAPH„4

5,1,4

.PARAGRAPH 3

3.1.2

.PARAGRAPH ,2

5.2.2

DSR Commands
.PERIOD and .NO PERIOD

!no period
DSR normally adds an extra space after any of the following
punctuation marks in your text: period (.), colon (:), question mark
(?), and exclamation point (I).
The .NO PERIOD command cancels the extra space that DSR inserts
after any of the punctuation marks listed above. The .NO PERIOD
command is used to differentiate between punctuation used in the
syntax of a sentence and punctuation used for other purposes.
The .PERIOD command restores the routine insertion of an extra
space following any of the punctuation marks listed above.

FORMAT

.PERIOD
.PR

.NO PERIOD
.NPR

DESCRIPTION

The .PERIOD condition works as described only if .FILL is in effect and if
the punctuation mark is followed by either a space or the end of the line.

You can override the effects of .PERIOD at any time by using the Accept
flag (_) in front of a punctuation mark.

RELATED
COMMAND

The Period flag (the plus sign [+] by default) allows you to specify extra space
after any character other than the ones mentioned above (see the description
of the Period flag in Section 3).

DEFAULT

.PERIOD

2-101

DSR Commands
.PERIOD and .NO PERIOD

EXAMPLE
Example 2-22 illustrates the use of the .PERIOD command.

Example 2-22

.PERIOD

The following shows an input file before it is processed by DSR:
.FILL.NO justify
Mr. Jones, the ratios of 5! (factorial) to 6! is 5 : 6 but
we will not use the ? character.
Wait a minute! The answers are: yes and no. However, what
if you are not sure? Try not to confuse things. Be more
explicit.

The following shows the output of the same file with the .PERIOD command
used throughout:
Mr.
but
The
are

Jones, the ratio of 5!
(factorial) to 6!
is 5 :
6
we will not use the ? character. Wait a minute!
answer8 are:
yes and no.
However, what if you
not sure? Try not to confuse things.
Be more explicit.

Notice that there are two spaces after each punctuation mark (except the
commas).
The following shows the output of the same file with the .NO PERIOD
command used throughout:
Mr. Jones, the ratio of 5! (factorial) to 6! is 5 : 6 but
we will not use the ? character. Wait a minute! The
answers are: yes and no. However, what if you are not
sure? Try not to confuse things. Be more explicit.

Notice that there is one space after each punctuation mark.

2-102

DSR Commands
.REPEAT

.REPEAT
The .REPEAT command allows you to specify up to 150 characters
to be printed a specified number of times, either horizontally or
vertically.

FORMAT

parameters

.REPEAT n"x"(orn'x')
.RPT n"x"(orn'x')

n
The number of times you want the characters printed.
X
A string of up to 150 characters. You must enclose the characters within
apostrophes (' ') or quotation marks ("").

DESCRIPTION

If you issue .REPEAT with .FILL in effect, the characters are repeated
horizontally. If you want the repetitions separated by a space, you must
include a space at the end of the string of characters to be repeated.

If you issue .REPEAT with .NO FILL in effect, the characters are repeated
vertically, beginning at the left margin.

2-103

DSR Commands
.REQUIRE

.REQUIRE
The .REQUIRE command allows you to process several DSR files at
the same time and merge them in an output file.

FORMAT

parameter

.REQUIRE "file-spec (or file-spec)
. R EQ " file-spec (or1 file-spec)
file-spec
A file specification enclosed in quotation marks or apostrophes. If you just
specify a file name, the default file type is RNO. If you do not supply a full
file specification, DSR uses your default device and directory. If you want to
include (.REQUIRE) files from other devices or directories, you must specify
the full file spec.

DESCRIPTION

2-104

A .REQUIRE command must be the last command on the line if you are
putting multiple DSR commands on a line.

You can have several .REQUIRE commands in a single file or you can
have one or more .REQUIRE commands in files that are themselves
specified in .REQUIRE commands. The maximum depth for "nesting"
.REQUIRE files in this manner is 10.

If you plan to use .REQUIRE in several files that might be required in
various combinations, you should consider using .SET LEVEL. .SET
LEVEL causes the section heads in files to be adjusted to the right level in
any context. See .HEADER LEVEL and .SET LEVEL.

DSR Commands
.RIGHT

.RIGHT
The .RIGHT command positions a single line of text relative to the
right margin. (See also .CENTER.)

FORMAT

parameters

.RIGHT [[-]n]; text
.R [[-]n]; text

.RIGHT [[-]n]
.R[[-]n]
text

n
Specifies how many character positions to the left of the right margin setting
the line will be indented.

—
Specifies the number of character positions to the right of the right margin
setting that the line will extend to.

text
The text to be positioned relative to the right margin. No other DSR
commands can follow this text on a line.

DESCRIPTION i

DEFAULT

The .RIGHT command issues a .BREAK before doing its main task.

The line of text being positioned can extend past margin settings and
even beyond the .PAGE SIZE width setting, but it cannot go to the left of
character position 0.

You can enter the text to be positioned on the same line following the
.RIGHT command. Or you can end the line after the .RIGHT command,
in which case the following line of text is positioned.

No commands will be recognized on the line following a .RIGHT
command (or if it is blank, on the next line). The Control flag (.) is not
honored while .RIGHT is collecting text to position. Other DSR flags are
recognized, for example, the Bold and the Underline flags.

If you issue .RIGHT without a value, you get a 0, which will push the line of
text to the right margin.

2-105

DSR Commands
.RIGHT MARGIN

.RIGHT MARGIN
The .RIGHT MARGIN command sets the right margin to the position
that you specify. This is the position to which a line of text normally
extends. If .JUSTIFY is in effect, the .RIGHT MARGIN value is
the position against which text is justified. If .NO JUSTIFY is in
effect, the .RIGHT MARGIN value specifies the maximum number of
characters on any text line. (Compare with .PAGE SIZE, which sets
the page width for running heads.)

FORMAT

parameters

.RIGHT MARGIN [[+/-]n]
.RM [[+/-]h]
n
Specifies the character position of the new right margin; n must be greater
than the value for the left margin. (For example, .RIGHT MARGIN 60 sets
the right margin just to the right of the 60th character position.)

+n
Sets the right margin n character positions to the right of the current right
margin.

—
Sets the right margin n character positions to the left of the current right
margin.

DESCRIPTION The .RIGHT MARGIN command issues a .BREAK before setting the right
margin.

RELATED
COMMANDS

DEFAULTS

2-106

.LITERAL issues a .RIGHT MARGIN 150 and .END LITERAL restores the
previous right margin setting.

.CENTER uses the .RIGHT MARGIN setting as the value on which to
center text on a page.

If you do not issue a .RIGHT MARGIN command, you get .RIGHT
MARGIN 70.

If you issue .RIGHT MARGIN without a value, you get the default value
of 70.

DSR Commands
.SAVE and .RESTORE

.SAVE
.RESTORE
These commands maintain the formatting context of a document for
the user. The files produced by the DSR utilities make changes to
the formatting context. In order not to disturb the user's context,
the RNT and RNX files issue .SAVE and .RESTORE commands.
.SAVE stores information about the current RUNOFF formatting
context; this includes DSR defaults and DSR commands and flags
issued by the user.
.RESTORE restores the formatting information saved by the
last-issued .SAVE.

FORMAT

.SAVE
.SA

DESCRIPTION 1

.RESTORE
.RE

You must balance a .SAVE command with a .RESTORE command. A
warning message results from a .RESTORE command without a preceding
.SAVE command, and no restore is done in this case. Similarly, a
warning message results if pending .SAVE commands are not matched by
.RESTORE commands by the end of a file.

2 You can nest .SAVE and .RESTORE commands to a depth of 20.
3 The .SAVE command preserves the following items of formatting context:
Case of the word Page that precedes the page number and the word
Index that precedes index page numbers
Date (On or Off)
Fill
Flags
Justify
Keep
Margins
Page numbering (On or Off)
Page size
Paging (On or Off)
Paragraph parameters
Spacing
Subtitles (On or Off)
Tab stops

2-107

DSR Commands
.SEND TOC

.SEND TOC
The .SEND TOC command allows you to insert DSR commands,
DSR flags, and text into the table of contents (RNT) file. The items
that you insert affect the appearance of the table of contents. For
example, you can send emphasis flag characters to cause bolding
and underlining in the table of contents. Section 5, Creating a Table
of Contents, has information on the DSR Table of Contents Utility.

FORMAT

parameter

.SEND TOC text
.STC text
text
Specifies the DSR command, DSR flag, or text that you are sending to the
table of contents.

2-108

DSR Commands
.SEND TOC

EXAMPLE
Example 2-23 illustrates the use of the .SEND TOC command.

Example 2-23

.SEND TOC

The following shows an input file before it has been processed with DSR and
the DSR Table of Contents Utility:
.HEADER LEVEL 1 1st Section
text.text.text
.PAGE
.HEADER LEVEL 1 2nd Section
text.text.text
.PAGE
.SEND TOC .BLANK 2
.HEADER LEVEL 1 3rd SectionC.SEND TOC command before this section)
text.text.text
.PAGE
.HEADER LEVEL 1 4th Section
text.text,text
.PAGE
.HEADER LEVEL 1 5th Section
text.text.text

The preceding commands will cause the RNT file to have the .BLANK 2
command in it and the table of contents file (MEC) will have the two blank
lines before the header level entry for the third section.
Following is the table of contents produced when you process the input file
with DSR and the DSR Table of Contents Utility:
CONTENTS
1
2

1ST SECTION.1
2ND SECTION.2

3
4
5

3RD SECTION(.SEND TOC COMMAND BEFORE THIS SECTION) . 3
4TH SECTION.4
5TH SECTION.5

2-109

DSR Commands
.SET DATE and .SET TIME

.SET DATE
.SET TIME
The .SET DATE and .SET TIME commands let you specify a date
and time to be inserted in your file when you issue the Substitute
flag pair, $$, with any of the appropriate date or time parameters.
.SET DATE also sets the date for the .DATE command, which
causes the date to appear in running heads. (See .DATE in this
section and the description of the Substitute flag pair, $$, in
Section 3.)

FORMAT

parameters

.SET DATE dl ,d2 ,d3
.SDT dl ,d2,d3

.SET TIME tl ,t2 ,t3
.STM tl ,t2,t3

dl
A number specifying the day of the month

62
A number specifying the month of the year

63
A number specifying the year (either four digits or the last two digits of the
year)

ti
A number specifying the hour of the day

t2
A number specifying minutes past the hour

t3
A number specifying seconds past the minute
If you precede any of these values with a + or
you will change the
corresponding current value by adding to or subtracting from it the value
following the + or

DESCRIPTION

2-110

The .SET DATE and .SET TIME commands issue .BREAK commands
before doing their main tasks.

The date or time that you specify or that is in effect by default remains in
effect until you issue another .SET DATE or .SET TIME.

DSR Commands
.SET DATE and .SET TIME

DEFAULTS

If you do not issue .SET DATE or .SET TIME, issuing a $$time, $$date,
or any of the appropriate date or time parameters with the substitute flag
pair ($$) will give you the date or time that DSR began processing the file.

If you issue either of these .SET commands, you can retain a previous
value by omitting its value from the command. You must, however, type
any comma that would have followed it.

If you issue either command without specifying any values for it, you will
get the current date or the time as of the second the command is executed.

2-111

DSR Commands
.SET LEVEL

.SET LEVEL
The .SET LEVEL command allows you to preset the level of the
next section head without issuing a .HEADER LEVEL command (see
.HEADER LEVEL).

FORMAT

parameters

.SET LEVEL [+/-]r>
■SL [+/-].n
n
Specifies the level for the next .HEADER LEVEL command.

+n
Makes the level for the next .HEADER LEVEL command n more than the
current level.

—
Makes the level for the next .HEADER LEVEL command n less than the
current level.

DESCRIPTION The .SET LEVEL command can be helpful when you are using the .REQUIRE
command to combine several text files that are to be processed and output
as a single file. By using the .SET LEVEL command, you can "require" your
files in different combinations without having to modify them, and without
having to make adjustments to .HEADER LEVEL commands throughout any
document involved. When using .SET LEVEL in .REQUIRE files, note the
following:

2-112

You should issue all .HEADER LEVEL commands in .REQUIRE files with
+n or -n values rather than with n values. Alternatively, you can issue no
value with the .HEADER LEVEL command, always specifying the level
with .SET LEVEL.

At the end of the .REQUIRE file, you can issue .SET LEVEL with a -n or
+n to reset the header level to its value before you entered the current
.REQUIRE file.

Here is text following the first header. Now we w
increment the header level by doing ".SET LEVEL +1
.SET LEVEL +1
.HEADER LEVEL second header in SL3.EXA
Text following the second header. Now we again
increment the header level:
.SET LEVEL +1
.HEADER LEVEL third header in SL3.EXA
This is the last text in SL3.EXA. At the end of it
will set the header level back to where it started
doing ".SET LEVEL --2".
.SET LEVEL --2

Example 2-24

.SET LEVEL

The following shows the input file before it is proce

One reason for using this command is that it allow
modularization of an RNO source file or a set of R
files.
.BLANK
Soon we are going to Require a file (SL3.EXA) that
3 levels of headers. They will appear the first ti
as header levels 1, 2, and 3 (numbered 1, 1.1, and
1.1.1). Following that, we will issue a .SET LEVEL
command here and then Require our 3-level file ag
This time, the same headers will appear as header
2, 3, and 4 (numbered 1.2, 1.2.1, and 1.2.1.1).
.BLANK
We will also pull in the left margin for SL3.EXA t
make it stand out.
.LEFT MARGIN +3
.REQUIRE 'SL3.EXA1
.BLANK.LEFT MARGIN --3
Now we issue a .SET LEVEL -*-1 command here at the t
level:
.SET LEVEL +1
Now we Require the file SL3.EXA again:
.LEFT MARGIN +3
.REQUIRE 'SL3.EXA'
.LEFT MARGIN --3

set of Require files.
Soon we are going to Require a file (SL3.EXA) that
has 3 levels of headers.
They will appear the
first time as header levels 1, 2, and 3
(numbered
1, i.l, and i.l.i).
Following that, we will issue
a .SET LEVEL +1 command here and then Require our
3-level file again.
This time, the same headers
will appear as header levels 2, 3, and 4 (numbered
1.2, 1.2.1, and 1.2.1.1).
We will also pull in the left margin
to make it stand out.
1

for

SL3.EXA

FIRST HEADER IN SL3.EXA

Here is text following the first header.
Now
we will increment the header level by doing
".SET LEVEL +1":
1.1

Second Header In SL3.EXA

Text following the second header.
increment the header level:

Now we again

1.1.1 Third Header In SL3.EXA - This is the
last text in SL3.EXA.
At the end of it, we
will set the header level back to where it
started by doing ".SET LEVEL --2."
Now we issue a .SET LEVEL +1 command here
top level:
Now we Require the file SL3.EXA again:
1.2

the

First Header In S13.exa

Here is text following the first header.
Now
we will increment the header level by doing
".SET LEVEL +1":
1.2.1 Second
Header
In
following the second header.
increment the header level:

SL3.EXA - Text
Now we again

1.2.1.1 Third Header In SL3.EXA - This is the
last text in SL3.EXA.
At the end of it, we
will set the header level back to where it
started by doing ".SET LEVEL --2."

2-114

DSR Commands
.SET PARAGRAPH

.SET PARAGRAPH
The .SET PARAGRAPH command allows you to set values for
.PARAGRAPH without issuing a .PARAGRAPH. .SET PARAGRAPH
can be especially useful if you plan to issue .AUTOPARAGRAPH or
.AUTOTABLE. (See .PARAGRAPH.)

FORMAT

.SET PARAGRAPH [[-]n 1 [,[-]n2 [,n3]]]
.SPR [Hn1[,[-]n2[,n3]]]
The parameters nl, n2, and n3 are identical to the values of the
.PARAGRAPH command. If you choose not to use one of these optional
parameters, you must use a comma as a placeholder for the missing parameter
in the parameter list.

parameters

nl = spaces indented (The default is 5.)
Specifies (like .INDENT) how many character positions to the right of the
.LEFT MARGIN setting the first line of text will begin.

-nl
Specifies how many character positions to the left of the .LEFT MARGIN
setting the first line of text will begin; -nl cannot, however, cause the text to
begin to the left of character position 0.

n3 = test page lines (The default is 2.)
Specifies (like .TEST PAGE) the number of lines of text required to be on one
page. Unlike the .TEST PAGE command itself, n3 takes into account any
blank lines that .SPACING routinely inserts after each line of text. If there is
not enough room on the current page to accommodate that many lines, DSR
puts the text on the next page. You can cancel this function by specifying 0
for n3.

2-115

DSR Commands
.SKIP

.SKIP
The .SKIP command inserts a multiple of the number of blank lines
that has been specified by the .SPACING command. Contrast this
with .BLANK, which inserts only the number of blank lines specified
with the .BLANK command itself. (See .BLANK.)

FORMAT

parameters

■SKIP [[-]n]
■S [[-]n]
n
The number of .SPACING lines you want to be inserted. For example, if you
have specified a .SPACING value of two lines and you issue .SKIP without
an n value, DSR will insert two blank lines (the .SPACING value) by default.
If you issue .SKIP 2, DSR will insert four blank lines (2 times the .SPACING
value), and so on.

—
Specifies that the next line of text be pushed to within n lines of the bottom
of the current page by the insertion of blank lines. Every line but the last one
retains the line spacing (.SPACING value) that follows it.

DESCRIPTION

DEFAULT

2-116

The .SKIP command issues a .BREAK before doing its main task.

.SKIP n does not work at the top of a page, that is, right after a .PAGE or
just after .PAGE SIZE length has been exceeded, but .SKIP -n does work
under such conditions.

If there is not enough room on the current page for .SKIP to do exactly as
you specified, the .SKIP does as much as it can on that page. It does not
finish on the next page.

If DSR encounters a footnote while executing .SKIP, it considers the line
directly above the footnote to be the bottom of the page.

If you issue no value for .SKIP, you get .SKIP 1.

DSR Commands
.SPACING

.SPACING
The .SPACING command changes the amount of spacing between
lines of text.

FORMAT

parameter

.SPACING n
.SP n
n
The amount of spacing that you want between lines of text. For example, 1
denotes single spacing (no blank lines between lines of text) — as the text
in this manual normally appears. You must specify n, which must be in the
range of 1 through 5.

DESCRIPTION

The .SPACING command issues a .BREAK before doing its main task.

2 The .SPACING setting affects the action of .SKIP.
3 The .SPACING setting affects the action of .LITERAL.
4

DEFAULT

The .SPACING setting affects the skip values and the test-page values
of .PARAGRAPH, .SET PARAGRAPH, .AUTOPARAGRAPH, and
.AUTOTABLE.

If you do not issue a .SPACING command, you get single spacing
(.SPACING 1).

2-117

DSR Commands
.STYLE HEADERS

.STYLE HEADERS
The .STYLE HEADERS command changes the formats of the various
levels of section heads (.HEADER LEVEL n). Do not confuse the
numbers that identify the header level (in the range of 1 through
6) with the numbers that get printed just to the left of the header
title (3.5.2, for example). See .HEADER LEVEL. (See also .NUMBER
LEVEL and .DISPLAY LEVEL.)

Default Header Level Numbering

FORMAT

parameters

Nonchapter

Chapter n

Appendix A

.HEADER LEVEL 1

n. 1

A. 1

.HEADER LEVEL 2

1.1

n.1.1

A.1.1

.HEADER LEVEL 3

1.1.1

n.1.1.1

A.1.1.1

.STYLE HEADERS [nl][,n2]...[,n9]
.STHL [n1][,n2]...[,n9]
n1
Specifies the lowest-numbered header level to have a run-in title format.
Run-in means that the text immediately follows the header on the same line
instead of beginning on a new line. All higher-numbered levels also have
run-in formats. If nl=4, then .HEADER LEVEL 4, 5, and 6 titles are run into
the main text. Default = 3.

n2
Specifies the highest-numbered header level to have its title printed entirely
in uppercase. All lower-numbered levels will also have titles entirely in
uppercase. If n2=4, then .HEADER LEVEL 1, 2, 3, and 4 will have titles in
uppercase. Default - 1.

n3
Specifies the highest-numbered header level to have only the first letter of
each word capitalized in the title. All lower-numbered levels will also have
titles in mixed format. If n3=6, all levels will have this case format. All
uppercase takes precedence over initial capital letters, if there is a conflict.
Default = 6.

n4
Specifies the lowest-numbered header level not to have a section number
to the left of its title. All higher-numbered levels will also not have section
numbers to the left of their titles. Default = 7.

n5
Specifies the lowest-numbered non-run-in header level to have its title
centered. All higher-numbered non-run-in levels will also have their titles
centered. Default = 7.

2-118

DSR Commands
STYLE HEADERS

n6
Specifies the number of blank lines you want before section heads.
Default = 3.

n7
Specifies the number of blank lines you want after section heads. Default = 1.

n8
Specifies the number of lines you want to have available on the current page
for the test page issued by .HEADER LEVEL. Note that n8 takes into account
any blank lines that .SPACING routinely inserts after each line of text (unlike
.TEST PAGE). (See also .SKIP.) Default = 9.

n9
Specifies the number of spaces you want between the section number and the
section title. The maximum value is 75. Default = 2.

DESCRIPTION i

The .STYLE HEADERS command issues a .BREAK before doing its main
task.

2 You can type 0 or 7 for nl, n2, n3, n4, or n5 to affect all levels of headers,
even though both 0 and 7 exceed the range of allowable levels.
In a conflict between n2 and n3 caused by an overlapping range, n2 (all
uppercase) takes precedence.

DEFAULTS

If you do not specify a value for any given n, DSR supplies the following
default values:
n1=3

Run-in titles for header levels 3 through 6.

n2=1

Titles in all uppercase for header level 1 only.

n3=6

Titles with only the first letter of every word in uppercase for header
level 2 through header level 6.

n4=7

A sequence of numbers (or letters) preceding the section title. (See
.DISPLAY LEVELS.)

n5=7

Titles printed starting at the left margin (flush left), not centered.

n6=2

Two blank lines before each header.

n7=1

One blank line after each header.

n8=9

Seven more than the test-page value of the most recent .PARAGRAPH
or .SET PARAGRAPH command you have issued. If you have not
specified such a value, you get 7 plus the .PARAGRAPH default of 2.
(See the description of n8 above for note on .SPACING adjustment.)

n9=2

Two spaces between the section number of the header and the header
itself (section title).

2—119

DSR Commands
.SUBPAGE and .END SUBPAGE

.SUBPAGE
.END SUBPAGE
The .SUBPAGE command begins a new page and a new format for
page numbering. It numbers the new page by keeping the previous
page number and appending the letter A to it. For example, if the
previous page is 10, the first subpage is 10A and the next page
becomes 10B unless you have issued an .END SUBPAGE in the
meantime. (See also .NUMBER SUBPAGE, .DISPLAY SUBPAGE,
.HEADERS ON, .LAYOUT, and .PAGE.)
The .END SUBPAGE command begins a new page and goes back to
normal page numbering. If you issued the .END SUBPAGE command
on page 2-8D, for example, the next page would be numbered 2-9.

FORMAT

.SUBPAGE
.SPG

DESCRIPTION

Both the .SUBPAGE and the .END SUBPAGE commands issue .BREAK
commands before doing their main tasks.

You can use the .SUBPAGE command if you are changing parts of a
document you are reprinting and if you do not want to have to renumber
the pages in the rest of a chapter (or possibly the rest of the document).
You can thus avoid a severe disruption of your index and table of
contents.

DEFAULT

2-120

.SUBPAGE is not in effect.

.END SUBPAGE
.ES

DSR Commands
.SUBTITLE and .NO SUBTITLE

.SUBTITLE
.NO SUBTITLE
The .SUBTITLE command allows you to specify a subtitle for a
running head (see .HEADERS ON). This subtitle normally appears
on the second line of every page (except page 1) at the leftmost
position on a line (character position 0), regardless of the .LEFT
MARGIN setting. The .NO SUBTITLE command cancels the
.SUBTITLE function. (See also .AUTOSUBTITLE, .TITLE, .FIRST
TITLE, and .LAYOUT.)

FORMAT

parameter

.SUBTITLE [text]
.ST [text]

.NO SUBTITLE
.NST

text
The title of the running head you want to appear on the second line of the
page.

DESCRIPTION

RELATED
COMMANDS

The .SUBTITLE command issues a .BREAK before doing its main task.

A .SUBTITLE command must be the last command on the line.

You must issue a .SUBTITLE if you want .AUTOSUBTITLE or .DATE to
work.

Once you issue the .SUBTITLE command, the running head will occupy
four lines at the top of each page (title, subtitle, and two blank lines.) If
you never issue .SUBTITLE, or if you issue .NO SUBTITLE, the running
head will occupy three lines at the top of each page.

You can change the position of a running-head subtitle on pages by
issuing a .LAYOUT command.

If .AUTOSUBTITLE is in effect, it will override the effects of a .SUBTITLE
you have issued. That is, DSR will use .HEADER LEVEL titles for
running-head subtitles. Any subtitle you have specified in a .SUBTITLE
command will be overridden when the first applicable .HEADER LEVEL is
encountered.

.NO HEADERS suppresses running heads and therefore the subtitle does
not appear at the top of the page. DSR remembers the subtitle, however,
and it will appear in the running head if you issue .HEADERS ON.

2-121

DSR Commands
.SUBTITLE and .NO SUBTITLE

DEFAULTS

2-122

If you do not issue either .SUBTITLE or .NO SUBTITLE, you get .NO
SUBTITLE.

If you issue the .SUBTITLE command without specifying subtitle text for
it, you will get the effects of .AUTOSUBTITLE (provided you have not
issued .NO AUTOSUBTITLE).

If .AUTOSUBTITLE is in effect and if the text picked up from an
applicable .HEADER LEVEL command is wider than the margins in effect
when the subtitle is displayed, the subtitle is truncated and an ellipsis
(...) is appended to the end of it.

DSR Commands
.TAB STOPS

.TAB STOPS
The .TAB STOPS command changes the current positions of tab
stops. Each tab character in the input file advances the print carriage
to the right to the next tab stop.

FORMAT

parameters

.TAB STOPS [[+/-]n1][,[+/-]n2]...[,[+/-]n32]
.TS [[+/-]n 1][,[+/-]n2]...[,[+/-]n32]
nl ,n2,...n32
Character positions that you are defining as new tab stops. They are absolute
positions not related to margin settings, and start at 0 (the leftmost position).
The highest number of tab stop positions you can have is 32.

n
Specifies the character position for a tab stop.

1,2,...32
The lst,2nd,...32nd tab stops on a line. Tab stops are defined as such by the
commas that follow them.

-hfl
Changes a given position by adding n to its value rather than by directly
specifying the value.

—n
Changes a position by subtracting n from its value.

DESCRIPTION

If you issue a .TAB STOPS but do not want to change all the settings,
you need not specify those you want to keep. You must, however, retain
the commas that would have followed because omissions alter or cancel
previous settings. In particular, the previous tab stop settings located after
the last number or comma in a .TAB STOPS command are canceled.

Each .TAB STOPS command suspends the use of the previous tab stop
settings.

Tab stop values must increase from left to right to work properly, and
each must have a value that is at least two higher than that of the
preceding tab stop. Tabs encountered when either of these conditions is
not in effect cause DSR to ignore the improper tab setting and bring you
to the next valid setting.

You can delete a tab stop by setting it to a value that is less than the tab
stop just preceding the one you are deleting. For example, if you have
issued .TAB STOPS 10,15,20,25,30 and you want to delete the tab stop at
position 20, you can issue the following:
.TAB STOPS

..12,,
2-123

DSR Commands
.TAB STOPS

DEFAULTS

2-124

If text overflows past a tab stop, a following tab brings you to the next
valid setting.

If DSR encounters a tab character after passing beyond all tab stops, it
treats the tab as a space.

Tabs work properly inside a .LITERAL block of text.

.TAB STOPS commands are not affected by .JUSTIFY.

If you issue a .TAB STOPS command without number or comma
specifications, the use of all tab stops is suspended and the tab character is
equivalent to a space.

If you do not issue a .TAB STOPS command, successive tab characters
work as if you had set a tab stop every eight positions, that is, as if you
had issued .TAB STOPS 8,16,24, and so on. Note, though, that because
.PAGE SIZE has a width limit of 150, 149 is the practical limit for .TAB
STOPS.

DSR Commands
.TEST PAGE

.TEST PAGE
The .TEST PAGE command allows you to keep a specified amount
of text entirely on a single page. If there is not enough room on the
current page to accommodate that amount, DSR ends the current
page and puts the entire text on the next page.

FORMAT

parameter

.TEST PAGEn
.TP n
n
The number of lines required to be on one page. This number cannot be
omitted and must be positive.

DESCRIPTION The .TEST PAGE command issues a .BREAK before doing its main task.
RELATED
COMMAND

The following commands issue .TEST PAGE commands:
.FIGURE
.FIGURE DEFERRED
.HEADER LEVEL
.LIST
.NOTE
.PARAGRAPH
.SET PARAGRAPH
Unlike .TEST PAGE, however, these commands all take the .SPACING value
into account when interpreting n. (See also .SKIP.)

2-125

DSR Commands
.TEST PAGE

EXAMPLE
Example 2-25

.TEST PAGE

Suppose there are exactly four lines left on the current page.

2-126

Example A

Example B

.TEST PAGE 5

[no .TEST PAGE command]

Line one

Line two

Line three

Line four

Line five

Produces:

[new page]

Line one

Line two

Line three

Line four

[new page]

Line five

DSR Commands
.TITLE

.TITLE
The .TITLE command allows you to specify a title for a running head
(see .HEADERS ON). This title normally appears at the top of every
page but the first, at the leftmost position on the line (character
position 0), regardless of the .LEFT MARGIN setting. (See also
.FIRST TITLE, .SUBTITLE, and .LAYOUT.)

FORMAT

parameter

.TITLE [text]
.T [text]
text
The title of the main running head you want to appear.

DESCRIPTION

RELATED
COMMANDS

The .TITLE command issues a .BREAK before doing its main task.

A .TITLE command must be the last command on the line.

You can change the position of a running-head title on pages by issuing a
.LAYOUT command.

.NO HEADERS suppresses running heads and therefore the title does not
appear at the top of the page. DSR remembers the title, however, and it
will appear in the running head if you issue .HEADERS ON.

If you issue a .CHAPTER (or .APPENDIX) after or instead of a .TITLE, the
chapter or appendix title becomes the running-head title.

4 If your document does not begin with a .CHAPTER command, you can
have running heads on the first page by issuing a .FIRST TITLE command.

DEFAULT

If you do not issue a .TITLE command, you get the title you specified in
any .CHAPTER command that is in effect (unless you have issued .NO
HEADERS).

2-127

DSR Commands
.VARIABLE

.VARIABLE
The .VARIABLE command allows you to specify a character that
corresponds to the name you have given the commands and text
in an .IF (or .IFNOT) block. This identifying character is placed in
the left margin when you process your file with the /DEBUG or
/DEBUG=CONDITIONALS command line qualifier.

FORMAT

parameters

.VARIABLE name [t ,f]
.VR name [t,f]
name
The name you have given to the commands and text in an .IF (or .IFNOT)
block.

t
(True) is a single character of your choice that appears in front of lines of text
to indicate that they will be processed (.IF block) if you specify /VARIANT,
instead of /DEBUG, in the command line.

f
(False) is a single character of your choice that appears in front of lines of
text to indicate that they will not be processed (.IFNOT block) if you specify
/VARIANT, instead of /DEBUG, in the command line.

DESCRIPTION i

.VARIABLE commands must occur before conditional commands of the
same name.

You can issue a .VARIABLE command for as many .IF or .IFNOT blocks
as you want, but you should have unique t,f characters for each unique
.VARIABLE "name." You can then tell which block will be processed or
not processed.

If you issue /VARIANT in the command line, only "true" text will appear.

EXAMPLE
Example 2-26 illustrates the use of the .VARIABLE command and also the
conditional commands (.IF, .IF NOT, .ELSE, and .ENDIF).

2-128

.VARIABLE DIAG d ,0
.CENTER;Known Bugs and Deficiencies
.BLANK
.CENTER;PCLS Version VI.i-002

.BLANK 2
This file should be processed with the qualifier
order to get the benefit of the coded information
left-hand margin. The key to the marginal coding
.BLANK.LEFT MARGIN 8.TAB STOPS 14
.BREAK;d TAB [Diagnostic notes.
.BREAK;c TABjCompleted-closed.
.BREAK;p TAEpPassed to another group - closed
.BREAK;u TAB]User errors or misunderstandings .LEFT MARGIN 0.BLANK
.LIST
.LEFT MARGIN 6

.IF COMPLETED
.LIST ELEMENT;[1122] (submitted by Adams) Found
VI.0-004; VMS only.
.BLANK
PCLS miscounts input records if the /RETRY quali
used.
.BLANK
Fixed in 1.0-005, 10-June-1981.
.ENDIF COMPLETED
.BLANK
#

.IF USER
.LIST ELEMENT;[1131] (submitted by Clark) Found
VI.0-006; all operating systems.
.BLANK
Closed: User error.
.BLANK
Reports sometimes print over the line printer pag
perforation when the NEWPAGE command is used.
.BLANK
This is not actually a bug. The user wants blank
is neglecting the page-header text in counting li
.ENDIF USER
.BLANK
#

.IF PASSED
.LIST ELEMENT;[1149] (submitted by AUSTIN::PRINE
VI.0-010; VMS only.
.BLANK
PCLS incurs an access violation upon trying to c
filein a version-limited directory.
.BLANK
Passed to the I/O group on 6-July-1981.
.BLANK
Fixed in VI.0-011.
.IF DIAG
.BLANK
A problem with the I/O system. It did not properl
the message from VMS that notifies the user that
oldest version was deleted.
.ENDIF DIAG
.ENDIF PASSED

.BLANK
PCLS access-violates when trying to open the fourth output
file in a user-defined sequence of output files.
.IF DIAG
.BLANK
Problem is likely to be in the EXTOUT module or in
something it calls.
.ENDIF DIAG
.END LIST 0
.BLANK
[End of BUGLIST.RND]

The output file, processed with RUNOFF/DEBUG, is this:
Known Bugs and Deficiencies
PCLS Version VI.1-002

This file should be run off with the qualifier /DEBUG in order
the benefit of the coded information in the left-hand margin.
to the marginal coding is:
d
c
p
u
c
c
c
c
c
c
c
c
u
u
u
u
u
u
u
u
u
u
u
P
P
P
P
P
p

Diagnostic notes.
Completed - closed.
Passed to another group - closed.
User errors or misunderstandings
closed.
[1122]
only.

(submitted by Adams) Found

PCLS miscounts input records if the
is used.

VI.0-004;

/RETRY

qualifie

Fixed in 1.0-005, 10-June-1981.
2.

[1131] (submitted by Clark) Found
operating systems.

VI.0-006;

Reports sometimes print over the line printer
perforation when the NEWPAGE command is used.

pag

This is not actually a bug.
The user wants
pages but is neglecting the page-header text in
counting lines.

blan

Closed:

User error.

[1149] (submitted by AUSTIN::PRINE) Found in VI.0-010
VMS only.
PCLS incurs an access violation upon trying to
a file in a version-limited directory.

creat

(Continued

2-130

Fixed in VI.0-011.
A problem with the I/O system.
It did not
handle the message from VMS that notifies
that the oldest version was deleted.
4.

[1211] (submitted
VMS only.

Clark) Found

before

PCLS access-violates when trying to open th
output file in a user-defined sequence
files.
Problem is likely to be in the
something it calls.
of BUGLIST.RND]

EXTOUT

modul

DSR Commands
.XLOWER and .XUPPER

.XLOWER
.XUPPER
The .XLOWER command allows you to control the case of index
entries specified by the .INDEX and the .ENTRY commands, or the
Index flag (> ). The case of the index entries will match exactly the
case that you enter when you make the .INDEX entry.
The .XUPPER command lets DSR control the case of index entries.
If .XUPPER is in effect (as it is by default), DSR capitalizes the first
character of every index entry, and drops everything else in the entry
to lowercase. Section 6, Creating an Index, has information on the
DSR indexing utility.

FORMAT

.XLOWER
.XL

DEFAULT

.XUPPER

2-132

.XUPPER
.XU

DSR Flags

This section describes the DSR flags. Flags are special characters that you
insert in your text to specify, for example, emphasis of text, case of characters,
and spacing of characters.

3.1

DSR Flag Characters
Table 3-1 lists all the flags, the default characters associated with the flags,
and the function of each flag.

Table 3-1

DSR Flags

Flag Name

Char. Purpose

—

Treat next character as ordinary text

Make next character boldface

Bold
Break

Allow DSR to break word here if at end of line

Capitalize

Capitalize all characters in next word

Comment

Allow hyphenation of word here if at end of line

Hyphenate

Index

Index next word

Make next character lowercase

Overstrike

Overstrike previous character with next character

Period

Insert extra interword space after character

Space

Insert unexpandable space

Subindex

Subindex next word or phrase if in a .INDEX or .ENTRY
command

Substitute

Insert date or time

Underline

Underline next character

Lowercase

Uppercase

3.1.1

Begin comment
Start DSR command

Control

Make next character uppercase

Entering Flag Characters
Enter flag characters in your text file to specify the character or strings of text
that you want to bold, capitalize, index, and so on. The following example
shows an input file with emphasis flags:
~&A Manual of Style\& by the University of Chicago Press
is a source of information on index entries.
.BLANK
.FLAGS BOLD
Do ~*NOT\* remove this book from the reference room.

3-1

DSR Flags

After processing this file with the RUNOFF command, the output is the
following:

A Manual of Style by the University of Chicago Press is a source
of information on index entries.
Do NOT remove this book from the reference room.

3.1.2

Using Multiple Flag Characters
The following flags can be used alone or with another flag (except as
specified):
Accept (can be used with any flag, including itself)
Bold
Capitalize
Comment
Lowercase
Substitute (can be paired only with itself)
Underline
Uppercase
The following flags are used alone (except for pairing with the Accept flag):
Break
Hyphenate
Index
Overstrike
Period
Space
Subindex

3.2

DSR Commands That Control Flags
Two DSR commands affect the DSR flag characters: the .FLAGS flagname command turns the recognition of a flag character on or off, and
the .ENABLE/.DISABLE flag-action command enables or disables the
action of certain flags. The following sections discuss the use of these two
DSR commands with the flag characters. There are detailed descriptions
of the DSR commands that control flags in Section 2. The commands
are listed alphabetically under .ENABLE BOLDING, HYPHENATION,
OVERSTRIKING, UNDERLINING, and .FLAGS flag-name.

3.2.1

Recognition of Flag Characters
Recognition of flag characters means only that the flag characters will not be
taken as text. If a flag is recognized by DSR, it does not appear in output
text. A recognized flag may or may not perform its flag task. For example,
the Underline flag might be recognized as a flag, but not cause underlining,
because you specified the /NOUNDERLINE qualifier on the DSR command
line (see Section 4).

3-2

DSR Flags

If a flag is not recognized by DSR, it appears as output text, and it does not
perform its flag task.
You cause a flag to be recognized by issuing a .FLAGS flag-name command.
For example:
.FLAGS BOLD

You turn off recognition of a flag character with the .NO FLAGS flag-name
command:
.NO FLAGS BOLD

You can suspend recognition of all flags simultaneously (except for the
Comment flag and the Control flag) by issuing .NO FLAGS ALL. If you issue
this "master switch" command, even those flags with recognition turned on
(either by default or because you issued the .FLAGS flag-name commands
for those flags) will not be recognized. If you later issue .FLAGS ALL, flag
recognition will be restored for all flags previously turned on. If recognition
of a flag character is individually turned off, (for example, .NO FLAGS
BOLD), the subsequent recognition of all flag characters (by .FLAGS ALL)
will not cause recognition of the individually turned off flag.
For a flag to perform its task, its recognition must be turned on both
collectively and individually.

3.2.2

Enabling of Flag Actions
Enabling of flag actions means that their tasks will be performed if the flags
are recognized. All flag actions are enabled by default. Therefore, it is not
usually necessary to issue .ENABLE flag-action commands.
You can disable the operation of some flags without affecting their
recognition. See .ENABLE/.DISABLE BOLDING, HYPHENATION,
INDEXING, OVERSTRIKING, and UNDERLINING. Once you have disabled
the action of a flag in this way, you can reenable it with the corresponding
.ENABLE command.
(See Section 2 if you want more information on .ENABLE BOLDING,
.ENABLE HYPHENATION, .ENABLE INDEXING, .ENABLE
OVERSTRIKING, and .ENABLE UNDERLINING.)

3.2.3

Redefining Flag Characters
You can change a flag from the default character to another character.
You redefine a flag character by turning off recognition of the current flag
character with .NO FLAGS flag-name and then specifying a new character
with the appropriate .FLAGS flag-name command. You might want to do this
if, for example, you are frequently using a default flag character as regular
text. By redefining the flag as another character, you avoid having to place an
Accept flag before the character each time you use it. (The Accept flag allows
flag characters to be accepted by DSR as regular text characters.)

3-3

DSR Flags

For example, if you wanted to move files from a RSTS system, which uses the
RNO text-formatting program, to a VAX/VMS system, which uses DSR you
could redefine the flag characters. In RNO, the ampersand (&) is the bold
flag, and the percent sign (%) is the underline flag. The RNO flags cannot
be redefined. In DSR, the asterisk (*) is the bold flag and the ampersand is
the underline flag, but they CAN be redefined. Therefore, in order to avoid
having to change all the ampersands and percent signs in your RNO file to
asterisks and ampersands, respectively, you can simply redefine the flags at
the beginning of your DSR file as follows:
.NO FLAGS UNDERLINE
.FLAGS BOLD &
.FLAGS UNDERLINE %
In this example, you must first issue .NO FLAGS UNDERLINE to disable the
use of the ampersand, the default flag character for underlining. You must
issue a .NO FLAGS flag-name command for any flag character that you want
to redefine whose recognition is currently turned on.
You can replace a flag character with an ASCII control character, but you
must precede the replacement control character with an Accept flag (_).
Otherwise, the flag will not be recognized. Note that the operating system
may make it difficult for you to input some control characters directly.
In the following example, the Overstrike flag (%) is redefined as the ASCII
backspace control character Ictrl/h1 :
.FLAGS OVERSTRIKE

ICTRL/HI

In this example, you do not need to issue a .NO FLAGS OVERSTRIKE
command, since recognition of the Overstrike flag is not turned on by default.
The following section has detailed descriptions of the individual DSR flags.
The flags are listed in alphabetical order.

3-4

DSR Flags
The Accept Flag (_)

The Accept Flag (_)
DESCRIPTION The Accept flag causes any character that directly follows it to be accepted as
text.
If the character is a punctuation mark after which DSR normally inserts an
extra space (for example, a period), you can precede it with the Accept flag
to cancel the extra space. You might want to cancel the extra space when
you enter terms in which a period does not necessarily end a sentence, for
example:
Mr_. or Mr8_.

The output would be:
Mr. or Mrs.

rather than:
Mr.

or Mrs.

If you want to insert a flag character into your text, the easiest way is to
precede it with the Accept flag. For example, to insert & (the Underline flag),
you would type
For underlining purposes, you can use the Accept flag to cause the acceptance
of an expandable space (one you produce by pressing the SPACE bar),
because DSR normally does not underline spaces between words.

DEFAULT

Recognition is turned on.

3-5

DSR Flags
The Bold Flag (*)

The Bold Flag (*)
DESCRIPTION The single character occurrence of the Bold flag causes the next character

to be printed in boldface, that is, to be overstruck once. You can cause
characters to be overstruck more than once by using the /BOLD=number
qualifier when processing the file with the RUNOFF command.

DEFAULT

Recognition is turned off. To turn on recognition, you must use the .FLAGS
BOLD command.

EXAMPLES
• Input
.FLAGS BOLD
Use Types *A and *C

• Output
Use Types A and C

In addition, the operation performed by this flag (as opposed to the flag's
recognition) can be disabled and reenabled by the .DISABLE BOLDING and
.ENABLE BOLDING commands or by the /BOLD and /NOBOLD command
line qualifiers.
You can pair the Bold flag with the Uppercase flag () to turn bolding on
and pair it with the Lowercase flag (\*) to turn bolding off. For example:
• Input
‘♦These words are in boldface.\*

• Output
These words are in boldface.

DSR Flags
The Break Flag (I)

The Break Flag (1)
DESCRIPTION The Break flag tells DSR where it may break a word that occurs at the end

of a line. You might want DSR to be able to break a word after a slash (/)
or a hyphen (-) that is part of the word (for example, "a yes/no response").
The Break flag allows a line to end where the flag occurs; no hyphen is ever
inserted because of it.
If the flag is turned on and inserted at break points, DSR is able to break the
word at any of the specified points. If more than one Break flag is present in
a word that DSR is breaking at the end of a line, DSR leaves as much of the
word as possible on the line, that is, it breaks the word at the last possible
Break flag.
The Break flag works the same whether .JUSTIFY or .NO JUSTIFY is in effect.

DEFAULT

Recognition is turned off. To turn on recognition, you must use the .FLAGS
BREAK command.

EXAMPLES
• Input
.FILL.RIGHT MARGIN 40
.FLAGS BREAK
.BLANK;This is an example of a phrase (end-I of- Iline) with
break points.

• Output
This is an example of a phrase (end-ofline) with break points.

3-7

DSR Flags
The Capitalize Flag (< )

The Capitalize Flag (< )
DESCRIPTION The Capitalize flag causes all the letters in the word directly following it to
be capitalized, except for letters that may be preceded by an Accept (—) or
Lowercase (\) flag.
Capitalization continues until one of the following is encountered:
An expandable space
A Break flag (I)
A Hyphenate flag (-)
Another Capitalize flag
A pair of Uppercase flags (AA)
A pair of Lowercase flags ()
The end of the line
You can pair the Capitalize flag with the Uppercase flag (A <) to capitalize all
following text up to the next case flag.

DEFAULT

3-8

Recognition is turned off. To turn on recognition, you must use a .FLAGS
CAPITALIZE command.

DSR Flags
The Comment Flag (!)

The Comment Flag (!)
DESCRIPTION The Comment flag is used to insert comments in the RNO file. You type the
comment text immediately after the Comment flag. Comments do not appear
in the output file.

DEPAULT

Recognition is turned on.

EXAMPLES
• Input
.LEFT MARGIN 0.RIGHT MARGIN 60!Place comment here.

You can use the flag wherever you use a command, except after a semicolon
(;) or at the very beginning of a line (character position 0). Because a
semicolon terminates a comment, you cannot include one in your comment.
You can, however, include a semicolon in regular text without using an
Accept flag.
A semicolon can also be used as a comment flag but only when it is paired
with a control flag at the beginning of a line:
^

.;This is a comment.

When not used as a comment flag, a semicolon can be used to terminate a
comment or a string of DSR commands. In this case, text that you type after
the semicolon will appear in the output file.
You can pair the Comment flag (!) as follows:
•

With a dot (.!), to introduce a comment at the beginning of a line:
.!Place comment here.

•

With an Accept flag (_!), which allows the character to be taken as
ordinary text.

3-9

DSR Flags
The Control Flag (.)

The Control Flag (.)
DESCRIPTION The Control flag is placed at the left margin to begin a string of DSR

commands. When you want a dot to be accepted as a text character, you
do not need to precede it with an Accept flag ( —) as long as the dot is not
placed at the left margin. If you do need to have a dot in the 0 character
position (and it is not part of a DSR command), you must precede it with an
Accept flag. Alternatively, you can use two dots at the beginning of a line;
the effect is the same as if you had used an Accept flag. (See also .FLAGS
CONTROL in Section 2.)

DEFAULT

Recognition is turned on.

EXAMPLES
• Input
■INDENT 5
The word "indent" is taken as a command by DSR when it
is preceded by a dot in the left margin.

• Output
The word "indent" is taken as a command by DSR
when it is preceded by a dot in the left margin.

(Note that the period at the end of the sentence does not need an Accept
flag.)
• Input
..FLAGS BOLD enables recognition of the Bold flag.

• Output
.FLAGS BOLD enables recognition of the Bold flag.

(Here an Accept flag is needed in the input text because the period is placed
at the left margin.)
• Input
..FLAGS BOLD enables recognition of the Bold flag.

• Output
.FLAGS BOLD enables recognition of the Bold flag.

(Using two dots has the same effect as using the Accept flag.)

3-10

DSR Flags
The Hyphenate Flag (=)

The Hyphenate Flag (=)
DESCRIPTION When the Hyphenate flag is turned on and inserted between syllables of a

word, DSR knows where the word can be broken at the end of a line. DSR
inserts a hyphen where the break occurs. If DSR does not find it necessary to
break the word, however, the hyphen does not appear.
The action of this flag (as opposed to the recognition of the flag) can be
disabled or reenabled by the .DISABLE HYPHENATION and .ENABLE
HYPHENATION commands.

DEFAULT

Recognition is turned off. To turn on recognition, you must use the .FLAGS
HYPHENATE command.

EXAMPLES
• Input
.FLAGS HYPHENATE
This is an example of a hy=phen=at=ed word.

• Output
This is an example of a hy¬
phenated word.

3-11

DSR Flags
The Index Flag (> )

The Index Flag (> )
DESCRIPTION

With the Index flag you can mark words in the text of your document as
index entries. Using the .INDEX command instead of the Index flag is a more
common way of marking index entries. Section 6, The DSR Indexing Utility,
has information on creating indexes.

DEFAULT

Recognition is turned off. To turn on recognition, you must use the .FLAGS
INDEX command.

3-12

DSR Flags
The Lowercase Flag (\)

The Lowercase Flag (\)
DESCRIPTION The Lowercase flag causes the letter that directly follows it to appear in
lowercase. The flag has no effect if the character following it is not a letter.
The Lowercase flag can be paired as follows:

DEFAULT

•

With the Underline flag (\&) to stop underlining text.

•

With the Bold flag (\* *) to stop bolding characters.

•

With itself (\\) to cause the characters following it to be printed in
lowercase by default. If you have a file that is in all uppercase, you can
put a paired lowercase flag (\\) at the beginning of the file and then, as
needed, override the temporary lowercase default by using a circumflex
(*) to capitalize a letter following it.

Recognition is turned on.

DSR Flags
The Overstrike Flag (%)

The Overstrike Flag (%)
DESCRIPTION When the Overstrike flag is turned on and inserted between two characters, it
causes the first of the two characters to be overstruck by the following one.

This capability allows the printing of characters not normally available, for
example, a 7 overstruck with a dash (7).
Three or more characters can be overstruck, but only if you specify the
/BACKSPACE qualifier in the DSR command line. Otherwise, only the first
and last characters in an overstrike sequence will appear.
The action performed by this flag (as opposed to the flag's recognition) can
be disabled and reenabled by the .DISABLE OVERSTRIKING and .ENABLE
OVERSTRIKING commands.

DEFAULT

Recognition is turned off. To turn on recognition, you must use the .FLAGS
OVERSTRIKE command.

EXAMPLES
• Input
.FLAGS OVERSTRIKE
Overstrike this 7'/,-.

• Output
Overstrike this 7.

3-14

DSR Flags
The Period Flag (+)

The Period Flag (+)
DESCRIPTION DSR routinely inserts an extra expandable space after a period, colon,

question mark, or exclamation point that is followed by the usual end-of-word
space.
The Period flag lets you specify the extra space for other characters.
If the flag is turned on and .FILL is in effect, an extra space occurs when the
flag (+) is inserted directly after the character. You must, however, insert the
end-of-word space after the flag if it is to be effective.
For example, if you have a complete sentence enclosed in quotation marks or
parentheses, you may want an extra space after the closing quotation mark or
parenthesis. (See also the .PERIOD command in Section 2.)

DEFAULT

Recognition is turned off. To turn on recognition, you must use the .FLAGS
PERIOD command.

EXAMPLES
• Input
.FLAGS PERIOD
"What do you mean?"* There was no response.

• Output
"What do you mean?"

There was no response.

3-15

DSR Flags
The Space Flag (#)

The Space Flag (#)
DESCRIPTION The Space flag produces one unexpandable space (not affected by justification)
in the output file for every flag character inserted in the input file. If you
insert the flag between two words, DSR treats them as one word (although
they will appear as separate words in the output file). Therefore, you should
not type any spaces before or after typing the Space flag.
The flag can directly follow an Underline flag (&#) to cause the underlining
of an unexpandable space.

DEFAULT

3-16

Recognition is turned on.

DSR Flags
The Subindex Flag (> )

The Subindex Flag (> )
DESCRIPTION This flag works as a subindex entry flag only if you have issued an .INDEX or
.ENTRY command. Subindex entries marked with this flag are collected and
alphabetized below the primary entry to which they refer. The Subindex flag
indicates that the next word or phrase will be placed on the following line
of the index, indented two characters to the right of the preceding entry. For
more information on indexing, see Section 6.

DEFAULT

Recognition is turned on only within .INDEX and .ENTRY commands.

EXAMPLES
The following is an input file with index entries and subindex flags:
.PAGE
text text text text text text text text text text text text
. INDEX Parameters description
.PAGE
text text text text text text text text text text text text
.INDEX Parameters >Examples
.PAGE
text text text text text text text text text text text text
.INDEX Parameters >Types >Strings
.INDEX Parameters >Types >Integers

The following is the index with the subindex entries:
Page Index-1
INDEX

Parameters
Description, 1
Examples, 2
Types
Integers, 3
Strings, 3

3-17

DSR Flags
The Substitute Flag Pair ($$)

The Substitute Flag Pair ($$)
DESCRIPTION

This is the only flag that must be paired with itself. When the flag is turned
on, it causes either a date or a time to be output. The output is determined
by the word you associate with the flag pair; for example, $$Date. See the
output in the following example.
When the Substitute flag is turned on, any dollar sign character ($), even if it
is not paired, must be preceded by an Accept flag if it is to be taken as normal
text by DSR. (See also .SET DATE and .SET TIME in Section 2.)

DEFAULT

Recognition is turned off. To turn on recognition, you must use the .FLAGS
SUBSTITUTE command.

EXAMPLES
The following example shows the use of the substitute flag. The output file
will contain the date and time that DSR processing of the file began.
• Input
.FLAGS SUBSTITUTE
$$Date
$$Time
$$Year
$$Month
$$Day
$$Hours
$$Minutes
$$Seconds
$$Month#$$Day.#$$Year

• Output
10 November 1985
10:55:00
1985
November
10
10
55
00
November 10, 1985

3-18

DSR Flags
The Underline Flag (&)

The Underline Flag (&)
DESCRIPTION The Underline flag causes the next character to be underlined.
The operation performed by this flag (as opposed to the flag's recognition) can
be disabled and reenabled by the .DISABLE UNDERLINING and .ENABLE
UNDERLINING commands.
The Underline flag can be paired as follows:

DEFAULT

•

With the Uppercase flag (*&) to turn underlining on and with the
Lowercase flag (\&) to turn underlining off.

•

With the Space flag (&#) to cause the underlining of unexpandable
spaces.

Recognition is turned on.

EXAMPLES
You can produce underlined text by placing the begin ("&) and end (\&)
underline flag pairs before and after the words you want to underline:
• Input
~&To be or not to be\&

• Output
To be or not
to be

You can underline between-word expandable spaces (spaces produced by
pressing the space bar) by putting the Accept flag before the spaces.
• Input
~&To_ be_ or_ not_ to_ be\&

• Output
To be or not to be

3-19

DSR Flags
The Underline Flag (&)

You can underline between-word unexpandable spaces (spaces produced with
the space flag [#]) by putting the underline flag (&) before the space flag.
• Input
~&To&#be&#or&#not&#to&#be\&

• Output
To be or not to be

3-20

DSR Flags
The Uppercase Flag (~)

The Uppercase Flag f)
DESCRIPTION The Uppercase flag serves the same purpose as a typewriter SHIFT key when
you use it just before typing a letter. The flag capitalizes any single letter that
directly follows it. It has no effect if the character following it is not a letter.
The Uppercase flag can be paired as follows:

DEFAULT

•

With a Capitalize flag (A < ) to turn on the capitalization of the text that
follows (the same as using SHIFT-LOCK on a typewriter).

•

With an Underline flag () to turn on underlining of the text that follows.

•

With a Bold flag ("*) to turn on bolding for the text that follows.

•

With itself ("") if you want to ensure that the case of letters in your input
file is maintained in your output file. You can use this flag pair with those
commands that control uppercasing and lowercasing (such as .HEADER
LEVEL or .CHAPTER). When you specify a title, precede it with

Recognition is turned on.

3-21

RUNOFF Command Qualifiers

To run DSR, use the DIGITAL Command Language (DCL) RUNOFF
command. The DSR command line consists of the RUNOFF command,
input file specifications, and optional qualifiers. Do not confuse the RUNOFF
command qualifiers with the DSR formatting commands, which are part of
your input text file. /BOLD is a command qualifier, .FLAGS BOLD is a DSR
command.

4.1

Input and Output File Specifications
To specify the input file for the RUNOFF command, you must enter the
complete file name and file type, unless the file type is RNO. If the input
file type is RNO, you can omit it from the command line. Wildcards are not
allowed as part of the input file specification.
The output file name will be the same as the input file name. The output file
type will depend on what the input file type is. The following list names
various input file types and the corresponding output file types:
Input

4.2

Output

RNB

BLB

RNC

CCO

RND

DOC

RNE

ERR

RNH

HLP

RNL

PLM

RNM

MAN

RNO

MEM

RNO/DEVICE=LN01

LNI

RNO/DEVICE=LN03

LNI

RNP

OPR

RNS

STD

RNT

MEC

RNX

MEX

None

MEM

Other

MEM

How to Run DSR
With the DCL RUNOFF command, you can instruct DSR to access an input
file, produce a formatted output file, and direct the output either to the disk
(for storage and printing) or to the terminal (for display).

4-1

RUNOFF Command Qualifiers

To run DSR, you type the word RUNOFF and the name of the input file after
the VAX/VMS dollar sign prompt:
$ RUNOFF TEST.RNO

You can also just type RUNOFF. In this case, DSR prompts for the file name:
_File:

If your file type is RNO (the default file type in DSR), you can omit it when
you specify the file name.

4.2.1 Output to Disk
When DSR processes the RNO file, it outputs a MEM file to the disk.
If no errors are detected, the program returns to the VAX/VMS command
level.
$ RUNOFF TEST
$

If an error is detected, the program responds by printing an error message
and a summary of errors when finished. For example:
7.RUN0FF-W-CJL Can't justify line on output page 1; on input line 8
of page 1 of file "_DBB5:[GILBERT]TEST.RNO;1"
DIGITAL Standard Runoff Version V3.0: 1 diagnostic message reported
1 page written to _DBB5:[GILBERT]TEST.MEM;1
$

4.2.2 Output to Terminal
If you want to display the processed output file on the terminal instead of
saving it in a file, type the following:
$ RUNOFF TEST.RNO/OUTPUT=SYS$OUTPUT

(TEST.MEM is displayed on the terminal)
$

4.2.3 Input from Terminal
If you want to insert additional commands before processing, specify the
terminal as the input device:
$ RUNOFF SYS$INPUT/OUTPUT=TEST.MEM
.FLAGS BOLD”
.REQUIRE "TEST.RNO"
~Z
$

Note that you terminate input from the terminal by typing 1ctrl/z| (which
VAX/VMS displays as Exit). If errors are detected, the program prints
messages as the errors are encountered.

4-2

RUNOFF Command Qualifiers

4.2.4

Terminal Input and Output
If you want to test individual DSR commands, flags, or qualifiers by checking
them on the terminal, you can specify the terminal as both the input device
and the output device. For example:
$ RUNOFF SYS$INPUT/OUTPUT=SYS$OUTPUT
.FLAGS CAPITALIZE
Capitalize the first word
[RET]

The resulting display is:
CAPITALIZE the first word.

To terminate the session, type |ctrl/z| .

4.3

Rules for Command Qualifiers
The 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 otherwise to control the appearance of printed output.
You can use RUNOFF qualifiers to override DSR commands or flags included
in the input file. For example, the following command line would suppress
any bolding you may have specified in the input file:
$ RUNOFF /NOBOLD MYFILE.RNO

The following rules apply to the use of command qualifiers:
•

A command line can include as many qualifiers as you want as long as no
operational conflicts occur. The command line can be continued on the
next line if you specify a hyphen (-) as the last character in the first line.

•

You can enter qualifier names in uppercase, lowercase, or both.

•

You can enter qualifier names in a truncated form. For example,
/BACK is equivalent to /BACKSPACE. VAX/VMS looks only at the
first four characters of a command or qualifier. Thus, all commands and
qualifiers can be abbreviated to four characters or to the shortest unique
abbreviation.

•

No spaces are allowed between the qualifier symbol (/) and a qualifier
name, or between a qualifier name and a numerical or text value (for
example, /FORM_SIZE=58).

•

The qualifier(s) can follow either the RUNOFF command or an individual
file specification. Qualifiers placed after the RUNOFF command will
affect all files listed on the command line; qualifiers placed after a file
specification will affect only that file. Exceptions are /FORM_SIZE,
/SIMULATE, /PAUSE, and /LOG, which affect all files listed in the
command line, regardless of whether the qualifier is placed after the
RUNOFF command or after a file specification.

4-3

RUNOFF Command Qualifiers

•

When you are using the Table of Contents and Indexing Utilities, you
must place the name of the utility directly after the RUNOFF command.
For example, to invoke the Table of Contents Utility, enter the following
command:
RUNOFF/CONTENTS

Any qualifiers that you want to add to the command line to affect the
processing of the Table of Contents Utility must come after the qualifier
that invokes the Table of Contents Utility. The following command
invokes the Table of Contents Utility and specifies that section numbers
are not displayed in the table of contents file:
RUNOFF/CONTENTS/NOSECTION_NUMBERS

4.4

Command Qualifiers
This section describes RUNOFF command qualifiers. The qualifiers are of two
types: command qualifiers and positional qualifiers. Both types of qualifiers
are merged into a single alphabetized list in the description section.

Command Qualifiers

Defaults

/FORM—SIZE=n
/[NOJLOG
/[NOJPAUSE
/[NOjSIMULA TE

/FORM—SIZE=66
/NOLOG
/NOPAUSE
/NOSIMULATE

Positional Qualifiers

Defaults

/BACKSPACE
/[NO]BOLD[=n]
/[NO]CHANGE—BARS[=“character"]
/CONTENTS
/[NO]DEBUG[=(option[,...])]
/DEVICE=(option[,...])
/[NO]DOWN[=n]
/INDEX
/[NOJINTERMEDIA TE[=file-spec]
/MESSA GES=(option[,...])
/[NO]OUTPUT[=file-spec]
/PA GES=string
/REVERSE-EMPHASIS
/[NO]RIGHT[=n]
/SEPA RA TE— UNDERLINE^ "character"]
/[NOJSEQUENCE
/[NOJUNDERLINE—CHA RA CTER[= ‘chara
/VARIANT=string

None.
/BOLD= 1
None.
See Section 5.
/NODEBUG
See text.
/NODOWN
See Section 6.
/NOINTERMEDIATE
/MESSA GES=(OUTPUT, USER)
See text.
All pages output.
None.
/NORIGHT
None.
/NOSEQUENCE
/UNDERLINE—CHARACTERS— ’
None.

RUNOFF Command Qualifiers
/BACKSPACE

/BACKSPACE
DESCRIPTION

The /BACKSPACE qualifier directs DSR to use the Backspace character to
produce three special effects:
•

Bolding flagged text (see the Bold flag description in Section 3) by
backspacing and overstriking each character as it is printed.

•

Overstriking flagged characters (see the Overstrike flag description in
Section 3) by backspacing and overstriking each character as it is printed.

•

Underlining flagged text (see the Underline flag description in Section 3)
by backspacing and underlining each character as it is printed. The default
underlining character is an underscore (_).

The /BACKSPACE qualifier generally gives more exact underlining and
bolding for files output on letter-quality printers.
Most line printers do not recognize or act on the Backspace character, so the
/BACKSPACE qualifier is not recommended for line printer output.
Using /BACKSPACE allows you to overstrike three or more characters by use
of the Overstrike flag (see Section 3).
If you do not issue the /BACKSPACE qualifier, the printer produces the
above effects by issuing a carriage return without a line feed, then printing
additional lines that contain only underscores or only the overstruck or
bolded text.

EXAMPLE
$ RUNOFF TEST.RNO/BACKSPACE

4-5

RUNOFF Command Qualifiers
/BOLD[=number] and /NOBOLD

/BOLD[=number]
/NOBOLD
DESCRIPTION

The /NOBOLD qualifier disables the bolding function. The /BOLD=n
qualifier specifies the number of times the text is to be overstruck. Neither
qualifier affects recognition of the Bold flag; you must turn on recognition of
the Bold flag with .FLAGS BOLD.
The default is /BOLD=l. Specifying /BOLD=0 is equivalent to using
/NOBOLD. /BOLD=3 gives good results on most line printers.
If you use /NOBOLD to disable bolding, you cannot reenable bolding
within that DSR run. The DSR command, .ENABLE BOLDING, is ignored if
/NOBOLD is specified.

EXAMPLES
$ RUNOFF MYFILE/B0LD=4
$ RUN0FF/B0LD=0 SOURCE.1
$ RUNOFF CHAPTERS.VO2/N0B0LD

4-6

RUNOFF Command Qualifiers
/CHANGE_BARS[-"character"] and /NOCHANGE_BARS

/CHANGE_BARS[="character"]
/NOCHANGE_BARS
DESCRIPTION

The /CHANGE—BARS and /NOCHANGE—BARS qualifiers enable and
disable the appearance of change bars (I) in the output file.
Using /CHANGE—BARS to enable change bars for an output file is equivalent
to entering an .ENABLE BAR command at the beginning of your input file
(see .ENABLE BAR in Section 2). The /CHANGE-BARS qualifier can also
specify a replacement for the change bar character:
/CHANGE_BARS-"x"

The specified replacement can be a character that takes up space (such as
* or ?) or a character that does not take up space (such as CTRL/G). A
nonspacing character code can be used:
/CHANGE_BARS-y,07/0UTPUT-SYS$0UTPUT

In this example, the octal code 7 causes the terminal bell to ring every time
an altered line of output is encountered.
The change bar qualifier can be disabled by using /NOCHANGE—BARS.
/NOCHANGE—BARS overrides any .ENABLE BAR command in the file.

EXAMPLES
$ RUNOFF YOURFILE/CHANGE_BARS='/.07
$ RUNOFF TESTS/CHANGE_BARS="* M
$ RUNOFF A.RNT/NOCHANGE.BARS

4-7

RUNOFF Command Qualifiers
/DEBUG[=(option[,...])] and /NODEBUG

/DEBUG[=(option[,...])]
/NODEBUG
DESCRIPTION

The /DEBUG qualifier traces the operation of certain DSR commands by
causing the commands to appear in the output file. The commands that
are associated with each of the following option words will appear in the
output file if you use the option word as a value for /DEBUG= (for example,
/DEBUG=INDEX).
•

CONDITIONALS
Specifying CONDITIONALS causes DSR to ignore all conditional
commands (.IF, .IFNOT, .ELSE, .ENDIF) in the input file and to include
the conditional commands in the output file. (See .VARIABLE in
Section 2.)

•

FILES
Specifying FILES causes DSR to print the .REQUIRE command in the
output file, in addition to the text of the .REQUIRE files.

•

INDEX
Specifying INDEX causes all indexing commands in the input file to be
printed in the file. Each indexing command appears before the line of text
with which it is associated.
All index entries specified with the .INDEX command or an Index flag are
labeled with the word .INDEX, while the entries specified with .ENTRY
commands are labeled with the word .ENTRY.

•

CONTENTS
Specifying CONTENTS causes all .SEND TOC commands in the input file
to be printed in the output file.

•

SAVE—RESTORE
Specifying SAVE_RESTORE causes all .SAVE and .RESTORE commands
in the input file to be printed in the output file.

•

ALL
Specifying ALL causes all five of the above actions.

If you specify more than one option, separate them with commas and enclose
the list in parentheses.
If you do not specify /DEBUG, the default is /NODEBUG. If you specify
/DEBUG without a qualifier, the default is /DEBUG=ALL.

EXAMPLES
$ RUNOFF HERFILE/DEBUG=CONDITIONALS
$ RUN OFF/DEBUG=INDEX CHAPTER6
$ RUNOFF SURVEY.DAT/DEBUG=(CONTENTS,INDEX)
$ RUNOFF LIST/DEBUG
$ RUNO A./DEB=FILES

4-8

RUNOFF Command Qualifiers
/DEVICE=(option[,...])

/DEVICE=(option[,...])
DESCRIPTION This qualifier can be used to produce an LNI file that is suitable for printing
on an LN01 or LN03 laser printer. You must supply at least one option word
(LN01, LN01E, or LN03) to specify whether the file will be printed on a
standard LN01, on a European LN01E, or on an LN03. The paper size for the
European LN01E printers is A4.
Do not use the /DEVICE=option qualifier with any of the following DSR
command qualifiers:
/BACKSPACE
/SEPARATE-UNDERLINE
/UNDERLINE_CHARACTER
In addition to the required option word (LN01, LN01E, or LN03), you can use
other option words to specify the layout of the text on the page (PORTRAIT
or LANDSCAPE) or the type of emphasis for characters marked with the DSR
underline flag (ITALIC or UNDERLINE). If you specify more than one option,
separate them with commas and enclose the list in parentheses.
All of the option words are described in the following list:
Option

Function

LN01

This option specifies that the output device is a
standard LN01 laser printer. The paper size is 8 1/2
by 11 inches. The default orientation is PORTRAIT
and the default emphasis is ITALIC.

LN01E

This option specifies that the output device is a
European LN01E laser printer, and the paper size
for it is the European A4. The default orientation is
PORTRAIT and the default emphasis is ITALIC.
This option specifies that the output device is a
standard LN03 laser printer. The paper size is 8 1/2
by 11 inches. The default orientation is PORTRAIT.
The LN03 laser printer recognizes the flags for
UNDERLINE or ITALIC. If the font currently loaded
in the laser printer has an ITALIC attribute, the text
flagged for emphasis is italicized. If the current
font does not have an ITALIC attribute, the default
emphasis is underlining.
This option specifies that the text will be arranged
on the page with the long dimension of the paper
(11 inches) at the top of the page. You can use this
option to print files that contain wide examples or
tables that will be fold-out pages in your document.

LN03

LANDSCAPE

PORTRAIT

This option specifies that the text will be arranged on
the page as it is in a standard business letter. The
short dimension of the paper (8 1/2 inches) is the top
of the page.
PORTRAIT is the default mode for the page
orientation.

4—9

RUNOFF Command Qualifiers
/DEVICE=(option[,...])

Option

Function

ITALIC

ITALIC is the default type of emphasis for LNI files
produced for the LN01 and LN01E. You do not have
to specify this option for LN01 and LN01E printers,
since it is the default. However, you may want to
use the option word ITALIC to override a previously
specified UNDERLINE option.
The LN03 requires no loading of fonts since default
fonts are present. Text flagged for emphasis is
printed ITALIC if the font currently loaded on the
printer has the Italic attribute, otherwise the default
emphasis is underlining.
There are four fonts available for LNI files for the
LN01 or LN01E laser printers: text, bold, italic, and
bold-italic. By default, all four fonts are loaded into
the printer. Characters flagged for emphasis with the
DSR underline flag (&) will be italicized by default.
Since you can nest emphasis flags in DSR, you might
have a character or a string of text that is flagged with
both the Bold (*) and the Underline (&) flags. The
following example would be printed on the LN01 as a
bold-italic word:
~*~&BOLDITALIC\&\*

You have the option of using the default fonts already
present on the LN03 or down-line loading the fonts of
your choice.

4-10

RUNOFF Command Qualifiers
/DEVICE=(option[,...])

Option

Function

UNDERLINE

This option causes the characters flagged with the
DSR underline flag (&) to be underlined rather than
italicized. The text and bold fonts are used for this
option.
The LN01 allows only 63 underline segments per
line. You create an LNOI underline segment each
time there is a break in the underlining. If you are
not underlining spaces, each underlined word is an
underline segment. If you do underline the spaces
between words, then the underlined words and
spaces make up one segment. For example, the
following would be six segments:
To be or not to be

The following would be one underline segment:
To be or not to be

DSR does not report an error if the user exceeds the
underline segment limit of the hardware.
If you are not getting the output that you expect when
you print an LNI file on the LNOI laser printer, check
with your system manager. Appendix B contains
information for system managers on setting an LNOI
to print LNI files.
On an LN03, if you have specified underlining, and
choose this option in the file you are printing, the
LN03 does UNDERLINE the flagged text. It does not
default to ITALIC even if the font has the ITALIC
attribute.

EXAMPLES
$ RUN0FF/DEVICE=LN01 TEXT.RNO
$ RUNOFF/DEVICE=(LNOI,LANDSCAPE) MEMO.RNO
$ RUNOFF CHAPTER1.RNO/DEVICE=(LNOI,LANDSCAPE,UNDERLINE)

4-11

RUNOFF Command Qualifiers
/DOWN=number

/DOWN=number
DESCRIPTION

The /DOWN qualifier lets you specify the number of blank lines to be
inserted at the top of each page, preceding any header information. The
number of blank lines you specify does not affect in any way the number of
text lines on a page. For example, if you issue /DOWN=10 with a .PAGE
SIZE of 58 lines, up to 58 lines of text will be output after 10 blank lines.
If you do not issue /DOWN, no blank lines are inserted except those
associated with the print device. If you issue /DOWN with no value, you get
/DOWN=5.

EXAMPLES
$ RUNOFF HISFILE.RN0/D0WN=lO
t RUNOFF/DOWN HISTORY

4-12

RUNOFF Command Qualifiers
/FORM_SIZE=number

/FORM_SIZE=number
DESCRIPTION

The /FORM-SIZE qualifier helps control the number of lines that can be
accommodated per page of output, including all running heads and feet.
When used with the /SIMULATE qualifier, /FORM_SIZE determines the
physical size of the page by putting out line feeds to equal the number you
use as n. When used with /NOSIMLATE, /FORM-SIZE causes DSR to
suppress the form feed it would put out at the line number you specify as
a value for n. If the number of lines that DSR is going to put on any given
page does not match the value of n, a form feed character will be written into
the output file.
The default value for n is derived from the RTL routine LIB$LP_LINES. This
will default to 66 unless the logical SYS$LP_LINES is defined, in which
case, the assigned value will be used. You can override the default value for
/FORM_SIZE by specifying a different value for n.
DSR normally starts each new page by writing a form feed character to the
output file. However, if the number of lines on a page exactly equals the
form size, DSR assumes that the output device (line printer) will advance to
the next page under hardware or system control. DSR does not write a form
feed in this case, because to do so would leave a blank page.
If you are generating output for a device with other than 66 lines per page,
use the /FORM_SIZE qualifier.
You can use the /FORM_SIZE qualifier with the
/DEVICE=(LN01,LN01E,LN03) qualifier to specify a page size larger
than the default paper size of 8 1/2 by 11 inches.

4-13

RUNOFF Command Qualifiers
/INTERMEDIATE[=file-spec] and /NOINTERMEDIATE

/INTERM EDI ATE[=file-spec]
/NOINTERMEDIATE
DESCRIPTION This qualifier causes DSR to generate an intermediate binary file with the

default file type of BRN. This file can be used as input to the DSR tableof-contents utility and the DSR indexing utility. See Sections 5 and 6 for
information on producing tables of contents and indexes.
If you use /INTERMEDIATE without specifying a value for file-spec, DSR
creates an output file that has the same file name as the input file and a file
type of BRN. You can rename the output file by supplying a file specification
that is different from the default values.
/NOINTERMEDIATE is the default.

EXAMPLES
$ RUNOFF MANUAL/INTERMEDIATE
$ RUNOFF/INTERMEDIATE BOOK.REQ

4-14

RUNOFF Command Qualifiers
/LOG and /NOLOG

/LOG
/NOLOG
DESCRIPTION The /LOG and /NOLOG qualifiers allow you to control whether DSR writes
a termination message to the terminal. The termination message includes the
following:
•

The version number of DSR

•

The number of diagnostic messages reported

•

The number of output pages generated

•

The output file specification

If you use the qualifier /INTERMEDIATE, the following information will be
included in the message:
•

The number of index records written to the intermediate file specification

•

The number of table-of-contents records written to the intermediate file
specification.

The default is /NOLOG.
If DSR detects errors in processing a file, it writes the termination message to
the terminal even if you specify /NOLOG.

EXAMPLES
$ RUNOFF PAYROLL/LOG
DIGITAL Standard Runoff Version V3.0: No errors detected
3 pages written to "DBA1:[WHITNEY]PAYROLL.MEM;1"
$
$ RUNOFF ERRORS.RNO/NOLOG/MESSAGES=USER
RUNOFF-I-CJL, Can't justify line
on output page 1; on input line 15 of page 1 of file "DBA1:[WHITNEY]
ERRORS.MEM;1"
DIGITAL Standard Runoff Version V3.0: 1 diagnostic message reported
3 pages written to "DBA1:[WHITNEY]ERRORS.MEM;1"
$

4-15

RUNOFF Command Qualifiers
/M ESS AG ES=option

/MESSAGES=option
DESCRIPTION The /MESSAGES qualifier lets you specify where you want DSR to display
error messages. The options are the following:
OUTPUT

Sends error messages only to the output file

USER

Sends error messages only to the terminal

The default is /MESSAGES=(OUTPUT,USER), which sends messages to the
output file and displays them on the terminal. You can cause error messages
to go only to the output file or only to the terminal, but you cannot suppress
them entirely.

EXAMPLES
$ RUNOFF OURFILE/MESSAGES=OUTPUT
$ RUNOFF DATA.2/MESSAGES=USER

4-16

RUNOFF Command Qualifiers
/OUTPUT=file-spec and /NOOUTPUT

/OUTPUT=file-spec
/NOOUTPUT
DESCRIPTION The /OUTPUT and /NOOUTPUT qualifiers let you specify where the output
from DSR processing should go. The default directory is the user directory,
the default file name is the name of the input file, and the default file type
depends on the input file type (see Section 4.1).
The /OUTPUT qualifier is a positional qualifier. If you enter /OUTPUT=filespec after an input file specification, the file-spec you supply applies only to
that input file. If you enter /OUTPUT=file-spec directly after the RUNOFF
command, the file-spec you supply applies to all input files (except any that
have their own /OUTPUT=name qualifiers).
You can specify /OUTPUT=directory-spec or /OUTPUT=logical-name to send
the output file to another directory.
/NOOUTPUT tells DSR not to create an output file. Use /NOOUTPUT with
the /INTERMEDIATE qualifier if you want to generate only a BRN file (see
Sections 5 and 6). You can also use /NOOUTPUT to check an input file for
errors without creating a formatted output file.

EXAMPLES
$ RUNOFF FINAL/OUTPUT=SYS$OUTPUT
$ RUNOFF/OUT=CHI::DBA2:[SULLIVAN]MONTHLY.RPT DRAFT.TXT

4-17

RUNOFF Command Qualifiers
/PAGES=string

/PAGES=string
DESCRIPTION The /PAGES qualifier lets you specify one or more pages or groups of pages
to be output. If you don't specify certain page numbers, they do not appear
in the output. The string is of the form:
start[:end]

or
"start:end[,...],start[:end]"

If you omit :end from the last page range, all pages from the start of that page
range to the end of the document are output.
Specify multiple page ranges in a quoted string, separating them by commas:
/PAGES*"start1:endl,start2:end2.... starts:endS"

The maximum number of ranges that you may specify is five.
If you want only one page, start and end must be the same number:
/PAGE=5-30:5-30

To specify output from Chapter 4, page 12, through a single page of the
appendix and five pages of the index, enter the following:
/PAGES*"4-12:A-l,Index-1:Index-5"

You must specify page numbers in their default form even if you have
a .DISPLAY command in your input file that specifies a different form.
For example, for Appendix B, Page B-6, you would specify /PAGE="B-6";
for Chapter V, Page V-13 (the result of a .DISPLAY command specifying
uppercase roman numerals), you would specify /PAGE="5-13".
For an entire appendix, only the letter is required (for example, /PAGES="A").
For an entire index, only the word "Index" is required (/PAGES="Index").

EXAMPLES
$ RUNOFF ITSFILE/0UTPUT=SYS$0UTPUT/PAGE=12
$ RUNOFF REPORT.TMP/0UTPUT=SYS$0UTPUT/PAGE=2-12
$ RUNOFF DOCUMENT/PAGES*"2-9:2-9,A-l:A-5c"

4-18

RUNOFF Command Qualifiers
/PAUSE and /NOPAUSE

/PAUSE
/NOPAUSE
DESCRIPTION

The /PAUSE qualifier controls whether DSR pauses after printing each page
of output. Pausing allows you to insert single sheets of paper or reproduction
masters into the output device. This qualifier is intended for use with
hardcopy output devices such as "daisy-wheel" printers. Do not use /PAUSE
if output for the named device is spooled.
The /PAUSE qualifier temporarily halts output and the terminal bell rings
to remind the operator to insert a new form. Processing resumes after the
operator presses the space bar. The default condition is /NOPAUSE.

EXAMPLE
$ RUNOFF NEWFILE.RN0/PAUSE/0UT=SYS$0UTPUT/F0RM_SIZE=60

4-19

RUNOFF Command Qualifiers
/REVERSE-EMPHASIS

/REVERSE-EMPHASIS
DESCRIPTION The /REVERSE—EMPHASIS qualifier directs DSR to change the order of
underlining the flagged text 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.
Some lineprinters require that you use the /REVERSE—EMPHASIS qualifier
to process your file to enable the underlining function.
If you do not issue the /REVERSE-EMPHASIS qualifier, the printer first
prints the underscores, issues a carriage return without a linefeed, then prints
the flagged text above the underscores. If you view your file on the terminal,
the flagged characters are visible.

EXAMPLE
$ RUNOFF TEST.RNO/REVERSE_EMPHASIS

4-20

RUNOFF Command Qualifiers
/RIGHT[=number] and /NORIGHT

/RIGHT[=number]
/NORIGHT
DESCRIPTION The /RIGHT qualifier causes the text on each page (including header
information) to be shifted to the right by the number of spaces specified.
These characters are not deducted from the page width specified in the input
file.
If you issue /RIGHT without a value, you get /RIGHT=5. If you issue
/RIGHT=0, no shift occurs. If you omit the /RIGHT qualifier, the default is
/NORIGHT.
If you specify /DEVICE=LN01, /DEVICE=LN01E, or /DEVICE=LN03 the
default values for /RIGHT depend upon the orientation of the text on the
page. The following table gives the default values for PORTRAIT and
LANDSCAPE:

Table 4-1

/RIGHT Default Values with /DEVICE=LN01 [E],LN03
LNOI

LNOI E

LN03

PORTRAIT

LANDSCAPE

You can override the default values by specifying /RIGHT=n or /NORIGHT.

EXAMPLES
$ RUNOFF 0LDFILE/RIGHT=8
$ RUNOFF X.2/RIGHT
$ RUNOFF/DEVICE=(LNOI,LANDSCAPE) REPORT.RNO

The default for /RIGHT in the above example is 9.

4-21

RUNOFF Command Qualifiers
/SEPARATE_UNDERLINE[="character"]

/SEPARATE_UNDERLINE[='character"]
DESCRIPTION The /SEPARATE_UNDERLINE qualifier causes underlining with separate

characters on the next line instead of overprinting with underscores on
the same line. The character may be expressed as a quoted character or as
an octal, decimal, or hexadecimal value. The default separate underlining
character is the hyphen (-).
Do not use this qualifier with /UNDERLINE-CHARACTER.

EXAMPLES
$ RUNOFF NEWFILE/SEPARATE.UNDERLINE
$ RUNOFF CHAPTER4/SEPARATE.UNDERLINE="*"
$ RUNOFF CALENDAR. LIS/SEPARATE_UNDERLINE='/,075

4-22

RUNOFF Command Qualifiers
/SEQUENCE and /NOSEQUENCE

/SEQUENCE
/NOSEQUENCE
DESCRIPTION The /SEQUENCE qualifier controls whether DSR outputs line numbers from
the input file. Line numbers show the input lines that generated each output
line to assist debugging. If the input file is not line-sequenced, DSR uses
sequential numbering.
The default is /NOSEQUENCE, which produces output without line
numbers.

EXAMPLE
$ RUNOFF MAILFILE. RNO/SEQUENCE

4-23

RUNOFF Command Qualifiers
/SIMULATE and /NOSIMULATE

/SIMULATE
/NOSIMULATE
DESCRIPTION

The /SIMULATE qualifier controls whether blank lines or form feeds are
used to advance to the top of each page. The default is /NOSIMULATE,
which uses form feeds.
Normally, DSR skips to the top of a page by means of a form feed. If you use
/SIMULATE, DSR does not generate form feeds. Instead, it prints enough
blank lines to cause a skip to the top of each new page. /SIMULATE also
causes a pause before the first page (but before the first page only, whereas
/PAUSE causes a pause before every page). To continue after the pause,
press the space bar.
You normally use /SIMULATE with hardcopy output devices such as
"daisy-wheel" printers.

4—24

RUNOFF Command Qualifiers
/UNDERLINE_CHARACTER[="character"] and /NOUNDERUNE

/UNDERLINE_CHARACTER[="character"]
/NOUNDERLINE
DESCRIPTION

The /UNDERLINE_CHARACTER qualifier allows you to specify the
character to be used for normal (overprint) underlining of flagged text. The
character may be expressed as a quoted character or as an octal, decimal, or
hexadecimal value. The default underlining character is the underscore (_).
The /NOUNDERLINE qualifier allows you to disable all underlining. If
this qualifier is used, the DSR command, .ENABLE UNDERLINING, has no
effect.
Notes
1

Do not use this qualifier with /SEPARATE-UNDERLINE.

2 You may also use the /BACKSPACE qualifier to specify how underlining
is accomplished.

EXAMPLES
$ RUNOFF DOCFILE/UNDERLINE_CHARACTER="."
$ RUNOFF DOC.DAT/NOUNDERLINE

4-25

RUNOFF Command Qualifiers
/VARIANT=string

/VARIANT=string
DESCRIPTION The /VARIANT qualifier controls the execution of the conditional commands
(.IF, .IFNOT, .ELSE, .ENDIF) by specifying the names of the segments to be
processed. (See Section 2 for descriptions of the conditional commands.) If
you specify multiple names in a string, you must separate them by commas
and enclose the string in quotation marks.
All variant names must be alphanumeric and must begin with a letter; the
maximum length of a variant name is 15 characters. You can specify a total
of 20 different variants.

EXAMPLES
$ RUNOFF LASTFILE/VARIANT=A
$ RUNOFF TEST.TMP/VARIANT=BETA
$ RUNOFF T4.2/VARIANT="A,B,C"

4-26

The DSR Table of Contents Utility

The DSR Table of Contents Utility produces tables of contents for documents
created with DSR. The input file for the Table of Contents Utility can be
either a BRN file (from Version 3 of DSR) or a BTC file (produced by previous
versions of DSR). The output from the Table of Contents Utility is an RNT
file that can be processed with the RUNOFF command to produce a formatted
table of contents.
This section is organized in the following manner:

5.1

•

Features of the DSR Table of Contents Utility

•

Producing a Table of Contents

•

RUNOFF/CONTENTS Command Qualifiers

•

RUNOFF/CONTENTS Command Line Examples

Features of the Table of Contents Utility
The DSR Table of Contents Utility provides a variety of features for
formatting tables of contents. Some of these features are:

5.2

•

Control of the display of bolding and underlining for header titles

•

Control of the format of page numbers

•

Control of the levels of page number references displayed

•

Control of the display of section numbers

Producing a Table of Contents
The DSR Table of Contents Utility creates a formatted table-of-contents
file from the chapter, section, and appendix titles specified by .CHAPTER,
.APPENDIX, .HEADER LEVEL, and .SEND TOC commands in your RNO
file.
Use the following steps to produce a table of contents:
1

Process the RNO file with RUNOFF/INTERMEDIATE to produce an
intermediate binary file (BRN).

2 Process the resulting BRN file with RUNOFF/CONTENTS to produce an
RNT file.

3 Process the RNT file with RUNOFF in one of the following ways:
•

Process the RNT file with the RUNOFF command to produce a MEC
file that contains the formatted table of contents.

•

Include the RNT file in a master file that uses .REQUIRE commands to
include all parts of your document. When you process the master file
with the RUNOFF command, the formatted table of contents will be
placed in the MEM file where you "require"' it.

5-1

The DSR Table of Contents Utility

4 Use the DCL PRINT command on either the MEC or MEM file to get a
copy of your table of contents.
These steps are described more fully in the following sections.

5.2.1

Process the RNO file with RUNOFF/INTERMEDIATE
Process the RNO file with RUNOFF/INTERMEDIATE to produce
an intermediate binary file that has a default type of BRN. The
following command line generates two output files: MANUAL.MEM
and MANUAL.BRN.
$ RUNOFF/INTERMEDIATE MANUAL.RNO

You can process the RNO file using the /NOOUTPUT qualifier, along with
the /INTERMEDIATE qualifier. The /NOOUTPUT qualifier suppresses the
MEM file and saves processing time. The following command line generates
only a BRN file:
$ RUN OFF/1NTERMEDIATE/N0OUTPUT MANUAL.RNO

5.2.2

Process the BRN file with the Table of Contents Utility
The RUNOFF/CONTENTS command, which invokes the DSR Table
of Contents Utility, follows the same format as other VAX/VMS DCL
commands:
$ RUNOFF/CONTENTS[/qualifiers...] file-spec [....]
or
$ RUNOFF/CONTENTS [/qualifiers...] file-spec[+...]

[/qualifiers...]
[/qualifiers...]

There can be one or more input files for CONTENTS. For single input files,
the DSR Table of Contents Utility produces an output file having the same
file name as the input file. The output file type is RNT.
If you separate multiple input files with commas, the Table of Contents
Utility produces a separate RNT file for each input file. If you separate
multiple input files with plus signs, the Table of Contents Utility produces a
single RNT file that contains contents information for all of the input files.
The default output file name is the same as the first input file name and the
default file type is RNT.
Processing multiple files with plus signs is the only way to correctly
concatenate BRN files. The DCL APPEND and COPY commands may not
accurately concatenate BRN files.
If you do not specify a file type for the input file, the default types are BRN
(from Version 3 of DSR) and BTC (from previous versions of DSR). The DSR
Table of Contents Utility searches first for a BRN file type and then for a BTC
file. You can process both BRN and BTC files in the same run of the DSR
Table of Contents Utility.
No wildcard characters are supported as input for RUNOFF/CONTENTS.

5-2

The DSR Table of Contents Utility

5.2.3

Process the RNT file with RUNOFF
The RNT file that RUNOFF/CONTENTS produces must be processed with
the RUNOFF command to get a formatted table of contents. There are two
ways of processing the RNT file:

5.3

You can process the RNT file separately. Process the RNT file with
RUNOFF to produce a MEC file. Use the DCL PRINT command to get a
copy of the formatted table of contents.

You can process the table of contents along with the text files that were
used to create the table of contents. Include the RNT file as a "require"
file in a RNO file. The RNT file is usually placed after the title page.
When you process the RNO file, the table of contents will be placed in the
document where you "require" it. (See .REQUIRE in Section 2.) Use the
DCL PRINT command to get a copy of your table of contents.

RUNOFF/CONTENTS Command Qualifiers
The RUNOFF/CONTENTS command qualifiers are used to specify how you
want to format the table of contents. You can use the following qualifiers:
Command Qualifiers

Defaults

/[.NOJBOLD
/DEEPEST—HEADER-n
/[NOJIDENTIFICA TION
/[NOJINDENT
/[NOJLOG
/OUTPUT=file-spec
/PA GE—NUMBERS=(option[,...])
/[NO]REQUIRE=file-spec
/[NOJSECTION—NUMBERS
/[NOJUNDERLINE

/NOBOLD
/DEEPEST—HEADERS
/NOIDENTIFICATION
/NOINDENT
/NOLOG
See text.
/PAGE-NUMBERS-(NORUNNING, LEVELS)
/NOREQUIRE
/SECTION-NUMBERS
/NOUNDERLINE

command
qualifiers

/BOLD
/NOBOLD
Controls the bolding of header titles in the table of contents. Bolding is
often used to emphasize headers within the text; however, bolding and/or
underlining of the same headers within the table of contents may not be
desirable. Both types of emphasis are suppressed in the table of contents by
default, but you have the option of turning them back on with the /BOLD
and /UNDERLINE qualifiers.
The default is /NOBOLD.

/DEEPEST_HEADER=n
Displays header levels up to and including level n.
The default is /DEEPEST_HEADER=6 (all headers displayed).

/IDENTIFICATION
/NOIDENTIFICATION
Reports the current version number of the DSR Table of Contents Utility.
The default is /NOIDENTIFICATION.

5-3

The DSR Table of Contents Utility

/INDENT
/NOINDENT
Controls the indentation of header-level numbers and header-level titles after
level 1.
If you do not use the qualifier or if you specify /NOINDENT all header levels
after header level 1 will be indented the same two spaces.
If you specify /INDENT, each header level after header level 1 will be
indented two spaces beyond the preceding header level.
The default is /NOINDENT.

/LOG
/NOLOG
Controls whether the DSR Table of Contents Utility reports the name of
each BRN and/or BTC input file as it is being processed, after it has been
processed, and the name of each output file that is created.
If there are any errors in processing, the DSR Table of Contents Utility will
send messages to the terminal even if /NOLOG is in effect.
The default is /NOLOG.

/OUTPUT[=file-spec]
/NOOUTPUT
Controls where the DSR Table of Contents Utility sends the output.
If you specify the /OUTPUT qualifier without a file specification or if you
omit the qualifier entirely, the Table of Contents Utility creates a file with the
same file name as the input file. The default output file type is RNT.
You can change the name of the output file by supplying a file specification
for the value file-spec. You can change the directory of the output file by
supplying a file specification with a directory name for the value file-spec.
The /NOOUTPUT qualifier suppresses the creation of an output file. You
can use /NOOUTPUT to check an input file for errors without using system
resources to generate an output file.

/PAGE_NUMBERS=(option[,...])
Controls the display of page number references, and also controls how many
levels of headers have page references listed in the table of contents. The
following example shows the syntax of the qualifier:
$ RUNOFF/CONTENTS/PAGE_NUMBERS=option[,...]

5—4

The DSR Table of Contents Utility

You can choose option words from the following list to specify the type of
formatting you want:
Option

Purpose

NORUNNING

Specifies chapter-oriented page numbers (such as 1-4 or 10-42).
You can specify chapter-oriented numbers for the table of
contents even if you displayed the numbers another way in the
document. NORUNNING is the default.

RUNNING

Specifies running page numbers (such as 4 or 42). Running page
numbers can be specified in the table of contents even if you
displayed the page numbers a different way in the document.

LEVEL=n

Specifies the display of page numbers up to and including header
level n. The default displays page numbers for all six levels of
headers. To turn off page numbers in the table of contents, use
LEVEL=0.

/REQUIRE=file-spec
/NOREQUIRE
Allows you to change the heading on the first page of a table of contents.
The default heading is the word CONTENTS, centered on the page, followed
by one blank line. You can substitute another word as a heading or not have
any heading.
To change the heading, do one of the following:
1

If you do not want any heading, merely specify a null file as the file-spec
for /REQUIRE:
$ RUNOFF/CONTENTS/REQUIRE=nl:

2 If you want to change the heading, create or edit a file that specifies the
heading that you want. Use the file that you create as the file-spec for
/REQUIRE.
When you use the /REQUIRE qualifier, the default heading for the first
page of the contents is not generated. The file that you specify with the
/REQUIRE qualifier must provide the heading. The file can contain DSR
commands that change the format of the first page and the text that you
want to appear at the top of the page. Or the file can contain only DSR
commands to format the first page of the contents. For example, you can put
the command .FIGURE 10 in the file. This command generates 10 blank lines
at the top of the first page of the table of contents. You can use these blank
lines for later pasteup.

/SECTION—NUMBERS
/NOSECTION—NUMBERS
Controls whether the DSR Table of Contents Utility displays section numbers
in the table of contents.
The /SECTION-NUMBERS qualifier displays section numbers for all header
levels in the table of contents. /NOSECTION—NUMBERS suppresses the
display of section numbers for all header levels.
The default is /SECTION-NUMBERS.

5-5

The DSR Table of Contents Utility

/UNDERLINE
/NOUNDERLINE
Controls whether the underlining specified in chapter and header titles in the
input file appears in the table of contents.
If you specify /UNDERLINE, the text flagged for underlining in the body of
the document is underlined in the table of contents.
If you specify /NOUNDERLINE, the text flagged for underlining in the body
of the document is not underlined in the table of contents. Underlining is
often used to emphasize headers within the text. However, underlining
and/or bolding of the same headers within the table of contents may not be
desirable. For this reason, both types of emphasis are suppressed in the table
of contents by default.

5.4

RUNOFF/CONTENTS Command Line Examples
The following examples show three command lines that would format the
same table of contents differently.
Enter the following command line to produce an RNT file with the default
format:
$ RUNOFF/CONTENTS BOOKNAME.BRN

Enter the following command line to produce an RNT file in which each
header level is indented two more than the previous header level. The DSR
Table of Contents Utility searches for a BRN file and uses BOOKNAME.BRN
by default.
$ RUNOFF/CONTENTS/INDENT BOOKNAME

Enter the following command line to produce an RNT file in which the
bolding and underlining used in the chapter titles and header level titles in
the body of the document are used in the table of contents:
$ RUNOFF/CONTENTS/BOLD/UNDERLINE BOOKNAME

5-6

THE DSR INDEXING UTILITY

The DSR Indexing Utility produces indexes for documents created with DSR.
The input file is either a BRN file (from Version 3 of DSR) or a BIX file
(produced by previous versions of DSR). The output from the Indexing Utility
is an RNX file that can be processed with the RUNOFF command to produce
a formatted index.
If you do not know how to design an index, see the University of Chicago
Press A Manual of Style. If you do not know how to enter indexing commands
in an RNO file, see Example 6-1 for a sample input file.
This section is organized in the following manner:
•

Features of the DSR Indexing Utility

•

Producing an Index

•

RUNOFF/INDEX Command Qualifiers

•

RUNOFF/INDEX Command Line Examples

6.1 Features of the DSR Indexing Utility
The DSR Indexing Utility formats an index in the ways described in the
following sections.

6.1.1 Punctuation of Index Entries
The DSR Indexing Utility places a comma between an index entry and the
page reference. For example:
Command qualifiers, 4-10

If a top-level index entry is followed by as index subentry rather than a page
reference, there is no comma after the top-level entry. The comma is placed
after the index subentry to set off the page reference. For example:
Command qualifiers
description, 4-10
examples, 4-12

6.1.2 Case Control of Index Entries
The DSR commands, .XUPPER and .XLOWER, determine the case of index
entries:
•

The .XLOWER command ensures that index entries are printed exactly as
they were in the input file.

•

The .XUPPER command capitalizes the first letter of the first word of each
index entry and lowercases all subsequent text in the index entry. (This is
the default condition.)

6-1

THE DSR INDEXING UTILITY

You should specify .XLOWER at the top of the file you want to index. Then
you can enter the text for the index entries as you want it to appear in the
finished index, rather than using case control flags in index entries.
The following example shows the format of an index entry when .XLOWER
is used:
Input

Index Entry

.XLOWER
.X COMMAND QUALIFIERS

COMMAND QUALIFIERS, 4-10

The following example shows the format of the same index entry when
.XUPPER is used:
Input

Index Entry

.XUPPER
.X COMMAND QUALIFIERS

Command qualifiers, 4-10

The explicit use of the Uppercase flag or the Capitalize flag in a .INDEX (.X)
or .ENTRY (.Y) command (or after the Index flag) can override the .XUPPER
command.

6.1.3

Merging of Index Entries
Index entries merge with other index entries having identical spelling,
spacing, punctuation, and emphasis. The following sections discuss the rules
for merging entries when the entries are different in case and/or emphasis.

6.1.3.1

Case Merging
If .XLOWER is in effect, entries with differing case will not merge and
uppercase characters will sort before lowercase characters. For example:
Input

Index Entries

.XLOWER
.X Command Qualifiers

COMMAND QUALIFIERS, 4-2

.PAGE

Command Qualifiers, 4-1

.X COMMAND QUALIFIERS
If .XUPPER is in effect, the DSR Indexing Utility merges entries that are
identical in every way except for case. The .XUPPER command causes the
first word of the index entry to be uppercase and all subsequent text to be
lowercase. For example:
Input

Index Entry

.XUPPER
.X Command Qualifiers
.PAGE
.X COMMAND QUALIFIERS

6-2

Command qualifiers, 4-1, 4-2

THE DSR INDEXING UTILITY

6.1.3.2

Emphasis Merging
Emphasized (bolded and/or underlined) entries merge only with entries
having identical emphasis. Entries with different emphasis sort in the
following order:
Bolded and underlined
Bolded
Underlined
No emphasis

6.1.4

Merging of Page Number References
Page number references merge only if they refer to the same page and have
identical characteristics.
Index entries that refer to the same page but have different emphasis sort in
the following order:
Bolded and underlined
Bolded
Underlined
No emphasis
The Indexing Utility does not merge entries on adjacent pages into a page
range.

6.1.5

Sorting of ENTRY (.Y) Entries
Index entries generated by .Y commands are sorted at the top of each
subindex level. This is done on the assumption that .Y is used to generate
"see" and "see also" information in the index, and that the place for this
information is at the top of each subindex level.

6.2

Producing an Index
Use the following steps to produce an index:
1

Enter indexing commands (.X or .Y) in the RNO file.

2 Process the RNO file with RUNOFF/INTERMEDIATE to generate an
intermediate binary file (BRN).

3 Process the resulting BRN file with RUNOFF/INDEX to generate an RNX
file.

4 Process the RNX file with RUNOFF in one of the following ways:
•

Process the RNX file with RUNOFF to produce a MEX file that contains
a formatted index.

•

Include the RNX file in a master file that uses .REQUIRE commands
to include all parts of your document. When you process the master
file with the RUNOFF command, the formatted index will be placed in
your document where you "require" it.

6-3

6.2.1

Enter Indexing Commands in the RNO File

Example 6-1 shows a sample RNO file that contains .X and .Y index
commands.

Example 6-1

Input File with Indexing Commands

.FLAGS BOLD
.NUMBER CHAPTER 4
.CHAPTER MANIPULATING A CMS LIBRARY
This chapter contains conceptual information about
manipulating a CMS library and its elements.
It describes
how and when to

.HEADER LEVEL 1 CONCURRENT RESERVATIONS AND REPLACEMENTS
.X Concurrent reservation
When creating an element generation, you reserve an element.

A reservation that is in effect for an element at a given
time is called a current reservation.
.X Current reservation

.X Unusual occurrence
.Y Occurrence, unusual >see Unusual occurrence
.PAGE
The following figure shows the structure of a typical
library.
.FIGURE 10
.CENTER;Figure 4-l:##Sample Library
.X Library >example
.X Library >structure
.PAGE
.HEADER LEVEL 1 UNUSUAL OCCURRENCES
.X Unusual occurrence > definition
An unusual occurrence results from the execution of a CMS
command that iftay be necessary or helpful in some cases, but
that might havfe undesirable consequences. The following
actions cause an unusual occurrence:
.X Unusual occurrence > cause

6-4

THE DSR INDEXING UTILITY

Example 6-2 shows the index that these entries create.

Example 6-2

Sample Index
Page Index-1
INDEX

6.2.2

Concurrent reservation, 4-1
Current reservation, 4-1

Occurrence, unusual
see unusual occurrence

Library
example, 4-2
structure, 4-2

Unusual occurrence, 4-1
cause, 4-3
definition, 4-3

Process the RNO file with RUNOFF/INTERMEDIATE
Process the RNO file with RUNOFF/INTERMEDIATE to produce an
intermediate binary file that has a default type of BRN. The following
command line generates two output files: USERGUIDE.MEM and
USERGUIDE.BRN.
$

RUNOFF/INTERMEDIATE USERGUIDE.RNO

You can process the RNO file using the /NOOUTPUT qualifier, along with
the /INTERMEDIATE qualifier. The /NOOUTPUT command suppresses the
MEM file and saves processing time. The following command line generates
only a BRN file:
$

RUNOFF/INTERMEDIATE/NOOUTPUT USERGUIDE.RNO

Use the BRN file as input for the Indexing Utility.

6.2.3

Process the BRN file with the Indexing Utility
The RUNOFF/INDEX command, which invokes the DSR Indexing Utility,
follows the same format as other VAX/VMS DCL commands:
$ RUNOFF/INDEX[/qualifiers...] file-spec[,...]
or
$ RUNOFF/INDEX[/qualifiers...] file-spec[+...]

[/qualifiers...]
[/qualifiers...]

There can be one or more input files for INDEX. For single input files, the
DSR Indexing Utility produces an output file having the same file name as
the input file. The output file type is RNX.
If you separate multiple input files with commas, the Indexing Utility
produces a separate RNX file for each input file. If you separate multiple
input files with plus signs, the Indexing Utility produces a single RNX file that
contains indexing information for all of the input files. The default output file
name is the same as the first input file name and the default file type is RNX.
Processing multiple files with plus signs is the only way to concatenate BRN
files correctly. The DCL APPEND and COPY commands may not accurately
concatenate BRN files.

6-5

THE DSR INDEXING UTILITY

If you do not specify a file type for the input file, the default types are BRN
(from Version 3 of DSR) and BIX (from previous versions of DSR). The DSR
Indexing Utility searches first for a BRN file type and then for a BIX file. You
can process both BRN and BIX files in the same run of the DSR Indexing
Utility.
No wildcard characters are supported as input for RUNOFF/INDEX.

6.2.4

Process the RNX file with RUNOFF
The RNX file that RUNOFF/INDEX produces must be processed with
RUNOFF to get a formatted index. There are two ways of processing the
RNX file:
1

You can process the index separately. Process the RNX file with RUNOFF
to generate a MEX file. Then print a copy of the MEX file using the DCL
command PRINT.

2 You can process the index along with the text files that were used to create
the index. Insert the RNX file as a "require" file in your RNO file. The
RNX file is usually placed at the end of the require file. When the RNO
file is processed with RUNOFF, the index will be placed at the end of the
MEM file. Use the DCL command PRINT to obtain a copy.

6.3

RUNOFF/INDEX Command Qualifiers
This section describes the RUNOFF/INDEX command qualifiers that are used
to produce an index. These qualifiers are listed in alphabetical order.

Command Qualifiers
/[NOJIDENTIFICA TION
/UNES-PER-PA GE=n
/[NOJLOG
/OUTPUT[=file-spec]
/PA GE—NUMBERS=option
/[NO]REQUIRE=file-spec
/[NO]RESERVE=n
command
qualifiers

Defaults
/NOIDENTIFICA TION
/LINES—PER—PA GE=55
/NOLOG
See text.
/PA GE—NUMBERS=NORUNNING
/NOREQUIRE
/NORESERVE

/IDENTIFICATION
/NOIDENTIFICATION
Controls whether the DSR Indexing Utility identifies itself by reporting
its current version number during processing. The default is
/NOIDENTIFICATION.

/LINES_PER_PAGE=n
The value n specifies the number of lines of index entries on each page. The
default is 55 lines of index entries. This number does not include the number
of lines required for running heads and feet.

6—6

THE DSR INDEXING UTILITY

The default of 55 lines of index entries is designed to work properly in the
default formatting environment for DSR. You must calculate and specify a
different value for n in any of the following cases:
1

Subtitles are in use in the document that requires the RNX file.
Normally three lines are reserved at the top of each page as the runninghead area for DSR. The title appears flush left on the first line, the page
number is flush right on the first line, and the title line is followed by
two blank lines. However, if you issue the .SUBTITLE command, the
running-head area expands to four lines.
To adjust the /LINES_PER_PAGE for INDEX, use the formula that
follows these three cases.

2 The page length in effect is anything other than 58 lines per page.
If you change the page-length value (the first parameter of the .PAGE
SIZE command) from the default value of 58, you must adjust the
/LINES_PER_PAGE value to conform to the new page size.

3 Any layout other than zero is being used.
The three alternate layouts, specified by the commands .LAYOUT 1,
.LAYOUT 2, and .LAYOUT 3, require a second parameter that specifies
how many lines to reserve at the bottom of each page. You must take
these lines into account when you calculate /LINES_PER_PAGE for
INDEX. Frequently users wish to provide 3 blank lines between the last
line of text and the page number. /LINES_PER_PAGE=52 would be used
with a .L01,3, .L02,3, or .L03,3.
To calculate the correct value for /LINES_PER_PAGE, follow this formula:
/LINES_PER_PAGE=n
n

= .PAGE SIZE (the first parameter is length value)
minus

4 if subtitles are used. 3 if no subtitles

minus

the number of lines reserved for .L01..L02,
or .L03

/LOG
/NOLOG
Controls whether INDEX reports the file specification of each input file as it
is being processed and after it is processed, and the name of the generated
output file.
The default is /NOLOG.

/OUTPUT[=file-spec]
NOOUTPUT
Controls where the DSR Indexing Utility sends the output.
If you specify the /OUTPUT qualifier without a file specification, or if you
omit the qualifier entirely, the output file name is the same as the input file
name. The default file type is RNX.
You can change the name or the directory of the output file by supplying a
file specification for the value file-spec.
The /NOOUTPUT qualifier suppresses the creation of an output file. You
can use /NOOUTPUT to check an input file for errors without using system
resources to generate an output file.

6-7

THE DSR INDEXING UTILITY

/PAG E_N U M B ERS=option
/NOPAGE_NUMBERS
Controls whether the page number references in the index are running page
numbers or chapter-oriented page numbers.
To specify the type of page numbers you want, select from the following
options:
Option

Purpose

NORUNNING

Specifies chapter-oriented page numbers (such as 1-2, 1-3).
You can specify chapter-oriented numbers for the index even if
you did not display the page numbers that way in the body of
the document. NORUNNING is the default.

RUNNING

Specifies running page numbers (such as 2, 3). You can
specify running page numbers for the index even if you did
not display the page numbers that way in the body of the
document.

Use the /NOPAGE_NUMBERS to turn off the display of page numbers.
The default is /PAGE_NUMBERS=NORUNNING.

/REQUIRE=file-spec
/NOREQUIRE
Allows you to change the heading on the first page of an index. The default
heading is the word INDEX, centered on the page, followed by three blank
lines. You can substitute a preface or a foreword to explain how to interpret
special formatting of the index (for example, how the entries are sorted or
why certain references are bolded).
To change the heading, do the following:
1

Create or edit a file that specifies the format and the text that you want to
use as the heading on the first index page.

2 Use the file you create as the file-spec for /REQUIRE.
When you use the /REQUIRE qualifier, the default heading for the first
page of the index is not generated. The file that you are "requiring" must
provide the heading. The file can contain both DSR commands that change
the format of the first page and the text that you want to appear at the top
of the page. Or the file can contain only DSR commands to format the first
page of the index. For example, you can put the command .FIGURE 10 in the
file. This command generates 10 blank lines at the top of the first page of the
index. You can use these blank lines for later pasteup.
If you are adding lines of text or blank space to the heading on the first page
of the index, you must provide space for this addition. Use the /RESERVE=n
qualifier to provide the space you need. See /RESERVE for more information.
The default is /NOREQUIRE.

/RESERVED
/NORESERVE
Allows you to reserve space at the top of the first page of the index for text or
blank space that you want to include with the /REQUIRE=file-spec qualifier.
Determine how many lines of text or blank space you want to add to the top
of the first page of the index, and use this number as the value n.
The default is /NORESERVE.

6-8

THE DSR INDEXING UTILITY

6.4

RUNOFF/INDEX Command Line Examples
The following examples show how to use the DSR Indexing Utility to
produce draft or finished indexes. Enter the following command line to
produce an RNX file with the default index format:
$ RUNOFF/INDEX BOOKNAME.BRN

Enter the following command line to produce an RNX file with 52 lines
of index entries per page rather than the default of 55 lines per page. The
/LINES_PER_PAGE=52 qualifier has to be used because .LAYOUT 1,3 was
specified.
$ RUN0FF/INDEX/LINES_PER_PAGE=52 BOOKNAME

Enter the following command line to change the default heading on the first
page of the index:
$ RUN OFF/1NDEX/RESERVE=10/REQUIRE=INDEX_HEADER BOOKNAME

6-9

DSR Commands Organized By Function

This appendix contains a list of DSR commands grouped according to
function. These commands are described in Section 2, where they are listed
alphabetically. The flags are described in Section 3.

A.1

Page-Formatting Commands
Page formatting commands allow you to control the following items:

A.1.1

•

The size of the text area relative to the size of the paper on which it is
printed

•

The appearance and format of running heads

•

The appearance and format of page numbering

•

Optional subpaging

Page Size and Running Heads
These commands allow you to control page size and running-head formats:
.AUTOSUBTITLE and .NO AUTOSUBTITLE
.DATE and .NO DATE
.FIRST TITLE
.HEADERS ON and .NO HEADERS
.HEADERS UPPER, .HEADERS LOWER, and .HEADERS MIXED
.LAYOUT
.PAGE SIZE
.SUBTITLE and .NO SUBTITLE
.TITLE

A.1.2

Paging and Page-Number Control
These commands allow you to control page numbering format:
.DISPLAY NUMBER
.NUMBER PAGE and .NO NUMBER
.NUMBER RUNNING
.PAGING and .NO PAGING

A. 1.3

Subpaging
These commands allow you to control subpaging format:
.DISPLAY SUBPAGE
.NUMBER SUBPAGE
.SUBPAGE and .END SUBPAGE

A—1

DSR Commands Organized By Function

A.2

Text-Formatting Commands
Text-formatting commands allow you to control the following items:

A.2.1

•

Margin settings

•

The amount of spacing between lines of text

•

Filling and justification of text

•

Indent and tab stop settings

•

Paragraph formation

•

The appearance of figures, lists, notes, and footnotes

•

Text emphasis (for example, bolding or underlining)

Margin Setting
These commands allow you to control the margin settings:
.LEFT MARGIN
.RIGHT MARGIN

A.2.2

Filling and Justifying
These commands allow you to control filling and justifying:
.AUTOJUSTIFY and .NO AUTOJUSTIFY
.FILL and .NO FILL
JUSTIFY and .NO JUSTIFY

A.2.3

Vertical Spacing
These commands allow you to control the amount of spacing between lines
of text, and paging:
.BLANK
.BREAK
.KEEP and .NO KEEP
.SKIP
.SPACING
.PAGE
.TEST PAGE

A.2.4

Horizontal Spacing
These commands allow you to control the spacing and positioning of text:
.CENTER
.INDENT
.PERIOD and .NO PERIOD
.RIGHT
.TAB STOPS

A—2

DSR Commands Organized By Function

A.2.5

Paragraph Formatting
These commands allow you to control the format of paragraphs:
.AUTOPARAGRAPH and .NO AUTOPARAGRAPH
.AUTOTABLE and .NO AUTOTABLE
.PARAGRAPH
.SET PARAGRAPH

A.2.6

Text Emphasis
These commands allow you to control the appearance of text emphasis (such
as bolding or underlining):
.ENABLE BAR, .DISABLE BAR, .BEGIN BAR, and .END BAR
.ENABLE BOLDING and .DISABLE BOLDING
.ENABLE HYPHENATION and .DISABLE HYPHENATION
.ENABLE OVERSTRIKING and .DISABLE OVERSTRIKING
.ENABLE UNDERLINING and .DISABLE UNDERLINING

A.2.7

Figures
These commands allow you to control the format of figures:
.FIGURE DEFERRED and .FIGURE
.LITERAL and .END LITERAL

A.2.8

Lists
These commands allow you to control the appearance and format of lists:
.DISPLAY ELEMENTS
.LIST and .END LIST
.LIST ELEMENT
.NUMBER LIST

A.2.9

Notes and Footnotes
These commands allow you to insert notes and footnotes:
.FOOTNOTE and .END FOOTNOTE
.NOTE and .END NOTE

A.3

Section-Formatting Commands
Section formatting commands allow you to divide your document into
chapters or sections and to include tables of contents, appendixes, and
indexes.

A—3

DSR Commands Organized By Function

A.3.1

Appendixes and Chapters
These commands allow you to control the appearance and format of
appendixes and chapters:
.APPENDIX
.CHAPTER
.DISPLAY APPENDIX
.DISPLAY CHAPTER
.NUMBER APPENDIX
.NUMBER CHAPTER

A.3.2

Sections
These commands allow you to control the appearance and format of sections:
.DISPLAY LEVELS
.HEADER LEVEL
.NUMBER LEVEL
.SET LEVEL
.STYLE HEADERS

A.3.3

Indexes
These commands allow you to control the appearance of indexes and index
entries:
.ENABLE INDEXING and .DISABLE INDEXING
.ENTRY
.FLAGS INDEX and .NO FLAGS INDEX
.FLAGS SUBINDEX and .NO FLAGS SUBINDEX
.INDEX
.XLOWER and .XUPPER

A.3.4

Tables of Contents
These commands allow you to control the appearance of tables of contents
and table-of-contents entries:
.ENABLE TOC and .DISABLE TOC
.SEND TOC

A—4

DSR Commands Organized By Function

A.4

Flag-Recognition Commands
Flag recognition commands enable or disable DSR's recognition of flag
characters as flags rather than as text. (See Section 3).
.FLAGS ACCEPT and .NO FLAGS ACCEPT
.FLAGS ALL and .NO FLAGS ALL
.FLAGS BOLD and .NO FLAGS BOLD
.FLAGS BREAK and .NO FLAGS BREAK
.FLAGS CAPITALIZE and .NO FLAGS CAPITALIZE
.FLAGS COMMENT and .NO FLAGS COMMENT
.FLAGS HYPHENATE and .NO FLAGS HYPHENATE
.FLAGS LOWERCASE and .NO FLAGS LOWERCASE
.FLAGS OVERSTRIKE and .NO FLAGS OVERSTRIKE
.FLAGS PERIOD and .NO FLAGS PERIOD
.FLAGS SPACE and .NO FLAGS SPACE
.FLAGS SUBSTITUTE and .NO FLAGS SUBSTITUTE
.FLAGS UNDERLINE and .NO FLAGS UNDERLINE
.FLAGS UPPERCASE and .NO FLAGS UPPERCASE

A.5

Miscellaneous Commands
These commands allow you to do various things, such as inserting a date and
time, repeating characters, and including other files.
.CONTROL CHARACTERS and .NO CONTROL CHARACTERS
.IF, .IFNOT, .ELSE, and .ENDIF
.NO SPACE
.REPEAT
.REQUIRE
.SET DATE and .SET TIME
.VARIABLE

A—5

Requirements for Printing LIUI Files On an
LN01 Laser Printer
This appendix is for system managers. The following sections describe
the requirements for printing an LNI file (produced with the RUNOFF
/DEVICE=LN01[E] command) on an LN01 or LN01E Laser Printer.
To ensure that LNI files produced with DSR default settings are printed with
the proper spacing and emphasis of characters, the system manager must do
the following things:
1

Install an LN01 font kit with a character set that is appropriately sized and
that has the proper emphasis characters

2 Put the modules that contain DSR font definitions in the device control
library.

3 Use the command SET PRINTER/NOTRUNCATE so that the printer
driver does not truncate long lines of text. Some lines of text in the DSR
LNI file contain complex escape sequences that make them longer than
the buffer size of the device.

4 Initialize the LN01 queue with /NOFEED so that the print symbiont and
the printer driver don't insert unwanted form feeds.

5 Define a form to use with the DCL PRINT /FORM= command when
printing LNI files on an LN01[E]. The following is a sample form
definition:
$ DEFINE / FORM DSR$LN01 2 /MARGIN=B0TT0M=0 /NOWRAP /NOTRUNCATE $_ /STOCK=DEFAULT /DESCRIPTI0N="DSR/LN01 form definition"

The following sections describe items 1 and 2, font kits and font definitions.
For more information on items 3-5, see Section 1.5, Printing DSR Output
Files, and the system documentation on these DCL commands and command
qualifiers.

B.1

LIM01 Font Kits for LNI Files
There are two factors that determine whether an LN01 font kit is suitable for
printing LNI files:
Size of the characters
Special emphasis characters
DSR is designed to format files with fixed-width characters. The default
margin settings and page-size dimensions for DSR are calculated for character
sets that have 10 characters to an inch.
Any LN01 font kits with fixed-width characters that are 30 pixels wide
(10 characters to an inch) should print LNI files with the spacing normally
expected in DSR output files.

B-1

Requirements for Printing LNI Files On an LN01 Laser Printer

The RUNOFF/DEVICE=LN01[E] command allows the user to specify
emphasis for characters in an LNI file. To provide for all the options that
RUNOFF/DEVICE=LN01[E] allows, an LN01 font kit used for printing LNI
files must have characters of the following types:
Text
Bold
Italic
Bold italic
Any LN01 font kits that have a character set of the proper size and that have
fonts for the types of emphasis that DSR supports can be used to print LNI
files. The Courier (10 pitch) font kit is used in the examples in this appendix.

B.1.1

Directory Listing of Font Files
The appropriate font kit must be installed on the system. The LN01 Font Kit
Installation Guide has complete information on installing font kits.
When you install a font kit, you create a directory named LN01$ROOT:[DOC]
that has font files in it. Example B-l shows the LN01 listing for the Courier
(10 pitch) character set.

Example B-1

Directory Listing for Courier (10 pitch)

LNOIIROOT: [FNT. 96] 961001. SIX; 1
002782L10F010001C
landscape fixed
COURIER 10
BASIC ASCII (GL)

5.769 lines/in
10.000 chars/in
10 point
13062 bytes

LNOIIROOT:[FNT.96]961002.SIX;1
002782L10F010002C
landscape fixed
COURIER 10
MULTINATIONAL (GR)

5.769 lines/in
10 point

LNOIIROOT:[FNT.96]961011.SIX;1
002782P10F010001C
portrait fixed
COURIER 10
BASIC ASCII (GL)

5.769 lines/in
10.000 chars/in
10 point
10896 bytes

LNOIIROOT:[FNT.96]961012.SIX;1
002782P10F010002C
portrait fixed
COURIER 10
MULTINATIONAL (GR)

5.769 lines/in
10 point

LNOIIROOT:[FNT.96]961021.SIX;1
002791L10F010001C
landscape fixed
5.769 lines/in
COURIER BOLD 10
BASIC ASCII (GL)
10 point

10.000 chars/in
12958 bytes

10.000 chars/in
12420 bytes
10.000 chars/in
13516 bytes

LNOIIROOT:[FNT.96]961022.SIX;1
002791L10F010002C
landscape fixed
6.769 lines/in
10.000 chars/in
COURIER BOLD 10
MULTINATIONAL (GR)
10 point
13712 bytes
LNOIIROOT:[FNT.96]961031.SIX;1
002791P10F010001C
portrait fixed
6.769 lines/in
COURIER BOLD 10
BASIC ASCII (GL)
10 point

10.000 chars/in
10888 bytes

LNOIIROOT:[FNT.96]961032.SIX;1
002791P10F010002C
portrait fixed
5.769 lines/in
10.000 chars/in
COURIER BOLD 10
MULTINATIONAL (GR)
10 point
12566 bytes
LNOIIROOT:[FNT.96]961041.SIX;1
002810L10F010001C
landscape fixed
COURIER IT 10
BASIC ASCII (GL)

5.769 lines/in
10 point

LNOIIROOT:[FNT.96]961042.SIX;1
002810L10F010002C
landscape fixed
5.769 lines/in
COURIER IT 10
MULTINATIONAL (GR)
10 point

10.000 chars/in
13522 bytes
10.000 chars/in
13396 bytes

(Continued on next page)

B—2

Requirements for Printing LNI Files On an LN01 Laser Printer

Example B-1

(Cont.)

Directory Listing for Courier (10 pitch)

LN01$ROOT:[FNT.96]961061.SIX;1
002810P10F010001C
portrait fixed
COURIER IT 10
BASIC ASCII (GL)

6.769 lines/in
10 point

LN01$R00T:[FNT.96]961062.SIX;1
002810P10F010002C
portrait fixed
6.769 lines/in
COURIER IT 10
MULTINATIONAL (GR)
10 point

10.000 chars/in
11030 bytes
10.000 chars/in
12642 bytes

LNOIIROOT:[FNT.96]961061.SIX;1
002811L10F010001C
landscape fixed
6.769 lines/in
10.000 chars/in
COURIER BD IT 10
BASIC ASCII (GL)
10 point
13630 bytes
LN01$ROOT:[FNT.96]961062.SIX;1
002811L10F010002C
landscape fixed
6.769 lines/in
10.000 chars/in
COURIER BD IT 10
MULTINATIONAL (GR)
10 point
13630 bytes
LNOIIROOT:[FNT.96]961071.SIX;1
002811P10F010001C
portrait fixed
6.769 lines/in
10.000 chars/in
COURIER BD IT 10
BASIC ASCII (GL)
10 point
11212 bytes
LN01$ROOT:[FNT.96]961072.SIX;1
002811P10F010002C
portrait fixed
6.769 lines/in
10.000 chars/in
COURIER BD IT 10
MULTINATIONAL (GR)
10 point
12790 bytes

Notice that there are two character sets listed in Example B-1, (GL) and (GR).
The font files identified as BASIC ASCII (GL) are the files that you should
use when you load the DSR font definitions in the device control library.
The (GL) character set consists of the standard ASCII character set. The (GR)
character set is a supplemental set that has the multinational characters that
are supported on 8-bit terminals. If you need to provide font definitions for
the full multinational character set, see the LN01 Font Utility User's Guide for
instructions on combining two character sets.
When you create the DSR font definition modules in the device control
library, you will need to use the internal font name that is in the LN01 listing.
The internal font name is printed in boldface in the following example:
LNOllROOT:[FNT.96]961001.SIX;1
002782L10F010001C
landscape fixed
COURIER 10
BASIC ASCII (GL)

6.769 lines/in
10.000 chars/in
10 point
13062 bytes

Internal font names are case sensitive. When you use the internal font name,
you must enter it exactly as it appears in the LN01 listing.

B—3

Requirements for Printing LNI Files On an LN01 Laser Printer

B.2

DSR Font Definitions for LNI Files
DSR font definition modules in the device control library allow you to specify
the character set that will be used to print LNI files. The print symbiont
looks in the device control library for the modules that DSR specifies before
printing an LNI file. DSR may specify any of the definition modules listed in
Example B-2.

Example B-2

DSR Modules in the Device Control Library

These modules should contain the LN01 escape sequences that do the
following:
DSRIFONT.LOAD (Initiate loading of fonts)
ST (Designate the end of a string of characters)
DSR$PAGE_SIZE (Override the default LN01 setting)
Module names for standard fonts:
DSRIFONT.TP
DSR$FONT_BP
DSR$FONT_IP
DSR$FONT_BIP
DSRIFONT.TL
DSRtFONT.BL
DSRIFONT.IL
DSR$FONT_BIL

Portrait text font
Portrait bold font
Portrait italic font
Portrait bold italic font
Landscape text font
Landscape bold font
Landscape italic font
Landscape bold italic font

Module names for European sized fonts:
DSRtFONT.TPE
DSRfFONTJBPE
DSRtFONT.IPE
DSR$FONT_BIPE
DSR$FONT_TLE
DSR$FONT_BLE
DSR$FONT_ILE
DSR$FONT_BILE

Portrait text font
Portrait bold font
Portrait italic font
Portrait bold italic font
Landscape text font
Landscape bold font
Landscape italic font
Landscape bold italic font

Module names for escape sequences that define standard fonts:
DSR$FONT_DEFINE_TP
DSR$FONT_DEFINE_BP
DSR$FONT_DEFINE_IP
DSR$FONT_DEFINE_BIP
DSR$FONT_DEFINE_TL
D S R$F 0 NT_DEFINE_BL
DSR$FONT_DEFINE_IL
DSR$FONT_DEFINE_BIL

Portrait text font
Portrait bold font
Portrait italic font
Portrait bold italic font
Landscape text font
Landscape bold font
Landscape italic font
Landscape bold italic font

Module names for escape sequences that define European fonts:
DSR$FONT_DEFINE_TPE
DSR$FONT_DEFINE_BPE
DSR$FONT_DEFINE_IPE
DSR$FONT_DEFINE JBIPE
DSR$FONT_DEFINE_TLE
DSR#FONT_DEFINE_BLE
DSR$FONT_DEFINE_ILE
DSR$FONT_DEFINE_BILE

Portrait text font
Portrait bold font
Portrait italic font
Portrait bold italic font
Landscape text font
Landscape bold font
Landscape italic font
Landscape bold italic font

The following section explains how to load the modules that DSR may require
into the device control library.

B—4

Requirements for Printing LNI Files On an LN01 Laser Printer

B.2.1

Loading DSR Font Definitions into the Device Control Library
Use the VAX/VMS Librarian Utility to load the modules that DSR may
require into the device control library. You can use the Librarian Utility at
DCL level or you can create a command procedure to load the modules.
Example B-3 shows a sample command procedure that loads DSR modules
for standard portrait fonts for Courier (10 pitch).

Example B-3

Command Procedure for Loading Font Definitions

This sample command file adds a set of four fonts to the VMS V4
system device control library, SYS$LIBRARY:SYSDEVCTL.TLB, for use
with DSR. This sample file shows how to load standard portrait
fonts.

if
if
if
if

pl.eqs.""
p2.eqs.""
p3.eqs.""
p4.eqs.""

then
then
then
then

inquire/nopunc
inquire/nopunc
inquire/nopunc
inquire/nopunc

if
if
if
if

f$loc(".six",pi).eqs.f$len(pl)
f$loc(".six",p2).eqs.f$len(p2)
f$loc(".six",p3).eqs.f$len(p3)
f$loc(".six",p4).eqs.f$len(p4)

pi
p2
p3
p4

"Text font?"
"Bold font?"
"Italic font?"
"Bold italic font?"

then
then
then
then

pl
p2
p3
p4

:=
:=
:=
:=

'pi' .six
1p2' .six
'P3' . six
'p4' .six

Insert sixel files into library
lib/rep/text/log
lib/rep/text/log
lib/rep/text/log
lib/rep/text/log

sysllibrary:sysdevctl
sys$library:sysdevctl
sys$library:sysdevctl
sys$library:sysdevctl

'pi'/mod=dsr$font_tp
'p2'/mod=dsr$font_bp
'p3'/mod=dsr$font_ip
'p4'/mod=dsr$font.bip

!
type sys$input:
You will now be prompted to enter the internal names
of the font files inserted in the library. These names
can be found in the file FKnnm.DOC that comes with DIGITALsupplied font kits, or by using the LN01 Font Utility.
The internal names are case sensitive. You must enter the
names exactly as they appear in the directory listing.
! Text portrait
inquire/nopunc fontname "Internal font name of TEXT font?"
open/write tmp tmp.tmp
write tmp "<ESC>P1;12}''fontname'<ESC>\"
! Press the ESC key on the terminal twice to enter the ESC character
clo tmp
lib/rep/text/log sys$library:sysdevctl tmp.tmp/mod=dsr$font_define_tp
!
! Bold
!
if f$8ea("tmp.tmp").nes."" then delete tmp.tmp;
open/write tmp tmp.tmp
inquire/nopunc fontname "Internal font name of BOLD font?"
write tmp "<ESC>P1;13}''fontname'<ESC>\"
clo tmp
lib/rep/text/log sys$library:sysdevctl tmp.tmp/mod=dsr$font_define_bp

(Continued on next page)

B—5

Requirements for Printing LNI Files On an LN01 Laser Printer

Example B-3

(Cont.)

Command Procedure for Loading Font
Definitions

! Italic
!
if f$sea("tmp.tmp").nes."" then delete tmp.tmp;
inquire/nopunc fontname "Internal font name of ITALIC font?"
open/write tmp tmp.tmp
write tmp "<ESC>P1;14}''fontname'<ESC>\"
clo tmp
lib/rep/text/log sys$library:sysdevctl tmp.tmp/mod*dsr$font.deline.ip
!
! Bold Italic
!
if f$sea("tmp.tmp").nes."" then delete tmp.tmp;
inquire/nopunc fontname "Internal font name of BOLD ITALIC font?"
open/write tmp tmp.tmp
write tmp "<ESC>P1;16}"fontname'<ESC>\"
clo tmp
lib/rep/text/log sys$library:sysdevctl tmp.tmp/mod*dsr$font_define_bip
!
! Define Font Load sequence, in module DSR$F0NT_L0AD
!
if f$sea("tmp.tmp").nes."" then delete tmp.tmp;
open/write tmp tmp.tmp
write tmp "<ESC>Pl;iy"
clo tmp
lib/rep/text/log sysllibrary:sysdevctl tmp.tmp/mod*dsr$font.load
! Add String Terminator, module ST
!
if f$sea("tmp.tmp").nes."" then delete
open/write tmp tmp.tmp
write tmp "<ESC>\"
clo tmp
lib/rep/text/log sysllibrary:sysdevctl
if f$sea("tmp.tmp").nes."" then delete
!
open/write tmp tmp.tmp
write tmp "<ESC>[3300t"
clo tmp
lib/rep/text/log sysllibrary:sysdevctl
if f$sea("tmp.tmp").nes."" then delete
exit

tmp.tmp;

tmp.tmp/mod*st
tmp.tmp;

tmp.tmp/mod*dsr$page_size
tmp.tmp;*

The numbers that are associated with font names can be found in the LN01
Font Kit Installation Guide. If you need more information on the LN01 escape
sequences, see the LN01 Programmer Reference Manual.
When an appropriate LN01 font kit is installed on your system and the
required font definition modules are in the device control library, LNI files
should print on the LN01 Laser Printer with the proper spacing and emphasis.

B—6

Index

A
A4 paper *4-9
Abbreviating commands* 1-4
in DSR* 1-1
Accept flag
default* 3-5
description • 3-5
recognizing *2-42
.APPENDIX *2-2
Appendix commands
.APPENDIX *2-2
.DISPLAY APPENDIX*2-16
.NUMBER APPENDIX *2-88
Argument
default* 1-2
definition* 1-2
Arguments
null* 1-4
rules for* 1-3
. AUTOJUSTIFY • 2-3
.AUTOPARAGRAPH • 2-4
example* 2-5
.AUTOSUBTITLE *2-6
.AUTOTABLE *2-7
example* 2-8

B
\*3-13
/BACKSPACE qualifier *4-5
Bar commands
.BEGIN BAR *2-26
.DISABLE BAR *2-26
.ENABLE BAR*2-26
.END BAR *2-26
example* 2-27
.BEGIN BAR*2-26
example* 2-27
8-bit characters *2-14

BIX files*6-6
.BLANK *2-9
Bold flag
default* 3-6
description *3-6
pairing • 3-6
recognizing • 2-43
/BOLD qualifier*4-6, 5-3
Bolding *2-29, 3-6
.BREAK *2-10
Break flag
default *3-7
description • 3-7
recognizing • 2-44
BRN files *5-1, 5-2, 6-6
BTC files *5-1, 5-2

c
Capitalize flag
default *3-8
description *3-8
recognizing *2-45
Case control
Indexing Utility *6-1
Case control flags
Capitalize flag *3-8
Lowercase flag *3-13
Uppercase flag *3-21
.CENTER* 2-11
.CENTRE *2-11
/CHANGE_BARS qualifier • 4-7
.CHAPTER *2-13
Chapter commands
.CHAPTER *2-13
.DISPLAY CHAPTER *2-18
.NUMBER CHAPTER *2-89
Command
defaults* 1-5
RUNOFF/DE VICE=LN01 [E] • B-1
RUNOFF/INDEX *6-5
Command line examples • 5-6, 6-9
Command line qualifiers
See Command qualifiers
Index—1

Index

Command qualifier
/INTERMEDIATE • 6-5
Command qualifiers*5-3
Commands
abbreviating* 1-4
DSR* 1-1
format of • 1-2
multiple* 1-2
parts of • 1-2
separating arguments* 1-3
syntax
DSR* 1-1
terminating* 1-3
Comment flag
default *3-9
description *3-9
pairing *3-9
recognizing • 2-46
Conditional commands
ELSE *2-66
.ENDIF • 2-66
example*2-68, 2-129
.IF *2-66
.IF NOT *2-66
Contents
producing table *5-1
.CONTROL CHARACTERS • 2-14
Control flag
default *3-10
definition* 1-2
description *3-10
recognizing* 2-47

D
.DATE *2-15
$$Date*3-18
$$Day *3-18
/DEBUG qualifier *4-8
DEC multinational character support *2-14
/DEEPEST_HEADER qualifier • 5-3

Default
definition *1-2
DIGITAL Standard Runoff (DSR)* 1-1
.DISABLE BAR*2-26
example* 2-27

Index—2

DISABLE BOLDING *2-29
.DISABLE HYPHENATION *2-30
.DISABLE INDEXING *2-31
.DISABLE OVERSTRIKING *2-32
.DISABLE TOC *2-33
.DISABLE UNDERLINING *2-34
.DISPLAY APPENDIX *2-16
example *2-17
.DISPLAY CHAPTER*2-18
example *2-19
.DISPLAY ELEMENTS *2-20
.DISPLAY LEVELS*2-22
.DISPLAY NUMBER*2-24
.DISPLAY SUBPAGE *2-25
Document formatting* 1-1
/DOWN qualifier *4-12
DSR
command defaults* 1-5
utilities
indexing* 1-1
table of contents* 1-1
DSR (DIGITAL Standard Runoff)* 1-1
DSR command
parts of • 1-2
sample of, • 1-2

E
.ELSE *2-66
Emphasis
text • A-3
Emphasizing index entries *6-3
.ENABLE BAR *2-26
example* 2-27
.ENABLE BOLDING *2-29
.ENABLE HYPHENATION *2-30
.ENABLE INDEXING *2-31
.ENABLE OVERSTRIKING *2-32
.ENABLE TOC *2-33
.ENABLE UNDERLINING *2-34
.END BAR *2-26
example • 2-27
.END FOOTNOTE *2-58
.END LIST*2-79
.END NOTE *2-87
.END SUBPAGE *2-120

Index

.ENDIF • 2-66
.ENTRY • 2-35
ENTRY index entries
merging *6-3
Error
messages
in DSR* 1-1
Error message
examples *4-2, 4-15
Examples of /INTERMEDIATE • 4-14
Examples of display setting
.DISPLAY APPENDIX*2-17
.DISPLAY CHAPTER *2-19
Examples of DSR formatting
.AUTOPARAGRAPH • 2-5
.AUTOTABLE *2-8
bar commands *2-27
BEGIN BAR *2-27
bolding characters*3-6
bolding words *3-6
breaking terms logically • 3-7
conditional commands*2-68, 2-129
.DISABLE BAR *2-27
.ENABLE BAR *2-27
.END BAR *2-27
error message *4-2, 4-15
.FIGURE *2-37
.FIGURE DEFERRED *2-37
header levels *2-62
hyphenating words *3-11
indexing *6-4
KEEP *2-73
.LAYOUT *2-76
.NO KEEP*2-73
.NO SPACE*2-86
overstriking characters*3-14
redefining flag characters • 3-4
.SET LEVEL*2-113
substituting date *3-18
substituting time *3-18
underlining words *3-20
VARIABLE *2-129
Examples of DSR index command
.INDEX *2-70
Examples of DSR justification command
.JUSTIFY *2-72

F
Features
See List of Features
.FIGURE *2-36
example *2-37
.FIGURE DEFERRED *2-36
example *2-37
Figures
formatting • A-3
Files
BIX *6-6
BRN • 5-1, 5-2, 6-6
BTC *5-1, 5-2
LNI • B-1
MEX* 6-6
RNT • 5-2
RNX • 6-6
.FILL *2-39
.FIRST TITLE *2-40
Flag descriptions
Accept flag • 3-5
Bold flag • 3-6
Break flag • 3-7
Capitalize flag • 3-8
Comment flag • 3-9
Control flag *3-10
Hyphenate flag *3-11
Index flag *3-12
Lowercase flag *3-13
Overstrike flag *3-14
Period flag *3-15
Space flag *3-16
Subindex flag *3-17
Substitute flag *3-18
Underline flag *3-19
Uppercase flag • 3-21
Flag recognition commands*3-2, A-5
Flags
enabling *3-3
pairing*3-6, 3-9, 3-13, 3-18, 3-19, 3-21
recognizing *3-2
redefining • 3-3
.FLAGS ACCEPT *2-42
.FLAGS BOLD *2-43

Index—3

Index

.FLAGS BREAK*2-44
FLAGS CAPITALIZE *2-45
.FLAGS COMMENT*2-46
.FLAGS CONTROL*2-47
.FLAGS HYPHENATE *2-48
.FLAGS INDEX *2-49
.FLAGS LOWERCASE *2-50
.FLAGS OVERSTRIKE *2-51
.FLAGS PERIOD*2-52
FLAGS SPACE *2-53
.FLAGS SUBINDEX *2-54
.FLAGS SUBSTITUTE*2-55
FLAGS UNDERLINE *2-56
.FLAGS UPPERCASE *2-57
Font definitions
LNI files *B-4
Font files
loading *B-5
Font kits
LN01 • B-1
Fonts
LN01 *4-10
.FOOTNOTE *2-58
Footnotes
inserting* A-3
/FORM_SIZE qualifier *4-13
Formatting
document* 1-1
text* 1-1

H
.HEADER LEVEL*2-60
Header level commands
DISPLAY LEVELS *2-22
.HEADER LEVEL*2-60
.HEADERS LOWER *2-65
.HEADERS MIXED*2-65
.HEADERS ON *2-63
HEADERS UPPER *2-65
.NO HEADERS *2-63
.NUMBER LEVEL*2-90
.STYLE HEADERS *2-118
.HEADERS LOWER *2-65
.HEADERS MIXED *2-65
.HEADERS ON *2-63

Index—4

.HEADERS UPPER *2-65
Horizontal spacing *A-2
$$Hours*3-18
How to run DSR*4-1
Hyphenate flag
default *3-11
description *3-11
recognizing *2-48

i
/IDENTIFICATION qualifier • 5-3, 6-6
.IF *2-66
.IFNOT • 2-66
.INDENT *2-69
/INDENT qualifier *5-4
.INDEX *2-70
example *2-70
Index
case control of entries *2-132
commands
.DISABLE INDEXING *2-31
.ENABLE INDEXING *2-31
.ENTRY *2-35
.FLAGS INDEX *2-49
.FLAGS SUBINDEX *2-54
.INDEX *2-70
.NO FLAGS INDEX *2-49
NO FLAGS SUBINDEX *2-54
.XLOWER *2-132
.XUPPER*2-132
flags
Index flag *3-12
Subindex flag *3-17
input files*6-5
producing *6-3
Index entries
emphasizing *6-3
merging *6-2
merging ENTRY entries *6-3
merging page number references • 6-3
punctuation of *6-1
Index flag
default *3-12
description *3-12
recognizing* 2-49

Index

/INDEX qualifier*6-3
Indexes *3-12, 3-17
formatting • A-4
Indexing
qualifiers* 6-6
Indexing commands
entering • 6-4
Indexing Utility *6-1
case control *6-1
features* 6-1
punctuation *6-1
/INTERMEDIATE
examples *4-14
/INTERMEDIATE command qualifier*6-5
/INTERMEDIATE qualifier*4-14, 5-2, 6-3

j
Justification
commands
AUTOJUSTIFY • 2-3
.JUSTIFY *2-71
.NO AUTOJUSTIFY *2-3
.NO JUSTIFY *2-71
.JUSTIFY *2-71
example* 2-72

.LIST (corn'd.)
example *2-81, 2-83
List commands
.DISPLAY ELEMENTS *2-20
.END LIST *2-79
.LIST *2-79
.NUMBER LIST*2-91
.LIST ELEMENT *2-82
List of Features
DSR Table of Contents Utility *5-1
Lists
formatting • A-3
.LITERAL *2-84
LN01
LANDSCAPE option *4-9
paper size *4-9
PORTRAIT option *4-9
printing files *4-9
printing requirements*B-1
UNDERLINE option *4-10
LN01 font kits*B-1
LN01 fonts *4-10
LN01 option *4-9
LN01E
paper size *4-9
printing files *4-9
printing requirements*B-1
LN01E option *4-9
LN03
LANDSCAPE option *4-9
PORTRAIT option *4-9

KEEP *2-73
example* 2-73
Keyword
definition *1-2

L
LANDSCAPE option *4-9
.LAYOUT *2-75
example* 2-76
.LEFT MARGIN *2-78
/LINES_PER_PAGE=n qualifier*6-6
.LIST *2-79

LN03 option *4-9
LNI files*B-1
font definitions • B-4
/LOG qualifier*5-4, 6-7
Lowercase flag
default *3-13
description *3-13
pairing *3-13
recognizing • 2-50

M
Margin commands
.INDENT *2-69
.LEFT MARGIN *2-78
PAGE SIZE *2-96

Index—5

Index

Margin commands (cont'd.)
.RIGHT *2-105

.NO AUTOSUBTITLE *2-6
.NO AUTOTABLE *2-7
.NO CONTROL CHARACTERS*2-14

.NO SPACE (cont'd.)
example *2-86
.NO SUBTITLE *2-121
/NOBOLD qualifier *4-6
/NOCHANGE_BARS qualifier*4-7
/NODEBUG qualifier *4-8
/NOINTERMEDIATE qualifier *4-14
/NOLOG qualifier*6-7
/NOOUTPUT qualifier*4-17, 6-7
/NOPAGE—NUMBERS qualifier*6-8
/NOPAUSE qualifier *4-19
/NOREQUIRE qualifier*6-8
/NORESERVE qualifier • 6-8
/NORIGHT qualifier *4-21
/NOSEQUENCE qualifier*4-23
/NOSIMULATE qualifier*4-24
.NOTE *2-87
Notes
inserting • A-3
/NOUNDERLINE qualifier*4-25
Null arguments* 1-4
NUMBER APPENDIX *2-88
NUMBER CHAPTER *2-89

.NO DATE *2-15
.NO FILL*2-39

.NUMBER LEVEL*2-90
NUMBER LIST *2-91

NO FLAGS ACCEPT *2-42
.NO FLAGS BOLD *2-43
.NO FLAGS BREAK *2-44
.NO FLAGS CAPITALIZE *2-45
.NO FLAGS COMMENT *2-46
NO FLAGS CONTROL *2-47

NUMBER PAGE *2-92
.NUMBER RUNNING *2-93
.NUMBER SUBPAGE *2-94

.RIGHT MARGIN *2-106
Margin setting • A-2
/MESSAGES qualifier*4-16
MEX file
generating *6-6
MEX files *6-6
$$Minutes *3-18
Miscellaneous commands *B-5
$$Month*3-18
Multinational characters*2-14
Multiple commands* 1-2

NO AUTOJUSTIFY • 2-3
.NO AUTOPARAGRAPH *2-4

.NO FLAGS HYPHENATE *2-48
NO FLAGS INDEX *2-49
NO FLAGS LOWERCASE *2-50
.NO FLAGS OVERSTRIKE *2-51
.NO FLAGS PERIOD *2-52
.NO FLAGS SPACE *2-53
NO FLAGS SUBINDEX *2-54
NO FLAGS SUBSTITUTE *2-55
NO FLAGS UNDERLINE *2-56
.NO FLAGS UPPERCASE *2-57
NO HEADERS *2-63
NO JUSTIFY *2-71
NO KEEP*2-73
example *2-73
.NO NUMBER*2-92
.NO PAGING *2-98
NO PERIOD*2-101
NO SPACE *2-85

Index—6

o
/OUTPUT qualifier*4-17, 5-4, 6-7
Overstrike flag
default *3-14
description *3-14
recognizing *2-51
Overstriking • 2-32, 3-14

p
.PAGE *2-95
Page formatting commands* A-1
Page number references
merging in index *6-3
Page range *6-3

Index

.PAGE SIZE*2-96
/PAGE_NUMBERS qualifier*5-4
/PAGE_NUMBERS=option qualifier*6-8
/PAGES qualifier *4-18
.PAGING *2-98
Paging commands
.DISPLAY NUMBER *2-24
.LAYOUT *2-75
.NO NUMBER *2-92
.NO PAGING *2-98
NUMBER PAGE *2-92
.NUMBER RUNNING *2-93
PAGE *2-95
PAGE SIZE *2-96
.PAGING *2-98
.TEST PAGE *2-125
Paper size
A4*4-9
default
LNOI *4-9
LN01E*4-9
LN03 • 4-9
European *4-9
.PARAGRAPH *2-99
Paragraph commands
.AUTOPARAGRAPH • 2-4
.AUTOTABLE *2-7
.NO AUTOPARAGRAPH *2-4
.NO AUTOTABLE *2-7
.PARAGRAPH *2-99
.SET PARAGRAPH *2-115
Paragraph formatting • A-3
/PAUSE qualifier *4-19
.PERIOD* 2-101
Period flag
default *3-15
description *3-15
recognizing *2-52
PORTRAIT option *4-9
Punctuation
Indexing Utility *6-1

Qualifier
See Command qualifiers

R
Range of page numbers *6-3
.REPEAT *2-103
.REQUIRE *2-104
/REQUIRE qualifier*5-5, 6-8
/RESERVE=n qualifier*6-8
.RESTORE *2-107
/REVERSE_EMPHASIS qualifier*4-20
.RIGHT *2-105
.RIGHT MARGIN *2-106
/RIGHT qualifier *4-21
RNO
see DSR
RNT files *5-2
producing • 5-3
RNX file
processing *6-6
RNX files *6-6
Rules
abbreviating commands* 1-4
command argument* 1-3
Running DSR
error messages *4-2
file types *4-1
input *4-2, 4-3
output *4-2, 4-3
qualifier rules *4-3
qualifiers *4-4
RUNOFF command *4-1, 4-2
RUNOFF
see DSR
RUNOFF/DE VICE=LN01 [E] • B-1
RUNOFF/DEVICE=LN01 [E] command • 4-9
RUNOFF/DEVICE=LN03 command *4-9
RUNOFF/INDEX command *6-5

s
.SAVE *2-107
$$Seconds*3-18
Section formatting commands* A-3
/SECTION_NUMBERS qualifier • 5-5
.SEND TOC *2-108
Index—7

Index

SEND TOC (cont'd.)
example* 2-109
/SEPARATE-UNDERLINE qualifier • 4-22
Separating command arguments* 1-3
/SEQUENCE qualifier *4-23
.SET DATE • 2-110
.SET LEVEL*2-112
example* 2-113
.SET PARAGRAPH *2-115
.SET TIME *2-110
/SIMULATE qualifier *4-24
.SKIP *2-116
Space flag
default • 3-16
description *3-16
recognizing • 2-53
.SPACING *2-117
Spacing commands
BLANK *2-9
NO PERIOD*2-101
NO SPACE *2-85
.PERIOD* 2-101
.SKIP *2-116
.SPACING *2-117
TAB STOPS *2-123
.STYLE HEADERS *2-118
Subindex flag
default *3-17
description *3-17
recognizing* 2-54
SUBPAGE *2-120
Subpaging commands
.DISPLAY SUBPAGE *2-25
.END SUBPAGE *2-120
.NUMBER SUBPAGE *2-94
SUBPAGE *2-120
Substitute flag
default *3-18
description* 3-18
pairing *3-18
recognizing • 2-55
.SUBTITLE *2-121
Subtitle commands
.AUTOSUBTITLE *2-6
DATE *2-15
.HEADERS ON*2-63
.LAYOUT *2-75
.NO AUTOSUBTITLE *2-6
.NO DATE *2-15

Index—8

Subtitle commands (cont'd.)
.NO HEADERS *2-63
.NO SUBTITLE*2-121
.SUBTITLE *2-121
Symbols
(>>•3-12, 3-17
! • 3-9
( <) • 3-8
.*3-10
% • 3-14
#•3-16
$$•3-18
&*3-19
*•3-6
+ •3-15
= •3-11
"•3-21
_• 3-5
1*3-7
\*3-13

T
.TAB STOPS *2-123
Table of contents
commands
.DISABLE TOC *2-33
.ENABLE TOC *2-33
.SEND TOC *2-108
formatting • A-4
producing* 5-1
Table of Contents Utility
input files*5-1
Terminating commands* 1-3
Terminator
definition* 1-2
.TEST PAGE *2-125
Text emphasis *A-3
Text formatting* 1-1
Text processing* 1-1
Text-formatting commands • A-2
$$Time*3-18
.TITLE *2-127
Title commands
.FIRST TITLE *2-40
.HEADERS ON *2-63
.LAYOUT *2-75

Index

Title commands (cont'd.)
NO HEADERS *2-63

$$Year* 3-18
Underline flag
default • 3-19
description • 3-19
pairing *3-19
recognizing • 2-56
UNDERLINE option *4-10
/UNDERLINE qualifier*5-6
/UNDERLINE-CHARACTER qualifier • 4-25
Underlining *2-34, 3-19
Uppercase flag
default *3-21
description *3-21
pairing *3-21
recognizing *2-57
used with .XUPPER*6-2
Utilities
DSR* 1-1

.VARIABLE* 2-128
example *2-129
variant name
restrictions *4-26
syntax *4-26
/VARIANT qualifier *4-26
Vertical spacing *A-2

x
.XLOWER* 2-132, 6-1
.XUPPER*2-132, 6-1
use of Uppercase flag with *6-2

Index—9

VAX DIGITAL Standard Runoff
(DSR) Reference Manual
Order Number AA-Z301B-TE

READER'S
COMMENTS

Note: This form is for document comments only. DIGITAL will use comments
submitted on this form at the company's discretion. If you require a written reply
and are eligible to receive one under Software Performance Report (SPR) service,
submit your comments on an SPR form.

Did you find this manual understandable, usable, and well organized? Please make suggestions for
improvement.

Did you find errors in this manual? If so, specify the error and the page number.

Please indicate the type of user/reader that you most nearly represent:
□
□
□
□
□
□

Assembly language programmer
Higher-level language programmer
Occasional programmer (experienced)
User with little programming experience
Student programmer
Other (please specify) _

Name _Date_
Organization _
Street _
City _State_Zip Code_
or Country

—

Do-Not Tear - Fold Here and Tape
No Postage
Necessary
if Mailed in the
United States

SDIDDSD
BUSINESS REPLY MAIL
FIRST CLASS PERMIT N0.33 MAYNARD MASS.
POSTAGE WILL BE PAID BY ADDRESSEE

SSG PUBLICATIONS ZK1-3/J35
DIGITAL EQUIPMENT CORPORATION
110 SPIT BROOK ROAD
NASHUA, NEW HAMPSHIRE 03062-2698

Do Not Tear - Fold Here