{ "content": [ { "type": "text", "text": "# groff_mm (info)\n\n## NAME\n\ngroffmm - memorandum macros for GNU roff\n\n## SYNOPSIS\n\ngroff -mm [option ...] [file ...]\ngroff -m mm [option ...] [file ...]\n\n## DESCRIPTION\n\nThe groff mm macros are intended to be compatible with the DWB mm\nmacros with the following limitations:\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **INTERNALS**\n- **FILES**\n- **AUTHORS**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "groff_mm", "section": "", "mode": "info", "summary": "groffmm - memorandum macros for GNU roff", "synopsis": "groff -mm [option ...] [file ...]\ngroff -m mm [option ...] [file ...]", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [ { "name": "groff", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/groff/1/json" }, { "name": "troff", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/troff/1/json" }, { "name": "tbl", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/tbl/1/json" }, { "name": "pic", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/pic/1/json" }, { "name": "eqn", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/eqn/1/json" }, { "name": "groffmmse", "section": "7", "url": "https://www.chedong.com/phpMan.php/man/groffmmse/7/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 3, "subsections": [] }, { "name": "DESCRIPTION", "lines": 1566, "subsections": [] }, { "name": "INTERNALS", "lines": 30, "subsections": [] }, { "name": "FILES", "lines": 8, "subsections": [] }, { "name": "AUTHORS", "lines": 3, "subsections": [] }, { "name": "SEE ALSO", "lines": 4, "subsections": [] } ], "sections": { "NAME": { "content": "groffmm - memorandum macros for GNU roff\n", "subsections": [] }, "SYNOPSIS": { "content": "groff -mm [option ...] [file ...]\ngroff -m mm [option ...] [file ...]\n", "subsections": [] }, "DESCRIPTION": { "content": "The groff mm macros are intended to be compatible with the DWB mm\nmacros with the following limitations:\n\no No Bell Labs localisms are implemented.\n\no The macros OK and PM are not implemented.\n\no groff mm does not support cut marks.\n\nmm is intended to support easy localization. Use mmse as an example\nhow to adapt the output format to a national standard. Localized\nstrings are collected in the file /usr/share/groff/1.22.4/tmac/xx.tmac,\nwhere xx denotes the two-letter code for the language, as defined in\nthe ISO 639 standard. For Swedish, this is 'sv.tmac' - not 'se', which\nis the ISO 3166 two-letter code for the country (as used for the output\nformat localization).\n\nA file called locale or countrylocale is read after the initialization\nof the global variables. It is therefore possible to localize the\nmacros with a different company name and so on.\n\nIn this manual, square brackets are used to show optional arguments.\n\nNumber registers and strings\nMany macros can be controlled by number registers and strings. A num-\nber register is assigned with the nr command:\n\n.nr XXX [+-]n [i]\n\nXXX is the name of the register, n is the value to be assigned, and\ni is the increment value for auto-increment. n can have a plus or mi-\nnus sign as a prefix if an increment or decrement of the current value\nis wanted. (Auto-increment or auto-decrement occurs if the number reg-\nister is used with a plus or minus sign, \\n+[XXX] or \\n-[XXX].)\n\nStrings are defined with ds.\n\n.ds YYY string\n\nThe string is assigned everything to the end of the line, even blanks.\nInitial blanks in string should be prefixed with a double-quote.\n(Strings are used in the text as \\*[YYY].)\n\nSpecial formatting of number registers\nA number register is printed with normal digits if no format has been\ngiven. Set the format with af:\n\n.af R c\n\nR is the name of the register, c is the format.\n\nForm Sequence\n1 0, 1, 2, 3, ...\n\n001 000, 001, 002, 003, ...\ni 0, i, ii, iii, iv, ...\nI 0, I, II, III, IV, ...\na 0, a, b, c, ..., z, aa, ab, ...\nA 0, A, B, C, ..., Z, AA, AB, ...\n\nFonts\nIn mm, the fonts (or rather, font styles) R (normal), I (italic), and\nB (bold) are hardwired to font positions 1, 2, and 3, respectively.\nInternally, font positions are used for backwards compatibility. From\na practical point of view it doesn't make a big difference - a differ-\nent font family can still be selected with a call to the .fam request\nor using groff's -f command-line option. On the other hand, if you\nwant to replace just, say, font B, you have to replace the font at po-\nsition 2 (with a call to '.fp 2 ...').\n\nMacros\n)E level text\nAdd heading text text to the table of contents with level, which\nis either 0 or in the range 1 to 7. See also .H. This macro is\nused for customized tables of contents.\n\n1C [1] Begin one-column processing. A 1 as an argument disables the\npage break. Use wide footnotes, small footnotes may be over-\nprinted.\n\n2C Begin two-column processing. Splits the page in two columns.\nIt is a special case of MC. See also 1C.\n\nAE Abstract end, see AS.\n\nAF [name-of-firm]\nAuthor's firm, should be called before AU, see also COVER.\n\nAL [type [text-indent [1]]]\nStart auto-increment list. Items are numbered beginning with\none. The type argument controls the format of numbers.\n\nArg Description\n1 Arabic (the default)\nA Upper-case letters (A-Z)\na Lower-case letters (a-z)\nI Upper-case roman\ni Lower-case roman\n\ntext-indent sets the indentation and overrides Li. A third ar-\ngument prohibits printing of a blank line before each item.\n\nAPP name text\nBegin an appendix with name name. Automatic naming occurs if\nname is \"\". The appendices start with A if automatic naming is\nused. A new page is ejected, and a header is also produced if\nthe number variable Aph is non-zero. This is the default. The\nappendix always appears in the 'List of contents' with correct\npage numbers. The name 'APPENDIX' can be changed by setting the\nstring App to the desired text. The string Apptxt contains the\ncurrent appendix text.\n\nAPPSK name pages text\nSame as .APP, but the page number is incremented with pages.\nThis is used when diagrams or other non-formatted documents are\nincluded as appendices.\n\nAS [arg [indent]]\nAbstract start. Indentation is specified in 'ens', but scaling\nis allowed. Argument arg controls where the abstract is\nprinted.\n\nArg Placement\n0 Abstract is printed on page 1 and on the cover sheet if\nused in the released-paper style (MT 4), otherwise it is\nprinted on page 1 without a cover sheet.\n1 Abstract is only printed on the cover sheet (MT 4 only).\n2 Abstract is printed only on the cover sheet (other than MT\n4 only). The cover sheet is printed without a need for\nCS.\n\nAn abstract is not printed at all in external letters (MT 5).\nThe indent parameter controls the indentation of both margins,\notherwise normal text indentation is used.\n\nAST [title]\nAbstract title. Default is 'ABSTRACT'. Sets the text above the\nabstract text.\n\nAT title1 [title2 [...]]\nAuthor's title. AT must appear just after each AU. The title\nshows up after the name in the signature block.\n\nAU [name [initials [loc [dept [ext [room [arg [arg [arg]]]]]]]]]\nAuthor information. Specifies the author of the memo or paper,\nand is printed on the cover sheet and on other similar places.\nAU must not appear before TL. The author information can con-\ntain initials, location, department, telephone extension, room\nnumber or name and up to three extra arguments.\n\nAV [name [1]]\nApproval signature. Generates an approval line with place for\nsignature and date. The string 'APPROVED:' can be changed with\nvariable Letapp; it is replaced with an empty lin if there is a\nsecond argument. The string 'Date' can be changed with variable\nLetdate.\n\nAVL [name]\nLetter signature. Generates a line with place for signature.\n\nB [bold-text [prev-font-text [bold [...]]]]\nBegin boldface. No limit on the number of arguments. All argu-\nments are concatenated to one word; the first, third and so on\nis printed in boldface.\n\nB1 Begin box (as the ms macro). Draws a box around the text. The\ntext is indented one character, and the right margin is one\ncharacter shorter.\n\nB2 End box. Finishes the box started with B1.\n\nBE End bottom block, see BS.\n\nBI [bold-text [italic-text [bold-text [...]]]]\nBold-italic. No limit on the number of arguments, see B.\n\nBL [text-indent [1]]\nStart bullet list. Initializes a list with a bullet and a space\nin the beginning of each list item (see LI). text-indent over-\nrides the default indentation of the list items set by number\nregister Pi. A third argument prohibits printing of a blank\nline before each item.\n\nBR [bold-text [roman-text [bold-text [...]]]]\nBold-roman. No limit on the number of arguments.\n\nBS Bottom block start. Begins the definition of a text block which\nis printed at the bottom of each page. The block ends with BE.\n\nBVL text-indent [mark-indent [1]]\nStart of broken variable-item list. Broken variable-item list\nhas no fixed mark, it assumes that every LI has a mark instead.\nThe text always begins at the next line after the mark. text-\nindent sets the indentation to the text, and mark-indent the\ndistance from the current indentation to the mark. A third ar-\ngument prohibits printing of a blank line before each item.\n\nCOVER [arg]\nBegin a coversheet definition. It is important that .COVER ap-\npears before any normal text. This macro uses arg to build the\nfilename /usr/share/groff/1.22.4/tmac/mm/arg.cov. Therefore it\nis possible to create unlimited types of cover sheets. ms.cov\nis supposed to look like the ms cover sheet. .COVER requires a\n.COVEND at the end of the cover definition. Always use this or-\nder of the cover macros:\n\n.COVER\n.TL\n.AF\n.AU\n.AT\n.AS\n.AE\n.COVEND\n\nHowever, only .TL and .AU are required.\n\nCOVEND Finish the cover description and print the cover page. It is\ndefined in the cover file.\n\nDE Display end. Ends a block of text or display that begins with\nDS or DF.\n\nDF [format [fill [rindent]]]\nBegin floating display (no nesting allowed). A floating display\nis saved in a queue and is printed in the order entered. For-\nmat, fill, and rindent are the same as in DS. Floating displays\nare controlled by the two number registers De and Df.\n\nDe register\n\n0 Nothing special, this is the default.\n1 A page eject occurs after each printed display, giv-\ning only one display per page and no text following\nit.\n\nDf register\n\n0 Displays are printed at the end of each section (when\nsection-page numbering is active) or at the end of\nthe document.\n1 A new display is printed on the current page if there\nis enough space, otherwise it is printed at the end\nof the document.\n2 One display is printed at the top of each page or\ncolumn (in multi-column mode).\n3 Print one display if there is enough space for it,\notherwise it is printed at the top of the next page\nor column.\n\n4 Print as many displays as possible in a new page or\ncolumn. A page break occurs between each display if\nDe is not zero.\n5 Fill the current page with displays and the rest be-\nginning at a new page or column. (This is the de-\nfault.) A page break occurs between each display if\nDe is not zero.\n\nDL [text-indent [1 [1]]]\nDash list start. Begins a list where each item is printed after\na dash. text-indent changes the default indentation of the list\nitems set by number register Pi. A second argument prevents an\nempty line between each list item. See LI. A third argument\nprohibits printing of a blank line before each item.\n\nDS [format [fill [rindent]]]\nStatic display start. Begins collection of text until DE. The\ntext is printed together on the same page, unless it is longer\nthan the height of the page. DS can be nested arbitrarily.\n\nformat\n\n\"\" No indentation.\nnone No indentation.\nL No indentation.\nI Indent text with the value of number register Si.\nC Center each line.\nCB Center the whole display as a block.\nR Right-adjust the lines.\nRB Right-adjust the whole display as a block.\n\nThe values 'L', 'I', 'C', and 'CB' can also be specified as '0',\n'1', '2', and '3', respectively, for compatibility reasons.\n\nfill\n\n\"\" Line-filling turned off.\nnone Line-filling turned off.\nN Line-filling turned off.\nF Line-filling turned on.\n\n'N' and 'F' can also be specified as '0' and '1', respectively.\n\nBy default, an empty line is printed before and after the dis-\nplay. Setting number register Ds to 0 prevents this. rindent\nshortens the line length by that amount.\n\nEC [title [override [flag [refname]]]]\nEquation title. Sets a title for an equation. The override ar-\ngument changes the numbering.\n\nflag\n\nnone override is a prefix to the number.\n0 override is a prefix to the number.\n1 override is a suffix to the number.\n2 override replaces the number.\n\nEC uses the number register Ec as a counter. It is possible to\nuse .af to change the format of the number. If number register\nOf is 1, the format of title uses a dash instead of a dot after\nthe number.\n\nThe string Le controls the title of the List of Equations; de-\nfault is 'LIST OF EQUATIONS'. The List of Equations is only\nprinted if number register Le is 1. The default is 0. The\nstring Liec contains the word 'Equation', which is printed be-\nfore the number. If refname is used, then the equation number\nis saved with .SETR, and can be retrieved with '.GETST refname'.\n\nSpecial handling of the title occurs if EC is used inside DS/DE;\nit is not affected by the format of DS.\n\nEF [arg]\nEven-page footer, printed just above the normal page footer on\neven pages. See PF.\n\nThis macro defines string EOPef.\n\nEH [arg]\nEven-page header, printed just below the normal page header on\neven pages. See PH.\n\nThis macro defines string TPeh.\n\nEN Equation end, see EQ.\n\nEOP End-of-page user-defined macro. This macro is called instead of\nthe normal printing of the footer. The macro is executed in a\nseparate environment, without any trap active. See TP.\n\nStrings available to EOP\n\nEOPf argument of PF\nEOPef argument of EF\nEOPof argument of OF\n\nEPIC [-L] width height [name]\nDraw a box with the given width and height. It also prints the\ntext name or a default string if name is not specified. This is\nused to include external pictures; just give the size of the\npicture. -L left-adjusts the picture; the default is to center.\nSee PIC.\n\nEQ [label]\nEquation start. EQ/EN are the delimiters for equations written\nfor eqn(1). EQ/EN must be inside of a DS/DE pair, except if EQ\nis used to set options for eqn only. The label argument appears\nat the right margin of the equation, centered vertically within\nthe DS/DE block, unless number register Eq is 1. Then the label\nappears at the left margin.\n\nIf there are multiple EQ/EN blocks within a single DS/DE pair,\nonly the last equation label (if any) is printed.\n\nEX [title [override [flag [refname]]]]\nExhibit title. The arguments are the same as for EC. EX uses\nthe number register Ex as a counter. The string Lx controls the\ntitle of the List of Exhibits; default is 'LIST OF EXHIBITS'.\nThe List of Exhibits is only printed if number register Lx is 1,\nwhich is the default. The string Liex contains the word 'Ex-\nhibit', which is printed before the number. If refname is used,\nthe exhibit number is saved with .SETR, and can be retrieved\nwith '.GETST refname'.\n\nSpecial handling of the title occurs if EX is used inside DS/DE;\nit is not affected by the format of DS.\n\nFC [closing]\nPrint 'Yours very truly,' as a formal closing of a letter or\nmemorandum. The argument replaces the default string. The de-\nfault is stored in string variable Letfc.\n\nFD [arg [1]]\nFootnote default format. Controls the hyphenation (hyphen),\nright margin justification (adjust), and indentation of footnote\ntext (indent). It can also change the label justification\n(ljust).\n\narg hyphen adjust indent ljust\n0 no yes yes left\n1 yes yes yes left\n2 no no yes left\n3 yes no yes left\n4 no yes no left\n5 yes yes no left\n6 no no no left\n7 yes no no left\n8 no yes yes right\n9 yes yes yes right\n10 no no yes right\n11 yes no yes right\n\nAn argument greater than or equal to 11 is considered as\nvalue 0. Default for mm is 10.\n\nFE Footnote end.\n\nFG [title [override [flag [refname]]]]\nFigure title. The arguments are the same as for EC. FG uses\nthe number register Fg as a counter. The string Lf controls the\ntitle of the List of Figures; default is 'LIST OF FIGURES'. The\nList of Figures is only printed if number register Lf is 1,\nwhich is the default. The string Lifg contains the word 'Fig-\nure', which is printed before the number. If refname is used,\nthen the figure number is saved with .SETR, and can be retrieved\nwith '.GETST refname'.\n\nSpecial handling of the title occurs if FG is used inside DS/DE,\nit is not affected by the format of DS.\n\nFS [label]\nFootnote start. The footnote is ended by FE. By default, foot-\nnotes are automatically numbered; the number is available in\nstring F. Just add \\*F in the text. By adding label, it is\npossible to have other number or names on the footnotes. Foot-\nnotes in displays are now possible. An empty line separates\nfootnotes; the height of the line is controlled by number regis-\nter Fs, default value is 1.\n\nGETHN refname [varname]\nInclude the header number where the corresponding 'SETR refname'\nwas placed. This is displayed as 'X.X.X.' in pass 1. See\nINITR. If varname is used, GETHN sets the string variable var-\nname to the header number.\n\nGETPN refname [varname]\nInclude the page number where the corresponding 'SETR refname'\nwas placed. This is displayed as '9999' in pass 1. See INITR.\nIf varname is used, GETPN sets the stringvariable varname to the\npage number.\n\nGETR refname\nCombine GETHN and GETPN with the text 'chapter' and ', page'.\nThe string Qrf contains the text for the cross reference:\n\n.ds Qrf See chapter \\\\*[Qrfh], page \\\\*[Qrfp].\n\nQrf may be changed to support other languages. Strings Qrfh and\nQrfp are set by GETR and contain the page and header number, re-\nspectively.\n\nGETST refname [varname]\nInclude the string saved with the second argument to .SETR.\nThis is a dummy string in pass 1. If varname is used, GETST\nsets it to the saved string. See INITR.\n\nH level [heading-text [heading-suffix]]\nNumbered section heading. Section headers can have a level be-\ntween 1 and 14; level 1 is the top level. The text is given in\nheading-text, and must be surrounded by double quotes if it con-\ntains spaces. heading-suffix is added to the header in the text\nbut not in the table of contents. This is normally used for\nfootnote marks and similar things. Don't use \\*F in heading-\nsuffix, it doesn't work. A manual label must be used, see FS.\n\nA call to the paragraph macro P directly after H is ignored.\nH takes care of spacing and indentation.\n\nPage ejection before heading\n\nNumber register Ej controls page ejection before the\nheading. By default, a level-one heading gets two blank\nlines before it; higher levels only get one. A new page\nis ejected before each first-level heading if number reg-\nister Ej is 1. All levels below or equal the value of Ej\nget a new page. Default value for Ej is 0.\n\nHeading break level\n\nA line break occurs after the heading if the heading\nlevel is less or equal to number register Hb. Default\nvalue is 2.\n\nHeading space level\n\nA blank line is inserted after the heading if the heading\nlevel is less or equal to number register Hs. Default\nvalue is 2.\n\nText follows the heading on the same line if the level is\ngreater than both Hb and Hs.\n\nPost-heading indent\n\nIndentation of the text after the heading is controlled\nby number register Hi. Default value is 0.\n\nHi\n\n0 The text is left-justified.\n1 Indentation of the text follows the value of number\nregister Pt , see P.\n2 The text is lined up with the first word of the head-\ning.\n\nCentered section headings\n\nAll headings whose level is equal or below number regis-\nter Hc and also less than or equal to Hb or Hs are cen-\ntered.\n\nFont control of the heading\n\nThe font of each heading level is controlled by string\nHF. It contains a font number or font name for each\nlevel. Default value is\n\n2 2 2 2 2 2 2 2 2 2 2 2 2 2\n\n(all headings in italic). This could also be written as\n\nI I I I I I I I I I I I I I\n\nNote that some other implementations use 3 3 2 2 2 2 2 as\nthe default value. All omitted values are presumed to\nhave value 1.\n\nPoint size control\n\nString HP controls the point size of each heading, in the\nsame way as HF controls the font. A value of 0 selects\nthe default point size. Default value is\n\n0 0 0 0 0 0 0 0 0 0 0 0 0 0\n\nBeware that only the point size changes, not the vertical\nsize. The latter can be controlled by the user-specified\nmacros HX and/or HZ.\n\nHeading counters\n\nFourteen number registers named H1 up to H14 contain the\ncounter for each heading level. The values are printed\nusing Arabic numerals; this can be changed with the macro\nHM (see below). All marks are concatenated before print-\ning. To avoid this, set number register Ht to 1. This\nonly prints the current heading counter at each heading.\n\nAutomatic table of contents\n\nAll headings whose level is equal or below number regis-\nter Cl are saved to be printed in the table of contents.\nDefault value is 2.\n\nSpecial control of the heading, user-defined macros\n\nThe following macros can be defined by the user to get a\nfiner control of vertical spacing, fonts, or other fea-\ntures. Argument level is the level-argument to H, but 0\nfor unnumbered headings (see HU). Argument rlevel is the\nreal level; it is set to number register Hu for unnum-\nbered headings. Argument heading-text is the text argu-\nment to H and HU.\n\nHX level rlevel heading-text\nThis macro is called just before the printing of\nthe heading. The following registers are avail-\nable for HX. Note that HX may alter }0, }2, and\n;3.\n\n}0 (string)\nContains the heading mark plus two spaces\nif rlevel is non-zero, otherwise empty.\n\n;0 (register)\nContains the position of the text after the\nheading. 0 means that the text should fol-\nlow the heading on the same line, 1 means\nthat a line break should occur before the\ntext, and 2 means that a blank line should\nseparate the heading and the text.\n\n}2 (string)\nContains two spaces if register ;0 is 0.\nIt is used to separate the heading from the\ntext. The string is empty if ;0 is non-\nzero.\n\n;3 (register)\nContains the needed space in units after\nthe heading. Default is 2v. Can be used\nto change things like numbering (}0), ver-\ntical spacing (}2), and the needed space\nafter the heading.\n\nHY dlevel rlevel heading-text\nThis macro is called after size and font calcula-\ntions and might be used to change indentation.\n\nHZ dlevel rlevel heading-text\nThis macro is called after the printing of the\nheading, just before H or HU exits. Can be used\nto change the page header according to the section\nheading.\n\nHC [hyphenation-character]\nSet hyphenation character. Default value is '\\%'. Resets to\nthe default if called without argument. Hyphenation can be\nturned off by setting number register Hy to 0 at the beginning\nof the file.\n\nHM [arg1 [arg2 [... [arg14]]]]\nHeading mark style. Controls the type of marking for printing\nof the heading counters. Default is 1 for all levels.\n\nArgument\n\n1 Arabic numerals.\n0001 Arabic numerals with leading zeroes, one or more.\nA upper-case alphabetic\na lower-case alphabetic\nI upper-case roman numerals\ni lower-case roman numerals\n\"\" Arabic numerals.\n\nHU heading-text\nUnnumbered section header. HU behaves like H at the level in\nnumber register Hu. See H.\n\nHX dlevel rlevel heading-text\nUser-defined heading exit. Called just before printing the\nheader. See H.\n\nHY dlevel rlevel heading-text\nUser-defined heading exit. Called just before printing the\nheader. See H.\n\nHZ dlevel rlevel heading-text\nUser-defined heading exit. Called just after printing the\nheader. See H.\n\nI [italic-text [prev-font-text [italic-text [...]]]]\nItalic. Changes the font to italic if called without arguments.\nWith one argument it sets the word in italic. With two argu-\nments it concatenates them and sets the first word in italic and\nthe second in the previous font. There is no limit on the num-\nber of argument; all are concatenated.\n\nIA [addressee-name [title]]\nBegin specification of the addressee and addressee's address in\nletter style. Several names can be specified with empty IA/IE-\npairs, but only one address. See LT.\n\nIB [italic-text [bold-text [italic-text [...]]]]\nItalic-bold. Even arguments are printed in italic, odd in bold-\nface. See I.\n\nIE End the address specification after IA.\n\nINITI type filename [macro]\nInitialize the new index system and set the filename to collect\nindex lines in with IND. Argument type selects the type of in-\ndex: page number, header marks or both. The default is page\nnumbers.\n\nIt is also possible to create a macro that is responsible for\nformatting each row; just add the name of the macro as a third\nargument. The macro is then called with the index as argu-\nment(s).\n\ntype\n\nN Page numbers\nH Header marks\nB Both page numbers and header marks, separated with a tab\ncharacter.\n\nINITR filename\nInitialize the cross reference macros. Cross references are\nwritten to stderr and are supposed to be redirected into file\nfilename.qrf. Requires two passes with groff; this is handled\nby a separate program called mmroff(1). This program exists be-\ncause groff(1) by default deactivates the unsafe operations that\nare required by INITR. The first pass looks for cross refer-\nences, and the second one includes them. INITR can be used sev-\neral times, but it is only the first occurrence of INITR that is\nactive.\n\nSee also SETR, GETPN, and GETHN.\n\nIND arg1 [arg2 [...]]\nWrite a line in the index file selected by INITI with all argu-\nments and the page number or header mark separated by tabs.\n\nExamples\n\narg1\\tpage number\narg1\\targ2\\tpage number\narg1\\theader mark\narg1\\tpage number\\theader mark\n\nINDP Print the index by running the command specified by string vari-\nable Indcmd, which has 'sort -t\\t' as the default value. INDP\nreads the output from the command to form the index, by default\nin two columns (this can be changed by defining TYIND). The in-\ndex is printed with string variable Index as header, default is\n'INDEX'. One-column processing is reactivated after the list.\nINDP calls the user-defined macros TXIND, TYIND, and TZIND if\ndefined. TXIND is called before printing the string 'INDEX',\nTYIND is called instead of printing 'INDEX', and TZIND is called\nafter the printing and should take care of restoring to normal\noperation again.\n\nISODATE [0]\nChange the predefined date string in DT to ISO-format, this is,\n'YYYY-MM-DD'. This can also be done by adding -rIso=1 on the\ncommand line. Reverts to old date format if argument is 0.\n\nIR [italic-text [roman-text [italic-text [...]]]]\nItalic-roman. Even arguments are printed in italic, odd in ro-\nman. See I.\n\nLB text-indent mark-indent pad type [mark [LI-space [LB-space]]]\nList-begin macro. This is the common macro used for all lists.\ntext-indent is the number of spaces to indent the text from the\ncurrent indentation.\n\npad and mark-indent control where to put the mark. The mark is\nplaced within the mark area, and mark-indent sets the number of\nspaces before this area. By default it is 0. The mark area\nends where the text begins. The start of the text is still con-\ntrolled by text-indent.\n\nThe mark is left-justified within the mark area if pad is 0. If\npad is greater than 0, mark-indent is ignored, and the mark is\nplaced pad spaces before the text. This right-justifies the\nmark.\n\nIf type is 0 the list either has a hanging indentation or, if\nargument mark is given, the string mark as a mark.\n\nIf type is greater than 0 automatic numbering occurs, using ara-\nbic numbers if mark is empty. mark can then be any of '1', 'A',\n'a', 'I', or 'i'.\n\ntype selects one of six possible ways to display the mark.\n\ntype\n\n1 x.\n2 x)\n3 (x)\n4 [x]\n5 \n6 {x}\n\nEvery item in the list gets LI-space number of blank lines be-\nfore them. Default is 1.\n\nLB itself prints LB-space blank lines. Default is 0.\n\nLC [list-level]\nList-status clear. Terminates all current active lists down to\nlist-level, or 0 if no argument is given. This is used by H to\nclear any active list.\n\nLE [1] List end. Terminates the current list. LE outputs a blank line\nif an argument is given.\n\nLI [mark [1|2]]\nList item preceding every item in a list. Without argument, LI\nprints the mark determined by the current list type. By giving\nLI one argument, it uses that as the mark instead. Two argu-\nments to LI makes mark a prefix to the current mark. There is\nno separating space between the prefix and the mark if the sec-\nond argument is '2' instead of '1'. This behaviour can also be\nachieved by setting number register Limsp to zero. A zero\nlength mark makes a hanging indentation instead.\n\nA blank line is printed before the list item by default. This\nbehaviour can be controlled by number register Ls. Pre-spacing\noccurs for each list level less than or equal to Ls. Default\nvalue is 99. There is no nesting limit.\n\nThe indentation can be changed through number register Li. De-\nfault is 6.\n\nAll lists begin with a list initialization macro, LB. There\nare, however, seven predefined list types to make lists easier\nto use. They all call LB with different default values.\n\nAL Automatically Incremented List\nML Marked List\nVL Variable-Item List\nBL Bullet List\nDL Dash List\nRL Reference List\nBVL Broken Variable List.\n\nThese lists are described at other places in this manual. See\nalso LB.\n\nLT [arg]\nFormat a letter in one of four different styles depending on the\nargument. Also see section \"Internals\" below.\n\nArg Style\nBL Blocked. Date line, return address, writer's ad-\ndress and closing begins at the center of the line.\nAll other lines begin at the left margin.\nSB Semi-blocked. Same as blocked, except that the\nfirst line in every paragraph is indented five spa-\nces.\nFB Full-blocked. All lines begin at the left margin.\nSP Simplified. Almost the same as the full-blocked\nstyle. Subject and the writer's identification are\nprinted in all-capital.\n\nLO type [arg]\nSpecify options in letter (see .LT). This is a list of the\nstandard options:\n\nCN Confidential notation. Prints 'CONFIDENTIAL' on the\nsecond line below the date line. Any argument re-\nplaces 'CONFIDENTIAL'. See also string variable\nLetCN.\nRN Reference notation. Prints 'In reference to:' and\nthe argument two lines below the date line. See\nalso string variable LetRN.\nAT Attention. Prints 'ATTENTION:' and the argument be-\nlow the inside address. See also string variable\nLetAT.\nSA Salutation. Prints 'To Whom It May Concern:' or the\nargument if it was present. The salutation is\nprinted two lines below the inside address. See\nalso string variable LetSA.\nSJ Subject line. Prints the argument as subject pre-\nfixed with 'SUBJECT:' two lines below the inside ad-\ndress, except in letter type 'SP', where the subject\nis printed in all-capital without any prefix. See\nalso string variable LetSJ.\n\nMC column-size [column-separation]\nBegin multiple columns. Return to normal with 1C. MC creates\nas many columns as the current line length permits. column-size\nis the width of each column, and column-separation is the space\nbetween two columns. Default separation is column-size/15. See\nalso 1C.\n\nML mark [text-indent [1]]\nMarked list start. The mark argument is printed before each\nlist item. text-indent sets the indent and overrides Li. A\nthird argument prohibits printing of a blank line before each\nitem.\n\nMT [arg [addressee]]\nMemorandum type. The argument arg is part of a filename in\n/usr/share/groff/1.22.4/tmac/mm/*.MT. Memorandum types 0 to 5\nare supported, including type 'string' (which gets internally\nmapped to type 6). addressee just sets a variable, used in the\nAT&T macros.\n\narg\n\n0 Normal memorandum, no type printed.\n1 Memorandum with 'MEMORANDUM FOR FILE' printed.\n2 Memorandum with 'PROGRAMMER'S NOTES' printed.\n3 Memorandum with 'ENGINEER'S NOTES' printed.\n4 Released paper style.\n5 External letter style.\n\nSee also COVER/COVEND, a more flexible type of front page.\n\nMOVE y-pos [x-pos [line-length]]\nMove to a position, setting page offset to x-pos. If line-\nlength is not given, the difference between current and new page\noffset is used. Use PGFORM without arguments to return to nor-\nmal.\n\nMULB cw1 space1 [cw2 space2 [cw3 ...]]\nBegin a special multi-column mode. All columns widths must be\nspecified. The space between the columns must be specified\nalso. The last column does not need any space definition. MULB\nstarts a diversion, and MULE ends the diversion and prints the\ncolumns. The unit for the width and space arguments is 'n', but\nMULB accepts all normal unit specifications like 'c' and 'i'.\nMULB operates in a separate environment.\n\nMULN Begin the next column. This is the only way to switch the col-\numn.\n\nMULE End the multi-column mode and print the columns.\n\nnP [type]\nPrint numbered paragraph with header level two. See .P.\n\nNCOL Force printing to the next column. Don't use this together with\nthe MUL* macros, see 2C.\n\nNS [arg [1]]\nPrint different types of notations. The argument selects be-\ntween the predefined type of notations. If the second argument\nis available, then the argument becomes the entire notation. If\nthe argument doesn't select a predefined type, it is printed as\n'Copy (arg) to'. It is possible to add more standard notations,\nsee the string variables Letns and Letnsdef.\n\nArg Notation\nnone Copy To\n\"\" Copy To\n1 Copy To (with att.) to\n2 Copy To (without att.) to\n\n3 Att.\n4 Atts.\n5 Enc.\n6 Encs.\n7 Under separate cover\n8 Letter to\n9 Memorandum to\n10 Copy (with atts.) to\n11 Copy (without atts.) to\n12 Abstract Only to\n13 Complete Memorandum to\n14 CC\n\nND new-date\nNew date. Overrides the current date. Date is not printed if\nnew-date is an empty string.\n\nOF [arg]\nOdd-page footer, a line printed just above the normal footer.\nSee EF and PF.\n\nThis macro defines string EOPof.\n\nOH [arg]\nOdd-page header, a line printed just below the normal header.\nSee EH and PH.\n\nThis macro defines string TPoh.\n\nOP Make sure that the following text is printed at the top of an\nodd-numbered page. Does not output an empty page if currently\nat the top of an odd page.\n\nP [type]\nBegin new paragraph. P without argument produces left-justified\ntext, even the first line of the paragraph. This is the same as\nsetting type to 0. If the argument is 1, the first line of text\nfollowing P is indented by the number of spaces in number regis-\nter Pi, by default 5.\n\nInstead of giving an argument to P it is possible to set the\nparagraph type in number register Pt. Using 0 and 1 is the same\nas adding that value to P. A value of 2 indents all paragraphs,\nexcept after headings, lists, and displays (this value can't be\nused as an argument to P itself).\n\nThe space between two paragraphs is controlled by number regis-\nter Ps, and is 1 by default (one blank line).\n\nPGFORM [linelength [pagelength [pageoffset [1]]]]\nSet line length, page length, and/or page offset. This macro\ncan be used for special formatting, like letter heads and other.\nIt is normally the first command in a file, though it is not\nnecessary. PGFORM can be used without arguments to reset every-\nthing after a MOVE call. A line break is done unless the fourth\nargument is given. This can be used to avoid the page number on\nthe first page while setting new width and length. (It seems as\nif this macro sometimes doesn't work too well. Use the command-\nline arguments to change line length, page length, and page off-\nset instead.)\n\nPGNH No header is printed on the next page. Used to get rid of the\nheader in letters or other special texts. This macro must be\nused before any text to inhibit the page header on the first\npage.\n\nPIC [-B] [-L] [-C] [-R] [-I n] filename [width [height]]\nInclude a PostScript file in the document. The macro depends on\nmmroff(1) and INITR. The arguments -L, -C, -R, and -I n adjust\nthe picture or indent it. With no flag the picture is adjusted\nto the left. Adding -B draws a box around the picture. The op-\ntional width and height can also be given to resize the picture.\n\nPE Picture end. Ends a picture for pic(1).\n\nPF [arg]\nPage footer. PF sets the line to be printed at the bottom of\neach page. Empty by default. See PH for the argument specifi-\ncation.\n\nThis macro defines string EOPf.\n\nPH [arg]\nPage header, a line printed at the top of each page. The argu-\nment should be specified as\n\n\"'left-part'center-part'right-part'\"\n\nwhere left-part, center-part, and right-part are printed left-\njustified, centered, and right justified, respectively. Within\nthe argument to PH, the character '%' is changed to the current\npage number. The default argument is\n\n\"''- % -''\"\n\nwhich gives the page number between two dashes.\n\nThis macro defines string TPh.\n\nPS Picture start (from pic). Begins a picture for pic(1).\n\nPX Page header user-defined exit. This macro is called just after\nthe printing of the page header in no-space mode.\n\nR Roman. Return to roman font, see also I.\n\nRB [roman-text [bold-text [roman-text [...]]]]\nRoman-bold. Even arguments are printed in roman, odd in bold-\nface. See I.\n\nRD [prompt [diversion [string]]]\nRead from standard input to diversion and/or string. The text\nis saved in a diversion named diversion. Recall the text by\nwriting the name of the diversion after a dot on an empty line.\nA string is also defined if string is given. Diversion and/or\nprompt can be empty (\"\").\n\nRF Reference end. Ends a reference definition and returns to nor-\nmal processing. See RS.\n\nRI [roman-text [italic-text [roman-text [...]]]]\nPrint even arguments in roman, odd in italic. See I.\n\nRL [text-indent[1]]\nReference list start. Begins a list where each item is preceded\nwith an automatically incremented number between square brack-\nets. text-indent changes the default indentation.\n\nRP [arg1 [arg2]]\nProduce reference page. This macro can be used if a reference\npage is wanted somewhere in the document. It is not needed if\nTC is used to produce a table of contents. The reference page\nis then printed automatically.\n\nThe reference counter is not reset if arg1 is 1.\n\narg2 tells RP whether to eject a page or not.\n\narg2\n\n0 The reference page is printed on a separate page.\n1 Do not eject page after the list.\n2 Do not eject page before the list.\n3 Do not eject page before and after the list.\n\nThe reference items are separated by a blank line. Setting num-\nber register Ls to 0 suppresses the line.\n\nThe string Rp contains the reference page title and is set to\n'REFERENCES' by default. The number register Rpe holds the de-\nfault value for the second argument of RP; it is initially set\nto 0.\n\nRS [string-name]\nBegin an automatically numbered reference definition. Put the\nstring \\*(Rf where the reference mark should be and write the\nreference between RS/RF at next new line after the reference\nmark. The reference number is stored in number register :R. If\nstring-name is given, a string with that name is defined and\ncontains the current reference mark. The string can be refer-\nenced as \\*[string-name] later in the text.\n\nS [size [spacing]]\nSet point size and vertical spacing. If any argument is equal\nto 'P', the previous value is used. A 'C' means current value,\nand 'D' the default value. If '+' or '-' is used before the\nvalue, the current value is incremented or decremented, respec-\ntively.\n\nSA [arg]\nSet right-margin justification. Justification is turned on by\ndefault. No argument or value '0' turns off justification, and\n'1' turns on justification.\n\nSETR refname [string]\nRemember the current header and page number as refname. Saves\nstring if string is defined. string is retrieved with .GETST.\nSee INITR.\n\nSG [arg [1]]\nSignature line. Prints the authors name(s) after the formal\nclosing. The argument is appended to the reference data,\nprinted at either the first or last author. The reference data\nis the location, department, and initials specified with .AU.\nIt is printed at the first author if the second argument is\ngiven, otherwise at the last. No reference data is printed if\nthe author(s) is specified through .WA/.WE. See section \"Inter-\nnals\" below.\n\nSK [pages]\nSkip pages. If pages is 0 or omitted, a skip to the next page\noccurs unless it is already at the top of a page. Otherwise it\nskips pages pages.\n\nSM string1 [string2 [string3]]\nMake a string smaller. If string2 is given, string1 is made\nsmaller and string2 stays at normal size, concatenated with\nstring1. With three arguments, everything is concatenated, but\nonly string2 is made smaller.\n\nSP [lines]\nSpace vertically. lines can have any scaling factor, like '3i'\nor '8v'. Several SP calls in a line only produces the maximum\nnumber of lines, not the sum. SP is ignored also until the\nfirst text line in a page. Add \\& before a call to SP to avoid\nthis.\n\nTAB Reset tabs to every 5n. Normally used to reset any previous tab\npositions.\n\nTB [title [override [flag [refname]]]]\nTable title. The arguments are the same as for EC. TB uses the\nnumber register Tb as a counter. The string Lt controls the ti-\ntle of the List of Tables; default value is 'LIST OF TABLES'.\nThe List of Tables is only printed if number register Lt is 1,\nwhich is the default. The string Litb contains the word 'TA-\nBLE', which is printed before the number.\n\nSpecial handling of the title occurs if TB is used inside DS/DE,\nit is not affected by the format of DS.\n\nTC [slevel [spacing [tlevel [tab [h1 [h2 [h3 [h4 [h5]]]]]]]]]\nTable of contents. This macro is normally used as the last line\nof the document. It generates a table of contents with headings\nup to the level controlled by number register Cl. Note that Cl\ncontrols the saving of headings, it has nothing to do with TC.\nHeadings with a level less than or equal to slevel get spacing\nnumber of lines before them. Headings with a level less than or\nequal to tlevel have their page numbers right-justified with\ndots or spaces separating the text and the page number. Spaces\nare used if tab is greater than zero, dots otherwise. Other\nheadings have the page number directly at the end of the heading\ntext (ragged-right).\n\nThe rest of the arguments is printed, centered, before the table\nof contents.\n\nThe user-defined macros TX and TY are used if TC is called with\nat most four arguments. TX is called before the printing of the\nstring 'CONTENTS', and TY is called instead of printing 'CON-\nTENTS'.\n\nEquivalent macros can be defined for list of figures, tables,\nequations and exhibits by defining TXxx or TYxx, where xx is\n'Fg', 'TB', 'EC', or 'EX', respectively.\n\nString Ci can be set to control the indentations for each head-\ning-level. It must be scaled, like\n\n.ds Ci .25i .5i .75i 1i 1i\n\nBy default, the indentation is controlled by the maximum length\nof headings in each level.\n\nThe string variables Lifg, Litb, Liex, Liec, and Licon contain\n'Figure', 'TABLE', 'Exhibit', 'Equation', and 'CONTENTS', re-\nspectively. These can be redefined to other languages.\n\nTE Table end. See TS.\n\nTH [N] Table header. See TS. TH ends the header of the table. This\nheader is printed again if a page break occurs. Argument 'N'\nisn't implemented yet.\n\nTL [charging-case-number [filing-case-number]]\nBegin title of memorandum. All text up to the next AU is in-\ncluded in the title. charging-case-number and filing-case-num-\nber are saved for use in the front page processing.\n\nTM [num1 [num2 [...]]]\nTechnical memorandum numbers used in .MT. An unlimited number\nof arguments may be given.\n\nTP Top-of-page user-defined macro. This macro is called instead of\nthe normal page header. It is possible to get complete control\nover the header. Note that the header and the footer are\nprinted in a separate environment. Line length is preserved,\nthough. See EOP.\n\nstrings available to TP\n\nTPh argument of PH\nTPeh argument of EH\nTPoh argument of OH\n\nTS [H] Table start. This is the start of a table specification to\ntbl(1). TS ends with TE. Argument 'H' tells mm that the table\nhas a header. See TH.\n\nTX User-defined table of contents exit. This macro is called just\nbefore TC prints the word 'CONTENTS'. See TC.\n\nTY User-defined table of contents exit. This macro is called in-\nstead of printing 'CONTENTS'. See TC.\n\nVERBON [flag [point-size [font]]]\nBegin verbatim output using Courier font. Usually for printing\nprograms. All characters have equal width. The point size can\nbe changed with the second argument. By specifying a third ar-\ngument it is possible to use another font instead of Courier.\nflag controls several special features. Its value is the sum of\nall wanted features.\n\nArg Description\n1 Disable the escape character (\\). This is normally\nturned on during verbose output.\n2 Add an empty line before the verbose text.\n4 Add an empty line after the verbose text.\n8 Print the verbose text with numbered lines. This\nadds four digit-sized spaces in the beginning of\neach line. Finer control is available with the\nstring variable Verbnm. It contains all arguments\nto the troff(1) command .nm, normally '1'.\n16 Indent the verbose text by '5n'. This is con-\ntrolled by the number-variable Verbin (in units).\n\nVERBOFF\nEnd verbatim output.\n\nVL text-indent [mark-indent [1]]\nVariable-item list. It has no fixed mark, it assumes that every\nLI has a mark instead. text-indent sets the indent to the text,\nand mark-indent the distance from the current indentation to the\nmark. A third argument prohibits printing of a blank line be-\nfore each item.\n\nVM [-T] [top [bottom]]\nVertical margin. Increase the top and bottom margin by top and\nbottom, respectively. If option -T is specified, set those mar-\ngins to top and bottom. If no argument is given, reset the mar-\ngin to zero, or to the default ('7v 5v') if -T is used. It is\nhighly recommended that macros TP and/or EOP are defined if us-\ning -T and setting top and/or bottom margin to less than the de-\nfault.\n\nWA [writer-name [title]]\nBegin specification of the writer and writer's address. Several\nnames can be specified with empty WA/WE pairs, but only one ad-\ndress.\n\nWE End the address specification after .WA.\n\nWC [format1] [format2] [...]\nFootnote and display width control.\n\nN Set default mode which is equal to using the options -WF,\n-FF, -WD, and FB.\nWF Wide footnotes, wide also in two-column mode.\n-WF Normal footnote width, follow column mode.\nFF All footnotes gets the same width as the first footnote\nencountered.\n-FF Normal footnotes, width follows WF and -WF.\nWD Wide displays, wide also in two-column mode.\n-WD Normal display width, follow column mode.\nFB Floating displays generates a line break when printed on\nthe current page.\n-FB Floating displays does not generate line break.\n\nStrings used in mm\nApp A string containing the word 'APPENDIX'.\n\nApptxt The current appendix text.\n\nEM Em dash string\n\nH1txt Updated by .H and .HU to the current heading text. Also updated\nin table of contents & friends.\n\nHF Font list for headings, '2 2 2 2 2 2 2' by default. Non-numeric\nfont names may also be used.\n\nHP Point size list for headings. By default, this is '0 0 0 0 0 0\n0' which is the same as '10 10 10 10 10 10 10'.\n\nIndex Contains the string 'INDEX'.\n\nIndcmd Contains the index command. Default value is 'sort -t\\t'.\n\nLifg String containing 'Figure'.\n\nLitb String containing 'TABLE'.\n\nLiex String containing 'Exhibit'.\n\nLiec String containing 'Equation'.\n\nLicon String containing 'CONTENTS'.\n\nLf Contains the string 'LIST OF FIGURES'.\n\nLt Contains the string 'LIST OF TABLES'.\n\nLx Contains the string 'LIST OF EXHIBITS'.\n\nLe Contains the string 'LIST OF EQUATIONS'.\n\nLetfc Contains the string 'Yours very truly,', used in .FC.\n\nLetapp Contains the string 'APPROVED:', used in .AV.\n\nLetdate\nContains the string 'Date', used in .AV.\n\nLetCN Contains the string 'CONFIDENTIAL', used in .LO CN.\n\nLetSA Contains the string 'To Whom It May Concern:', used in .LO SA.\n\nLetAT Contains the string 'ATTENTION:', used in .LO AT.\n\nLetSJ Contains the string 'SUBJECT:', used in .LO SJ.\n\nLetRN Contains the string 'In reference to:', used in .LO RN.\n\nLetns is an array containing the different strings used in .NS. It is\nreally a number of string variables prefixed with Letns!. If\nthe argument doesn't exist, it is included between () with\nLetns!copy as a prefix and Letns!to as a suffix. Observe the\nspace after 'Copy' and before 'to'.\n\nName Value\nLetns!0 Copy to\nLetns!1 Copy (with att.) to\nLetns!2 Copy (without att.) to\nLetns!3 Att.\nLetns!4 Atts.\nLetns!5 Enc.\nLetns!6 Encs.\nLetns!7 Under separate cover\nLetns!8 Letter to\nLetns!9 Memorandum to\nLetns!10 Copy (with atts.) to\nLetns!11 Copy (without atts.) to\nLetns!12 Abstract Only to\nLetns!13 Complete Memorandum to\nLetns!14 CC\nLetns!copy Copy (with trailing space)\nLetns!to to (note leading space)\n\nLetnsdef\nDefine the standard notation used when no argument is given to\n.NS. Default is 0.\n\nMO1 - MO12\nStrings containing the month names 'January' through 'December'.\n\nQrf String containing 'See chapter \\\\*[Qrfh], page \\\\n[Qrfp].'.\n\nRp Contains the string 'REFERENCES'.\n\nTcst Contains the current status of the table of contents and list of\nfigures, etc. Empty outside of .TC. Useful in user-defined\nmacros like .TP.\n\nValue Meaning\nco Table of contents\nfg List of figures\ntb List of tables\nec List of equations\nex List of exhibits\nap Appendix\n\nTm Contains the string '\\(tm', the trade mark symbol.\n\nVerbnm Argument to .nm in the .VERBON command. Default is 1.\n\nNumber variables used in mm\nAph Print an appendix page for every new appendix if this number\nvariable is non-zero. No output occurs if Aph is zero, but\nthere is always an appendix entry in the 'List of contents'.\n\nCl Contents level (in the range 0 to 14). The contents is saved if\na heading level is lower than or equal to the value of Cl. De-\nfault is 2.\n\nCp Eject page between list of table, list of figure, etc., if the\nvalue of Cp is zero. Default is 0.\n\nD Debug flag. Values greater than zero produce debug information\nof increasing verbosity. A value of 1 gives information about\nthe progress of formatting. Default is 0.\n\nDe If set to 1, eject after floating display is output. Default\nis 0.\n\nDsp If defined, it controls the space output before and after static\ndisplays. Otherwise the value of Lsp is used.\n\nDf Control floating keep output. This is a number in the range 0\nto 5, with a default value of 5. See .DF.\n\nDs If set to 1, use the amount of space stored in register Lsp be-\nfore and after display. Default is 1.\n\nEj If set to 1, eject page before each first-level heading. De-\nfault is 0.\n\nEq Equation labels are left-adjusted if set to 0 and right-adjusted\nif set to 1. Default is 0.\n\nFs Footnote spacing. Default is 1.\n\nH1 - H7\nHeading counters\n\nH1dot Append a dot after the level-one heading number if value is\ngreater than zero. Default is 1.\n\nH1h A copy of number register H1, but it is incremented just before\nthe page break. Useful in user-defined header macros.\n\nHb Heading break level. A number in the range 0 to 14, with a de-\nfault value of 2. See .H.\n\nHc Heading centering level. A number in the range 0 to 14, with a\ndefault value value of 0. See .H.\n\nHi Heading temporary indent. A number in the range 0 to 2, with a\ndefault value of 1.\n\n0 no indentation, left margin\n1 indent to the right, similar to '.P 1'\n2 indent to line up with text part of preceding heading\n\nHps Heading pre-space level. If the heading level is less than or\nequal to Hps, two lines precede the section heading instead of\none. Default is first level only. The real amount of lines is\ncontrolled by the variables Hps1 and Hps2.\n\nHps1 Number of lines preceding .H if the heading level is greater\nthan Hps. Value is in units, default is 0.5.\n\nHps2 Number of lines preceding .H if the heading level is less than\nor equal to Hps. Value is in units, default is 1.\n\nHs Heading space level. A number in the range 0 to 14, with a de-\nfault value of 2. See .H.\n\nHss Number of lines following .H if the heading level is less than\nor equal to Hs. Value is in units, default is 1.\n\nHt Heading numbering type.\n\n0 multiple levels (1.1.1, 1.1.2, etc.)\n1 single level\n\nDefault is 0.\n\nHu Unnumbered heading level. Default is 2.\n\nHy Hyphenation status of text body.\n\n0 no hyphenation\n1 hyphenation on, set to value 6\n\nDefault is 0.\n\nIso Set this variable to 1 on the command line to get an ISO-format-\nted date string (-rIso=1). Useless inside of a document.\n\nL Page length, only for command-line settings.\n\nLetwam Maximum lines in return-address, used in .WA/.WE. Default\nis 14.\n\nLf, Lt, Lx, Le\nEnable (1) or disable (0) the printing of List of figures, List\nof tables, List of exhibits and List of equations, respectively.\nDefault values are Lf=1, Lt=1, Lx=1, and Le=0.\n\nLi List indentation, used by .AL. Default is 6.\n\nLimsp A flag controlling the insertion of space between prefix and\nmark in automatic lists (.AL).\n\n0 no space\n1 emit space\n\nLs List space threshold. If current list level is greater than Ls\nno spacing occurs around lists. Default is 99.\n\nLsp The vertical space used by an empty line. The default is 0.5v\nin troff mode and 1v in nroff mode.\n\nN Page numbering style.\n\n0 normal header for all pages.\n1 header replaces footer on first page, header is\nempty.\n2 page header is removed on the first page.\n3 'section-page' numbering style enabled.\n4 page header is removed on the first page.\n5 'section-page' and 'section-figure' numbering style\nenabled.\n\nDefault is 0. See also the number registers Sectf and Sectp.\n\nNp A flag to control whether paragraphs are numbered.\n\n0 not numbered\n1 numbered in first-level headings.\n\nDefault is 0.\n\nO Page offset, only for command-line settings.\n\nOf Format of figure, table, exhibit, and equation titles.\n\n0 \". \"\n1 \" - \"\n\nDefault is 0.\n\nP Current page-number, normally the same as '%' unless 'section-\npage' numbering style is enabled.\n\nPi Paragraph indentation. Default is 5.\n\nPgps A flag to control whether header and footer point size should\nfollow the current settings or just change when the header and\nfooter are defined.\n\n0 Point size only changes to the current setting when\n.PH, .PF, .OH, .EH, .OF, or .OE is executed.\n1 Point size changes after every .S. This is the de-\nfault.\n\nPs Paragraph spacing. Default is 1.\n\nPt Paragraph type.\n\n0 left-justified\n1 indented paragraphs\n2 indented paragraphs except after .H, .DE, or .LE.\n\nDefault is 0.\n\nRpe Set default value for second argument of .RP. Default is 0.\n\nSectf A flag controlling 'section-figures' numbering style. A non-\nzero value enables this. See also register N.\n\nSectp A flag controlling 'section-page' numbering style. A non-zero\nvalue enables this. See also register N.\n\nSi Display indentation. Default is 5.\n\nVerbin Indentation for .VERBON. Default is 5n.\n\nW Line length, only for command-line settings.\n\n.mgm Always 1.\n", "subsections": [] }, "INTERNALS": { "content": "The letter macros are using different submacros depending on the letter\ntype. The name of the submacro has the letter type as suffix. It is\ntherefore possible to define other letter types, either in the national\nmacro-file, or as local additions. .LT sets the number variables Pt\nand Pi to 0 and 5, respectively. The following strings and macros must\nbe defined for a new letter type.\n\nlet@inittype\nThis macro is called directly by .LT. It is supposed to ini-\ntialize variables and other stuff.\n\nlet@headtype\nThis macro prints the letter head, and is called instead of the\nnormal page header. It is supposed to remove the alias\nlet@header, otherwise it is called for all pages.\n\nlet@sgtype name title n flag [arg1 [arg2 [...]]]\n.SG is calling this macro only for letters; memorandums have its\nown processing. name and title are specified through .WA/.WB.\nn is the counter, 1-max, and flag is true for the last name.\nAny other argument to .SG is appended.\n\nlet@fctype closing\nThis macro is called by .FC, and has the formal closing as the\nargument.\n\n.LO is implemented as a general option-macro. It demands that a string\nnamed Lettype is defined, where type is the letter type. .LO then as-\nsigns the argument to the string variable let*lo-type.\n", "subsections": [] }, "FILES": { "content": "/usr/share/groff/1.22.4/tmac/m.tmac\n\n/usr/share/groff/1.22.4/tmac/mm/*.cov\n\n/usr/share/groff/1.22.4/tmac/mm/*.MT\n\n/usr/share/groff/1.22.4/tmac/mm/locale\n", "subsections": [] }, "AUTHORS": { "content": "The GNU version of the mm macro package was written by Jorgen Hagg of Lund, Sweden.\n", "subsections": [] }, "SEE ALSO": { "content": "groff(1), troff(1), tbl(1), pic(1), eqn(1)\ngroffmmse(7) (only in Swedish locales)\n\ngroff 1.22.4 23 March 2022 GROFFMM(7)", "subsections": [] } } } }