1.\" Copyright (c) 1980, 1993
2.\" The Regents of the University of California. 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.\" @(#)me.7 8.1 (Berkeley) 6/5/93
33.\"
34.hc %
35.TH ME 7 "June 5, 1993"
36.UC 3
37.SH NAME
38me \- macros for formatting papers
39.SH SYNOPSIS
40.B "nroff \-me"
41[ options ]
42file ...
43.br
44.B "troff \-me"
45[ options ]
46file ...
47.SH DESCRIPTION
48This package of
49.I nroff
50and
51.I troff
52macro definitions provides a canned formatting
53facility for tech%nical papers in various formats.
54When producing 2-column output on a terminal, filter
55the output through
56.IR col (1).
57.PP
58The macro requests are defined below.
59Many
60.I nroff
61and
62.I troff
63requests are unsafe in conjunction with
64this package, however, these requests may be used with
65impunity after the first .pp:
66.nf
67.IP
68.ta \w'.sz +n 'u
69\&.bp begin new page
70\&.br break output line here
71\&.sp n insert n spacing lines
72\&.ls n (line spacing) n=1 single, n=2 double space
73\&.na no alignment of right margin
74\&.ce n center next n lines
75\&.ul n underline next n lines
76\&.sz +n add n to point size
77.fi
78.PP
79Output of the
80.I eqn,
81.I neqn,
82.I refer,
83and
84.IR tbl (1)
85preprocessors
86for equations and tables is acceptable as input.
87.SH FILES
88/usr/share/tmac/tmac.e
89.br
90/usr/share/me/*
91.SH "SEE ALSO"
92eqn(1), troff(1), refer(1), tbl(1)
93.br
94\-me Reference Manual, Eric P. Allman
95.br
96Writing Papers with Nroff Using \-me
97.tr &.
98.SH REQUESTS
99In the following list,
100\*(lqinitialization\*(rq
101refers to the first .pp, .lp, .ip, .np, .sh, or .uh macro.
102This list is incomplete;
103see
104.I "The \-me Reference Manual"
105for interesting details.
106.PP
107.ta \w'.eh \'x\'y\'z\' 'u +\w'Initial 'u +\w'Cause 'u
108.br
109.di x
110 \ka
111.br
112.di
113.in \nau
114.ti 0
115Request Initial Cause Explanation
116.ti 0
117 Value Break
118.br
119.in \nau
120.ti 0
121\&.(c - yes Begin centered block
122.ti 0
123\&.(d - no Begin delayed text
124.ti 0
125\&.(f - no Begin footnote
126.ti 0
127\&.(l - yes Begin list
128.ti 0
129\&.(q - yes Begin major quote
130.ti 0
131\&.(x \fIx\fR - no Begin indexed item in index
132.I x
133.ti 0
134\&.(z - no Begin floating keep
135.ti 0
136\&.)c - yes End centered block
137.ti 0
138\&.)d - yes End delayed text
139.ti 0
140\&.)f - yes End footnote
141.ti 0
142\&.)l - yes End list
143.ti 0
144\&.)q - yes End major quote
145.ti 0
146\&.)x - yes End index item
147.ti 0
148\&.)z - yes End floating keep
149.ti 0
150\&.++ \fIm H\fR - no Define paper section.
151.I m
152defines the part of the paper, and can be
153.B C
154(chapter),
155.B A
156(appendix),
157.B P
158(preliminary, e.g., abstract, table of contents, etc.),
159.B B
160(bibliography),
161.B RC
162(chapters renumbered from page one each chapter),
163or
164.B RA
165(appendix renumbered from page one).
166.ti 0
167\&.+c \fIT\fR - yes Begin chapter (or appendix, etc., as
168set by .++).
169.I T
170is the chapter title.
171.ti 0
172\&.1c 1 yes One column format on a new page.
173.ti 0
174\&.2c 1 yes Two column format.
175.ti 0
176\&.EN - yes Space after equation
177produced by
178.I eqn
179or
180.IR neqn .
181.ti 0
182\&.EQ \fIx y\fR - yes Precede equation; break out and
183add space.
184Equation number is
185.IR y .
186The optional argument \fIx\fR
187may be
188.I I
189to indent equation (default),
190.I L
191to left-adjust the equation, or
192.I C
193to center the equation.
194.ti 0
195\&.GE - yes End \fIgremlin\fP picture.
196.ti 0
197\&.GS - yes Begin \fIgremlin\fP picture.
198.ti 0
199\&.PE - yes End \fIpic\fP picture.
200.ti 0
201\&.PS - yes Begin \fIpic\fP picture.
202.ti 0
203\&.TE - yes End table.
204.ti 0
205\&.TH - yes End heading section of table.
206.ti 0
207\&.TS \fIx\fR - yes Begin table; if \fIx\fR is
208.I H
209table has repeated heading.
210.ti 0
211\&.ac \fIA N\fR - no Set up for ACM style output.
212.I A
213is the Author's name(s),
214.I N
215is the total number of pages.
216Must be given before the first initialization.
217.ti 0
218\&.b \fIx\fR no no Print
219.I x
220in boldface; if no argument switch to boldface.
221.ti 0
222\&.ba \fI+n\fR 0 yes Augments the base indent by
223.I n.
224This indent is used to set the indent on regular text
225(like paragraphs).
226.ti 0
227\&.bc no yes Begin new column
228.ti 0
229\&.bi \fIx\fR no no Print
230.I x
231in bold italics (nofill only)
232.ti 0
233\&.bu - yes Begin bulleted paragraph
234.ti 0
235\&.bx \fIx\fR no no Print \fIx\fR in a box (nofill only).
236.ti 0
237\&.ef \fI\'x\'y\'z\'\fR \'\'\'\' no Set even footer to x y z
238.ti 0
239\&.eh \fI\'x\'y\'z\'\fR \'\'\'\' no Set even header to x y z
240.ti 0
241\&.fo \fI\'x\'y\'z\'\fR \'\'\'\' no Set footer to x y z
242.ti 0
243\&.hx - no Suppress headers and footers on next page.
244.ti 0
245\&.he \fI\'x\'y\'z\'\fR \'\'\'\' no Set header to x y z
246.ti 0
247\&.hl - yes Draw a horizontal line
248.ti 0
249\&.i \fIx\fR no no Italicize
250.I x;
251if
252.I x
253missing, italic text follows.
254.ti 0
255\&.ip \fIx y\fR no yes Start indented paragraph,
256with hanging tag
257.IR x .
258Indentation is
259.I y
260ens (default 5).
261.ti 0
262\&.lp yes yes Start left-blocked paragraph.
263.ti 0
264\&.lo - no Read in a file of local macros of the
265form
266.BI \&.* x.
267Must be given before initialization.
268.ti 0
269\&.np 1 yes Start numbered paragraph.
270.ti 0
271\&.of \fI\'x\'y\'z\'\fR \'\'\'\' no Set odd footer to x y z
272.ti 0
273\&.oh \fI\'x\'y\'z\'\fR \'\'\'\' no Set odd header to x y z
274.ti 0
275\&.pd - yes Print delayed text.
276.ti 0
277\&.pp no yes Begin paragraph.
278First line indented.
279.ti 0
280\&.r yes no Roman text follows.
281.ti 0
282\&.re - no Reset tabs to default values.
283.ti 0
284\&.sc no no Read in a file of special characters
285and diacritical marks.
286Must be given before initialization.
287.ti 0
288\&.sh \fIn x\fR - yes Section head follows,
289font automatically bold.
290.I n
291is level of section,
292.I x
293is title of section.
294.ti 0
295\&.sk no no Leave the next page blank.
296Only one page is remembered ahead.
297.ti 0
298\&.sm \fIx\fR - no Set
299.I x
300in a smaller pointsize.
301.ti 0
302\&.sz \fI+n\fR 10p no Augment the point size by
303.I n
304points.
305.ti 0
306\&.th no no Produce the paper in thesis format.
307Must be given before initialization.
308.ti 0
309\&.tp no yes Begin title page.
310.ti 0
311\&.u \fIx\fR - no Underline argument (even in \fItroff\fR).
312(Nofill only).
313.ti 0
314\&.uh - yes Like .sh but unnumbered.
315.ti 0
316\&.xp \fIx\fR - no Print index
317.I x.
2.\" The Regents of the University of California. 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.\" @(#)me.7 8.1 (Berkeley) 6/5/93
33.\"
34.hc %
35.TH ME 7 "June 5, 1993"
36.UC 3
37.SH NAME
38me \- macros for formatting papers
39.SH SYNOPSIS
40.B "nroff \-me"
41[ options ]
42file ...
43.br
44.B "troff \-me"
45[ options ]
46file ...
47.SH DESCRIPTION
48This package of
49.I nroff
50and
51.I troff
52macro definitions provides a canned formatting
53facility for tech%nical papers in various formats.
54When producing 2-column output on a terminal, filter
55the output through
56.IR col (1).
57.PP
58The macro requests are defined below.
59Many
60.I nroff
61and
62.I troff
63requests are unsafe in conjunction with
64this package, however, these requests may be used with
65impunity after the first .pp:
66.nf
67.IP
68.ta \w'.sz +n 'u
69\&.bp begin new page
70\&.br break output line here
71\&.sp n insert n spacing lines
72\&.ls n (line spacing) n=1 single, n=2 double space
73\&.na no alignment of right margin
74\&.ce n center next n lines
75\&.ul n underline next n lines
76\&.sz +n add n to point size
77.fi
78.PP
79Output of the
80.I eqn,
81.I neqn,
82.I refer,
83and
84.IR tbl (1)
85preprocessors
86for equations and tables is acceptable as input.
87.SH FILES
88/usr/share/tmac/tmac.e
89.br
90/usr/share/me/*
91.SH "SEE ALSO"
92eqn(1), troff(1), refer(1), tbl(1)
93.br
94\-me Reference Manual, Eric P. Allman
95.br
96Writing Papers with Nroff Using \-me
97.tr &.
98.SH REQUESTS
99In the following list,
100\*(lqinitialization\*(rq
101refers to the first .pp, .lp, .ip, .np, .sh, or .uh macro.
102This list is incomplete;
103see
104.I "The \-me Reference Manual"
105for interesting details.
106.PP
107.ta \w'.eh \'x\'y\'z\' 'u +\w'Initial 'u +\w'Cause 'u
108.br
109.di x
110 \ka
111.br
112.di
113.in \nau
114.ti 0
115Request Initial Cause Explanation
116.ti 0
117 Value Break
118.br
119.in \nau
120.ti 0
121\&.(c - yes Begin centered block
122.ti 0
123\&.(d - no Begin delayed text
124.ti 0
125\&.(f - no Begin footnote
126.ti 0
127\&.(l - yes Begin list
128.ti 0
129\&.(q - yes Begin major quote
130.ti 0
131\&.(x \fIx\fR - no Begin indexed item in index
132.I x
133.ti 0
134\&.(z - no Begin floating keep
135.ti 0
136\&.)c - yes End centered block
137.ti 0
138\&.)d - yes End delayed text
139.ti 0
140\&.)f - yes End footnote
141.ti 0
142\&.)l - yes End list
143.ti 0
144\&.)q - yes End major quote
145.ti 0
146\&.)x - yes End index item
147.ti 0
148\&.)z - yes End floating keep
149.ti 0
150\&.++ \fIm H\fR - no Define paper section.
151.I m
152defines the part of the paper, and can be
153.B C
154(chapter),
155.B A
156(appendix),
157.B P
158(preliminary, e.g., abstract, table of contents, etc.),
159.B B
160(bibliography),
161.B RC
162(chapters renumbered from page one each chapter),
163or
164.B RA
165(appendix renumbered from page one).
166.ti 0
167\&.+c \fIT\fR - yes Begin chapter (or appendix, etc., as
168set by .++).
169.I T
170is the chapter title.
171.ti 0
172\&.1c 1 yes One column format on a new page.
173.ti 0
174\&.2c 1 yes Two column format.
175.ti 0
176\&.EN - yes Space after equation
177produced by
178.I eqn
179or
180.IR neqn .
181.ti 0
182\&.EQ \fIx y\fR - yes Precede equation; break out and
183add space.
184Equation number is
185.IR y .
186The optional argument \fIx\fR
187may be
188.I I
189to indent equation (default),
190.I L
191to left-adjust the equation, or
192.I C
193to center the equation.
194.ti 0
195\&.GE - yes End \fIgremlin\fP picture.
196.ti 0
197\&.GS - yes Begin \fIgremlin\fP picture.
198.ti 0
199\&.PE - yes End \fIpic\fP picture.
200.ti 0
201\&.PS - yes Begin \fIpic\fP picture.
202.ti 0
203\&.TE - yes End table.
204.ti 0
205\&.TH - yes End heading section of table.
206.ti 0
207\&.TS \fIx\fR - yes Begin table; if \fIx\fR is
208.I H
209table has repeated heading.
210.ti 0
211\&.ac \fIA N\fR - no Set up for ACM style output.
212.I A
213is the Author's name(s),
214.I N
215is the total number of pages.
216Must be given before the first initialization.
217.ti 0
218\&.b \fIx\fR no no Print
219.I x
220in boldface; if no argument switch to boldface.
221.ti 0
222\&.ba \fI+n\fR 0 yes Augments the base indent by
223.I n.
224This indent is used to set the indent on regular text
225(like paragraphs).
226.ti 0
227\&.bc no yes Begin new column
228.ti 0
229\&.bi \fIx\fR no no Print
230.I x
231in bold italics (nofill only)
232.ti 0
233\&.bu - yes Begin bulleted paragraph
234.ti 0
235\&.bx \fIx\fR no no Print \fIx\fR in a box (nofill only).
236.ti 0
237\&.ef \fI\'x\'y\'z\'\fR \'\'\'\' no Set even footer to x y z
238.ti 0
239\&.eh \fI\'x\'y\'z\'\fR \'\'\'\' no Set even header to x y z
240.ti 0
241\&.fo \fI\'x\'y\'z\'\fR \'\'\'\' no Set footer to x y z
242.ti 0
243\&.hx - no Suppress headers and footers on next page.
244.ti 0
245\&.he \fI\'x\'y\'z\'\fR \'\'\'\' no Set header to x y z
246.ti 0
247\&.hl - yes Draw a horizontal line
248.ti 0
249\&.i \fIx\fR no no Italicize
250.I x;
251if
252.I x
253missing, italic text follows.
254.ti 0
255\&.ip \fIx y\fR no yes Start indented paragraph,
256with hanging tag
257.IR x .
258Indentation is
259.I y
260ens (default 5).
261.ti 0
262\&.lp yes yes Start left-blocked paragraph.
263.ti 0
264\&.lo - no Read in a file of local macros of the
265form
266.BI \&.* x.
267Must be given before initialization.
268.ti 0
269\&.np 1 yes Start numbered paragraph.
270.ti 0
271\&.of \fI\'x\'y\'z\'\fR \'\'\'\' no Set odd footer to x y z
272.ti 0
273\&.oh \fI\'x\'y\'z\'\fR \'\'\'\' no Set odd header to x y z
274.ti 0
275\&.pd - yes Print delayed text.
276.ti 0
277\&.pp no yes Begin paragraph.
278First line indented.
279.ti 0
280\&.r yes no Roman text follows.
281.ti 0
282\&.re - no Reset tabs to default values.
283.ti 0
284\&.sc no no Read in a file of special characters
285and diacritical marks.
286Must be given before initialization.
287.ti 0
288\&.sh \fIn x\fR - yes Section head follows,
289font automatically bold.
290.I n
291is level of section,
292.I x
293is title of section.
294.ti 0
295\&.sk no no Leave the next page blank.
296Only one page is remembered ahead.
297.ti 0
298\&.sm \fIx\fR - no Set
299.I x
300in a smaller pointsize.
301.ti 0
302\&.sz \fI+n\fR 10p no Augment the point size by
303.I n
304points.
305.ti 0
306\&.th no no Produce the paper in thesis format.
307Must be given before initialization.
308.ti 0
309\&.tp no yes Begin title page.
310.ti 0
311\&.u \fIx\fR - no Underline argument (even in \fItroff\fR).
312(Nofill only).
313.ti 0
314\&.uh - yes Like .sh but unnumbered.
315.ti 0
316\&.xp \fIx\fR - no Print index
317.I x.