BRIEF GUIDE to BONNER LAB RUNOFF CHAPTER I INTRODUCTION RUNOFF (RNO) is a PDP-11 program to facilitate the preparation of typed or printed manuscripts, such as memos, manuals, etc. The user prepares his material on any regular PDP-11 terminal, and writes it onto a file using an appropriate editor. The user includes not only textual material, but also case and formatting information. RUNOFF then takes the file and reproduces it onto the line printer, terminal or other file to produce a final copy or final file image. It performs the formatting and case shifting as directed, and will also perform line justification, page numbering and titling, etc., as desired. The principal benefit of such a program is that files prepared for use with it may be easily edited and corrected. Small or large amounts of material may be added or deleted, and unchanged material need not be retyped. After a set of changes, the program may be operated to produce a new copy which is properly paged and formatted. Documentation may thus be updated as necessary without requiring extensive retyping. - 2 - CHAPTER Ii VMS OPERATING PROCEDURES Ii.1 INITIATING RUNOFF If you are using this as a guide to DSR then this entire section should be ignored. RUNOFF can be initiated in several ways. The general formats are: $ RNO Command_string ... or $ RNO RNO>Command_string Ii.2 RNO COMMAND STRING output-file,toc-file=input1-file/sw1/...,input2... or @command-file The output-file, toc-file, and input-file are strings comprising a file specification. The toc-file may be omitted if no table of contents is desired. A file specification has the following form: Dev:[Directory.subdir...]Filename.Typ;Ver Default file specifications (any part of which may be overridden): Input: SY:name.RNO Output: SY:name.DOC Table of contents: SY:name.RNT - 3 - CHAPTER: VMS OPERATING PROCEDURES - 4 - SECTION: RNO COMMAND STRING - 6 DEC 84 Ii.2.1 RNO OPTIONS A file specification may have one or more options associated with it. /AP:l:h -- Output only indicated appendix range. /CH:l:h -- Output only indicated chapter range. /CR -- Output CR,LF in file. /DE -- Type out input lines (debug) /EV -- Output even numbered pages. /FF:n -- Put form-feed at end of page. /HY -- Hyphenate output /OD -- Output odd numbered pages. /PA:l:h -- Output only indicated page range /PS:h:w -- Set page size to H,W (height,width) /RI:n -- Right shift output. n=amount of shift. /SP -- Spool the output file. /TT -- Bypass checks and do a write all on output. /UC -- Force ALL uppercase output /UL:x -- Underline x=[B-backspace, S-simulate, L-line, N-none] /WA -- Wait at beginning of a page. /WR -- Warning message output. /2P -- Two pass operation. DEFAULT: /CR/-DE/EV/OD/PS:58:60 /HY/-SP/UL:L/-WA/WR/-2P CHAPTER Iii SOURCE FILE FORMAT The source file contains the textual material which will appear on the final copy, plus information to specify formatting. All command infor- mation consists of regular ASCII printing characters so that a listing of the source file may be examined if the final copy is not exactly as desired. All material in the source file is taken to be source text except those lines beginning with a period. A line beginning with a period is as- sumed to be a command, .comment index Command format and must match one of those listed in chapter on commands. The commands provide the for- matting information, and control various optional modes of operation. - 5 - CHAPTER Iv RUNOFF COMMANDS All commands begin with a period(.). Most commands have arguments fol- lowing them. An argument is a number or line of text that controls how the command works. Multiple arguments may be separated by spaces, tabs, or commas. If the arguments are separated by commas, any number of tabs or spaces may appear before or after the comma. When you look at the description of a command certain conventions are used to describe the arguments. If the argument is enclosed inside square brackets [] it may be omitted. Most arguments are numbers. If the number is preceeded by a minus sign (-) then it may be entered as a negative value. If it is preceeded by +- then it may be a relative argument. A relative argument changes the old value by + or - the value specified. Some commands have literal arguments. A literal is a line of text enclosed in either apos- trophes (') or quotes ("). If the quotes are used, and you wish to use a quote inside the string you must use it twice. More than one command may be entered on a single line. The commands may be optionally separated by a semicolon ";", spaces, or tabs. If the semicolon is used as a separator the next command must immediately follow with no inter- vening spaces or tabs. Commands which are followed by text must be the last command on a line, and may not have other commands after them on the same line. - 6 - CHAPTER: RUNOFF COMMANDS - 7 - Iv.1 BASIC TEXT FORMATTING .BLANK [-n] .B [-n] Skips n absolute lines. BLANK is like SKIP, except that the space to be left is independent of line spacing. If the page is empty, BLANK does nothing. n can be negative to move to n lines from the end of the page. DEFAULT: .BLANK 1 .BREAK .BR causes a break, i.e. the current line will be output with no justification, and the next word of the source text will be placed at the beginning of the next line. .CENTER [LINE][+-n] .CENTRE [+-n] .C [LINE] [+-n] causes a BREAK and centers the following line of text in the source file. The centering is halfway between the right and left margins if n is not specified. If n is specified as an absolute argument (no sign) then the centering is over column n. .CENTER TEXT [+-n] .C TEXT [+-n] .END CENTER .ECN .CENTER TEXT centers lines of text until a .END CENTER command. .FIGURE [n] .FG n leaves n lines blank to make room for a figure or diagram. If fewer than n lines remain on the current page, the page is advanced and n blank lines are left at the top of the next page. This com- mand guarantees your having n blank lines for a figure, while blank will not generate extra lines at the top or the bottom of the page. DEFAULT: .FIGURE 1 .FIGURE DEFERRED [n] .FGD [n] This command will reserve n lines on the current page or if there is not enough room n lines at the top of the next page. This differs from .FIGURE in that the current page will be filled with text right to the bottom line if there is no room for the figure on this page. CHAPTER: RUNOFF COMMANDS - 8 - SECTION: BASIC TEXT FORMATTING - 6 DEC 84 .INDENT [-n] .I [-n] .LEFT [-n] .L [-n] causes a BREAK and sets the next line to begin n spaces to the right of the left margin. DEFAULT .INDENT paragraph-indentation .PARAGRAPH [-n], [v], [t], [b] .P [-n], [v], [t], [b] Causes a break and starts a paragraph. The n is optional and, if present, sets the number of spaces the paragraph is to be indented. (n can also have a negative value). v is the vertical spacing or number of lines between paragraphs. v can range from 0 to 5. T is the TEST TEXT value. If there is not room for t lines remaining on the page then a new page is started. B is the bottom test value. This specifies the minimum number of lines allowed on the next page. .SET PARAGRAPH [-n], [v], [t], [b] .SPR [-n], [v], [t], [b] This command sets the paragraph parameters without actually start- ing a paragraph. .RIGHT [-n] .R [-n] breaks the line and places the following text flush with the right margin if n is zero or unspecified. If n is specified the text is placed n spaces to the left of the margin (n positive) or n to the right (n negative). .RIGHT TEXT [-n] .R TEXT [-n] .END RIGHT .ER This command begins a section of text all of which is right justified. After this command each input line causes a break, un- til .END RIGHT. .SKIP [-n] .S [-n] Skips n spaced lines. The number of blank lines produced is n times the spacing. If you are currently at the top of a page .SKIP does nothing. DEFAULT: .SKIP 1 CHAPTER: RUNOFF COMMANDS - 9 - SECTION: FOOTNOTE / NOTE - 6 DEC 84 Iv.2 FOOTNOTE / NOTE .FOOTNOTE .FN saves lines for a footnote. When the bottom of the page is reached the text following the .FOOTNOTE command will be printed. If in- sufficient room remains on the current page, the footnote continues at the bottom of the following page. .END FOOTNOTE .EFN causes a break and ends the footnote. .PERMANENT FOOTNOTE .PFN The text following this command is taken a permanent footnote which is then printed between the body of text on a page, and the foot- notes at the bottom. This also sets up permanent margins, spacing, and fill/justify mode for footnotes. .NOTE [;][title] .NT [;][title] This command is used to format notes. A note is text set off from the rest of the text by reduced margins and a centered title. .END NOTE [n] .EN [n] terminates the NOTE command, SKIPs n, and resets the margins and spacing modes to their settings before the last NOTE command. DEFAULT: .END NOTE 2 Iv.3 PAGE FORMATTING .PAGE .PG causes a BREAK and an advance to a new page. If the current page is empty, this command does not advance the page. .PAGE EVEN .PGE This is the same as .PAGE, except that the page number is even. CHAPTER: RUNOFF COMMANDS - 10 - SECTION: PAGE FORMATTING - 6 DEC 84 .PAGE ODD .PGO This is the same as .PAGE, except that the page number is odd. .SUBPAGE .SPG .END SUBPAGE .ES .SUBPAGE produces a new page, but the page number is unchanged and letters are appended to the page number until .END PAGE. | .PAGING | .PA | .NO PAGING | .NPA | With paging off the document is not formatted into pages. These | commands cause a break. | DEFAULT: PAGING | .TEXT | .TX | .END TEXT | .ETX | The .TEXT begins a section of text that you wish to keep all on one | page. The .PAGE, .END TEXT, or another .TEXT command ends the | section. | .TEXT DEFERRED | .TXDEF | This starts a text section which will be printed later if it | doesn't fit on the current page. The normal .TEXT command will | leave the bottom of the current page blank if the text section | doesn't fit. The text deferred will save the text for printing on | later pages. The current page will still be filled with text that | follows the .END TEXT or .PAGE command and the deferred text may | appear on the next page. | .FLUSH | This flushes out all deferred text. | .TEST PAGE t [,b] | .TP t [,b] | causes a BREAK followed by a conditional page advance. It skips to | the next page if fewer than t lines are left on the page. B is | specified to prevent orphan lines. When you specify b, test page | operates slightly differently. The text following the test page is | treated as a block up to the next command which causes a break. T | specifies the minimum number of lines at the top of the block and b | the minimum number of lines at the bottom. CHAPTER: RUNOFF COMMANDS - 11 - SECTION: PAGE FORMATTING - 6 DEC 84 | .IMMEDIATE TEST PAGE t [,b] | .ITP t [,b] | This is almost the same as test page except that it doesn't cause a | break. | .TEST TEXT t [,b] | .TT t [,b] | First this command causes a break, then tests to see if enough room | is on the current page for t lines of text. If not a new page is | started. This differs from .TEST PAGE in that the actual space re- | quired depends on the current spacing. | (not available in DSR) | .IMMEDIATE TEST TEXT t [,b] | .ITT t [,b] | This command is the same as test text except that no break occurrs | before the test. | (not available in DSR) | Iv.4 PAGE HEADERS | The page header consists of a title, and subtitle printed at the top of | each page, as well as a page number. This title is printed on the first | line below the top margin, and the subtitle on the next line. The page | number will normally appear right justified on the same line with the | title. | .TITLE [;][text] | .T [;][text] | .NO TITLE | These commands break the text and set the title at the top of the | page. | .FIRST TITLE [;][text] | .FT [;][text] | Same as .TITLE, but used to specify the title to be printed on the | first page of the document. This command must precede all text in | the source file. Use of the FIRST TITLE command is the only way to | print a title line on the first page of the document. | .SUBTITLE [;][text] | .ST [;][text] | takes the remaining text as the subtitle and outputs it on every | page. It appears directly under the title. CHAPTER: RUNOFF COMMANDS - 12 - SECTION: PAGE HEADERS - 6 DEC 84 | .LAYOUT [code] [,spacing] | .LO [code] [,spacing] | breaks the current line and changes the layout of the title and | page numbers on the page. | CODE PAGE LAYOUT ---- ---- ------ | 0 Title flush left, page number flush right | 1 Title center ,number bottom center | 2 Title right odd page/left even ,number bottom center | 3 Title left, number bottom center | 4 Title left, number bottom right | 5 Title center, number bottom right | 6 Title center, number bottom right odd/left even | 7 Title top, number bottom, both right odd/left even | 8 Title left, number right odd/left even | 9 Title right odd/left even, number bottom right | 10 Title center, number bottom left | 11 Title right odd/left even, number bottom left | 12 Title left, number bottom left | 13 Title right, number bottom left | 14 Title right, number bottom center | 15 Title right, number bottom right odd/left even | 16 Title right, number bottom right | .CHAPTER LAYOUT [code] [,spacing] | .CHLO [code] [,spacing] | This command changes the layout for the first page of a chapter or | appendix without having any effect on any other pages. | .HEADERS [on] | .HD [on] | .NO HEADERS [on] | .NHD | These control whether the page header (title, subtitle, and page | number) are printed. | .HEADERS SPACING [n] | .HDSP [n] | sets the spacing between the title and the first line of text. The | value n is the number of lines to skip. If n is not specified then | the current spacing per line of text is used as the default. The | minimum value for n is 1 and if 0 is specified the value of 1 is | assumed. | DEFAULT: .HEADER SPACING 3 | (Not available in DSR) CHAPTER: RUNOFF COMMANDS - 13 - SECTION: LISTS - 6 DEC 84 | Iv.5 LISTS | The following commands format lists of items. | .LIST [n] ["char"] | .LS [n] ["char"] | starts an indented numbered list with n spacing, moves the left | margin 9 spaces to the right for the first LIST command, and 4 more | spaces for each subsequent nested LIST. The n specified in the | .LIST command skips n lines before each list element in the current | list. | DEFAULT: .LIST paragraph-spacing | .LIST ELEMENT [;]text | .LE [;]text | Starts an item in the list. If you want to type the text on the | same line as the command, you must separate the text from the com- | mand with any number of intervening spaces or tabs, or (optionally) | one semicolon. | .END LIST n | .ELS n | Terminate the .LIST command and restore the margins to the previous | values before the last .LIST command. The optional value n causes | a .SKIP n at the end of the current list. | DEFAULT: END LIST paragraph-spacing | Iv.6 CHAPTER/APPENDIX FORMATTING | .CHAPTER [;][title] | .CH [;][title] | starts a new chapter using the title as the title of the chapter. | .STYLE CHAPTER [n1],[-n2],[-n3],[-n4],[-n5] | .STCH [n1],[-n2],[-n3],[-n4],[-n5] | changes the style of the chapter and appendix headers. | n1 = The number of lines to skip before printing CHAPTER. | n2 = Number of lines to skip after the word CHAPTER. If n2=-1 then | the title and word CHAPTER will appear on the same line. | n3 = Number of lines from title to text. If n3=-1 then the title | and any following text will be on the same line. | n4 = The number of spaces to indent the word CHAPTER. | n5 = The number of spaces to indent the title. If n4 or n5 are -1 | then the line will be centered. If n4 or n5 are -2 then the | lines are right justified. | DEFAULT: .STYLE CHAPTER 12,1,3,-1,-1. | (Not available in DSR) CHAPTER: RUNOFF COMMANDS - 14 - SECTION: CHAPTER/APPENDIX FORMATTING - 6 DEC 84 | .APPENDIX [;][title] | .AX [;][title] | starts a new appendix using the title as the title of the appendix. | Iv.7 SECTION HEADERS | A section header consists of a string of numbers (n1.n2.n3....) followed | by a title. If you use either the .CHAPTER or .APPENDIX command then it | consists of a string of numbers (n0.n1.n2....) where n0 is the current | chapter or appendix number. | .HEADER LEVEL [+-n] [title] | .HL [+-n] [;][title] | starts a section at the level specified and takes the following ti- | tle as the header or title of the section. n can range from 1 to | 6. | .STYLE HEADERS [n1],[n2],...[n9],[n10] | .STHL [n1],...[n10] | breaks the line and controls the formats of the header levels. The | initial default is in (). | n1 = The lowest level at which text starts on same line as title. | (3) | n2 = The lowest level with title capitalized. (1) | n3 = The highest level with first letter of title in CAPS. (6) | n4 = Lowest level with no level number. (7) | n5 = Lowest level with centered title and number. If the title and | text are on the same line no centering occurrs. (7) | n6 = The number of blank lines before the header. (2) | n7 = The number of blank lines after the title. (1) | n8 = The implicit test page value (7) | n9 = Number spaces between section number and title. (2) | n10= Largest level printed as n.m.... (6) | (n10 not available in DSR) | DEFAULT: STYLE HEADERS 3,1,6,7,7,2,1,7,2,6 .INDENT LEVELS n1,n2 this causes the header levels to be indented by n1 from the left margin and indented n2 from the right margin. | .INDENT LEVEL TITLES [n1],[n2]...[n6] | this causes the titles to be indented from the level indent by | a fixed amount. | .DEFAULT: .INDENT LEVEL TITLES 0,0,0,0,0,0 CHAPTER: RUNOFF COMMANDS - 15 - SECTION: NUMBERING - 6 DEC 84 Iv.8 NUMBERING These commands set numbers for various items. The number may be either a decimal number or a string of letters. If n is a letter A it corresponds to 1, B to 2, Z to 26. Similarly AA is 27, AB 28, and so on. If the number is preceded by a plus sign "+" then then new value is the old value plus the specified increment. If the number is omitted it is assumed to be 1. Zero (0) is not a legal number, and no number may exceed 3999 or EWU. .NUMBER APPENDIX [+-n] .NUMBER CHAPTER [+-n] .NMCH [+-n] .NUMBER LEVEL [+-n1],[+-n2],[+-n3],[+-n4],[+-n5],[+-n6] .NMLV [+-n1],[+-n2],[+-n3],[+-n4],[+-n5],[+-n6] .NUMBER ITEM /name1/ [+-n1] .NMIT /name1/ [+-n1] .NUMBER LIST [+-n] .NMLS [+-n] .NUMBER [PAGE] [+-n] .NMPG [+-N] .NO NUMBER .NNM .NUMBER SUBPAGE [+-n] .NMSPG [+-n] Iv.9 DISPLAY COMMANDS The display commands control how numbers are displayed. Examples of these are the page number, chapter number and so on. Numbers may be displayed as normal (decimal) numbers, letters, or Roman numerals. Ex- tra text may be added to the numbers via pre or post-fixes. CHAPTER: RUNOFF COMMANDS - 16 - SECTION: DISPLAY COMMANDS - 6 DEC 84 Table of Formats The format code produces numbers in the specified format: Format Description ------ ----------- D Decimal numbers (1,2,3,....) LU Letters uppercase (A,B,C,....,Z,AA,AB,AC....) LL Letters lowercase (a,b,c,....,z,aa,ab,ac....) LM Letters mixed (first is uppercase) (A,B,C,....,Z,Aa,Ab,...) RU Roman numerals uppercase (I,II,III,IV,....) RL Roman lowercase (i,ii,iii,iv,....) RM Roman mixed (I,Ii,Iii,Iv,....) .DISPLAY APPENDIX ["pre-fix",] [format] [,"post-fix"] .DAX ["pre-fix",] [format] [,"post-fix"] DEFAULT: .DISPLAY APPENDIX "APPENDIX " , LU , "" .DISPLAY CHAPTER ["pre-fix",] [format] [,"post-fix"] .DCH ["pre-fix",] [format] [,"post-fix"] DEFAULT: .DISPLAY CHAPTER "CHAPTER " , D , "" .DISPLAY ELEMENTS ["l"] [,format] [,"r"] .DLE ["l",] [format] [,"r"] DEFAULT: .DISPLAY ELEMENTS "" , D , "." .DISPLAY LEVELS [fm1,][fm2,][fm3,][fm4,][fm5,][fm6,] .DISPLAY LEVELS [level,]["pre-fix",] [form,] ["post-fix"] .DHL [fm1,][fm2,][fm3,][fm4,][fm5,][fm6,] DEFAULT: .DISPLAY LEVELS D,D,D,D,D,D .DISPLAY NUMBER ["pre-fix",] [format] [,"post-fix"] .DNM ["pre-fix",] [format] [,"post-fix"] DEFAULT: .DISPLAY NUMBER "Page " , D , "" .DISPLAY SUBPAGE [format] .DSP [format] DEFAULT: .DISPLAY SUBPAGE "" LU "" .DISPLAY SUBTITLE ["pre-fix"] [,"post-fix"] DEFAULT: .DISPLAY SUBTITLE "" "" .DISPLAY TITLE ["pre-fix"] [,"post-fix"] DEFAULT: .DISPLAY TITLE "" "" CHAPTER: RUNOFF COMMANDS - 17 - SECTION: MODE SETTING - 6 DEC 84 Iv.10 MODE SETTING .AUTOBREAK ["characters-to-test"] .AB ["characters-to-test"] .NO AUTOBREAK ["characters-to-disable"] .NAB .AUTOBREAK allows automatic optional breaks after selected characters. The selected characters are specified in a literal string. DEFAULT .NO AUTOBREAK .AUTOHYPHENATE [size],[begin],[end],[mode][,"chars"] .AH [size],[begin],[end],[mode][,"chars"] .NO AUTOHYPHENATE [,"chars"] .NAH [,"chars"] These commands control automatic hyphenation. size = The minimum number of characters/word. begin = The minimum number of characters at the beginning of a line. end = The minimum number of characters at end of a line. mode = The hyphenation mode. 0 produces maximum hyphenation with possibly some inaccuracy. 1 hyphenates according to the suf- fix/prefix tables only for maximum accuracy. "chars"= Special characters allowed in hyphenated words. DEFAULT: .AH 5,2,3,0,'\/.,()"@' .AUTOPARAGRAPH .AP .NO AUTOPARAGRAPH .NAP .AUTOPARAGRAPH causes any blank line or any line starting with a space or tab to be considered as the start of a new paragraph. DEFAULT .NO AUTOPARAGRAPH .AUTOTABLE .AT .NO AUTOTABLE .NAT .AUTOTABLE causes any line not starting with a space or tab to be considered as the start of a new paragraph. DEFAULT .NO AUTOTABLE .AUTOTITLE .ATI .NO AUTOTITLE .NAT .AUTOTITLE enables automatic titles. Everytime you give a .CHAPTER or .APPENDIX command the chapter or appendix title will be used as the title at the top of the page. DEFAULT: .AUTOTITLE (Not available in DSR) CHAPTER: RUNOFF COMMANDS - 18 - SECTION: MODE SETTING - 6 DEC 84 .AUTOSUBTITLE [+-n] .AST [+-n] .NO AUTOSUBTITLE .NAST When enabled each header level command lower than n sets the subti- tle to the current header level title. DEFAULT: .NO AUTOSUBTITLE The default for n is 1 .BEGIN BAR .BB .END BAR .EB These commands control whether the change bar is printed in the document. .FILL .F .NO FILL .NF .FILL causes a break and specifies that subsequent output lines be filled. Sets the justification mode to be that specified by the last appearance of .JUSTIFY or .NO JUSTIFY. FILL adds successive words from the source text until the adding of one more word will exceed the right margin. DEFAULT .FILL .JUSTIFY .J .NO JUSTIFY .NJ These commands cause a break and control the justify mode. The justify mode increases the spaces between words until the last word exactly meets the right margin. | .KEEP [LINES] | .K [LINES] | .NO KEEP [LINES] | .NK [LINES] | .KEEP LINES allows you to keep blank lines while in .NO FILL mode. | DEFAULT: .NO KEEP LINES | .KEEP TABS | .K TABS | .NO KEEP TABS | .NK TABS | .KEEP TABS allows you to keep all tabs at the beginning of a line | while in .FILL mode. | DEFAULT: .KEEP TABS CHAPTER: RUNOFF COMMANDS - 19 - SECTION: MODE SETTING - 6 DEC 84 .LITERAL .LT .END LITERAL .ELI .LITERAL turns off fill and all flags to permit printing of text exactly as it appears in the source file. In addition all commands are disabled until .END LITERAL. .PERIOD ["chars"] .PR ["chars"] .NO PERIOD ["chars"] .NPR ["chars"] .PERIOD automatically prints two spaces after every terminal punc- tuation followed by at least one space or tab character. DEFAULT: .PERIOD ".:;?!" .SEPARATED EQUATION .SEQ .END SEPARATED EQUATION .ESEQ .BEGIN SEPARATED EQUATION enables separated equation mode. In this mode an equation will automatically generate extra lines to separate it properly from other equations or text. .UNDERLINE "chars to underline" .UN "chars to underline" .NO UNDERLINE "chars to not underline" .NUN "chars to not underline" This command sets which characters are underlinable. DEFAULT: .NO UNDERLINE " " .VARIABLE SPACING .VARSP .NO VARIABLE SPACING .NVARSP These commands control the variable spacing mode. In this mode RNO uses microspaces to pad out spaces between words for a justified line. To use this your printer must either be DIABLO compatible or you must define an appropriate escape sequence for variable spacing via the .DEFINE VARIABLE SPACE command. DEFAULT: .NO VARIABLE SPACING CHAPTER: RUNOFF COMMANDS - 20 - SECTION: PARAMETER SETTING - 6 DEC 84 Iv.11 PARAMETER SETTING .LEFT MARGIN [+-n] .LM [+-n] sets the left margin to n. The n must be at least 16 less than the right margin but not less than 0. The initial setting is 0. If n is not specified, the permanent margin is restored. If the margin is specified with a + or - sign then n is added to the current margin. .RIGHT MARGIN [+-n] .RM [+-n] sets the right margin n. The n must be 16 greater than the left margin. .TOP MARGIN [+-n] .TM [+-n] sets the top margin or the number of blank lines at the top of the page to n. .PAPER SIZE [+-h],[+-w],[+-l],[+-t],[s] .PAGE SIZE [+-h],[+-w],[+-l],[+-t],[s] .PS [+-h],[+-w],[+-l],[+-t],[s] sets the size of the page to h by w for the height and width. Also sets the LEFT MARGIN to l, the TOP MARGIN to t and the spacing to s. These settings are permanent since they are now the new default for the duration of the document. DEFAULT: .PAGE SIZE 58,60,0,0,1. .SPACING [lines] .SP [lines] sets the number of spaces between lines. The lines can range from 1 to 5. DEFAULT: .SPACING 1 .HALF SPACING [half lines] .NO HALF SPACING This command is very similar to the spacing command except that it turns on half spacing. The half lines will be the number of half lines per line of text. Once half spacing is enabled, every com- mand which specifies spacing now works in increments of half lines. DEFAULT .NO HALF SPACING CHAPTER: RUNOFF COMMANDS - 21 - SECTION: PARAMETER SETTING - 6 DEC 84 .LOCK this command locks a number of page formatting parameters. While locked these parameters can not be changed. Essentially all com- mands that change the page format are locked. The following com- mands will give error messages if issued after a .LOCK command: .ENABLE NUMBERING .DISABLE NUMBERING .ENABLE NUMBERING CHAPTER .DISABLE NUMBERING CHAPTER .HEADERS UPPER .HEADERS LOWER .HEADERS MIXED .HEADERS PAGE .HEADERS NO PAGE .HEADERS SPACING .NO HEADERS .HEADERS .INDENT LEVELS .PAGE SIZE .TOP MARGIN .STYLE (all commands) .STANDARD .NO NUMBER .NO NUMBER CHAPTER .NO TITLE .LAYOUT .DISPLAY (all commands) Iv.12 TAB STOPS Lists of items may be conveniently expressed in tabular form using the tab key and the .TAB STOPS command. Every time you press the "tab" key you have entered a tab into the text. Just as on a typewriter a tab will make the text begin at the next tab stop. .TAB STOPS ["ell"][+n1],["ell"][+n2], . . . .TS ["ell"][+n1],["ell"][+n2], . . . This command clears all previous tabs, then sets new ones. Each n specifies the column number for the tab stop That is n2 must be bigger than n1 and so on. If a tab stop is +n then it will be n more than the previous one. If the first stop is +n then it will be n more than the left margin. If the n is prefaced by either R, C, or L then the text is right, center, or left justified. If the number is preceeded by a literal then the text inside the literal is used as an ellipses to fill in the space generated by the tab. .TAB PROPORTIONAL n,["ell"][+-n1],["ell"][+-n2],,, .TABP n,["ell"][+-n1],["ell"][+-n2],,, This sets tab stops to create n columns across a page between the left and right margins. The first column begins at the left margin and ends at the first tab stop. The second column begins at the first tab stop and ends at the second one. The last one ends at the right margin. n must be 2 or larger. Tab stops are set so that all unspecified columns have equal width. You specify column 1 by specifying n1, column 2 by n2 and so on. When you omit a column it is unspecified. If you specify a column as either + or -n then it is n larger or smaller than the unspecified ones. Using + or - you may increase or decrease each column width from an evenly spaced one. CHAPTER: RUNOFF COMMANDS - 22 - SECTION: TAB STOPS - 6 DEC 84 .TAB LEFT .TL This sets unspecified tabs to left justification. If you do not specify either .TAB LEFT or RIGHT then .TAB LEFT is assumed. .TAB RIGHT .TR This causes the text following an unspecified tab to be right justified. This command is the opposite of .TAB LEFT. The text is right justified at the next tab terminator. The text is considered to be terminated by either a space, tab, end of line, break character, or autobreak character. .ELLIPSES .ELL .NO ELLIPSES .NELL .ELLIPSES causes tabbed text to be filled with ellipses rather than spaces. Iv.13 FLAGS A flag is a character which performs some special action and does not appear in the final document. An example of a flag is the ampersand (&). It causes the next character to be underlined. Each flag character can be defined by the .FLAGS command and removed by the .NO FLAGS command. The ACCEPT, CONTROL, LOWERCASE, SPACE, UPPERCASE and UN- DERLINE flags are already defined by default. .FLAGS ACCEPT [new flag] .FL ACCEPT [new flag] .NO FLAGS ACCEPT .NFL ACCEPT .FLAGS [ALL] .FL [ALL] .NO FLAGS [ALL] .NFL [ALL] .FLAGS BREAK [new flag] .FL BREAK [new flag] .NO FLAGS BREAK .NFL BREAK CHAPTER: RUNOFF COMMANDS - 23 - SECTION: FLAGS - 6 DEC 84 .FLAGS CAPITALIZE [new flag] .FL CAPITALIZE [new flag] .NO FLAGS CAPITALIZE .NFL CAPITALIZE .FLAGS CONTROL [new flag] .FL CONTROL [new flag] .NO FLAGS CONTROL .NFL CONTROL Once .NO FLAGS CONTROL has been issued you can no longer give any more commands including .FLAGS CONTROL. So this is a non revers- able command. .FLAGS ESCAPE [escape flag] .FL ESCAPE [escape flag] .NO FLAGS ESCAPE .NFL ESCAPE .FLAGS EQUATION .FL EQUATION .NO FLAGS EQUATION .NFL EQUATION .FLAGS LOWERCASE [new flag] .FL LOWERCASE [new flag] .NO FLAGS LOWERCASE .NFL LOWERCASE .FLAGS HYPHENATE [new flag] .FL HYPHENATE [new flag] .NO FLAGS HYPHENATE .NFL HYPHENATE .FLAGS INDEX [new flag] .FL INDEX [new flag] .NO FLAGS INDEX .NFL INDEX .FLAGS OVERSTRIKE [new flag] .FL OVERSTRIKE [new flag] .NO FLAGS OVERSTRIKE .NFL OVERSTRIKE .FLAGS PERIOD [new flag] .FL PERIOD [new flag] .NO FLAGS PERIOD .NFL PERIOD CHAPTER: RUNOFF COMMANDS - 24 - SECTION: FLAGS - 6 DEC 84 .FLAGS SPACE [new flag] .FL SPACE [new flag] .NO FLAGS SPACE .NFL SPACE .FLAGS SPECIAL [flag1][flag2][flag3] . . . .FL SPECIAL [flag1][flag2][flag3] . . . .NO FLAGS SPECIAL [flag1][flag2][flag3] . . . .NFL SPECIAL [flag1][flag2][flag3] . . . .FLAGS SUBINDEX [new flag] .FL SUBINDEX [new flag] .NO FLAGS SUBINDEX .NFL SUBINDEX .FLAGS SUBSTITUTE [new flag] .FL SUBSTITUTE [new flag] .NO FLAGS SUBSTITUTE .NFL SUBSTITUTE Assuming the current date and time is January 17,1983 15:23:51 DEFAULT substitutions are: Symbol Resulting output $$DATE 17 Jan 83 $$TIME 15:23:51 $$YEAR 1983 $$MONTH January $$DAY 17 $$HOURS 15 $$MINUTES 23 $$SECONDS 51 .FLAGS TAB [new flag] .FL TAB [new flag] .NO FLAGS TAB .NFL TAB .FLAGS UNDERLINE [new flag] .FL UNDERLINE [new flag] .NO FLAGS UNDERLINE .NFL UNDERLINE .FLAGS UPPERCASE [new flag] .FL UPPERCASE [new flag] .NO FLAGS UPPERCASE .NFL UPPERCASE CHAPTER: RUNOFF COMMANDS - 25 - SECTION: ENABLE/DISABLE - 6 DEC 84 Iv.14 ENABLE/DISABLE .ENABLE BAR [n1] [,n2] .EBB [n1] [,n2] .DISABLE BAR .DBB This command controls the printing of change bars. DEFAULT: .DISABLE BAR | .ENABLE CONTINUE | .ECO | .DISABLE CONTINUE | .DES | When this is enabled either a break, or hyphenation flag at the end | of the line will cause the line to be continued. | DEFAULT: .DISABLE CONTINUE .ENABLE ESCAPE .EES .DISABLE ESCAPE .DES These commands control the output of escape sequences. The escape sequence flags will be recognized, but not executed while disabled. DEFAULT: .ENABLE ESCAPE (Not supported in DSR) .ENABLE EQUATION n .EEQ n .DISABLE EQUATION .DEQ This controls the equation formatting. The parameter n is the number of half lines to allocate above and below each character. The default is .EEQ 0. DEFAULT: .ENABLE EQUATION | .ENABLE FLAGS [flag] | .DISABLE FLAGS [flag] | this commands temporarily enable or disable flags. | .ENABLE HYPHENATION | .EHY | .DISABLE HYPHENATION | .DHY | Controls hyphenation. | DEFAULT: .ENABLE HYPHENATION CHAPTER: RUNOFF COMMANDS - 26 - SECTION: ENABLE/DISABLE - 6 DEC 84 | .ENABLE INDEXING | .EIX | .DISABLE INDEXING | .DIX | contols collecting and printing of index entries. | DEFAULT: .ENABLE INDEXING | .ENABLE LEVELS [+-n1],[+-n2] | Enables output of header levels up to n1, and TOC output up to n2. | DEFAULT: .ENABLE LEVELS 6,6 | .ENABLE NUMBERING | .ENMPG | .DISABLE NUMBERING | .DNMPG | .ENABLE NUMBERING allows page numbers to be printed. This does not | start numbering if it has been terminated by a .NO NUMBER command. | DEFAULT .ENABLE NUMBERING | .ENABLE NUMBERING CHAPTER | .ENMCH | .DISABLE NUMBERING CHAPTER | .DNMCH | When enabled pages are numbered as N-M where N is the chapter | number and M is the page number. | DEFAULT: .ENABLE NUMBERING CHAPTER | .ENABLE ODD | .EODD | .DISABLE ODD | .DODD | Enabling odd forces the first page of each chapter onto an odd num- | bered page. If necessary numbered pages with no text will be pro- | duced to force the chapter onto the proper page. | (Not supported in DSR) | DEFAULT: .DISABLE ODD | .ENABLE OVERSTRIKING | .EOV | .DISABLE OVERSTRIKING | .DOV | Enables or disables overstriking by means of the overstrike | character [ % ]. | DEFAULT: .ENABLE OVERSTRIKING CHAPTER: RUNOFF COMMANDS - 27 - SECTION: ENABLE/DISABLE - 6 DEC 84 | .ENABLE SUBSTITUTION | .ESST | .DISABLE SUBSTITUTION | .DSST | These command enable or disable substitutions. When disabled and | the substitute flag is defined the substitution will be recognized, | but no substitution will be made. | DEFAULT: .ENABLE SUBSTITUTION | .ENABLE TABS | .ETB | .DISABLE TABS | .DTB | This contols the use of the tab key to produce tabulated or | columnar output. | DEFAULT: .ENABLE TABS | .ENABLE TOC | .ETC | .DISABLE TOC | .DTC | These commands enable or disable all output to the table of con- | tents file. | DEFAULT: .ENABLE TOC | .ENABLE UNCONDITIONAL | .EUNC | .DISABLE UNCONDITIONAL | .DUNC | This causes a break, and enables or disable unconditional text. | When enabled all text not preceeded by an .IF command will appear | in the output. | DEFAULT: .ENABLE UNCONDITIONAL | .ENABLE UNDERLINING | .EUL | .DISABLE UNDERLINING | .DUL | Controls underlining using the underline character [ & ]. | .DEFAULT: .ENABLE UNDERLINING CHAPTER: RUNOFF COMMANDS - 28 - SECTION: DEFINE, DELETE, AND RESET - 6 DEC 84 | Iv.15 DEFINE, DELETE, AND RESET | The DEFINE, DELETE, and RESET commands are not available in DSR. These | commands may be used to define features such as bolding which is avail- | able in DSR. | .DEFINE COMMAND /label/command string | defines commands. The label consists of up to 20 letters. | .DEFINE ESCAPE "escape label" [,modifiers] definition | defines escape sequences for control of a variety of printers. | Each escape sequence is indicated in the text by either \ or ^ or a | symbol of your choice followed by another symbol. For example ^* | can enable bolding by issuing a sequence to turn on bolding and \* | may disable bolding by issuing a turn off sequence. The escape se- | quence is entered as follows. First you select which 2 character | label. The first character must be either ^,\, or your flag | character, while the second one may be any other character. They | are entered as a literal. | Modifiers | LCK - escape sequence is a lock/unlock pair. | VSP,spacing - escape sequence changes vertical position by spacing. | HSP,spacing - sequence modifies the horizontal position by spacing. | PSP - The horizontal spacing specified by HSP is applied to all | printable characters following the escape sequence. | CHR - The lock/unlock pair is used to change only 1 printable | character. | .DEFINE ITEM /name/ [format],[n] | This command defines a numbered item which may be included in your | text. The name is a substitution label for the item. The format | is the format to display the item, see .DISPLAY PAGE. The inital | value for the item may be specified as n in the range 0 to 3999 or | as a series of letters A to EWU. | DEFAULT: .DEFINE ITEM /item/ D 1 | .DEFINE NUMBER parameter /label/ | defines a numeric substitution. The parameter determines what | number is used in the substitution. Normally the number must be | defined before you use the label. You may reference the label be- | fore the .DEFINE NUMBER statement if you use the /2P option. | Parameters are: | Param. Number substituted | APPENDIX Current Appendix or chapter | CHAPTER Current Chapter or appendix | LIST Current List element | LEVEL Current Header level | PAGE Current Page-subpage number | ITEM /name/ Item named CHAPTER: RUNOFF COMMANDS - 29 - SECTION: DEFINE, DELETE, AND RESET - 6 DEC 84 .DEFINE SUBSTITUTE /label/ text defines a substitution to be made in the text. The label is pre- ceeded and followed by a delimiter of your choice. The label must be no more than 20 characters long and may not contain spaces or tabs. .DEFINE SUBSCRIPT [parameters] This command allows the user to define subscript escape sequences. This is an escape sequence that moves the text down 1/2 space on the page. It must be a maximum of 10 numbers or characters. The command is followed by either numbers or literals. .DEFINE VARIABLE SPACE n,[parameters] This command defines a micro space for implementing variable spac- ing between words. The n is the number of microspaces/space. The parameters define an escape sequence which produces a microspace. The escape sequence may have up to 19 numbers or characters. .DELETE COMMAND /label/ This command deletes an already defined command. Only commands de- fined by .DEFINE COMMAND may be removed. .DELETE SUBSTITUTE /label/ This command deletes an already defined substitution. Only com- mands defined by .DEFINE SUBSTITUTE may be removed. This command is illegal in 2 pass mode. .RESET ESCAPE resets all escape sequences. This clears the table of escape se- quences so you may enter new ones by using .DEFINE ESCAPE. After giving this command all escape sequences are no longer defined. If you need to reset escape sequences, this should be done only once at the beginning. .RESET SUBSTITUTE resets the table of substitutions so that all the previously de- fined substitutions and commands are no longer available. The per- manently defined substitutions ($$DATE...) and defined commands are also no longer defined. To remove a single entry use .DELETE SUB- STITUTE or .DELETE COMMAND. This command can be dangerous so use with caution. It should done only once at the beginning. This command is illegal in 2 pass mode. CHAPTER: RUNOFF COMMANDS - 30 - SECTION: MISC COMMANDS - 6 DEC 84 Iv.16 MISC COMMANDS .COMMENT text .; text .! text causes the line to be ignored. The text is not printed in the output. .NO SPACE .NSP This command may be used to join 2 filled lines without the normal space in the output between them. If .FILL is engaged and you is- sue .NO SPACE after a line, the end of that line will not automa- tically generate a space in the output .DOC file. .REQUIRE 'filespec' .REQ 'filespec' takes the input text from the specified file. The .REQUIRE command may be imbedded in files which have been required. DEFAULT: file type=.RNO .REQUIRE BINARY [spacing] 'file-specification' .REQ BIN 'file-spec' This form of the require command first causes a break. Next a test page is executed with the specified spacing. Finally the entire contents of the required file is included in the .DOC output. The output is identical to the input and no interpretation of the input is performed. | Iv.17 SAVE/RESTORE COMMANDS | These commands save the current status for later. The status is res- | tored automatically or by a RESTORE command. | .SAVE APPENDIX | This saves the status to be restored by an .APPENDIX command. | .SAVE CHAPTER | This saves the status to be restored by a .CHAPTER command. | .SAVE HEADERS | This saves the current status which is restored whenever a page | header or page number are printed. CHAPTER: RUNOFF COMMANDS - 31 - SECTION: SAVE/RESTORE COMMANDS - 6 DEC 84 | .SAVE LEVELS | This saves the status to be restored by a .HEADER LEVEL command. | .SAVE STATUS | This saves the status to be restored by the .RESTORE STATUS | command. | .RESTORE STATUS | This command restores the status saved by the last SAVE STATUS | command. | .TRACE | This generates an error message to aid in debugging your .RNO file. | .TYPE text | This command causes the "text" to be typed on your terminal. Iv.18 INDEXING Runoff can produce an index to your document. To do this you must use the .INDEX command for each occurrence of a keyword you wish to index. .INDEX [text] .X [text] takes the remaining text on the line as a keyword and adds it, along with the current page number, to the internal index buffer. The command does not cause a break. .ENTRY index term .Y index term This puts an index term into the index, but doesn't include the current page number. .DO INDEX [;][text] .DX [;][text] This command clears the title and subtitle, uses the text as a header, and starts a new page. Then the entire contents of the index buffer is printed and reset. .PRINT INDEX ["entry"] .PX ["entry"] This prints the specified entry in the index buffer. If no entry is specified the entire index buffer is printed and reset. CHAPTER: RUNOFF COMMANDS - 32 - SECTION: INDEXING - 6 DEC 84 .DELETE INDEX "entry" This deletes an index entry from the index buffer. .RESET INDEX This resets the index buffer so that it contains no entries. Iv.19 TABLE OF CONTENTS A table of contents may be produced by RUNOFF. It will include all chapters and section headers at level 1. .SEND TOC [;]text .STC text sends the "text" to the .RNT file. .SEND PAGE TOC [n] [;text] This sends text to the .RNT file followed by a page number. If n is included then the text is preceeded by .IF TOCn and followed by .ENDIF TOCn. The parameter n must be in the range 1 to 9. .TOC .END TOC You do not normally use these commands. They are automatically placed in the .RNT file. .TOC enables formatting for the table of contents. Iv.20 CONDITIONAL TEXT .IF aaa This statement causes the text following it to be ignored or pro- cessed depending on whether the label aaa is defined by a .VARIANT command. .IF NOT aaa This statement causes the text following it to be ignored if aaa is undefined. .ELSE aaa This command changes true conditionals to false and false to true. .ENDIF aaa This command terminates the range of the .IF or .IF NOT statements. The label aaa must be the same as the previous .IF which is terminated. CHAPTER: RUNOFF COMMANDS - 33 - SECTION: CONDITIONAL TEXT - 6 DEC 84 .VARIANT aaa This statement defines a label aaa which is used to control the ac- tion of subsequent .IF commands. If the label is defined in the VARIANT statement then .IF aaa will cause text to be printed and .IF NOT aaa will suppress text. .NO VARIANT aaa This statement undefines a label aaa which is used to control the action of subsequent .IF commands. APPENDIX A SPECIAL CHARACTERS Flag characters Below is a list of RUNOFF's flag characters. To appear in the text, each must be preceeded by the underscore character "_" (itself a special character). Since the special characters may be changed by the .FLAGS commands this list may not represent the actual usage for your document. ^ UPPERCASE next char or LOCK function ^^ No case conversion \ LOWERCASE next char. or UNLOCK function \\ Lowercase all text < CAPITALIZE word flag character * ^< capitalize all text * # SPACE character (non expandable or quoted space) = HYPHENATE specify or continue * & UNDERLINE the following character or "^&,/&" _ ACCEPT the following character. % OVERSTRIKE the previous char by the next char * $ SUBSTITUTE defined text for abbreviation * > INDEX/SUBINDEX flags * | BREAK text with no spaces or continue * + PERIOD add extra space if followed by space * { EQUATION flag 1 * (Not in DSR) } EQUATION flag 2 * "tab" TAB flag character causes tabulation. (Not a flag in DSR) -------- footnote -------- * Only becomes a special character if the FLAG is engaged. - 34 - APPENDIX: SPECIAL CHARACTERS - 35 - Terminal punctuation . : ; ? ! These characters if followed by a separator (space or tab) will then have 1 extra space after them in the output. This feature works only when both .FILL and .PERIOD are engaged. This list may be changed by the .PERIOD command. Valid punctuation / \ . , " ( ) @ These characters are valid in a hyphenated word. Any other non alpha- betic character will prevent autohyphenation. These characters may be changed by the .AUTOHYPHENATE command. APPENDIX B LIST OF COMMANDS (ALPHABETICAL) * Indicates the command causes a line BREAK. $ Indicates a command forbidden during a FOOTNOTE. D Indicates the default setting ~ Indicates not available in DSR Command Abbreviation Opt. ------- ------------ ---- APPENDIX [;][title] - - - - - - - AX - - - - *$ Start an appendix AUTOBREAK ["chars"] - - - - - - - AB - - - - $ ~ The characters may cause a line break AUTOHYPHENATE [n1,...n4][,"chars"] - - AH - - - - $D~ (n1=size, n2=begin, n3=end, n4=mode) Enable automatic hyphenation "chars" are allowed in hyphenated word until NO AUTOHYPHENATE AUTOPARAGRAPH - - - - - - - - - AP - - - - $ Begin paragraphs for lines with leading spaces, tabs, or blank lines until NO AUTOPARAGRAPH AUTOSUBTITLE - - - - - - - - - AST - - - - $ Subtitle is same as current section (header level) until NO AU- TOSUBTITLE AUTOTABLE - - - - - - - - - - AT Enable automatic table format until NO AUTOTABLE AUTOTITLE - - - - - - - - - - ATI - - - - $D~ Enable title is same as current chapter/appendix BEGIN BAR - - - - - - - - - - BB - - - - Left hand margin will have a bar in it until .END BAR BLANK [-space] - - - - - - - - - B - - - - - * Skip lines independently from spacing, except at top of page. BREAK - - - - - - - - - - - - BR - - - - * Start a new line CENTER [LINE][+-n] - - - - - - - C [LINE] - - * Center 1 line CENTER TEXT [+-n] - - - - - - - - C TEXT - - - * ~ Center a section until END CENTER CENTRE [+-n] - - - - - - - - - C - - - - - * CHAPTER [;][title] - - - - - - - CH - - - - *$ Start a chapter CHAPTER LAYOUT [code][,spacing] - - - CHLO - - - - $ ~ Change the layout of first page of chapter COMMENT [comment text] - - - - - - ; - - - - - - - ! The comment is not included in the output DEFINE COMMAND /command/text - - - - - - - - - - $ ~ Define a new command - 36 - APPENDIX: LIST OF COMMANDS (ALPHABETICAL) - 37 - DEFINE ESCAPE escape definition - - - - - - - - - $ ~ Define special characters to output control codes. DEFINE ITEM /label/ [format],[+-n] - - - - - - - - ~ The label is a number to appear in text DEFINE NUMBER - Defines a substitution label for a current "number" DEFINE NUMBER APPENDIX /label/ - - - - - - - - - ~ DEFINE NUMBER CHAPTER /label/ - - - - - - - - - - ~ DEFINE NUMBER ITEM /item/ /label/ - - - - - - - - ~ DEFINE NUMBER LEVEL /label/ - - - - - - - - - - ~ DEFINE NUMBER LIST /label/ - - - - - - - - - - - ~ DEFINE NUMBER PAGE /label/ - - - - - - - - - - - ~ DEFINE SUBSTITUTE /label/text - - - - - - - - - - $ ~ Set up text to be substituted for label DEFINE SUBSCRIPT escape def - - - - - - - - - - ~ Define subscript for equation formatting DEFINE SUPERSCRIPT escape def - - - - - - - - - - ~ Define superscript for equation formatting DEFINE VARIABLE SPACE escape def - - - - - - - - - ~ Define how to do variable spacing DELETE INDEX "entry" - - - - - - - - - - - - - ~ Remove an entry from index table DELETE SUBSTITUTE /label/ - - - - - - - - - - - ~ Remove a substitution label from table of subst. DISABLE - Turns off features turned on by .ENABLE DISABLE BAR - - - - - - - - - - DBB - - - - D DISABLE ESCAPE - - - - - - - - - DES - - - - ~ DISABLE EQUATION - - - - - - - - DEQ - - - - ~ DISABLE FLAGS [flag] - - - - - - - DFL - - - - D~ DISABLE HYPHENATION - - - - - - - DHY - - - - DISABLE INDEXING - - - - - - - - DIX - - - - DISABLE NUMBERING - - - - - - - - DNMPG - - - $ ~ DISABLE NUMBERING CHAPTER - - - - - DNMCH - - - $ ~ DISABLE ODD - - - - - - - - - - DOD - - - - D~ DISABLE SUBSTITUTION - - - - - - - DSST - - - - DISABLE TABS - - - - - - - - - DTB - - - - ~ DISABLE TOC - - - - - - - - - - DTC - - - - DISABLE OVERSTRIKING - - - - - - - DOV - - - - DISABLE UNCONDITIONAL - - - - - - DUNC - - - - *$ ~ DISABLE UNDERLINING - - - - - - - DUL - - - - DISPLAY APPENDIX ["pre",][form][,"post"] DAX - - - - *$ DISPLAY - Change format of specified number (form = D,LU,LL,LM,RU,RL,RM) DISPLAY CHAPTER ["pre",][form][,"post"] DCH - - - - *$ DISPLAY ELEMENTS ["pre",][form][,"post"] DLE - - - - *$ DISPLAY LEVELS [f1],...[f6] - - - - DHL - - - - *$ DISPLAY LEVELS [level,]["pre",][format,]["post"] - - - * ~ DISPLAY NUMBER ["pre",][form][,"post"] - DNM - - - - *$ DISPLAY SUBPAGE [form] - - - - - - DSP - - - - *$ DISPLAY SUBTITLE ["pre"],["post"] - - - - - - - - ~ DISPLAY TITLE ["pre"],["post"] - - - - - - - - - ~ DO INDEX [title] - - - - - - - - DX - - - - *$ Print the index as an appendix APPENDIX: LIST OF COMMANDS (ALPHABETICAL) - 38 - ELLIPSES - - - - - - - - - - - ELL - - - - $ ~ Unspecified tabs are converted to ellipses ELSE aaaa Follows IF aaaa command ENABLE BAR n1,n2 - - - - - - - - EBB - - - - D Allow change bars in left margin n1,n2 are spaces before, after bar ENABLE ESCAPE - - - - - - - - - ESC - - - - D~ Allow control code output ENABLE FLAGS [flag] - - - - - - - EFL - - - - D~ Allow specified flag to be used ENABLE EQUATION n - - - - - - - - EEQ - - - - D~ Allow equation formatting ENABLE HYPHENATION - - - - - - - EHY - - - - D Allow hyphenation ENABLE INDEXING - - - - - - - - EIX - - - - D Entries will be made in index table ENABLE LEVELS [+-out],[+-toc] - - - - - - - - - - $ ~ Enables header levels for output and table of contents ENABLE NUMBERING - - - - - - - - ENMPG - - - $ ~ Page numbers are produced ENABLE NUMBERING CHAPTER - - - - - ENMCH - - - $ ~ Page numbers include chapter number (1-2) ENABLE ODD - - - - - - - - - - EOD - - - - ~ Chapters start only on odd page numbers ENABLE TABS - - - - - - - - - - ETB - - - - D~ Tabs are converted to multiple spaces ENABLE TOC - - - - - - - - - - ETC - - - - D Entries are made in table of contents file ENABLE OVERSTRIKING - - - - - - - EOV - - - - D The overstrike flag is obeyed ENABLE SUBSTITUTION - - - - - - - ESST - - - - D Text may be substituted for a defined label ENABLE UNCONDITIONAL - - - - - - - ENUNC - - - *$D~ Unconditional commands are obeyed and text is output ENABLE UNDERLINING - - - - - - - EUL - - - - D Text may be underlined END - Ends a feature END BAR - - - - - - - - - - - EB - - - - END CENTER - - - - - - - - - - ECN - - - - ~ END FOOTNOTE - - - - - - - - - EFN - - - - ENDIF aaaa END LIST [space] - - - - - - - - ELS - - - - *$ END LITERAL - - - - - - - - - - EL - - - - *$ END NOTE - - - - - - - - - - - EN - - - - *$ END RIGHT - - - - - - - - - - ER - - - - * ~ END SEPARATED EQUATION - - - - - - ESEQ - - - - D~ END SUBPAGE - - - - - - - - - - ES - - - - *$ END TEXT - - - - - - - - - - - ETX - - - - *$ ~ ENTRY index term - - - - - - - - Y - - - - - Defines index term without page number FIGURE [space] - - - - - - - - - FG - - - - *$ Skips lines independently of spacing. Works at top of page. APPENDIX: LIST OF COMMANDS (ALPHABETICAL) - 39 - FIGURE DEFERRED [space] - - - - - - FGD - - - - *$ Skips lines independently of spacing, where space permits. FILL - - - - - - - - - - - F - - - - - D Starts fill mode until NO FILL (normal mode of usage) FIRST TITLE - - - - - - - - - - FT - - - - $ Defines title to appear on all pages including first. FLAGS - Turns on and defines a special character to do something. FLAGS ACCEPT [new flag] - - - - - - FL ACCEPT - - $D FLAGS [ALL] - - - - - - - - - - FL [ALL] - - $ FLAGS BREAK [new flag] - - - - - - FL BREAK - - $ FLAGS CAPITALIZE [new flag] - - - - FL CAPITALIZE - $ FLAGS CONTROL [new flag] - - - - - FL CONTROL - - $D FLAGS ESCAPE [new flag] - - - - - - FL ESCAPE - - $ ~ FLAGS EQUATION - - - - - - - - - FL EQUATION - ~ FLAGS HYPHENATE [new flag] - - - - - FL HYPHENATE - $ FLAGS INDEX [new flag] - - - - - - FL INDEX - - $ FLAGS PERIOD [new flag] - - - - - - FL PERIOD - - $ FLAGS LOWERCASE [new flag] - - - - - FL LOWERCASE - $D FLAGS OVERSTRIKE [new flag] - - - - FL OVERSTRIKE - $ FLAGS SUBINDEX [new flag] - - - - - FL SUBINDEX - $ FLAGS SUBSTITUTE [new flag] - - - - FL SUBSTITUTE - $ FLAGS TAB [new flag] - - - - - - - FL TAB - - - $ ~ FLAGS UNDERLINE [new flag] - - - - - FL UNDERLINE - $D FLAGS UPPERCASE [new flag] - - - - - FL UPPERCASE - $D FLUSH - - - - - - - - - - - - - - - - - - * ~ Flushes out all deferred text FOOTNOTE - - - - - - - - - - - FN - - - - $ Start a footnote until END FOOTNOTE HALF SPACING [n] - - - - - - - - - - - - - - ~ Enable and define half spacing HEADERS [on] - - - - - - - - - HD [on] - - - $D Enable output of headers (title/subtitle) at top of page HEADER LEVEL [+-level] [title] - - - HL - - - - *$ Starts a numbered section in document HEADERS LOWER - - - - - - - - - - - - - - - $ HEADERS MIXED - - - - - - - - - - - - - - - $D HEADERS NO PAGE - - - - - - - - - - - - - - $ ~ HEADERS PAGE - - - - - - - - - - - - - - - $D~ HEADERS SPACING [spacing] - - - - - HDSP - - - - ~ Sets spacing between title and first line of text. HEADERS UPPER - - - - - - - - - - - - - - - $ IF aaaa Text following is output if aaaa is "true" until ELSE or ENDIF IF NOT aaaa Text following is not output if aaa is "false"until ELSE or ENDIF IMMEDIATE TEST PAGE n - - - - - - ITP - - - - $ ~ Starts new page if fewer than n line remain on page IMMEDIATE TEST TEXT n - - - - - - ITT - - - - $ ~ Starts new page if fewer than n lines of text can be put on page INDENT [-n] - - - - - - - - - - I - - - - - * Indent line from left margin APPENDIX: LIST OF COMMANDS (ALPHABETICAL) - 40 - INDENT LEVELS [-l],[-r] - - - - - - - - - - - - $ ~ Secify left, right indentation for header levels (sections) INDEX entry - - - - - - - - - - X - - - - - Specify term to be indexed with page number JUSTIFY - - - - - - - - - - - J - - - - - D Output text is left and right justified KEEP [LINES] - - - - - - - - - K - - - - - Blank lines in input also appear in output in NO FILL mode KEEP TABS - - - - - - - - - - - - - - - - ~ Tabs at beginning of lines are kept and not removed in FILL mode LAYOUT [code] [,spacing] - - - - - LO - - - - *$ Change overall page layout of title/subtite and page number (0=all at top 1-15=Header top,number bottom) ( 1=C,C 2=LR,C 3=L,C 4=L,R 5=C,R 6=C,LR) ( 7=LR,LR 8=L,LR 9=LR,R 10=C,L 11=LR,L 12=L,L) (13=R,L 14=R,C 15=R,LR 16=R,R) LEFT MARGIN [+-n] - - - - - - - - LM - - - - * Sets the left margin LIST [n] ["char"] - - - - - - - - LS - - - - *$ Begin a list of items separated by n blank lines until end list LIST ELEMENT [;]text - - - - - - - LE - - - - *$ Print current number in list LITERAL - - - - - - - - - - - LT - - - - * Text following this command appears in output exactly as typed un- til END LITERAL LOCK - - - - - - - - - - - - - - - - - - $ ~ Lock some parameters so they can not be changed LOWER CASE - - - - - - - - - - LC - - - - All text will be in same case as input NO - turns off selected features NO AUTOBREAK ["chars"] - - - - - - NAB - - - - $D~ NO AUTOHYPHENATE "chars" - - - - - NAH - - - - $ NO AUTOPARAGRAPH - - - - - - - - NAP - - - - $D NO AUTOSUBTITLE - - - - - - - - NAST - - - - $D NO AUTOTABLE - - - - - - - - - NAT NO AUTOTITLE - - - - - - - - - NATI - - - - $ ~ NO ELLIPSES - - - - - - - - - - NELL - - - - $D~ NO FILL - - - - - - - - - - - NF - - - - * NO FLAGS [flag name] - - - - - - - NFL - - - - $ NO HALF SPACING - - - - - - - - - - - - - - D~ NO HEADERS [on] - - - - - - - - NHD NO JUSTIFY - - - - - - - - - - NJ - - - - NO KEEP - - - - - - - - - - - NK - - - - D NO NUMBER - - - - - - - - - - NNM - - - - $ NO NUMBER CHAPTER - - - - - - - - - - - - - - $ ~ NO PAGING - - - - - - - - - - NPA - - - - $ NO PERIOD ["chars"] - - - - - - - NPR NO SPACE - - - - - - - - - - - NSP - - - - NO TITLE - - - - - - - - - - - - - - - - - $ ~ NO UNDERLINE "characters" - - - - - NUN - - - - ~ NO VARIANT aaaa - - - - - - - - - - - - - - ~ APPENDIX: LIST OF COMMANDS (ALPHABETICAL) - 41 - NOTE [;title] - - - - - - - - - N - - - - - *$ Starts an indented note until END NOTE NUMBER - Sets the new number NUMBER APPENDIX [+-n] - - - - - - NMAX - - - - $ NUMBER CHAPTER [+-n] - - - - - - - NMCH - - - - $D NUMBER ITEM [+-n] - - - - - - - - NMIT - - - - ~ NUMBER LEVEL [+-n1],....,[+-n6] - - - NMLV - - - - $ NUMBER LIST [+-n] - - - - - - - - NPLS - - - - $ NUMBER [PAGE] [+-n] - - - - - - - NMPG - - - - $D NUMBER SUBPAGE [+-n] - - - - - - - NMSPG - - - $ PAGE - - - - - - - - - - - - PG - - - - *$ Starts a new page PAGE EVEN - - - - - - - - - - PGE - - - - *$ ~ Starts a new even numbered page PAGE ODD - - - - - - - - - - - PGO - - - - *$ ~ Starts a new odd numbered page PAGE SIZE [+-h],[+-w],[+-l],[+-t],[s] - PS - - - - $ Sets page size and permanent margins PAGING - - - - - - - - - - - PA - - - - * D Text will be divided into pages PAPER SIZE [+-h],[+-w],[+-l],[+-t],[s] - PS - - - - $ Synonym for page size PARAGRAPH [-n],[v],[t],[b] - - - - - P - - - - - * Starts a new paragraph until command causing break (n=indent, v=skip, t=test, b=bottom test) PERIOD "characters" - - - - - - - PR - - - - $D Enables specified characters to end sentence (produce 2 spaces) PERMANENT FOOTNOTE - - - - - - - PFN - - - - $ ~ Starts a section of text to begin each footnote until END FOOTNOTE PRINT INDEX "entry" - - - - - - - PX - - - - *$ Prints the index and clear it RESET - Removes all entries in a table RESET ESCAPE - - - - - - - - - - - - - - - $ ~ RESET INDEX - - - - - - - - - - - - - - - - ~ RESET SUBSTITUTE - - - - - - - - - - - - - - $ ~ RESTORE STATUS - - - - - - - - - - - - - - - ~ Restores status saved by SAVE STATUS REQUIRE 'file spec' - - - - - - - REQ - - - - $ Input now is taken from specified file REQUIRE BINARY [spacing ]'file-spec' - REQ BIN - - - * ~ The specified file is transferred to output file RIGHT [-indent] - - - - - - - - R - - - - - *$ Line is right but not left justified RIGHT MARGIN [+-n] - - - - - - - RM - - - - * Set right margin RIGHT TEXT [-indent] - - - - - - - R TEXT - - - * ~ Section of text is right, but not left justified until END RIGHT SAVE CHAPTER - - - - - - - - - - - - - - - ~ Current status is restored at each CHAPTER command SAVE HEADER - - - - - - - - - - - - - - - - ~ Current status is restored at each page header APPENDIX: LIST OF COMMANDS (ALPHABETICAL) - 42 - SAVE LEVEL - - - - - - - - - - - - - - - - ~ Current status is restored at each HEADER LEVEL command SAVE STATUS - - - - - - - - - - - - - - - - ~ Current status is restored at each RESTORE command SEND PAGE TOC [n;]text - - - - - - - - - - - - ~ Text followd by page number will appear in table of contents SEND TOC [;]text - - - - - - - - STC - - - - Text will appear in table of contents SEPARATED EQUATION - - - - - - - SEQ - - - - ~ Begins separated equation mode until END SEPARATED EQUATION SET PARAGRAPH [-n],[v],[t],[b] - - - STP - - - - $ Sets paragraph params (n=indent, v=skip, t=test, b=bottom test) SKIP [lines] - - - - - - - - - S - - - - - * Skips lines depending on spacing except at top of page SPACING [s] - - - - - - - - - - SP - - - - $ Sets line spacing STYLE CHAPTER [n1],...[n5] - - - - - STCH - - - - $ ~ Changes style of first chapter page (1-3 = spacing, 4,5=indent (-1 centered,-2 right just) STYLE HEADERS [n1],...[n10] - - - - STHL - - - - *$ Changes style of header levels (sections) (line,CAPS,Cap,number,center,skip1,skip2,test,indent,[n.m]) SUBPAGE - - - - - - - - - - - SPG - - - - *$ Starts a subpage until END SUBPAGE SUBTITLE [subtitle] - - - - - - - ST - - - - $ Sets line of text to appear in subtitle TAB LEFT - - - - - - - - - - - TL - - - - $D~ Unspecified tabs left justify TAB PROPORTIONAL n,["ell"][R/C/L][+-n1],.. TABP - - - - $ ~ Sets up proportionally spaced tab stops TAB RIGHT - - - - - - - - - - TR - - - - $ ~ Unspecified tabs right justify TAB STOPS ["ell"][R/C/L]+n1,... - - - TS - - - - $ Sets up ellipses, justification and location of tab stops TEST PAGE n - - - - - - - - - - TP - - - - *$ Starts new page if fewer than n lines remain on this page TEST TEXT n - - - - - - - - - - TT - - - - *$ ~ New page if fewer than n lines of text may be output on this page TEXT - - - - - - - - - - - - TX - - - - *$ ~ Starts a block of text that may not be split between pages until TEXT, END TEXT, or PAGE TEXT DEFERRED - - - - - - - - - TXD - - - - *$ ~ Starts a block of text to appear on a later page until TEXT, END TEXT, or PAGE TITLE [title] - - - - - - - - - T - - - - - $D Sets line of text to appear as page title TOP MARGIN [+-n] - - - - - - - - TM - - - - *$ ~ Sets top margin for the next page UNDERLINE "characters" - - - - - - UN - - - - ~ The specified characters may be underlined UNDERLINE SPACES - - - - - - - - - - - - - - ~ Spaces may be underlined APPENDIX: LIST OF COMMANDS (ALPHABETICAL) - 43 - UNDERLINE NO SPACES - - - - - - - - - - - - - D~ Disables underlining of spaces UPPER CASE - - - - - - - - - - UC - - - - D All text will be output in upper case VARIABLE SPACING - - - - - - - - VARSP - - - * ~ Enable variable spacing VARIANT aaaa - - - - - - - - - - - - - - - ~ Sets aaaa to be true until NO VARIANT