PageRenderTime 167ms CodeModel.GetById 148ms app.highlight 6ms RepoModel.GetById 1ms app.codeStats 0ms

/contrib/groff/contrib/mm/groff_mm.man

https://bitbucket.org/freebsd/freebsd-head/
Unknown | 2104 lines | 2100 code | 4 blank | 0 comment | 0 complexity | 9c8ff93217b5f40186c77e6b9ce0b975 MD5 | raw file

Large files files are truncated, but you can click here to view the full file

   1.\"
   2.\" $Id: groff_mm.man,v 2.13 2004/07/03 12:46:56 wlemb Exp $
   3.\"
   4.de T2
   5.if t .ne 2v
   6.ti -.5i
   7\\$1
   8.sp -1
   9..
  10.
  11.de T3
  12.if t .ne 2v
  13.ti -.5i
  14\fB\\$1\fP
  15.br
  16..
  17.
  18.TH GROFF_MM @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@"
  19.SH NAME
  20groff_mm \- groff mm macros
  21.SH SYNOPSIS
  22.B groff
  23.B \-m@TMAC_M_PREFIX@m
  24[
  25.IR options .\|.\|.
  26]
  27[
  28.IR files .\|.\|.
  29]
  30.SH DESCRIPTION
  31The groff mm macros are intended to be compatible with the DWB mm macros
  32with the following limitations:
  33.TP
  34.B \(bu
  35no Bell Labs localisms implemented.
  36.TP
  37.B \(bu
  38the macros OK and PM are not implemented.
  39.TP
  40.B \(bu
  41groff mm does not support cut marks
  42.LP
  43\fBm@TMAC_M_PREFIX@m\fP is intended to be international.
  44Therefore it is 
  45possible to write short national macrofiles which change all
  46english text to the preferred language.
  47Use \fBm@TMAC_M_PREFIX@mse\fP as an example.
  48.\"########################################################################
  49.LP
  50A file called \fBlocale\fP or \fIlang\fP\fB_locale\fP is read
  51after the initiation of the global variables.
  52It is therefore
  53possible to localize the macros with companyname and so on.
  54.sp
  55In this manual square brackets is used to show optional arguments.
  56.sp 3
  57\fBNumber registers and strings\fP
  58.br
  59Many macros can be controlled by number registers and strings.
  60A number register is assigned with the \fBnr\fP command:
  61.br
  62\fB\&.nr\fP \fIXXX\fP \fI[+-]n [i]\fP
  63.br
  64\fBXXX\fP is the name of the register, \fBn\fP is the value to
  65be assigned, and \fBi\fP is increment value for auto-increment.
  66\fBn\fP can have a plus or minus sign as prefix if an increment
  67or decrement of the current value is wanted.
  68(Auto-increment or decrement
  69occurs if the number register is used with a plus or minus sign,
  70\fB\en+[XXX]\fP or \fB\en-[XXX]\fP.)
  71.sp
  72Strings is defined with \fBds\fP.
  73.br
  74\fB\&.ds\fP \fIYYY string\fP
  75.br
  76The string is assigned everything to the end of the line, even blanks.
  77Initial blanks in \fIstring\fP should be prefixed with
  78a double-quote.
  79(Strings are used in the text as \fB\e*[YYY]\fP.)
  80.sp
  81\fBSpecial formatting of number registers\fP
  82.br
  83A number register is printed with normal digits if no format has been
  84given.
  85Set the format with \fBaf\fP:
  86.br
  87\fB\&.af\fP \fIR c\fP
  88.br
  89\fIR\fP is the name of the register, \fIc\fP is the format.
  90.in +.5i
  91.T2 \fBForm\fP
  92\fBSequence\fP
  93.T2 1
  940, 1, 2, 3, ...
  95.T2 001
  96000, 001, 002, 003, ...
  97.T2 i
  980, i, ii, iii, iv, ...
  99.T2 I
 1000, I, II, III, IV, ...
 101.T2 a
 1020, a, b, c, ..., z, aa, ab, ...
 103.T2 A
 1040, A, B, C, ..., Z, AA, AB, ...
 105.in
 106
 107.LP
 108\fBMacros:\fP
 109.TP
 110.B ")E level text"
 111Adds \fBtext\fP (heading-text) to the table of contents
 112with \fBlevel\fP either 0
 113or between 1-7.
 114See also \fB.H\fP.
 115This macro is used for customized
 116table of contents.
 117.TP
 118.B "1C [1]"
 119Begin one column processing.
 120An \fB1\fP as argument disables the page-break.
 121Use wide footnotes, small footnotes may be overprinted.
 122.TP
 123.B 2C
 124Begin two column processing.
 125Splits the page in two columns.
 126It is
 127a special case of \fBMC\fP.
 128See also \fB1C\fP.
 129.TP
 130.B AE
 131Abstract end, see \fBAS\fP.
 132.TP
 133.B "AF [name of firm]"
 134Authors firm, should be called before \fBAU\fP, see also \fBCOVER\fP.
 135.TP
 136.B "AL [type [text-indent [1]]]"
 137Start autoincrement list.
 138Items are numbered beginning on one.
 139The \fItype\fP argument controls the type of numbers.
 140.in +.5i
 141.T2 Arg
 142Description
 143.T2 1
 144Arabic (the default)
 145.T2 A
 146Upper-case letters (A-Z)
 147.T2 a
 148Lower-case letters (a-z)
 149.T2 I
 150Upper-case roman
 151.T2 i
 152Lower-case roman
 153.in
 154\fIText-indent\fP sets the indent and overrides \fBLi\fP.
 155A third argument will prohibit printing of a blank line before each
 156item.
 157.TP
 158.B "APP name text"
 159Begin an appendix with name \fIname\fP.
 160Automatic naming occurs if
 161\fIname\fP is "".
 162The appendixes starts with \fBA\fP if auto is used.
 163An new page is ejected, and a header is also produced if the number
 164variable \fBAph\fP is non-zero.
 165This is the default.
 166The appendix always appear in the 'List of contents' with correct
 167pagenumber.
 168The name \fIAPPENDIX\fP can be changed by setting
 169the string \fBApp\fP to the desired text.
 170The string \fBApptxt\fP contains the current appendix text.
 171.TP
 172.B "APPSK name pages text"
 173Same as \fB.APP\fP, but the pagenr is incremented with \fIpages\fP.
 174This is used when diagrams or other non-formatted documents are
 175included as appendixes.
 176.TP
 177.B "AS [arg [indent]]"
 178Abstract start.
 179Indent is specified in 'ens', but scaling is allowed.
 180Argument \fIarg\fP controls where the abstract is printed.
 181.in +.5i
 182.T2 Arg
 183Placement
 184.T2 0
 185Abstract will be printed on page 1 and on the cover sheet if
 186used in the released-paper style (\fBMT 4\fP), otherwise
 187it will be printed on page 1 without a cover sheet.
 188.T2 1
 189Abstract will only be printed on the cover sheet (\fBMT 4\fP only).
 190.T2 2
 191Abstract will be printed only on the cover sheet (other than \fBMT 4\fP only).
 192The cover sheet is printed without need for \fBCS\fP.
 193.in
 194Abstract is not printed at all in external letters (\fBMT 5\fP).
 195The \fIindent\fP controls the indentation of both margins, otherwise
 196will normal text indent be used.
 197.TP
 198.B "AST [title]"
 199Abstract title.
 200Default is \fBABSTRACT\fP.
 201Sets the text above the abstract text.
 202.TP
 203.B "AT title1 [title2 ...]"
 204Authors title.
 205\fBAT\fP must appear just after each \fBAU\fP.
 206The title will show up after the name in the signature block.
 207.TP
 208.B "AU [name [initials [loc [dept [ext [room [arg [arg [arg]]]]]]]]]"
 209Author information, specifies the author of the memo or paper, and
 210will be printed on the cover sheet and on other similar places.
 211\fBAU\fP must not appear before \fBTL\fP.
 212The author information
 213can contain initials, location, department, telephone extension,
 214room number or name and up to three extra arguments.
 215.TP
 216.B "AV [name [1]]"
 217Approval signature, generates an approval line with place for
 218signature and date.
 219The string \fBAPPROVED:\fP can be changed
 220with variable \fBLetapp\fP, and the string \fBDate\fP in \fBLetdate\fP.
 221.TP
 222.B "AVL [name]"
 223Letter signature, generates a line with place for signature.
 224.TP
 225.B "B [bold-text [prev-font-text [bold...]]]"
 226Begin boldface.
 227No limit on the number of arguments.
 228All arguments will be concatenated to one word, the first, third and so
 229on will be printed in boldface.
 230.TP
 231.B B1
 232Begin box (as the ms macro).
 233Draws a box around the text.
 234The text will be indented one character,
 235and the right margin will be one character shorter.
 236.TP
 237.B B2
 238End box.
 239Finish the box started by \fBB1\fP.
 240.TP
 241.B BE
 242End bottom block, see \fBBS\fP.
 243.TP
 244.B "BI [bold-text [italic-text [bold-text [...]]]]"
 245Bold-italic.
 246No limit on the number of arguments, see \fBB\fP.
 247.TP
 248.B "BL [text-indent [1]]"
 249Start bullet list, initialize a list with a bullet and a space
 250in the beginning of each list item (see \fBLI\fP).
 251\fIText-indent\fP
 252overrides the default indentation of the list items set by
 253number register \fBPi\fP.
 254A third argument will prohibit printing of a blank line before each
 255item.
 256.TP
 257.B "BR [bold-text [roman-text [bold-text [...]]]]"
 258Bold-roman.
 259No limit on the number of arguments.
 260.TP
 261.B BS
 262Bottom block start.
 263Begins the definition of a text block which is
 264printed at the bottom of each page.
 265Block ends with \fBBE\fP.
 266.TP
 267.B "BVL text-indent [mark-indent [1]]"
 268Start of 
 269broken variable-item list.
 270Broken variable-item list has no fixed mark, it assumes that
 271every \fBLI\fP has a mark instead.
 272The text will always begin at the next line after the mark.
 273\fIText-indent\fP sets the indent to the text, and \fImark-indent\fP
 274the distance from the current indent to the mark.
 275A third argument will prohibit printing of a blank line before each
 276item.
 277.TP
 278.B "COVER [arg]"
 279\&\fBCOVER\fP begins a coversheet definition.
 280It is important
 281that \fB.COVER\fP appears before any normal text.
 282\&\fB.COVER\fP uses \fIarg\fP to build the filename 
 283@TMAC_MDIR@/\fIarg\fP.cov.
 284Therefore it is possible to create unlimited
 285types of coversheets.
 286\fIms.cov\fP is supposed to look like the \fBms\fP coversheet.
 287\&\fB.COVER\fP requires a \fB.COVEND\fP at the end of the coverdefinition.
 288Always use this order of the covermacros:
 289.nf
 290\&.COVER
 291\&.TL
 292\&.AF
 293\&.AU
 294\&.AT
 295\&.AS
 296\&.AE
 297\&.COVEND
 298.fi
 299However, only \fB.TL\fP and \fB.AU\fP are required.
 300.TP
 301.B COVEND
 302This finish the cover description and prints the cover-page.
 303It is defined in the cover file.
 304.TP
 305.B DE
 306Display end.
 307Ends a block of text, display, that begins
 308with \fBDS\fP or \fBDF\fP.
 309.TP
 310.B "DF [format [fill [rindent]]]"
 311Begin floating display (no nesting allowed).
 312A floating display is saved in a queue and is printed in the
 313order entered.
 314\fIFormat\fP, \fIfill\fP and \fIrindent\fP is the same
 315as in \fBDS\fP.
 316Floating displays are controlled by the two number registers \fBDe\fP
 317and \fBDf\fP.
 318.sp
 319\fBDe register\fP
 320.in +.5i
 321.T2 0
 322Nothing special, this is the default.
 323.T2 1
 324A page eject will occur after each printed display, giving only
 325one display per page and no text following it.
 326.in
 327.sp
 328\fBDf register\fP
 329.in +.5i
 330.T2 0
 331Displays are printed at the end of each section (when section-page
 332numbering is active) or at the end of the document.
 333.T2 1
 334A new display will be printed on the current page if there is enough
 335space, otherwise it will be printed at the end of the document.
 336.T2 2
 337One display will be printed at the top of each page or column
 338(in multi-column mode).
 339.T2 3
 340Print one display if there is enough space for it, otherwise it will
 341be printed at the top of the next page or column.
 342.T2 4
 343Print as many displays that will fit in a new page or column.
 344A page break will occur between each display if \fBDe\fP is not zero.
 345.T2 5
 346Fill the current page with displays and the rest beginning at a new page
 347or column.
 348(This is the default.)
 349A page break will occur between each display
 350if \fBDe\fP is not zero.
 351.in
 352.TP
 353.B "DL [text-indent [1 [1]]]"
 354Dash list start.
 355Begins a list where each item is printed
 356after a dash.
 357\fIText-indent\fP changes the default indentation
 358of the list items set by
 359number register \fBPi\fP.
 360A second argument prevents the empty line between each list item
 361to be printed.
 362See \fBLI\fP.
 363A third argument will prohibit printing of a blank line before each
 364item.
 365.TP
 366.B "DS [format [fill [rindent]]]"
 367Static display start.
 368Begins collection of text until \fBDE\fP.
 369The text is printed together on the same page, unless it is longer
 370than the height of the page.
 371\fBDS\fP can be nested to a unlimited depth (reasonably :-).
 372.sp
 373\fBformat\fP
 374.in +.5i
 375.ds x "
 376.T2 """"""
 377No indentation.
 378.T2 none
 379No indentation.
 380.T2 L
 381No indentation.
 382.T2 I
 383Indent text with the value of number register \fBSi\fP.
 384.T2 C
 385Center each line
 386.T2 CB
 387Center the whole display as a block.
 388.T2 R
 389Right adjust the lines.
 390.T2 RB
 391Right adjust the whole display as a block
 392.in
 393.sp
 394L, I, C and CB can also be specified as 0, 1, 2 or 3 for compatibility
 395reasons.
 396(Don't use it.\ :-)
 397.sp
 398\fBfill\fP
 399.in +.5i
 400.T2 """"""
 401Line-filling turned off.
 402.T2 none
 403Line-filling turned off.
 404.T2 N
 405Line-filling turned off.
 406.T2 F
 407Line-filling turned on.
 408.in
 409.sp
 410N and F can also be specified as 0 or 1.
 411An empty line will normally be printed before and after the
 412display.
 413Setting number register \fBDs\fP to 0 will prevent this.
 414\fIRindent\fP shortens the line length by that amount.
 415.TP
 416.B "EC [title [override [flag [refname]]]]"
 417Equation title.
 418Sets a title for an equation.
 419The \fIoverride\fP argument
 420change the numbering.
 421.sp
 422\fBflag\fP
 423.in +.5i
 424.T2 none
 425\fIoverride\fP is a prefix to the number.
 426.T2 0
 427\fIoverride\fP is a prefix to the number.
 428.T2 1
 429\fIoverride\fP is a suffix to the number.
 430.T2 2
 431\fIoverride\fP replaces the number.
 432.in
 433\fBEC\fP uses the number register \fBEc\fP as counter.
 434It is possible to use \fB.af\fP to change the format of the number.
 435If number register \fBOf\fP is 1, then the format of title
 436will use a dash instead of a dot after the number.
 437.br
 438The string \fBLe\fP controls the title of the
 439List of Equations, default is \fILIST OF EQUATIONS\fP.
 440The List of Equations will only be printed if number register \fBLe\fP
 441is 1, default 0.
 442The string \fBLiec\fP contains the word \fIEquation\fP, wich
 443is printed before the number.
 444If \fIrefname\fP is used, then the equation number is saved with
 445\&\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
 446.br
 447Special handling of the title will occur if
 448\fBEC\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
 449affected by the format of \fBDS\fP.
 450.TP
 451.B "EF [arg]"
 452Even-page footer, printed just above the normal page footer
 453on even pages, see \fBPF\fP.
 454.TP
 455.B "EH [arg]"
 456Even-page header, printed just below the normal page header
 457on even pages, see \fBPH\fP.
 458.TP
 459.B EN
 460Equation end, see \fBEQ\fP.
 461.TP
 462.B EOP
 463End of page user-defined macro.
 464This macro will be called
 465instead of the normal printing of the footer.
 466The macro
 467will be executed in a separate environment, without any
 468trap active.
 469See \fBTP\fP.
 470.sp
 471\fBStrings available to EOP\fP
 472.in +.5i
 473.T2 EOPf
 474Argument from \fBPF\fP.
 475.T2 EOPef
 476Argument from \fBEF\fP.
 477.T2 EOPof
 478Argument from \fBOF\fP.
 479.in
 480.TP
 481.B "EPIC [-L] width height [name]"
 482\fBEPIC\fP draws a box with the given \fIwidth\fP and \fIheight\fP, it will
 483also print the text \fIname\fP or a default string if
 484\fIname\fP is not specified..
 485This is used to include external pictures, just give the size
 486of the picture.
 487\fB-L\fP will leftadjust the picture, the default is to center adjust.
 488See \fBPIC\fP
 489.TP
 490.B "EQ [label]"
 491Equation start.
 492\fBEQ\fP/\fBEN\fP are the delimiters for equations written for \fBeqn\fP.
 493\fBEQ\fP/\fBEN\fP must be inside a \fBDS\fP/\fBDE\fP-pair, except
 494when \fBEQ\fP is only used to set options in \fBeqn\fP.
 495The \fIlabel\fP will appear at the right margin of the equation, unless
 496number register \fBEq\fP is\ 1.
 497Then the label will appear at the
 498left margin.
 499.TP
 500.B "EX [title [override [flag [refname]]]]"
 501Exhibit title, arguments are the same as for \fBEC\fP.
 502\fBEX\fP uses the number register \fBEx\fP as counter.
 503The string \fBLx\fP controls the title of the
 504List of Exhibits, default is \fILIST OF EXHIBITS\fP.
 505The List of Exhibits will only be printed if number register \fBLx\fP
 506is 1, default 1.
 507The string \fBLiex\fP contains the word \fIExhibit\fP, which
 508is printed before the number.
 509If \fIrefname\fP is used, then the exhibit number is saved with
 510\&\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
 511.br
 512Special handling of the title will occur if
 513\fBEX\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
 514affected by the format of \fBDS\fP.
 515.TP
 516.B "FC [closing]"
 517Prints \fIYours\ very\ truly,\fP as a formal closing of a letter or
 518memorandum.
 519The argument replaces the defualt string.
 520The default is stored in string variable \fBLetfc\fP.
 521.TP
 522.B "FD [arg [1]]"
 523Footnote default format.
 524Controls the hyphenation (hyphen), right margin justification (adjust),
 525indentation of footnote text (indent).
 526It can also change the label
 527justification (ljust).
 528.sp
 529.if t .ne 14v
 530.nf
 531.ta .5i +.8i +.8i +.8i +.8i
 532\fBarg	hyphen	adjust	indent	ljust\fP
 5330	no	yes	yes	left
 5341	yes	yes	yes	left
 5352	no	no	yes	left
 5363	yes	no	yes	left
 5374	no	yes	no	left
 5385	yes	yes	no	left
 5396	no	no	no	left
 5407	yes	no	no	left
 5418	no	yes	yes	right
 5429	yes	yes	yes	right
 54310	no	no	yes	right
 54411	yes	no	yes	right
 545.sp
 546.fi
 547.DT
 548Argument greater than or equal to 11 is considered as arg 0.
 549Default for m@TMAC_M_PREFIX@m is 10.
 550.TP
 551.B FE
 552Footnote end.
 553.TP
 554.B "FG [title [override [flag [refname]]]]"
 555Figure title, arguments are the same as for \fBEC\fP.
 556\fBFG\fP uses the number register \fBFg\fP as counter.
 557The string \fBLf\fP controls the title of the
 558List of Figures, default is \fILIST OF FIGURES\fP.
 559The List of Figures will only be printed if number register \fBLf\fP
 560is 1, default 1.
 561The string \fBLifg\fP contains the word \fIFigure\fP, wich
 562is printed before the number.
 563If \fIrefname\fP is used, then the figure number is saved with
 564\&\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
 565.br
 566Special handling of the title will occur if
 567\fBFG\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
 568affected by the format of \fBDS\fP.
 569.TP
 570.B "FS [label]"
 571Footnote start.
 572The footnote is ended by \fBFE\fP.
 573Footnotes is normally automatically
 574numbered, the number is available in string \fBF\fP.
 575Just add \fB\e*F\fP in the text.
 576By adding \fIlabel\fP, it is possible
 577to have other number or names on the footnotes.
 578Footnotes in displays is now possible.
 579An empty line separates footnotes, the height of the line
 580is controlled by number register \fBFs\fP, default value is 1.
 581.TP
 582.B "GETHN refname [varname]"
 583Includes the headernumber where the corresponding \fBSETR\fP \fIrefname\fP
 584was placed.
 585Will be X.X.X. in pass\ 1.
 586See \fBINITR\fP.
 587If \fIvarname\fP is used, \fBGETHN\fP sets the stringvariable \fIvarname\fP to the 
 588headernumber.
 589.TP
 590.B "GETPN refname [varname]"
 591Includes the pagenumber where the corresponding \fBSETR\fP \fIrefname\fP
 592was placed.
 593Will be 9999 in pass\ 1.
 594See \fBINITR\fP.
 595If \fIvarname\fP is used, \fBGETPN\fP sets the stringvariable \fIvarname\fP
 596to the pagenumber.
 597.TP
 598.B "GETR refname"
 599Combines \fBGETHN\fP and \fBGETPN\fP with the text 'chapter' and ', page'.
 600The string \fIQrf\fP contains the text for reference:
 601.ti +.5i
 602\&.ds Qrf See chapter \e\e*[Qrfh], page \e\e*[Qrfp].
 603.br
 604\fIQrf\fP may be changed to support other languages.
 605Strings \fIQrfh\fP and \fIQrfp\fP are set by \fBGETR\fP
 606and contains the page and headernumber.
 607.TP
 608.B "GETST refname [varname]"
 609Includes the string saved with the second argument to \fB.SETR\fP.
 610Will be dummystring in pass 1.
 611If varname is used, \fBGETST\fP sets the stringvariable \fIvarname\fP to the 
 612saved string.
 613See \fBINITR\fP.
 614.TP
 615.B "H level [heading-text [heading-suffix]]"
 616Numbered section heading.
 617Section headers can have a level between 1 and 14, level 1 is the
 618top level.
 619The text is given in \fIheading-text\fP, and must be
 620surrounded by double quotes if it contains spaces.
 621\fBHeading-suffix\fP is added to the header in the text but not in
 622the table of contents.
 623This is normally used for footnote marks
 624and similar things.
 625Don't use \fB\e*F\fP in \fIheading-suffix\fP, it won't
 626work.
 627A manual label must be used, see \fBFS\fP.
 628.sp
 629An eventual paragraph, \fBP\fP, directly after \fBH\fP will be
 630ignored, \fBH\fP is taking care of spacing and indentation.
 631.sp
 632\fBPage ejection before heading\fP
 633.br
 634Number register \fBEj\fP controls page ejection before the heading.
 635Normally, a level one heading gets two blank lines before it, higher levels
 636gets only one.
 637A new page is ejected before each
 638first-level heading if number register \fBEj\fP is 1.
 639All levels below or equal the value of \fBEj\fP gets a new page.
 640Default value for \fBEj\fP is 0.
 641.sp
 642\fBHeading break level\fP
 643.br
 644A line break occurs after the heading if the heading level is less
 645or equal to number register \fBHb\fP.
 646Default value 2.
 647.sp
 648\fBHeading space level\fP
 649.br
 650A blank line is inserted after the heading if the heading level is less
 651or equal to number register \fBHs\fP.
 652Default value 2.
 653.sp
 654Text will follow the heading on the same line if the level is greater
 655than both \fBHb\fP and \fBHs\fP.
 656.sp
 657\fBPost-heading indent\fP
 658.br
 659Indentation of the text after the heading is controlled by number
 660register \fBHi\fP, default value 0.
 661.sp
 662\fBHi\fP
 663.in +.5i
 664.T2 0
 665The text will be left-justified.
 666.T2 1
 667Indentation of the text will follow the value of number register \fBPt\fP,
 668see \fBP\fP.
 669.T2 2
 670The text will be lined up with the first word of the heading.
 671.in
 672.sp
 673\fBCentered section headings\fP
 674.br
 675All headings whose level is equal or below number register \fBHc\fP
 676and also less than or equal to \fBHb\fP or \fBHs\fP
 677is centerered.
 678.sp
 679\fBFont control of the heading\fP
 680.br
 681The font of each heading level is controlled by string \fBHF\fP.
 682It contains a fontnumber or fontname for each level.
 683Default
 684is \fB2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\fP (all headings in italic).
 685Could also be written as \fBI\ I\ I\ I\ I\ I\ I\ I\ I\ I\ I\ I\ I\ I\fP.
 686Note that some other implementations use \fB3\ 3\ 2\ 2\ 2\ 2\ 2\fP as the
 687default value.
 688All omitted values are presumed to be a 1.
 689.sp
 690\fBPoint size control\fP.
 691.br
 692String \fBHP\fP controls the pointsize of each heading, in the
 693same way as \fBHF\fP controls the font.
 694A value of 0 selects the default point size.
 695Default value is \fB0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\fP.
 696Beware that only the
 697point size changes, not the vertical size.
 698That can be controlled by the user specified macro \fBHX\fP and/or
 699\fBHZ\fP.
 700.sp
 701\fBHeading counters\fP
 702.br
 703Fourteen number registers, named \fBH1\fP thru \fBH14\fP contains
 704the counter for each heading level.
 705The values are printed using arabic numerals, this can be changed
 706with the macro \fBHM\fP (see below).
 707All marks are concatenated before printing.
 708To avoid this, set
 709number register \fBHt\fP to\ 1.
 710That will only print the current
 711heading counter at each heading.
 712.sp
 713\fBAutomatic table of contents\fP
 714.br
 715All headings whose level is equal or below number register \fBCl\fP
 716is saved to be printed in the table of contents.
 717Default value is\ 2.
 718.sp
 719\fBSpecial control of the heading, user-defined macros\fP.
 720.br
 721These macros can be defined by the user to get a finer control
 722of vertical spacing, fonts or other features.
 723Argument \fIlevel\fP is the level-argument to \fBH\fP, but
 7240 for unnumbered headings (see \fBHU\fP).
 725Argument \fIrlevel\fP is the real level, it is
 726set to number register \fBHu\fP for unnumbered headings.
 727Argument \fIheading-text\fP is the text argument to \fBH\fP and \fBHU\fP.
 728.sp
 729\fBHX\ \fP\fIlevel\ rlevel\ heading-text\fP
 730.br
 731\fBHX\fP is called just before the printing of the heading.
 732The following register is available for \fBHX\fP.
 733\fBHX\fP may alter \fB}0\fP, \fB}2\fP and \fB;3\fP.
 734.in +.5i
 735.T3 "string }0"
 736Contains the heading mark plus two spaces if \fIrlevel\fP is non-zero,
 737otherwise empty.
 738.T3 "register ;0"
 739Contains the position of the text after the heading.
 7400 means that the text should follow the heading on the same line, 1
 741means that a line break should occur before the text and
 7422 means that a blank line should separate the heading and the text.
 743.T3 "string }2"
 744Contains two spaces if register \fB;0\fP is\ 0.
 745It is used to
 746separate the heading from the text.
 747The string
 748is empty if \fB;0\fP is non-zero.
 749.T3 "register ;3"
 750Contains the needed space in units after the heading.
 751Default is 2v.
 752
 753Can be used to change things like numbering (\fB}0\fP),
 754vertical spacing (\fB}2\fP)
 755and the needed space after the heading.
 756.in
 757.sp
 758\fBHY\ \fP\fIdlevel\ rlevel\ heading-text\fP
 759.br
 760\fBHY\fP is called after size and font calculations and
 761might be used to change indentation.
 762.sp
 763\fBHZ\ \fP\fIdlevel\ rlevel\ heading-text\fP
 764.br
 765\fBHZ\fP is called after the printing of the heading, just before
 766\fBH\fP or \fBHU\fP exits.
 767Could be used to change the page header according to the section heading.
 768.TP
 769.B "HC [hyphenation-character]"
 770Set hyphenation character.
 771Default value is \e%.
 772Resets to the default if called without argument.
 773Hyphenation can be turned off by setting number
 774register \fBHy\fP to 0 in the beginning of the file.
 775.TP
 776.B "HM [arg1 [arg2 [... [arg14]]]]"
 777Heading mark style.
 778Controls the type of marking for printing of the heading counters.
 779Default is 1 for all levels.
 780.sp
 781\fBArgument\fP
 782.in +.5i
 783.T2 1
 784Arabic numerals.
 785.T2 0001
 786Arabic numerals with leading zeroes, one or more.
 787.T2 A
 788Upper-case alphabetic
 789.T2 a
 790Lower-case alphabetic
 791.T2 I
 792Upper-case roman numerals
 793.T2 i
 794lower-case roman numerals
 795.T2 \fIempty\fP
 796Arabic numerals.
 797.in
 798.TP
 799.B "HU heading-text"
 800Unnumbered section header.
 801\fBHU\fP behavies like \fBH\fP at the level in number register \fBHu\fP.
 802See \fBH\fP.
 803.TP
 804.B "HX dlevel rlevel heading-text"
 805Userdefined heading exit.
 806Called just before printing the header.
 807See \fBH\fP.
 808.TP
 809.B "HY dlevel rlevel heading-text"
 810Userdefined heading exit.
 811Called just before printing the header.
 812See \fBH\fP.
 813.TP
 814.B "HZ dlevel rlevel heading-text"
 815Userdefined heading exit.
 816Called just after printing the header.
 817See \fBH\fP.
 818.TP
 819.B "I [italic-text [prev-font-text [italic-text [...]]]]"
 820Italic.
 821Changes the font to italic if called without arguments.
 822With one argument it will set the word in italic.
 823With two argument it will concatenate them and set the first
 824word in italic and the second in the previous font.
 825There is no limit on the number of argument, all will be concatenated.
 826.TP
 827.B "IA [addressee-name [title]]"
 828Begins specification of the addressee and addressee's address in
 829letter style.
 830Several names can be specified with empty \fBIA\fP/\fBIE\fP-pairs, but
 831only one address.
 832See \fBLT\fP.
 833.TP
 834.B "IB [italic-text [bold-text [italic-text [...]]]]"
 835Italic-bold.
 836Even arguments is printed in italic, odd in boldface.
 837See \fBI\fP.
 838.TP
 839.B IE
 840Ends the address-specification after \fPIA\fP.
 841.TP
 842.B "INITI type filename [macro]"
 843Initialize the new index system, sets the filename to collect
 844index lines in with \fBIND\fP.
 845Argument \fItype\fP selects
 846the type of index, page number, header marks or both.
 847The default is \fIN\fP.
 848
 849It is also possible to create a macro that is responsible
 850for formatting each row.
 851Add the name of the macro as argument\ 3.
 852The macro will be called with the index as argument(s).
 853.sp
 854\fBtype\fP
 855.in +.5i
 856.T2 N
 857Page numbers
 858.T2 H
 859Header marks
 860.T2 B
 861Both page numbers and header marks, tab separated
 862.in
 863.TP
 864.B "INITR filename"
 865Initialize the refencemacros.
 866References will be written to stderr and is supposed to
 867be written to \fIfilename.qrf\fP. 
 868Requires two passes with groff, this is handled by a
 869separate program called \fBmmroff\fP, the reason is that
 870groff is often installed without the unsafe operations that
 871\fBINITR\fP requiered.
 872The first pass looks for references and the second one includes them.
 873\fBINITR\fP can be used several times, but it is only the first
 874occurrence of \fBINITR\fP that is active.
 875
 876See also \fBSETR\fP, \fBGETPN\fP and \fBGETHN\fP.
 877.TP
 878.B "IND arg1 [arg2 [...]]"
 879\fBIND\fP writes a line in the index file selected by \fBINITI\fP
 880with all arguments and the page number or header mark separated by tabs.
 881.in +.5i
 882\fBExamples\fP
 883.br
 884arg1\etpage number
 885.br
 886arg1\etarg2\etpage number
 887.br
 888arg1\etheader mark
 889.br
 890arg1\etpage number\etheader mark
 891.in
 892.TP
 893.B "INDP"
 894\fBINDP\fP prints the index by running the command specified
 895by string variable \fBIndcmd\fP, normally \fIsort\ -t\et\fP.
 896\fBINDP\fP reads the output from the command to form
 897the index, normally in two columns (can be changed by defining \fBTYIND\fP).
 898The index is printed with string variable \fBIndex\fP as header,
 899default is \fBINDEX\fP.
 900One-column processing is
 901returned after the list.
 902\fBINDP\fP will call the
 903user-defined macros \fBTXIND\fP, \fBTYIND\fP and \fBTZIND\fP if defined.
 904\fBTXIND\fP is called before printing \fBINDEX\fP, \fBTYIND\fP
 905is called instead of printing \fBINDEX\fP.
 906\fBTZIND\fP is called
 907after the printing and should take care of restoring to normal
 908operation again.
 909.TP
 910.B "ISODATE [0]"
 911\fBISODATE\fP changes the predefined date string in \fBDT\fP to
 912ISO-format, ie YYYY-MM-DD.
 913This can also be done by
 914adding \fB-rIso=1\fP on the command line.
 915Reverts to old date format if argument is \fB0\fP.
 916.TP
 917.B "IR [italic-text [roman-text [italic-text [...]]]]"
 918Italic-roman.
 919Even arguments is printed in italic, odd in roman.
 920See \fBI\fP.
 921.TP
 922.B "LB text-indent mark-indent pad type [mark [LI-space [LB-space]]]"
 923List begin macro.
 924This is the common macro used for all lists.
 925\fIText-indent\fP is the number of spaces to indent the text from the
 926current indent.
 927.sp
 928\fIPad\fP and \fImark-indent\fP controls where to put the mark.
 929The mark is placed within the mark area, and \fImark-indent\fP
 930sets the number of spaces before this area.
 931It is normally\ 0.
 932The mark area ends where the text begins.
 933The start of the text
 934is still controlled by \fItext-indent\fP.
 935.sp
 936The mark is left justified whitin the mark area if \fIpad\fP is 0.
 937If \fIpad\fP is greater than 0, then \fImark-indent\fP is ignored, and
 938the mark is placed \fIpad\fP spaces before the text.
 939This will right justify the mark.
 940.sp
 941If \fItype\fP is 0 the list will have either a hanging indent or, if
 942argument \fImark\fP is given, the string \fImark\fP as mark.
 943.sp
 944If \fItype\fP is greater than 0 automatic numbering will occur, arabic
 945if \fImark\fP is empty.
 946\fIMark\fP can then be any of \fB1\fP, \fBA\fP,
 947\fBa\fP, \fBI\fP or \fBi\fP.
 948.sp
 949\fIType\fP selects one of six possible ways to display the mark.
 950.br
 951\fBtype\fP
 952.in +.6i
 953.T2 1
 954x.
 955.T2 2
 956x)
 957.T2 3
 958(x)
 959.T2 4
 960[x]
 961.T2 5
 962<x>
 963.T2 6
 964{x}
 965.in
 966.sp
 967Every item in the list will get \fILI-space\fP number of blank lines
 968before them.
 969Default is\ 1.
 970.sp
 971\fBLB\fP itself will print \fILB-space\fP blank lines.
 972Default is\ 0.
 973.TP
 974.B "LC [list-level]"
 975List-status clear.
 976Terminates all current active lists down to \fIlist-level\fP, or 0
 977if no argmuent is given.
 978This is used by \fBH\fP to clear any
 979active list.
 980.TP
 981.B "LE [1]"
 982List end.
 983Terminate the current list.
 984\fBLE\fP outputs a blank line
 985if an argument is given.
 986.TP
 987.B "LI [mark [1]]"
 988List item precedes every item in a list.
 989Without argument \fBLI\fP
 990will print the mark determined by the current list type.
 991By giving
 992\fBLI\fP one argument, it will use that as the mark instead.
 993Two arguments to \fBLI\fP will make \fImark\fP a prefix to
 994the current mark.
 995There will be no separating space between the prefix
 996and the mark if the second argument is \fB2\fP instead of \fB1\fP.
 997This behaviour can also be achieved by setting number register
 998\fBLimsp\fP to zero.
 999A zero length \fImark\fP will make a hanging
1000indent instead.
1001.sp
1002A blank line is normally printed before the list item.
1003This behaviour
1004can be controlled by number register \fBLs\fP.
1005Pre-spacing
1006will occur for each list-level less than or equal to \fBLs\fP.
1007Default value is\ 99.
1008(Nesting of lists is unlimited.\ :-)
1009.sp
1010The indentation can be changed thru number register \fBLi\fP.
1011Default is 6.
1012.sp
1013All lists begins with a list initialization macro, \fBLB\fP.
1014There are, however, seven predefined listtypes to
1015make lists easier to use.
1016They all call \fBLB\fP with different
1017default values.
1018.in +.5i
1019.T2 \fBAL\fP
1020Automatically Incremented List
1021.T2 \fBML\fP
1022Marked List
1023.T2 \fBVL\fP
1024Variable-Item List
1025.T2 \fBBL\fP
1026Bullet List
1027.T2 \fBDL\fP
1028Dash List
1029.T2 \fBRL\fP
1030Reference List
1031.T2 \fBBVL\fP
1032Broken Varable List.
1033.in
1034These lists are described at other places in this manual.
1035See also \fBLB\fP.
1036.TP
1037.B "LT [arg]"
1038Formats a letter in one of four different styles depending
1039on the argument.
1040See also \fBINTERNALS\fP.
1041.in +.5i
1042.T2 \fBArg
1043Style\fP
1044.T2 BL
1045Blocked.
1046Date line, return address, writer's address and closing
1047begins at the center of the line.
1048All other lines begin at the left margin.
1049.T2 SB
1050Semi-blocked.
1051Same as blocked, except that the first line in every
1052paragraph is indented five spaces.
1053.T2 FB
1054Full-blocked.
1055All lines begin at the left margin.
1056.T2 SP
1057Simplified.
1058Almost the same as the full-blocked style.
1059Subject and
1060the writer's identification are printed in all-capital.
1061.in
1062.TP
1063.B "LO type [arg]"
1064Specify options in letter (see \fB.LT\fP).
1065This is a list of the standard options:
1066.in +.5i
1067.T2 CN
1068Confidential notation.
1069Prints \fBCONFIDENTIAL\fP on the second line
1070below the date line.
1071Any argument replaces \fBCONFIDENTIAL\fP.
1072See also string variable \fBLetCN\fP.
1073.T2 RN
1074Reference notation.
1075Prints \fBIn reference to:\fP and the argument
1076two lines below the date line.
1077See also string variable \fBLetRN\fP.
1078.T2 AT
1079Attention.
1080Prints \fBATTENTION:\fP and the argument below the inside address.
1081See also string variable \fBLetAT\fP.
1082.T2 SA
1083Salutation.
1084Prints \fBTo Whom It May Concern:\fP or the argument if
1085it was present.
1086The salutation is printed two lines below the inside address.
1087See also string variable \fBLetSA\fP.
1088.T2 SJ
1089Subject line.
1090Prints the argument as subject prefixed with \fBSUBJECT:\fP
1091two lines below the inside address, except in letter type \fBSP\fP.
1092Then the subject is printed in all-captial without any prefix.
1093See also string variable \fBLetSJ\fP.
1094.in
1095.TP
1096.B "MC column-size [column-separation] "
1097Begin multiple columns.
1098Return to normal with \fB1C\fP.
1099\fBMC\fP will create as many columns as the current line length permits.
1100\fIColumn-size\fP is the width of each column, and \fIcolumn-separation\fP
1101is the space between two columns.
1102Default separation is the 
1103column-size/15.
1104See also \fB1C\fP.
1105.TP
1106.B "ML mark [text-indent [1]]"
1107Marked list start.
1108The \fImark\fP argument will be printed before
1109each list item.
1110\fIText-indent\fP sets the indent and overrides \fBLi\fP.
1111A third argument will prohibit printing of a blank line before each
1112item.
1113.TP
1114.B "MT [arg [addressee]]"
1115Memorandum type.
1116The \fIarg\fP is part of a filename in \fI@TMAC_MDIR@/*.MT\fP.
1117Memorandum type 0 thru 5 are supported, including \fI"string"\fP.
1118\fIAddressee\fP just sets a variable, used in the AT&T macros.
1119.br
1120\fBarg\fP
1121.in +.5i
1122.T2 0
1123Normal memorandum, no type printed
1124.T2 1
1125Memorandum with \fIMEMORANDUM FOR FILE\fP printed
1126.T2 2
1127Memorandum with \fIPROGRAMMER'S NOTES\fP printed
1128.T2 3
1129Memorandum with \fIENGINEER'S NOTES\fP printed
1130.T2 4
1131Released paper style
1132.T2 5
1133External letter style
1134.in
1135See also \fBCOVER\fP/\fBCOVEND\fP, a more flexible type of front page.
1136.TP
1137.B "MOVE y-pos [x-pos [line-length]]"
1138Move to a position, pageoffset set to \fIx-pos\fP.
1139If \fIline-length\fP is not given, the difference between
1140current and new pageoffset is used.
1141Use \fBPGFORM\fP without arguments to return to normal.
1142.TP
1143.B "MULB cw1 space1 [cw2 space2 [cw3 ...]]"
1144Begin a special multi-column mode.
1145Every columns width must be specified.
1146Also the space between the columns must be specified.
1147The last column
1148does not need any space-definition.
1149\fBMULB\fP starts a diversion and \fBMULE\fP
1150ends the diversion and prints the columns.
1151The unit for width and space is 'n', but \fBMULB\fP accepts all 
1152normal unitspecifications like 'c' and 'i'.
1153\fBMULB\fP operates in a separate environment.
1154.TP
1155.B "MULN"
1156Begin the next column.
1157This is the only way to switch column.
1158.TP
1159.B "MULE"
1160End the multi-column mode and print the columns.
1161.TP
1162.B "nP [type]"
1163Print numbered paragraph with header level two.
1164See \fB.P\fP.
1165.TP
1166.B "NCOL"
1167Force printing to the next column, don't use this together with
1168the \fBMUL*\fP macros, see \fB2C\fP.
1169.TP
1170.B "NS [arg [1]]"
1171Prints different types of notations.
1172The argument selects between
1173the predefined type of notations.
1174If the second argument is available, 
1175then the argument becomes the entire notation.
1176If the argument doesn't exist in the predefined, it will be
1177printed as \fBCopy (\fP\fIarg\fP\fB) to\fP.
1178It is possible to add more standard notations, see the string variable
1179\fBLetns\fP and \fBLetnsdef\fP.
1180.nf
1181.in +.5i
1182.T2 \fBArg
1183Notation\fP
1184.T2 \fInone\fP
1185Copy To
1186.T2 """""
1187Copy To
1188.T2 1
1189Copy To (with att.) to
1190.T2 2
1191Copy To (without att.) to
1192.T2 3
1193Att.
1194.T2 4
1195Atts.
1196.T2 5
1197Enc.
1198.T2 6
1199Encs.
1200.T2 7
1201Under separate cover
1202.T2 8
1203Letter to
1204.T2 9
1205Memorandum to
1206.T2 10
1207Copy (with atts.) to
1208.T2 11
1209Copy (without atts.) to
1210.T2 12
1211Abstract Only to
1212.T2 13
1213Complete Memorandum to
1214.T2 14
1215CC
1216.in
1217.fi
1218.TP
1219.B "ND new-date"
1220New date.
1221Override the current date.
1222Date is not
1223printed if \fInew-date\fP is an empty string.
1224.TP
1225.B "OF [arg]"
1226Odd-page footer, a line printed just above the normal footer.
1227See \fBEF\fP and \fBPF\fP.
1228.TP
1229.B "OH [arg]"
1230Odd-page header, a line printed just below the normal header.
1231See \fBEH\fP and \fBPH\fP.
1232.TP
1233.B OP
1234Make sure that the following text is printed at the top
1235of an odd-numbered page.
1236Will not output an empty page
1237if currently at the top of an odd page.
1238.TP
1239.B "P [type]"
1240Begin new paragraph.
1241\fBP\fP without argument will produce left justified text, even
1242the first line of the paragraph.
1243This is the same as setting
1244\fItype\fP to 0.
1245If the argument is\ 1, then the first line
1246of text following \fBP\fP will be indented by the number of
1247spaces in number register \fBPi\fP, normally 5.
1248.sp
1249Instead of giving 1 as argument to \fBP\fP it is possible to set the
1250paragraph type in number register \fBPt\fP.
1251Using 0 and\ 1
1252will be the same as adding that value to \fBP\fP.
1253A value of 2 will indent all paragraphs, except after
1254headings, lists and displays.
1255.sp
1256The space between two paragraphs is controlled by number register \fBPs\fP,
1257and is 1 by default (one blank line).
1258.TP
1259.B "PGFORM [linelength [pagelength [pageoffset [1]]]]"
1260Sets linelength, pagelength and/or pageoffset.
1261This macro can be used for special formatting, like letterheads
1262and other.
1263It is normally the first command in a file, though it's not necessary.
1264\fBPGFORM\fP can be used without arguments 
1265to reset everything after a \fBMOVE\fP.
1266A line-break is done unless the fourth argument is given.
1267This can be used to avoid the pagenumber on the first page while setting
1268new width and length.
1269(It seems as if this macro sometimes doesn't work too well.
1270Use the command line arguments
1271to change linelength, pagelength and pageoffset instead.
1272Sorry.)
1273.TP
1274.B PGNH
1275No header is printed on the next page.
1276Used to get rid of
1277the header in letters or other special texts.
1278This macro must be used before any text to inhibit the pageheader
1279on the first page.
1280.TP
1281.B "PIC [-L] [-C] [-R] [-I n] filename [width [height]]"
1282\fBPIC\fP includes a Postscript file in the document.
1283The macro depends on \fBmmroff\fP and \fBINITR\fP.
1284\fB-L\fP, \fB-C\fP, \fB-R\fP and \fB-I n\fP adjusts the picture
1285or indents it.
1286The optionally \fIwidth\fP and \fIheight\fP
1287can also be given to resize the picture.
1288.TP
1289.B PE
1290Picture end.
1291Ends a picture for \fB@TMAC_M_PREFIX@pic\fP, see the manual for \fB@TMAC_M_PREFIX@pic\fP.
1292.TP
1293.B "PF [arg]"
1294Page footer.
1295\fBPF\fP sets the line to be printed at the bottom of each page.
1296Normally empty.
1297See \fBPH\fP for the argument specification.
1298.TP
1299.B "PH [arg]"
1300Page header, a line printed at the top of each page.
1301The argument should be specified as "'left-part'center-part'right-part'",
1302where left-, center- and right-part is printed left-justified, centered
1303and right justified.
1304The character \fB%\fP is changed to the current
1305page number.
1306The default page-header is "''- % -''", the page
1307number between two dashes.
1308.TP
1309.B PS
1310Picture start (from pic).
1311Begins a picture for \fB@g@pic\fP, see
1312the manual.
1313.TP
1314.B PX
1315Page-header user-defined exit.
1316\fBPX\fP is called just after the printing of the page header
1317in \fIno-space\fP mode.
1318.TP
1319.B R
1320Roman.
1321Return to roman font, see also \fBI\fP.
1322.TP
1323.B "RB [roman-text [bold-text [roman-text [...]]]]"
1324Roman-bold.
1325Even arguments is printed in roman, odd in boldface.
1326See \fBI\fP.
1327.TP
1328.B "RD [prompt [diversion [string]]]"
1329Read from standard input to diversion and/or string.
1330The text will be saved in a diversion named \fIdiversion\fP.
1331Recall the text by writing the name of the diversion after a dot
1332on an empty line.
1333A string will also be defined if
1334\fIstring\fP is given.
1335\fIDiversion\fP and/or \fIprompt\fP can 
1336be empty ("").
1337.TP
1338.B RF
1339Reference end.
1340Ends a reference definition and returns to normal
1341processing.
1342See \fBRS\fP.
1343.TP
1344.B "RI [roman-text [italic-text [roman-text [...]]]]"
1345Even arguments are printed in roman, odd in italic.
1346See \fBI\fP.
1347.TP
1348.B "RL [text-indent [1]]"
1349Reference list start.
1350Begins a list where each item is preceded with a automatically
1351incremented number between
1352square brackets.
1353\fIText-indent\fP changes the default indentation.
1354.TP
1355.B "RP [arg1 [arg2]]"
1356Produce reference page.
1357\fBRP\fP can be used if a reference page is wanted somewhere in the
1358document.
1359It is not needed if \fBTC\fP is used to produce
1360a table of content.
1361The reference page will then be printed automatically.
1362.sp
1363The reference counter will not be reset if \fIarg1\fP is 1.
1364.sp
1365\fIArg2\fP tells \fBRP\fP whether to eject a page or not.
1366.br
1367\fBArg2\fP
1368.in +.5i
1369.T2 0
1370The reference page will be printed on a separate page.
1371This is
1372the default.
1373.T2 1
1374Do not eject page after the list.
1375.T2 2
1376Do not eject page before the list.
1377.T2 3
1378Do not eject page before and after the list.
1379.in
1380The reference items will be separated by a blank line.
1381Setting number register \fBLs\fP to 0 will suppress the line.
1382.sp
1383The string \fBRp\fP contains the reference page title and
1384is normally set to \fIREFERENCES\fP.
1385.TP
1386.B "RS [string-name]"
1387\fBRS\fP begins an automatically numbered reference definition.
1388Put the string \fB\e*(Rf\fP where the reference mark
1389should be and write the reference between \fBRS\fP/\fBRF\fP
1390at next new line after the reference mark.
1391The reference number
1392is stored in number register \fB:R\fP.
1393If \fIstring-name\fP is given, a string with that name
1394will be defined and contain the current reference mark.
1395The string can be referenced as \fB\e*[\fIstring-name\fP]\fP later in
1396the text.
1397.TP
1398.B "S [size [spacing]]"
1399Set point size and vertical spacing.
1400If any argument is equal 'P', then
1401the previous value is used.
1402A 'C' means current value, and 'D' default value.
1403If '+' or '-' is used before the value, then increment or decrement of
1404the current value will be done.
1405.TP
1406.B "SA [arg]"
1407Set right-margin justification.
1408Justification is normally turned on.
1409No argumenent or \fB0\fP turns off justification, a \fB1\fP turns on
1410justification.
1411.TP
1412.B "SETR refname [string]"
1413Remember the current header and page-number as \fIrefname\fP.
1414Saves \fIstring\fP if \fIstring\fP is defined.
1415\fIstring\fP is retrieved
1416with \fB.GETST\fP.
1417See \fBINITR\fP.
1418.TP
1419.B "SG [arg [1]]"
1420Signature line.
1421Prints the authors name(s) after the formal closing.
1422The argument will be appended to the reference data, printed
1423at either the first or last author.
1424The reference data is the location,
1425department and initials specified with \fB.AU\fP.
1426It will be printed at the first author if the second argument is given,
1427otherwise at the last.
1428No reference data will be printed if the author(s) is specifed
1429thru \fB.WA\fP/\fB.WE\fP.
1430See \fBINTERNALS\fP.
1431.TP
1432.B "SK [pages]"
1433Skip pages.
1434If \fIpages\fP is \fB0\fP or omitted, a skip to the next page
1435will occur unless it is already at the top of a page.
1436Otherwise it will skip \fIpages\fP pages.
1437.TP
1438.B "SM string1 [string2 [string3]]"
1439Make a string smaller.
1440If \fIstring2\fP is given, \fIstring1\fP will be smaller and \fIstring2\fP
1441normal, concatenated with \fIstring1\fP.
1442With three argument, all is
1443concatenated, but only \fIstring2\fP is made smaller.
1444.TP
1445.B "SP [lines]"
1446Space vertically.
1447\fIlines\fP can have any scalingfactor, like \fI3i\fP or
1448\fI8v\fP.
1449Several \fBSP\fP in a line will only produce the
1450maximum number of lines, not the sum.
1451\fBSP\fP will also be ignored
1452until the first textline in a page.
1453Add a \fB\e&\fP before \fBSP\fP
1454to avoid this.
1455.TP
1456.B TAB
1457reset tabs to every\ 5n.
1458Normally used to reset any previous tabpositions.
1459.TP
1460.B "TB [title [override [flag [refname]]]]"
1461Table title, arguments are the same as for \fBEC\fP.
1462\fBTB\fP uses the number register \fBTb\fP as counter.
1463The string \fBLt\fP controls the title of the
1464List of Tables, default is \fILIST OF TABLES\fP.
1465The List of Tables will only be printed if number register \fBLt\fP
1466is 1, default 1.
1467The string \fBLitb\fP contains the word \fITABLE\fP, wich
1468is printed before the number.
1469.br
1470Special handling of the title will occur if
1471\fBTB\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
1472affected by the format of \fBDS\fP.
1473.TP
1474.B "TC [slevel [spacing [tlevel [tab [h1 [h2 [h3 [h4 [h5]]]]]]]]]"
1475Table of contents.
1476This macro is normally used at the last line of the document.
1477It generates a table of contents with headings up to the level
1478controlled by number register \fBCl\fP.
1479Note that \fBCl\fP controls
1480the saving of headings, it has nothing to do with \fBTC\fP.
1481Headings with level less than or equal to \fIslevel\fP will get
1482\fIspacing\fP number of lines before them.
1483Headings with level less than or equal to \fItlevel\fP will have
1484their page numbers right justified with dots or spaces separating
1485the text and the page number.
1486Spaces is used if \fItab\fP
1487is greater than zero, otherwise dots.
1488Other headings will have the
1489page number directly at the end of the heading text (\fIragged right\fP).
1490.sp
1491The rest of the arguments will be printed, centered, before the
1492table of contents.
1493.sp
1494The user-defined macros \fBTX\fP and \fBTY\fP are used if \fBTC\fP is called
1495with at most four arguments.
1496\fBTX\fP is called before the printing
1497of \fICONTENTS\fP, and \fBTY\fP is called instead of printing \fICONTENTS\fP.
1498.sp
1499Equivalent macros can be defined for list of figures, tables, equations
1500and excibits by defining \fBTXxx\fP or \fBTYxx\fP, where \fBxx\fP
1501is \fBFg\fP, \fBTB\fP, \fBEC\fP or \fBEX\fP.
1502.sp
1503String \fBCi\fP can be set to control the indentations for each heading-level.
1504It must be scaled, like \fB.ds\ Ci\ .25i\ .5i\ .75i\ 1i\ 1i\fP.
1505The indentation is normally controlled by the maxlength of headings
1506in each level.
1507.sp
1508All texts can be redefined, new stringvariables 
1509\fILifg\fP, \fILitb\fP, \fILiex\fP, \fILiec\fP and \fILicon\fP contain
1510"Figure", "TABLE", "Exhibit", "Equation" and "CONTENTS".
1511These can be redefined to other languages.
1512.TP
1513.B TE
1514Table end.
1515See \fBTS\fP.
1516.TP
1517.B "TH [N]"
1518Table header.
1519See \fBTS\fP.
1520\fBTH\fP ends the header of the table.
1521This header will
1522be printed again if a page-break occurs.
1523Argument \fIN\fP isn't implemented yet.
1524.TP
1525.B TL [charging-case number(s) [filing-case number(s)]]
1526Begin title of memorandum.
1527All text up to the next \fBAU\fP is included in the title.
1528\fICharging-case number\fP and \fIfiling-case\fP are saved
1529for use in the front page processing.
1530.TP
1531.B TM [num1 [num2 [...]]]
1532Technical memorandumnumbers used in \fB.MT\fP.
1533Unlimited number
1534of arguments may be given.
1535.TP
1536.B TP
1537Top of page user-defined macro.
1538This macro is called instead of the normal page header.
1539It is
1540possible to get complete control over the header.
1541Note that header and footer is printed in a separate environment.
1542Linelength is preserved though.
1543.TP
1544.B "TS [H]"
1545Table start.
1546This is the start of a table specification
1547to \fB@g@tbl\fP.
1548See separate manual for \fB@g@tbl\fP.
1549\fBTS\fP ends with \fBTE\fP.
1550Argument \fIH\fP tells \fBm@TMAC_M_PREFIX@m\fP that the table
1551has a header.
1552See \fBTH\fP.
1553.TP
1554.B TX
1555Userdefined table of contents exit.
1556This macro is called just before \fBTC\fP prints the word \fICONTENTS\fP.
1557See \fBTC\fP.
1558.TP
1559.B TY
1560Userdefined table of contents exit (no "CONTENTS").
1561This macro is called instead of printing \fICONTENTS\fP.
1562See \fBTC\fP.
1563.TP
1564.B VERBON [flag [pointsize [font]]]
1565Begin verbatim output using courier font.
1566Usually for printing programs.
1567All character has equal width.
1568The pointsize can be changed with
1569the second argument.
1570By specifying the font-argument
1571it is possible to use another font instead of courier.
1572\fIflag\fP controls several special features.
1573It contains the sum of all wanted features.
1574.in +.5i
1575.T2 Value
1576Description
1577.T2 1
1578Disable the escape-character (\e).
1579This is normally turned on during
1580verbose output.
1581.T2 2
1582Add an empty line before the verbose text.
1583.T2 4
1584Add an empty line after the verbose text.
1585.T2 8
1586Print the verbose text with numbered lines.
1587This adds four digitsized
1588spaces in the beginning of each line.
1589Finer control is available with
1590the string-variable \fBVerbnm\fP.
1591It contains all arguments to the
1592\fBtroff\fP-command \fB.nm\fP, normally '1'.
1593.T2 16
1594Indent the verbose text with five 'n':s.
1595This is controlled by the
1596number-variable \fBVerbin\fP (in units).
1597.in
1598.TP
1599.B VERBOFF
1600End verbatim output.
1601.TP
1602.B "VL text-indent [mark-indent [1]]"
1603Variable-item list has no fixed mark, it assumes that
1604every \fBLI\fP have a mark instead.
1605\fIText-indent\fP sets the indent to the text, and \fImark-indent\fP
1606the distance from the current indent to the mark.
1607A third argument will prohibit printing of a blank line before each
1608item.
1609.TP
1610.B "VM [-T] [top [bottom]]"
1611Vertical margin. Adds extra vertical top and margin space.
1612Option \fB-T\fP set the total space instead.
1613No argument resets the margin to zero or the default
1614\fI(7v 5v)\fP if \fB-T\fP
1615was used. It is higly recommended that macro \fBTP\fP and/or
1616\fBEOP\fP are defined
1617if using \fB-T\fP and setting top and/or bottom margin to less than the default.
1618.TP
1619.B "WA [writer-name [title]]"
1620Begins specification of the writer and writer's address.
1621Several names can be specified with empty \fBWA\fP/\fBWE\fP-pairs, but
1622only one address.
1623.TP
1624.B WE
1625Ends the address-specification after \fP.WA\fP.
1626.TP
1627.B "WC [format]"
1628Footnote and display width control.
1629.in +.5i
1630.T2 N
1631Set default mode, \fB-WF\fP, \fB-FF\fP, \fB-WD\fP and \fBFB\fP.
1632.T2 WF
1633Wide footnotes, wide also in two-column mode.
1634.T2 -WF
1635Normal footnote width, follow column mode.
1636.T2 FF
1637All footnotes gets the same width as the first footnote encountered.
1638.T2 -FF
1639Normal footnotes, width follows \fBWF\fP and \fB-WF\fP.
1640.T2 WD
1641Wide displays, wide also in two-column mode.
1642.T2 -WD
1643Normal display width, follow column mode.
1644.T2 FB
1645Floating displays generates a line break when printed on the current page.
1646.T2 -FB
1647Floating displays does not generate line break.
1648.in
1649.sp 3
1650.LP
1651.\"########################################################################
1652.LP
1653.B "Strings used in m@TMAC_M_PREFIX@m:"
1654.TP
1655.B App
1656A string containing the word "APPENDIX".
1657.TP
1658.B Apptxt
1659The current appendix text.
1660.TP
1661.B "EM"
1662Em dash string
1663.TP
1664.B H1txt
1665Will be updated by \fB.H\fP and \fB.HU\fP to the current heading text.
1666Also updated in table of contents & friends.
1667.TP
1668.B HF
1669Fontlist for headings, normally "2 2 2 2 2 2 2".
1670Nonnumeric fontnames may also be used.
1671.TP
1672.B HP
1673Pointsize list for headings.
1674Normally "0 0 0 0 0 0 0" which is the same as
1675"10 10 10 10 10 10 10".
1676.TP
1677.B Index
1678Contains \fIINDEX\fP.
1679.TP
1680.B Indcmd
1681Contains the index command, \fIsort\ -t\et\fP.
1682.TP
1683.B Lifg
1684String containing \fIFigure\fP.
1685.TP
1686.B Litb
1687String containing \fITABLE\fP.
1688.TP
1689.B Liex
1690String containing \fIExhibit\fP.
1691.TP
1692.B Liec
1693String containing \fIEquation\fP.
1694.TP
1695.B Licon
1696String containing \fICONTENTS\fP.
1697.TP
1698.B Lf
1699Contains "LIST OF FIGURES".
1700.TP
1701.B Lt
1702Contains "LIST OF TABLES".
1703.TP
1704.B Lx
1705Contains "LIST OF EXHIBITS".
1706.TP
1707.B Le
1708Contains "LIST OF EQUATIONS".
1709.TP
1710.B Letfc
1711Contains "Yours very truly,", used in \fB.FC\fP.
1712.TP
1713.B Letapp
1714Contains "APPROVED:", used in \fB.AV\fP.
1715.TP
1716.B Letdate
1717Contains "Date", used in \fB.AV\fP.
1718.TP
1719.B LetCN
1720Contains "CONFIDENTIAL", used in \fB.LO CN\fP.
1721.TP
1722.B LetSA
1723Contains "To Whom It May Concern:", used in \fB.LO SA\fP.
1724.TP
1725.B LetAT
1726Contains "ATTENTION:", used in \fB.LO AT\fP.
1727.TP
1728.B LetSJ
1729Contains "SUBJECT:", used in \fB.LO SJ\fP.
1730.TP
1731.B LetRN
1732Contains …

Large files files are truncated, but you can click here to view the full file