File: groff_me.7

package info (click to toggle)
manpages-de 2.12-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 71,404 kB
  • sloc: sh: 1,059; makefile: 71; python: 64; perl: 37; sed: 11
file content (354 lines) | stat: -rw-r--r-- 6,926 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
'\" t
.hc %
.TH GROFF_ME 7 "7 November 2018" "1.22.3"
.UC 3
.SH NAME
groff_me \- troff macros for formatting papers
.
.
.\" Copyright (C) 1980 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms are permitted
.\" provided that the above copyright notice and this paragraph are
.\" duplicated in all such forms and that any documentation,
.\" advertising materials, and other materials related to such
.\" distribution and use acknowledge that the software was developed
.\" by the University of California, Berkeley.  The name of the
.\" University may not be used to endorse or promote products derived
.\" from this software without specific prior written permission.
.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
.\"	@(#)me.7	6.4 (Berkeley) 4/13/90
.\"
.\" Modified for groff by jjc@jclark.com
.\" Changed to use TBL and eliminate low-level troff hackery by ESR
.\" (this enables it to be lifted to structural markup).
.
.
.\" --------------------------------------------------------------------
.SH SYNOPSIS
.\" --------------------------------------------------------------------
.
.B "groff \-me"
[ options ]
file ...
.br
.B "groff \-m\ me"
[ options ]
file ...
.
.
.\" --------------------------------------------------------------------
.SH DESCRIPTION
.\" --------------------------------------------------------------------
.
This manual page describes the GNU version of the \-me macros,
which is part of the groff document formatting system.
.
This version can be used with both GNU troff and Unix troff.
.
This package of
.I troff
macro definitions provides a canned formatting
facility for technical papers in various formats.
.
.
.PP
The macro requests are defined below.
.
Many
.I troff
requests are unsafe in conjunction with this package, however, these
requests may be used with impunity after the first \&.pp:
.TS
l l.
\&.bp	begin new page
\&.br	break output line here
\&.sp n	insert n spacing lines
\&.ls n	(line spacing) n=1 single, n=2 double space
\&.na	no alignment of right margin
\&.ce n	center next n lines
\&.ul n	underline next n lines
.TE
.PP
Output of the
.I pic,
.I eqn,
.I refer,
and
.I tbl
preprocessors
is acceptable as input.
.
.
.\" --------------------------------------------------------------------
.SH FILES
.\" --------------------------------------------------------------------
.
/usr/share/groff/1.21/tmac/me.tmac (a wrapper file for e.tmac)
.br
/usr/share/groff/1.21/tmac/e.tmac
.
.
.\" --------------------------------------------------------------------
.SH "SEE ALSO"
.\" --------------------------------------------------------------------
.
.BR groff (1),
.BR troff (1)
.br
\-me Reference Manual, Eric P.\& Allman
.br
Writing Papers with Groff Using \-me
.
.
.\" --------------------------------------------------------------------
.SH REQUESTS
.\" --------------------------------------------------------------------
.
This list is incomplete;
see
.I "The \-me Reference Manual"
for interesting details.
.
.
.PP
.na
.TS
l l l lx.
Request	Initial	Causes	Explanation
	Value	Break
_
\&.(c	\-	yes	T{
Begin centered block
T}
\&.(d	\-	no	T{
Begin delayed text
T}
\&.(f	\-	no	Begin footnote
\&.(l	\-	yes	Begin list
\&.(q	\-	yes	T{
Begin major quote
T}
\&.(x \fIx\fR	\-	no	T{
Begin indexed item in index
T}
\&.(z	\-	no	T{
Begin floating keep
T}
\&.)c	\-	yes	T{
End centered block
T}
\&.)d	\-	yes	T{
End delayed text
T}
\&.)f	\-	yes	End footnote
\&.)l	\-	yes	End list
\&.)q	\-	yes	T{
End major quote
T}
\&.)x	\-	yes	T{
End index item
T}
\&.)z	\-	yes	T{
End floating keep
T}
\&.++ \fIm H\fR	\-	no	T{
Define paper section.
.I m
defines the part of the paper, and can be
.B C
(chapter),
.B A
(appendix),
.B P
(preliminary, e.g., abstract, table of contents, etc.),
.B B
(bibliography),
.B RC
(chapters renumbered from page one each chapter),
or
.B RA
(appendix renumbered from page one).
T}
\&.+c \fIT\fR	\-	yes	T{
Begin chapter (or appendix, etc., as
set by \&.++).
.I T
is the chapter title.
T}
\&.1c	1	yes	T{
One column format on a new page.
T}
\&.2c	1	yes	T{
Two column format.
T}
\&.EN	\-	yes	T{
Space after equation
produced by
.I eqn
or
.IR neqn .
T}
\&.EQ \fIx y\fR	\-	yes	T{
Precede equation; break out and
add space.
Equation number is
.IR y .
The optional argument \fIx\fR
may be
.I I
to indent equation (default),
.I L
to left-adjust the equation, or
.I C
to center the equation.
T}
\&.GE	\-	yes	T{
End \fIgremlin\fP picture.
T}
\&.GS	\-	yes	T{
Begin \fIgremlin\fP picture.
T}
\&.PE	\-	yes	T{
End \fIpic\fP picture.
T}
\&.PS	\-	yes	T{
Begin \fIpic\fP picture.
T}
\&.TE	\-	yes	End table.
\&.TH	\-	yes	T{
End heading section of table.
T}
\&.TS \fIx\fR	\-	yes	T{
Begin table; if \fIx\fR is
.I H
table has repeated heading.
T}
\&.b \fIx\fR	no	no	T{
Print
.I x
in boldface; if no argument switch to boldface.
T}
\&.ba \fI+n\fR	0	yes	T{
Augments the base indent by
.I n.
This indent is used to set the indent on regular text
(like paragraphs).
T}
\&.bc	no	yes	T{
Begin new column
T}
\&.bi \fIx\fR	no	no	T{
Print
.I x
in bold italics (nofill only)
T}
\&.bu	\-	yes	T{
Begin bulleted paragraph
T}
\&.bx \fIx\fR	no	no	T{
Print \fIx\fR in a box (nofill only).
T}
\&.ef \fI\'x\'y\'z\'\fR	\'\'\'\'	no	T{
Set even footer to x  y  z
T}
\&.eh \fI\'x\'y\'z\'\fR	\'\'\'\'	no	T{
Set even header to x  y  z
T}
\&.fo \fI\'x\'y\'z\'\fR	\'\'\'\'	no	T{
Set footer to x  y  z
T}
\&.hx	\-	no	T{
Suppress headers and footers on next page.
T}
\&.he \fI\'x\'y\'z\'\fR	\'\'\'\'	no	T{
Set header to x  y  z
T}
\&.hl	\-	yes	T{
Draw a horizontal line
T}
\&.i \fIx\fR	no	no	T{
Italicize
.I x;
if
.I x
missing, italic text follows.
T}
\&.ip \fIx y\fR	no	yes	T{
Start indented paragraph,
with hanging tag
.IR x .
Indentation is
.I y
ens (default 5).
T}
\&.lp	yes	yes	T{
Start left-blocked paragraph.
T}
\&.np	1	yes	T{
Start numbered paragraph.
T}
\&.of \fI\'x\'y\'z\'\fR	\'\'\'\'	no	T{
Set odd footer to x  y  z
T}
\&.oh \fI\'x\'y\'z\'\fR	\'\'\'\'	no	T{
Set odd header to x  y  z
T}
\&.pd	\-	yes	T{
Print delayed text.
T}
\&.pp	no	yes	T{
Begin paragraph.
First line indented.
T}
\&.r	yes	no	T{
Roman text follows.
T}
\&.re	\-	no	T{
Reset tabs to default values.
T}
\&.sh \fIn x\fR	\-	yes	T{
Section head follows,
font automatically bold.
.I n
is level of section,
.I x
is title of section.
T}
\&.sk	no	no	T{
Leave the next page blank.
Only one page is remembered ahead.
T}
\&.sm \fIx\fR	\-	no	T{
Set
.I x
in a smaller pointsize.
T}
\&.sz \fI+n\fR	10p	no	T{
Augment the point size by
.I n
points.
T}
\&.tp	no	yes	T{
Begin title page.
T}
\&.u \fIx\fR	\-	no	T{
Underline argument (even in \fItroff\fR).
(Nofill only).
T}
\&.uh	\-	yes	T{
Like .sh but unnumbered.
T}
\&.xp \fIx\fR	\-	no	Print index.
.TE
.ad

.
.\" Local Variables:
.\" mode: nroff
.\" tab-with: 20
.\" End: