|
|
1.1 root 1: .TH MS 7 "18 July 1983"
2: .UC 4
3: .ds ]W UCB Computer Center
4: .UC 4
5: .SH NAME
6: ms \- text formatting macros
7: .SH SYNOPSIS
8: \fBnroff \-ms\fP [ options ] file ...
9: .br
10: \fBtroff \-ms\fP [ options ] file ...
11: .SH DESCRIPTION
12: This package of \fInroff\fP\| and \fItroff\fP\|
13: macro definitions provides a formatting facility
14: for various styles of articles, theses, and books.
15: When producing 2-column output on a terminal or lineprinter,
16: or when reverse line motions are needed,
17: filter the output through \fIcol\fP\|(1).
18: All external \-ms macros are defined below.
19: Many \fInroff\fP\| and \fItroff\fP\| requests
20: are unsafe in conjunction with this package.
21: However, the first four requests below
22: may be used with impunity after initialization,
23: and the last two may be used even before initialization:
24: .sp .2
25: .ta 5n 12n
26: .nf
27: .bp begin new page
28: .br break output line
29: .sp n insert n spacing lines
30: .ce n center next n lines
31: .ls n line spacing: n=1 single, n=2 double space
32: .na no alignment of right margin
33: .fi
34: .sp .2
35: Font and point size changes with \ef and \es are also allowed;
36: for example, ``\efIword\efR'' will italicize \fIword.\fP
37: Output of the \fItbl, eqn,\fP and \fIrefer\fP\|(1) preprocessors
38: for equations, tables, and references is acceptable as input.
39: .SH FILES
40: /usr/lib/tmac/tmac.x
41: .br
42: /usr/lib/ms/x.???
43: .SH "SEE ALSO"
44: eqn(1), refer(1), tbl(1), troff(1)
45: .SH REQUESTS
46: .if n .in 0
47: .ds x \fIx\fP\|
48: .ds y \fIy\fP\|
49: .ds z \fI y\fP
50: .ds Y \fIx y\fP
51: .tr _.
52: .ta \w'MacroNam'u +\w'InitialVal'u +\w'Break? 'u
53: .sp .3
54: .nf
55: Macro Initial Break? \0 Explanation
56: Name Value Reset?
57: .sp .3
58: _AB \*x \- y begin abstract; if \*x=no don't label abstract
59: _AE \- y end abstract
60: _AI \- y author's institution
61: _AM \- n better accent mark definitions
62: _AU \- y author's name
63: _B \*x \- n embolden \*x; if no \*x, switch to boldface
64: _B1 \- y begin text to be enclosed in a box
65: _B2 \- y end boxed text and print it
66: _BT date n bottom title, printed at foot of page
67: _BX \*x \- n print word \*x in a box
68: _CM if t n cut mark between pages
69: _CT \- y,y chapter title: page number moved to CF (TM only)
70: _DA \*x if n n force date \*x at bottom of page; today if no \*x
71: _DE \- y end display (unfilled text) of any kind
72: _DS \*Y I y begin display with keep; \*x=I,L,C,B; \*y=indent
73: _ID\*z 8n,.5i y indented display with no keep; \*y=indent
74: _LD \- y left display with no keep
75: _CD \- y centered display with no keep
76: _BD \- y block display; center entire block
77: _EF \*x \- n even page footer \*x (3 part as for .tl)
78: _EH \*x \- n even page header \*x (3 part as for .tl)
79: _EN \- y end displayed equation produced by \fIeqn\fP
80: _EQ \*Y \- y break out equation; \*x=L,I,C; \*y=equation number
81: _FE \- n end footnote to be placed at bottom of page
82: _FP \- n numbered footnote paragraph; may be redefined
83: _FS \*x \- n start footnote; \*x is optional footnote label
84: _HD undef n optional page header below header margin
85: _I \*x \- n italicize \*x; if no \*x, switch to italics
86: _IP \*Y \- y,y indented paragraph, with hanging tag \*x; \*y=indent
87: _IX \*Y \- y index words \*x \*y and so on (up to 5 levels)
88: _KE \- n end keep of any kind
89: _KF \- n begin floating keep; text fills remainder of page
90: _KS \- y begin keep; unit kept together on a single page
91: _LG \- n larger; increase point size by 2
92: _LP \- y,y left (block) paragraph.
93: _MC \*x \- y,y multiple columns; \*x=column width
94: _ND \*x if t n no date in page footer; \*x is date on cover
95: _NH \*Y \- y,y numbered header; \*x=level, \*x=0 resets, \*x=S sets to \*y
96: _NL 10p n set point size back to normal
97: _OF \*x \- n odd page footer \*x (3 part as for .tl)
98: _OH \*x \- n odd page header \*x (3 part as for .tl)
99: _P1 if TM n print header on 1st page
100: _PP \- y,y paragraph with first line indented
101: _PT - % - n page title, printed at head of page
102: _PX \*x \- y print index (table of contents); \*x=no suppresses title
103: _QP \- y,y quote paragraph (indented and shorter)
104: _R on n return to Roman font
105: _RE 5n y,y retreat: end level of relative indentation
106: _RP \*x \- n released paper format; \*x=no stops title on 1st page
107: _RS 5n y,y right shift: start level of relative indentation
108: _SH \- y,y section header, in boldface
109: _SM \- n smaller; decrease point size by 2
110: _TA 8n,5n n set tabs to 8n 16n ... (nroff) 5n 10n ... (troff)
111: _TC \*x \- y print table of contents at end; \*x=no suppresses title
112: _TE \- y end of table processed by \fItbl\fP
113: _TH \- y end multi-page header of table
114: _TL \- y title in boldface and two points larger
115: _TM off n UC Berkeley thesis mode
116: _TS \*x \- y,y begin table; if \*x=H table has multi-page header
117: _UL \*x \- n underline \*x, even in \fItroff\fP
118: _UX \*x \- n UNIX; trademark message first time; \*x appended
119: _XA \*Y \- y another index entry; \*x=page or no for none; \*y=indent
120: _XE \- y end index entry (or series of .IX entries)
121: _XP \- y,y paragraph with first line exdented, others indented
122: _XS \*Y \- y begin index entry; \*x=page or no for none; \*y=indent
123: _1C on y,y one column format, on a new page
124: _2C \- y,y begin two column format
125: _]- \- n beginning of \fIrefer\fP\| reference
126: _[0 \- n end of unclassifiable type of reference
127: _[N \- n N= 1:journal-article, 2:book, 3:book-article, 4:report
128: .fi
129: .if t .bp
130: .DT
131: .SH REGISTERS
132: Formatting distances can be controlled in \-ms
133: by means of built-in number registers.
134: For example, this sets the line length to 6.5 inches:
135: .sp .3
136: .nr LL 6.5i
137: .sp .3
138: Here is a table of number registers and their default values:
139: .sp .3
140: .nf
141: .ta .5i +\w'Name\0'u +\w'paragraph distance 'u +\w'Takes Effect 'u
142: Name Register Controls Takes Effect Default
143: .sp .3
144: PS point size paragraph 10
145: VS vertical spacing paragraph 12
146: LL line length paragraph 6i
147: LT title length next page same as LL
148: FL footnote length next .FS 5.5i
149: PD paragraph distance paragraph 1v (if n), .3v (if t)
150: DD display distance displays 1v (if n), .5v (if t)
151: PI paragraph indent paragraph 5n
152: QI quote indent next .QP 5n
153: FI footnote indent next .FS 2n
154: PO page offset next page 0 (if n), \(ap1i (if t)
155: HM header margin next page 1i
156: FM footer margin next page 1i
157: FF footnote format next .FS 0 (1, 2, 3 available)
158: .fi
159: .sp .3
160: When resetting these values,
161: make sure to specify the appropriate units.
162: Setting the line length to 7, for example,
163: will result in output with one character per line.
164: Setting FF to 1 suppresses footnote superscripting;
165: setting it to 2 also suppresses indentation of the first line;
166: and setting it to 3 produces an .IP-like footnote paragraph.
167: .PP
168: Here is a list of string registers available in \-ms;
169: they may be used anywhere in the text:
170: .sp .3
171: .nf
172: .ta .5i 1.1i
173: Name String's Function
174: .sp .3
175: \e*Q quote (" in \fInroff,\fP\| `` in \fItroff\fP )
176: \e*U unquote (" in \fInroff,\fP\| '' in \fItroff\fP )
177: \e*\- dash (-- in \fInroff,\fP \(em in \fItroff\fP )
178: \e*(MO month (month of the year)
179: \e*(DY day (current date)
180: \e** automatically numbered footnote
181: \e*\' acute accent (before letter)
182: \e*\` grave accent (before letter)
183: \e*\d^ \ucircumflex (before letter)
184: \e*, cedilla (before letter)
185: \e*: umlaut (before letter)
186: \e*\d~ \utilde (before letter)
187: .fi
188: .sp .3
189: When using the extended accent mark definitions available with .AM,
190: these strings should come after, rather than before,
191: the letter to be accented.
192: .SH BUGS
193: Floating keeps and regular keeps are diverted to the same space,
194: so they cannot be mixed together with predictable results.
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.