Commit | Line | Data |
---|---|---|
2676dd22 EA |
1 | .nr MO 20 \" mod number |
2 | .de TL \" *** title line | |
3 | .lp | |
4 | .di XX | |
5 | .. | |
6 | .de DE \" *** description | |
7 | \\\\h'|\\n(DIu'\\\\c | |
8 | .br | |
9 | .di | |
10 | .in +\\n(DIu | |
11 | .ti 0 | |
12 | .cu 1000 | |
13 | .XX | |
14 | .rm XX | |
15 | .cu 0 | |
16 | .. | |
17 | .ds N \s-1NROFF\s0 | |
18 | .ds T \s-1TROFF\s0 | |
19 | .nr DI 1.5i | |
20 | .he '\-ME REFERENCE MANUAL''%' | |
21 | .de NR | |
22 | .b "\en\\$1" "\\$2" | |
23 | .. | |
24 | .de ST | |
25 | .b "\e*\\$1" "\\$2" | |
26 | .. | |
27 | .sc | |
28 | .+c | |
29 | .ce 20 | |
30 | .sz 14 | |
31 | .b "\-ME REFERENCE MANUAL" | |
32 | .sz | |
33 | .sp | |
34 | .i "Release 1.1/\n(MO" | |
35 | .sp 2 | |
36 | .ul | |
37 | Eric P. Allman | |
38 | .sp | |
39 | Electronics Research Laboratory | |
40 | University of California, Berkeley | |
41 | Berkeley, California 94720 | |
42 | .ce 0 | |
43 | .sp 4 | |
44 | .pp | |
45 | This document describes | |
46 | in extremely terse form | |
47 | the features | |
48 | of the | |
49 | .b \-me | |
50 | macro package | |
51 | for version seven \*N/\*T\*(dg. | |
52 | .(f | |
53 | \(dg\*N and \*T are Trademarks of Bell Laboratories. | |
54 | .)f | |
55 | Some familiarity is assumed | |
56 | with | |
57 | those programs, | |
58 | specifically, | |
59 | the reader should understand | |
60 | breaks, | |
61 | fonts, | |
62 | pointsizes, | |
63 | the use and definition of number registers | |
64 | and strings, | |
65 | how to define macros, | |
66 | and scaling factors for ens, points, | |
67 | .b v 's | |
68 | (vertical line spaces), | |
69 | etc. | |
70 | .pp | |
71 | For a more casual introduction | |
72 | to text processing | |
73 | using \*N, | |
74 | refer to the document | |
75 | .ul | |
76 | Writing Papers with \*N using \-me. | |
77 | .pp | |
78 | There are a number of macro parameters | |
79 | that may be adjusted. | |
80 | Fonts may be set to a font number only. | |
81 | In \*N font 8 | |
82 | is underlined, | |
83 | and is set in bold font in \*T | |
84 | (although font | |
85 | 3, | |
86 | bold in \*T, | |
87 | is not underlined in \*N). | |
88 | Font 0 is no font change; | |
89 | the font of the surrounding text | |
90 | is used instead. | |
91 | Notice that fonts 0 and 8 are | |
92 | .q pseudo-fonts ; | |
93 | that is, | |
94 | they are simulated by the macros. | |
95 | This means that although it is legal to set a font register | |
96 | to zero or eight, | |
97 | it is not legal to use the escape character form, | |
98 | such as: | |
99 | .(b | |
100 | \ef8 | |
101 | .)b | |
102 | .pp | |
103 | All distances | |
104 | are in basic units, | |
105 | so it is nearly always necessary | |
106 | to use a scaling factor. | |
107 | For example, | |
108 | the request | |
109 | to set the paragraph indent | |
110 | to eight one-en spaces is: | |
111 | .(b | |
112 | \&.nr pi 8n | |
113 | .)b | |
114 | and not | |
115 | .(b | |
116 | \&.nr pi 8 | |
117 | .)b | |
118 | which would set the paragraph indent to eight basic units, | |
119 | or about 0.02 inch. | |
120 | Default parameter values are given in brackets | |
121 | in the remainder of this document. | |
122 | .pp | |
123 | Registers and strings | |
124 | of the form | |
125 | .b $ \c | |
126 | .i x | |
127 | may be used in expressions | |
128 | but should not be changed. | |
129 | Macros of the form | |
130 | .b $ \c | |
131 | .i x | |
132 | perform some function | |
133 | (as described) | |
134 | and may be redefined | |
135 | to change this function. | |
136 | This may be a sensitive operation; | |
137 | look at the body of the original macro | |
138 | before changing it. | |
139 | .pp | |
140 | All names in \-me | |
141 | follow a rigid naming convention. | |
142 | The user may define number registers, | |
143 | strings, | |
144 | and macros, | |
145 | provided that s/he | |
146 | uses single character upper case names | |
147 | or double character names | |
148 | consisting of letters and digits, | |
149 | with at least one upper case letter. | |
150 | In no case should special characters | |
151 | be used in user-defined names. | |
152 | .pp | |
153 | On daisy wheel type printers | |
154 | in twelve pitch, | |
155 | the | |
156 | .b \-rx1 | |
157 | flag can be stated to make lines default to | |
158 | one eighth inch | |
159 | (the normal spacing for a newline in twelve-pitch). | |
160 | This is normally too small for easy readability, | |
161 | so the default is to space one sixth inch. | |
162 | .pp | |
163 | This documentation was | |
164 | .if n \*N'ed | |
165 | .if t \*T'ed | |
166 | on \*(td | |
167 | and applies to version | |
168 | 1.1/\n(MO | |
169 | of the \-me macros. | |
170 | .sh 1 "Paragraphing" | |
171 | .pp | |
172 | These macros are used | |
173 | to begin paragraphs. | |
174 | The standard paragraph macro | |
175 | is | |
176 | .b .pp ; | |
177 | the others are all variants | |
178 | to be used for special purposes. | |
179 | .pp | |
180 | The first call to one of the paragraphing macros | |
181 | defined in this section | |
182 | or the | |
183 | .b .sh | |
184 | macro | |
185 | (defined in the next session) | |
186 | .i initializes | |
187 | the macro processor. | |
188 | After initialization | |
189 | it is not possible to use any of the following requests: | |
190 | .b .sc , | |
191 | .b .lo , | |
192 | .b .th , | |
193 | or | |
194 | .b .ac . | |
195 | Also, | |
196 | the effects of changing parameters | |
197 | which will have a global effect | |
198 | on the format of the page | |
199 | (notably page length and header and footer margins) | |
200 | are not well defined | |
201 | and should be avoided. | |
202 | .TL | |
203 | .b .lp | |
204 | .DE | |
205 | Begin left-justified paragraph. | |
206 | Centering and underlining | |
207 | are turned off if they were on, | |
208 | the font is set to | |
209 | .NR (pf | |
210 | [1] | |
211 | the type size | |
212 | is set to | |
213 | .NR (pp | |
214 | [10p], | |
215 | and a | |
216 | .NR (ps | |
217 | space is inserted | |
218 | before the paragraph | |
219 | [0.35v in \*T, 1v or 0.5v in \*N | |
220 | depending on device resolution]. | |
221 | The indent is reset | |
222 | to | |
223 | .NR ($i | |
224 | [0] | |
225 | plus | |
226 | .NR (po | |
227 | [0] | |
228 | unless the paragraph | |
229 | is inside a display. | |
230 | (see | |
231 | .b .ba ). | |
232 | At least | |
233 | the first two lines | |
234 | of the paragraph | |
235 | are kept together | |
236 | on a page. | |
237 | .TL | |
238 | .b .pp | |
239 | .DE | |
240 | Like | |
241 | .b .lp , | |
242 | except that it puts | |
243 | .NR (pi | |
244 | [5n] | |
245 | units of indent. | |
246 | This is the standard paragraph macro. | |
247 | .TL | |
248 | .b .ip | |
249 | .i T | |
250 | .i I | |
251 | .DE | |
252 | Indented paragraph | |
253 | with hanging tag. | |
254 | The body of the following paragraph | |
255 | is indented | |
256 | .i I | |
257 | spaces | |
258 | (or | |
259 | .NR (ii | |
260 | [5n] | |
261 | spaces | |
262 | if | |
263 | .i I | |
264 | is not specified) | |
265 | more than a non-indented paragraph | |
266 | (such as with | |
267 | .b .pp ) | |
268 | is. | |
269 | The title | |
270 | .i T | |
271 | is exdented (opposite of indented). | |
272 | The result is a paragraph | |
273 | with an even left edge | |
274 | and | |
275 | .i T | |
276 | printed in the margin. | |
277 | Any spaces in | |
278 | .i T | |
279 | must be unpaddable. | |
280 | .TL | |
281 | .b .np | |
282 | .DE | |
283 | A variant of .ip which numbers paragraphs. | |
284 | Numbering is reset | |
285 | after a | |
286 | .b .lp , | |
287 | .b .pp , | |
288 | or | |
289 | .b .sh . | |
290 | The current paragraph number | |
291 | is in | |
292 | .NR ($p . | |
293 | .sh 1 "Section Headings" | |
294 | .pp | |
295 | Numbered sections | |
296 | are similiar to paragraphs | |
297 | except that a | |
298 | section number | |
299 | is automatically | |
300 | generated for each one. | |
301 | The section numbers are of the form | |
302 | .b 1.2.3 . | |
303 | The | |
304 | .i depth | |
305 | of the section | |
306 | is the count of numbers | |
307 | (separated by decimal points) | |
308 | in the section number. | |
309 | .pp | |
310 | Unnumbered section headings are similar, | |
311 | except that no number is attached | |
312 | to the heading. | |
313 | .TL | |
314 | .b .sh | |
315 | .i +N | |
316 | .i T | |
317 | .i "a b c d e f" | |
318 | .DE | |
319 | Begin numbered section | |
320 | of depth | |
321 | .i N . | |
322 | If | |
323 | .i N | |
324 | is missing | |
325 | the current depth | |
326 | (maintained in | |
327 | the number register | |
328 | .NR ($0 ) | |
329 | is used. | |
330 | The values of | |
331 | the individual parts of the section number | |
332 | are maintained in | |
333 | .NR ($1 | |
334 | through | |
335 | .NR ($6 . | |
336 | There is a | |
337 | .NR (ss | |
338 | [1v] | |
339 | space before the section. | |
340 | .i T | |
341 | is printed | |
342 | as a section title | |
343 | in font | |
344 | .NR (sf | |
345 | [8] | |
346 | and size | |
347 | .NR (sp | |
348 | [10p]. | |
349 | The | |
350 | .q name | |
351 | of the section may be accessed via | |
352 | .ST ($n . | |
353 | If | |
354 | .NR (si | |
355 | is non-zero, | |
356 | the base indent | |
357 | is set to | |
358 | .NR (si | |
359 | times the section depth, | |
360 | and the section title | |
361 | is exdented. | |
362 | (See | |
363 | .b .ba .) | |
364 | Also, | |
365 | an additional indent of | |
366 | .NR (so | |
367 | [0] | |
368 | is added to the section title | |
369 | (but not to the body of the section). | |
370 | The font is then set | |
371 | to the paragraph font, | |
372 | so that more information may occur | |
373 | on the line | |
374 | with the section number | |
375 | and title. | |
376 | .b .sh | |
377 | insures that there is enough room | |
378 | to print the section head | |
379 | plus the beginning of a paragraph | |
380 | (about 3 lines total). | |
381 | If | |
382 | .i a | |
383 | through | |
384 | .i f | |
385 | are specified, | |
386 | the section number is set to that number | |
387 | rather than incremented automatically. | |
388 | If any of | |
389 | .i a | |
390 | through | |
391 | .i f | |
392 | are a hyphen | |
393 | that number is not reset. | |
394 | If | |
395 | .i T | |
396 | is a single underscore | |
397 | (\c | |
398 | .q _ ) | |
399 | then the section depth and numbering is reset, | |
400 | but the base indent is not reset | |
401 | and nothing is printed out. | |
402 | This is useful to automatically | |
403 | coordinate section numbers with | |
404 | chapter numbers. | |
405 | .TL | |
406 | .b .sx | |
407 | .i +N | |
408 | .DE | |
409 | Go to section depth | |
410 | .i N | |
411 | [\c | |
412 | .b \-1 ], | |
413 | but do not print the number | |
414 | and title, | |
415 | and do not increment the section number | |
416 | at level | |
417 | .i N . | |
418 | This has the effect | |
419 | of starting a new paragraph | |
420 | at level | |
421 | .i N . | |
422 | .TL | |
423 | .b .uh | |
424 | .i T | |
425 | .DE | |
426 | Unnumbered section heading. | |
427 | The title | |
428 | .i T | |
429 | is printed | |
430 | with the same rules for spacing, | |
431 | font, etc., | |
432 | as for | |
433 | .b .sh . | |
434 | .TL | |
435 | .b .$p | |
436 | .i T | |
437 | .i B | |
438 | .i N | |
439 | .DE | |
440 | Print section heading. | |
441 | May be redefined | |
442 | to get fancier headings. | |
443 | .i T | |
444 | is the title passed on the | |
445 | .b .sh | |
446 | or | |
447 | .b .uh | |
448 | line; | |
449 | .i B | |
450 | is the section number for this section, | |
451 | and | |
452 | .i N | |
453 | is the depth of this section. | |
454 | These parameters are not always present; | |
455 | in particular, | |
456 | .b .sh | |
457 | passes all three, | |
458 | .b .uh | |
459 | passes only the first, | |
460 | and | |
461 | .b .sx | |
462 | passes three, | |
463 | but the first two | |
464 | are null strings. | |
465 | Care should be taken if this macro | |
466 | is redefined; | |
467 | it is quite complex and subtle. | |
468 | .TL | |
469 | .b .$0 | |
470 | .i T | |
471 | .i B | |
472 | .i N | |
473 | .DE | |
474 | This macro is called automatically | |
475 | after every call to | |
476 | .b .$p . | |
477 | It is normally undefined, | |
478 | but may be used | |
479 | to automatically put | |
480 | every section title | |
481 | into the table of contents | |
482 | or for some similiar function. | |
483 | .i T | |
484 | is the section title | |
485 | for the section title which was just printed, | |
486 | .i B | |
487 | is the section number, | |
488 | and | |
489 | .i N | |
490 | is the section depth. | |
491 | .TL | |
492 | .b .$1 | |
493 | \- | |
494 | .b .$6 | |
495 | .DE | |
496 | Traps called just before printing that depth section. | |
497 | May be defined to | |
498 | (for example) | |
499 | give variable spacing | |
500 | before sections. | |
501 | These macros are called from | |
502 | .b .$p , | |
503 | so if you redefine that macro | |
504 | you may lose this feature. | |
505 | .sh 1 "Headers and Footers" | |
506 | .ds TP \fI\(aal\|\(aam\^\(aar\^\(aa\fP | |
507 | .pp | |
508 | Headers and footers | |
509 | are put at the top and bottom | |
510 | of every page | |
511 | automatically. | |
512 | They are set in font | |
513 | .NR (tf | |
514 | [3] | |
515 | and size | |
516 | .NR (tp | |
517 | [10p]. | |
518 | Each of the definitions | |
519 | apply as of the | |
520 | .i next | |
521 | page. | |
522 | Three-part titles | |
523 | must be quoted | |
524 | if there are two blanks adjacent | |
525 | anywhere in the title | |
526 | or more than eight blanks total. | |
527 | .pp | |
528 | The spacing | |
529 | of headers and footers | |
530 | are controlled by three number registers. | |
531 | .NR (hm | |
532 | [4v] | |
533 | is the distance from the top of the page | |
534 | to the top of the header, | |
535 | .NR (fm | |
536 | [3v] | |
537 | is the distance from the bottom of the page | |
538 | to the bottom of the footer, | |
539 | .NR (tm | |
540 | [7v] | |
541 | is the distance from the top of the page | |
542 | to the top of the text, | |
543 | and | |
544 | .NR (bm | |
545 | [6v] | |
546 | is the distance from the bottom of the page | |
547 | to the bottom of the text | |
548 | (nominal). | |
549 | The macros | |
550 | .b .m1 , | |
551 | .b .m2 , | |
552 | .b .m3 , | |
553 | and | |
554 | .b .m4 | |
555 | are also supplied for compatibility | |
556 | with | |
557 | \s-1ROFF\s0 documents. | |
558 | .TL | |
559 | .b .he | |
560 | \*(TP | |
561 | .DE | |
562 | Define three-part header, | |
563 | to be printed on the top | |
564 | of every page. | |
565 | .TL | |
566 | .b .fo | |
567 | \*(TP | |
568 | .DE | |
569 | Define footer, | |
570 | to be printed at the bottom | |
571 | of every page. | |
572 | .TL | |
573 | .b .eh | |
574 | \*(TP | |
575 | .DE | |
576 | Define header, | |
577 | to be printed at the top of every | |
578 | even-numbered page. | |
579 | .TL | |
580 | .b .oh | |
581 | \*(TP | |
582 | .DE | |
583 | Define header, | |
584 | to be printed at the top of every | |
585 | odd-numbered page. | |
586 | .TL | |
587 | .b .ef | |
588 | \*(TP | |
589 | .DE | |
590 | Define footer, | |
591 | to be printed at the bottom | |
592 | of every even-numbered page. | |
593 | .TL | |
594 | .b .of | |
595 | \*(TP | |
596 | .DE | |
597 | Define footer, | |
598 | to be printed at the bottom | |
599 | of every odd-numbered page. | |
600 | .TL | |
601 | .b .hx | |
602 | .DE | |
603 | Suppress headers and footers | |
604 | on the next page. | |
605 | .TL | |
606 | .b .m1 | |
607 | .i +N | |
608 | .DE | |
609 | Set the space between the top of the page | |
610 | and the header | |
611 | [4v]. | |
612 | .TL | |
613 | .b .m2 | |
614 | .i +N | |
615 | .DE | |
616 | Set the space between the header | |
617 | and the first line of text | |
618 | [2v]. | |
619 | .TL | |
620 | .b .m3 | |
621 | .i +N | |
622 | .DE | |
623 | Set the space | |
624 | between the bottom of the text | |
625 | and the footer | |
626 | [2v]. | |
627 | .TL | |
628 | .b .m4 | |
629 | .i +N | |
630 | .DE | |
631 | Set the space | |
632 | between the footer | |
633 | and the bottom of the page | |
634 | [4v]. | |
635 | .TL | |
636 | .b .ep | |
637 | .DE | |
638 | End this page, | |
639 | but do not begin the next page. | |
640 | Useful for forcing out footnotes, | |
641 | but other than | |
642 | that hardly every used. | |
643 | Must be followed by a | |
644 | .b .bp | |
645 | or the end of input. | |
646 | .TL | |
647 | .b .$h | |
648 | .DE | |
649 | Called at every page | |
650 | to print the header. | |
651 | May be redefined | |
652 | to provide fancy | |
653 | (e.g., | |
654 | multi-line) | |
655 | headers, | |
656 | but doing so | |
657 | loses the function of the | |
658 | .b .he , | |
659 | .b .fo , | |
660 | .b .eh , | |
661 | .b .oh , | |
662 | .b .ef , | |
663 | and | |
664 | .b .of | |
665 | requests, | |
666 | as well as the chapter-style title feature | |
667 | of | |
668 | .b .+c . | |
669 | .TL | |
670 | .b .$f | |
671 | .DE | |
672 | Print footer; | |
673 | same comments apply | |
674 | as in | |
675 | .b .$h . | |
676 | .TL | |
677 | .b .$H | |
678 | .DE | |
679 | A normally undefined macro | |
680 | which is called | |
681 | at the top of each page | |
682 | (after outputing | |
683 | the header, | |
684 | initial saved floating keeps, | |
685 | etc.); | |
686 | in other words, | |
687 | this macro is called immediately before | |
688 | printing text | |
689 | on a page. | |
690 | It can be used for column headings | |
691 | and the like. | |
692 | .sh 1 "Displays" | |
693 | .pp | |
694 | All displays except centered blocks | |
695 | and block quotes | |
696 | are preceeded and followed | |
697 | by an extra | |
698 | .NR (bs | |
699 | [same as | |
700 | .NR (ps ] | |
701 | space. | |
702 | Quote spacing is stored in a separate register; | |
703 | centered blocks have no default initial or trailing space. | |
704 | The vertical spacing of all displays except quotes | |
705 | and centered blocks | |
706 | is stored in register | |
707 | .NR ($R | |
708 | instead of | |
709 | .NR ($r . | |
710 | .TL | |
711 | .b .(l | |
712 | .i m | |
713 | .i f | |
714 | .DE | |
715 | Begin list. | |
716 | Lists are single spaced, | |
717 | unfilled text. | |
718 | If | |
719 | .i f | |
720 | is | |
721 | .b F , | |
722 | the list will be filled. | |
723 | If | |
724 | .i m | |
725 | [\c | |
726 | .b I ] | |
727 | is | |
728 | .b I | |
729 | the list is indented by | |
730 | .NR (bi | |
731 | [4n]; | |
732 | if | |
733 | .b M | |
734 | the list is indented to the left margin; | |
735 | if | |
736 | .b L | |
737 | the list is left justified with respect to the text | |
738 | (different from | |
739 | .b M | |
740 | only if the base indent | |
741 | (stored in | |
742 | .NR ($i | |
743 | and set with | |
744 | .b .ba ) | |
745 | is not zero); | |
746 | and if | |
747 | .b C | |
748 | the list is centered on a line-by-line basis. | |
749 | The list is set in font | |
750 | .NR (df | |
751 | [0]. | |
752 | Must be matched by a | |
753 | .b .)l . | |
754 | This macro is almost like | |
755 | .b .(b | |
756 | except that no attempt is made | |
757 | to keep the display on one page. | |
758 | .TL | |
759 | .b .)l | |
760 | .DE | |
761 | End list. | |
762 | .TL | |
763 | .b .(q | |
764 | .DE | |
765 | Begin major quote. | |
766 | These are single spaced, | |
767 | filled, | |
768 | moved in from the text | |
769 | on both sides | |
770 | by | |
771 | .NR (qi | |
772 | [4n], | |
773 | preceeded and followed | |
774 | by | |
775 | .NR (qs | |
776 | [same as | |
777 | .NR (bs ] | |
778 | space, | |
779 | and are set in point size | |
780 | .NR (qp | |
781 | [one point smaller than surrounding text]. | |
782 | .TL | |
783 | .b .)q | |
784 | .DE | |
785 | End major quote. | |
786 | .TL | |
787 | .b .(b | |
788 | .i m | |
789 | .i f | |
790 | .DE | |
791 | Begin block. | |
792 | Blocks are a form of | |
793 | .i keep , | |
794 | where the text of a keep | |
795 | is kept together on one page | |
796 | if possible | |
797 | (keeps are useful | |
798 | for tables and figures | |
799 | which should not be broken | |
800 | over a page). | |
801 | If the block will not fit | |
802 | on the current page | |
803 | a new page is begun, | |
804 | .i unless | |
805 | that would leave more than | |
806 | .NR (bt | |
807 | [0] | |
808 | white space | |
809 | at the bottom of the text. | |
810 | If | |
811 | .NR (bt | |
812 | is zero, the threshold feature | |
813 | is turned off. | |
814 | Blocks are not filled | |
815 | unless | |
816 | .i f | |
817 | is | |
818 | .b F , | |
819 | when they are filled. | |
820 | The block will be left-justified | |
821 | if | |
822 | .i m | |
823 | is | |
824 | .b L , | |
825 | indented by | |
826 | .NR (bi | |
827 | [4n] | |
828 | if | |
829 | .i m | |
830 | is | |
831 | .b I | |
832 | or absent, | |
833 | centered | |
834 | (line-for-line) | |
835 | if | |
836 | .i m | |
837 | is | |
838 | .b C , | |
839 | and left justified to the margin | |
840 | (not to the base indent) | |
841 | if | |
842 | .i m | |
843 | is | |
844 | .b M . | |
845 | The block is set in font | |
846 | .NR (df | |
847 | [0]. | |
848 | .TL | |
849 | .b .)b | |
850 | .DE | |
851 | End block. | |
852 | .TL | |
853 | .b .(z | |
854 | .i m | |
855 | .i f | |
856 | .DE | |
857 | Begin floating keep. | |
858 | Like | |
859 | .b .(b | |
860 | except that the keep is | |
861 | .i floated | |
862 | to the bottom of the page | |
863 | or the top of the next page. | |
864 | Therefore, | |
865 | its position relative to the text changes. | |
866 | The floating keep is preceeded and followed | |
867 | by | |
868 | .NR (zs | |
869 | [1v] | |
870 | space. | |
871 | Also, | |
872 | it defaults to mode | |
873 | .b M . | |
874 | .TL | |
875 | .b .)z | |
876 | .DE | |
877 | End floating keep. | |
878 | .TL | |
879 | .b .(c | |
880 | .DE | |
881 | Begin centered block. | |
882 | The next keep | |
883 | is centered as a block, | |
884 | rather than on a line-by-line basis | |
885 | as with | |
886 | .b ".(b C" . | |
887 | This call may be nested | |
888 | inside keeps. | |
889 | .TL | |
890 | .b .)c | |
891 | .DE | |
892 | End centered block. | |
893 | .sh 1 Annotations | |
894 | .TL | |
895 | .b .(d | |
896 | .DE | |
897 | Begin delayed text. | |
898 | Everything in the next keep | |
899 | is saved for output | |
900 | later with | |
901 | .b .pd , | |
902 | in a manner | |
903 | similar to footnotes. | |
904 | .TL | |
905 | .b .)d | |
906 | .i n | |
907 | .DE | |
908 | End delayed text. | |
909 | The delayed text number register | |
910 | .NR ($d | |
911 | and the associated string | |
912 | .ST # | |
913 | are incremented if | |
914 | .ST # | |
915 | has been referenced. | |
916 | .TL | |
917 | .b .pd | |
918 | .DE | |
919 | Print delayed text. | |
920 | Everything diverted via | |
921 | .b .(d | |
922 | is printed and truncated. | |
923 | This might be used | |
924 | at the end of each chapter. | |
925 | .TL | |
926 | .b .(f | |
927 | .DE | |
928 | Begin footnote. | |
929 | The text of the footnote | |
930 | is floated to the bottom | |
931 | of the page | |
932 | and set in font | |
933 | .NR (ff | |
934 | [1] | |
935 | and size | |
936 | .NR (fp | |
937 | [8p]. | |
938 | Each entry | |
939 | is preceeded by | |
940 | .NR (fs | |
941 | [0.2v] | |
942 | space, | |
943 | is indented | |
944 | .NR (fi | |
945 | [3n] | |
946 | on the first line, | |
947 | and is indented | |
948 | .NR (fu | |
949 | [0] | |
950 | from the right margin. | |
951 | Footnotes line up underneath | |
952 | two columned output. | |
953 | If the text of the footnote | |
954 | will not all fit on one page | |
955 | it will be carried over | |
956 | to the next page. | |
957 | .TL | |
958 | .b .)f | |
959 | .i n | |
960 | .DE | |
961 | End footnote. | |
962 | The number register | |
963 | .NR ($f | |
964 | and the associated string | |
965 | .ST * | |
966 | are incremented | |
967 | if they have been referenced. | |
968 | .TL | |
969 | .b .$s | |
970 | .DE | |
971 | The macro to output the footnote seperator. | |
972 | This macro may be redefined | |
973 | to give other size lines or other types | |
974 | of separators. | |
975 | Currently | |
976 | it draws a 1.5i line. | |
977 | .TL | |
978 | .b .(x | |
979 | .i x | |
980 | .DE | |
981 | Begin index entry. | |
982 | Index entries are saved in the index | |
983 | .i x | |
984 | [\c | |
985 | .b x ] | |
986 | until called up with | |
987 | .b .xp. | |
988 | Each entry is preceeded | |
989 | by a | |
990 | .NR (xs | |
991 | [0.2v] | |
992 | space. | |
993 | Each entry is | |
994 | .q undented | |
995 | by | |
996 | .NR (xu | |
997 | [0.5i]; | |
998 | this register tells how far the page number | |
999 | extends into the right margin. | |
1000 | .TL | |
1001 | .b .)x | |
1002 | .i P | |
1003 | .i A | |
1004 | .DE | |
1005 | End index entry. | |
1006 | The index entry | |
1007 | is finished with a row of dots | |
1008 | with | |
1009 | .i A | |
1010 | [null] | |
1011 | right justified on the last line | |
1012 | (such as for an author's name), | |
1013 | followed by P | |
1014 | [\c | |
1015 | .NR % ]. | |
1016 | If | |
1017 | .i A | |
1018 | is specified, | |
1019 | .i P | |
1020 | must be specified; | |
1021 | .NR % | |
1022 | can be used to print the current page number. | |
1023 | If | |
1024 | .i P | |
1025 | is an underscore, | |
1026 | no page number | |
1027 | and no row of dots | |
1028 | are printed. | |
1029 | .TL | |
1030 | .b .xp | |
1031 | .i x | |
1032 | .DE | |
1033 | Print index | |
1034 | .i x | |
1035 | [\c | |
1036 | .b x ]. | |
1037 | The index is formated in the font, size, and so forth | |
1038 | in effect at the time it is printed, | |
1039 | rather than at the time it is collected. | |
1040 | .sh 1 "Columned Output" | |
1041 | .TL | |
1042 | .b .2c | |
1043 | .i +S | |
1044 | .i N | |
1045 | .DE | |
1046 | Enter two-column mode. | |
1047 | The column separation is set to | |
1048 | .i +S | |
1049 | [4n, 0.5i in ACM mode] | |
1050 | (saved in | |
1051 | .NR ($s ). | |
1052 | The column width, | |
1053 | calculated to fill the single column line length | |
1054 | with both columns, | |
1055 | is stored in | |
1056 | .NR ($l . | |
1057 | The current column | |
1058 | is in | |
1059 | .NR ($c . | |
1060 | You can test register | |
1061 | .NR ($m | |
1062 | [1] | |
1063 | to see if you are in single column | |
1064 | or double column mode. | |
1065 | Actually, | |
1066 | the request enters | |
1067 | .i N | |
1068 | [2] | |
1069 | columned output. | |
1070 | .TL | |
1071 | .b .1c | |
1072 | .DE | |
1073 | Revert to single-column mode. | |
1074 | .TL | |
1075 | .b .bc | |
1076 | .DE | |
1077 | Begin column. | |
1078 | This is like | |
1079 | .b .bp | |
1080 | except that it begins a new column | |
1081 | on a new page | |
1082 | only if necessary, | |
1083 | rather than forcing a whole new page | |
1084 | if there is another column left | |
1085 | on the current page. | |
1086 | .sh 1 "Fonts and Sizes" | |
1087 | .TL | |
1088 | .b .sz | |
1089 | .i +P | |
1090 | .DE | |
1091 | The pointsize is set to | |
1092 | .i P | |
1093 | [10p], | |
1094 | and the line spacing is set proportionally. | |
1095 | The ratio of line spacing to pointsize | |
1096 | is stored in | |
1097 | .NR ($r . | |
1098 | The ratio used internally | |
1099 | by displays and annotations | |
1100 | is stored in | |
1101 | .NR ($R | |
1102 | (although this is not used by | |
1103 | .b .sz ). | |
1104 | .TL | |
1105 | .b .r | |
1106 | .i W | |
1107 | .i X | |
1108 | .DE | |
1109 | Set | |
1110 | .i W | |
1111 | in roman font, | |
1112 | appending | |
1113 | .i X | |
1114 | in the previous font. | |
1115 | To append different font requests, | |
1116 | use | |
1117 | .i X | |
1118 | = | |
1119 | .b \ec . | |
1120 | If no parameters, | |
1121 | change to roman font. | |
1122 | .TL | |
1123 | .b .i | |
1124 | .i W | |
1125 | .i X | |
1126 | .DE | |
1127 | Set | |
1128 | .i W | |
1129 | in italics, | |
1130 | appending | |
1131 | .i X | |
1132 | in the previous font. | |
1133 | If no parameters, | |
1134 | change to italic font. | |
1135 | Underlines in \*N. | |
1136 | .TL | |
1137 | .b .b | |
1138 | .i W | |
1139 | .i X | |
1140 | .DE | |
1141 | Set | |
1142 | .i W | |
1143 | in bold font | |
1144 | and append | |
1145 | .i X | |
1146 | in the previous font. | |
1147 | If no parameters, | |
1148 | switch to bold font. | |
1149 | In \*N, | |
1150 | underlines. | |
1151 | .TL | |
1152 | .b .rb | |
1153 | .i W | |
1154 | .i X | |
1155 | .DE | |
1156 | Set | |
1157 | .i W | |
1158 | in bold font | |
1159 | and append | |
1160 | .i X | |
1161 | in the previous font. | |
1162 | If no parameters, | |
1163 | switch to bold font. | |
1164 | .b .rb | |
1165 | differs from | |
1166 | .b .b | |
1167 | in that | |
1168 | .b .rb | |
1169 | does not underline in \*N. | |
1170 | .TL | |
1171 | .b .u | |
1172 | .i W | |
1173 | .i X | |
1174 | .DE | |
1175 | Underline | |
1176 | .i W | |
1177 | and append | |
1178 | .i X . | |
1179 | This is a true underlining, | |
1180 | as opposed to the | |
1181 | .b .ul | |
1182 | request, | |
1183 | which changes to | |
1184 | .q "underline font" | |
1185 | (usually italics in \*T). | |
1186 | It won't work right | |
1187 | if | |
1188 | .i W | |
1189 | is spread or broken (including hyphenated). | |
1190 | In other words, | |
1191 | it is safe in nofill mode only. | |
1192 | .TL | |
1193 | .b .q | |
1194 | .i W | |
1195 | .i X | |
1196 | .DE | |
1197 | Quote | |
1198 | .i W | |
1199 | and append | |
1200 | .i X . | |
1201 | In \*N | |
1202 | this just surrounds | |
1203 | .i W | |
1204 | with double quote marks | |
1205 | (`\|\c | |
1206 | .b """" \|'), | |
1207 | but in \*T | |
1208 | uses directed quotes. | |
1209 | .TL | |
1210 | .b .bi | |
1211 | .i W | |
1212 | .i X | |
1213 | .DE | |
1214 | Set | |
1215 | .i W | |
1216 | in bold italics | |
1217 | and append | |
1218 | .i X . | |
1219 | Actually, | |
1220 | sets | |
1221 | .i W | |
1222 | in italic | |
1223 | and overstrikes once. | |
1224 | Underlines in \*N. | |
1225 | It won't work right | |
1226 | if | |
1227 | .i W | |
1228 | is spread or broken (including hyphenated). | |
1229 | In other words, | |
1230 | it is safe in nofill mode only. | |
1231 | .TL | |
1232 | .b .bx | |
1233 | .i W | |
1234 | .i X | |
1235 | .DE | |
1236 | Sets | |
1237 | .i W | |
1238 | in a box, | |
1239 | with | |
1240 | .i X | |
1241 | appended. | |
1242 | Underlines in \*N. | |
1243 | It won't work right | |
1244 | if | |
1245 | .i W | |
1246 | is spread or broken (including hyphenated). | |
1247 | In other words, | |
1248 | it is safe in nofill mode only. | |
1249 | .sh 1 "Roff Support" | |
1250 | .TL | |
1251 | .b .ix | |
1252 | .i +N | |
1253 | .DE | |
1254 | Indent, | |
1255 | no break. | |
1256 | Equivalent to | |
1257 | .b \(aain | |
1258 | .i N . | |
1259 | .TL | |
1260 | .b .bl | |
1261 | .i N | |
1262 | .DE | |
1263 | Leave | |
1264 | .i N | |
1265 | contiguous white space, | |
1266 | on the next page if not enough room | |
1267 | on this page. | |
1268 | Equivalent to a | |
1269 | .b .sp | |
1270 | .i N | |
1271 | inside a block. | |
1272 | .TL | |
1273 | .b .pa | |
1274 | .i +N | |
1275 | .DE | |
1276 | Equivalent to | |
1277 | .b .bp . | |
1278 | .TL | |
1279 | .b .ro | |
1280 | .DE | |
1281 | Set page number | |
1282 | in roman numerals. | |
1283 | Equivalent to | |
1284 | .b ".af % i" . | |
1285 | .TL | |
1286 | .b .ar | |
1287 | .DE | |
1288 | Set page number in arabic. | |
1289 | Equivalent to | |
1290 | .b ".af % 1" . | |
1291 | .TL | |
1292 | .b .n1 | |
1293 | .DE | |
1294 | Number lines in margin from one | |
1295 | on each page. | |
1296 | .TL | |
1297 | .b .n2 | |
1298 | .i N | |
1299 | .DE | |
1300 | Number lines from | |
1301 | .i N , | |
1302 | stop if | |
1303 | .i N | |
1304 | = 0. | |
1305 | .TL | |
1306 | .b .sk | |
1307 | .DE | |
1308 | Leave the next output page blank, | |
1309 | except for headers and footers. | |
1310 | This is used to leave space | |
1311 | for a full-page diagram | |
1312 | which is produced externally | |
1313 | and pasted in later. | |
1314 | To get a partial-page paste-in display, | |
1315 | say | |
1316 | .b .sv \ \c | |
1317 | .i N , | |
1318 | where | |
1319 | .i N | |
1320 | is the amount of space | |
1321 | to leave; | |
1322 | this space will be output immediately | |
1323 | if there is room, | |
1324 | and will otherwise be output | |
1325 | at the top of the next page. | |
1326 | However, be warned: | |
1327 | if | |
1328 | .i N | |
1329 | is greater than the amount of available space | |
1330 | on an empty page, | |
1331 | no space will ever be output. | |
1332 | .sh 1 "Preprocessor Support" | |
1333 | .TL | |
1334 | .b .EQ | |
1335 | .i m | |
1336 | .i T | |
1337 | .DE | |
1338 | Begin equation. | |
1339 | The equation is centered | |
1340 | if | |
1341 | .i m | |
1342 | is | |
1343 | .b C | |
1344 | or omitted, | |
1345 | indented | |
1346 | .NR (bi | |
1347 | [4n] | |
1348 | if | |
1349 | .i m | |
1350 | is | |
1351 | .b I , | |
1352 | and left justified if | |
1353 | .i m | |
1354 | is | |
1355 | .b L . | |
1356 | .i T | |
1357 | is a title printed on the right margin | |
1358 | next to the equation. | |
1359 | See | |
1360 | .i "Typesetting Mathematics \- User's Guide" | |
1361 | by Brian W. Kernighan | |
1362 | and Lorinda L. Cherry. | |
1363 | .TL | |
1364 | .b .EN | |
1365 | .i c | |
1366 | .DE | |
1367 | End equation. | |
1368 | If | |
1369 | .i c | |
1370 | is | |
1371 | .b C | |
1372 | the equation must be continued | |
1373 | by immediately following | |
1374 | with another | |
1375 | .b .EQ , | |
1376 | the text of which | |
1377 | can be centered | |
1378 | along with this one. | |
1379 | Otherwise, | |
1380 | the equation is printed, | |
1381 | always on one page, | |
1382 | with | |
1383 | .NR (es | |
1384 | [0.5v in \*T, 1v in \*N] | |
1385 | space | |
1386 | above and below it. | |
1387 | .TL | |
1388 | .b .TS | |
1389 | .i h | |
1390 | .DE | |
1391 | Table start. | |
1392 | Tables are single spaced | |
1393 | and kept on one page | |
1394 | if possible. | |
1395 | If you have a large table | |
1396 | which will not fit on one page, | |
1397 | use | |
1398 | .i h | |
1399 | = | |
1400 | .b H | |
1401 | and follow the header part | |
1402 | (to be printed on every page of the table) | |
1403 | with a | |
1404 | .b .TH . | |
1405 | See | |
1406 | .i "Tbl \- A Program to Format Tables" | |
1407 | by M. E. Lesk. | |
1408 | .TL | |
1409 | .b .TH | |
1410 | .DE | |
1411 | With | |
1412 | .b ".TS H" , | |
1413 | ends the header portion of the table. | |
1414 | .TL | |
1415 | .b .TE | |
1416 | .DE | |
1417 | Table end. | |
1418 | Note that this table | |
1419 | does not float, | |
1420 | in fact, | |
1421 | it is not even guaranteed to stay on one page | |
1422 | if you use requests such as | |
1423 | .b .sp | |
1424 | intermixed with the text | |
1425 | of the table. | |
1426 | If you want it to float | |
1427 | (or if you use requests | |
1428 | inside the table), | |
1429 | surround the entire table | |
1430 | (including the | |
1431 | .b .TS | |
1432 | and | |
1433 | .b .TE | |
1434 | requests) | |
1435 | with the requests | |
1436 | .b .(z | |
1437 | and | |
1438 | .b .)z . | |
1439 | .sh 1 "Miscellaneous" | |
1440 | .TL | |
1441 | .b .re | |
1442 | .DE | |
1443 | Reset tabs. | |
1444 | Set to every 0.5i | |
1445 | in \*T | |
1446 | and every 0.8i in \*N. | |
1447 | .TL | |
1448 | .b .ba | |
1449 | .i +N | |
1450 | .DE | |
1451 | Set the base indent | |
1452 | to | |
1453 | .i +N | |
1454 | [0] | |
1455 | (saved in | |
1456 | .NR ($i ). | |
1457 | All paragraphs, | |
1458 | sections, | |
1459 | and displays | |
1460 | come out indented by this amount. | |
1461 | Titles and footnotes | |
1462 | are unaffected. | |
1463 | The | |
1464 | .b .sh | |
1465 | request performs a | |
1466 | .b .ba | |
1467 | request | |
1468 | if | |
1469 | .NR (si | |
1470 | [0] is not zero, | |
1471 | and sets the base indent to | |
1472 | .NR (si \c | |
1473 | .b * \c | |
1474 | .NR ($0 . | |
1475 | .TL | |
1476 | .b .xl | |
1477 | .i +N | |
1478 | .DE | |
1479 | Set the line length to | |
1480 | .i N | |
1481 | [6.0i]. | |
1482 | This differs | |
1483 | from | |
1484 | .b .ll | |
1485 | because it only affects the current environment. | |
1486 | .TL | |
1487 | .b .ll | |
1488 | .i +N | |
1489 | .DE | |
1490 | Set line length in all environments | |
1491 | to | |
1492 | .i N | |
1493 | [6.0i]. | |
1494 | This should not be used | |
1495 | after output has begun, | |
1496 | and particularly not in two-columned output. | |
1497 | The current line length is stored in | |
1498 | .NR ($l . | |
1499 | .TL | |
1500 | .b .hl | |
1501 | .DE | |
1502 | Draws a horizontal line | |
1503 | the length of the page. | |
1504 | This is useful | |
1505 | inside floating keeps | |
1506 | to differentiate | |
1507 | between the text | |
1508 | and the figure. | |
1509 | .TL | |
1510 | .b .lo | |
1511 | .DE | |
1512 | This macro loads another set of macros | |
1513 | (in | |
1514 | .b /usr/lib/me/local.me ) | |
1515 | which is intended to be a set of locally defined macros. | |
1516 | These macros | |
1517 | should all be of the form | |
1518 | .b .* \c | |
1519 | .i X , | |
1520 | where | |
1521 | .i X | |
1522 | is any letter | |
1523 | (upper or lower case) | |
1524 | or digit. | |
1525 | .sh 1 "Standard Papers" | |
1526 | .TL | |
1527 | .b .tp | |
1528 | .DE | |
1529 | Begin title page. | |
1530 | Spacing at the top of the page | |
1531 | can occur, | |
1532 | and headers and footers are supressed. | |
1533 | Also, | |
1534 | the page number | |
1535 | is not incremented | |
1536 | for this page. | |
1537 | .TL | |
1538 | .b .th | |
1539 | .DE | |
1540 | Set thesis mode. | |
1541 | This defines the modes acceptable | |
1542 | for a doctoral dissertation | |
1543 | at Berkeley. | |
1544 | It double spaces, | |
1545 | defines the header | |
1546 | to be a single page number, | |
1547 | and changes the margins | |
1548 | to be 1.5 inch on the left | |
1549 | and one inch on the top. | |
1550 | .b .++ | |
1551 | and | |
1552 | .b .+c | |
1553 | should be used with it. | |
1554 | This macro must be stated | |
1555 | before | |
1556 | initialization, | |
1557 | that is, | |
1558 | before the first call of a paragraphing | |
1559 | macro | |
1560 | or | |
1561 | .b .sh . | |
1562 | .TL | |
1563 | .b .++ | |
1564 | .i m | |
1565 | .i H | |
1566 | .DE | |
1567 | This request defines the section of the paper | |
1568 | which we are entering. | |
1569 | The section type is defined by | |
1570 | .i m . | |
1571 | .b C | |
1572 | means that we are entering the chapter portion | |
1573 | of the paper, | |
1574 | .b A | |
1575 | means that we are entering the appendix portion | |
1576 | of the paper, | |
1577 | .b P | |
1578 | means that the material following | |
1579 | should be the preliminary portion | |
1580 | (abstract, table of contents, etc.) | |
1581 | portion of the paper, | |
1582 | .b AB | |
1583 | means that we are entering the abstract | |
1584 | (numbered independently from 1 | |
1585 | in Arabic numerals), | |
1586 | and | |
1587 | .b B | |
1588 | means that we are entering the bibliographic | |
1589 | portion at the end of the paper. | |
1590 | Also, the variants | |
1591 | .b RC | |
1592 | and | |
1593 | .b RA | |
1594 | are allowed, | |
1595 | which specify renumbering of pages | |
1596 | from one at the beginning of each | |
1597 | chapter or appendix, | |
1598 | respectively. | |
1599 | The | |
1600 | .i H | |
1601 | parameter defines the new header. | |
1602 | If there are any spaces in it, | |
1603 | the entire header must be quoted. | |
1604 | If you want the header to have the chapter number | |
1605 | in it, | |
1606 | Use the string | |
1607 | .b "\e\e\e\en(ch" . | |
1608 | For example, to number appendixes | |
1609 | .b A.1 | |
1610 | etc., | |
1611 | type | |
1612 | .b ".++ RA \(aa\(aa\(aa\e\e\e\en(ch.%\(aa" . | |
1613 | Each section | |
1614 | (chapter, appendix, etc.) | |
1615 | should be preceeded by the | |
1616 | .b .+c | |
1617 | request. | |
1618 | It should be mentioned | |
1619 | that it is easier when using | |
1620 | \*T to put the front material | |
1621 | at the end of the paper, | |
1622 | so that the table of contents | |
1623 | can be collected and output; | |
1624 | this material can then be physically | |
1625 | moved to the beginning of the paper. | |
1626 | .TL | |
1627 | .b .+c | |
1628 | .i T | |
1629 | .DE | |
1630 | Begin chapter with title | |
1631 | .i T . | |
1632 | The chapter number | |
1633 | is maintained in | |
1634 | .NR (ch . | |
1635 | This register is incremented | |
1636 | every time | |
1637 | .b .+c | |
1638 | is called with a parameter. | |
1639 | The title and chapter number | |
1640 | are printed by | |
1641 | .b .$c . | |
1642 | The header is moved to the footer | |
1643 | on the first page | |
1644 | of each chapter. | |
1645 | If | |
1646 | .i T | |
1647 | is omitted, | |
1648 | .b .$c | |
1649 | is not called; | |
1650 | this is useful for doing your own | |
1651 | .q "title page" | |
1652 | at the beginning of papers | |
1653 | without a title page proper. | |
1654 | .b .$c | |
1655 | calls | |
1656 | .b .$C | |
1657 | as a hook so that chapter titles can be inserted | |
1658 | into a table of contents automatically. | |
1659 | .TL | |
1660 | .b .$c | |
1661 | .i T | |
1662 | .DE | |
1663 | Print chapter number | |
1664 | (from | |
1665 | .NR (ch ) | |
1666 | and | |
1667 | .i T . | |
1668 | This macro can be redefined to your liking. | |
1669 | It is defined by default | |
1670 | to be acceptable | |
1671 | for a PhD thesis | |
1672 | at Berkeley. | |
1673 | This macro calls | |
1674 | .b $C , | |
1675 | which can be defined to make index entries, | |
1676 | or whatever. | |
1677 | .TL | |
1678 | .b .$C | |
1679 | .i K | |
1680 | .i N | |
1681 | .i T | |
1682 | .DE | |
1683 | This macro is called by | |
1684 | .b .$c . | |
1685 | It is normally undefined, | |
1686 | but can be used to automatically insert | |
1687 | index entries, | |
1688 | or whatever. | |
1689 | .i K | |
1690 | is a keyword, | |
1691 | either | |
1692 | .q Chapter | |
1693 | or | |
1694 | .q Appendix | |
1695 | (depending on the | |
1696 | .b .++ | |
1697 | mode); | |
1698 | .i N | |
1699 | is the chapter or appendix number, | |
1700 | and | |
1701 | .i T | |
1702 | is the chapter or appendix title. | |
1703 | .TL | |
1704 | .b .ac | |
1705 | .i A | |
1706 | .i N | |
1707 | .DE | |
1708 | This macro | |
1709 | (short for | |
1710 | .b .acm ) | |
1711 | sets up the \*N environment | |
1712 | for photo-ready papers | |
1713 | as used by the ACM. | |
1714 | This format is 25% larger, | |
1715 | and has no headers or footers. | |
1716 | The author's name | |
1717 | .i A | |
1718 | is printed at the bottom of the page | |
1719 | (but off the part which will be printed | |
1720 | in the conference proceedings), | |
1721 | together with the current page number | |
1722 | and the total number of pages | |
1723 | .i N . | |
1724 | Additionally, | |
1725 | this macro loads the file | |
1726 | .b /usr/lib/me/acm.me , | |
1727 | which may later be augmented with other macros | |
1728 | useful for printing papers | |
1729 | for ACM conferences. | |
1730 | It should be noted | |
1731 | that this macro will not work correctly in \*T, | |
1732 | since it sets the page length | |
1733 | wider than the physical width | |
1734 | of the phototypesetter roll. | |
1735 | .sh 1 "Predefined Strings" | |
1736 | .TL | |
1737 | .ST * | |
1738 | .DE | |
1739 | Footnote number, actually | |
1740 | .ST [ \c | |
1741 | .NR ($f \c | |
1742 | .ST ] . | |
1743 | This macro is incremented | |
1744 | after each call to | |
1745 | .b .)f . | |
1746 | .TL | |
1747 | .ST # | |
1748 | .DE | |
1749 | Delayed text number. | |
1750 | Actually | |
1751 | [\c | |
1752 | .NR ($d ]. | |
1753 | .TL | |
1754 | .ST [ | |
1755 | .DE | |
1756 | Superscript. | |
1757 | This string gives upward movement | |
1758 | and a change to a smaller point size | |
1759 | if possible, | |
1760 | otherwise it gives the left bracket character | |
1761 | (`\^\c | |
1762 | .b [ \^'). | |
1763 | .TL | |
1764 | .ST ] | |
1765 | .DE | |
1766 | Unsuperscript. | |
1767 | Inverse to | |
1768 | .ST [ . | |
1769 | For example, | |
1770 | to produce a superscript | |
1771 | you might type | |
1772 | .b x \c | |
1773 | .ST [ \c | |
1774 | .b 2 \c | |
1775 | .ST ] , | |
1776 | which will produce | |
1777 | .b x\*[2\*] . | |
1778 | .TL | |
1779 | .ST < | |
1780 | .DE | |
1781 | Subscript. | |
1782 | Defaults to | |
1783 | `\^<\^' | |
1784 | if half-carriage motion not possible. | |
1785 | .TL | |
1786 | .ST > | |
1787 | .DE | |
1788 | Inverse to | |
1789 | .ST < . | |
1790 | .TL | |
1791 | .ST (dw | |
1792 | .DE | |
1793 | The day of the week, | |
1794 | as a word. | |
1795 | .TL | |
1796 | .ST (mo | |
1797 | .DE | |
1798 | The month, | |
1799 | as a word. | |
1800 | .TL | |
1801 | .ST (td | |
1802 | .DE | |
1803 | Today's date, | |
1804 | directly printable. | |
1805 | The date is of the form \*(td. | |
1806 | Other forms of the date can be used | |
1807 | by using | |
1808 | .NR (dy | |
1809 | (the day of the month; | |
1810 | for example, \n(dy), | |
1811 | .ST (mo | |
1812 | (as noted above) | |
1813 | or | |
1814 | .NR (mo | |
1815 | (the same, | |
1816 | but as an ordinal number; | |
1817 | for example, \*(mo is \n(mo), | |
1818 | and | |
1819 | .NR (yr | |
1820 | (the last two digits of the current year). | |
1821 | .TL | |
1822 | .ST (lq | |
1823 | .DE | |
1824 | Left quote marks. | |
1825 | Double quote in \*N. | |
1826 | .TL | |
1827 | .ST (rq | |
1828 | .DE | |
1829 | Right quote. | |
1830 | .TL | |
1831 | .ST \- | |
1832 | .DE | |
1833 | \(34 em dash in \*T; | |
1834 | two hyphens in \*N. | |
1835 | .sh 1 "Special Characters and Marks" | |
1836 | .pp | |
1837 | There are a number of special characters | |
1838 | and diacritical marks | |
1839 | (such as accents) | |
1840 | available through \-me. | |
1841 | To reference these characters, | |
1842 | you must call the macro | |
1843 | .b .sc | |
1844 | to define the characters before using them. | |
1845 | .TL | |
1846 | .b .sc | |
1847 | .DE | |
1848 | Define special characters and diacritical marks, as described | |
1849 | in the remainder of this section. | |
1850 | This macro must be stated | |
1851 | before initialization. | |
1852 | .pp | |
1853 | The special characters available | |
1854 | are listed below. | |
1855 | .ta 15 +5 +6 | |
1856 | .nf | |
1857 | Name Usage Example | |
1858 | Acute accent \e*\(aa a\e*\(aa a\*' | |
1859 | Grave accent \e*\(ga e\e*\(ga e\*` | |
1860 | Umlat \e*: u\e*: u\*: | |
1861 | Tilde \e*~ n\e*~ n\*~ | |
1862 | Caret \e*^ e\e*^ e\*^ | |
1863 | Cedilla \e*, c\e*, c\*, | |
1864 | Czech \e*v e\e*v e\*v | |
1865 | Circle \e*o A\e*o A\*o | |
1866 | There exists \e*(qe \*(qe | |
1867 | For all \e*(qa \*(qa | |
1868 | .fi | |
1869 | .sp 1i | |
1870 | .b Acknowledgments | |
1871 | .pp | |
1872 | I would like to thank | |
1873 | Bob Epstein, | |
1874 | Bill Joy, | |
1875 | and Larry Rowe | |
1876 | for having the courage | |
1877 | to use the \-me macros | |
1878 | to produce non-trivial papers | |
1879 | during the development stages; | |
1880 | Ricki Blau, | |
1881 | Pamela Humphrey, | |
1882 | and Jim Joyce | |
1883 | for their help with the documentation phase; | |
1884 | and the plethora of people who have contributed ideas | |
1885 | and have given support for the project. |