1GROFF_MM(7)            Miscellaneous Information Manual            GROFF_MM(7)
2
3
4

NAME

6       groff_mm - groff mm macros
7

SYNOPSIS

9       groff -mm [ options...  ] [ files...  ]
10

DESCRIPTION

12       The  groff  mm  macros  are  intended  to be compatible with the DWB mm
13       macros with the following limitations:
14
15       ·      no Bell Labs localisms implemented.
16
17       ·      the macros OK and PM are not implemented.
18
19       ·      groff mm does not support cut marks
20
21       mm is intended to be international.  Therefore it is possible to  write
22       short  national  macrofiles  which  change all english text to the pre‐
23       ferred language.  Use mmse as an example.
24
25       A file called locale or lang_locale is read after the initiation of the
26       global variables.  It is therefore possible to localize the macros with
27       companyname and so on.
28
29       In this manual square brackets is used to show optional arguments.
30
31
32
33       Number registers and strings
34       Many macros can be controlled by number registers and strings.  A  num‐
35       ber register is assigned with the nr command:
36       .nr XXX [+-]n [i]
37       XXX  is  the name of the register, n is the value to be assigned, and i
38       is increment value for auto-increment.  n can have a plus or minus sign
39       as  prefix if an increment or decrement of the current value is wanted.
40       (Auto-increment or decrement occurs if the number register is used with
41       a plus or minus sign, \n+[XXX] or \n-[XXX].)
42
43       Strings is defined with ds.
44       .ds YYY string
45       The  string is assigned everything to the end of the line, even blanks.
46       Initial blanks in  string  should  be  prefixed  with  a  double-quote.
47       (Strings are used in the text as \*[YYY].)
48
49       Special formatting of number registers
50       A  number  register is printed with normal digits if no format has been
51       given.  Set the format with af:
52       .af R c
53       R is the name of the register, c is the format.
54       Form Sequence
55       1    0, 1, 2, 3, ...
56       001  000, 001, 002, 003, ...
57       i    0, i, ii, iii, iv, ...
58       I    0, I, II, III, IV, ...
59       a    0, a, b, c, ..., z, aa, ab, ...
60       A    0, A, B, C, ..., Z, AA, AB, ...
61
62
63       Macros:
64
65       )E level text
66              Adds text (heading-text) to the table  of  contents  with  level
67              either  0  or between 1-7.  See also .H.  This macro is used for
68              customized table of contents.
69
70       1C [1] Begin one column processing.  An  1  as  argument  disables  the
71              page-break.   Use  wide  footnotes, small footnotes may be over‐
72              printed.
73
74       2C     Begin two column processing.  Splits the page  in  two  columns.
75              It is a special case of MC.  See also 1C.
76
77       AE     Abstract end, see AS.
78
79       AF [name of firm]
80              Authors firm, should be called before AU, see also COVER.
81
82       AL [type [text-indent [1]]]
83              Start  autoincrement list.  Items are numbered beginning on one.
84              The type argument controls the type of numbers.
85              Arg  Description
86              1    Arabic (the default)
87              A    Upper-case letters (A-Z)
88              a    Lower-case letters (a-z)
89              I    Upper-case roman
90              i    Lower-case roman
91              Text-indent sets the indent and overrides Li.  A third  argument
92              will prohibit printing of a blank line before each item.
93
94       APP name text
95              Begin  an  appendix  with name name.  Automatic naming occurs if
96              name is "".  The appendixes starts with A if auto is  used.   An
97              new page is ejected, and a header is also produced if the number
98              variable Aph is non-zero.  This is the  default.   The  appendix
99              always appear in the 'List of contents' with correct pagenumber.
100              The name APPENDIX can be changed by setting the  string  App  to
101              the desired text.  The string Apptxt contains the current appen‐
102              dix text.
103
104       APPSK name pages text
105              Same as .APP, but the pagenr is incremented with pages.  This is
106              used when diagrams or other non-formatted documents are included
107              as appendixes.
108
109       AS [arg [indent]]
110              Abstract start.  Indent is specified in 'ens',  but  scaling  is
111              allowed.  Argument arg controls where the abstract is printed.
112              Arg  Placement
113              0    Abstract  will  be printed on page 1 and on the cover sheet
114                   if used in the released-paper style (MT  4),  otherwise  it
115                   will be printed on page 1 without a cover sheet.
116              1    Abstract  will  only  be  printed  on the cover sheet (MT 4
117                   only).
118              2    Abstract will be printed only on  the  cover  sheet  (other
119                   than  MT  4 only).  The cover sheet is printed without need
120                   for CS.
121              Abstract is not printed at all in external letters (MT 5).   The
122              indent  controls the indentation of both margins, otherwise will
123              normal text indent be used.
124
125       AST [title]
126              Abstract title.  Default is ABSTRACT.  Sets the text  above  the
127              abstract text.
128
129       AT title1 [title2 ...]
130              Authors  title.   AT  must appear just after each AU.  The title
131              will show up after the name in the signature block.
132
133       AU [name [initials [loc [dept [ext [room [arg [arg [arg]]]]]]]]]
134              Author information, specifies the author of the memo  or  paper,
135              and  will  be  printed  on  the cover sheet and on other similar
136              places.  AU must not appear before TL.  The  author  information
137              can contain initials, location, department, telephone extension,
138              room number or name and up to three extra arguments.
139
140       AV [name [1]]
141              Approval signature, generates an approval line  with  place  for
142              signature  and  date.   The string APPROVED: can be changed with
143              variable Letapp, and the string Date in Letdate.
144
145       AVL [name]
146              Letter signature, generates a line with place for signature.
147
148       B [bold-text [prev-font-text [bold...]]]
149              Begin boldface.  No limit on the number of arguments.  All argu‐
150              ments  will be concatenated to one word, the first, third and so
151              on will be printed in boldface.
152
153       B1     Begin box (as the ms macro).  Draws a box around the text.   The
154              text  will  be indented one character, and the right margin will
155              be one character shorter.
156
157       B2     End box.  Finish the box started by B1.
158
159       BE     End bottom block, see BS.
160
161       BI [bold-text [italic-text [bold-text [...]]]]
162              Bold-italic.  No limit on the number of arguments, see B.
163
164       BL [text-indent [1]]
165              Start bullet list, initialize a list with a bullet and  a  space
166              in  the beginning of each list item (see LI).  Text-indent over‐
167              rides the default indentation of the list items  set  by  number
168              register Pi.  A third argument will prohibit printing of a blank
169              line before each item.
170
171       BR [bold-text [roman-text [bold-text [...]]]]
172              Bold-roman.  No limit on the number of arguments.
173
174       BS     Bottom block start.  Begins the definition of a text block which
175              is printed at the bottom of each page.  Block ends with BE.
176
177       BVL text-indent [mark-indent [1]]
178              Start  of  broken variable-item list.  Broken variable-item list
179              has no fixed mark, it assumes that every LI has a mark  instead.
180              The  text  will  always  begin  at the next line after the mark.
181              Text-indent sets the indent to the  text,  and  mark-indent  the
182              distance  from the current indent to the mark.  A third argument
183              will prohibit printing of a blank line before each item.
184
185       COVER [arg]
186              COVER begins a coversheet  definition.   It  is  important  that
187              .COVER appears before any normal text.  .COVER uses arg to build
188              the filename /usr/share/groff/1.18.1.4/tmac/mm/arg.cov.   There‐
189              fore  it  is  possible to create unlimited types of coversheets.
190              ms.cov is supposed to  look  like  the  ms  coversheet.   .COVER
191              requires  a  .COVEND  at the end of the coverdefinition.  Always
192              use this order of the covermacros:
193              .COVER
194              .TL
195              .AF
196              .AU
197              .AT
198              .AS
199              .AE
200              .COVEND
201              However, only .TL and .AU are required.
202
203       COVEND This finish the cover description and prints the cover-page.  It
204              is defined in the cover file.
205
206       DE     Display end.  Ends a block of text, display, that begins with DS
207              or DF.
208
209       DF [format [fill [rindent]]]
210              Begin floating display (no nesting allowed).  A floating display
211              is  saved  in a queue and is printed in the order entered.  For‐
212              mat, fill and rindent is the same as in DS.   Floating  displays
213              are controlled by the two number registers De and Df.
214
215              De register
216              0    Nothing special, this is the default.
217              1    A  page eject will occur after each printed display, giving
218                   only one display per page and no text following it.
219
220              Df register
221              0    Displays are printed at the end of each section (when  sec‐
222                   tion-page  numbering  is active) or at the end of the docu‐
223                   ment.
224              1    A new display will be printed on the current page if  there
225                   is enough space, otherwise it will be printed at the end of
226                   the document.
227              2    One display will be printed at the top of each page or col‐
228                   umn (in multi-column mode).
229              3    Print  one  display if there is enough space for it, other‐
230                   wise it will be printed at the top of the next page or col‐
231                   umn.
232              4    Print  as many displays that will fit in a new page or col‐
233                   umn.  A page break will occur between each display if De is
234                   not zero.
235              5    Fill  the current page with displays and the rest beginning
236                   at a new page or column.  (This is the  default.)   A  page
237                   break will occur between each display if De is not zero.
238
239       DL [text-indent [1 [1]]]
240              Dash list start.  Begins a list where each item is printed after
241              a dash.  Text-indent changes the default indentation of the list
242              items set by number register Pi.  A second argument prevents the
243              empty line between each list item to be  printed.   See  LI.   A
244              third  argument  will  prohibit  printing of a blank line before
245              each item.
246
247       DS [format [fill [rindent]]]
248              Static display start.  Begins collection of text until DE.   The
249              text  is  printed together on the same page, unless it is longer
250              than the height of the page.  DS can be nested  to  a  unlimited
251              depth (reasonably :-).
252
253              format
254              ""   No indentation.
255              none No indentation.
256              L    No indentation.
257              I    Indent text with the value of number register Si.
258              C    Center each line
259              CB   Center the whole display as a block.
260              R    Right adjust the lines.
261              RB   Right adjust the whole display as a block
262
263              L, I, C and CB can also be specified as 0, 1, 2 or 3 for compat‐
264              ibility reasons.  (Don't use it. :-)
265
266              fill
267              ""   Line-filling turned off.
268              none Line-filling turned off.
269              N    Line-filling turned off.
270              F    Line-filling turned on.
271
272              N and F can also be specified as 0 or 1.   An  empty  line  will
273              normally  be printed before and after the display.  Setting num‐
274              ber register Ds to 0 will prevent this.   Rindent  shortens  the
275              line length by that amount.
276
277       EC [title [override [flag [refname]]]]
278              Equation  title.   Sets  a  title for an equation.  The override
279              argument change the numbering.
280
281              flag
282              none override is a prefix to the number.
283              0    override is a prefix to the number.
284              1    override is a suffix to the number.
285              2    override replaces the number.
286              EC uses the number register Ec as counter.  It  is  possible  to
287              use  .af to change the format of the number.  If number register
288              Of is 1, then the format of title will use a dash instead  of  a
289              dot after the number.
290              The  string  Le  controls  the  title  of the List of Equations,
291              default is LIST OF EQUATIONS.  The List of Equations  will  only
292              be  printed  if  number register Le is 1, default 0.  The string
293              Liec contains the word Equation, wich is printed before the num‐
294              ber.  If refname is used, then the equation number is saved with
295              .SETR, and can be retrieved with .GETST refname.
296              Special handling of the title will occur if EC  is  used  inside
297              DS/DE, it will not be affected by the format of DS.
298
299       EF [arg]
300              Even-page  footer,  printed just above the normal page footer on
301              even pages, see PF.
302
303       EH [arg]
304              Even-page header, printed just below the normal page  header  on
305              even pages, see PH.
306
307       EN     Equation end, see EQ.
308
309       EOP    End  of  page  user-defined  macro.   This  macro will be called
310              instead of the normal printing of the footer.  The macro will be
311              executed  in  a  separate  environment, without any trap active.
312              See TP.
313
314              Strings available to EOP
315              EOPf Argument from PF.
316              EOPefArgument from EF.
317              EOPofArgument from OF.
318
319       EPIC [-L] width height [name]
320              EPIC draws a box with the given width and height, it  will  also
321              print  the  text  name or a default string if name is not speci‐
322              fied..  This is used to include external pictures, just give the
323              size  of  the  picture.   -L  will  leftadjust  the picture, the
324              default is to center adjust.  See PIC
325
326       EQ [label]
327              Equation start.  EQ/EN are the delimiters for equations  written
328              for  eqn.   EQ/EN must be inside a DS/DE-pair, except when EQ is
329              only used to set options in eqn.  The label will appear  at  the
330              right  margin  of  the equation, unless number register Eq is 1.
331              Then the label will appear at the left margin.
332
333       EX [title [override [flag [refname]]]]
334              Exhibit title, arguments are the same as for EC.   EX  uses  the
335              number register Ex as counter.  The string Lx controls the title
336              of the List of Exhibits, default is LIST OF EXHIBITS.  The  List
337              of  Exhibits  will  only  be printed if number register Lx is 1,
338              default 1.  The string Liex contains the word Exhibit, which  is
339              printed before the number.  If refname is used, then the exhibit
340              number is saved with .SETR, and can  be  retrieved  with  .GETST
341              refname.
342              Special  handling  of  the title will occur if EX is used inside
343              DS/DE, it will not be affected by the format of DS.
344
345       FC [closing]
346              Prints Yours very truly, as a formal closing of a letter or mem‐
347              orandum.  The argument replaces the defualt string.  The default
348              is stored in string variable Letfc.
349
350       FD [arg [1]]
351              Footnote default format.   Controls  the  hyphenation  (hyphen),
352              right  margin  justification  (adjust),  indentation of footnote
353              text (indent).  It  can  also  change  the  label  justification
354              (ljust).
355
356              arg  hyphen  adjust  indent  ljust
357              0    no      yes     yes     left
358              1    yes     yes     yes     left
359              2    no      no      yes     left
360              3    yes     no      yes     left
361              4    no      yes     no      left
362              5    yes     yes     no      left
363              6    no      no      no      left
364              7    yes     no      no      left
365              8    no      yes     yes     right
366              9    yes     yes     yes     right
367              10   no      no      yes     right
368              11   yes     no      yes     right
369
370              Argument  greater  than  or  equal to 11 is considered as arg 0.
371              Default for mm is 10.
372
373       FE     Footnote end.
374
375       FG [title [override [flag [refname]]]]
376              Figure title, arguments are the same as for  EC.   FG  uses  the
377              number register Fg as counter.  The string Lf controls the title
378              of the List of Figures, default is LIST OF FIGURES.  The List of
379              Figures will only be printed if number register Lf is 1, default
380              1.  The string Lifg contains the word Figure,  wich  is  printed
381              before  the  number.  If refname is used, then the figure number
382              is saved with .SETR, and can be retrieved with .GETST refname.
383              Special handling of the title will occur if FG  is  used  inside
384              DS/DE, it will not be affected by the format of DS.
385
386       FS [label]
387              Footnote start.  The footnote is ended by FE.  Footnotes is nor‐
388              mally automatically numbered, the number is available in  string
389              F.   Just  add \*F in the text.  By adding label, it is possible
390              to have other number or names on the  footnotes.   Footnotes  in
391              displays  is  now  possible.  An empty line separates footnotes,
392              the height of the line is  controlled  by  number  register  Fs,
393              default value is 1.
394
395       GETHN refname [varname]
396              Includes  the  headernumber where the corresponding SETR refname
397              was placed.  Will be X.X.X. in pass 1.  See INITR.   If  varname
398              is used, GETHN sets the stringvariable varname to the headernum‐
399              ber.
400
401       GETPN refname [varname]
402              Includes the pagenumber where the corresponding SETR refname was
403              placed.   Will  be  9999  in  pass 1.  See INITR.  If varname is
404              used, GETPN sets the stringvariable varname to the pagenumber.
405
406       GETR refname
407              Combines GETHN and GETPN with the text 'chapter' and  ',  page'.
408              The string Qrf contains the text for reference:
409                   .ds Qrf See chapter \\*[Qrfh], page \\*[Qrfp].
410              Qrf may be changed to support other languages.  Strings Qrfh and
411              Qrfp are set by GETR and contains the page and headernumber.
412
413       GETST refname [varname]
414              Includes the string saved with the  second  argument  to  .SETR.
415              Will  be  dummystring in pass 1.  If varname is used, GETST sets
416              the stringvariable varname to the saved string.  See INITR.
417
418       H level [heading-text [heading-suffix]]
419              Numbered section heading.  Section  headers  can  have  a  level
420              between 1 and 7, level 1 is the top level.  The text is given in
421              heading-text, and must be surrounded by double quotes if it con‐
422              tains spaces.  Heading-suffix is added to the header in the text
423              but not in the table of contents.  This  is  normally  used  for
424              footnote  marks  and  similar things.  Don't use \*F in heading-
425              suffix, it won't work.  A manual label must be used, see FS.
426
427              An eventual paragraph, P, directly after H will be ignored, H is
428              taking care of spacing and indentation.
429
430              Page ejection before heading
431              Number  register  Ej  controls page ejection before the heading.
432              Normally, a level one heading gets two blank  lines  before  it,
433              higher  levels gets only one.  A new page is ejected before each
434              first-level heading if number register  Ej  is  1.   All  levels
435              below  or  equal the value of Ej gets a new page.  Default value
436              for Ej is 0.
437
438              Heading break level
439              A line break occurs after the heading if the  heading  level  is
440              less or equal to number register Hb.  Default value 2.
441
442              Heading space level
443              A  blank line is inserted after the heading if the heading level
444              is less or equal to number register Hs.  Default value 2.
445
446              Text will follow the heading on the same line if  the  level  is
447              greater than both Hb and Hs.
448
449              Post-heading indent
450              Indentation  of the text after the heading is controlled by num‐
451              ber register Hi, default value 0.
452
453              Hi
454              0    The text will be left-justified.
455              1    Indentation of the text will follow  the  value  of  number
456                   register Pt, see P.
457              2    The  text will be lined up with the first word of the head‐
458                   ing.
459
460              Centered section headings
461              All headings whose level is equal or below  number  register  Hc
462              and also less than or equal to Hb or Hs is centerered.
463
464              Font control of the heading
465              The  font  of each heading level is controlled by string HF.  It
466              contains a fontnumber or fontname for each  level.   Default  is
467              2 2 2 2 2 2 2  (all  headings in italic).  Could also be written
468              as I I I I I I I.  Note  that  some  other  implementations  use
469              3 3 2 2 2 2 2 as the default value.  All omitted values are pre‐
470              sumed to be a 1.
471
472              Point size control.
473              String HP controls the pointsize of each heading,  in  the  same
474              way  as  HF controls the font.  A value of 0 selects the default
475              point size.  Default value is 0 0 0 0 0 0 0.  Beware  that  only
476              the point size changes, not the vertical size.  That can be con‐
477              trolled by the user specified macro HX and/or HZ.
478
479              Heading counters
480              Seven number registers, named H1 thru H7  contains  the  counter
481              for  each  heading  level.   The values are printed using arabic
482              numerals, this can be changed with the  macro  HM  (see  below).
483              All  marks are concatenated before printing.  To avoid this, set
484              number register Ht to 1.  That will only print the current head‐
485              ing counter at each heading.
486
487              Automatic table of contents
488              All headings whose level is equal or below number register Cl is
489              saved to be printed in the table  of  contents.   Default  value
490              is 2.
491
492              Special control of the heading, user-defined macros.
493              These  macros  can be defined by the user to get a finer control
494              of vertical spacing, fonts or other features.  Argument level is
495              the level-argument to H, but 0 for unnumbered headings (see HU).
496              Argument rlevel is the real level, it is set to number  register
497              Hu  for  unnumbered headings.  Argument heading-text is the text
498              argument to H and HU.
499
500              HX level rlevel heading-text
501              HX is called just before the printing of the heading.  The  fol‐
502              lowing  register  is  available for HX.  HX may alter }0, }2 and
503              ;3.
504              string }0
505                   Contains the heading mark plus two spaces if rlevel is non-
506                   zero, otherwise empty.
507              register ;0
508                   Contains  the  position  of  the text after the heading.  0
509                   means that the text should follow the heading on  the  same
510                   line,  1  means  that  a line break should occur before the
511                   text and 2 means that a  blank  line  should  separate  the
512                   heading and the text.
513              string }2
514                   Contains  two  spaces  if  register ;0 is 0.  It is used to
515                   separate the heading from the text.  The string is empty if
516                   ;0 is non-zero.
517              register ;3
518                   Contains  the  needed  space  in  units  after the heading.
519                   Default is 2v.
520
521                   Can be used to change things like numbering (}0),  vertical
522                   spacing (}2) and the needed space after the heading.
523
524              HY dlevel rlevel heading-text
525              HY  is called after size and font calculations and might be used
526              to change indentation.
527
528              HZ dlevel rlevel heading-text
529              HZ is called after the printing of the heading, just before H or
530              HU  exits.  Could be used to change the page header according to
531              the section heading.
532
533       HC [hyphenation-character]
534              Set hyphenation character.  Default value is \%.  Resets to  the
535              default  if  called without argument.  Hyphenation can be turned
536              off by setting number register Hy to 0 in the beginning  of  the
537              file.
538
539       HM [arg1 [arg2 [... [arg7]]]]
540              Heading  mark  style.  Controls the type of marking for printing
541              of the heading counters.  Default is 1 for all levels.
542
543              Argument
544              1    Arabic numerals.
545              0001 Arabic numerals with leading zeroes, one or more.
546              A    Upper-case alphabetic
547              a    Lower-case alphabetic
548              I    Upper-case roman numerals
549              i
550                   lower-case roman numerals
551              emptyArabic numerals.
552
553       HU heading-text
554              Unnumbered section header.  HU behavies like H at the  level  in
555              number register Hu.  See H.
556
557       HX dlevel rlevel heading-text
558              Userdefined  heading  exit.   Called  just  before  printing the
559              header.  See H.
560
561       HY dlevel rlevel heading-text
562              Userdefined heading  exit.   Called  just  before  printing  the
563              header.  See H.
564
565       HZ dlevel rlevel heading-text
566              Userdefined  heading  exit.   Called  just  after  printing  the
567              header.  See H.
568
569       I [italic-text [prev-font-text [italic-text [...]]]]
570              Italic.  Changes the font to italic if called without arguments.
571              With  one  argument  it  will  set the word in italic.  With two
572              argument it will concatenate them and  set  the  first  word  in
573              italic  and  the second in the previous font.  There is no limit
574              on the number of argument, all will be concatenated.
575
576       IA [addressee-name [title]]
577              Begins specification of the addressee and addressee's address in
578              letter  style.  Several names can be specified with empty IA/IE-
579              pairs, but only one address.  See LT.
580
581       IB [italic-text [bold-text [italic-text [...]]]]
582              Italic-bold.  Even arguments is printed in italic, odd in  bold‐
583              face.  See I.
584
585       IE     Ends the address-specification after IA.
586
587       INITI type filename [macro]
588              Initialize  the  new  index system, sets the filename to collect
589              index lines in with IND.  Argument  type  selects  the  type  of
590              index, page number, header marks or both.  The default is N.
591
592              It  is  also  possible to create a macro that is responsible for
593              formatting each row.  Add the name of the macro  as  argument 3.
594              The macro will be called with the index as argument(s).
595
596              type
597              N    Page numbers
598              H    Header marks
599              B    Both page numbers and header marks, tab separated
600
601       INITR filename
602              Initialize  the  refencemacros.   References  will be written to
603              stderr and is supposed to be written to filename.qrf.   Requires
604              two  passes  with  groff,  this is handled by a separate program
605              called mmroff, the reason is that groff is often installed with‐
606              out  the unsafe operations that INITR requiered.  The first pass
607              looks for references and the second one  includes  them.   INITR
608              can  be  used several times, but it is only the first occurrence
609              of INITR that is active.
610
611              See also SETR, GETPN and GETHN.
612
613       IND arg1 [arg2 [...]]
614              IND writes a line in the index file selected by INITI  with  all
615              arguments and the page number or header mark separated by tabs.
616                   Examples
617                   arg1\tpage number
618                   arg1\targ2\tpage number
619                   arg1\theader mark
620                   arg1\tpage number\theader mark
621
622       INDP   INDP prints the index by running the command specified by string
623              variable Indcmd, normally sort -t\t.  INDP reads the output from
624              the  command  to form the index, normally in two columns (can be
625              changed by defining TYIND).  The index is  printed  with  string
626              variable Index as header, default is INDEX.  One-column process‐
627              ing is returned after the list.  INDP will call the user-defined
628              macros  TXIND,  TYIND  and  TZIND  if  defined.  TXIND is called
629              before printing INDEX,  TYIND  is  called  instead  of  printing
630              INDEX.   TZIND is called after the printing and should take care
631              of restoring to normal operation again.
632
633       ISODATE [0]
634              ISODATE changes the predefined date string in DT to  ISO-format,
635              ie  YYYY-MM-DD.   This can also be done by adding -rIso=1 on the
636              command line.  Reverts to old date format if argument is 0.
637
638       IR [italic-text [roman-text [italic-text [...]]]]
639              Italic-roman.  Even arguments  is  printed  in  italic,  odd  in
640              roman.  See I.
641
642       LB text-indent mark-indent pad type [mark [LI-space [LB-space]]]
643              List  begin macro.  This is the common macro used for all lists.
644              Text-indent is the number of spaces to indent the text from  the
645              current indent.
646
647              Pad and mark-indent controls where to put the mark.  The mark is
648              placed within the mark area, and mark-indent sets the number  of
649              spaces  before this area.  It is normally 0.  The mark area ends
650              where the text begins.  The start of  the  text  is  still  con‐
651              trolled by text-indent.
652
653              The mark is left justified whitin the mark area if pad is 0.  If
654              pad is greater than 0, then mark-indent is ignored, and the mark
655              is  placed  pad spaces before the text.  This will right justify
656              the mark.
657
658              If type is 0 the list will have either a hanging indent  or,  if
659              argument mark is given, the string mark as mark.
660
661              If type is greater than 0 automatic numbering will occur, arabic
662              if mark is empty.  Mark can then be any of 1, A, a, I or i.
663
664              Type selects one of six possible ways to display the mark.
665              type
666               1    x.
667               2    x)
668               3    (x)
669               4    [x]
670               5    <x>
671               6    {x}
672
673              Every item in the list will get LI-space number of  blank  lines
674              before them.  Default is 1.
675
676              LB itself will print LB-space blank lines.  Default is 0.
677
678       LC [list-level]
679              List-status  clear.  Terminates all current active lists down to
680              list-level, or 0 if no argmuent is given.  This is used by H  to
681              clear any active list.
682
683       LE [1] List  end.  Terminate the current list.  LE outputs a blank line
684              if an argument is given.
685
686       LI [mark [1]]
687              List item precedes every item in a list.   Without  argument  LI
688              will  print  the  mark  determined by the current list type.  By
689              giving LI one argument, it will use that as  the  mark  instead.
690              Two arguments to LI will make mark a prefix to the current mark.
691              There will be no separating space between  the  prefix  and  the
692              mark  if  the second argument is 2 instead of 1.  This behaviour
693              can also be achieved by setting number register Limsp  to  zero.
694              A zero length mark will make a hanging indent instead.
695
696              A blank line is normally printed before the list item.  This be‐
697              haviour can be controlled by number  register  Ls.   Pre-spacing
698              will  occur  for  each  list-level  less  than  or  equal to Ls.
699              Default value is 99.  (Nesting of lists is unlimited. :-)
700
701              The indentation can be changed thru number register Li.  Default
702              is 6.
703
704              All  lists  begins  with a list initialization macro, LB.  There
705              are, however, seven predefined listtypes to make lists easier to
706              use.  They all call LB with different default values.
707              AL   Automatically Incremented List
708              ML   Marked List
709              VL   Variable-Item List
710              BL   Bullet List
711              DL   Dash List
712              RL   Reference List
713              BVL  Broken Varable List.
714              These  lists  are described at other places in this manual.  See
715              also LB.
716
717       LT [arg]
718              Formats a letter in one of four different  styles  depending  on
719              the argument.  See also INTERNALS.
720              Arg  Style
721              BL   Blocked.   Date  line, return address, writer's address and
722                   closing begins at the center of the line.  All other  lines
723                   begin at the left margin.
724              SB   Semi-blocked.   Same as blocked, except that the first line
725                   in every paragraph is indented five spaces.
726              FB   Full-blocked.  All lines begin at the left margin.
727              SP   Simplified.  Almost the same  as  the  full-blocked  style.
728                   Subject and the writer's identification are printed in all-
729                   capital.
730
731       LO type [arg]
732              Specify options in letter (see .LT).  This  is  a  list  of  the
733              standard options:
734              CN   Confidential  notation.   Prints CONFIDENTIAL on the second
735                   line below the date line.  Any argument replaces  CONFIDEN‐
736                   TIAL.  See also string variable LetCN.
737              RN   Reference  notation.  Prints In reference to: and the argu‐
738                   ment two lines below the date line.  See also string  vari‐
739                   able LetRN.
740              AT   Attention.   Prints  ATTENTION:  and the argument below the
741                   inside address.  See also string variable LetAT.
742              SA   Salutation.  Prints To Whom It May Concern: or the argument
743                   if  it  was  present.   The salutation is printed two lines
744                   below the inside address.  See also string variable LetSA.
745              SJ   Subject line.  Prints the argument as subject prefixed with
746                   SUBJECT: two lines below the inside address, except in let‐
747                   ter type SP.  Then the subject is  printed  in  all-captial
748                   without any prefix.  See also string variable LetSJ.
749
750       MC column-size [column-separation]
751              Begin multiple columns.  Return to normal with 1C.  MC will cre‐
752              ate as many columns as the current line length permits.  Column-
753              size  is  the width of each column, and column-separation is the
754              space between two columns.  Default separation  is  the  column-
755              size/15.  See also 1C.
756
757       ML mark [text-indent [1]]
758              Marked  list  start.   The  mark argument will be printed before
759              each list item.  Text-indent sets the indent and  overrides  Li.
760              A  third  argument will prohibit printing of a blank line before
761              each item.
762
763       MT [arg [addressee]]
764              Memorandum  type.   The  arg  is   part   of   a   filename   in
765              /usr/share/groff/1.18.1.4/tmac/mm/*.MT.   Memorandum type 0 thru
766              5 are supported, including  "string".   Addressee  just  sets  a
767              variable, used in the AT&T macros.
768              arg
769              0    Normal memorandum, no type printed
770              1    Memorandum with MEMORANDUM FOR FILE printed
771              2    Memorandum with PROGRAMMER'S NOTES printed
772              3    Memorandum with ENGINEER'S NOTES printed
773              4    Released paper style
774              5    External letter style
775              See also COVER/COVEND, a more flexible type of front page.
776
777       MOVE y-pos [x-pos [line-length]]
778              Move  to a position, pageoffset set to x-pos.  If line-length is
779              not given, the difference between current and new pageoffset  is
780              used.  Use PGFORM without arguments to return to normal.
781
782       MULB cw1 space1 [cw2 space2 [cw3 ...]]
783              Begin  a special multi-column mode.  Every columns width must be
784              specified.  Also the space between the columns  must  be  speci‐
785              fied.  The last column does not need any space-definition.  MULB
786              starts a diversion and MULE ends the diversion  and  prints  the
787              columns.   The unit for width and space is 'n', but MULB accepts
788              all normal unitspecifications like 'c' and 'i'.   MULB  operates
789              in a separate environment.
790
791       MULN   Begin the next column.  This is the only way to switch column.
792
793       MULE   End the multi-column mode and print the columns.
794
795       nP [type]
796              Print numbered paragraph with header level two.  See .P.
797
798       NCOL   Force  printing to the next column, don't use this together with
799              the MUL* macros, see 2C.
800
801       NS [arg [1]]
802              Prints different  types  of  notations.   The  argument  selects
803              between  the  predefined type of notations.  If the second argu‐
804              ment is available, then the argument becomes  the  entire  nota‐
805              tion.   If the argument doesn't exist in the predefined, it will
806              be printed as Copy (arg) to.  It is possible to add  more  stan‐
807              dard notations, see the string variable Letns and Letnsdef.
808              Arg  Notation
809              none Copy To
810              ""   Copy To
811              1    Copy To (with att.) to
812              2    Copy To (without att.) to
813              3    Att.
814              4    Atts.
815              5    Enc.
816              6    Encs.
817              7    Under separate cover
818              8    Letter to
819              9    Memorandum to
820              10   Copy (with atts.) to
821              11   Copy (without atts.) to
822              12   Abstract Only to
823              13   Complete Memorandum to
824              14   CC
825
826       ND new-date
827              New  date.   Override  the current date.  Date is not printed if
828              new-date is an empty string.
829
830       OF [arg]
831              Odd-page footer, a line printed just above  the  normal  footer.
832              See EF and PF.
833
834       OH [arg]
835              Odd-page  header,  a  line printed just below the normal header.
836              See EH and PH.
837
838       OP     Make sure that the following text is printed at the  top  of  an
839              odd-numbered  page.   Will not output an empty page if currently
840              at the top of an odd page.
841
842       P [type]
843              Begin new paragraph.  P without argument will produce left  jus‐
844              tified  text, even the first line of the paragraph.  This is the
845              same as setting type to 0.  If the argument is 1, then the first
846              line  of text following P will be indented by the number of spa‐
847              ces in number register Pi, normally 5.
848
849              Instead of giving 1 as argument to P it is possible to  set  the
850              paragraph type in number register Pt.  Using 0 and 1 will be the
851              same as adding that value to P.  A value of 2  will  indent  all
852              paragraphs, except after headings, lists and displays.
853
854              The  space between two paragraphs is controlled by number regis‐
855              ter Ps, and is 1 by default (one blank line).
856
857       PGFORM [linelength [pagelength [pageoffset [1]]]]
858              Sets linelength, pagelength and/or pageoffset.  This  macro  can
859              be  used for special formatting, like letterheads and other.  It
860              is normally the first command in a file, though it's not  neces‐
861              sary.   PGFORM can be used without arguments to reset everything
862              after a MOVE.  A line-break is done unless the  fourth  argument
863              is given.  This can be used to avoid the pagenumber on the first
864              page while setting new width and length.  (It seems as  if  this
865              macro  sometimes  doesn't  work  too well.  Use the command line
866              arguments  to  change  linelength,  pagelength  and   pageoffset
867              instead.  Sorry.)
868
869       PGNH   No  header  is printed on the next page.  Used to get rid of the
870              header in letters or other special texts.  This  macro  must  be
871              used  before  any  text  to  inhibit the pageheader on the first
872              page.
873
874       PIC [-L] [-C] [-R] [-I n] filename [width [height]]
875              PIC includes a Postscript  file  in  the  document.   The  macro
876              depends  on  mmroff  and INITR.  -L, -C, -R and -I n adjusts the
877              picture or indents it.  The optionally width and height can also
878              be given to resize the picture.
879
880       PE     Picture end.  Ends a picture for pic, see the manual for pic.
881
882       PF [arg]
883              Page  footer.   PF  sets the line to be printed at the bottom of
884              each page.  Normally empty.  See PH for the argument  specifica‐
885              tion.
886
887       PH [arg]
888              Page  header, a line printed at the top of each page.  The argu‐
889              ment  should  be  specified  as   "'left-part'center-part'right-
890              part'", where left-, center- and right-part is printed left-jus‐
891              tified, centered  and  right  justified.   The  character  %  is
892              changed  to the current page number.  The default page-header is
893              "''- % -''", the page number between two dashes.
894
895       PS     Picture start (from pic).  Begins a picture  for  pic,  see  the
896              manual.
897
898       PX     Page-header  user-defined  exit.   PX  is  called just after the
899              printing of the page header in no-space mode.
900
901       R      Roman.  Return to roman font, see also I.
902
903       RB [roman-text [bold-text [roman-text [...]]]]
904              Roman-bold.  Even arguments is printed in roman,  odd  in  bold‐
905              face.  See I.
906
907       RD [prompt [diversion [string]]]
908              Read  from  standard input to diversion and/or string.  The text
909              will be saved in a diversion named diversion.  Recall  the  text
910              by  writing  the  name  of the diversion after a dot on an empty
911              line.  A string will also be defined if string is given.  Diver‐
912              sion and/or prompt can be empty ("").
913
914       RF     Reference  end.  Ends a reference definition and returns to nor‐
915              mal processing.  See RS.
916
917       RI [roman-text [italic-text [roman-text [...]]]]
918              Even arguments are printed in roman, odd in italic.  See I.
919
920       RL [text-indent [1]]
921              Reference list start.  Begins a list where each item is preceded
922              with a automatically incremented number between square brackets.
923              Text-indent changes the default indentation.
924
925       RP [arg1 [arg2]]
926              Produce reference page.  RP can be used if a reference  page  is
927              wanted  somewhere  in  the  document.  It is not needed if TC is
928              used to produce a table of content.   The  reference  page  will
929              then be printed automatically.
930
931              The reference counter will not be reset if arg1 is 1.
932
933              Arg2 tells RP whether to eject a page or not.
934              Arg2
935              0    The  reference  page  will  be  printed on a separate page.
936                   This is the default.
937              1    Do not eject page after the list.
938              2    Do not eject page before the list.
939              3    Do not eject page before and after the list.
940              The reference items will be separated by a blank line.   Setting
941              number register Ls to 0 will suppress the line.
942
943              The  string Rp contains the reference page title and is normally
944              set to REFERENCES.
945
946       RS [string-name]
947              RS begins an automatically numbered reference  definition.   Put
948              the  string  \*(Rf  where the reference mark should be and write
949              the reference between RS/RF at next new line after the reference
950              mark.  The reference number is stored in number register :R.  If
951              string-name is given, a string with that name  will  be  defined
952              and  contain the current reference mark.  The string can be ref‐
953              erenced as \*[string-name] later in the text.
954
955       S [size [spacing]]
956              Set point size and vertical spacing.  If any argument  is  equal
957              'P',  then  the  previous  value  is  used.  A 'C' means current
958              value, and 'D' default value.  If '+' or '-' is used before  the
959              value,  then increment or decrement of the current value will be
960              done.
961
962       SA [arg]
963              Set  right-margin  justification.   Justification  is   normally
964              turned  on.   No  argumenent  or  0 turns off justification, a 1
965              turns on justification.
966
967       SETR refname [string]
968              Remember the current header and page-number as  refname.   Saves
969              string  if  string is defined.  string is retrieved with .GETST.
970              See INITR.
971
972       SG [arg [1]]
973              Signature line.  Prints the authors  name(s)  after  the  formal
974              closing.   The  argument will be appended to the reference data,
975              printed at either the first or last author.  The reference  data
976              is the location, department and initials specified with .AU.  It
977              will be printed at the first author if the  second  argument  is
978              given, otherwise at the last.  No reference data will be printed
979              if the author(s) is specifed thru .WA/.WE.  See INTERNALS.
980
981       SK [pages]
982              Skip pages.  If pages is 0 or omitted, a skip to the  next  page
983              will occur unless it is already at the top of a page.  Otherwise
984              it will skip pages pages.
985
986       SM string1 [string2 [string3]]
987              Make a string smaller.  If string2 is  given,  string1  will  be
988              smaller  and  string2  normal,  concatenated with string1.  With
989              three argument, all is concatenated, but only  string2  is  made
990              smaller.
991
992       SP [lines]
993              Space  vertically.  lines can have any scalingfactor, like 3i or
994              8v.  Several SP in a line will only produce the  maximum  number
995              of  lines, not the sum.  SP will also be ignored until the first
996              textline in a page.  Add a \& before SP to avoid this.
997
998       TAB    reset tabs to every 5n.  Normally used  to  reset  any  previous
999              tabpositions.
1000
1001       TB [title [override [flag [refname]]]]
1002              Table title, arguments are the same as for EC.  TB uses the num‐
1003              ber register Tb as counter.  The string Lt controls the title of
1004              the  List  of  Tables,  default  is LIST OF TABLES.  The List of
1005              Tables will only be printed if number register Lt is 1,  default
1006              1.   The  string  Litb  contains the word TABLE, wich is printed
1007              before the number.
1008              Special handling of the title will occur if TB  is  used  inside
1009              DS/DE, it will not be affected by the format of DS.
1010
1011       TC [slevel [spacing [tlevel [tab [h1 [h2 [h3 [h4 [h5]]]]]]]]]
1012              Table of contents.  This macro is normally used at the last line
1013              of the document.  It generates a table of contents with headings
1014              up  to the level controlled by number register Cl.  Note that Cl
1015              controls the saving of headings, it has nothing to do  with  TC.
1016              Headings  with level less than or equal to slevel will get spac‐
1017              ing number of lines before them.  Headings with level less  than
1018              or  equal to tlevel will have their page numbers right justified
1019              with dots or spaces separating the text  and  the  page  number.
1020              Spaces  is  used  if  tab  is greater than zero, otherwise dots.
1021              Other headings will have the page number directly at the end  of
1022              the heading text (ragged right).
1023
1024              The  rest of the arguments will be printed, centered, before the
1025              table of contents.
1026
1027              The user-defined macros TX and TY are used if TC is called  with
1028              at  most  four  arguments.   TX is called before the printing of
1029              CONTENTS, and TY is called instead of printing CONTENTS.
1030
1031              Equivalent macros can be defined for list  of  figures,  tables,
1032              equations and excibits by defining TXxx or TYxx, where xx is Fg,
1033              TB, EC or EX.
1034
1035              String Ci can be set to control the indentations for each  head‐
1036              ing-level.   It must be scaled, like .ds Ci .25i .5i .75i 1i 1i.
1037              The indentation is normally controlled by the maxlength of head‐
1038              ings in each level.
1039
1040              All  texts  can  be  redefined,  new stringvariables Lifg, Litb,
1041              Liex, Liec  and  Licon  contain  "Figure",  "TABLE",  "Exhibit",
1042              "Equation" and "CONTENTS".  These can be redefined to other lan‐
1043              guages.
1044
1045       TE     Table end.  See TS.
1046
1047       TH [N] Table header.  See TS.  TH ends the header of the  table.   This
1048              header will be printed again if a page-break occurs.  Argument N
1049              isn't implemented yet.
1050
1051       TL [charging-case number(s) [filing-case number(s)]]
1052              Begin title of memorandum.  All  text  up  to  the  next  AU  is
1053              included in the title.  Charging-case number and filing-case are
1054              saved for use in the front page processing.
1055
1056       TM [num1 [num2 [...]]]
1057              Technical memorandumnumbers used in .MT.   Unlimited  number  of
1058              arguments may be given.
1059
1060       TP     Top of page user-defined macro.  This macro is called instead of
1061              the normal page header.  It is possible to get complete  control
1062              over  the  header.   Note that header and footer is printed in a
1063              separate environment.  Linelength is preserved though.
1064
1065       TS [H] Table start.  This is the start of a table specification to tbl.
1066              See separate manual for tbl.  TS ends with TE.  Argument H tells
1067              mm that the table has a header.  See TH.
1068
1069       TX     Userdefined table of contents exit.  This macro is  called  just
1070              before TC prints the word CONTENTS.  See TC.
1071
1072       TY     Userdefined  table of contents exit (no "CONTENTS").  This macro
1073              is called instead of printing CONTENTS.  See TC.
1074
1075       VERBON [flag [pointsize [font]]]
1076              Begin verbatim output using courier font.  Usually for  printing
1077              programs.   All character has equal width.  The pointsize can be
1078              changed with the second argument.  By specifying the  font-argu‐
1079              ment  it  is  possible  to  use another font instead of courier.
1080              flag controls several special features.  It contains the sum  of
1081              all wanted features.
1082              ValueDescription
1083              1    Disable  the escape-character (\).  This is normally turned
1084                   on during verbose output.
1085              2    Add an empty line before the verbose text.
1086              4    Add an empty line after the verbose text.
1087              8    Print the verbose text with numbered lines.  This adds four
1088                   digitsized  spaces  in  the  beginning of each line.  Finer
1089                   control is available with the string-variable  Verbnm.   It
1090                   contains  all  arguments to the troff-command .nm, normally
1091                   '1'.
1092              16   Indent the verbose text with  five  'n':s.   This  is  con‐
1093                   trolled by the number-variable Verbin (in units).
1094
1095       VERBOFF
1096              End verbatim output.
1097
1098       VL text-indent [mark-indent [1]]
1099              Variable-item  list  has no fixed mark, it assumes that every LI
1100              have a mark instead.  Text-indent sets the indent to  the  text,
1101              and  mark-indent  the  distance  from  the current indent to the
1102              mark.  A third argument will prohibit printing of a  blank  line
1103              before each item.
1104
1105       VM [-T] [top [bottom]]
1106              Vertical  margin.  Adds  extra  vertical  top  and margin space.
1107              Option -T set the total space instead.  No argument  resets  the
1108              margin  to  zero  or  the  default (7v 5v) if -T was used. It is
1109              higly recommended that macro TP and/or EOP are defined if  using
1110              -T  and  setting  top  and/or  bottom  margin  to  less than the
1111              default.
1112
1113       WA [writer-name [title]]
1114              Begins specification of the writer and writer's  address.   Sev‐
1115              eral names can be specified with empty WA/WE-pairs, but only one
1116              address.
1117
1118       WE     Ends the address-specification after .WA.
1119
1120       WC [format]
1121              Footnote and display width control.
1122              N    Set default mode, -WF, -FF, -WD and FB.
1123              WF   Wide footnotes, wide also in two-column mode.
1124              -WF  Normal footnote width, follow column mode.
1125              FF   All footnotes gets the same width  as  the  first  footnote
1126                   encountered.
1127              -FF  Normal footnotes, width follows WF and -WF.
1128              WD
1129                   Wide displays, wide also in two-column mode.
1130              -WD  Normal display width, follow column mode.
1131              FB   Floating  displays  generates  a line break when printed on
1132                   the current page.
1133              -FB  Floating displays does not generate line break.
1134
1135
1136
1137
1138       Strings used in mm:
1139
1140       App    A string containing the word "APPENDIX".
1141
1142       Apptxt
1143
1144       The current appendix text.
1145              EM Em dash string
1146
1147       H1txt  Will be updated by .H and .HU to the current heading text.  Also
1148              updated in table of contents & friends.
1149
1150       HF     Fontlist  for  headings,  normally  "2 2 2 2 2 2 2".  Nonnumeric
1151              fontnames may also be used.
1152
1153       HP     Pointsize list for headings.  Normally "0 0 0 0 0 0 0" which  is
1154              the same as "10 10 10 10 10 10 10".
1155
1156       Index
1157
1158       Contains INDEX.
1159              Indcmd
1160
1161       Contains the index command, sort -t\t.
1162              Lifg String containing Figure.
1163
1164       Litb   String containing TABLE.
1165
1166       Liex   String containing Exhibit.
1167
1168       Liec   String containing Equation.
1169
1170       Licon  String containing CONTENTS.
1171
1172       Lf     Contains "LIST OF FIGURES".
1173
1174       Lt     Contains "LIST OF TABLES".
1175
1176       Lx     Contains "LIST OF EXHIBITS".
1177
1178       Le     Contains "LIST OF EQUATIONS".
1179
1180       Letfc  Contains "Yours very truly,", used in .FC.
1181
1182       Letapp Contains "APPROVED:", used in .AV.
1183
1184       Letdate
1185              Contains "Date", used in .AV.
1186
1187       LetCN  Contains "CONFIDENTIAL", used in .LO CN.
1188
1189       LetSA  Contains "To Whom It May Concern:", used in .LO SA.
1190
1191       LetAT  Contains "ATTENTION:", used in .LO AT.
1192
1193       LetSJ  Contains "SUBJECT:", used in .LO SJ.
1194
1195       LetRN  Contains "In reference to:", used in .LO RN.
1196
1197       Letns  is an array containing the different strings used in .NS.  It is
1198              really a number of stringvariables prefixed with Letns!.  If the
1199              argument  doesn't  exist,  it  will  be included between () with
1200              Letns!copy as prefix and Letns!to as suffix.  Observe the  space
1201              after copy and before to.
1202              Name           Value
1203              Letns!0        Copy to
1204              Letns!1        Copy (with att.) to
1205              Letns!2        Copy (without att.) to
1206              Letns!3        Att.
1207              Letns!4        Atts.
1208              Letns!5        Enc.
1209              Letns!6        Encs.
1210              Letns!7        Under separate cover
1211              Letns!8        Letter to
1212              Letns!9        Memorandum to
1213              Letns!10       Copy (with atts.) to
1214              Letns!11       Copy (without atts.) to
1215              Letns!12       Abstract Only to
1216              Letns!13       Complete Memorandum to
1217              Letns!14       CC
1218              Letns!copy     Copy "
1219              Letns!to       " to
1220
1221       Letnsdef
1222              Defines  the standard-notation used when no argument is given to
1223              .NS.  Default is 0.
1224
1225       MO1 - MO12
1226              Strings containing January thru December.
1227
1228       Qrf    String containing "See chapter \\*[Qrfh], page \\n[Qrfp].".
1229
1230       Rp     Contains "REFERENCES".
1231
1232       Tcst   Contains current status of table of contents and list  of  XXXX.
1233              Empty outside .TC.  Useful in user-defined macros like .TP.
1234              Value          Meaning
1235              co             Table of contents
1236              fg             List of figures
1237              tb             List of tables
1238              ec             List of equations
1239              ex             List of exhibits
1240              ap             Appendix
1241
1242       Tm     Contains \(tm, trade mark.
1243
1244       Verbnm Argument to .nm in .VERBON, default: 1.
1245
1246       Number variables used in mm:
1247
1248       Aph    Print  an  appendix-page  for every new appendix if this number‐
1249              variable is non-zero.  No output will occur if Aph is zero,  but
1250              there  will  always  be  an  appendix-entry in the 'List of con‐
1251              tents'.
1252
1253       Cl     Contents level [0:7], contents saved if  heading  level  <=  Cl,
1254              default 2.
1255
1256       Cp     Eject page between LIST OF XXXX if Cp == 0, default 0.
1257
1258       D      Debugflag,  values >0 produces varying degree of debug.  A value
1259              of 1  gives  information  about  the  progress  of   formatting,
1260              default 0.
1261
1262       De     Eject after floating display is output [0:1], default 0.
1263
1264       Dsp    Controls  the  space  output before and after static displays if
1265              defined.  Otherwise is the value of Lsp used.
1266
1267       Df     Floating keep output [0:5], default 5.
1268
1269       Ds     Lsp space before and after display if == 1 [0:1], default 1.
1270
1271       Ej     Eject page, default 0.
1272
1273       Eq     Equation lable adjust 0=left, 1=right.  Default 0.
1274
1275       Fs     Footnote spacing, default 1.
1276
1277       H1-H7  Heading counters
1278
1279       H1dot  Append a dot after the level one heading number if > 0.  Default
1280              is 1.
1281
1282       H1h
1283
1284       Copy of number register H1, but it is incremented
1285              just  before  the  page  break.   Useful  in user defined header
1286              macros.  Hb Heading break level [0:7], default 2.
1287
1288       Hc     Heading centering level, [0:7].  Default 0.
1289
1290       Hi     Heading temporary indent [0:2], default 1.
1291              0 -> 0 indent, left margin
1292              1 -> indent to right , like .P 1
1293              2 -> indent to line up with text part of preceding heading
1294
1295       Hps    Numbervariable with the heading pre-space level.  If  the  head‐
1296              ing-level is less than or equal to Hps, then two lines will pre‐
1297              cede the section heading instead of one.  Default is first level
1298              only.   The  real amount of lines is controlled by the variables
1299              Hps1 and Hps2.
1300
1301       Hps1   This is the number of lines preceding .H when the  heading-level
1302              is greater than Hps.  Value is in units, normally 0.5.
1303
1304       Hps2   This  is the number of lines preceding .H when the heading-level
1305              is less than or equal to Hps.  Value is in units, normally 1.
1306
1307       Hs     Heading space level [0:7], default 2.
1308
1309       Hss    This is the number of lines that follows .H  when  the  heading-
1310              level  is  less  than  or  equal to Hs.  Value is in units, nor‐
1311              mally 1.
1312
1313       Ht     Heading numbering type, default 0.  0 -> multiple (1.1.1 ...)
1314              1 -> single
1315
1316       Hu     Unnumbered heading level, default 2.
1317
1318       Hy     Hyphenation in body, default 1.
1319              0 -> no hyphenation
1320              1 -> hyphenation 14 on
1321
1322       Iso    Set this variable to 1 on the command line to get  ISO-formatted
1323              date string.  (-rIso=1) Useless inside a document.
1324
1325       L      Page length, only for command line settings.
1326
1327       Letwam Max lines in return-address, used in .WA/.WE.  Default 14.
1328
1329       Lf, Lt, Lx, Le
1330              Enables  (1)  or  disables  (0) the printing of List of figures,
1331              List  of  tables,  List  of  exhibits  and  List  of  equations.
1332              Default: Lf=1, Lt=1, Lx=1, Le=0.
1333
1334       Li     List indent, used by .AL, default 6.
1335
1336       Limsp  Flag for space between prefix and mark in automatic lists (.AL).
1337              0 == no space
1338              1 == space
1339
1340       Ls     List space, if current listlevel > Ls then no spacing will occur
1341              around lists.  Default 99.
1342
1343       Lsp    The size of an empty line.  Normally 0.5v, but it is 1v if n  is
1344              set (.nroff).
1345
1346       N      Numbering style [0:5], default 0.
1347              0 == (default) normal header for all pages.
1348              1 == header replaces footer on first page, header is empty.
1349              2 == page header is removed on the first page.
1350              3 == "section-page" numbering enabled.
1351              4 == page header is removed on the first page.
1352              5 == "section-page" and "section-figure" numbering enabled.  See
1353              also the number-register Sectf and Sectp.
1354
1355       Np     Numbered paragraphs, default 0.
1356              0 == not numbered
1357              1 == numbered in first level headings.
1358
1359       O      Page offset, only for command line settings.
1360
1361       Of     Format of figure,table,exhibit,equation titles, default 0.
1362              0 = ". "
1363              1 = " - "
1364
1365       P      Current page-number, normally the same  as  %  unless  "section-
1366              page" numbering is enabled.
1367
1368       Pi     paragraph indent, default 5.
1369
1370       Pgps   Controls  whether  header and footer pointsize should follow the
1371              current setting or just change when the  header  and  footer  is
1372              defined.
1373              ValueDescription
1374              0    Pointsize will only change to the current setting when .PH,
1375                   .PF, .OH, .EH, .OF or .OE is executed.
1376              1    Pointsize will change after every .S.  This is the default.
1377
1378       Ps     paragraph spacing, default 1.
1379
1380       Pt     Paragraph type, default 0.
1381              0 == left-justified
1382              1 == indented .P
1383              2 == indented .P except after .H, .DE or .LE.
1384
1385       Sectf  Flag controlling "section-figures".  A  non-zero  value  enables
1386              this.  See also register N.
1387
1388       Sectp  Flag   controlling  "section-page-numbers".   A  non-zero  value
1389              enables this.  See also register N.
1390
1391       Si     Display indent, default 5.
1392
1393       Verbin Indent for .VERBON, default 5n.
1394
1395       W      Line length, only for command line settings.
1396
1397       .mgm   Always 1.
1398

INTERNALS

1400       The letter macros is using different submacros depending on the  letter
1401       type.   The  name of the submacro has the letter type as suffix.  It is
1402       therefore possible to define other letter types, either in the national
1403       macro-file,  or  as local additions.  .LT will set the number variables
1404       Pt and Pi to 0 and 5.  The following strings and macros must be defined
1405       for a new letter type:
1406
1407       let@init_type
1408              This  macro  is  called directly by .LT.  It is supposed to ini‐
1409              tialize variables and other stuff.
1410
1411       let@head_type
1412              This macro prints the letter head, and is called instead of  the
1413              normal  page  header.   It  is  supposed  to  remove  the  alias
1414              let@header, otherwise it will be called for all pages.
1415
1416       let@sg_type name title n flag [arg1 [arg2 [...]]]
1417              .SG is calling this macro only for letters, memorandums has  its
1418              own processing.  name and title is specified thru .WA/.WB.  n is
1419              the counter, 1-max, and flag is true for  the  last  name.   Any
1420              other argument to .SG is appended.
1421
1422       let@fc_type closing
1423              This macro is called by .FC, and has the formal closing as argu‐
1424              ment.
1425
1426       .LO is implemented as a  general  option-macro.   .LO  demands  that  a
1427       string  named  Lettype  is defined, where type is the letter type.  .LO
1428       will then assign the argument to the string variable let*lo-type.
1429

AUTHOR

1431       Jörgen Hägg, Lund, Sweden <jh@axis.se>.
1432

FILES

1434       /usr/share/groff/1.18.1.4/tmac/tmac.m
1435
1436       /usr/share/groff/1.18.1.4/tmac/mm/*.cov
1437
1438       /usr/share/groff/1.18.1.4/tmac/mm/*.MT
1439
1440       /usr/share/groff/1.18.1.4/tmac/mm/locale
1441

SEE ALSO

1443       groff(1), troff(1), tbl(1), pic(1), eqn(1)
1444       groff_mmse(7)
1445
1446
1447
1448Groff Version 1.18.1.4          25 January 2008                    GROFF_MM(7)
Impressum