.left margin .ifnot hlp .HL 1 ENABLE/DISABLE .else hlp .helpc DISABLE .s2 See ENABLE .s .helpc ENABLE .br .endif hlp .if hlp .if RSX .i5;Additional help available: introduction BAR CONTINUE ESCAPE EQUATION FLAGS HYPHENATION INDEXING LEVELS NUMBERING ODD OVERSTRIKING PAGING SUBSTITUTION TABS TOC TRAILING__ZERO UNCONDITIONAL UNDERLINING .j .endif RSX .endif hlp .HELPD INTRODUCTION .entry NO>- See also DISABLE .entry DISABLE>- See also NO .entry FLAGS>- See also ENABLE FLAGS .p These commands enable or disable various actions. .ifnot small Some of the enable commands can be confused with the FLAGS commands, but they .x FLAGS are very different. A FLAGS command turns on recognition of special characters or combinations of characters, but does not affect whether the flag causes the desired action. If recognition of a flag is turned on, then the enable/disable commands can be used to cause the action of the flag to actually occur or not. For example, if you turn on recognition of the overstrike flag with _.FLAGS#OVERSTRIKE, then the flag is also enabled. The flag character, normally a percent sign "#%#", will then cause overstriking and will not appear in the text. If _.DISABLE#OVERSTRIKING command is then issued, the percent sign will still not appear in the text, unless quoted, but no overstriking will occur. See the FLAGS section for further information on the use of flags. .endif small .helpd BAR .q _.ENABLE BAR [n1] [,n2] [,"c"] .qq _.EBB [n1] [,n2] [,"c"] .qn _.DISABLE BAR .qn _.DBB .x DISABLE>BAR .p.x ENABLE>BAR controls the printing of change bars. .ifnot small A change bar is a vertical bar printed in the left margin of a document. It is generally used to denote sections of the document that have been changed since the last printing. Change bars will not actually be printed unless a _.BEGIN BAR command is issued. The _.ENABLE BARS command is normally issued at the beginning of a document. When change bars are enabled, change bars are printed n1 spaces to the right of the left margin and normal text is printed n1+n2 spaces to the right of the left margin. For example, if n1 is 4 and n2 is 3, text will be indented by 7 and change bars will appear to the left of the text with two spaces in between. The default values for n1 and n2 are 0 and 3. The character printed in the change bar position can be changed by specifying the literal "c". If a null literal "" is used, the character reverts to the default. .i5;(n1,n2, and "c" are not supported in DSR) .endif small .i5;DEFAULT: _.DISABLE BAR .helpd COMMAND .bb .q _.ENABLE COMMAND REPLACEMENT .qn _.DISABLE COMMAND REPLACEMENT .p.x ENABLE>COMMAND REPLACEMENT controls the ability to replace permanently defined commands with user defined commands. .ifnot small If a user command is the same as a permanent command, the permanent command will be performed unless prefaced by an underscore "__". For example, if you define the following command: .i5;_.DEFINE COMMAND /p/.s 1 .tt 5 .i 5 .br the command would not normally be performed unless you either .i5;_.ENABLE COMMAND REPLACEMENT .i10;_...or .i5;_.__P .p When command replacement is enabled, you can still select permanent commands by beginning them with a dollar sign "_$". In the example above, _._$P invokes the permanent command and _.__P invokes the user defined command. When command replacement is enabled, RUNOFF may be slower if you have defined many commands or substitutions. .endif small .s.i5;(Not supported in DSR) .i5;Default: _.DISABLE COMMAND REPLACEMENT .eb .helpd CONTINUE .q _.ENABLE CONTINUE .qq _.ECO .qn _.DISABLE CONTINUE .qn _.DES .x DISABLE>CONTINUE .p.x ENABLE>CONTINUE controls the action at the end of a line when a break or hyphenation flag occurs. When CONTINUE is enabled, the line will not automatically break at the end of the input line when in NO#FILL mode. .ifnot small In .x FILL FILL mode, no space will occur between the word at the end of the line and the word at the beginning of the next input line. When CONTINUE is enabled, the break and hyphenate characters still have their usual meaning, and hyphenation or breaks may occur at the end of the input line if there is not sufficient space for the next word in the output line. If the break or hyphenation flag is followed by a space, then it is not at the end of the line. .i5;(Not supported in DSR) .endif small .i5;DEFAULT: _.DISABLE CONTINUE .helpd ESCAPE .q _.ENABLE ESCAPE .qq _.EES .qn _.DISABLE ESCAPE .qn _.DES .x DISABLE>ESCAPE .p.x ENABLE>ESCAPE controls the output of escape sequences. When ESCAPE is diabled, the escape sequence flags will be recognized but not executed. .i5;DEFAULT: _.ENABLE ESCAPE .i5;(Not supported in DSR) .helpd EQUATION .q _.ENABLE EQUATION n .qq _.EEQ n .qn _.DISABLE EQUATION .qn _.DEQ .x DISABLE>EQUATION .X EQUATION>DISABLE .p.x ENABLE>EQUATION .X EQUATION>ENABLE controls the action of the equation formatting flag. The parameter n is the number of half lines to allocate above and below each character. .ifnot small If you are formatting equations with many subscripts or superscripts, n=1 may look better because more blank space is added to the fractions. When the equation is disabled but has had recognition turned on by the _.FLAGS EQUATION command, left and right braces _{ _} are translated to be normal parentheses ( ). .i5;(Not supported in DSR) .endif small .i5;DEFAULT: _.ENABLE EQUATION .helpd FLAGS .q _.ENABLE FLAGS [flag] .qn _.DISABLE FLAGS [flag] .x FLAGS>DISABLE .x DISABLE>FLAGS .p.x ENABLE>FLAGS .x FLAGS>ENABLE controls whether or not flags are enabled. .ifnot small The possible flags are: .nj.ts +5,+12,+12,+12,+12,+12,+12 ACCEPT ALL BREAK CAPITALIZE ESCAPE EQUATION HYPHENATE INDEX LOWERCASE OVERSTRIKE SPACE SPECIAL SUBINDEX SUBSTITUTE TAB UNDERLINE UPPERCASE .j By default all flags are initially enabled. If no flag is specified or ALL is specified, all flags except the TAB flag are enabled or disabled. Flags disabled by _.NO FLAGS ALL can be enabled by a _.FLAGS ENABLE flag command. Flags that have not been defined by a .FLAGS command cannot be enabled. The enable status of flags can be saved with the _.SAVE command. Disabling a flag does not redefine or remove the flag character. For example, if you wish to use the ampersand (_&) for some other purpose than as the underline flag, you could undefine it with a _.NO FLAGS UNDERLINE. You could also _.DISABLE FLAGS UNDERLINE to use the ampersand as a printable character. .i5;(Not supported in DSR) .endif small .helpd HYPHENATION .q _.ENABLE HYPHENATION .qq _.EHY .qn _.DISABLE HYPHENATION .qn _.DHY .x DISABLE>HYPHENATION .p.x ENABLE>HYPHENATION .x Hyphenation Controls hyphenation. .ifnot small When hyphenation is enabled, RUNOFF will hyphenate words at the end of an output line. Hyphenation defined by the user with the hyphenate flag can also be used. Automatic hyphenation is enabled with the _.AUTOHYPHENATE command. RUNOFF will not hyphenate: .LIST 0 .le;The last line on the page .le;A line following 2 hyphenated lines .le;Equations .els 0 The following will inhibit autohyphenation: .list 0 .le;Escape sequences inside a word .le;Overstrikes .le;Non expandable spaces "_#" .x Space>Non expandable .le;Tabs in front of a word .le;Invalid punctuation .els 0 Valid punctuation marks are: .x Punctuation>Valid .c;/ _\ _. , ( ) " @ For example, words containing hyphens are not hyphenated; these words can be broken by using a break character or by issuing the command .c; _.AUTOBREAK "-" .x Autobreak The valid punctuation marks can be changed by the _.AUTOHYPHENATION command. .p The hyphenation algorithm is not ideal; there are certain problems that you must overcome manually. The hyphenation routine receives no warning when a paragraph is ending. Consequently, it may hyphenate the last word in a paragraph. This can be avoided by using the _.FLAGS HYPHENATE command and marking the last word in a paragraph for no hyphenation. Also, periods could be declared as invalid punctuation. If a footnote overflows to the next page, the hyphenation routine may hyphenate the last word on a page. This can be avoided by use of the hyphenation flag, or by forcing the page breaks with the _.PAGE command. Try to avoid footnotes that overflow to the next page. .endif small .i5;DEFAULT: _.ENABLE HYPHENATION .helpd INDEXING .q _.ENABLE INDEXING .qq _.EIX .qn _.DISABLE INDEXING .qn _.DIX .x ENABLE>INDEXING .x INDEX>DISABLE .x ENABLE>INDEXING .s.x INDEX>ENABLE controls the collection and printing of index entries. .i5;DEFAULT: _.ENABLE INDEXING .helpd LEVELS .q _.ENABLE LEVELS [+-n1],[+-n2] .p.x ENABLE>LEVELS .X Table of contents enables output of header levels up to n1, and TOC output up to n2. .ifnot small In other words, the _.DOC file will have header levels 1 to n1 and the _.RNT file will have levels up to n2. If n2 is greater than n1, the _.RNT file will only contain levels up to n1. If n is not specified, the default value is assumed. There is no _.DISABLE LEVELS command .i5;(Not supported in DSR) .endif small .i5;DEFAULT: _.ENABLE LEVELS 6,6 .helpd NUMBERING .q _.ENABLE NUMBERING .qq _.ENMPG .qn _.DISABLE NUMBERING .qn _.DNMPG .x DISABLE>NUMBERING .p.x ENABLE>NUMBERING controls whether page numbers are printed. Numbering does not start if it has been turned off by a _.NO NUMBER command. .ifnot small When page numbering is disabled, page numbers will not be printed, but pages will still be counted. The _.NUMBER command will not turn on the printing of page numbers when page numbering is disabled. .endif small .i5;DEFAULT: _.ENABLE NUMBERING .ifnot small .if hlp .if Rsx .i5;ADDITIONAL HELP AVAILABLE: CHAPTER .endif RSX .endif hlp .helpe CHAPTER .endif small .q _.ENABLE NUMBERING CHAPTER .qq _.ENMCH .qn _.DISABLE NUMBERING CHAPTER .qn _.DNMCH .x DISABLE>NUMBERING>CHAPTER .p.x ENABLE>NUMBERING>CHAPTER controls the form of page numbering. When enabled, pages are numbered in the chapter form N-M, where N is the chapter number and M is the page number. .ifnot small Once chapter numbering has been disabled, it will not be reenabled by any command except _.ENABLE NUMBERING CHAPTER. .i5;(Not supported in DSR) .endif small .i5;DEFAULT: _.ENABLE NUMBERING CHAPTER .helpd ODD .q _.ENABLE ODD .qq _.EODD .qn _.DISABLE ODD .qn _.DODD .p.x DISABLE>ODD .x ENABLE>ODD controls whether or not the first page of each chapter is forced to be an odd number. If enabled, and a page must be skipped, an intermediate numbered page with with no text will be produced to force the chapter onto the proper page. .i5;(Not supported in DSR) .i5;DEFAULT: _.DISABLE ODD .helpd OVERSTRIKING .q _.ENABLE OVERSTRIKING .qq _.EOV .qn _.DISABLE OVERSTRIKING .qn _.DOV .x DISABLE>OVERSTRIKING .p.x ENABLE>OVERSTRIKING enables or disables the overstriking flag. .ifnot small If recognition of the overstrike flag has been turned on by the _.FLAGS OVERSTRIKE command, but overstriking is disabled, RUNOFF will not do any overstriking, and the overstrike flag character will not appear in the output. Previous versions of RUNOFF attempted to omit overstruck characters, but this is, unfortunately, not possible in all circumstances, so this feature had to be omitted. .endif small .i5;DEFAULT: _.ENABLE OVERSTRIKING .helpd PAGING .bb .q _.ENABLE PAGING .qq _.EPAG .qn _.DISABLE PAGING .qn _.DPAG .x DISABLE>PAGING .p.x ENABLE>PAGING enables or disables pagination. When PAGING is disabled, the _.PAGE SIZE command will not turn paging on, and the _.PAGE command will not produce a page. See _.PAGING. .i5;DEFAULT: _.ENABLE PAGING .i5;(Not available in DSR) .eb .helpd SUBSTITUTION .q _.ENABLE SUBSTITUTION .qq _.ESST .qn _.DISABLE SUBSTITUTION .qn _.DSST .x DISABLE>SUBSTITUTION .p.x ENABLE>SUBSTITUTION enables or disables the substitute flag. When recognition of the substitute flag is turned on, but the flag is disabled, the substitution will be recognized, but no substitution will be made. .i5;DEFAULT: _.ENABLE SUBSTITUTION .i5;(Not available in DSR) .helpd TABS .q _.ENABLE TABS .qq _.ETB .qn _.DISABLE TABS .qn _.DTB .x DISABLE>TABS .p.x ENABLE>TABS controls how the tab key is interpreted for producing tabulated or columnar output. .ifnot small Tabs are normally enabled, so you do not need to enable them unless they have been previously disabled. When tabs are disabled, they are treated as .x Tabs .x Space ordinary spaces. .i5;(Not supported in DSR) .endif small .i5;DEFAULT: _.ENABLE TABS .helpd TOC .q _.ENABLE TOC .qq _.ETC .qn _.DISABLE TOC .qn _.DTC .x DISABLE>TOC .p.x ENABLE>TOC .X Table of contents controls whether or not output is sent to the table of contents file. .ifnot small When disabled, neither CHAPTER, _.HEADER LEVEL, _.APPENDIX, nor _.SEND TOC commands will output anything to the _.RNT file. This command can be used to control which items are placed in the TOC. .endif small .i5;DEFAULT: _.ENABLE TOC .helpd TRAILING__ZERO .bb .q _.ENABLE TRAILING ZERO .qn _.DISABLE TRAILING ZERO .p.x ENABLE>TRAILING ZERO .x DISABLE>TRAILING ZERO controls whether or not header levels are printed with trailing zeroes. For a non-chapter-oriented document, the command .i5;_.HL 1 .br;will print a header level number in the form .i5;1.0 .br;If trailing zeroes are disabled, the number appear as .i5;1 .s.i5;(Not available in DSR) .i5;DEFAULT: _.ENABLE TRAILING ZERO .eb .helpd UNCONDITIONAL .q _.ENABLE UNCONDITIONAL .qq _.EUNC .qn _.DISABLE UNCONDITIONAL .qn _.DUNC .x DISABLE>UNCONDITIONAL .p.x ENABLE>UNCONDITIONAL controls the printing of unconditional text. When enabled, all text that is not preceded by an _.IF command will appear in the output. .ifnot small When disabled, all input that follows is ignored except for _.ENABLE UNCONDITIONAL and _.IF commands. These commands cannot be used inside a note, footnote or text section, and must be the first command on a line. When an _.IF command is encountered, RUNOFF will continue processing text as if UNCONDITIONAL were enabled until the matching _.ENDIF command is reached. .p These commands can be used to generate multiple table of contents for sections, figures, tables, and so forth. By disabling normal text, you can have RUNOFF pick out only desired sections and ignore the rest. .i5;(NOT available in DSR) .endif small .i5;DEFAULT: _.ENABLE UNCONDITIONAL .helpd UNDERLINING .q _.ENABLE UNDERLINING .qq _.EUL .qn _.DISABLE UNDERLINING .qn _.DUL .x DISABLE>UNDERLINING .p.x ENABLE>UNDERLINING enables or disables the underline flag. .ifnot small .note The DSR Pocket Reference uses _.EUN instead of _.EUL, but the DST manual uses _.EUL, so this has been adopted as the standard abbreviation. _.EUN and _.DUN will also work, but these might not be supported in the future. .end note .endif small .i5;_.DEFAULT: _.ENABLE UNDERLINING