











































































                      --MMEE RREEFFEERREENNCCEE MMAANNUUAALL

                          _R_e_l_e_a_s_e _2_._2_9


                         _E_r_i_c _P_. _A_l_l_m_a_n_*

                         Project INGRES
                 Electronics Research Laboratory
               University of California, Berkeley
                   Berkeley, California  94720





     This document describes in extremely terse form the features
of the --mmee macro package for  version  seven  NROFF/TROFF.   Some
familiarity  is  assumed  with those programs.  Specifically, the
reader should understand breaks, fonts, pointsizes, the  use  and
definition of number registers and strings, how to define macros,
and scaling factors for ens, points, vv's (vertical line  spaces),
etc.

     For  a  more  casual  introduction  to text processing using
NROFF, refer to the document _W_r_i_t_i_n_g _P_a_p_e_r_s _w_i_t_h _N_R_O_F_F _u_s_i_n_g _-_m_e_.

     There are a number of macro parameters that may be adjusted.
Fonts may be set to a font number only.  Font 8 means  bold  font
in  TROFF;  in NROFF font 8 is underlined unless the --rrbb33 flag is
specified to use "true bold" font (most versions of NROFF do  not
interpret  bold font nicely).  Font 0 is no font change; the font
of the surrounding text is used instead.  Notice that fonts 0 and
8  are "pseudo-fonts"; that is, they are simulated by the macros.
This means that although it is legal to set a  font  register  to
zero  or eight, it is not legal to use the escape character form,
such as:

    \f8


     All distances are in basic units, so  it  is  nearly  always
necessary  to  use a scaling factor.  For example, the request to
____________________
   *Author's  current  address:  Computer Science Division, EECS,
University of California, Berkeley, California 94720.
   [+]NROFF  and  TROFF  may be trademarks of AT&T Bell Laborato-
ries.




--mmee RReeffeerreennccee MMaannuuaall                                     UUSSDD::2200--11







UUSSDD::2200--22                                     --mmee RReeffeerreennccee MMaannuuaall


set the paragraph indent to eight one-en spaces is:

    .nr pi 8n

and not

    .nr pi 8

which would set the paragraph indent to  eight  basic  units,  or
about  0.02 inch.  Default parameter values are given in brackets
in the remainder of this document.

     Registers and strings of the form $$_x may be used in  expres-
sions  but  should not be changed.  Macros of the form $$_x perform
some function (as described) and may be redefined to change  this
function.  This may be a sensitive operation; look at the body of
the original macro before changing it.

     All names in -me follow a rigid naming convention.  The user
may  define  number registers, strings, and macros, provided that
s/he uses single character upper case names or  double  character
names  consisting  of letters and digits, with at least one upper
case letter.  In no case should special  characters  be  used  in
user-defined names.

     On  daisy wheel type printers in twelve pitch, the --rrxx11 flag
can be stated to make lines default to one eighth inch (the  nor-
mal spacing for a newline in twelve-pitch).  This is normally too
small for easy readability, so the default is to space one  sixth
inch.

     The  --rrvv22 flag will indicates that this _i_s being output on a
C/A/T phototypesetter; this changes the page offset  and  inserts
cut marks.

     This documentation was NROFF'ed

on May 13, 2024 and applies to version 2.29 of the -me macros.

11..  PPaarraaggrraapphhiinngg

     These  macros  are  used  to begin paragraphs.  The standard
paragraph macro is ..pppp; the others are all variants  to  be  used
for special purposes.

     The  first call to one of the paragraphing macros defined in
this section or the ..sshh macro (defined in the next session)  _i_n_i_-
_t_i_a_l_i_z_e_s  the  macro  processor.   After initialization it is not
possible to use any of the following requests: ..sscc, ..lloo, ..tthh,  or
..aacc.   Also, the effects of changing parameters which will have a
global effect on the format of the page (notably page length  and
header  and  footer  margins)  are not well defined and should be
avoided.










--mmee RReeffeerreennccee MMaannuuaall                                     UUSSDD::2200--33


..llpp            Begin  left-justified  paragraph.   Centering  and
               underlining  are  turned  off if they were on, the
               font is set to \\nn((ppff [1] the type size is  set  to
               \\nn((pppp  [10p], and a \\nn((ppss space is inserted before
               the paragraph [0.35v in TROFF, 1v or 0.5v in NROFF
               depending  on  device  resolution].  The indent is
               reset to \\nn(($$ii [0] plus \\nn((ppoo [0] unless the para-
               graph  is  inside a display.  (see ..bbaa).  At least
               the first two lines  of  the  paragraph  are  kept
               together on a page.

..pppp            Like  ..llpp, except that it puts \\nn((ppii [5n] units of
               indent.  This is the standard paragraph macro.

..iipp_ _T_ _I        Indented paragraph with hanging tag.  The body  of
               the  following  paragraph is indented _I spaces (or
               \\nn((iiii [5n] spaces if _I is not specified) more than
               a  non-indented  paragraph  (such as with ..pppp) is.
               The title _T is exdented  (opposite  of  indented).
               The  result  is a paragraph with an even left edge
               and _T printed in the margin.  Any spaces in _T must
               be  unpaddable.   If  _T  will not fit in the space
               provided, ..iipp will start a new line.

..nnpp            A variant of .ip which numbers  paragraphs.   Num-
               bering  is  reset  after  a ..llpp, ..pppp, or ..sshh.  The
               current paragraph number is in \\nn(($$pp.

..bbuu            Like ..nnpp except that paragraphs  are  marked  with
               bullets  (+o).  Leading space is eliminated to cre-
               ate compact lists.

22..  SSeeccttiioonn HHeeaaddiinnggss

     Numbered sections are similar to paragraphs  except  that  a
section number is automatically generated for each one.  The sec-
tion numbers are of the form 11..22..33.  The _d_e_p_t_h of the section  is
the count of numbers (separated by decimal points) in the section
number.

     Unnumbered section headings are similar, except that no num-
ber is attached to the heading.

..sshh_ _+_N_ _T_ _a_ _b_ _c _dBe_egi_fn  numbered section of depth _N.  If _N is miss-
               ing the current depth (maintained  in  the  number
               register  \\nn(($$00) is used.  The values of the indi-
               vidual parts of the section number are  maintained
               in  \\nn(($$11  through  \\nn(($$66.   There is a \\nn((ssss [1v]
               space before the section.  _T is printed as a  sec-
               tion title in font \\nn((ssff [8] and size \\nn((sspp [10p].
               The "name" of the  section  may  be  accessed  via
               \\**(($$nn.   If  \\nn((ssii is non-zero, the base indent is
               set to \\nn((ssii times  the  section  depth,  and  the










UUSSDD::2200--44                                     --mmee RReeffeerreennccee MMaannuuaall


               section  title  is exdented.  (See ..bbaa.)  Also, an
               additional indent of \\nn((ssoo [0]  is  added  to  the
               section  title  (but  not  to the body of the sec-
               tion).  The font is  then  set  to  the  paragraph
               font,  so  that  more information may occur on the
               line with  the  section  number  and  title.   ..sshh
               insures  that  there  is  enough room to print the
               section head plus the  beginning  of  a  paragraph
               (about  3 lines total).  If _a through _f are speci-
               fied, the section number is  set  to  that  number
               rather  than incremented automatically.  If any of
               _a through _f are a hyphen that number is not reset.
               If _T is a single underscore ("_") then the section
               depth and numbering is reset, but the base  indent
               is  not reset and nothing is printed out.  This is
               useful to automatically coordinate section numbers
               with chapter numbers.

..ssxx_ _+_N         Go  to  section depth _N [--11], but do not print the
               number and title, and do not increment the section
               number  at level _N.  This has the effect of start-
               ing a new paragraph at level _N.

..uuhh_ _T          Unnumbered  section  heading.   The  title  _T   is
               printed  with  the  same  rules for spacing, font,
               etc., as for ..sshh.

..$$pp_ _T_ _B_ _N      Print section heading.  May be  redefined  to  get
               fancier  headings.   _T  is the title passed on the
               ..sshh or ..uuhh line; _B is the section number for  this
               section,  and  _N  is  the  depth  of this section.
               These parameters are not always present;  in  par-
               ticular, ..sshh passes all three, ..uuhh passes only the
               first, and ..ssxx passes three, but the first two are
               null  strings.  Care should be taken if this macro
               is redefined; it is quite complex and subtle.

..$$00_ _T_ _B_ _N      This macro is  called  automatically  after  every
               call to ..$$pp.  It is normally undefined, but may be
               used to automatically put every section title into
               the  table  of  contents or for some similar func-
               tion.  _T is the  section  title  for  the  section
               title  which  was  just  printed, _B is the section
               number, and _N is the section depth.

..$$11_ -_ ..$$66      Traps called just before printing that depth  sec-
               tion.   May be defined to (for example) give vari-
               able spacing before sections.   These  macros  are
               called from ..$$pp, so if you redefine that macro you
               may lose this feature.













--mmee RReeffeerreennccee MMaannuuaall                                     UUSSDD::2200--55


33..  HHeeaaddeerrss aanndd FFooootteerrss

     Headers and footers are put at the top and bottom  of  every
page  automatically.   They  are  set  in font \\nn((ttff [3] and size
\\nn((ttpp [10p].  Each of the definitions apply as of the _n_e_x_t  page.
Three-part titles must be quoted if there are two blanks adjacent
anywhere in the title or more than eight blanks total.

     The spacing of headers and footers are controlled  by  three
number registers.  \\nn((hhmm [4v] is the distance from the top of the
page to the top of the header, \\nn((ffmm [3v] is  the  distance  from
the bottom of the page to the bottom of the footer, \\nn((ttmm [7v] is
the distance from the top of the page to the top of the text, and
\\nn((bbmm  [6v]  is  the  distance from the bottom of the page to the
bottom of the text (nominal).  The macros ..mm11, ..mm22, ..mm33, and  ..mm44
are also supplied for compatibility with ROFF documents.

..hhee_ _'_l_'_m_'_r_'    Define three-part header, to be printed on the top
               of every page.

..ffoo_ _'_l_'_m_'_r_'    Define footer, to be  printed  at  the  bottom  of
               every page.

..eehh_ _'_l_'_m_'_r_'    Define  header,  to be printed at the top of every
               even-numbered page.

..oohh_ _'_l_'_m_'_r_'    Define header, to be printed at the top  of  every
               odd-numbered page.

..eeff_ _'_l_'_m_'_r_'    Define  footer,  to  be  printed  at the bottom of
               every even-numbered page.

..ooff_ _'_l_'_m_'_r_'    Define footer, to be  printed  at  the  bottom  of
               every odd-numbered page.

..hhxx            Suppress headers and footers on the next page.

..mm11_ _+_N         Set  the space between the top of the page and the
               header [4v].

..mm22_ _+_N         Set the space between the  header  and  the  first
               line of text [2v].

..mm33_ _+_N         Set  the  space between the bottom of the text and
               the footer [2v].

..mm44_ _+_N         Set the space between the footer and the bottom of
               the page [4v].

..eepp            End  this  page,  but  do not begin the next page.
               Useful for forcing out footnotes, but  other  than
               that hardly every used.  Must be followed by a ..bbpp
               or the end of input.










UUSSDD::2200--66                                     --mmee RReeffeerreennccee MMaannuuaall


..$$hh            Called at every page to print the header.  May  be
               redefined  to  provide  fancy  (e.g.,  multi-line)
               headers, but doing so loses the  function  of  the
               ..hhee, ..ffoo, ..eehh, ..oohh, ..eeff, and ..ooff requests, as well
               as the chapter-style title feature of ..++cc.

..$$ff            Print footer; same comments apply as in ..$$hh.

..$$HH            A normally undefined macro which is called at  the
               top  of  each  page (after putting out the header,
               initial saved  floating  keeps,  etc.);  in  other
               words,  this  macro  is  called immediately before
               printing text on a page.  It can be used for  col-
               umn headings and the like.

44..  DDiissppllaayyss

     All  displays  except  centered  blocks and block quotes are
preceded and followed by an extra \\nn((bbss [same  as  \\nn((ppss]  space.
Quote  spacing  is stored in a separate register; centered blocks
have no default initial or trailing space.  The vertical  spacing
of  all  displays  except quotes and centered blocks is stored in
register \\nn(($$RR instead of \\nn(($$rr.

..((ll_ _m_ _f        Begin list.  Lists  are  single  spaced,  unfilled
               text.   If  _f is FF, the list will be filled.  If _m
               [II] is II the list is indented by \\nn((bbii [4m]; if  MM
               the  list is indented to the left margin; if LL the
               list is left justified with respect  to  the  text
               (different  from MM only if the base indent (stored
               in \\nn(($$ii and set with ..bbaa) is not zero); and if  CC
               the list is centered on a line-by-line basis.  The
               list is set in font \\nn((ddff [0].  Must be matched by
               a  ..))ll.  This macro is almost like ..((bb except that
               no attempt is made to  keep  the  display  on  one
               page.

..))ll            End list.

..((qq            Begin  major  quote.   These  are  single  spaced,
               filled, moved in from the text on  both  sides  by
               \\nn((qqii  [4n],  preceded and followed by \\nn((qqss [same
               as \\nn((bbss] space, and are set in point  size  \\nn((qqpp
               [one point smaller than surrounding text].

..))qq            End major quote.

..((bb_ _m_ _f        Begin block.  Blocks are a form of _k_e_e_p, where the
               text of a keep is kept together  on  one  page  if
               possible  (keeps are useful for tables and figures
               which should not be broken over a page).   If  the
               block  will not fit on the current page a new page
               is begun, _u_n_l_e_s_s that would leave more than  \\nn((bbtt










--mmee RReeffeerreennccee MMaannuuaall                                     UUSSDD::2200--77


               [0]  white  space  at  the bottom of the text.  If
               \\nn((bbtt is zero, the  threshold  feature  is  turned
               off.   Blocks  are  not filled unless _f is FF, when
               they are filled.  The block will be left-justified
               if  _m  is  LL,  indented by \\nn((bbii [4m] if _m is II or
               absent, centered (line-for-line) if _m  is  CC,  and
               left  justified  to  the  margin  (not to the base
               indent) if _m is MM.  The block is set in font \\nn((ddff
               [0].

..))bb            End block.

..((zz_ _m_ _f        Begin  floating  keep.   Like  ..((bb except that the
               keep is _f_l_o_a_t_e_d to the bottom of the page  or  the
               top  of  the  next  page.  Therefore, its position
               relative to the text changes.  The  floating  keep
               is  preceded  and  followed  by  \\nn((zzss [1v] space.
               Also, it defaults to mode MM.

..))zz            End floating keep.

..((cc            Begin centered block.  The next keep  is  centered
               as a block, rather than on a line-by-line basis as
               with ..((bb CC.  This call may be nested inside keeps.

..))cc            End centered block.

55..  AAnnnnoottaattiioonnss

..((dd            Begin  delayed  text.  Everything in the next keep
               is saved for output later with ..ppdd,  in  a  manner
               similar to footnotes.

..))dd_ _n          End  delayed text.  The delayed text number regis-
               ter \\nn(($$dd and the associated string \\**## are incre-
               mented if \\**## has been referenced.

..ppdd            Print  delayed  text.  Everything diverted via ..((dd
               is printed and truncated.  This might be  used  at
               the end of each chapter.

..((ff            Begin  footnote.   The  text  of  the  footnote is
               floated to the bottom of the page and set in  font
               \\nn((ffff [1] and size \\nn((ffpp [8p].  Each entry is pre-
               ceded by \\nn((ffss [0.2v]  space,  is  indented  \\nn((ffii
               [3n]  on the first line, and is indented \\nn((ffuu [0]
               from the right margin.  Footnotes line  up  under-
               neath two column output.  If the text of the foot-
               note will not all fit on one page it will be  car-
               ried over to the next page.

..))ff_ _n          End  footnote.   The number register \\nn(($$ff and the
               associated string \\**** are incremented if they have










UUSSDD::2200--88                                     --mmee RReeffeerreennccee MMaannuuaall


               been referenced.

..$$ss            The  macro to output the footnote separator.  This
               macro may be redefined to give other size lines or
               other  types  of separators.  Currently it draws a
               1.5i line.

..((xx_ _x          Begin index entry.  Index entries are saved in the
               index  _x [xx] until called up with ..xxpp..  Each entry
               is preceded by a \\nn((xxss [0.2v] space.   Each  entry
               is "undented" by \\nn((xxuu [0.5i]; this register tells
               how far the page number  extends  into  the  right
               margin.

..))xx_ _P_ _A        End index entry.  The index entry is finished with
               a row of dots with _A [null] right justified on the
               last line (such as for an author's name), followed
               by P [\\nn%%].  If _A is specified, _P must  be  speci-
               fied;  \\nn%%  can  be used to print the current page
               number.  If _P is an underscore, no page number and
               no row of dots are printed.

..xxpp_ _x          Print  index _x [xx].  The index is formatted in the
               font, size, and so forth in effect at the time  it
               is  printed,  rather  than  at the time it is col-
               lected.

66..  CCoolluummnneedd OOuuttppuutt

..22cc_ _+_S_ _N       Enter two-column mode.  The column  separation  is
               set to _+_S [4n, 0.5i in ACM mode] (saved in \\nn(($$ss).
               The column width, calculated to  fill  the  single
               column line length with both columns, is stored in
               \\nn(($$ll.  The current column is in \\nn(($$cc.   You  can
               test  register \\nn(($$mm [1] to see if you are in sin-
               gle column or double column mode.   Actually,  the
               request enters _N [2] column output.

..11cc            Revert to single-column mode.

..bbcc            Begin  column.   This  is  like ..bbpp except that it
               begins a new column on a new page only  if  neces-
               sary,  rather  than  forcing  a  whole new page if
               there is another column left on the current  page.

77..  FFoonnttss aanndd SSiizzeess

..sszz_ _+_P         The  pointsize  is  set  to  _P [10p], and the line
               spacing is set proportionally.  The ratio of  line
               spacing  to  pointsize  is  stored  in \\nn(($$rr.  The
               ratio used internally by displays and  annotations
               is  stored  in \\nn(($$RR (although this is not used by
               ..sszz).  This size is _n_o_t sticky beyond many macros:










--mmee RReeffeerreennccee MMaannuuaall                                     UUSSDD::2200--99


               in  particular,  \\nn((pppp (paragraph pointsize) modi-
               fies the pointsize every time a new  paragraph  is
               begun using the ..pppp, ..llpp, ..iipp, ..nnpp, or ..bbuu macros.
               Also, \\nn((ffpp  (footnote  pointsize),  \\nn((qqpp  (quote
               pointsize),  \\nn((sspp (section header pointsize), and
               \\nn((ttpp (title pointsize) may modify the  pointsize.

..rr_ _W_ _X         Set  _W  in roman font, appending _X in the previous
               font.  To append different font requests, use _X  =
               \\cc.  If no parameters, change to roman font.

..ii_ _W_ _X         Set  _W  in  italics,  appending  _X in the previous
               font.  If no parameters, change  to  italic  font.
               Underlines in NROFF.

..bb_ _W_ _X         Set  _W  in  bold font and append _X in the previous
               font.  If no parameters, switch to bold font.   In
               NROFF, underlines.

..rrbb_ _W_ _X        Set  _W  in  bold font and append _X in the previous
               font.  If no parameters, switch to bold font.  ..rrbb
               differs  from ..bb in that ..rrbb does not underline in
               NROFF.

..uu_ _W_ _X         Underline _W and append _X.  This is a  true  under-
               lining,  as  opposed  to  the  ..uull  request, which
               changes to "underline font"  (usually  italics  in
               TROFF).   It  won't  work  right if _W is spread or
               broken (including hyphenated).  In other words, it
               is safe in nofill mode only.

..qq_ _W_ _X         Quote  _W  and  append  _X.  In NROFF this just sur-
               rounds _W with double quote  marks  (`""'),  but  in
               TROFF uses directed quotes.

..bbii_ _W_ _X        Set  _W  in  bold  italics and append _X.  Actually,
               sets _W in italic and overstrikes once.  Underlines
               in  NROFF.   It won't work right if _W is spread or
               broken (including hyphenated).  In other words, it
               is safe in nofill mode only.

..bbxx_ _W_ _X        Sets  _W  in a box, with _X appended.  Underlines in
               NROFF.  It won't work right if _W is spread or bro-
               ken (including hyphenated).  In other words, it is
               safe in nofill mode only.

ssmm_ _W_ _X         Sets _W in a smaller pointsize, with _X appended.

88..  RRooffff SSuuppppoorrtt

..iixx_ _+_N         Indent, no break.  Equivalent to ''iinn _N.












UUSSDD::2200--1100                                    --mmee RReeffeerreennccee MMaannuuaall


..bbll_ _N          Leave _N contiguous white space, on the  next  page
               if  not enough room on this page.  Equivalent to a
               ..sspp _N inside a block.

..ppaa_ _+_N         Equivalent to ..bbpp.

..rroo            Set page number in roman numerals.  Equivalent  to
               ..aaff %% ii.

..aarr            Set page number in Arabic.  Equivalent to ..aaff %% 11.

..nn11            Number lines in margin from one on each page.

..nn22_ _N          Number lines from _N, stop if _N = 0.

..sskk            Leave the next output page blank, except for head-
               ers  and footers.  This is used to leave space for
               a full-page diagram which is  produced  externally
               and pasted in later.  To get a partial-page paste-
               in display, say ..ssvv _N, where _N is  the  amount  of
               space  to leave; this space will be output immedi-
               ately if there is room, and will otherwise be out-
               put  at  the  top  of  the next page.  However, be
               warned: if _N is greater than the amount of  avail-
               able space on an empty page, no space will ever be
               output.

99..  PPrreepprroocceessssoorr SSuuppppoorrtt

..EEQQ_ _m_ _T        Begin equation.  The equation is centered if _m  is
               CC  or  omitted, indented \\nn((bbii [4m] if _m is II, and
               left justified if _m is LL.  _T is a title printed on
               the  right margin next to the equation.  See _T_y_p_e_-
               _s_e_t_t_i_n_g _M_a_t_h_e_m_a_t_i_c_s _- _U_s_e_r_'_s  _G_u_i_d_e  by  Brian  W.
               Kernighan and Lorinda L. Cherry.

..EENN_ _c          End equation.  If _c is CC the equation must be con-
               tinued by immediately following with another  ..EEQQ,
               the  text of which can be centered along with this
               one.  Otherwise, the equation is  printed,  always
               on  one  page,  with  \\nn((eess  [0.5v in TROFF, 1v in
               NROFF] space above and below it.

..TTSS_ _h          Table start.  Tables are single spaced and kept on
               one  page  if possible.  If you have a large table
               which will not fit on one page, use _h = HH and fol-
               low  the  header part (to be printed on every page
               of the table) with a ..TTHH.  See _T_b_l _- _A _P_r_o_g_r_a_m  _t_o
               _F_o_r_m_a_t _T_a_b_l_e_s by M. E. Lesk.

..TTHH            With  ..TTSS HH, ends the header portion of the table.












--mmee RReeffeerreennccee MMaannuuaall                                    UUSSDD::2200--1111


..TTEE            Table end.  Note that this table does  not  float,
               in  fact, it is not even guaranteed to stay on one
               page if you use requests such  as  ..sspp  intermixed
               with  the  text  of  the table.  If you want it to
               float (or if you use requests inside  the  table),
               surround  the  entire table (including the ..TTSS and
               ..TTEE requests) with the requests ..((zz and ..))zz.

..PPSS_ _h_ _w        Begin _p_i_c picture.  _H is the height and _w  is  the
               width, both in basic units.  _D_i_t_r_o_f_f only.

..PPEE            End picture.

..IISS            Begin _i_d_e_a_l picture.

..IIEE            End _i_d_e_a_l picture.

..IIFF            End _i_d_e_a_l picture (alternate form).

GGSS             Begin _g_r_e_m_l_i_n picture.

GGEE             End _g_r_e_m_l_i_n picture.

GGFF             End _g_r_e_m_l_i_n picture (alternate form).

1100..  MMiisscceellllaanneeoouuss

..rree            Reset  tabs.  Set to every 0.5i in TROFF and every
               0.8i in NROFF.

..bbaa_ _+_N         Set the base indent to _+_N [0]  (saved  in  \\nn(($$ii).
               All  paragraphs,  sections,  and displays come out
               indented by this amount.  Titles and footnotes are
               unaffected.    The  ..sshh  request  performs  a  ..bbaa
               request if \\nn((ssii [0] is not  zero,  and  sets  the
               base indent to \\nn((ssii**\\nn(($$00.

..xxll_ _+_N         Set  the  line  length  to _N [6.0i].  This differs
               from ..llll because it only affects the current envi-
               ronment.

..llll_ _+_N         Set  line  length in all environments to _N [6.0i].
               This should not be used after  output  has  begun,
               and  particularly  not  in two-column output.  The
               current line length is stored in \\nn(($$ll.

..hhll            Draws a horizontal line the length  of  the  page.
               This  is useful inside floating keeps to differen-
               tiate between the text and the figure.

..llhh            Print a letterhead at the current position on  the
               page.   The  format  of  the  letterhead  must  be
               defined in the file  //uussrr//lliibb//mmee//lleetttteerrhheeaadd..mmee  by










UUSSDD::2200--1122                                    --mmee RReeffeerreennccee MMaannuuaall


               your  local  systems staff.  Some environments may
               require _d_i_t_r_o_f_f for this macro to  function  prop-
               erly.

..lloo            This   macro  loads  another  set  of  macros  (in
               //uussrr//lliibb//mmee//llooccaall..mmee) which is intended  to  be  a
               set  of  locally  defined  macros.   These  macros
               should all be of the form ..**_X, where _X is any let-
               ter (upper or lower case) or digit.

1111..  SSttaannddaarrdd PPaappeerrss

..ttpp            Begin  title page.  Spacing at the top of the page
               can occur, and headers and footers are suppressed.
               Also,  the page number is not incremented for this
               page.

..tthh            Set thesis mode.  This defines the  modes  accept-
               able  for a doctoral dissertation at Berkeley.  It
               double spaces, defines the header to be  a  single
               page  number,  and  changes  the margins to be 1.5
               inch on the left and one inch on the top.  ..++++ and
               ..++cc  should  be  used with it.  This macro must be
               stated before initialization, that is, before  the
               first call of a paragraphing macro or ..sshh.

..++++_ _m_ _H        This  request  defines  the  section  of the paper
               which  we  are  entering.   The  section  type  is
               defined  by  _m.   CC means that we are entering the
               chapter portion of the paper, AA means that we  are
               entering  the  appendix  portion  of  the paper, PP
               means that the material following  should  be  the
               preliminary  portion (abstract, table of contents,
               etc.)  portion of the paper, AABB means that we  are
               entering the abstract (numbered independently from
               1 in Arabic numerals), and BB  means  that  we  are
               entering  the  bibliographic portion at the end of
               the paper.  Also,  the  variants  RRCC  and  RRAA  are
               allowed,  which  specify renumbering of pages from
               one at the beginning of each chapter or  appendix,
               respectively.   The  _H  parameter  defines the new
               header.  If there are any spaces in it, the entire
               header  must be quoted.  If you want the header to
               have the chapter number  in  it,  Use  the  string
               \\\\\\\\nn((cchh.   For  example, to number appendixes AA..11
               etc., type ..++++ RRAA  ''''''\\\\\\\\nn((cchh..%%''.   Each  section
               (chapter,  appendix,  etc.)  should be preceded by
               the ..++cc request.  It should be mentioned  that  it
               is  easier when using TROFF to put the front mate-
               rial at the end of the paper, so that the table of
               contents  can be collected and put out; this mate-
               rial can then be physically moved to the beginning
               of the paper.










--mmee RReeffeerreennccee MMaannuuaall                                    UUSSDD::2200--1133


..++cc_ _T          Begin chapter with title _T.  The chapter number is
               maintained in \\nn((cchh.  This register is incremented
               every  time  ..++cc  is called with a parameter.  The
               title and chapter number are printed by ..$$cc.   The
               header is moved to the footer on the first page of
               each chapter.  If _T is omitted, ..$$cc is not called;
               this  is useful for doing your own "title page" at
               the beginning  of  papers  without  a  title  page
               proper.   ..$$cc  calls ..$$CC as a hook so that chapter
               titles can be inserted into a  table  of  contents
               automatically.  The footnote numbering is reset to
               one.

..$$cc_ _T          Print chapter number (from  \\nn((cchh)  and  _T.   This
               macro  can  be  redefined  to  your liking.  It is
               defined by default to be acceptable for a PhD the-
               sis  at  Berkeley.  This macro calls $$CC, which can
               be defined to make index entries, or whatever.

..$$CC_ _K_ _N_ _T      This macro is called by ..$$cc.  It is normally unde-
               fined,  but  can  be  used to automatically insert
               index entries,  or  whatever.   _K  is  a  keyword,
               either  "Chapter"  or "Appendix" (depending on the
               ..++++ mode); _N is the chapter  or  appendix  number,
               and _T is the chapter or appendix title.

..aacc_ _A_ _N        This  macro  (short  for  ..aaccmm)  sets up the NROFF
               environment for camera-ready papers as used by the
               ACM.   This format is 25% larger, and has no head-
               ers or footers.  The author's name _A is printed at
               the  bottom  of  the  page (but off the part which
               will be printed in  the  conference  proceedings),
               together  with  the  current  page  number and the
               total number of pages _N.  Additionally, this macro
               loads the file //uussrr//lliibb//mmee//aaccmm..mmee, which may later
               be augmented with other macros useful for printing
               papers  for  ACM  conferences.  It should be noted
               that this macro will not work correctly in version
               7  TROFF, since it sets the page length wider than
               the physical width of  the  C/A/T  phototypesetter
               roll.

1122..  PPrreeddeeffiinneedd SSttrriinnggss

\\****            Footnote number, actually \\**{{\\nn(($$ff\\**}}.  This macro
               is incremented after each call to ..))ff.

\\**##            Delayed text number.  Actually [\\nn(($$dd].

\\**{{            Superscript.  This string  gives  upward  movement
               and  a change to a smaller point size if possible,
               otherwise it  gives  the  left  bracket  character
               (`[[').   Extra  space  is  left  above the line to










UUSSDD::2200--1144                                    --mmee RReeffeerreennccee MMaannuuaall


               allow room for the superscript.

\\**}}            Unsuperscript.  Inverse to \\**{{.  For  example,  to
               produce  a  superscript  you  might type xx\\**{{22\\**}},
               which will produce xx22.

\\**<<            Subscript.   Defaults  to  `<'  if   half-carriage
               motion  not  possible.   Extra space is left below
               the line to allow for the subscript.

\\**>>            Inverse to \\**<<.

\\**((ddww          The day of the week, as a word.

\\**((mmoo          The month, as a word.

\\**((ttdd          Today's date, directly printable.  The date is  of
               the  form  June  1, 1994.  Other forms of the date
               can be used by using \\nn((ddyy (the day of the  month;
               for  example,  22, \\**((mmoo (as noted above) or \\nn((mmoo
               (the same, but as an ordinal number; for  example,
               December  is 12, and \\nn((yyrr (the last two digits of
               the current year).

\\**((llqq          Left quote marks.  Double quote in NROFF.

\\**((rrqq          Right quote.

\\**--            3/4 em dash in TROFF; two hyphens in NROFF.

1133..  SSppeecciiaall CChhaarraacctteerrss aanndd MMaarrkkss

     There are a number of  special  characters  and  diacritical
marks  (such  as  accents)  available  through -me.  To reference
these characters, you must call the macro ..sscc to define the char-
acters before using them.

..sscc            Define  special  characters and diacritical marks,
               as described in the  remainder  of  this  section.
               This  macro  must be stated before initialization.
               The special characters available are listed below.
                   Name           Usage      Example
                   Acute accent   \*'  a\*'  a'
                   Grave accent   \*`  e\*`  e`
                   Umlat          \*:  u\*:  u..
                   Tilde          \*~  n\*~  n~
                   Caret          \*^  e\*^  e^
                   Cedilla        \*,  c\*,  c,
                   Czech          \*v  e\*v  ev
                   Circle         \*o  A\*o  Ao
                   There exists   \*(qe      ------|
                   For all        \*(qa      \/--











--mmee RReeffeerreennccee MMaannuuaall                                    UUSSDD::2200--1155


AAcckknnoowwlleeddggmmeennttss

     I  would like to thank Bob Epstein, Bill Joy, and Larry Rowe
for having the courage to use the -me macros to produce non-triv-
ial  papers  during  the  development  stages; Ricki Blau, Pamela
Humphrey, and Jim Joyce for their  help  with  the  documentation
phase; peter kessler for numerous complaints, most accompanied by
fixes; and the plethora of people who have contributed ideas  and
have given support for the project.

SSuummmmaarryy

     This  alphabetical  list summarizes all macros, strings, and
number registers available in the  -me  macros.   Selected  _t_r_o_f_f
commands,  registers,  and  functions are included as well; those
listed can generally be used with impunity.

     The columns are the name of the command, macro, register, or
string; the type of the object, and the description.  Types are MM
for macro or builtin command (invoked with ..  or '' in  the  first
input  column),  SS for a string (invoked with \\** or \\**((), RR for a
number register (invoked with \\nn or  \\nn((),  and  FF  for  a  _t_r_o_f_f
builtin  function  (invoked  by  preceding it with a single back-
slash).

     Lines marked with  <s>  are  _t_r_o_f_f  internal  codes.   Lines
marked with [+] or [++] may be defined by the user to get special
functions; [++] indicates that these are defined by  default  and
changing  them  may  have  unexpected side effects.  Lines marked
with o are specific to _d_i_t_r_o_f_f (device-independent _t_r_o_f_f).

    NAME        TYPE  DESCRIPTION
    \(space)    F<s>  unpaddable space
    \"          F<s>  comment (to end of line)
    \*#         S     optional delayed text tag string
    \$_N         F<s>  interpolate argument _N
    \n($0       R     section depth
    .$0         M[+]  invoked after section title printed
    \n($1       R     first section number
    .$1         M[+]  invoked before printing depth 1 section
    \n($2       R     second section number
    .$2         M[+]  invoked before printing depth 2 section
    \n($3       R     third section number
    .$3         M[+]  invoked before printing depth 3 section
    \n($4       R     fourth section number
    .$4         M[+]  invoked before printing depth 4 section
    \n($5       R     fifth section number
    .$5         M[+]  invoked before printing depth 5 section
    \n($6       R     sixth section number
    .$6         M[+]  invoked before printing depth 6 section
    .$C         M[+]  called at beginning of chapter
    .$H         M[+]  text header
    \n($R       R[++] relative vertical spacing in displays










UUSSDD::2200--1166                                    --mmee RReeffeerreennccee MMaannuuaall


    NAME        TYPE  DESCRIPTION
    \n($c       R     current column number
    .$c         M[++] print chapter title
    \n($d       R     delayed text number
    \n($f       R     footnote number
    .$f         M[++] print footer
    .$h         M[++] print header
    \n($i       R     paragraph base indent
    \n($l       R     column width
    \n($m       R     number of columns in effect
    \*($n       S     section name
    \n($p       R     numbered paragraph number
    .$p         M[++] print section heading (internal macro)
    \n($r       R[++] relative vertical spacing in text
    \n($s       R     column indent
    .$s         M[++] footnote separator (from text)
    \n%         R<s>  current page number
    \&          F<s>  zero width character, useful for hiding controls
    \(_x_x        F<s>  interpolate special character _x_x
    .(b         M     begin block
    .(c         M     begin centered block
    .(d         M     begin delayed text
    .(f         M     begin footnote
    .(l         M     begin list
    .(q         M     begin quote
    .(x         M     begin index entry
    .(z         M     begin floating keep
    .)b         M     end block
    .)c         M     end centered block
    .)d         M     end delayed text
    .)f         M     end footnote
    .)l         M     end list
    .)q         M     end quote
    .)x         M     end index entry
    .)z         M     end floating keep
    \*_x         F<s>  interpolate string _x
    \*(_x_x       F<s>  interpolate string _x_x
    \**         S     optional footnote tag string
    .++         M     set paper section type
    .+c         M     begin chapter
    \*,         S     cedilla
    \-          F<s>  minus sign
    \*-         S     3/4 em dash
    \0          F<s>  unpaddable digit-width space
    .1c         M     revert to single column output
    .2c         M     begin two column output
    \*:         S     umlat
    \*<         S     begin subscript
    \*>         S     end subscript
    .EN         M     end equation
    .EQ         M     begin equation
    \L'_d'       F<s>  vertical line drawing function for distance _d
    .GE         Mo    end _g_r_e_m_l_i_n picture










--mmee RReeffeerreennccee MMaannuuaall                                    UUSSDD::2200--1177


    NAME        TYPE  DESCRIPTION
    .GF         Mo    end _g_r_e_m_l_i_n picture (with flyback)
    .GS         Mo    start _g_r_e_m_l_i_n picture
    .IE         Mo    end _i_d_e_a_l picture
    .IF         Mo    end _i_d_e_a_l picture (with flyback)
    .IS         Mo    start _i_d_e_a_l picture
    .PE         Mo    end _p_i_c picture
    .PF         Mo    end _p_i_c picture (with flyback)
    .PS         Mo    start _p_i_c picture
    .TE         M     end table
    .TH         M     end header of table
    .TS         M     begin table
    \*{         S     begin superscript
    \n(.$       R<s>  number of arguments to macro
    \n(.i       R<s>  current indent
    \n(.l       R<s>  current line length
    \n(.s       R<s>  current point size
    \*('        S     acute accent
    \*(`        S     grave accent
    \('         F<s>  acute accent
    \(`         F<s>  grave accent
    \*}         S     end superscript
    \^          F<s>  1/12 em narrow space
    \*^         S     caret
    .ac         M     ACM mode
    .ad         M<s>  set text adjustment
    .af         M<s>  assign format to register
    .am         M<s>  append to macro
    .ar         M     set page numbers in Arabic
    .as         M<s>  append to string
    .b          M     bold font
    .ba         M     set base indent
    .bc         M     begin new column
    .bi         M     bold italic
    \n(bi       R     display (block) indent
    .bl         M     blank lines (even at top of page)
    \n(bm       R     bottom title margin
    .bp         M<s>  begin page
    .br         M<s>  break (start new line)
    \n(bs       R     display (block) pre/post spacing
    \n(bt       R     block keep threshold
    .bx         M     boxed
    \c          F<s>  continue input
    .ce         M<s>  center lines
    \n(ch       R     current chapter number
    .de         M<s>  define macro
    \n(df       R     display font
    .ds         M<s>  define string
    \n(dw       R<s>  current day of week
    \*(dw       S     current day of week
    \n(dy       R<s>  day of month
    \e          F<s>  printable version of \
    .ef         M     set footer (even numbered pages only)










UUSSDD::2200--1188                                    --mmee RReeffeerreennccee MMaannuuaall


    NAME        TYPE  DESCRIPTION
    .eh         M     set header (even numbered pages only)
    .el         M<s>  else part of conditional
    .ep         M     end page
    \n(es       R     equation pre/post space
    \f_f         F<s>  inline font change to font _f
    \f(_f_f       F<s>  inline font change to font _f_f
    .fc         M<s>  set field characters
    \n(ff       R     footnote font
    .fi         M<s>  fill output lines
    \n(fi       R     footnote indent (first line only)
    \n(fm       R     footer margin
    .fo         M     set footer
    \n(fp       R     footnote pointsize
    \n(fs       R     footnote prespace
    \n(fu       R     footnote undent (from right margin)
    \h'_d'       F<s>  local horizontal motion for distance _d
    .hc         M<s>  set hyphenation character
    .he         M     set header
    .hl         M     draw horizontal line
    \n(hm       R     header margin
    .hx         M     suppress headers and footers on next page
    .hy         M<s>  set hyphenation mode
    .i          M     italic font
    .ie         M<s>  conditional with else
    .if         M<s>  conditional
    \n(ii       R     indented paragraph indent
    .in         M<s>  indent (transient, use .ba for pervasive)
    .ip         M     begin indented paragraph
    .ix         M     indent, no break
    \l'_d'       F<s>  horizontal line drawing function for distance _d
    .lc         M<s>  set leader repetition character
    .lh         Mo    interpolate local letterhead
    .ll         M     set line length
    .lo         M     load local macros
    .lp         M     begin left justified paragraph
    \*(lq       S     left quote marks
    .ls         M<s>  set multi-line spacing
    .m1         M     set space from top of page to header
    .m2         M     set space from header to text
    .m3         M     set space from text to footer
    .m4         M     set space from footer to bottom of page
    .mc         M<s>  insert margin character
    .mk         M<s>  mark vertical position
    \n(mo       R<s>  month of year
    \*(mo       S     current month
    \n_x         F<s>  interpolate number register _x
    \n(_x_x       F<s>  interpolate number register _x_x
    .n1         M     number lines in margin
    .n2         M     number lines in margin
    .na         M<s>  turn off text adjustment
    .ne         M<s>  need vertical space
    .nf         M<s>  don't fill output lines










--mmee RReeffeerreennccee MMaannuuaall                                    UUSSDD::2200--1199


    NAME        TYPE  DESCRIPTION
    .nh         M<s>  turn off hyphenation
    .np         M     begin numbered paragraph
    .nr         M<s>  set number register
    .ns         M<s>  no space mode
    \*o         S     circle (e.g., for Norse Ao)
    .of         M     set footer (odd numbered pages only)
    .oh         M     set header (odd numbered pages only)
    .pa         M     begin page
    .pd         M     print delayed text
    \n(pf       R     paragraph font
    \n(pi       R     paragraph indent
    .pl         M<s>  set page length
    .pn         M<s>  set next page number
    .po         M<s>  page offset
    \n(po       R     simulated page offset
    .pp         M     begin paragraph
    \n(pp       R     paragraph pointsize
    \n(ps       R     paragraph prespace
    .q          M     quoted
    \*(qa       S     for all
    \*(qe       S     there exists
    \n(qi       R     quote indent (also shortens line)
    \n(qp       R     quote pointsize
    \n(qs       R     quote pre/post space
    .r          M     roman font
    .rb         M     real bold font
    .re         M     reset tabs
    .rm         M<s>  remove macro or string
    .rn         M<s>  rename macro or string
    .ro         M     set page numbers in roman
    \*(rq       S     right quote marks
    .rr         M<s>  remove register
    .rs         M<s>  restore spacing
    .rt         M<s>  return to vertical position
    \s_S         F<s>  inline size change to size _S
    .sc         M     load special characters
    \n(sf       R     section title font
    .sh         M     begin numbered section
    \n(si       R     relative base indent per section depth
    .sk         M     skip next page
    .sm         M     set argument in a smaller pointsize
    .so         M<s>  source input file
    \n(so       R     additional section title offset
    .sp         M<s>  vertical space
    \n(sp       R     section title pointsize
    \n(ss       R     section prespace
    .sx         M     change section depth
    .sz         M     set pointsize and vertical spacing
    .ta         M<s>  set tab stops
    .tc         M<s>  set tab repetition character
    \*(td       S     today's date
    \n(tf       R     title font










UUSSDD::2200--2200                                    --mmee RReeffeerreennccee MMaannuuaall


    NAME        TYPE  DESCRIPTION
    .th         M     set thesis mode
    .ti         M<s>  temporary indent (next line only)
    .tl         M<s>  three part title
    \n(tm       R     top title margin
    .tp         M     begin title page
    \n(tp       R     title pointsize
    .tr         M<s>  translate
    .u          M     underlined
    .uh         M     unnumbered section
    .ul         M<s>  underline next line
    \v'_d'       F<s>  local vertical motion for distance _d
    \*v         S     inverted `v' for czeck ``ev''
    \w'_S'       F<s>  return width of string _S
    .xl         M     set line length (local)
    .xp         M     print index
    \n(xs       R     index entry prespace
    \n(xu       R     index undent (from right margin)
    \n(yr       R<s>  year (last two digits only)
    \n(zs       R     floating keep pre/post space
    \{          F<s>  begin conditional group
    \|          F<s>  1/6 em narrow space
    \}          F<s>  end conditional group
    \*~         S     tilde



































