![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to eqn.1 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Research Unix] / researchv10dc / man / man1|
Return to eqn.1 CVS log | Up to [Research Unix] / researchv10dc / man / man1 |
1.1 root 1: .TH EQN 1
2: .CT 1 writing_troff
3: .EQ
4: delim $$
5: .EN
6: .SH NAME
7: eqn, neqn, checkeq \- typeset mathematics
8: .SH SYNOPSIS
9: .B eqn
10: [
11: .I option ...
12: ]
13: [
14: .I file ...
15: ]
16: .PP
17: .B neqn
18: [
19: .I option ...
20: ]
21: [
22: .I file ...
23: ]
24: .PP
25: .B checkeq
26: [
27: .I file ...
28: ]
29: .SH DESCRIPTION
30: .I Eqn
31: is a
32: .IR troff (1)
33: preprocessor
34: for typesetting mathematics
35: on a phototypesetter,
36: .I neqn
37: on terminals.
38: Usage is almost always
39: .IP
40: .L
41: eqn file ... | troff
42: .br
43: .L
44: neqn file ... | nroff
45: .PP
46: If no files are specified,
47: these programs
48: read from the standard input.
49: .I Eqn
50: prepares output for the typesetter
51: named in the
52: .BI -T dest
53: option (Mergenthaler Linotron 202 default, see
54: .IR troff (1)).
55: When run with other preprocessor filters,
56: .I eqn
57: usually comes last.
58: .PP
59: A line beginning with
60: .B .EQ
61: marks the start of an equation;
62: the end of an equation
63: is marked by a line beginning with
64: .BR .EN .
65: Neither of these lines is altered,
66: so they may be defined in macro packages
67: to get
68: centering, numbering, etc.
69: It is also possible to set two characters
70: as `delimiters';
71: text between delimiters is also
72: .I eqn
73: input.
74: Delimiters may be set to characters
75: .I x
76: and
77: .I y
78: with the option
79: .BI -d xy
80: or (more commonly) with
81: .B delim
82: .I xy
83: between
84: .B .EQ
85: and
86: .BR .EN .
87: Left and right delimiters may be identical.
88: (They are customarily taken to be
89: $font CW "$$" )$.
90: Delimiters are turned off by
91: .LR "delim off" .
92: All text that is neither between delimiters nor between
93: .B .EQ
94: and
95: .B .EN
96: is passed through untouched.
97: .PP
98: .I Checkeq
99: reports missing or unbalanced delimiters and
100: .BR .EQ / .EN
101: pairs.
102: .PP
103: Tokens within
104: .I eqn
105: are separated by
106: spaces, tabs, newlines, braces, double quotes,
107: tildes or circumflexes.
108: Braces {} are used for grouping;
109: generally speaking,
110: anywhere a single character like
111: .L x
112: could appear, a complicated construction
113: enclosed in braces may be used instead.
114: Tilde
115: .L ~
116: represents a full space in the output,
117: circumflex
118: .L ^
119: half as much.
120: .if t .ig
121: .PP
122: WARNING to users of the on-line manual.
123: Unless your terminal understands half-spacing, the
124: examples below will be nearly unreadable.
125: To get a well printed copy execute
126: .BR "man -t eqn | lp" .
127: ..
128: .PP
129: .vs 13p
130: Subscripts and superscripts are produced with the keywords
131: .B sub
132: and
133: .B sup.
134: Thus
135: .L "x sub i"
136: makes
137: $x sub i$,
138: .L "a sub i sup 2"
139: produces
140: $a sub i sup 2$,
141: and
142: .L "e sup {x sup 2 + y sup 2}"
143: gives
144: $e sup {x sup 2 + y sup 2}$.
145: .PP
146: Fractions are made with
147: .BR over :
148: .L "a over b"
149: yields $a over b$.
150: .PP
151: .B sqrt
152: makes square roots:
153: .L "1 over sqrt {ax sup 2 +bx+c}"
154: results in
155: $1 over sqrt {ax sup 2 +bx+c}$ .
156: .PP
157: The keywords
158: .B from
159: and
160: .B to
161: introduce lower and upper
162: limits on arbitrary things:
163: $lim from {n -> inf} sum from 0 to n x sub i$
164: is made with
165: .L "lim from {n -> inf} sum from 0 to n x sub i".
166: .PP
167: Left and right brackets, braces, etc., of the right height are made with
168: .B left
169: and
170: .B right:
171: .L "left [ x sup 2 + y sup 2 over alpha right ] ~=~1"
172: produces
173: $left [ x sup 2 + y sup 2 over alpha right ] ~=~1$.
174: The
175: .B right
176: clause is optional.
177: Legal characters after
178: .B left
179: and
180: .B right
181: are braces, brackets, bars,
182: .B c
183: and
184: .B f
185: for ceiling and floor,
186: and
187: .B
188: ""
189: for nothing at all (useful for a right-side-only bracket).
190: .PP
191: Vertical piles of things are made with
192: .BR pile ,
193: .BR lpile ,
194: .BR cpile ,
195: and
196: .BR rpile :
197: .L "pile {a above b above c}"
198: produces
199: $pile {a above b above c}$.
200: There can be an arbitrary number of elements in a pile.
201: .B lpile
202: left-justifies,
203: .B pile
204: and
205: .B cpile
206: center, with different vertical spacing,
207: and
208: .B rpile
209: right justifies.
210: .PP
211: Matrices are made with
212: .BR matrix :
213: .L "matrix { lcol { x sub i above y sub 2 } ccol { 1 above 2 } }"
214: produces
215: $matrix { lcol { x sub i above y sub 2 } ccol { 1 above 2 } }$.
216: In addition, there is
217: .B rcol
218: for a right-justified column.
219: .PP
220: .vs 12p
221: Diacritical marks are made with
222: .BR prime ,
223: .BR dot ,
224: .BR dotdot ,
225: .BR hat ,
226: .BR tilde ,
227: .BR bar ,
228: .BR under ,
229: .BR vec ,
230: .BR dyad ,
231: and
232: .BR under :
233: .L "x sub 0 sup prime = f(t) bar + g(t) under"
234: is
235: $x sub 0 sup prime = f(t) bar + g(t) under$,
236: and
237: .L "x vec = y dyad"
238: is
239: $x vec = y dyad$.
240: .PP
241: Sizes and font can be changed with prefix operators
242: .B size
243: .I n,
244: .B size
245: .BI \(+- n,
246: .BR fat ,
247: .BR roman ,
248: .BR italic ,
249: .BR bold ,
250: or
251: .BR font
252: .I n.
253: Size and fonts can be changed globally in a document by
254: .B gsize
255: .I n
256: and
257: .B gfont
258: .IR n ,
259: or by the command-line arguments
260: .BI -s n
261: and
262: .BI -f n.
263: .PP
264: Normally subscripts and superscripts are reduced by
265: 3 point sizes from the previous size;
266: this may be changed by the command-line argument
267: .BI -p n.
268: .PP
269: Successive display arguments can be lined up.
270: Place
271: .B mark
272: before the desired lineup point in the first equation;
273: place
274: .B lineup
275: at the place that is to line up vertically in subsequent equations.
276: .PP
277: Shorthands may be defined
278: or existing keywords redefined with
279: .BI define :
280: .L define
281: .I thing
282: .L %
283: .I replacement
284: .L %
285: defines a new token called
286: .I thing
287: which will be replaced by
288: .I replacement
289: whenever it appears thereafter.
290: The
291: .L %
292: may be any character that does not occur in
293: .L replacement.
294: .PP
295: Keywords like
296: .L sum
297: .EQ
298: ( sum )
299: .EN
300: .L int
301: .EQ
302: ( int )
303: .EN
304: .L inf
305: .EQ
306: ( inf )
307: .EN
308: and shorthands like
309: .L >=
310: .EQ
311: (>=)
312: .EN
313: .L ->
314: .EQ
315: (->),
316: .EN
317: and
318: .L !=
319: .EQ
320: ( != )
321: .EN
322: are recognized.
323: Greek letters are spelled out in the desired case, as in
324: .L alpha
325: or
326: .LR GAMMA .
327: Mathematical words like
328: .LR sin ,
329: .LR cos ,
330: .L log
331: are made Roman automatically.
332: .IR Troff (1)
333: four-character escapes like
334: .L \e(lh
335: (\(lh) can be used anywhere.
336: Strings enclosed in double quotes
337: .B
338: " "
339: are passed through untouched;
340: this permits keywords to be entered as text,
341: and can be used to communicate
342: with
343: .I troff
344: when all else fails.
345: .SH "SEE ALSO"
346: .IR troff (1),
347: .IR tbl (1),
348: .IR ms (6),
349: .IR eqnchar (6),
350: .IR doctype (1)
351: .br
352: B. W. Kernighan and L. L. Cherry,
353: `Typesetting Mathematics\(emUser's Guide',
354: this manual, Volume 2
355: .br
356: J. F. Ossanna and B. W. Kernighan,
357: `NROFF/TROFF User's Manual',
358: .I ibid.
359: .SH BUGS
360: To embolden digits, parens, etc.,
361: it is necessary to quote them,
362: as in
363: .LR bold\ "12.3" .
364: .EQ
365: delim off
366: .EN
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.