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