Debian Codegraph @

upstream/debian-unstable/man7/groff_me.7

raw
1 '\" t
2 .TH groff_me 7 "2026-04-22" "groff 1.24.1"
3 .SH Name
4 groff_me \- \(lqme\(rq macro package for formatting
5 .I roff
6 documents
7 .
8 .
9 .\" ====================================================================
10 .\" Legal Terms
11 .\" ====================================================================
12 .\"
13 .\" Copyright (C) 1980, 1993
14 .\" The Regents of the University of California. All rights reserved.
15 .\"
16 .\" Copyright 1989-2024 Free Software Foundation, Inc.
17 .\"
18 .\" Redistribution and use in source and binary forms, with or without
19 .\" modification, are permitted provided that the following conditions
20 .\" are met:
21 .\" 1. Redistributions of source code must retain the above copyright
22 .\" notice, this list of conditions and the following disclaimer.
23 .\" 2. Redistributions in binary form must reproduce the above copyright
24 .\" notice, this list of conditions and the following disclaimer in
25 .\" the documentation and/or other materials provided with the
26 .\" distribution.
27 .\" 3. [Deleted. See
28 .\" ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change]
29 .\" 4. Neither the name of the University nor the names of its
30 .\" contributors may be used to endorse or promote products derived
31 .\" from this software without specific prior written permission.
32 .\"
33 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS"
34 .\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
35 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
36 .\" PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
37 .\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
39 .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
40 .\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
41 .\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
42 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
43 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44 .\" SUCH DAMAGE.
45 .\"
46 .\" @(#)me.7 8.1 (Berkeley) 06/05/93
47 .\"
48 .\" Modified for groff by [email protected]
49 .\" Changed to use TBL and eliminate low-level troff hackery by ESR
50 .\" (this enables it to be lifted to structural markup).
51 .
52 .
53 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
54 .do nr *groff_groff_me_7_man_C \n[.cp]
55 .cp 0
56 .
57 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
58 .nr do-fallback 0
59 .if !\n(.f .nr do-fallback 1 \" mandoc
60 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
61 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
62 .if \n[do-fallback] \{\
63 . de MR
64 . ie \\n(.$=1 \
65 . I \%\\$1
66 . el \
67 . IR \%\\$1 (\\$2)\\$3
68 . .
69 .\}
70 .rr do-fallback
71 .
72 .
73 .\" ====================================================================
74 .SH Synopsis
75 .\" ====================================================================
76 .
77 .SY "groff \-me"
78 .RI [ option\~ .\|.\|.\&]
79 .RI [ file\~ .\|.\|.]
80 .YS
81 .
82 .SY "groff \-m me"
83 .RI [ option\~ .\|.\|.\&]
84 .RI [ file\~ .\|.\|.]
85 .YS
86 .
87 .
88 .\" ====================================================================
89 .SH Description
90 .\" ====================================================================
91 .
92 The GNU implementation of the
93 .I me
94 macro package is part of the
95 .I groff
96 document formatting system.
97 .
98 The
99 .I me
100 package of macro definitions for the
101 .I roff
102 language provides a convenient facility for preparing technical papers
103 in various formats.
104 .
105 This version is based on the
106 .I me
107 distributed with 4.4BSD and can be used with the GNU
108 .I troff
109 formatter as well as those descended from AT&T
110 .IR troff .
111 .
112 .
113 .P
114 Some formatter requests affect page layout unpredictably when used in
115 conjunction with this package;
116 however,
117 the following may be used with impunity after the first call to a
118 paragraphing macro like
119 .B lp
120 or
121 .BR pp .
122 .
123 Some arguments are optional;
124 see
125 .MR groff 7
126 for details,
127 particularly of requests whose argument list is designated with an
128 ellipsis.
129 .
130 An asterisk
131 .B *
132 marks
133 .I groff
134 extensions.
135 .
136 .
137 .P
138 .TS
139 Lb1 Li L.
140 ad c set text adjustment mode to \fIc
141 af r f assign format \fIf\fP to register \fIr
142 am m e append to macro \fIm\fP until \fIe\fP called
143 as s t append rest of line \fIt\fP to string \fIs
144 bp n begin new page numbered \fIn
145 br \& break output line
146 ce n center next \fIn\fP productive input lines
147 cp n en-/disable AT&T \fItroff\fP compatibility mode\fB*
148 de m e define macro \fIm\fP until \fIe\fP called
149 do t interpret input \fIt\fP with compatibility mode off\fB*
150 ds s t define rest of line \fIt\fP as string \fIs
151 el t interpret \fIt\fP if corresponding \fBie\fP's \fIp\fP \
152 false
153 fc c d set field delimiter \fIc\fP and padding glyph \fId
154 fi \& enable filling
155 hc c set hyphenation character to \fIc
156 hy m set automatic hyphenation mode to \fIm
157 ie p t as \fBif\fP, but enable interpretation of later \fBel
158 if p t if condition \fIp\/\fP, interpret rest of line \fIt
159 in h set indentation to distance \fIh\fP
160 lc c set leader repetition glyph to \fIc
161 ls n set line spacing to \fIn
162 mc c h set (right) margin glyph to \fIc\fP at distance \fIh
163 mk r mark vertical position in register \fIr\fP
164 na \& disable adjustment of text
165 ne v need vertical space of distance \fIv
166 nf \& disable filling
167 nh \& disable automatic hyphenation
168 nr r n i assign register \fIr\fP value \fIn\fP with \
169 auto-increment \fIi
170 ns \& begin no-space mode
171 pl v set page length to \fIv
172 pn n set next page number to \fIn
173 po h set page offset to \fIh
174 rj n right-align next \fIn\fP productive input lines\fB*
175 rm m remove macro, string, or request \fIm
176 rn m n rename macro, string, or request \fIm\fP to \fIn
177 rr r remove register \fIr
178 rs \& resume spacing (end no-space mode)
179 rt v return to vertical position set by \fBmk\fP, or \fIv
180 so f source (interpolate) input file \fIf
181 sp n insert \fIn\fP lines of vertical space
182 ta \fR.\|.\|. set tab stops
183 tc c set tab repetition glyph to \fIc
184 ti h set temporary indentation (next line only) to \fIh
185 tl \fR.\|.\|. output three-part title
186 tr \fR.\|.\|. translate characters
187 ul n underline next \fIn\fP productive input lines
188 .TE
189 .
190 .
191 .P
192 Except on title pages
193 (produced by calling
194 .BR tp ),
195 .I me
196 suppresses the output of vertical space at the tops of pages
197 (after the output of any page header);
198 the
199 .B sp
200 request thus does not work there.
201 .
202 You can instead call
203 .B bl
204 or enclose the desired spacing request in a diversion,
205 for instance by calling
206 .B (b
207 and
208 .BR )b .
209 .
210 .I me
211 also intercepts the
212 .B ll
213 request;
214 see the
215 .RI \[lq] me
216 Reference Manual\[rq]
217 for details.
218 .
219 .
220 .\" ====================================================================
221 .SS "Name space"
222 .\" ====================================================================
223 .
224 Objects in
225 .I me
226 follow a rigid naming convention.
227 .
228 To avoid conflict,
229 any user-defined register,
230 string,
231 or macro
232 names should be single numerals or uppercase letters,
233 or any longer sequence of letters and numerals
234 with at least one uppercase letter.
235 .
236 (For portability between BSD and
237 .I groff
238 .IR me ,
239 limit names to
240 two characters,
241 and avoid the name
242 .B [
243 (left square bracket).)
244 .
245 The names employed
246 by any preprocessors in use
247 should also not be repurposed.
248 .
249 .
250 .\" ====================================================================
251 .SS Macros
252 .\" ====================================================================
253 .
254 .ne 2v \" Keep at least the first entry together with the heading.
255 .TS
256 Lb L.
257 $0 post-section heading hook
258 $1 pre-section depth 1 hook
259 $2 pre-section depth 2 hook
260 $3 pre-section depth 3 hook
261 $4 pre-section depth 4 hook
262 $5 pre-section depth 5 hook
263 $6 pre-section depth 6 hook
264 $C post-chapter title hook
265 $H page/column heading hook
266 $c output chapter number and title
267 $f output footer
268 $h output header
269 $p output section heading
270 $s output footnote area separator
271 (b begin block
272 (c begin centered block
273 (d begin delayed text
274 (f begin footnote
275 (l begin list
276 (q begin long quotation
277 (x begin index entry
278 (z begin floating keep
279 )b end block
280 )c end centered block
281 )d end delayed text
282 )f end footnote
283 )l end list
284 )q end long quotation
285 )x end index entry
286 )z end floating keep
287 ++ set document segment type
288 +c begin chapter
289 1c end multi-column layout
290 2c begin multi-column layout
291 EN end \fI\%eqn\fP equation
292 EQ begin \fI\%eqn\fP equation
293 GE end \fI\%grn\fP picture with drawing position at bottom
294 GF end \fI\%grn\fP picture with drawing position at top
295 GS start \fI\%grn\fP picture
296 IE end \fIideal\fP picture with drawing position at bottom
297 IF end \fIideal\fP picture with drawing position at top
298 IS start \fIideal\fP picture
299 PE end \fI\%pic\fP picture with drawing position at bottom
300 PF end \fI\%pic\fP picture with drawing position at top
301 PS start \fI\%pic\fP picture
302 TE end \fI\%tbl\fP table
303 TH end heading for multi-page \fI\%tbl\fP table
304 TS start \fI\%tbl\fP table
305 b embolden argument
306 ba set base indentation
307 bc begin new column
308 bi embolden and italicize argument
309 bx box argument
310 ef set even-numbered page footer
311 eh set even-numbered page header
312 ep end page
313 fo set footer
314 he set header
315 hl draw horizontal line
316 hx suppress next page's headers/footers
317 i italicize argument
318 ip begin indented paragraph
319 ld reset localization and date registers and strings\fB*
320 ll set line length
321 lp begin fully left-aligned paragraph
322 np begin numbered paragraph
323 of set odd-numbered page footer
324 oh set odd-numbered page header
325 pd output delayed text
326 pp begin first-line indented paragraph
327 q quote argument
328 r set argument in roman
329 re reset tab stops
330 sh begin numbered section
331 sm set argument at smaller type size
332 sx change section depth
333 sz set type size and vertical spacing
334 tp begin title page
335 u underline argument
336 uh begin unnumbered section
337 xl set line length (current environment only)
338 xp output index
339 .TE
340 .
341 .
342 .br
343 .ne 4v
344 .P
345 Some macros are provided for \(lqold\(rq
346 .MR roff 1
347 compatibility.
348 .
349 The
350 .RI \(lq me
351 Reference Manual\(rq
352 describes alternatives for modern documents.
353 .
354 .
355 .P
356 .ne 2v \" Keep at least the first entry together with the heading.
357 .TS
358 Lb L.
359 ar use Arabic numerals for page numbers
360 bl insert space (even at page top; cf.\& \fBsp\fP)
361 ix set indentation without break
362 m1 set page top to header distance
363 m2 set header to text distance
364 m3 set text to footer distance
365 m4 set footer to page bottom distance
366 n1 begin output line numbering
367 n2 end or alter output line numbering
368 pa begin page
369 ro use Roman numerals for page numbers
370 sk skip next page
371 .TE
372 .
373 .
374 .\" ====================================================================
375 .SS Registers
376 .\" ====================================================================
377 .
378 .ne 2v \" Keep at least the first entry together with the heading.
379 .TS
380 Lb L.
381 $0 section depth
382 $1 first section number component
383 $2 second section number component
384 $3 third section number component
385 $4 fourth section number component
386 $5 fifth section number component
387 $6 sixth section number component
388 $c current column number
389 $d delayed text number
390 $f footnote number
391 $i paragraph base indentation
392 $l column width
393 $m number of available columns
394 $p numbered paragraph number
395 $s column spacing (indentation)
396 bi display (block) indentation
397 bm distance from text area to page bottom
398 bs display (block) pre/post space
399 bt block threshold for keeps
400 ch current chapter number
401 df display font
402 dv vertical spacing of displayed text (as percentage)\fB*
403 es equation pre/post space
404 ff footnote font
405 fi footnote indentation (first line only)
406 fm footer margin
407 fp footnote type size in points
408 fs footnote prespace
409 fu footnote undent (right indentation)
410 hm header margin
411 ii indented paragraph indentation
412 no line numbering offset\fB*
413 pf paragraph font
414 pi paragraph indentation
415 po page offset
416 pp paragraph type size in points
417 ps paragraph prespace
418 qi long quotation left/right indentation
419 qp long quotation type size in points
420 qs long quotation pre/post space
421 sf section title font
422 si section indentation per level of depth
423 so additional section title offset
424 sp section title type size in points
425 ss section prespace
426 sx super/subscript line height increase\fB*
427 tf title font
428 tm distance from page top to text area
429 tp title type size in points
430 tv vertical spacing of text (as percentage)\fB*
431 xs index entry prespace
432 xu index undent (right indentation)
433 y2 year of the century\fB*
434 y4 year\fB*
435 yr year minus 1900
436 zs floating keep pre/post space
437 .TE
438 .
439 .
440 .\" ====================================================================
441 .SS Strings
442 .\" ====================================================================
443 .
444 .ne 2v \" Keep at least the first entry together with the heading.
445 .TS
446 Lb L.
447 # delayed text marker
448 $n catenated section number
449 * footnote marker
450 \- em dash
451 < begin subscripting
452 > end subscripting
453 dw weekday name
454 lq left double quotation mark
455 mo month name
456 rq right double quotation mark
457 td date
458 wa term for \(lqappendix\(rq used by \fB.$c*
459 wc term for \(lqchapter\(rq used by \fB.$c*
460 { begin superscripting
461 } end superscripting
462 .TE
463 .
464 .
465 .\" ====================================================================
466 .SH Files
467 .\" ====================================================================
468 .
469 .TP
470 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/e.tmac
471 implements the package.
472 .
473 .
474 .TP
475 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/refer\-me.tmac
476 implements
477 .MR \%refer 1
478 support for
479 .IR me .
480 .
481 .
482 .TP
483 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/me.tmac
484 is a wrapper enabling the package to be loaded with the option
485 .RB \[lq] "\-m me" \[rq].
486 .
487 .
488 .\" ====================================================================
489 .SH Notes
490 .\" ====================================================================
491 .
492 Some early
493 .I roff
494 macro packages limited their names to a single letter,
495 which followed the formatter's
496 .B m
497 option,
498 resulting in \[lq]names\[rq] like
499 .IR \-mm ,
500 .IR \-ms ,
501 .IR \-mv ,
502 and
503 .IR \-mn .
504 .
505 .\" 'When I started writing the -me macros it began as something in my
506 .\" private tree (I don't remember what I called it). Then some other
507 .\" folks on the INGRES project wanted to use it, but our system admin
508 .\" at the time didn't want to dicker with the system namespace at the
509 .\" behest of a mere undergraduate, so he didn't like anything that was
510 .\" actually descriptive lest people think it was "official". He
511 .\" finally consented to "-meric" (which I always hated), since it was
512 .\" obviously non-official. By the time my macros became popular around
513 .\" Berkeley it got shortened to "-me", much to my relief.
514 .\"
515 .\" Of course, if AT&T had been willing to let Berkeley have -ms then
516 .\" most likely -me would never have happened at all. Without a macro
517 .\" package, nroff/troff is basically unusable; -me stepped into the
518 .\" vacuum.' -- Eric Allman
519 .\"
520 .\" https://minnie.tuhs.org/pipermail/tuhs/2018-November/017033.html
521 .
522 .IR me 's
523 \(lqe\(rq stands for \(lqEric P.\& Allman\(rq,
524 the author of the original macro package and the technical papers
525 documenting it.
526 .
527 .
528 .br
529 .ne 4v
530 .\" ====================================================================
531 .SH "See also"
532 .\" ====================================================================
533 .
534 .
535 Two manuals are available in source and rendered form.
536 .
537 On your system,
538 they may be compressed and/or available in additional formats.
539 .
540 .
541 .br
542 .ne 3v
543 .TP
544 .I /usr/\:\%share/\:\%doc/\:\%groff\-base/meintro.me
545 .TQ
546 .I /usr/\:\%share/\:\%doc/\:\%groff\-base/meintro.ps
547 is
548 \[lq]Writing Papers with
549 .I Groff
550 Using
551 .RI \- me \[rq],
552 by Eric P.\& Allman,
553 adapted for
554 .I groff
555 by James Clark.
556 .
557 .
558 .br
559 .ne 4v
560 .TP
561 .I /usr/\:\%share/\:\%doc/\:\%groff\-base/meref.me
562 .TQ
563 .I /usr/\:\%share/\:\%doc/\:\%groff\-base/meref.ps
564 is the
565 .RI \[lq] me
566 Reference Manual\[rq],
567 by Eric P.\& Allman,
568 adapted for
569 .I groff
570 by James Clark and G.\& Branden Robinson.
571 .
572 .
573 .P
574 .IR "Groff: The GNU Implementation of troff" ,
575 by Trent A.\& Fisher and Werner Lemberg,
576 is the primary
577 .I groff
578 manual.
579 .
580 You can browse it interactively with \[lq]info groff\[rq].
581 .
582 .
583 .P
584 For preprocessors supported by
585 .IR me ,
586 see
587 .MR \%eqn 1 ,
588 .MR \%grn 1 ,
589 .MR \%pic 1 ,
590 .MR \%refer 1 ,
591 and
592 .MR \%tbl 1 .
593 .
594 .
595 .P
596 .MR groff 1 ,
597 .MR \%troff 1 ,
598 .MR groff 7
599 .
600 .
601 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
602 .cp \n[*groff_groff_me_7_man_C]
603 .do rr *groff_groff_me_7_man_C
604 .
605 .
606 .\" Local Variables:
607 .\" fill-column: 72
608 .\" mode: nroff
609 .\" End:
610 .\" vim: set filetype=groff textwidth=72: