home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / bsd_srcs / share / doc / usd / 23.meref / ref.me < prev    next >
Encoding:
Text File  |  1991-04-17  |  40.1 KB  |  2,385 lines

  1. .\" Copyright (c) 1986 The Regents of the University of California.
  2. .\" All rights reserved.
  3. .\"
  4. .\" Redistribution and use in source and binary forms, with or without
  5. .\" modification, are permitted provided that the following conditions
  6. .\" are met:
  7. .\" 1. Redistributions of source code must retain the above copyright
  8. .\"    notice, this list of conditions and the following disclaimer.
  9. .\" 2. Redistributions in binary form must reproduce the above copyright
  10. .\"    notice, this list of conditions and the following disclaimer in the
  11. .\"    documentation and/or other materials provided with the distribution.
  12. .\" 3. All advertising materials mentioning features or use of this software
  13. .\"    must display the following acknowledgement:
  14. .\"    This product includes software developed by the University of
  15. .\"    California, Berkeley and its contributors.
  16. .\" 4. Neither the name of the University nor the names of its contributors
  17. .\"    may be used to endorse or promote products derived from this software
  18. .\"    without specific prior written permission.
  19. .\"
  20. .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21. .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22. .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23. .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24. .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25. .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26. .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27. .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28. .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29. .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30. .\" SUCH DAMAGE.
  31. .\"
  32. .\"    @(#)ref.me    6.5 (Berkeley) 4/17/91
  33. .\"
  34. .UC 7
  35. .ll 6.5i
  36. .lt 6.5i
  37. .pn 0
  38. .ds MO 2.27\"        \" mod number
  39. .de TL            \" *** title line
  40. .lp
  41. .di XX
  42. ..
  43. .de DE            \" *** description
  44. \\\\h'|\\n(DIu'\\\\c
  45. .br
  46. .di
  47. .in +\\n(DIu
  48. .ti 0
  49. .cu 1000
  50. .XX
  51. .rm XX
  52. .cu 0
  53. ..
  54. .ds N \s-1NROFF\s0
  55. .ds T \s-1TROFF\s0
  56. .nr DI 1.5i
  57. \".he '\-ME REFERENCE MANUAL''%'
  58. .de NR
  59. .b "\en\\$1" "\\$2"
  60. ..
  61. .de ST
  62. .b "\e*\\$1" "\\$2"
  63. ..
  64. .sc
  65. .eh 'USD:23-%''\-me Reference Manual'
  66. .oh '\-me Reference Manual''USD:23-%'
  67. .+c
  68. .ce 20
  69. .sz 14
  70. .b "\-ME REFERENCE MANUAL"
  71. .sz
  72. .sp
  73. .i "Release \*(MO"
  74. .sp 2
  75. .ul
  76. Eric P. Allman*
  77. .(f
  78. *Author's current address:
  79. Britton Lee, Inc.,
  80. 1919 Addison Suite 105,
  81. Berkeley, California 94704.
  82. .)f
  83. .sp
  84. Project INGRES
  85. Electronics Research Laboratory
  86. University of California, Berkeley
  87. Berkeley, California  94720
  88. .ce 0
  89. .sp 4
  90. .pp
  91. This document describes
  92. in extremely terse form
  93. the features
  94. of the
  95. .b \-me
  96. macro package
  97. for version seven \*N/\*T\*(dg.
  98. .(f
  99. \(dg\*N and \*T may be trademarks of AT&T Bell Laboratories.
  100. .)f
  101. Some familiarity is assumed
  102. with
  103. those programs.
  104. Specifically,
  105. the reader should understand
  106. breaks,
  107. fonts,
  108. pointsizes,
  109. the use and definition of number registers
  110. and strings,
  111. how to define macros,
  112. and scaling factors for ens, points,
  113. .b v 's
  114. (vertical line spaces),
  115. etc.
  116. .pp
  117. For a more casual introduction
  118. to text processing
  119. using \*N,
  120. refer to the document
  121. .ul
  122. Writing Papers with \*N using \-me.
  123. .pp
  124. There are a number of macro parameters
  125. that may be adjusted.
  126. Fonts may be set to a font number only.
  127. Font 8 means bold font in \*T;
  128. in \*N font 8
  129. is underlined
  130. unless the
  131. .b \-rb3
  132. flag is specified to use
  133. .q "true bold"
  134. font
  135. (most versions of \*N do not interpret bold font nicely).
  136. Font 0 is no font change;
  137. the font of the surrounding text
  138. is used instead.
  139. Notice that fonts 0 and 8 are
  140. .q pseudo-fonts ;
  141. that is,
  142. they are simulated by the macros.
  143. This means that although it is legal to set a font register
  144. to zero or eight,
  145. it is not legal to use the escape character form,
  146. such as:
  147. .(b
  148. \ef8
  149. .)b
  150. .pp
  151. All distances
  152. are in basic units,
  153. so it is nearly always necessary
  154. to use a scaling factor.
  155. For example,
  156. the request
  157. to set the paragraph indent
  158. to eight one-en spaces is:
  159. .(b
  160. \&.nr pi 8n
  161. .)b
  162. and not
  163. .(b
  164. \&.nr pi 8
  165. .)b
  166. which would set the paragraph indent to eight basic units,
  167. or about 0.02 inch.
  168. Default parameter values are given in brackets
  169. in the remainder of this document.
  170. .pp
  171. Registers and strings
  172. of the form
  173. .b $ \c
  174. .i x
  175. may be used in expressions
  176. but should not be changed.
  177. Macros of the form
  178. .b $ \c
  179. .i x
  180. perform some function
  181. (as described)
  182. and may be redefined
  183. to change this function.
  184. This may be a sensitive operation;
  185. look at the body of the original macro
  186. before changing it.
  187. .pp
  188. All names in \-me
  189. follow a rigid naming convention.
  190. The user may define number registers,
  191. strings,
  192. and macros,
  193. provided that s/he
  194. uses single character upper case names
  195. or double character names
  196. consisting of letters and digits,
  197. with at least one upper case letter.
  198. In no case should special characters
  199. be used in user-defined names.
  200. .pp
  201. On daisy wheel type printers
  202. in twelve pitch,
  203. the
  204. .b \-rx1
  205. flag can be stated to make lines default to
  206. one eighth inch
  207. (the normal spacing for a newline in twelve-pitch).
  208. This is normally too small for easy readability,
  209. so the default is to space one sixth inch.
  210. .pp
  211. The
  212. .b \-rv2
  213. flag will indicates that this
  214. .i is
  215. being output on a C/A/T
  216. phototypesetter;
  217. this changes the page offset
  218. and inserts cut marks.
  219. .pp
  220. This documentation was
  221. .if n \*N'ed
  222. .if t \*T'ed
  223. on \*(td
  224. and applies to version
  225. \*(MO
  226. of the \-me macros.
  227. .sh 1 "Paragraphing"
  228. .pp
  229. These macros are used
  230. to begin paragraphs.
  231. The standard paragraph macro
  232. is
  233. .b .pp ;
  234. the others are all variants
  235. to be used for special purposes.
  236. .pp
  237. The first call to one of the paragraphing macros
  238. defined in this section
  239. or the
  240. .b .sh
  241. macro
  242. (defined in the next session)
  243. .i initializes
  244. the macro processor.
  245. After initialization
  246. it is not possible to use any of the following requests:
  247. .b .sc ,
  248. .b .lo ,
  249. .b .th ,
  250. or
  251. .b .ac .
  252. Also,
  253. the effects of changing parameters
  254. which will have a global effect
  255. on the format of the page
  256. (notably page length and header and footer margins)
  257. are not well defined
  258. and should be avoided.
  259. .TL
  260. .b .lp
  261. .DE
  262. Begin left-justified paragraph.
  263. Centering and underlining
  264. are turned off if they were on,
  265. the font is set to
  266. .NR (pf
  267. [1]
  268. the type size
  269. is set to
  270. .NR (pp
  271. [10p],
  272. and a
  273. .NR (ps
  274. space is inserted
  275. before the paragraph
  276. [0.35v in \*T, 1v or 0.5v in \*N
  277. depending on device resolution].
  278. The indent is reset
  279. to
  280. .NR ($i
  281. [0]
  282. plus
  283. .NR (po
  284. [0]
  285. unless the paragraph
  286. is inside a display.
  287. (see
  288. .b .ba ).
  289. At least
  290. the first two lines
  291. of the paragraph
  292. are kept together
  293. on a page.
  294. .TL
  295. .b .pp
  296. .DE
  297. Like
  298. .b .lp ,
  299. except that it puts
  300. .NR (pi
  301. [5n]
  302. units of indent.
  303. This is the standard paragraph macro.
  304. .TL
  305. .b .ip
  306. .i T
  307. .i I
  308. .DE
  309. Indented paragraph
  310. with hanging tag.
  311. The body of the following paragraph
  312. is indented
  313. .i I
  314. spaces
  315. (or
  316. .NR (ii
  317. [5n]
  318. spaces
  319. if
  320. .i I
  321. is not specified)
  322. more than a non-indented paragraph
  323. (such as with
  324. .b .pp )
  325. is.
  326. The title
  327. .i T
  328. is exdented (opposite of indented).
  329. The result is a paragraph
  330. with an even left edge
  331. and
  332. .i T
  333. printed in the margin.
  334. Any spaces in
  335. .i T
  336. must be unpaddable.
  337. If
  338. .i T
  339. will not fit in the space provided,
  340. .b .ip
  341. will start a new line.
  342. .TL
  343. .b .np
  344. .DE
  345. A variant of .ip which numbers paragraphs.
  346. Numbering is reset
  347. after a
  348. .b .lp ,
  349. .b .pp ,
  350. or
  351. .b .sh .
  352. The current paragraph number
  353. is in
  354. .NR ($p .
  355. .TL
  356. .b .bu
  357. .DE
  358. Like
  359. .b .np
  360. except that paragraphs are marked with bullets (\(bu).
  361. Leading space is eliminated to create compact lists.
  362. .sh 1 "Section Headings"
  363. .pp
  364. Numbered sections
  365. are similar to paragraphs
  366. except that a
  367. section number
  368. is automatically
  369. generated for each one.
  370. The section numbers are of the form
  371. .b 1.2.3 .
  372. The
  373. .i depth
  374. of the section
  375. is the count of numbers
  376. (separated by decimal points)
  377. in the section number.
  378. .pp
  379. Unnumbered section headings are similar,
  380. except that no number is attached
  381. to the heading.
  382. .TL
  383. .b .sh
  384. .i +N
  385. .i T
  386. .i "a b c d e f"
  387. .DE
  388. Begin numbered section
  389. of depth
  390. .i N .
  391. If
  392. .i N
  393. is missing
  394. the current depth
  395. (maintained in
  396. the number register
  397. .NR ($0 )
  398. is used.
  399. The values of
  400. the individual parts of the section number
  401. are maintained in
  402. .NR ($1
  403. through
  404. .NR ($6 .
  405. There is a
  406. .NR (ss
  407. [1v]
  408. space before the section.
  409. .i T
  410. is printed
  411. as a section title
  412. in font
  413. .NR (sf
  414. [8]
  415. and size
  416. .NR (sp
  417. [10p].
  418. The
  419. .q name
  420. of the section may be accessed via
  421. .ST ($n .
  422. If
  423. .NR (si
  424. is non-zero,
  425. the base indent
  426. is set to
  427. .NR (si
  428. times the section depth,
  429. and the section title
  430. is exdented.
  431. (See
  432. .b .ba .)
  433. Also,
  434. an additional indent of
  435. .NR (so
  436. [0]
  437. is added to the section title
  438. (but not to the body of the section).
  439. The font is then set
  440. to the paragraph font,
  441. so that more information may occur
  442. on the line
  443. with the section number
  444. and title.
  445. .b .sh
  446. insures that there is enough room
  447. to print the section head
  448. plus the beginning of a paragraph
  449. (about 3 lines total).
  450. If
  451. .i a
  452. through
  453. .i f
  454. are specified,
  455. the section number is set to that number
  456. rather than incremented automatically.
  457. If any of
  458. .i a
  459. through
  460. .i f
  461. are a hyphen
  462. that number is not reset.
  463. If
  464. .i T
  465. is a single underscore
  466. (\c
  467. .q _ )
  468. then the section depth and numbering is reset,
  469. but the base indent is not reset
  470. and nothing is printed out.
  471. This is useful to automatically
  472. coordinate section numbers with
  473. chapter numbers.
  474. .TL
  475. .b .sx
  476. .i +N
  477. .DE
  478. Go to section depth
  479. .i N
  480. [\c
  481. .b \-1 ],
  482. but do not print the number
  483. and title,
  484. and do not increment the section number
  485. at level
  486. .i N .
  487. This has the effect
  488. of starting a new paragraph
  489. at level
  490. .i N .
  491. .TL
  492. .b .uh
  493. .i T
  494. .DE
  495. Unnumbered section heading.
  496. The title
  497. .i T
  498. is printed
  499. with the same rules for spacing,
  500. font, etc.,
  501. as for
  502. .b .sh .
  503. .TL
  504. .b .$p
  505. .i T
  506. .i B
  507. .i N
  508. .DE
  509. Print section heading.
  510. May be redefined
  511. to get fancier headings.
  512. .i T
  513. is the title passed on the
  514. .b .sh
  515. or
  516. .b .uh
  517. line;
  518. .i B
  519. is the section number for this section,
  520. and
  521. .i N
  522. is the depth of this section.
  523. These parameters are not always present;
  524. in particular,
  525. .b .sh
  526. passes all three,
  527. .b .uh
  528. passes only the first,
  529. and
  530. .b .sx
  531. passes three,
  532. but the first two
  533. are null strings.
  534. Care should be taken if this macro
  535. is redefined;
  536. it is quite complex and subtle.
  537. .TL
  538. .b .$0
  539. .i T
  540. .i B
  541. .i N
  542. .DE
  543. This macro is called automatically
  544. after every call to
  545. .b .$p .
  546. It is normally undefined,
  547. but may be used
  548. to automatically put
  549. every section title
  550. into the table of contents
  551. or for some similar function.
  552. .i T
  553. is the section title
  554. for the section title which was just printed,
  555. .i B
  556. is the section number,
  557. and
  558. .i N
  559. is the section depth.
  560. .TL
  561. .b .$1
  562. \-
  563. .b .$6
  564. .DE
  565. Traps called just before printing that depth section.
  566. May be defined to
  567. (for example)
  568. give variable spacing
  569. before sections.
  570. These macros are called from
  571. .b .$p ,
  572. so if you redefine that macro
  573. you may lose this feature.
  574. .sh 1 "Headers and Footers"
  575. .ds TP \fI\(aal\|\(aam\^\(aar\^\(aa\fP
  576. .pp
  577. Headers and footers
  578. are put at the top and bottom
  579. of every page
  580. automatically.
  581. They are set in font
  582. .NR (tf
  583. [3]
  584. and size
  585. .NR (tp
  586. [10p].
  587. Each of the definitions
  588. apply as of the
  589. .i next
  590. page.
  591. Three-part titles
  592. must be quoted
  593. if there are two blanks adjacent
  594. anywhere in the title
  595. or more than eight blanks total.
  596. .pp
  597. The spacing
  598. of headers and footers
  599. are controlled by three number registers.
  600. .NR (hm
  601. [4v]
  602. is the distance from the top of the page
  603. to the top of the header,
  604. .NR (fm
  605. [3v]
  606. is the distance from the bottom of the page
  607. to the bottom of the footer,
  608. .NR (tm
  609. [7v]
  610. is the distance from the top of the page
  611. to the top of the text,
  612. and
  613. .NR (bm
  614. [6v]
  615. is the distance from the bottom of the page
  616. to the bottom of the text
  617. (nominal).
  618. The macros
  619. .b .m1 ,
  620. .b .m2 ,
  621. .b .m3 ,
  622. and
  623. .b .m4
  624. are also supplied for compatibility
  625. with
  626. \s-1ROFF\s0 documents.
  627. .TL
  628. .b .he
  629. \*(TP
  630. .DE
  631. Define three-part header,
  632. to be printed on the top
  633. of every page.
  634. .TL
  635. .b .fo
  636. \*(TP
  637. .DE
  638. Define footer,
  639. to be printed at the bottom
  640. of every page.
  641. .TL
  642. .b .eh
  643. \*(TP
  644. .DE
  645. Define header,
  646. to be printed at the top of every
  647. even-numbered page.
  648. .TL
  649. .b .oh
  650. \*(TP
  651. .DE
  652. Define header,
  653. to be printed at the top of every
  654. odd-numbered page.
  655. .TL
  656. .b .ef
  657. \*(TP
  658. .DE
  659. Define footer,
  660. to be printed at the bottom
  661. of every even-numbered page.
  662. .TL
  663. .b .of
  664. \*(TP
  665. .DE
  666. Define footer,
  667. to be printed at the bottom
  668. of every odd-numbered page.
  669. .TL
  670. .b .hx
  671. .DE
  672. Suppress headers and footers
  673. on the next page.
  674. .TL
  675. .b .m1
  676. .i +N
  677. .DE
  678. Set the space between the top of the page
  679. and the header
  680. [4v].
  681. .TL
  682. .b .m2
  683. .i +N
  684. .DE
  685. Set the space between the header
  686. and the first line of text
  687. [2v].
  688. .TL
  689. .b .m3
  690. .i +N
  691. .DE
  692. Set the space
  693. between the bottom of the text
  694. and the footer
  695. [2v].
  696. .TL
  697. .b .m4
  698. .i +N
  699. .DE
  700. Set the space
  701. between the footer
  702. and the bottom of the page
  703. [4v].
  704. .TL
  705. .b .ep
  706. .DE
  707. End this page,
  708. but do not begin the next page.
  709. Useful for forcing out footnotes,
  710. but other than
  711. that hardly every used.
  712. Must be followed by a
  713. .b .bp
  714. or the end of input.
  715. .TL
  716. .b .$h
  717. .DE
  718. Called at every page
  719. to print the header.
  720. May be redefined
  721. to provide fancy
  722. (e.g.,
  723. multi-line)
  724. headers,
  725. but doing so
  726. loses the function of the
  727. .b .he ,
  728. .b .fo ,
  729. .b .eh ,
  730. .b .oh ,
  731. .b .ef ,
  732. and
  733. .b .of
  734. requests,
  735. as well as the chapter-style title feature
  736. of
  737. .b .+c .
  738. .TL
  739. .b .$f
  740. .DE
  741. Print footer;
  742. same comments apply
  743. as in
  744. .b .$h .
  745. .TL
  746. .b .$H
  747. .DE
  748. A normally undefined macro
  749. which is called
  750. at the top of each page
  751. (after putting out
  752. the header,
  753. initial saved floating keeps,
  754. etc.);
  755. in other words,
  756. this macro is called immediately before
  757. printing text
  758. on a page.
  759. It can be used for column headings
  760. and the like.
  761. .sh 1 "Displays"
  762. .pp
  763. All displays except centered blocks
  764. and block quotes
  765. are preceded and followed
  766. by an extra
  767. .NR (bs
  768. [same as
  769. .NR (ps ]
  770. space.
  771. Quote spacing is stored in a separate register;
  772. centered blocks have no default initial or trailing space.
  773. The vertical spacing of all displays except quotes
  774. and centered blocks
  775. is stored in register
  776. .NR ($R
  777. instead of
  778. .NR ($r .
  779. .TL
  780. .b .(l
  781. .i m
  782. .i f
  783. .DE
  784. Begin list.
  785. Lists are single spaced,
  786. unfilled text.
  787. If
  788. .i f
  789. is
  790. .b F ,
  791. the list will be filled.
  792. If
  793. .i m
  794. [\c
  795. .b I ]
  796. is
  797. .b I
  798. the list is indented by
  799. .NR (bi
  800. [4m];
  801. if
  802. .b M
  803. the list is indented to the left margin;
  804. if
  805. .b L
  806. the list is left justified with respect to the text
  807. (different from
  808. .b M
  809. only if the base indent
  810. (stored in
  811. .NR ($i
  812. and set with
  813. .b .ba )
  814. is not zero);
  815. and if
  816. .b C
  817. the list is centered on a line-by-line basis.
  818. The list is set in font
  819. .NR (df
  820. [0].
  821. Must be matched by a
  822. .b .)l .
  823. This macro is almost like
  824. .b .(b
  825. except that no attempt is made
  826. to keep the display on one page.
  827. .TL
  828. .b .)l
  829. .DE
  830. End list.
  831. .TL
  832. .b .(q
  833. .DE
  834. Begin major quote.
  835. These are single spaced,
  836. filled,
  837. moved in from the text
  838. on both sides
  839. by
  840. .NR (qi
  841. [4n],
  842. preceded and followed
  843. by
  844. .NR (qs
  845. [same as
  846. .NR (bs ]
  847. space,
  848. and are set in point size
  849. .NR (qp
  850. [one point smaller than surrounding text].
  851. .TL
  852. .b .)q
  853. .DE
  854. End major quote.
  855. .TL
  856. .b .(b
  857. .i m
  858. .i f
  859. .DE
  860. Begin block.
  861. Blocks are a form of
  862. .i keep ,
  863. where the text of a keep
  864. is kept together on one page
  865. if possible
  866. (keeps are useful
  867. for tables and figures
  868. which should not be broken
  869. over a page).
  870. If the block will not fit
  871. on the current page
  872. a new page is begun,
  873. .i unless
  874. that would leave more than
  875. .NR (bt
  876. [0]
  877. white space
  878. at the bottom of the text.
  879. If
  880. .NR (bt
  881. is zero, the threshold feature
  882. is turned off.
  883. Blocks are not filled
  884. unless
  885. .i f
  886. is
  887. .b F ,
  888. when they are filled.
  889. The block will be left-justified
  890. if
  891. .i m
  892. is
  893. .b L ,
  894. indented by
  895. .NR (bi
  896. [4m]
  897. if
  898. .i m
  899. is
  900. .b I
  901. or absent,
  902. centered
  903. (line-for-line)
  904. if
  905. .i m
  906. is
  907. .b C ,
  908. and left justified to the margin
  909. (not to the base indent)
  910. if
  911. .i m
  912. is
  913. .b M .
  914. The block is set in font
  915. .NR (df
  916. [0].
  917. .TL
  918. .b .)b
  919. .DE
  920. End block.
  921. .TL
  922. .b .(z
  923. .i m
  924. .i f
  925. .DE
  926. Begin floating keep.
  927. Like
  928. .b .(b
  929. except that the keep is
  930. .i floated
  931. to the bottom of the page
  932. or the top of the next page.
  933. Therefore,
  934. its position relative to the text changes.
  935. The floating keep is preceded and followed
  936. by
  937. .NR (zs
  938. [1v]
  939. space.
  940. Also,
  941. it defaults to mode
  942. .b M .
  943. .TL
  944. .b .)z
  945. .DE
  946. End floating keep.
  947. .TL
  948. .b .(c
  949. .DE
  950. Begin centered block.
  951. The next keep
  952. is centered as a block,
  953. rather than on a line-by-line basis
  954. as with
  955. .b ".(b C" .
  956. This call may be nested
  957. inside keeps.
  958. .TL
  959. .b .)c
  960. .DE
  961. End centered block.
  962. .sh 1 Annotations
  963. .TL
  964. .b .(d
  965. .DE
  966. Begin delayed text.
  967. Everything in the next keep
  968. is saved for output
  969. later with
  970. .b .pd ,
  971. in a manner
  972. similar to footnotes.
  973. .TL
  974. .b .)d
  975. .i n
  976. .DE
  977. End delayed text.
  978. The delayed text number register
  979. .NR ($d
  980. and the associated string
  981. .ST #
  982. are incremented if
  983. .ST #
  984. has been referenced.
  985. .TL
  986. .b .pd
  987. .DE
  988. Print delayed text.
  989. Everything diverted via
  990. .b .(d
  991. is printed and truncated.
  992. This might be used
  993. at the end of each chapter.
  994. .TL
  995. .b .(f
  996. .DE
  997. Begin footnote.
  998. The text of the footnote
  999. is floated to the bottom
  1000. of the page
  1001. and set in font
  1002. .NR (ff
  1003. [1]
  1004. and size
  1005. .NR (fp
  1006. [8p].
  1007. Each entry
  1008. is preceded by
  1009. .NR (fs
  1010. [0.2v]
  1011. space,
  1012. is indented
  1013. .NR (fi
  1014. [3n]
  1015. on the first line,
  1016. and is indented
  1017. .NR (fu
  1018. [0]
  1019. from the right margin.
  1020. Footnotes line up underneath
  1021. two column output.
  1022. If the text of the footnote
  1023. will not all fit on one page
  1024. it will be carried over
  1025. to the next page.
  1026. .TL
  1027. .b .)f
  1028. .i n
  1029. .DE
  1030. End footnote.
  1031. The number register
  1032. .NR ($f
  1033. and the associated string
  1034. .ST *
  1035. are incremented
  1036. if they have been referenced.
  1037. .TL
  1038. .b .$s
  1039. .DE
  1040. The macro to output the footnote separator.
  1041. This macro may be redefined
  1042. to give other size lines or other types
  1043. of separators.
  1044. Currently
  1045. it draws a 1.5i line.
  1046. .TL
  1047. .b .(x
  1048. .i x
  1049. .DE
  1050. Begin index entry.
  1051. Index entries are saved in the index
  1052. .i x
  1053. [\c
  1054. .b x ]
  1055. until called up with
  1056. .b .xp.
  1057. Each entry is preceded
  1058. by a
  1059. .NR (xs
  1060. [0.2v]
  1061. space.
  1062. Each entry is
  1063. .q undented
  1064. by
  1065. .NR (xu
  1066. [0.5i];
  1067. this register tells how far the page number
  1068. extends into the right margin.
  1069. .TL
  1070. .b .)x
  1071. .i P
  1072. .i A
  1073. .DE
  1074. End index entry.
  1075. The index entry
  1076. is finished with a row of dots
  1077. with
  1078. .i A
  1079. [null]
  1080. right justified on the last line
  1081. (such as for an author's name),
  1082. followed by P
  1083. [\c
  1084. .NR % ].
  1085. If
  1086. .i A
  1087. is specified,
  1088. .i P
  1089. must be specified;
  1090. .NR %
  1091. can be used to print the current page number.
  1092. If
  1093. .i P
  1094. is an underscore,
  1095. no page number
  1096. and no row of dots
  1097. are printed.
  1098. .TL
  1099. .b .xp
  1100. .i x
  1101. .DE
  1102. Print index
  1103. .i x
  1104. [\c
  1105. .b x ].
  1106. The index is formatted in the font, size, and so forth
  1107. in effect at the time it is printed,
  1108. rather than at the time it is collected.
  1109. .sh 1 "Columned Output"
  1110. .TL
  1111. .b .2c
  1112. .i +S
  1113. .i N
  1114. .DE
  1115. Enter two-column mode.
  1116. The column separation is set to
  1117. .i +S
  1118. [4n, 0.5i in ACM mode]
  1119. (saved in
  1120. .NR ($s ).
  1121. The column width,
  1122. calculated to fill the single column line length
  1123. with both columns,
  1124. is stored in
  1125. .NR ($l .
  1126. The current column
  1127. is in
  1128. .NR ($c .
  1129. You can test register
  1130. .NR ($m
  1131. [1]
  1132. to see if you are in single column
  1133. or double column mode.
  1134. Actually,
  1135. the request enters
  1136. .i N
  1137. [2]
  1138. column output.
  1139. .TL
  1140. .b .1c
  1141. .DE
  1142. Revert to single-column mode.
  1143. .TL
  1144. .b .bc
  1145. .DE
  1146. Begin column.
  1147. This is like
  1148. .b .bp
  1149. except that it begins a new column
  1150. on a new page
  1151. only if necessary,
  1152. rather than forcing a whole new page
  1153. if there is another column left
  1154. on the current page.
  1155. .sh 1 "Fonts and Sizes"
  1156. .TL
  1157. .b .sz
  1158. .i +P
  1159. .DE
  1160. The pointsize is set to
  1161. .i P
  1162. [10p],
  1163. and the line spacing is set proportionally.
  1164. The ratio of line spacing to pointsize
  1165. is stored in
  1166. .NR ($r .
  1167. The ratio used internally
  1168. by displays and annotations
  1169. is stored in
  1170. .NR ($R
  1171. (although this is not used by
  1172. .b .sz ).
  1173. This size is
  1174. .i not
  1175. sticky beyond many macros:
  1176. in particular,
  1177. .NR (pp
  1178. (paragraph pointsize)
  1179. modifies the pointsize every time a new paragraph is begun
  1180. using the
  1181. .b \&.pp ,
  1182. .b \&.lp ,
  1183. .b \&.ip ,
  1184. .b \&.np ,
  1185. or
  1186. .b \&.bu
  1187. macros.
  1188. Also,
  1189. .NR (fp
  1190. (footnote pointsize),
  1191. .NR (qp
  1192. (quote pointsize),
  1193. .NR (sp
  1194. (section header pointsize),
  1195. and
  1196. .NR (tp
  1197. (title pointsize)
  1198. may modify the pointsize.
  1199. .TL
  1200. .b .r
  1201. .i W
  1202. .i X
  1203. .DE
  1204. Set
  1205. .i W
  1206. in roman font,
  1207. appending
  1208. .i X
  1209. in the previous font.
  1210. To append different font requests,
  1211. use
  1212. .i X
  1213. =
  1214. .b \ec .
  1215. If no parameters,
  1216. change to roman font.
  1217. .TL
  1218. .b .i
  1219. .i W
  1220. .i X
  1221. .DE
  1222. Set
  1223. .i W
  1224. in italics,
  1225. appending
  1226. .i X
  1227. in the previous font.
  1228. If no parameters,
  1229. change to italic font.
  1230. Underlines in \*N.
  1231. .TL
  1232. .b .b
  1233. .i W
  1234. .i X
  1235. .DE
  1236. Set
  1237. .i W
  1238. in bold font
  1239. and append
  1240. .i X
  1241. in the previous font.
  1242. If no parameters,
  1243. switch to bold font.
  1244. In \*N,
  1245. underlines.
  1246. .TL
  1247. .b .rb
  1248. .i W
  1249. .i X
  1250. .DE
  1251. Set
  1252. .i W
  1253. in bold font
  1254. and append
  1255. .i X
  1256. in the previous font.
  1257. If no parameters,
  1258. switch to bold font.
  1259. .b .rb
  1260. differs from
  1261. .b .b
  1262. in that
  1263. .b .rb
  1264. does not underline in \*N.
  1265. .TL
  1266. .b .u
  1267. .i W
  1268. .i X
  1269. .DE
  1270. Underline
  1271. .i W
  1272. and append
  1273. .i X .
  1274. This is a true underlining,
  1275. as opposed to the
  1276. .b .ul
  1277. request,
  1278. which changes to
  1279. .q "underline font"
  1280. (usually italics in \*T).
  1281. It won't work right
  1282. if
  1283. .i W
  1284. is spread or broken (including hyphenated).
  1285. In other words,
  1286. it is safe in nofill mode only.
  1287. .TL
  1288. .b .q
  1289. .i W
  1290. .i X
  1291. .DE
  1292. Quote
  1293. .i W
  1294. and append
  1295. .i X .
  1296. In \*N
  1297. this just surrounds
  1298. .i W
  1299. with double quote marks
  1300. (`\|\c
  1301. .b """" \|'),
  1302. but in \*T
  1303. uses directed quotes.
  1304. .TL
  1305. .b .bi
  1306. .i W
  1307. .i X
  1308. .DE
  1309. Set
  1310. .i W
  1311. in bold italics
  1312. and append
  1313. .i X .
  1314. Actually,
  1315. sets
  1316. .i W
  1317. in italic
  1318. and overstrikes once.
  1319. Underlines in \*N.
  1320. It won't work right
  1321. if
  1322. .i W
  1323. is spread or broken (including hyphenated).
  1324. In other words,
  1325. it is safe in nofill mode only.
  1326. .TL
  1327. .b .bx
  1328. .i W
  1329. .i X
  1330. .DE
  1331. Sets
  1332. .i W
  1333. in a box,
  1334. with
  1335. .i X
  1336. appended.
  1337. Underlines in \*N.
  1338. It won't work right
  1339. if
  1340. .i W
  1341. is spread or broken (including hyphenated).
  1342. In other words,
  1343. it is safe in nofill mode only.
  1344. .TL
  1345. .b sm
  1346. .i W
  1347. .i X
  1348. .DE
  1349. Sets
  1350. .i W
  1351. in a smaller pointsize,
  1352. with
  1353. .i X
  1354. appended.
  1355. .sh 1 "Roff Support"
  1356. .TL
  1357. .b .ix
  1358. .i +N
  1359. .DE
  1360. Indent,
  1361. no break.
  1362. Equivalent to
  1363. .b \(aain
  1364. .i N .
  1365. .TL
  1366. .b .bl
  1367. .i N
  1368. .DE
  1369. Leave
  1370. .i N
  1371. contiguous white space,
  1372. on the next page if not enough room
  1373. on this page.
  1374. Equivalent to a
  1375. .b .sp
  1376. .i N
  1377. inside a block.
  1378. .TL
  1379. .b .pa
  1380. .i +N
  1381. .DE
  1382. Equivalent to
  1383. .b .bp .
  1384. .TL
  1385. .b .ro
  1386. .DE
  1387. Set page number
  1388. in roman numerals.
  1389. Equivalent to
  1390. .b ".af % i" .
  1391. .TL
  1392. .b .ar
  1393. .DE
  1394. Set page number in Arabic.
  1395. Equivalent to
  1396. .b ".af % 1" .
  1397. .TL
  1398. .b .n1
  1399. .DE
  1400. Number lines in margin from one
  1401. on each page.
  1402. .TL
  1403. .b .n2
  1404. .i N
  1405. .DE
  1406. Number lines from
  1407. .i N ,
  1408. stop if
  1409. .i N
  1410. = 0.
  1411. .TL
  1412. .b .sk
  1413. .DE
  1414. Leave the next output page blank,
  1415. except for headers and footers.
  1416. This is used to leave space
  1417. for a full-page diagram
  1418. which is produced externally
  1419. and pasted in later.
  1420. To get a partial-page paste-in display,
  1421. say
  1422. .b .sv \ \c
  1423. .i N ,
  1424. where
  1425. .i N
  1426. is the amount of space
  1427. to leave;
  1428. this space will be output immediately
  1429. if there is room,
  1430. and will otherwise be output
  1431. at the top of the next page.
  1432. However, be warned:
  1433. if
  1434. .i N
  1435. is greater than the amount of available space
  1436. on an empty page,
  1437. no space will ever be output.
  1438. .sh 1 "Preprocessor Support"
  1439. .TL
  1440. .b .EQ
  1441. .i m
  1442. .i T
  1443. .DE
  1444. Begin equation.
  1445. The equation is centered
  1446. if
  1447. .i m
  1448. is
  1449. .b C
  1450. or omitted,
  1451. indented
  1452. .NR (bi
  1453. [4m]
  1454. if
  1455. .i m
  1456. is
  1457. .b I ,
  1458. and left justified if
  1459. .i m
  1460. is
  1461. .b L .
  1462. .i T
  1463. is a title printed on the right margin
  1464. next to the equation.
  1465. See
  1466. .i "Typesetting Mathematics \- User's Guide"
  1467. by Brian W. Kernighan
  1468. and Lorinda L. Cherry.
  1469. .TL
  1470. .b .EN
  1471. .i c
  1472. .DE
  1473. End equation.
  1474. If
  1475. .i c
  1476. is
  1477. .b C
  1478. the equation must be continued
  1479. by immediately following
  1480. with another
  1481. .b .EQ ,
  1482. the text of which
  1483. can be centered
  1484. along with this one.
  1485. Otherwise,
  1486. the equation is printed,
  1487. always on one page,
  1488. with
  1489. .NR (es
  1490. [0.5v in \*T, 1v in \*N]
  1491. space
  1492. above and below it.
  1493. .TL
  1494. .b .TS
  1495. .i h
  1496. .DE
  1497. Table start.
  1498. Tables are single spaced
  1499. and kept on one page
  1500. if possible.
  1501. If you have a large table
  1502. which will not fit on one page,
  1503. use
  1504. .i h
  1505. =
  1506. .b H
  1507. and follow the header part
  1508. (to be printed on every page of the table)
  1509. with a
  1510. .b .TH .
  1511. See
  1512. .i "Tbl \- A Program to Format Tables"
  1513. by M. E. Lesk.
  1514. .TL
  1515. .b .TH
  1516. .DE
  1517. With
  1518. .b ".TS H" ,
  1519. ends the header portion of the table.
  1520. .TL
  1521. .b .TE
  1522. .DE
  1523. Table end.
  1524. Note that this table
  1525. does not float,
  1526. in fact,
  1527. it is not even guaranteed to stay on one page
  1528. if you use requests such as
  1529. .b .sp
  1530. intermixed with the text
  1531. of the table.
  1532. If you want it to float
  1533. (or if you use requests
  1534. inside the table),
  1535. surround the entire table
  1536. (including the
  1537. .b .TS
  1538. and
  1539. .b .TE
  1540. requests)
  1541. with the requests
  1542. .b .(z
  1543. and
  1544. .b .)z .
  1545. .TL
  1546. .b .PS
  1547. .i h
  1548. .i w
  1549. .DE
  1550. Begin
  1551. .i pic
  1552. picture.
  1553. .i H
  1554. is the height and
  1555. .i w
  1556. is the width,
  1557. both in basic units.
  1558. .i Ditroff
  1559. only.
  1560. .TL
  1561. .b .PE
  1562. .DE
  1563. End picture.
  1564. .TL
  1565. .b .IS
  1566. .DE
  1567. Begin
  1568. .i ideal
  1569. picture.
  1570. .TL
  1571. .b .IE
  1572. .DE
  1573. End
  1574. .i ideal
  1575. picture.
  1576. .TL
  1577. .b .IF
  1578. .DE
  1579. End
  1580. .i ideal
  1581. picture (alternate form).
  1582. .TL
  1583. .b GS
  1584. .DE
  1585. Begin
  1586. .i gremlin
  1587. picture.
  1588. .TL
  1589. .b GE
  1590. .DE
  1591. End
  1592. .i gremlin
  1593. picture.
  1594. .TL
  1595. .b GF
  1596. .DE
  1597. End
  1598. .i gremlin
  1599. picture (alternate form).
  1600. .sh 1 "Miscellaneous"
  1601. .TL
  1602. .b .re
  1603. .DE
  1604. Reset tabs.
  1605. Set to every 0.5i
  1606. in \*T
  1607. and every 0.8i in \*N.
  1608. .TL
  1609. .b .ba
  1610. .i +N
  1611. .DE
  1612. Set the base indent
  1613. to
  1614. .i +N
  1615. [0]
  1616. (saved in
  1617. .NR ($i ).
  1618. All paragraphs,
  1619. sections,
  1620. and displays
  1621. come out indented by this amount.
  1622. Titles and footnotes
  1623. are unaffected.
  1624. The
  1625. .b .sh
  1626. request performs a
  1627. .b .ba
  1628. request
  1629. if
  1630. .NR (si
  1631. [0] is not zero,
  1632. and sets the base indent to
  1633. .NR (si \c
  1634. .b * \c
  1635. .NR ($0 .
  1636. .TL
  1637. .b .xl
  1638. .i +N
  1639. .DE
  1640. Set the line length to
  1641. .i N
  1642. [6.0i].
  1643. This differs
  1644. from
  1645. .b .ll
  1646. because it only affects the current environment.
  1647. .TL
  1648. .b .ll
  1649. .i +N
  1650. .DE
  1651. Set line length in all environments
  1652. to
  1653. .i N
  1654. [6.0i].
  1655. This should not be used
  1656. after output has begun,
  1657. and particularly not in two-column output.
  1658. The current line length is stored in
  1659. .NR ($l .
  1660. .TL
  1661. .b .hl
  1662. .DE
  1663. Draws a horizontal line
  1664. the length of the page.
  1665. This is useful
  1666. inside floating keeps
  1667. to differentiate
  1668. between the text
  1669. and the figure.
  1670. .TL
  1671. .b .lh
  1672. .DE
  1673. Print a letterhead at the current position on the page.
  1674. The format of the letterhead must be defined
  1675. in the file
  1676. .b /usr/lib/me/letterhead.me
  1677. by your local systems staff.
  1678. Some environments may require
  1679. .i ditroff
  1680. for this macro
  1681. to function properly.
  1682. .TL
  1683. .b .lo
  1684. .DE
  1685. This macro loads another set of macros
  1686. (in
  1687. .b /usr/lib/me/local.me )
  1688. which is intended to be a set of locally defined macros.
  1689. These macros
  1690. should all be of the form
  1691. .b .* \c
  1692. .i X ,
  1693. where
  1694. .i X
  1695. is any letter
  1696. (upper or lower case)
  1697. or digit.
  1698. .sh 1 "Standard Papers"
  1699. .TL
  1700. .b .tp
  1701. .DE
  1702. Begin title page.
  1703. Spacing at the top of the page
  1704. can occur,
  1705. and headers and footers are suppressed.
  1706. Also,
  1707. the page number
  1708. is not incremented
  1709. for this page.
  1710. .TL
  1711. .b .th
  1712. .DE
  1713. Set thesis mode.
  1714. This defines the modes acceptable
  1715. for a doctoral dissertation
  1716. at Berkeley.
  1717. It double spaces,
  1718. defines the header
  1719. to be a single page number,
  1720. and changes the margins
  1721. to be 1.5 inch on the left
  1722. and one inch on the top.
  1723. .b .++
  1724. and
  1725. .b .+c
  1726. should be used with it.
  1727. This macro must be stated
  1728. before
  1729. initialization,
  1730. that is,
  1731. before the first call of a paragraphing
  1732. macro
  1733. or
  1734. .b .sh .
  1735. .TL
  1736. .b .++
  1737. .i m
  1738. .i H
  1739. .DE
  1740. This request defines the section of the paper
  1741. which we are entering.
  1742. The section type is defined by
  1743. .i m .
  1744. .b C
  1745. means that we are entering the chapter portion
  1746. of the paper,
  1747. .b A
  1748. means that we are entering the appendix portion
  1749. of the paper,
  1750. .b P
  1751. means that the material following
  1752. should be the preliminary portion
  1753. (abstract, table of contents, etc.)
  1754. portion of the paper,
  1755. .b AB
  1756. means that we are entering the abstract
  1757. (numbered independently from 1
  1758. in Arabic numerals),
  1759. and
  1760. .b B
  1761. means that we are entering the bibliographic
  1762. portion at the end of the paper.
  1763. Also, the variants
  1764. .b RC
  1765. and
  1766. .b RA
  1767. are allowed,
  1768. which specify renumbering of pages
  1769. from one at the beginning of each
  1770. chapter or appendix,
  1771. respectively.
  1772. The
  1773. .i H
  1774. parameter defines the new header.
  1775. If there are any spaces in it,
  1776. the entire header must be quoted.
  1777. If you want the header to have the chapter number
  1778. in it,
  1779. Use the string
  1780. .b "\e\e\e\en(ch" .
  1781. For example, to number appendixes
  1782. .b A.1
  1783. etc.,
  1784. type
  1785. .b ".++ RA \(aa\(aa\(aa\e\e\e\en(ch.%\(aa" .
  1786. Each section
  1787. (chapter, appendix, etc.)
  1788. should be preceded by the
  1789. .b .+c
  1790. request.
  1791. It should be mentioned
  1792. that it is easier when using
  1793. \*T to put the front material
  1794. at the end of the paper,
  1795. so that the table of contents
  1796. can be collected and put out;
  1797. this material can then be physically
  1798. moved to the beginning of the paper.
  1799. .TL
  1800. .b .+c
  1801. .i T
  1802. .DE
  1803. Begin chapter with title
  1804. .i T .
  1805. The chapter number
  1806. is maintained in
  1807. .NR (ch .
  1808. This register is incremented
  1809. every time
  1810. .b .+c
  1811. is called with a parameter.
  1812. The title and chapter number
  1813. are printed by
  1814. .b .$c .
  1815. The header is moved to the footer
  1816. on the first page
  1817. of each chapter.
  1818. If
  1819. .i T
  1820. is omitted,
  1821. .b .$c
  1822. is not called;
  1823. this is useful for doing your own
  1824. .q "title page"
  1825. at the beginning of papers
  1826. without a title page proper.
  1827. .b .$c
  1828. calls
  1829. .b .$C
  1830. as a hook so that chapter titles can be inserted
  1831. into a table of contents automatically.
  1832. The footnote numbering is reset to one.
  1833. .TL
  1834. .b .$c
  1835. .i T
  1836. .DE
  1837. Print chapter number
  1838. (from
  1839. .NR (ch )
  1840. and
  1841. .i T .
  1842. This macro can be redefined to your liking.
  1843. It is defined by default
  1844. to be acceptable
  1845. for a PhD thesis
  1846. at Berkeley.
  1847. This macro calls
  1848. .b $C ,
  1849. which can be defined to make index entries,
  1850. or whatever.
  1851. .TL
  1852. .b .$C
  1853. .i K
  1854. .i N
  1855. .i T
  1856. .DE
  1857. This macro is called by
  1858. .b .$c .
  1859. It is normally undefined,
  1860. but can be used to automatically insert
  1861. index entries,
  1862. or whatever.
  1863. .i K
  1864. is a keyword,
  1865. either
  1866. .q Chapter
  1867. or
  1868. .q Appendix
  1869. (depending on the
  1870. .b .++
  1871. mode);
  1872. .i N
  1873. is the chapter or appendix number,
  1874. and
  1875. .i T
  1876. is the chapter or appendix title.
  1877. .TL
  1878. .b .ac
  1879. .i A
  1880. .i N
  1881. .DE
  1882. This macro
  1883. (short for
  1884. .b .acm )
  1885. sets up the \*N environment
  1886. for camera-ready papers
  1887. as used by the ACM.
  1888. This format is 25% larger,
  1889. and has no headers or footers.
  1890. The author's name
  1891. .i A
  1892. is printed at the bottom of the page
  1893. (but off the part which will be printed
  1894. in the conference proceedings),
  1895. together with the current page number
  1896. and the total number of pages
  1897. .i N .
  1898. Additionally,
  1899. this macro loads the file
  1900. .b /usr/lib/me/acm.me ,
  1901. which may later be augmented with other macros
  1902. useful for printing papers
  1903. for ACM conferences.
  1904. It should be noted
  1905. that this macro will not work correctly in version 7 \*T,
  1906. since it sets the page length
  1907. wider than the physical width
  1908. of the C/A/T phototypesetter roll.
  1909. .sh 1 "Predefined Strings"
  1910. .TL
  1911. .ST *
  1912. .DE
  1913. Footnote number, actually
  1914. .ST [ \c
  1915. .NR ($f \c
  1916. .ST ] .
  1917. This macro is incremented
  1918. after each call to
  1919. .b .)f .
  1920. .TL
  1921. .ST #
  1922. .DE
  1923. Delayed text number.
  1924. Actually
  1925. [\c
  1926. .NR ($d ].
  1927. .TL
  1928. .ST [
  1929. .DE
  1930. Superscript.
  1931. This string gives upward movement
  1932. and a change to a smaller point size
  1933. if possible,
  1934. otherwise it gives the left bracket character
  1935. (`\^\c
  1936. .b [ \^').
  1937. Extra space is left above the line
  1938. to allow room for the superscript.
  1939. .TL
  1940. .ST ]
  1941. .DE
  1942. Unsuperscript.
  1943. Inverse to
  1944. .ST [ .
  1945. For example,
  1946. to produce a superscript
  1947. you might type
  1948. .b x \c
  1949. .ST [ \c
  1950. .b 2 \c
  1951. .ST ] ,
  1952. which will produce
  1953. .b x\*[2\*] .
  1954. .TL
  1955. .ST <
  1956. .DE
  1957. Subscript.
  1958. Defaults to
  1959. `\^<\^'
  1960. if half-carriage motion not possible.
  1961. Extra space is left below the line
  1962. to allow for the subscript.
  1963. .TL
  1964. .ST >
  1965. .DE
  1966. Inverse to
  1967. .ST < .
  1968. .TL
  1969. .ST (dw
  1970. .DE
  1971. The day of the week,
  1972. as a word.
  1973. .TL
  1974. .ST (mo
  1975. .DE
  1976. The month,
  1977. as a word.
  1978. .TL
  1979. .ST (td
  1980. .DE
  1981. Today's date,
  1982. directly printable.
  1983. The date is of the form \*(td.
  1984. Other forms of the date can be used
  1985. by using
  1986. .NR (dy
  1987. (the day of the month;
  1988. for example, \n(dy),
  1989. .ST (mo
  1990. (as noted above)
  1991. or
  1992. .NR (mo
  1993. (the same,
  1994. but as an ordinal number;
  1995. for example, \*(mo is \n(mo),
  1996. and
  1997. .NR (yr
  1998. (the last two digits of the current year).
  1999. .TL
  2000. .ST (lq
  2001. .DE
  2002. Left quote marks.
  2003. Double quote in \*N.
  2004. .TL
  2005. .ST (rq
  2006. .DE
  2007. Right quote.
  2008. .TL
  2009. .ST \-
  2010. .DE
  2011. .ie \w'\(34'>0 \(34
  2012. .el 3/4
  2013. em dash in \*T;
  2014. two hyphens in \*N.
  2015. .sh 1 "Special Characters and Marks"
  2016. .pp
  2017. There are a number of special characters
  2018. and diacritical marks
  2019. (such as accents)
  2020. available through \-me.
  2021. To reference these characters,
  2022. you must call the macro
  2023. .b .sc
  2024. to define the characters before using them.
  2025. .TL
  2026. .b .sc
  2027. .DE
  2028. Define special characters and diacritical marks, as described
  2029. in the remainder of this section.
  2030. This macro must be stated
  2031. before initialization.
  2032. The special characters available
  2033. are listed below.
  2034. .in +4n
  2035. .ta 15 +5 +6
  2036. .nf
  2037. Name    Usage    Example
  2038. Acute accent    \e*\(aa    a\e*\(aa    a\*'
  2039. Grave accent    \e*\(ga    e\e*\(ga    e\*`
  2040. Umlat    \e*:    u\e*:    u\*:
  2041. Tilde    \e*~    n\e*~    n\*~
  2042. Caret    \e*^    e\e*^    e\*^
  2043. Cedilla    \e*,    c\e*,    c\*,
  2044. Czech    \e*v    e\e*v    e\*v
  2045. Circle    \e*o    A\e*o    A\*o
  2046. There exists    \e*(qe        \*(qe
  2047. For all    \e*(qa        \*(qa
  2048. .fi
  2049. .sp 1i
  2050. .in 0
  2051. .b Acknowledgments
  2052. .pp
  2053. I would like to thank
  2054. Bob Epstein,
  2055. Bill Joy,
  2056. and Larry Rowe
  2057. for having the courage
  2058. to use the \-me macros
  2059. to produce non-trivial papers
  2060. during the development stages;
  2061. Ricki Blau,
  2062. Pamela Humphrey,
  2063. and Jim Joyce
  2064. for their help with the documentation phase;
  2065. peter kessler
  2066. for numerous complaints,
  2067. most accompanied by fixes;
  2068. and the plethora of people who have contributed ideas
  2069. and have given support for the project.
  2070. .bp
  2071. .b Summary
  2072. .pp
  2073. This alphabetical list summarizes all macros, strings, and number registers
  2074. available in the \-me macros.
  2075. Selected
  2076. .i troff
  2077. commands, registers, and functions are included as well;
  2078. those listed can generally be used with impunity.
  2079. .pp
  2080. The columns are the name of the
  2081. command, macro, register, or string;
  2082. the type of the object,
  2083. and the description.
  2084. Types are
  2085. .b M
  2086. for macro or builtin command
  2087. (invoked with
  2088. .b \&.
  2089. or
  2090. .b \&\'
  2091. in the first input column),
  2092. .b S
  2093. for a string
  2094. (invoked with
  2095. .b \e*
  2096. or
  2097. .b \e*( ),
  2098. .b R
  2099. for a number register
  2100. (invoked with
  2101. .b \en
  2102. or
  2103. .b \en( ),
  2104. and
  2105. .b F
  2106. for a
  2107. .i troff
  2108. builtin function
  2109. (invoked by preceding it with a single backslash).
  2110. .pp
  2111. Lines marked with \(sc are
  2112. .i troff
  2113. internal codes.
  2114. Lines marked with \(dg or \(dd
  2115. may be defined by the user to get special functions;
  2116. \(dd indicates that these are defined by default
  2117. and changing them may have unexpected side effects.
  2118. Lines marked with \(de
  2119. are specific to
  2120. .i ditroff
  2121. (device-independent
  2122. .i troff ).
  2123. .de $H
  2124. .ev 1
  2125. .ta \w'\e(space)\(sc\ 'u +\w'TYPE  'u
  2126. NAME    TYPE    DESCRIPTION
  2127. .ev
  2128. ..
  2129. .(l
  2130. .$H
  2131. \e(space)    F\(sc    unpaddable space
  2132. \e"    F\(sc    comment (to end of line)
  2133. \e*#    S    optional delayed text tag string
  2134. \e$\fI\&N\fP    F\(sc    interpolate argument \fI\&N\fP
  2135. \en($0    R    section depth
  2136. \&.$0    M\(dg    invoked after section title printed
  2137. \en($1    R    first section number
  2138. \&.$1    M\(dg    invoked before printing depth 1 section
  2139. \en($2    R    second section number
  2140. \&.$2    M\(dg    invoked before printing depth 2 section
  2141. \en($3    R    third section number
  2142. \&.$3    M\(dg    invoked before printing depth 3 section
  2143. \en($4    R    fourth section number
  2144. \&.$4    M\(dg    invoked before printing depth 4 section
  2145. \en($5    R    fifth section number
  2146. \&.$5    M\(dg    invoked before printing depth 5 section
  2147. \en($6    R    sixth section number
  2148. \&.$6    M\(dg    invoked before printing depth 6 section
  2149. \&.$C    M\(dg    called at beginning of chapter
  2150. \&.$H    M\(dg    text header
  2151. \en($R    R\(dd    relative vertical spacing in displays
  2152. \en($c    R    current column number
  2153. \&.$c    M\(dd    print chapter title
  2154. \en($d    R    delayed text number
  2155. \en($f    R    footnote number
  2156. \&.$f    M\(dd    print footer
  2157. \&.$h    M\(dd    print header
  2158. \en($i    R    paragraph base indent
  2159. \en($l    R    column width
  2160. \en($m    R    number of columns in effect
  2161. \e*($n    S    section name
  2162. \en($p    R    numbered paragraph number
  2163. \&.$p    M\(dd    print section heading (internal macro)
  2164. \en($r    R\(dd    relative vertical spacing in text
  2165. \en($s    R    column indent
  2166. \&.$s    M\(dd    footnote separator (from text)
  2167. \en%    R\(sc    current page number
  2168. \e&    F\(sc    zero width character, useful for hiding controls
  2169. \e(\fI\&xx\fP    F\(sc    interpolate special character \fI\&xx\fP
  2170. \&.(b    M    begin block
  2171. \&.(c    M    begin centered block
  2172. \&.(d    M    begin delayed text
  2173. \&.(f    M    begin footnote
  2174. \&.(l    M    begin list
  2175. \&.(q    M    begin quote
  2176. \&.(x    M    begin index entry
  2177. \&.(z    M    begin floating keep
  2178. \&.)b    M    end block
  2179. \&.)c    M    end centered block
  2180. \&.)d    M    end delayed text
  2181. \&.)f    M    end footnote
  2182. \&.)l    M    end list
  2183. \&.)q    M    end quote
  2184. \&.)x    M    end index entry
  2185. \&.)z    M    end floating keep
  2186. \e*\fI\&x\fP    F\(sc    interpolate string \fI\&x\fP
  2187. \e*(\fI\&xx\fP    F\(sc    interpolate string \fI\&xx\fP
  2188. \e**    S    optional footnote tag string
  2189. \&.++    M    set paper section type
  2190. \&.+c    M    begin chapter
  2191. \e*,    S    cedilla
  2192. \e\-    F\(sc    minus sign
  2193. \e*\-    S    3/4 em dash
  2194. \e0    F\(sc    unpaddable digit-width space
  2195. \&.1c    M    revert to single column output
  2196. \&.2c    M    begin two column output
  2197. \e*:    S    umlat
  2198. \e*<    S    begin subscript
  2199. \e*>    S    end subscript
  2200. \&.EN    M    end equation
  2201. \&.EQ    M    begin equation
  2202. \eL\'\fI\&d\fP\'    F\(sc    vertical line drawing function for distance \fI\&d\fP
  2203. \&.GE    M\(de    end \fIgremlin\fP picture
  2204. \&.GF    M\(de    end \fIgremlin\fP picture (with flyback)
  2205. \&.GS    M\(de    start \fIgremlin\fP picture
  2206. \&.IE    M\(de    end \fIideal\fP picture
  2207. \&.IF    M\(de    end \fIideal\fP picture (with flyback)
  2208. \&.IS    M\(de    start \fIideal\fP picture
  2209. \&.PE    M\(de    end \fIpic\fP picture
  2210. \&.PF    M\(de    end \fIpic\fP picture (with flyback)
  2211. \&.PS    M\(de    start \fIpic\fP picture
  2212. \&.TE    M    end table
  2213. \&.TH    M    end header of table
  2214. \&.TS    M    begin table
  2215. \e*[    S    begin superscript
  2216. \en(\&.$    R\(sc    number of arguments to macro
  2217. \en(\&.i    R\(sc    current indent
  2218. \en(\&.l    R\(sc    current line length
  2219. \en(\&.s    R\(sc    current point size
  2220. \e*(\&\'    S    acute accent
  2221. \e*(\&\`    S    grave accent
  2222. \e(\'    F\(sc    acute accent
  2223. \e(\`    F\(sc    grave accent
  2224. \e*]    S    end superscript
  2225. \e^    F\(sc    1/12 em narrow space
  2226. \e*^    S    caret
  2227. \&.ac    M    ACM mode
  2228. \&.ad    M\(sc    set text adjustment
  2229. \&.af    M\(sc    assign format to register
  2230. \&.am    M\(sc    append to macro
  2231. \&.ar    M    set page numbers in Arabic
  2232. \&.as    M\(sc    append to string
  2233. \&.b    M    bold font
  2234. \&.ba    M    set base indent
  2235. \&.bc    M    begin new column
  2236. \&.bi    M    bold italic
  2237. \en(bi    R    display (block) indent
  2238. \&.bl    M    blank lines (even at top of page)
  2239. \en(bm    R    bottom title margin
  2240. \&.bp    M\(sc    begin page
  2241. \&.br    M\(sc    break (start new line)
  2242. \en(bs    R    display (block) pre/post spacing
  2243. \en(bt    R    block keep threshold
  2244. \&.bx    M    boxed
  2245. \ec    F\(sc    continue input
  2246. \&.ce    M\(sc    center lines
  2247. \en(ch    R    current chapter number
  2248. \&.de    M\(sc    define macro
  2249. \en(df    R    display font
  2250. \&.ds    M\(sc    define string
  2251. \en(dw    R\(sc    current day of week
  2252. \e*(dw    S    current day of week
  2253. \en(dy    R\(sc    day of month
  2254. \ee    F\(sc    printable version of \e
  2255. \&.ef    M    set footer (even numbered pages only)
  2256. \&.eh    M    set header (even numbered pages only)
  2257. \&.el    M\(sc    else part of conditional
  2258. \&.ep    M    end page
  2259. \en(es    R    equation pre/post space
  2260. \ef\fI\&f\fP    F\(sc    inline font change to font \fI\&f\fP
  2261. \ef(\fI\&ff\fP    F\(sc    inline font change to font \fI\&ff\fP
  2262. \&.fc    M\(sc    set field characters
  2263. \en(ff    R    footnote font
  2264. \&.fi    M\(sc    fill output lines
  2265. \en(fi    R    footnote indent (first line only)
  2266. \en(fm    R    footer margin
  2267. \&.fo    M    set footer
  2268. \en(fp    R    footnote pointsize
  2269. \en(fs    R    footnote prespace
  2270. \en(fu    R    footnote undent (from right margin)
  2271. \eh\'\fI\&d\fP\'    F\(sc    local horizontal motion for distance \fI\&d\fP
  2272. \&.hc    M\(sc    set hyphenation character
  2273. \&.he    M    set header
  2274. \&.hl    M    draw horizontal line
  2275. \en(hm    R    header margin
  2276. \&.hx    M    suppress headers and footers on next page
  2277. \&.hy    M\(sc    set hyphenation mode
  2278. \&.i    M    italic font
  2279. \&.ie    M\(sc    conditional with else
  2280. \&.if    M\(sc    conditional
  2281. \en(ii    R    indented paragraph indent
  2282. \&.in    M\(sc    indent (transient, use .ba for pervasive)
  2283. \&.ip    M    begin indented paragraph
  2284. \&.ix    M    indent, no break
  2285. \el\'\fI\&d\fP\'    F\(sc    horizontal line drawing function for distance \fI\&d\fP
  2286. \&.lc    M\(sc    set leader repetition character
  2287. \&.lh    M\(de    interpolate local letterhead
  2288. \&.ll    M    set line length
  2289. \&.lo    M    load local macros
  2290. \&.lp    M    begin left justified paragraph
  2291. \e*(lq    S    left quote marks
  2292. \&.ls    M\(sc    set multi-line spacing
  2293. \&.m1    M    set space from top of page to header
  2294. \&.m2    M    set space from header to text
  2295. \&.m3    M    set space from text to footer
  2296. \&.m4    M    set space from footer to bottom of page
  2297. \&.mc    M\(sc    insert margin character
  2298. \&.mk    M\(sc    mark vertical position
  2299. \en(mo    R\(sc    month of year
  2300. \e*(mo    S    current month
  2301. \en\fI\&x\fP    F\(sc    interpolate number register \fI\&x\fP
  2302. \en(\fI\&xx\fP    F\(sc    interpolate number register \fI\&xx\fP
  2303. \&.n1    M    number lines in margin
  2304. \&.n2    M    number lines in margin
  2305. \&.na    M\(sc    turn off text adjustment
  2306. \&.ne    M\(sc    need vertical space
  2307. \&.nf    M\(sc    don't fill output lines
  2308. \&.nh    M\(sc    turn off hyphenation
  2309. \&.np    M    begin numbered paragraph
  2310. \&.nr    M\(sc    set number register
  2311. \&.ns    M\(sc    no space mode
  2312. \e*o    S    circle (e.g., for Norse A\*o)
  2313. \&.of    M    set footer (odd numbered pages only)
  2314. \&.oh    M    set header (odd numbered pages only)
  2315. \&.pa    M    begin page
  2316. \&.pd    M    print delayed text
  2317. \en(pf    R    paragraph font
  2318. \en(pi    R    paragraph indent
  2319. \&.pl    M\(sc    set page length
  2320. \&.pn    M\(sc    set next page number
  2321. \&.po    M\(sc    page offset
  2322. \en(po    R    simulated page offset
  2323. \&.pp    M    begin paragraph
  2324. \en(pp    R    paragraph pointsize
  2325. \en(ps    R    paragraph prespace
  2326. \&.q    M    quoted
  2327. \e*(qa    S    for all
  2328. \e*(qe    S    there exists
  2329. \en(qi    R    quote indent (also shortens line)
  2330. \en(qp    R    quote pointsize
  2331. \en(qs    R    quote pre/post space
  2332. \&.r    M    roman font
  2333. \&.rb    M    real bold font
  2334. \&.re    M    reset tabs
  2335. \&.rm    M\(sc    remove macro or string
  2336. \&.rn    M\(sc    rename macro or string
  2337. \&.ro    M    set page numbers in roman
  2338. \e*(rq    S    right quote marks
  2339. \&.rr    M\(sc    remove register
  2340. \&.rs    M\(sc    restore spacing
  2341. \&.rt    M\(sc    return to vertical position
  2342. \es\fI\&S\fP    F\(sc    inline size change to size \fI\&S\fP
  2343. \&.sc    M    load special characters
  2344. \en(sf    R    section title font
  2345. \&.sh    M    begin numbered section
  2346. \en(si    R    relative base indent per section depth
  2347. \&.sk    M    skip next page
  2348. \&.sm    M    set argument in a smaller pointsize
  2349. \&.so    M\(sc    source input file
  2350. \en(so    R    additional section title offset
  2351. \&.sp    M\(sc    vertical space
  2352. \en(sp    R    section title pointsize
  2353. \en(ss    R    section prespace
  2354. \&.sx    M    change section depth
  2355. \&.sz    M    set pointsize and vertical spacing
  2356. \&.ta    M\(sc    set tab stops
  2357. \&.tc    M\(sc    set tab repetition character
  2358. \e*(td    S    today's date
  2359. \en(tf    R    title font
  2360. \&.th    M    set thesis mode
  2361. \&.ti    M\(sc    temporary indent (next line only)
  2362. \&.tl    M\(sc    three part title
  2363. \en(tm    R    top title margin
  2364. \&.tp    M    begin title page
  2365. \en(tp    R    title pointsize
  2366. \&.tr    M\(sc    translate
  2367. \&.u    M    underlined
  2368. \&.uh    M    unnumbered section
  2369. \&.ul    M\(sc    underline next line
  2370. \ev\'\fI\&d\fP\'    F\(sc    local vertical motion for distance \fI\&d\fP
  2371. \e*v    S    inverted `v' for czeck ``e\*v''
  2372. \ew\'\fI\&S\fP\'    F\(sc    return width of string \fI\&S\fP
  2373. \&.xl    M    set line length (local)
  2374. \&.xp    M    print index
  2375. \en(xs    R    index entry prespace
  2376. \en(xu    R    index undent (from right margin)
  2377. \en(yr    R\(sc    year (last two digits only)
  2378. \en(zs    R    floating keep pre/post space
  2379. \e{    F\(sc    begin conditional group
  2380. \e|    F\(sc    1/6 em narrow space
  2381. \e}    F\(sc    end conditional group
  2382. \e*~    S    tilde
  2383. .)l
  2384. .rm $H
  2385.